Merge pull request #77 from Oloodi/76-backend-extend-events-entity-implement-get-update-delete-filter-operations
76 backend extend events entity implement get update delete filter operations
This commit is contained in:
José Salazar
@@ -1,29 +1,160 @@
|
||||
mutation CreateEvent(
|
||||
$eventName: String!,
|
||||
$isRecurring: Boolean!,
|
||||
$isRapid: Boolean,
|
||||
$isRecurring: Boolean,
|
||||
$isMultiDay: Boolean,
|
||||
$recurrenceType: RecurrenceType,
|
||||
$recurrenceStartDate: Timestamp,
|
||||
$recurrenceEndDate: Timestamp,
|
||||
$scatterDates: String,
|
||||
$multiDayStartDate: Timestamp,
|
||||
$multiDayEndDate: Timestamp,
|
||||
$bufferTimeBefore: Float,
|
||||
$bufferTimeAfter: Float,
|
||||
$conflictDetectionEnabled: Boolean,
|
||||
$detectedConflicts: String,
|
||||
$businessId: UUID!,
|
||||
$businessName: String,
|
||||
$vendorId: UUID,
|
||||
$vendorName: String,
|
||||
$hub: String,
|
||||
$eventLocation: String,
|
||||
$contractType: ContractType,
|
||||
$poReference: String,
|
||||
$status: EventStatus!,
|
||||
$date: Timestamp!,
|
||||
$shifts: String,
|
||||
$addons: String,
|
||||
$total: Float,
|
||||
$clientName: String,
|
||||
$clientEmail: String,
|
||||
$clientPhone: String,
|
||||
$invoiceId: UUID,
|
||||
$notes: String,
|
||||
$requested: Int,
|
||||
$assignedStaff: String
|
||||
) @auth(level: USER) {
|
||||
event_insert(
|
||||
data: {
|
||||
eventName: $eventName
|
||||
isRapid: $isRapid
|
||||
isRecurring: $isRecurring
|
||||
isMultiDay: $isMultiDay
|
||||
recurrenceType: $recurrenceType
|
||||
recurrenceStartDate: $recurrenceStartDate
|
||||
recurrenceEndDate: $recurrenceEndDate
|
||||
scatterDates: $scatterDates
|
||||
multiDayStartDate: $multiDayStartDate
|
||||
multiDayEndDate: $multiDayEndDate
|
||||
bufferTimeBefore: $bufferTimeBefore
|
||||
bufferTimeAfter: $bufferTimeAfter
|
||||
conflictDetectionEnabled: $conflictDetectionEnabled
|
||||
detectedConflicts: $detectedConflicts
|
||||
businessId: $businessId
|
||||
businessName: $businessName
|
||||
vendorId: $vendorId
|
||||
vendorName: $vendorName
|
||||
hub: $hub
|
||||
eventLocation: $eventLocation
|
||||
contractType: $contractType
|
||||
poReference: $poReference
|
||||
status: $status
|
||||
date: $date
|
||||
shifts: $shifts
|
||||
addons: $addons
|
||||
total: $total
|
||||
clientName: $clientName
|
||||
clientEmail: $clientEmail
|
||||
clientPhone: $clientPhone
|
||||
invoiceId: $invoiceId
|
||||
notes: $notes
|
||||
requested: $requested
|
||||
assignedStaff: $assignedStaff
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
mutation UpdateEvent(
|
||||
$id: UUID!,
|
||||
$eventName: String,
|
||||
$isRapid: Boolean,
|
||||
$isRecurring: Boolean,
|
||||
$isMultiDay: Boolean,
|
||||
$recurrenceType: RecurrenceType,
|
||||
$recurrenceStartDate: Timestamp,
|
||||
$recurrenceEndDate: Timestamp,
|
||||
$scatterDates: String,
|
||||
$multiDayStartDate: Timestamp,
|
||||
$multiDayEndDate: Timestamp,
|
||||
$bufferTimeBefore: Float,
|
||||
$bufferTimeAfter: Float,
|
||||
$conflictDetectionEnabled: Boolean,
|
||||
$detectedConflicts: String,
|
||||
$businessId: UUID,
|
||||
$businessName: String,
|
||||
$vendorId: UUID,
|
||||
$vendorName: String,
|
||||
$hub: String,
|
||||
$eventLocation: String,
|
||||
$contractType: ContractType,
|
||||
$poReference: String,
|
||||
$status: EventStatus,
|
||||
$date: Timestamp,
|
||||
$shifts: String,
|
||||
$addons: String,
|
||||
$total: Float,
|
||||
$clientName: String,
|
||||
$clientEmail: String,
|
||||
$clientPhone: String,
|
||||
$invoiceId: UUID,
|
||||
$notes: String,
|
||||
$requested: Int,
|
||||
$assignedStaff: String
|
||||
) @auth(level: USER) {
|
||||
event_update(
|
||||
id: $id,
|
||||
data: {
|
||||
eventName: $eventName
|
||||
isRapid: $isRapid
|
||||
isRecurring: $isRecurring
|
||||
isMultiDay: $isMultiDay
|
||||
recurrenceType: $recurrenceType
|
||||
recurrenceStartDate: $recurrenceStartDate
|
||||
recurrenceEndDate: $recurrenceEndDate
|
||||
scatterDates: $scatterDates
|
||||
multiDayStartDate: $multiDayStartDate
|
||||
multiDayEndDate: $multiDayEndDate
|
||||
bufferTimeBefore: $bufferTimeBefore
|
||||
bufferTimeAfter: $bufferTimeAfter
|
||||
conflictDetectionEnabled: $conflictDetectionEnabled
|
||||
detectedConflicts: $detectedConflicts
|
||||
businessId: $businessId
|
||||
businessName: $businessName
|
||||
vendorId: $vendorId
|
||||
vendorName: $vendorName
|
||||
hub: $hub
|
||||
eventLocation: $eventLocation
|
||||
contractType: $contractType
|
||||
poReference: $poReference
|
||||
status: $status
|
||||
date: $date
|
||||
shifts: $shifts
|
||||
addons: $addons
|
||||
total: $total
|
||||
clientName: $clientName
|
||||
clientEmail: $clientEmail
|
||||
clientPhone: $clientPhone
|
||||
invoiceId: $invoiceId
|
||||
notes: $notes
|
||||
requested: $requested
|
||||
assignedStaff: $assignedStaff
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
mutation DeleteEvent(
|
||||
$id: UUID!
|
||||
) @auth(level: USER) {
|
||||
event_delete(id: $id)
|
||||
}
|
||||
|
||||
@@ -4,11 +4,144 @@ query listEvents @auth(level: USER) {
|
||||
eventName
|
||||
status
|
||||
date
|
||||
isRapid
|
||||
isRecurring
|
||||
isMultiDay
|
||||
recurrenceType
|
||||
recurrenceStartDate
|
||||
recurrenceEndDate
|
||||
scatterDates
|
||||
multiDayStartDate
|
||||
multiDayEndDate
|
||||
bufferTimeBefore
|
||||
bufferTimeAfter
|
||||
conflictDetectionEnabled
|
||||
detectedConflicts
|
||||
businessId
|
||||
businessName
|
||||
vendorId
|
||||
vendorName
|
||||
hub
|
||||
eventLocation
|
||||
contractType
|
||||
poReference
|
||||
shifts
|
||||
addons
|
||||
total
|
||||
clientName
|
||||
clientEmail
|
||||
clientPhone
|
||||
invoiceId
|
||||
notes
|
||||
requested
|
||||
assignedStaff
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
query getEventById(
|
||||
$id: UUID!
|
||||
) @auth(level: USER) {
|
||||
event(id: $id) {
|
||||
id
|
||||
eventName
|
||||
status
|
||||
date
|
||||
isRapid
|
||||
isRecurring
|
||||
isMultiDay
|
||||
recurrenceType
|
||||
recurrenceStartDate
|
||||
recurrenceEndDate
|
||||
scatterDates
|
||||
multiDayStartDate
|
||||
multiDayEndDate
|
||||
bufferTimeBefore
|
||||
bufferTimeAfter
|
||||
conflictDetectionEnabled
|
||||
detectedConflicts
|
||||
businessId
|
||||
businessName
|
||||
vendorId
|
||||
vendorName
|
||||
hub
|
||||
eventLocation
|
||||
contractType
|
||||
poReference
|
||||
shifts
|
||||
addons
|
||||
total
|
||||
clientName
|
||||
clientEmail
|
||||
clientPhone
|
||||
invoiceId
|
||||
notes
|
||||
requested
|
||||
assignedStaff
|
||||
}
|
||||
}
|
||||
|
||||
query filterEvents(
|
||||
$status: EventStatus,
|
||||
$businessId: UUID,
|
||||
$vendorId: UUID,
|
||||
$isRecurring: Boolean,
|
||||
$isRapid: Boolean,
|
||||
$isMultiDay: Boolean,
|
||||
$recurrenceType: RecurrenceType,
|
||||
$date: Timestamp,
|
||||
$hub: String,
|
||||
$eventLocation: String,
|
||||
$contractType: ContractType,
|
||||
$clientEmail: String
|
||||
) @auth(level: USER) {
|
||||
events(where: {
|
||||
status: { eq: $status }
|
||||
businessId: { eq: $businessId }
|
||||
vendorId: { eq: $vendorId }
|
||||
isRecurring: { eq: $isRecurring }
|
||||
isRapid: { eq: $isRapid }
|
||||
isMultiDay: { eq: $isMultiDay }
|
||||
recurrenceType: { eq: $recurrenceType }
|
||||
date: { eq: $date }
|
||||
hub: { eq: $hub }
|
||||
eventLocation: { eq: $eventLocation }
|
||||
contractType: { eq: $contractType }
|
||||
clientEmail: { eq: $clientEmail }
|
||||
}) {
|
||||
id
|
||||
eventName
|
||||
status
|
||||
date
|
||||
isRapid
|
||||
isRecurring
|
||||
isMultiDay
|
||||
recurrenceType
|
||||
recurrenceStartDate
|
||||
recurrenceEndDate
|
||||
scatterDates
|
||||
multiDayStartDate
|
||||
multiDayEndDate
|
||||
bufferTimeBefore
|
||||
bufferTimeAfter
|
||||
conflictDetectionEnabled
|
||||
detectedConflicts
|
||||
businessId
|
||||
businessName
|
||||
vendorId
|
||||
vendorName
|
||||
hub
|
||||
eventLocation
|
||||
contractType
|
||||
poReference
|
||||
shifts
|
||||
addons
|
||||
total
|
||||
clientName
|
||||
clientEmail
|
||||
clientPhone
|
||||
invoiceId
|
||||
notes
|
||||
requested
|
||||
assignedStaff
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,19 +15,50 @@ enum RecurrenceType {
|
||||
SCATTER
|
||||
}
|
||||
|
||||
#enums cant start by a number, reason of C1099
|
||||
enum ContractType {
|
||||
W2
|
||||
C1099
|
||||
TEMP
|
||||
CONTRACT
|
||||
}
|
||||
|
||||
type Event @table(name: "events") {
|
||||
|
||||
id: UUID! @default(expr: "uuidV4()")
|
||||
eventName: String!
|
||||
isRecurring: Boolean!
|
||||
isRapid: Boolean @default(expr: "false")
|
||||
isRecurring: Boolean @default(expr: "false")
|
||||
isMultiDay: Boolean @default(expr: "false")
|
||||
recurrenceType: RecurrenceType
|
||||
recurrenceStartDate: Timestamp
|
||||
recurrenceEndDate: Timestamp
|
||||
scatterDates: String
|
||||
multiDayStartDate: Timestamp
|
||||
multiDayEndDate: Timestamp
|
||||
bufferTimeBefore: Float @default(expr: "0")
|
||||
bufferTimeAfter: Float @default(expr: "0")
|
||||
conflictDetectionEnabled: Boolean @default(expr: "true")
|
||||
detectedConflicts: String
|
||||
businessId: UUID!
|
||||
businessName: String
|
||||
vendorId: UUID
|
||||
vendorName: String
|
||||
hub: String
|
||||
eventLocation: String
|
||||
contractType: ContractType
|
||||
poReference: String
|
||||
status: EventStatus!
|
||||
date: Timestamp!
|
||||
shifts: String
|
||||
addons: String
|
||||
total: Float
|
||||
requested: Int
|
||||
clientName: String
|
||||
clientEmail: String
|
||||
clientPhone: String
|
||||
invoiceId: UUID
|
||||
notes: String
|
||||
requested: Int @default(expr: "0")
|
||||
assignedStaff: String
|
||||
createdDate: Timestamp @default(expr: "request.time")
|
||||
updatedDate: Timestamp @default(expr: "request.time")
|
||||
|
||||
@@ -12,11 +12,9 @@ For each operation, there is a wrapper hook that can be used to call the operati
|
||||
|
||||
Here are all of the hooks that get generated:
|
||||
```ts
|
||||
import { useListEvents, useCreateStaff, useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateEvent } from '@dataconnect/generated/react';
|
||||
import { useCreateStaff, useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateEvent, useUpdateEvent } from '@dataconnect/generated/react';
|
||||
// The types of these hooks are available in react/index.d.ts
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useListEvents();
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useCreateStaff(createStaffVars);
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useListStaff();
|
||||
@@ -35,6 +33,8 @@ const { data, isPending, isSuccess, isError, error } = useFilterVendors(filterVe
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars);
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars);
|
||||
|
||||
```
|
||||
|
||||
Here's an example from a different generated SDK:
|
||||
@@ -72,12 +72,9 @@ If a user is not using a supported framework, they can use the generated SDK dir
|
||||
Here's an example of how to use it with the first 5 operations:
|
||||
|
||||
```js
|
||||
import { listEvents, createStaff, listStaff, createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createEvent } from '@dataconnect/generated';
|
||||
import { createStaff, listStaff, createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createEvent, updateEvent } from '@dataconnect/generated';
|
||||
|
||||
|
||||
// Operation listEvents:
|
||||
const { data } = await ListEvents(dataConnect);
|
||||
|
||||
// Operation CreateStaff: For variables, look at type CreateStaffVars in ../index.d.ts
|
||||
const { data } = await CreateStaff(dataConnect, createStaffVars);
|
||||
|
||||
@@ -105,5 +102,8 @@ const { data } = await FilterVendors(dataConnect, filterVendorsVars);
|
||||
// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts
|
||||
const { data } = await CreateEvent(dataConnect, createEventVars);
|
||||
|
||||
// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts
|
||||
const { data } = await UpdateEvent(dataConnect, updateEventVars);
|
||||
|
||||
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
@@ -7,6 +7,13 @@ export const BackgroundCheckStatus = {
|
||||
EXPIRED: "EXPIRED",
|
||||
}
|
||||
|
||||
export const ContractType = {
|
||||
W2: "W2",
|
||||
C1099: "C1099",
|
||||
TEMP: "TEMP",
|
||||
CONTRACT: "CONTRACT",
|
||||
}
|
||||
|
||||
export const EmploymentType = {
|
||||
FULL_TIME: "FULL_TIME",
|
||||
PART_TIME: "PART_TIME",
|
||||
@@ -61,17 +68,6 @@ export const connectorConfig = {
|
||||
location: 'us-central1'
|
||||
};
|
||||
|
||||
export const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
|
||||
export function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
}
|
||||
|
||||
export const createStaffRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
@@ -171,3 +167,58 @@ export function createEvent(dcOrVars, vars) {
|
||||
return executeMutation(createEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const updateEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'UpdateEvent', inputVars);
|
||||
}
|
||||
updateEventRef.operationName = 'UpdateEvent';
|
||||
|
||||
export function updateEvent(dcOrVars, vars) {
|
||||
return executeMutation(updateEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const deleteEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'DeleteEvent', inputVars);
|
||||
}
|
||||
deleteEventRef.operationName = 'DeleteEvent';
|
||||
|
||||
export function deleteEvent(dcOrVars, vars) {
|
||||
return executeMutation(deleteEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
|
||||
export function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
}
|
||||
|
||||
export const getEventByIdRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'getEventById', inputVars);
|
||||
}
|
||||
getEventByIdRef.operationName = 'getEventById';
|
||||
|
||||
export function getEventById(dcOrVars, vars) {
|
||||
return executeQuery(getEventByIdRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const filterEventsRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'filterEvents', inputVars);
|
||||
}
|
||||
filterEventsRef.operationName = 'filterEvents';
|
||||
|
||||
export function filterEvents(dcOrVars, vars) {
|
||||
return executeQuery(filterEventsRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
|
||||
@@ -8,6 +8,14 @@ const BackgroundCheckStatus = {
|
||||
}
|
||||
exports.BackgroundCheckStatus = BackgroundCheckStatus;
|
||||
|
||||
const ContractType = {
|
||||
W2: "W2",
|
||||
C1099: "C1099",
|
||||
TEMP: "TEMP",
|
||||
CONTRACT: "CONTRACT",
|
||||
}
|
||||
exports.ContractType = ContractType;
|
||||
|
||||
const EmploymentType = {
|
||||
FULL_TIME: "FULL_TIME",
|
||||
PART_TIME: "PART_TIME",
|
||||
@@ -69,18 +77,6 @@ const connectorConfig = {
|
||||
};
|
||||
exports.connectorConfig = connectorConfig;
|
||||
|
||||
const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
exports.listEventsRef = listEventsRef;
|
||||
|
||||
exports.listEvents = function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
};
|
||||
|
||||
const createStaffRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
@@ -188,3 +184,63 @@ exports.createEventRef = createEventRef;
|
||||
exports.createEvent = function createEvent(dcOrVars, vars) {
|
||||
return executeMutation(createEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const updateEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'UpdateEvent', inputVars);
|
||||
}
|
||||
updateEventRef.operationName = 'UpdateEvent';
|
||||
exports.updateEventRef = updateEventRef;
|
||||
|
||||
exports.updateEvent = function updateEvent(dcOrVars, vars) {
|
||||
return executeMutation(updateEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const deleteEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'DeleteEvent', inputVars);
|
||||
}
|
||||
deleteEventRef.operationName = 'DeleteEvent';
|
||||
exports.deleteEventRef = deleteEventRef;
|
||||
|
||||
exports.deleteEvent = function deleteEvent(dcOrVars, vars) {
|
||||
return executeMutation(deleteEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
exports.listEventsRef = listEventsRef;
|
||||
|
||||
exports.listEvents = function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
};
|
||||
|
||||
const getEventByIdRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'getEventById', inputVars);
|
||||
}
|
||||
getEventByIdRef.operationName = 'getEventById';
|
||||
exports.getEventByIdRef = getEventByIdRef;
|
||||
|
||||
exports.getEventById = function getEventById(dcOrVars, vars) {
|
||||
return executeQuery(getEventByIdRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const filterEventsRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'filterEvents', inputVars);
|
||||
}
|
||||
filterEventsRef.operationName = 'filterEvents';
|
||||
exports.filterEventsRef = filterEventsRef;
|
||||
|
||||
exports.filterEvents = function filterEvents(dcOrVars, vars) {
|
||||
return executeQuery(filterEventsRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
280
frontend-web/src/dataconnect-generated/index.d.ts
vendored
280
frontend-web/src/dataconnect-generated/index.d.ts
vendored
@@ -15,6 +15,13 @@ export enum BackgroundCheckStatus {
|
||||
EXPIRED = "EXPIRED",
|
||||
};
|
||||
|
||||
export enum ContractType {
|
||||
W2 = "W2",
|
||||
C1099 = "C1099",
|
||||
TEMP = "TEMP",
|
||||
CONTRACT = "CONTRACT",
|
||||
};
|
||||
|
||||
export enum EmploymentType {
|
||||
FULL_TIME = "FULL_TIME",
|
||||
PART_TIME = "PART_TIME",
|
||||
@@ -71,14 +78,37 @@ export interface CreateEventData {
|
||||
|
||||
export interface CreateEventVariables {
|
||||
eventName: string;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
@@ -113,6 +143,14 @@ export interface CreateVendorVariables {
|
||||
isActive?: boolean | null;
|
||||
}
|
||||
|
||||
export interface DeleteEventData {
|
||||
event_delete?: Event_Key | null;
|
||||
}
|
||||
|
||||
export interface DeleteEventVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
|
||||
export interface DeleteVendorData {
|
||||
vendor_delete?: Vendor_Key | null;
|
||||
}
|
||||
@@ -126,6 +164,61 @@ export interface Event_Key {
|
||||
__typename?: 'Event_Key';
|
||||
}
|
||||
|
||||
export interface FilterEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
|
||||
export interface FilterEventsVariables {
|
||||
status?: EventStatus | null;
|
||||
businessId?: UUIDString | null;
|
||||
vendorId?: UUIDString | null;
|
||||
isRecurring?: boolean | null;
|
||||
isRapid?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
date?: TimestampString | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
clientEmail?: string | null;
|
||||
}
|
||||
|
||||
export interface FilterVendorsData {
|
||||
vendors: ({
|
||||
id: UUIDString;
|
||||
@@ -149,6 +242,50 @@ export interface FilterVendorsVariables {
|
||||
platformType?: VendorPlatformType | null;
|
||||
}
|
||||
|
||||
export interface GetEventByIdData {
|
||||
event?: {
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key;
|
||||
}
|
||||
|
||||
export interface GetEventByIdVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
|
||||
export interface GetVendorByIdData {
|
||||
vendor?: {
|
||||
id: UUIDString;
|
||||
@@ -172,12 +309,37 @@ export interface ListEventsData {
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
|
||||
@@ -214,6 +376,48 @@ export interface Staff_Key {
|
||||
__typename?: 'Staff_Key';
|
||||
}
|
||||
|
||||
export interface UpdateEventData {
|
||||
event_update?: Event_Key | null;
|
||||
}
|
||||
|
||||
export interface UpdateEventVariables {
|
||||
id: UUIDString;
|
||||
eventName?: string | null;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId?: UUIDString | null;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status?: EventStatus | null;
|
||||
date?: TimestampString | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
|
||||
export interface UpdateVendorData {
|
||||
vendor_update?: Vendor_Key | null;
|
||||
}
|
||||
@@ -234,18 +438,6 @@ export interface Vendor_Key {
|
||||
__typename?: 'Vendor_Key';
|
||||
}
|
||||
|
||||
interface ListEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(): QueryRef<ListEventsData, undefined>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect): QueryRef<ListEventsData, undefined>;
|
||||
operationName: string;
|
||||
}
|
||||
export const listEventsRef: ListEventsRef;
|
||||
|
||||
export function listEvents(): QueryPromise<ListEventsData, undefined>;
|
||||
export function listEvents(dc: DataConnect): QueryPromise<ListEventsData, undefined>;
|
||||
|
||||
interface CreateStaffRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: CreateStaffVariables): MutationRef<CreateStaffData, CreateStaffVariables>;
|
||||
@@ -354,3 +546,63 @@ export const createEventRef: CreateEventRef;
|
||||
export function createEvent(vars: CreateEventVariables): MutationPromise<CreateEventData, CreateEventVariables>;
|
||||
export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise<CreateEventData, CreateEventVariables>;
|
||||
|
||||
interface UpdateEventRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: UpdateEventVariables): MutationRef<UpdateEventData, UpdateEventVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: UpdateEventVariables): MutationRef<UpdateEventData, UpdateEventVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const updateEventRef: UpdateEventRef;
|
||||
|
||||
export function updateEvent(vars: UpdateEventVariables): MutationPromise<UpdateEventData, UpdateEventVariables>;
|
||||
export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise<UpdateEventData, UpdateEventVariables>;
|
||||
|
||||
interface DeleteEventRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: DeleteEventVariables): MutationRef<DeleteEventData, DeleteEventVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: DeleteEventVariables): MutationRef<DeleteEventData, DeleteEventVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const deleteEventRef: DeleteEventRef;
|
||||
|
||||
export function deleteEvent(vars: DeleteEventVariables): MutationPromise<DeleteEventData, DeleteEventVariables>;
|
||||
export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise<DeleteEventData, DeleteEventVariables>;
|
||||
|
||||
interface ListEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(): QueryRef<ListEventsData, undefined>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect): QueryRef<ListEventsData, undefined>;
|
||||
operationName: string;
|
||||
}
|
||||
export const listEventsRef: ListEventsRef;
|
||||
|
||||
export function listEvents(): QueryPromise<ListEventsData, undefined>;
|
||||
export function listEvents(dc: DataConnect): QueryPromise<ListEventsData, undefined>;
|
||||
|
||||
interface GetEventByIdRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: GetEventByIdVariables): QueryRef<GetEventByIdData, GetEventByIdVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: GetEventByIdVariables): QueryRef<GetEventByIdData, GetEventByIdVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const getEventByIdRef: GetEventByIdRef;
|
||||
|
||||
export function getEventById(vars: GetEventByIdVariables): QueryPromise<GetEventByIdData, GetEventByIdVariables>;
|
||||
export function getEventById(dc: DataConnect, vars: GetEventByIdVariables): QueryPromise<GetEventByIdData, GetEventByIdVariables>;
|
||||
|
||||
interface FilterEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars?: FilterEventsVariables): QueryRef<FilterEventsData, FilterEventsVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars?: FilterEventsVariables): QueryRef<FilterEventsData, FilterEventsVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const filterEventsRef: FilterEventsRef;
|
||||
|
||||
export function filterEvents(vars?: FilterEventsVariables): QueryPromise<FilterEventsData, FilterEventsVariables>;
|
||||
export function filterEvents(dc: DataConnect, vars?: FilterEventsVariables): QueryPromise<FilterEventsData, FilterEventsVariables>;
|
||||
|
||||
|
||||
@@ -17,17 +17,21 @@ You can also follow the instructions from the [Data Connect documentation](https
|
||||
- [**Accessing the connector**](#accessing-the-connector)
|
||||
- [*Connecting to the local Emulator*](#connecting-to-the-local-emulator)
|
||||
- [**Queries**](#queries)
|
||||
- [*listEvents*](#listevents)
|
||||
- [*listStaff*](#liststaff)
|
||||
- [*listVendor*](#listvendor)
|
||||
- [*getVendorById*](#getvendorbyid)
|
||||
- [*filterVendors*](#filtervendors)
|
||||
- [*listEvents*](#listevents)
|
||||
- [*getEventById*](#geteventbyid)
|
||||
- [*filterEvents*](#filterevents)
|
||||
- [**Mutations**](#mutations)
|
||||
- [*CreateStaff*](#createstaff)
|
||||
- [*CreateVendor*](#createvendor)
|
||||
- [*UpdateVendor*](#updatevendor)
|
||||
- [*DeleteVendor*](#deletevendor)
|
||||
- [*CreateEvent*](#createevent)
|
||||
- [*UpdateEvent*](#updateevent)
|
||||
- [*DeleteEvent*](#deleteevent)
|
||||
|
||||
# TanStack Query Firebase & TanStack React Query
|
||||
This SDK provides [React](https://react.dev/) hooks generated specific to your application, for the operations found in the connector `krow-connector`. These hooks are generated using [TanStack Query Firebase](https://react-query-firebase.invertase.dev/) by our partners at Invertase, a library built on top of [TanStack React Query v5](https://tanstack.com/query/v5/docs/framework/react/overview).
|
||||
@@ -119,86 +123,6 @@ Here's a general overview of how to use the generated Query hooks in your code:
|
||||
|
||||
Below are examples of how to use the `krow-connector` connector's generated Query hook functions to execute each Query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#operations-react-angular).
|
||||
|
||||
## listEvents
|
||||
You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `listEvents` Query has no variables.
|
||||
### Return Type
|
||||
Recall that calling the `listEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listEvents` Query is of type `ListEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface ListEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRecurring: boolean;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
businessId: UUIDString;
|
||||
vendorId?: UUIDString | null;
|
||||
total?: number | null;
|
||||
requested?: number | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `listEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig } from '@dataconnect/generated';
|
||||
import { useListEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function ListEventsComponent() {
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useListEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useListEvents(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(dataConnect, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## listStaff
|
||||
You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
@@ -557,6 +481,375 @@ export default function FilterVendorsComponent() {
|
||||
}
|
||||
```
|
||||
|
||||
## listEvents
|
||||
You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `listEvents` Query has no variables.
|
||||
### Return Type
|
||||
Recall that calling the `listEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listEvents` Query is of type `ListEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface ListEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `listEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig } from '@dataconnect/generated';
|
||||
import { useListEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function ListEventsComponent() {
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useListEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useListEvents(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(dataConnect, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## getEventById
|
||||
You can execute the `getEventById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useGetEventById(vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `getEventById` Query requires an argument of type `GetEventByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface GetEventByIdVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `getEventById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `getEventById` Query is of type `GetEventByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface GetEventByIdData {
|
||||
event?: {
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `getEventById`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, GetEventByIdVariables } from '@dataconnect/generated';
|
||||
import { useGetEventById } from '@dataconnect/generated/react'
|
||||
|
||||
export default function GetEventByIdComponent() {
|
||||
// The `useGetEventById` Query hook requires an argument of type `GetEventByIdVariables`:
|
||||
const getEventByIdVars: GetEventByIdVariables = {
|
||||
id: ...,
|
||||
};
|
||||
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useGetEventById(getEventByIdVars);
|
||||
// Variables can be defined inline as well.
|
||||
const query = useGetEventById({ id: ..., });
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useGetEventById(dataConnect, getEventByIdVars);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useGetEventById(getEventByIdVars, options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useGetEventById(dataConnect, getEventByIdVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.event);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## filterEvents
|
||||
You can execute the `filterEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `filterEvents` Query has an optional argument of type `FilterEventsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface FilterEventsVariables {
|
||||
status?: EventStatus | null;
|
||||
businessId?: UUIDString | null;
|
||||
vendorId?: UUIDString | null;
|
||||
isRecurring?: boolean | null;
|
||||
isRapid?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
date?: TimestampString | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
clientEmail?: string | null;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `filterEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `filterEvents` Query is of type `FilterEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface FilterEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `filterEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, FilterEventsVariables } from '@dataconnect/generated';
|
||||
import { useFilterEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function FilterEventsComponent() {
|
||||
// The `useFilterEvents` Query hook has an optional argument of type `FilterEventsVariables`:
|
||||
const filterEventsVars: FilterEventsVariables = {
|
||||
status: ..., // optional
|
||||
businessId: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isRapid: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
date: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
};
|
||||
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useFilterEvents(filterEventsVars);
|
||||
// Variables can be defined inline as well.
|
||||
const query = useFilterEvents({ status: ..., businessId: ..., vendorId: ..., isRecurring: ..., isRapid: ..., isMultiDay: ..., recurrenceType: ..., date: ..., hub: ..., eventLocation: ..., contractType: ..., clientEmail: ..., });
|
||||
// Since all variables are optional for this Query, you can omit the `FilterEventsVariables` argument.
|
||||
// (as long as you don't want to provide any `options`!)
|
||||
const query = useFilterEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useFilterEvents(dataConnect, filterEventsVars);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useFilterEvents(filterEventsVars, options);
|
||||
// If you'd like to provide options without providing any variables, you must
|
||||
// pass `undefined` where you would normally pass the variables.
|
||||
const query = useFilterEvents(undefined, options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useFilterEvents(dataConnect, filterEventsVars /** or undefined */, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
# Mutations
|
||||
|
||||
The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase.
|
||||
@@ -1016,14 +1309,37 @@ The `CreateEvent` Mutation requires an argument of type `CreateEventVariables`,
|
||||
```javascript
|
||||
export interface CreateEventVariables {
|
||||
eventName: string;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
@@ -1076,20 +1392,43 @@ export default function CreateEventComponent() {
|
||||
// The `useCreateEvent` Mutation requires an argument of type `CreateEventVariables`:
|
||||
const createEventVars: CreateEventVariables = {
|
||||
eventName: ...,
|
||||
isRecurring: ...,
|
||||
isRapid: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
recurrenceStartDate: ..., // optional
|
||||
recurrenceEndDate: ..., // optional
|
||||
scatterDates: ..., // optional
|
||||
multiDayStartDate: ..., // optional
|
||||
multiDayEndDate: ..., // optional
|
||||
bufferTimeBefore: ..., // optional
|
||||
bufferTimeAfter: ..., // optional
|
||||
conflictDetectionEnabled: ..., // optional
|
||||
detectedConflicts: ..., // optional
|
||||
businessId: ...,
|
||||
businessName: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
vendorName: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
poReference: ..., // optional
|
||||
status: ...,
|
||||
date: ...,
|
||||
shifts: ..., // optional
|
||||
addons: ..., // optional
|
||||
total: ..., // optional
|
||||
clientName: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
clientPhone: ..., // optional
|
||||
invoiceId: ..., // optional
|
||||
notes: ..., // optional
|
||||
requested: ..., // optional
|
||||
assignedStaff: ..., // optional
|
||||
};
|
||||
mutation.mutate(createEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ eventName: ..., isRecurring: ..., recurrenceType: ..., businessId: ..., vendorId: ..., status: ..., date: ..., shifts: ..., total: ..., requested: ..., assignedStaff: ..., });
|
||||
mutation.mutate({ eventName: ..., isRapid: ..., isRecurring: ..., isMultiDay: ..., recurrenceType: ..., recurrenceStartDate: ..., recurrenceEndDate: ..., scatterDates: ..., multiDayStartDate: ..., multiDayEndDate: ..., bufferTimeBefore: ..., bufferTimeAfter: ..., conflictDetectionEnabled: ..., detectedConflicts: ..., businessId: ..., businessName: ..., vendorId: ..., vendorName: ..., hub: ..., eventLocation: ..., contractType: ..., poReference: ..., status: ..., date: ..., shifts: ..., addons: ..., total: ..., clientName: ..., clientEmail: ..., clientPhone: ..., invoiceId: ..., notes: ..., requested: ..., assignedStaff: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
@@ -1114,3 +1453,259 @@ export default function CreateEventComponent() {
|
||||
}
|
||||
```
|
||||
|
||||
## UpdateEvent
|
||||
You can execute the `UpdateEvent` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)):
|
||||
```javascript
|
||||
useUpdateEvent(options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
```javascript
|
||||
useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `UpdateEvent` Mutation requires an argument of type `UpdateEventVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface UpdateEventVariables {
|
||||
id: UUIDString;
|
||||
eventName?: string | null;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId?: UUIDString | null;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status?: EventStatus | null;
|
||||
date?: TimestampString | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `UpdateEvent` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things.
|
||||
|
||||
To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields.
|
||||
|
||||
To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation.
|
||||
|
||||
To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateEvent` Mutation is of type `UpdateEventData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface UpdateEventData {
|
||||
event_update?: Event_Key | null;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
|
||||
|
||||
### Using `UpdateEvent`'s Mutation hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, UpdateEventVariables } from '@dataconnect/generated';
|
||||
import { useUpdateEvent } from '@dataconnect/generated/react'
|
||||
|
||||
export default function UpdateEventComponent() {
|
||||
// Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation.
|
||||
const mutation = useUpdateEvent();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const mutation = useUpdateEvent(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useUpdateEvent(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useUpdateEvent(dataConnect, options);
|
||||
|
||||
// After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation.
|
||||
// The `useUpdateEvent` Mutation requires an argument of type `UpdateEventVariables`:
|
||||
const updateEventVars: UpdateEventVariables = {
|
||||
id: ...,
|
||||
eventName: ..., // optional
|
||||
isRapid: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
recurrenceStartDate: ..., // optional
|
||||
recurrenceEndDate: ..., // optional
|
||||
scatterDates: ..., // optional
|
||||
multiDayStartDate: ..., // optional
|
||||
multiDayEndDate: ..., // optional
|
||||
bufferTimeBefore: ..., // optional
|
||||
bufferTimeAfter: ..., // optional
|
||||
conflictDetectionEnabled: ..., // optional
|
||||
detectedConflicts: ..., // optional
|
||||
businessId: ..., // optional
|
||||
businessName: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
vendorName: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
poReference: ..., // optional
|
||||
status: ..., // optional
|
||||
date: ..., // optional
|
||||
shifts: ..., // optional
|
||||
addons: ..., // optional
|
||||
total: ..., // optional
|
||||
clientName: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
clientPhone: ..., // optional
|
||||
invoiceId: ..., // optional
|
||||
notes: ..., // optional
|
||||
requested: ..., // optional
|
||||
assignedStaff: ..., // optional
|
||||
};
|
||||
mutation.mutate(updateEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ id: ..., eventName: ..., isRapid: ..., isRecurring: ..., isMultiDay: ..., recurrenceType: ..., recurrenceStartDate: ..., recurrenceEndDate: ..., scatterDates: ..., multiDayStartDate: ..., multiDayEndDate: ..., bufferTimeBefore: ..., bufferTimeAfter: ..., conflictDetectionEnabled: ..., detectedConflicts: ..., businessId: ..., businessName: ..., vendorId: ..., vendorName: ..., hub: ..., eventLocation: ..., contractType: ..., poReference: ..., status: ..., date: ..., shifts: ..., addons: ..., total: ..., clientName: ..., clientEmail: ..., clientPhone: ..., invoiceId: ..., notes: ..., requested: ..., assignedStaff: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
mutation.mutate(updateEventVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Mutation.
|
||||
if (mutation.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (mutation.isError) {
|
||||
return <div>Error: {mutation.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field.
|
||||
if (mutation.isSuccess) {
|
||||
console.log(mutation.data.event_update);
|
||||
}
|
||||
return <div>Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## DeleteEvent
|
||||
You can execute the `DeleteEvent` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)):
|
||||
```javascript
|
||||
useDeleteEvent(options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
```javascript
|
||||
useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `DeleteEvent` Mutation requires an argument of type `DeleteEventVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface DeleteEventVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `DeleteEvent` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things.
|
||||
|
||||
To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields.
|
||||
|
||||
To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation.
|
||||
|
||||
To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteEvent` Mutation is of type `DeleteEventData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface DeleteEventData {
|
||||
event_delete?: Event_Key | null;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
|
||||
|
||||
### Using `DeleteEvent`'s Mutation hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, DeleteEventVariables } from '@dataconnect/generated';
|
||||
import { useDeleteEvent } from '@dataconnect/generated/react'
|
||||
|
||||
export default function DeleteEventComponent() {
|
||||
// Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation.
|
||||
const mutation = useDeleteEvent();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const mutation = useDeleteEvent(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useDeleteEvent(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useDeleteEvent(dataConnect, options);
|
||||
|
||||
// After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation.
|
||||
// The `useDeleteEvent` Mutation requires an argument of type `DeleteEventVariables`:
|
||||
const deleteEventVars: DeleteEventVariables = {
|
||||
id: ...,
|
||||
};
|
||||
mutation.mutate(deleteEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ id: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
mutation.mutate(deleteEventVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Mutation.
|
||||
if (mutation.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (mutation.isError) {
|
||||
return <div>Error: {mutation.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field.
|
||||
if (mutation.isSuccess) {
|
||||
console.log(mutation.data.event_delete);
|
||||
}
|
||||
return <div>Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -1,13 +1,7 @@
|
||||
import { listEventsRef, createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, connectorConfig } from '../../esm/index.esm.js';
|
||||
import { createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, connectorConfig } from '../../esm/index.esm.js';
|
||||
import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect';
|
||||
import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect';
|
||||
|
||||
|
||||
export function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
export function useCreateStaff(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
@@ -71,3 +65,38 @@ export function useCreateEvent(dcOrOptions, options) {
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useUpdateEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return updateEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useDeleteEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return deleteEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
|
||||
export function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useGetEventById(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true);
|
||||
const ref = getEventByIdRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useFilterEvents(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false);
|
||||
const ref = filterEventsRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
@@ -1,13 +1,7 @@
|
||||
const { listEventsRef, createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, connectorConfig } = require('../index.cjs.js');
|
||||
const { createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, connectorConfig } = require('../index.cjs.js');
|
||||
const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect');
|
||||
const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect');
|
||||
|
||||
|
||||
exports.useListEvents = function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
@@ -71,3 +65,38 @@ exports.useCreateEvent = function useCreateEvent(dcOrOptions, options) {
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return updateEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return deleteEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
|
||||
exports.useListEvents = function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useGetEventById = function useGetEventById(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true);
|
||||
const ref = getEventByIdRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useFilterEvents = function useFilterEvents(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false);
|
||||
const ref = filterEventsRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
@@ -1,13 +1,10 @@
|
||||
import { ListEventsData, CreateStaffData, CreateStaffVariables, ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateEventData, CreateEventVariables } from '../';
|
||||
import { CreateStaffData, CreateStaffVariables, ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables } from '../';
|
||||
import { UseDataConnectQueryResult, useDataConnectQueryOptions, UseDataConnectMutationResult, useDataConnectMutationOptions} from '@tanstack-query-firebase/react/data-connect';
|
||||
import { UseQueryResult, UseMutationResult} from '@tanstack/react-query';
|
||||
import { DataConnect } from 'firebase/data-connect';
|
||||
import { FirebaseError } from 'firebase/app';
|
||||
|
||||
|
||||
export function useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
|
||||
export function useCreateStaff(options?: useDataConnectMutationOptions<CreateStaffData, FirebaseError, CreateStaffVariables>): UseDataConnectMutationResult<CreateStaffData, CreateStaffVariables>;
|
||||
export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions<CreateStaffData, FirebaseError, CreateStaffVariables>): UseDataConnectMutationResult<CreateStaffData, CreateStaffVariables>;
|
||||
|
||||
@@ -34,3 +31,18 @@ export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables,
|
||||
|
||||
export function useCreateEvent(options?: useDataConnectMutationOptions<CreateEventData, FirebaseError, CreateEventVariables>): UseDataConnectMutationResult<CreateEventData, CreateEventVariables>;
|
||||
export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<CreateEventData, FirebaseError, CreateEventVariables>): UseDataConnectMutationResult<CreateEventData, CreateEventVariables>;
|
||||
|
||||
export function useUpdateEvent(options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
|
||||
export function useDeleteEvent(options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
|
||||
export function useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
|
||||
export function useGetEventById(vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
export function useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
|
||||
export function useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
|
||||
@@ -12,11 +12,9 @@ For each operation, there is a wrapper hook that can be used to call the operati
|
||||
|
||||
Here are all of the hooks that get generated:
|
||||
```ts
|
||||
import { useListEvents, useCreateStaff, useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateEvent } from '@dataconnect/generated/react';
|
||||
import { useCreateStaff, useListStaff, useCreateVendor, useUpdateVendor, useDeleteVendor, useListVendor, useGetVendorById, useFilterVendors, useCreateEvent, useUpdateEvent } from '@dataconnect/generated/react';
|
||||
// The types of these hooks are available in react/index.d.ts
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useListEvents();
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useCreateStaff(createStaffVars);
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useListStaff();
|
||||
@@ -35,6 +33,8 @@ const { data, isPending, isSuccess, isError, error } = useFilterVendors(filterVe
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useCreateEvent(createEventVars);
|
||||
|
||||
const { data, isPending, isSuccess, isError, error } = useUpdateEvent(updateEventVars);
|
||||
|
||||
```
|
||||
|
||||
Here's an example from a different generated SDK:
|
||||
@@ -72,12 +72,9 @@ If a user is not using a supported framework, they can use the generated SDK dir
|
||||
Here's an example of how to use it with the first 5 operations:
|
||||
|
||||
```js
|
||||
import { listEvents, createStaff, listStaff, createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createEvent } from '@dataconnect/generated';
|
||||
import { createStaff, listStaff, createVendor, updateVendor, deleteVendor, listVendor, getVendorById, filterVendors, createEvent, updateEvent } from '@dataconnect/generated';
|
||||
|
||||
|
||||
// Operation listEvents:
|
||||
const { data } = await ListEvents(dataConnect);
|
||||
|
||||
// Operation CreateStaff: For variables, look at type CreateStaffVars in ../index.d.ts
|
||||
const { data } = await CreateStaff(dataConnect, createStaffVars);
|
||||
|
||||
@@ -105,5 +102,8 @@ const { data } = await FilterVendors(dataConnect, filterVendorsVars);
|
||||
// Operation CreateEvent: For variables, look at type CreateEventVars in ../index.d.ts
|
||||
const { data } = await CreateEvent(dataConnect, createEventVars);
|
||||
|
||||
// Operation UpdateEvent: For variables, look at type UpdateEventVars in ../index.d.ts
|
||||
const { data } = await UpdateEvent(dataConnect, updateEventVars);
|
||||
|
||||
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
@@ -7,6 +7,13 @@ export const BackgroundCheckStatus = {
|
||||
EXPIRED: "EXPIRED",
|
||||
}
|
||||
|
||||
export const ContractType = {
|
||||
W2: "W2",
|
||||
C1099: "C1099",
|
||||
TEMP: "TEMP",
|
||||
CONTRACT: "CONTRACT",
|
||||
}
|
||||
|
||||
export const EmploymentType = {
|
||||
FULL_TIME: "FULL_TIME",
|
||||
PART_TIME: "PART_TIME",
|
||||
@@ -61,17 +68,6 @@ export const connectorConfig = {
|
||||
location: 'us-central1'
|
||||
};
|
||||
|
||||
export const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
|
||||
export function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
}
|
||||
|
||||
export const createStaffRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
@@ -171,3 +167,58 @@ export function createEvent(dcOrVars, vars) {
|
||||
return executeMutation(createEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const updateEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'UpdateEvent', inputVars);
|
||||
}
|
||||
updateEventRef.operationName = 'UpdateEvent';
|
||||
|
||||
export function updateEvent(dcOrVars, vars) {
|
||||
return executeMutation(updateEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const deleteEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'DeleteEvent', inputVars);
|
||||
}
|
||||
deleteEventRef.operationName = 'DeleteEvent';
|
||||
|
||||
export function deleteEvent(dcOrVars, vars) {
|
||||
return executeMutation(deleteEventRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
|
||||
export function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
}
|
||||
|
||||
export const getEventByIdRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'getEventById', inputVars);
|
||||
}
|
||||
getEventByIdRef.operationName = 'getEventById';
|
||||
|
||||
export function getEventById(dcOrVars, vars) {
|
||||
return executeQuery(getEventByIdRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
export const filterEventsRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'filterEvents', inputVars);
|
||||
}
|
||||
filterEventsRef.operationName = 'filterEvents';
|
||||
|
||||
export function filterEvents(dcOrVars, vars) {
|
||||
return executeQuery(filterEventsRef(dcOrVars, vars));
|
||||
}
|
||||
|
||||
|
||||
@@ -8,6 +8,14 @@ const BackgroundCheckStatus = {
|
||||
}
|
||||
exports.BackgroundCheckStatus = BackgroundCheckStatus;
|
||||
|
||||
const ContractType = {
|
||||
W2: "W2",
|
||||
C1099: "C1099",
|
||||
TEMP: "TEMP",
|
||||
CONTRACT: "CONTRACT",
|
||||
}
|
||||
exports.ContractType = ContractType;
|
||||
|
||||
const EmploymentType = {
|
||||
FULL_TIME: "FULL_TIME",
|
||||
PART_TIME: "PART_TIME",
|
||||
@@ -69,18 +77,6 @@ const connectorConfig = {
|
||||
};
|
||||
exports.connectorConfig = connectorConfig;
|
||||
|
||||
const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
exports.listEventsRef = listEventsRef;
|
||||
|
||||
exports.listEvents = function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
};
|
||||
|
||||
const createStaffRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
@@ -188,3 +184,63 @@ exports.createEventRef = createEventRef;
|
||||
exports.createEvent = function createEvent(dcOrVars, vars) {
|
||||
return executeMutation(createEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const updateEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'UpdateEvent', inputVars);
|
||||
}
|
||||
updateEventRef.operationName = 'UpdateEvent';
|
||||
exports.updateEventRef = updateEventRef;
|
||||
|
||||
exports.updateEvent = function updateEvent(dcOrVars, vars) {
|
||||
return executeMutation(updateEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const deleteEventRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return mutationRef(dcInstance, 'DeleteEvent', inputVars);
|
||||
}
|
||||
deleteEventRef.operationName = 'DeleteEvent';
|
||||
exports.deleteEventRef = deleteEventRef;
|
||||
|
||||
exports.deleteEvent = function deleteEvent(dcOrVars, vars) {
|
||||
return executeMutation(deleteEventRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const listEventsRef = (dc) => {
|
||||
const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'listEvents');
|
||||
}
|
||||
listEventsRef.operationName = 'listEvents';
|
||||
exports.listEventsRef = listEventsRef;
|
||||
|
||||
exports.listEvents = function listEvents(dc) {
|
||||
return executeQuery(listEventsRef(dc));
|
||||
};
|
||||
|
||||
const getEventByIdRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'getEventById', inputVars);
|
||||
}
|
||||
getEventByIdRef.operationName = 'getEventById';
|
||||
exports.getEventByIdRef = getEventByIdRef;
|
||||
|
||||
exports.getEventById = function getEventById(dcOrVars, vars) {
|
||||
return executeQuery(getEventByIdRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
const filterEventsRef = (dcOrVars, vars) => {
|
||||
const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars);
|
||||
dcInstance._useGeneratedSdk();
|
||||
return queryRef(dcInstance, 'filterEvents', inputVars);
|
||||
}
|
||||
filterEventsRef.operationName = 'filterEvents';
|
||||
exports.filterEventsRef = filterEventsRef;
|
||||
|
||||
exports.filterEvents = function filterEvents(dcOrVars, vars) {
|
||||
return executeQuery(filterEventsRef(dcOrVars, vars));
|
||||
};
|
||||
|
||||
@@ -15,6 +15,13 @@ export enum BackgroundCheckStatus {
|
||||
EXPIRED = "EXPIRED",
|
||||
};
|
||||
|
||||
export enum ContractType {
|
||||
W2 = "W2",
|
||||
C1099 = "C1099",
|
||||
TEMP = "TEMP",
|
||||
CONTRACT = "CONTRACT",
|
||||
};
|
||||
|
||||
export enum EmploymentType {
|
||||
FULL_TIME = "FULL_TIME",
|
||||
PART_TIME = "PART_TIME",
|
||||
@@ -71,14 +78,37 @@ export interface CreateEventData {
|
||||
|
||||
export interface CreateEventVariables {
|
||||
eventName: string;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
@@ -113,6 +143,14 @@ export interface CreateVendorVariables {
|
||||
isActive?: boolean | null;
|
||||
}
|
||||
|
||||
export interface DeleteEventData {
|
||||
event_delete?: Event_Key | null;
|
||||
}
|
||||
|
||||
export interface DeleteEventVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
|
||||
export interface DeleteVendorData {
|
||||
vendor_delete?: Vendor_Key | null;
|
||||
}
|
||||
@@ -126,6 +164,61 @@ export interface Event_Key {
|
||||
__typename?: 'Event_Key';
|
||||
}
|
||||
|
||||
export interface FilterEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
|
||||
export interface FilterEventsVariables {
|
||||
status?: EventStatus | null;
|
||||
businessId?: UUIDString | null;
|
||||
vendorId?: UUIDString | null;
|
||||
isRecurring?: boolean | null;
|
||||
isRapid?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
date?: TimestampString | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
clientEmail?: string | null;
|
||||
}
|
||||
|
||||
export interface FilterVendorsData {
|
||||
vendors: ({
|
||||
id: UUIDString;
|
||||
@@ -149,6 +242,50 @@ export interface FilterVendorsVariables {
|
||||
platformType?: VendorPlatformType | null;
|
||||
}
|
||||
|
||||
export interface GetEventByIdData {
|
||||
event?: {
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key;
|
||||
}
|
||||
|
||||
export interface GetEventByIdVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
|
||||
export interface GetVendorByIdData {
|
||||
vendor?: {
|
||||
id: UUIDString;
|
||||
@@ -172,12 +309,37 @@ export interface ListEventsData {
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
|
||||
@@ -214,6 +376,48 @@ export interface Staff_Key {
|
||||
__typename?: 'Staff_Key';
|
||||
}
|
||||
|
||||
export interface UpdateEventData {
|
||||
event_update?: Event_Key | null;
|
||||
}
|
||||
|
||||
export interface UpdateEventVariables {
|
||||
id: UUIDString;
|
||||
eventName?: string | null;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId?: UUIDString | null;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status?: EventStatus | null;
|
||||
date?: TimestampString | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
|
||||
export interface UpdateVendorData {
|
||||
vendor_update?: Vendor_Key | null;
|
||||
}
|
||||
@@ -234,18 +438,6 @@ export interface Vendor_Key {
|
||||
__typename?: 'Vendor_Key';
|
||||
}
|
||||
|
||||
interface ListEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(): QueryRef<ListEventsData, undefined>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect): QueryRef<ListEventsData, undefined>;
|
||||
operationName: string;
|
||||
}
|
||||
export const listEventsRef: ListEventsRef;
|
||||
|
||||
export function listEvents(): QueryPromise<ListEventsData, undefined>;
|
||||
export function listEvents(dc: DataConnect): QueryPromise<ListEventsData, undefined>;
|
||||
|
||||
interface CreateStaffRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: CreateStaffVariables): MutationRef<CreateStaffData, CreateStaffVariables>;
|
||||
@@ -354,3 +546,63 @@ export const createEventRef: CreateEventRef;
|
||||
export function createEvent(vars: CreateEventVariables): MutationPromise<CreateEventData, CreateEventVariables>;
|
||||
export function createEvent(dc: DataConnect, vars: CreateEventVariables): MutationPromise<CreateEventData, CreateEventVariables>;
|
||||
|
||||
interface UpdateEventRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: UpdateEventVariables): MutationRef<UpdateEventData, UpdateEventVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: UpdateEventVariables): MutationRef<UpdateEventData, UpdateEventVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const updateEventRef: UpdateEventRef;
|
||||
|
||||
export function updateEvent(vars: UpdateEventVariables): MutationPromise<UpdateEventData, UpdateEventVariables>;
|
||||
export function updateEvent(dc: DataConnect, vars: UpdateEventVariables): MutationPromise<UpdateEventData, UpdateEventVariables>;
|
||||
|
||||
interface DeleteEventRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: DeleteEventVariables): MutationRef<DeleteEventData, DeleteEventVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: DeleteEventVariables): MutationRef<DeleteEventData, DeleteEventVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const deleteEventRef: DeleteEventRef;
|
||||
|
||||
export function deleteEvent(vars: DeleteEventVariables): MutationPromise<DeleteEventData, DeleteEventVariables>;
|
||||
export function deleteEvent(dc: DataConnect, vars: DeleteEventVariables): MutationPromise<DeleteEventData, DeleteEventVariables>;
|
||||
|
||||
interface ListEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(): QueryRef<ListEventsData, undefined>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect): QueryRef<ListEventsData, undefined>;
|
||||
operationName: string;
|
||||
}
|
||||
export const listEventsRef: ListEventsRef;
|
||||
|
||||
export function listEvents(): QueryPromise<ListEventsData, undefined>;
|
||||
export function listEvents(dc: DataConnect): QueryPromise<ListEventsData, undefined>;
|
||||
|
||||
interface GetEventByIdRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars: GetEventByIdVariables): QueryRef<GetEventByIdData, GetEventByIdVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars: GetEventByIdVariables): QueryRef<GetEventByIdData, GetEventByIdVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const getEventByIdRef: GetEventByIdRef;
|
||||
|
||||
export function getEventById(vars: GetEventByIdVariables): QueryPromise<GetEventByIdData, GetEventByIdVariables>;
|
||||
export function getEventById(dc: DataConnect, vars: GetEventByIdVariables): QueryPromise<GetEventByIdData, GetEventByIdVariables>;
|
||||
|
||||
interface FilterEventsRef {
|
||||
/* Allow users to create refs without passing in DataConnect */
|
||||
(vars?: FilterEventsVariables): QueryRef<FilterEventsData, FilterEventsVariables>;
|
||||
/* Allow users to pass in custom DataConnect instances */
|
||||
(dc: DataConnect, vars?: FilterEventsVariables): QueryRef<FilterEventsData, FilterEventsVariables>;
|
||||
operationName: string;
|
||||
}
|
||||
export const filterEventsRef: FilterEventsRef;
|
||||
|
||||
export function filterEvents(vars?: FilterEventsVariables): QueryPromise<FilterEventsData, FilterEventsVariables>;
|
||||
export function filterEvents(dc: DataConnect, vars?: FilterEventsVariables): QueryPromise<FilterEventsData, FilterEventsVariables>;
|
||||
|
||||
|
||||
@@ -17,17 +17,21 @@ You can also follow the instructions from the [Data Connect documentation](https
|
||||
- [**Accessing the connector**](#accessing-the-connector)
|
||||
- [*Connecting to the local Emulator*](#connecting-to-the-local-emulator)
|
||||
- [**Queries**](#queries)
|
||||
- [*listEvents*](#listevents)
|
||||
- [*listStaff*](#liststaff)
|
||||
- [*listVendor*](#listvendor)
|
||||
- [*getVendorById*](#getvendorbyid)
|
||||
- [*filterVendors*](#filtervendors)
|
||||
- [*listEvents*](#listevents)
|
||||
- [*getEventById*](#geteventbyid)
|
||||
- [*filterEvents*](#filterevents)
|
||||
- [**Mutations**](#mutations)
|
||||
- [*CreateStaff*](#createstaff)
|
||||
- [*CreateVendor*](#createvendor)
|
||||
- [*UpdateVendor*](#updatevendor)
|
||||
- [*DeleteVendor*](#deletevendor)
|
||||
- [*CreateEvent*](#createevent)
|
||||
- [*UpdateEvent*](#updateevent)
|
||||
- [*DeleteEvent*](#deleteevent)
|
||||
|
||||
# TanStack Query Firebase & TanStack React Query
|
||||
This SDK provides [React](https://react.dev/) hooks generated specific to your application, for the operations found in the connector `krow-connector`. These hooks are generated using [TanStack Query Firebase](https://react-query-firebase.invertase.dev/) by our partners at Invertase, a library built on top of [TanStack React Query v5](https://tanstack.com/query/v5/docs/framework/react/overview).
|
||||
@@ -119,86 +123,6 @@ Here's a general overview of how to use the generated Query hooks in your code:
|
||||
|
||||
Below are examples of how to use the `krow-connector` connector's generated Query hook functions to execute each Query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#operations-react-angular).
|
||||
|
||||
## listEvents
|
||||
You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `listEvents` Query has no variables.
|
||||
### Return Type
|
||||
Recall that calling the `listEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listEvents` Query is of type `ListEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface ListEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRecurring: boolean;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
businessId: UUIDString;
|
||||
vendorId?: UUIDString | null;
|
||||
total?: number | null;
|
||||
requested?: number | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `listEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig } from '@dataconnect/generated';
|
||||
import { useListEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function ListEventsComponent() {
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useListEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useListEvents(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(dataConnect, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## listStaff
|
||||
You can execute the `listStaff` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
@@ -557,6 +481,375 @@ export default function FilterVendorsComponent() {
|
||||
}
|
||||
```
|
||||
|
||||
## listEvents
|
||||
You can execute the `listEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `listEvents` Query has no variables.
|
||||
### Return Type
|
||||
Recall that calling the `listEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `listEvents` Query is of type `ListEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface ListEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `listEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig } from '@dataconnect/generated';
|
||||
import { useListEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function ListEventsComponent() {
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useListEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useListEvents(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useListEvents(dataConnect, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## getEventById
|
||||
You can execute the `getEventById` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useGetEventById(vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `getEventById` Query requires an argument of type `GetEventByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface GetEventByIdVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `getEventById` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `getEventById` Query is of type `GetEventByIdData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface GetEventByIdData {
|
||||
event?: {
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `getEventById`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, GetEventByIdVariables } from '@dataconnect/generated';
|
||||
import { useGetEventById } from '@dataconnect/generated/react'
|
||||
|
||||
export default function GetEventByIdComponent() {
|
||||
// The `useGetEventById` Query hook requires an argument of type `GetEventByIdVariables`:
|
||||
const getEventByIdVars: GetEventByIdVariables = {
|
||||
id: ...,
|
||||
};
|
||||
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useGetEventById(getEventByIdVars);
|
||||
// Variables can be defined inline as well.
|
||||
const query = useGetEventById({ id: ..., });
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useGetEventById(dataConnect, getEventByIdVars);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useGetEventById(getEventByIdVars, options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useGetEventById(dataConnect, getEventByIdVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.event);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## filterEvents
|
||||
You can execute the `filterEvents` Query using the following Query hook function, which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts):
|
||||
|
||||
```javascript
|
||||
useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
```javascript
|
||||
useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `filterEvents` Query has an optional argument of type `FilterEventsVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface FilterEventsVariables {
|
||||
status?: EventStatus | null;
|
||||
businessId?: UUIDString | null;
|
||||
vendorId?: UUIDString | null;
|
||||
isRecurring?: boolean | null;
|
||||
isRapid?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
date?: TimestampString | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
clientEmail?: string | null;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `filterEvents` Query hook function returns a `UseQueryResult` object. This object holds the state of your Query, including whether the Query is loading, has completed, or has succeeded/failed, and any data returned by the Query, among other things.
|
||||
|
||||
To check the status of a Query, use the `UseQueryResult.status` field. You can also check for pending / success / error status using the `UseQueryResult.isPending`, `UseQueryResult.isSuccess`, and `UseQueryResult.isError` fields.
|
||||
|
||||
To access the data returned by a Query, use the `UseQueryResult.data` field. The data for the `filterEvents` Query is of type `FilterEventsData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface FilterEventsData {
|
||||
events: ({
|
||||
id: UUIDString;
|
||||
eventName: string;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
} & Event_Key)[];
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseQueryResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery).
|
||||
|
||||
### Using `filterEvents`'s Query hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, FilterEventsVariables } from '@dataconnect/generated';
|
||||
import { useFilterEvents } from '@dataconnect/generated/react'
|
||||
|
||||
export default function FilterEventsComponent() {
|
||||
// The `useFilterEvents` Query hook has an optional argument of type `FilterEventsVariables`:
|
||||
const filterEventsVars: FilterEventsVariables = {
|
||||
status: ..., // optional
|
||||
businessId: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isRapid: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
date: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
};
|
||||
|
||||
// You don't have to do anything to "execute" the Query.
|
||||
// Call the Query hook function to get a `UseQueryResult` object which holds the state of your Query.
|
||||
const query = useFilterEvents(filterEventsVars);
|
||||
// Variables can be defined inline as well.
|
||||
const query = useFilterEvents({ status: ..., businessId: ..., vendorId: ..., isRecurring: ..., isRapid: ..., isMultiDay: ..., recurrenceType: ..., date: ..., hub: ..., eventLocation: ..., contractType: ..., clientEmail: ..., });
|
||||
// Since all variables are optional for this Query, you can omit the `FilterEventsVariables` argument.
|
||||
// (as long as you don't want to provide any `options`!)
|
||||
const query = useFilterEvents();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Query hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const query = useFilterEvents(dataConnect, filterEventsVars);
|
||||
|
||||
// You can also pass in a `useDataConnectQueryOptions` object to the Query hook function.
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useFilterEvents(filterEventsVars, options);
|
||||
// If you'd like to provide options without providing any variables, you must
|
||||
// pass `undefined` where you would normally pass the variables.
|
||||
const query = useFilterEvents(undefined, options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectQueryOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = { staleTime: 5 * 1000 };
|
||||
const query = useFilterEvents(dataConnect, filterEventsVars /** or undefined */, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Query.
|
||||
if (query.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (query.isError) {
|
||||
return <div>Error: {query.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Query is successful, you can access the data returned using the `UseQueryResult.data` field.
|
||||
if (query.isSuccess) {
|
||||
console.log(query.data.events);
|
||||
}
|
||||
return <div>Query execution {query.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
# Mutations
|
||||
|
||||
The React generated SDK provides Mutations hook functions that call and return [`useDataConnectMutation`](https://react-query-firebase.invertase.dev/react/data-connect/mutations) hooks from TanStack Query Firebase.
|
||||
@@ -1016,14 +1309,37 @@ The `CreateEvent` Mutation requires an argument of type `CreateEventVariables`,
|
||||
```javascript
|
||||
export interface CreateEventVariables {
|
||||
eventName: string;
|
||||
isRecurring: boolean;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId: UUIDString;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status: EventStatus;
|
||||
date: TimestampString;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
@@ -1076,20 +1392,43 @@ export default function CreateEventComponent() {
|
||||
// The `useCreateEvent` Mutation requires an argument of type `CreateEventVariables`:
|
||||
const createEventVars: CreateEventVariables = {
|
||||
eventName: ...,
|
||||
isRecurring: ...,
|
||||
isRapid: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
recurrenceStartDate: ..., // optional
|
||||
recurrenceEndDate: ..., // optional
|
||||
scatterDates: ..., // optional
|
||||
multiDayStartDate: ..., // optional
|
||||
multiDayEndDate: ..., // optional
|
||||
bufferTimeBefore: ..., // optional
|
||||
bufferTimeAfter: ..., // optional
|
||||
conflictDetectionEnabled: ..., // optional
|
||||
detectedConflicts: ..., // optional
|
||||
businessId: ...,
|
||||
businessName: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
vendorName: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
poReference: ..., // optional
|
||||
status: ...,
|
||||
date: ...,
|
||||
shifts: ..., // optional
|
||||
addons: ..., // optional
|
||||
total: ..., // optional
|
||||
clientName: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
clientPhone: ..., // optional
|
||||
invoiceId: ..., // optional
|
||||
notes: ..., // optional
|
||||
requested: ..., // optional
|
||||
assignedStaff: ..., // optional
|
||||
};
|
||||
mutation.mutate(createEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ eventName: ..., isRecurring: ..., recurrenceType: ..., businessId: ..., vendorId: ..., status: ..., date: ..., shifts: ..., total: ..., requested: ..., assignedStaff: ..., });
|
||||
mutation.mutate({ eventName: ..., isRapid: ..., isRecurring: ..., isMultiDay: ..., recurrenceType: ..., recurrenceStartDate: ..., recurrenceEndDate: ..., scatterDates: ..., multiDayStartDate: ..., multiDayEndDate: ..., bufferTimeBefore: ..., bufferTimeAfter: ..., conflictDetectionEnabled: ..., detectedConflicts: ..., businessId: ..., businessName: ..., vendorId: ..., vendorName: ..., hub: ..., eventLocation: ..., contractType: ..., poReference: ..., status: ..., date: ..., shifts: ..., addons: ..., total: ..., clientName: ..., clientEmail: ..., clientPhone: ..., invoiceId: ..., notes: ..., requested: ..., assignedStaff: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
@@ -1114,3 +1453,259 @@ export default function CreateEventComponent() {
|
||||
}
|
||||
```
|
||||
|
||||
## UpdateEvent
|
||||
You can execute the `UpdateEvent` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)):
|
||||
```javascript
|
||||
useUpdateEvent(options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
```javascript
|
||||
useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `UpdateEvent` Mutation requires an argument of type `UpdateEventVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface UpdateEventVariables {
|
||||
id: UUIDString;
|
||||
eventName?: string | null;
|
||||
isRapid?: boolean | null;
|
||||
isRecurring?: boolean | null;
|
||||
isMultiDay?: boolean | null;
|
||||
recurrenceType?: RecurrenceType | null;
|
||||
recurrenceStartDate?: TimestampString | null;
|
||||
recurrenceEndDate?: TimestampString | null;
|
||||
scatterDates?: string | null;
|
||||
multiDayStartDate?: TimestampString | null;
|
||||
multiDayEndDate?: TimestampString | null;
|
||||
bufferTimeBefore?: number | null;
|
||||
bufferTimeAfter?: number | null;
|
||||
conflictDetectionEnabled?: boolean | null;
|
||||
detectedConflicts?: string | null;
|
||||
businessId?: UUIDString | null;
|
||||
businessName?: string | null;
|
||||
vendorId?: UUIDString | null;
|
||||
vendorName?: string | null;
|
||||
hub?: string | null;
|
||||
eventLocation?: string | null;
|
||||
contractType?: ContractType | null;
|
||||
poReference?: string | null;
|
||||
status?: EventStatus | null;
|
||||
date?: TimestampString | null;
|
||||
shifts?: string | null;
|
||||
addons?: string | null;
|
||||
total?: number | null;
|
||||
clientName?: string | null;
|
||||
clientEmail?: string | null;
|
||||
clientPhone?: string | null;
|
||||
invoiceId?: UUIDString | null;
|
||||
notes?: string | null;
|
||||
requested?: number | null;
|
||||
assignedStaff?: string | null;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `UpdateEvent` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things.
|
||||
|
||||
To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields.
|
||||
|
||||
To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation.
|
||||
|
||||
To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `UpdateEvent` Mutation is of type `UpdateEventData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface UpdateEventData {
|
||||
event_update?: Event_Key | null;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
|
||||
|
||||
### Using `UpdateEvent`'s Mutation hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, UpdateEventVariables } from '@dataconnect/generated';
|
||||
import { useUpdateEvent } from '@dataconnect/generated/react'
|
||||
|
||||
export default function UpdateEventComponent() {
|
||||
// Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation.
|
||||
const mutation = useUpdateEvent();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const mutation = useUpdateEvent(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useUpdateEvent(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useUpdateEvent(dataConnect, options);
|
||||
|
||||
// After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation.
|
||||
// The `useUpdateEvent` Mutation requires an argument of type `UpdateEventVariables`:
|
||||
const updateEventVars: UpdateEventVariables = {
|
||||
id: ...,
|
||||
eventName: ..., // optional
|
||||
isRapid: ..., // optional
|
||||
isRecurring: ..., // optional
|
||||
isMultiDay: ..., // optional
|
||||
recurrenceType: ..., // optional
|
||||
recurrenceStartDate: ..., // optional
|
||||
recurrenceEndDate: ..., // optional
|
||||
scatterDates: ..., // optional
|
||||
multiDayStartDate: ..., // optional
|
||||
multiDayEndDate: ..., // optional
|
||||
bufferTimeBefore: ..., // optional
|
||||
bufferTimeAfter: ..., // optional
|
||||
conflictDetectionEnabled: ..., // optional
|
||||
detectedConflicts: ..., // optional
|
||||
businessId: ..., // optional
|
||||
businessName: ..., // optional
|
||||
vendorId: ..., // optional
|
||||
vendorName: ..., // optional
|
||||
hub: ..., // optional
|
||||
eventLocation: ..., // optional
|
||||
contractType: ..., // optional
|
||||
poReference: ..., // optional
|
||||
status: ..., // optional
|
||||
date: ..., // optional
|
||||
shifts: ..., // optional
|
||||
addons: ..., // optional
|
||||
total: ..., // optional
|
||||
clientName: ..., // optional
|
||||
clientEmail: ..., // optional
|
||||
clientPhone: ..., // optional
|
||||
invoiceId: ..., // optional
|
||||
notes: ..., // optional
|
||||
requested: ..., // optional
|
||||
assignedStaff: ..., // optional
|
||||
};
|
||||
mutation.mutate(updateEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ id: ..., eventName: ..., isRapid: ..., isRecurring: ..., isMultiDay: ..., recurrenceType: ..., recurrenceStartDate: ..., recurrenceEndDate: ..., scatterDates: ..., multiDayStartDate: ..., multiDayEndDate: ..., bufferTimeBefore: ..., bufferTimeAfter: ..., conflictDetectionEnabled: ..., detectedConflicts: ..., businessId: ..., businessName: ..., vendorId: ..., vendorName: ..., hub: ..., eventLocation: ..., contractType: ..., poReference: ..., status: ..., date: ..., shifts: ..., addons: ..., total: ..., clientName: ..., clientEmail: ..., clientPhone: ..., invoiceId: ..., notes: ..., requested: ..., assignedStaff: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
mutation.mutate(updateEventVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Mutation.
|
||||
if (mutation.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (mutation.isError) {
|
||||
return <div>Error: {mutation.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field.
|
||||
if (mutation.isSuccess) {
|
||||
console.log(mutation.data.event_update);
|
||||
}
|
||||
return <div>Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## DeleteEvent
|
||||
You can execute the `DeleteEvent` Mutation using the `UseMutationResult` object returned by the following Mutation hook function (which is defined in [dataconnect-generated/react/index.d.ts](./index.d.ts)):
|
||||
```javascript
|
||||
useDeleteEvent(options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
```
|
||||
You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
```javascript
|
||||
useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
```
|
||||
|
||||
### Variables
|
||||
The `DeleteEvent` Mutation requires an argument of type `DeleteEventVariables`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
|
||||
```javascript
|
||||
export interface DeleteEventVariables {
|
||||
id: UUIDString;
|
||||
}
|
||||
```
|
||||
### Return Type
|
||||
Recall that calling the `DeleteEvent` Mutation hook function returns a `UseMutationResult` object. This object holds the state of your Mutation, including whether the Mutation is loading, has completed, or has succeeded/failed, among other things.
|
||||
|
||||
To check the status of a Mutation, use the `UseMutationResult.status` field. You can also check for pending / success / error status using the `UseMutationResult.isPending`, `UseMutationResult.isSuccess`, and `UseMutationResult.isError` fields.
|
||||
|
||||
To execute the Mutation, call `UseMutationResult.mutate()`. This function executes the Mutation, but does not return the data from the Mutation.
|
||||
|
||||
To access the data returned by a Mutation, use the `UseMutationResult.data` field. The data for the `DeleteEvent` Mutation is of type `DeleteEventData`, which is defined in [dataconnect-generated/index.d.ts](../index.d.ts). It has the following fields:
|
||||
```javascript
|
||||
export interface DeleteEventData {
|
||||
event_delete?: Event_Key | null;
|
||||
}
|
||||
```
|
||||
|
||||
To learn more about the `UseMutationResult` object, see the [TanStack React Query documentation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation).
|
||||
|
||||
### Using `DeleteEvent`'s Mutation hook function
|
||||
|
||||
```javascript
|
||||
import { getDataConnect } from 'firebase/data-connect';
|
||||
import { connectorConfig, DeleteEventVariables } from '@dataconnect/generated';
|
||||
import { useDeleteEvent } from '@dataconnect/generated/react'
|
||||
|
||||
export default function DeleteEventComponent() {
|
||||
// Call the Mutation hook function to get a `UseMutationResult` object which holds the state of your Mutation.
|
||||
const mutation = useDeleteEvent();
|
||||
|
||||
// You can also pass in a `DataConnect` instance to the Mutation hook function.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const mutation = useDeleteEvent(dataConnect);
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to the Mutation hook function.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useDeleteEvent(options);
|
||||
|
||||
// You can also pass both a `DataConnect` instance and a `useDataConnectMutationOptions` object.
|
||||
const dataConnect = getDataConnect(connectorConfig);
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
const mutation = useDeleteEvent(dataConnect, options);
|
||||
|
||||
// After calling the Mutation hook function, you must call `UseMutationResult.mutate()` to execute the Mutation.
|
||||
// The `useDeleteEvent` Mutation requires an argument of type `DeleteEventVariables`:
|
||||
const deleteEventVars: DeleteEventVariables = {
|
||||
id: ...,
|
||||
};
|
||||
mutation.mutate(deleteEventVars);
|
||||
// Variables can be defined inline as well.
|
||||
mutation.mutate({ id: ..., });
|
||||
|
||||
// You can also pass in a `useDataConnectMutationOptions` object to `UseMutationResult.mutate()`.
|
||||
const options = {
|
||||
onSuccess: () => { console.log('Mutation succeeded!'); }
|
||||
};
|
||||
mutation.mutate(deleteEventVars, options);
|
||||
|
||||
// Then, you can render your component dynamically based on the status of the Mutation.
|
||||
if (mutation.isPending) {
|
||||
return <div>Loading...</div>;
|
||||
}
|
||||
|
||||
if (mutation.isError) {
|
||||
return <div>Error: {mutation.error.message}</div>;
|
||||
}
|
||||
|
||||
// If the Mutation is successful, you can access the data returned using the `UseMutationResult.data` field.
|
||||
if (mutation.isSuccess) {
|
||||
console.log(mutation.data.event_delete);
|
||||
}
|
||||
return <div>Mutation execution {mutation.isSuccess ? 'successful' : 'failed'}!</div>;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -1,13 +1,7 @@
|
||||
import { listEventsRef, createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, connectorConfig } from '../../esm/index.esm.js';
|
||||
import { createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, connectorConfig } from '../../esm/index.esm.js';
|
||||
import { validateArgs, CallerSdkTypeEnum } from 'firebase/data-connect';
|
||||
import { useDataConnectQuery, useDataConnectMutation, validateReactArgs } from '@tanstack-query-firebase/react/data-connect';
|
||||
|
||||
|
||||
export function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
export function useCreateStaff(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
@@ -71,3 +65,38 @@ export function useCreateEvent(dcOrOptions, options) {
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useUpdateEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return updateEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useDeleteEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return deleteEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
|
||||
export function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useGetEventById(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true);
|
||||
const ref = getEventByIdRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
export function useFilterEvents(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false);
|
||||
const ref = filterEventsRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
@@ -1,13 +1,7 @@
|
||||
const { listEventsRef, createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, connectorConfig } = require('../index.cjs.js');
|
||||
const { createStaffRef, listStaffRef, createVendorRef, updateVendorRef, deleteVendorRef, listVendorRef, getVendorByIdRef, filterVendorsRef, createEventRef, updateEventRef, deleteEventRef, listEventsRef, getEventByIdRef, filterEventsRef, connectorConfig } = require('../index.cjs.js');
|
||||
const { validateArgs, CallerSdkTypeEnum } = require('firebase/data-connect');
|
||||
const { useDataConnectQuery, useDataConnectMutation, validateReactArgs } = require('@tanstack-query-firebase/react/data-connect');
|
||||
|
||||
|
||||
exports.useListEvents = function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
exports.useCreateStaff = function useCreateStaff(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
@@ -71,3 +65,38 @@ exports.useCreateEvent = function useCreateEvent(dcOrOptions, options) {
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useUpdateEvent = function useUpdateEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return updateEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useDeleteEvent = function useDeleteEvent(dcOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputOpts } = validateArgs(connectorConfig, dcOrOptions, options);
|
||||
function refFactory(vars) {
|
||||
return deleteEventRef(dcInstance, vars);
|
||||
}
|
||||
return useDataConnectMutation(refFactory, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
|
||||
exports.useListEvents = function useListEvents(dcOrOptions, options) {
|
||||
const { dc: dcInstance, options: inputOpts } = validateReactArgs(connectorConfig, dcOrOptions, options);
|
||||
const ref = listEventsRef(dcInstance);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useGetEventById = function useGetEventById(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, true);
|
||||
const ref = getEventByIdRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
|
||||
exports.useFilterEvents = function useFilterEvents(dcOrVars, varsOrOptions, options) {
|
||||
const { dc: dcInstance, vars: inputVars, options: inputOpts } = validateReactArgs(connectorConfig, dcOrVars, varsOrOptions, options, true, false);
|
||||
const ref = filterEventsRef(dcInstance, inputVars);
|
||||
return useDataConnectQuery(ref, inputOpts, CallerSdkTypeEnum.GeneratedReact);
|
||||
}
|
||||
@@ -1,13 +1,10 @@
|
||||
import { ListEventsData, CreateStaffData, CreateStaffVariables, ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateEventData, CreateEventVariables } from '../';
|
||||
import { CreateStaffData, CreateStaffVariables, ListStaffData, CreateVendorData, CreateVendorVariables, UpdateVendorData, UpdateVendorVariables, DeleteVendorData, DeleteVendorVariables, ListVendorData, GetVendorByIdData, GetVendorByIdVariables, FilterVendorsData, FilterVendorsVariables, CreateEventData, CreateEventVariables, UpdateEventData, UpdateEventVariables, DeleteEventData, DeleteEventVariables, ListEventsData, GetEventByIdData, GetEventByIdVariables, FilterEventsData, FilterEventsVariables } from '../';
|
||||
import { UseDataConnectQueryResult, useDataConnectQueryOptions, UseDataConnectMutationResult, useDataConnectMutationOptions} from '@tanstack-query-firebase/react/data-connect';
|
||||
import { UseQueryResult, UseMutationResult} from '@tanstack/react-query';
|
||||
import { DataConnect } from 'firebase/data-connect';
|
||||
import { FirebaseError } from 'firebase/app';
|
||||
|
||||
|
||||
export function useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
|
||||
export function useCreateStaff(options?: useDataConnectMutationOptions<CreateStaffData, FirebaseError, CreateStaffVariables>): UseDataConnectMutationResult<CreateStaffData, CreateStaffVariables>;
|
||||
export function useCreateStaff(dc: DataConnect, options?: useDataConnectMutationOptions<CreateStaffData, FirebaseError, CreateStaffVariables>): UseDataConnectMutationResult<CreateStaffData, CreateStaffVariables>;
|
||||
|
||||
@@ -34,3 +31,18 @@ export function useFilterVendors(dc: DataConnect, vars?: FilterVendorsVariables,
|
||||
|
||||
export function useCreateEvent(options?: useDataConnectMutationOptions<CreateEventData, FirebaseError, CreateEventVariables>): UseDataConnectMutationResult<CreateEventData, CreateEventVariables>;
|
||||
export function useCreateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<CreateEventData, FirebaseError, CreateEventVariables>): UseDataConnectMutationResult<CreateEventData, CreateEventVariables>;
|
||||
|
||||
export function useUpdateEvent(options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
export function useUpdateEvent(dc: DataConnect, options?: useDataConnectMutationOptions<UpdateEventData, FirebaseError, UpdateEventVariables>): UseDataConnectMutationResult<UpdateEventData, UpdateEventVariables>;
|
||||
|
||||
export function useDeleteEvent(options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
export function useDeleteEvent(dc: DataConnect, options?: useDataConnectMutationOptions<DeleteEventData, FirebaseError, DeleteEventVariables>): UseDataConnectMutationResult<DeleteEventData, DeleteEventVariables>;
|
||||
|
||||
export function useListEvents(options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
export function useListEvents(dc: DataConnect, options?: useDataConnectQueryOptions<ListEventsData>): UseDataConnectQueryResult<ListEventsData, undefined>;
|
||||
|
||||
export function useGetEventById(vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
export function useGetEventById(dc: DataConnect, vars: GetEventByIdVariables, options?: useDataConnectQueryOptions<GetEventByIdData>): UseDataConnectQueryResult<GetEventByIdData, GetEventByIdVariables>;
|
||||
|
||||
export function useFilterEvents(vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
export function useFilterEvents(dc: DataConnect, vars?: FilterEventsVariables, options?: useDataConnectQueryOptions<FilterEventsData>): UseDataConnectQueryResult<FilterEventsData, FilterEventsVariables>;
|
||||
|
||||
Reference in New Issue
Block a user