@bizmap/sdk 0.0.58 → 0.0.60

package/dist/main.d.ts

@@ -1,4 +1,5 @@
 import * as z from 'zod';
+import { SafeOmit } from '@wavy/util';
 
 declare const companyUserRoles: z.ZodEnum<{
     doc: "doc";
@@ -25,11 +26,11 @@ declare const healthcareProviderRoles: z.ZodEnum<{
     physAsst: "physAsst";
 }>;
 type HealthcareProviderRole = z.infer<typeof healthcareProviderRoles>;
-declare const serviceDistAlgs: z.ZodEnum<{
+declare const appointmentDistAlgs: z.ZodEnum<{
     RR: "RR";
     LOR: "LOR";
 }>;
-type ServiceDistAlg = z.infer<typeof serviceDistAlgs>;
+type AppointmentDistAlg = z.infer<typeof appointmentDistAlgs>;
 declare const companyServiceSelectors: z.ZodEnum<{
     scheduler: "scheduler";
     doctor: "doctor";
@@ -144,8 +145,8 @@ declare const CompanyDetails: z.ZodObject<{
             scheduler: "scheduler";
             doctor: "doctor";
         }>;
-        enforcePaidServices: z.ZodBoolean;
-        serviceDistAlg: z.ZodDefault<z.ZodEnum<{
+        enforcePaidAppointments: z.ZodBoolean;
+        apptDistAlg: z.ZodDefault<z.ZodEnum<{
             RR: "RR";
             LOR: "LOR";
         }>>;
@@ -203,7 +204,7 @@ declare const CompanyDetails: z.ZodObject<{
             percentage: z.ZodNumber;
             isOptional: z.ZodBoolean;
         }, z.core.$strip>>;
-        services: z.ZodObject<{
+        offeredServices: z.ZodObject<{
             deployed: z.ZodBoolean;
             value: z.ZodRecord<z.ZodString, z.ZodObject<{
                 createdAt: z.ZodReadonly<z.ZodInt>;
@@ -238,7 +239,7 @@ declare const CompanyDetails: z.ZodObject<{
                 active: "active";
                 inactive: "inactive";
             }>;
-            services: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
+            appointments: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
             lastActive: z.ZodNullable<z.ZodInt>;
             isAvailableLastModified: z.ZodNullable<z.ZodInt>;
             isBusyLastModified: z.ZodNullable<z.ZodInt>;
@@ -275,6 +276,128 @@ declare const CompanyDetails: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 type CompanyDetails = z.infer<typeof CompanyDetails>;
+declare const MutableCompanyDetails: z.ZodObject<{
+    uid: z.ZodUUID;
+    identity: z.ZodOptional<z.ZodObject<{
+        address: z.ZodOptional<z.ZodObject<{
+            streetAddress: z.ZodString;
+            city: z.ZodOptional<z.ZodString>;
+            parish: z.ZodString;
+            country: z.ZodString;
+        }, z.core.$strip>>;
+        logo: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        contact: z.ZodOptional<z.ZodObject<{
+            email: z.ZodEmail;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        legal: z.ZodOptional<z.ZodObject<{
+            regNo: z.ZodReadonly<z.ZodString>;
+            trn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            gctRegNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    preferences: z.ZodOptional<z.ZodObject<{
+        serviceSelector: z.ZodOptional<z.ZodEnum<{
+            scheduler: "scheduler";
+            doctor: "doctor";
+        }>>;
+        enforcePaidAppointments: z.ZodOptional<z.ZodBoolean>;
+        apptDistAlg: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            RR: "RR";
+            LOR: "LOR";
+        }>>>;
+    }, z.core.$strip>>;
+    billing: z.ZodOptional<z.ZodObject<{
+        additionalFees: z.ZodOptional<z.ZodRecord<z.ZodUUID, z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodInt>;
+            lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+            description: z.ZodOptional<z.ZodString>;
+            fixedAmount: z.ZodObject<{
+                value: z.ZodNumber;
+                currency: z.ZodEnum<{
+                    JMD: "JMD";
+                    USD: "USD";
+                    EUR: "EUR";
+                    GBP: "GBP";
+                    CAD: "CAD";
+                }>;
+            }, z.core.$strip>;
+            percentage: z.ZodNumber;
+            isOptional: z.ZodBoolean;
+        }, z.core.$strip>>>;
+        discounts: z.ZodOptional<z.ZodRecord<z.ZodUUID, z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodInt>;
+            lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+            description: z.ZodOptional<z.ZodString>;
+            fixedAmount: z.ZodObject<{
+                value: z.ZodNumber;
+                currency: z.ZodEnum<{
+                    JMD: "JMD";
+                    USD: "USD";
+                    EUR: "EUR";
+                    GBP: "GBP";
+                    CAD: "CAD";
+                }>;
+            }, z.core.$strip>;
+            percentage: z.ZodNumber;
+            isOptional: z.ZodBoolean;
+        }, z.core.$strip>>>;
+        prepayments: z.ZodOptional<z.ZodRecord<z.ZodUUID, z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodInt>;
+            lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+            description: z.ZodOptional<z.ZodString>;
+            fixedAmount: z.ZodObject<{
+                value: z.ZodNumber;
+                currency: z.ZodEnum<{
+                    JMD: "JMD";
+                    USD: "USD";
+                    EUR: "EUR";
+                    GBP: "GBP";
+                    CAD: "CAD";
+                }>;
+            }, z.core.$strip>;
+            percentage: z.ZodNumber;
+            isOptional: z.ZodBoolean;
+        }, z.core.$strip>>>;
+        offeredServices: z.ZodOptional<z.ZodObject<{
+            deployed: z.ZodBoolean;
+            value: z.ZodRecord<z.ZodString, z.ZodObject<{
+                createdAt: z.ZodReadonly<z.ZodInt>;
+                lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+                currency: z.ZodEnum<{
+                    JMD: "JMD";
+                    USD: "USD";
+                    EUR: "EUR";
+                    GBP: "GBP";
+                    CAD: "CAD";
+                }>;
+                item: z.ZodString;
+                cost: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    staff: z.ZodOptional<z.ZodObject<{
+        partnerMap: z.ZodOptional<z.ZodRecord<z.ZodUUID, z.ZodRecord<z.ZodUUID, z.ZodObject<{
+            addedAt: z.ZodInt;
+        }, z.core.$strip>>>>;
+        updateQueue: z.ZodOptional<z.ZodRecord<z.ZodUUID, z.ZodObject<{
+            $REMOVE: z.ZodOptional<z.ZodObject<{
+                addedAt: z.ZodInt;
+            }, z.core.$strip>>;
+            $CHANGE_ROLES: z.ZodOptional<z.ZodObject<{
+                newRoles: z.ZodPipe<z.ZodArray<z.ZodEnum<{
+                    doc: "doc";
+                    physAsst: "physAsst";
+                    rcpst: "rcpst";
+                    cshr: "cshr";
+                    admin: "admin";
+                }>>, z.ZodTransform<("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[], ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[]>>;
+                addedAt: z.ZodInt;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type MutableCompanyDetails = z.infer<typeof MutableCompanyDetails>;
 
 declare const CompanyBilling: z.ZodObject<{
     uid: z.ZodUUID;
@@ -329,7 +452,7 @@ declare const CompanyBilling: z.ZodObject<{
         percentage: z.ZodNumber;
         isOptional: z.ZodBoolean;
     }, z.core.$strip>>;
-    services: z.ZodObject<{
+    offeredServices: z.ZodObject<{
         deployed: z.ZodBoolean;
         value: z.ZodRecord<z.ZodString, z.ZodObject<{
             createdAt: z.ZodReadonly<z.ZodInt>;
@@ -348,6 +471,76 @@ declare const CompanyBilling: z.ZodObject<{
     lastModified: z.ZodNullable<z.ZodInt>;
 }, z.core.$strip>;
 type CompanyBilling = z.infer<typeof CompanyBilling>;
+declare const MutableCompanyBilling: z.ZodObject<{
+    additionalFees: z.ZodRecord<z.ZodUUID, z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodInt>;
+        lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        description: z.ZodOptional<z.ZodString>;
+        fixedAmount: z.ZodObject<{
+            value: z.ZodNumber;
+            currency: z.ZodEnum<{
+                JMD: "JMD";
+                USD: "USD";
+                EUR: "EUR";
+                GBP: "GBP";
+                CAD: "CAD";
+            }>;
+        }, z.core.$strip>;
+        percentage: z.ZodNumber;
+        isOptional: z.ZodBoolean;
+    }, z.core.$strip>>;
+    discounts: z.ZodRecord<z.ZodUUID, z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodInt>;
+        lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        description: z.ZodOptional<z.ZodString>;
+        fixedAmount: z.ZodObject<{
+            value: z.ZodNumber;
+            currency: z.ZodEnum<{
+                JMD: "JMD";
+                USD: "USD";
+                EUR: "EUR";
+                GBP: "GBP";
+                CAD: "CAD";
+            }>;
+        }, z.core.$strip>;
+        percentage: z.ZodNumber;
+        isOptional: z.ZodBoolean;
+    }, z.core.$strip>>;
+    prepayments: z.ZodRecord<z.ZodUUID, z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodInt>;
+        lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        description: z.ZodOptional<z.ZodString>;
+        fixedAmount: z.ZodObject<{
+            value: z.ZodNumber;
+            currency: z.ZodEnum<{
+                JMD: "JMD";
+                USD: "USD";
+                EUR: "EUR";
+                GBP: "GBP";
+                CAD: "CAD";
+            }>;
+        }, z.core.$strip>;
+        percentage: z.ZodNumber;
+        isOptional: z.ZodBoolean;
+    }, z.core.$strip>>;
+    offeredServices: z.ZodObject<{
+        deployed: z.ZodBoolean;
+        value: z.ZodRecord<z.ZodString, z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodInt>;
+            lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+            currency: z.ZodEnum<{
+                JMD: "JMD";
+                USD: "USD";
+                EUR: "EUR";
+                GBP: "GBP";
+                CAD: "CAD";
+            }>;
+            item: z.ZodString;
+            cost: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type MutableCompanyBilling = z.infer<typeof MutableCompanyBilling>;
 
 declare const CompanyIdentity: z.ZodObject<{
     uid: z.ZodUUID;
@@ -380,6 +573,25 @@ declare const CompanyIdentity: z.ZodObject<{
     lastModified: z.ZodNullable<z.ZodInt>;
 }, z.core.$strip>;
 type CompanyIdentity = z.infer<typeof CompanyIdentity>;
+declare const MutableCompanyIdentity: z.ZodObject<{
+    address: z.ZodObject<{
+        streetAddress: z.ZodString;
+        city: z.ZodOptional<z.ZodString>;
+        parish: z.ZodString;
+        country: z.ZodString;
+    }, z.core.$strip>;
+    logo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    contact: z.ZodObject<{
+        email: z.ZodEmail;
+        phoneNumber: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    legal: z.ZodObject<{
+        regNo: z.ZodReadonly<z.ZodString>;
+        trn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        gctRegNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+type MutableCompanyIdentity = z.infer<typeof MutableCompanyIdentity>;
 
 declare const CompanyNotifications: z.ZodArray<z.ZodObject<{
     code: z.ZodLiteral<"COMPANY_INVITE" | "INVITE_RESPONSE" | "DEV_MESSAGE" | "ALERT">;
@@ -400,14 +612,26 @@ declare const CompanyPreferences: z.ZodObject<{
         scheduler: "scheduler";
         doctor: "doctor";
     }>;
-    enforcePaidServices: z.ZodBoolean;
-    serviceDistAlg: z.ZodDefault<z.ZodEnum<{
+    enforcePaidAppointments: z.ZodBoolean;
+    apptDistAlg: z.ZodDefault<z.ZodEnum<{
         RR: "RR";
         LOR: "LOR";
     }>>;
     lastModified: z.ZodNullable<z.ZodInt>;
 }, z.core.$strip>;
 type CompanyPreferences = z.infer<typeof CompanyPreferences>;
+declare const MutableCompanyPreferences: z.ZodObject<{
+    serviceSelector: z.ZodEnum<{
+        scheduler: "scheduler";
+        doctor: "doctor";
+    }>;
+    enforcePaidAppointments: z.ZodBoolean;
+    apptDistAlg: z.ZodDefault<z.ZodEnum<{
+        RR: "RR";
+        LOR: "LOR";
+    }>>;
+}, z.core.$strip>;
+type MutableCompanyPreferences = z.infer<typeof MutableCompanyPreferences>;
 
 declare const CompanyStaff: z.ZodPipe<z.ZodObject<{
     uid: z.ZodUUID;
@@ -427,7 +651,7 @@ declare const CompanyStaff: z.ZodPipe<z.ZodObject<{
             active: "active";
             inactive: "inactive";
         }>;
-        services: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
+        appointments: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
         lastActive: z.ZodNullable<z.ZodInt>;
         isAvailableLastModified: z.ZodNullable<z.ZodInt>;
         isBusyLastModified: z.ZodNullable<z.ZodInt>;
@@ -470,7 +694,7 @@ declare const CompanyStaff: z.ZodPipe<z.ZodObject<{
         isAvailable: boolean;
         isBusy: boolean;
         status: "inviteSent" | "active" | "inactive";
-        services: Record<"ongoing" | "completed", number>;
+        appointments: Record<"ongoing" | "completed", number>;
         lastActive: number | null;
         isAvailableLastModified: number | null;
         isBusyLastModified: number | null;
@@ -504,7 +728,7 @@ declare const CompanyStaff: z.ZodPipe<z.ZodObject<{
         isAvailable: boolean;
         isBusy: boolean;
         status: "inviteSent" | "active" | "inactive";
-        services: Record<"ongoing" | "completed", number>;
+        appointments: Record<"ongoing" | "completed", number>;
         lastActive: number | null;
         isAvailableLastModified: number | null;
         isBusyLastModified: number | null;
@@ -572,7 +796,7 @@ declare const CompanyUser: z.ZodObject<{
         active: "active";
         inactive: "inactive";
     }>;
-    services: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
+    appointments: z.ZodRecord<z.ZodLiteral<"ongoing" | "completed">, z.ZodInt>;
     lastActive: z.ZodNullable<z.ZodInt>;
     isAvailableLastModified: z.ZodNullable<z.ZodInt>;
     isBusyLastModified: z.ZodNullable<z.ZodInt>;
@@ -814,7 +1038,7 @@ declare const Reason: z.ZodObject<{
     lastModified: z.ZodInt;
 }, z.core.$strip>;
 
-declare const MiniServiceDetails: z.ZodObject<{
+declare const MiniAppointmentDetails: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodInt>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     _id: z.ZodUUID;
@@ -963,8 +1187,8 @@ declare const MiniServiceDetails: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
-type MiniServiceDetails = z.infer<typeof MiniServiceDetails>;
-declare const ServiceDetails: z.ZodObject<{
+type MiniAppointmentDetails = z.infer<typeof MiniAppointmentDetails>;
+declare const AppointmentDetails: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodInt>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     additionalFees: z.ZodReadonly<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -1133,8 +1357,8 @@ declare const ServiceDetails: z.ZodObject<{
         activated: z.ZodBoolean;
     }, z.core.$strip>;
 }, z.core.$strip>;
-type ServiceDetails = z.infer<typeof ServiceDetails>;
-declare const MutableServiceDetails: z.ZodObject<{
+type AppointmentDetails = z.infer<typeof AppointmentDetails>;
+declare const MutableAppointmentDetails: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodInt>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     additionalFees: z.ZodReadonly<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -1304,8 +1528,8 @@ declare const MutableServiceDetails: z.ZodObject<{
     }, z.core.$strip>;
     _hash: z.ZodString;
 }, z.core.$strip>;
-type MutableServiceDetails = z.infer<typeof MutableServiceDetails>;
-declare const CreateServiceForm: z.ZodObject<{
+type MutableAppointmentDetails = z.infer<typeof MutableAppointmentDetails>;
+declare const ScheduleAppointmentForm: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodInt>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     clientUid: z.ZodUUID;
@@ -1351,7 +1575,214 @@ declare const CreateServiceForm: z.ZodObject<{
         amount: z.ZodNumber;
     }, z.core.$strip>>>>>;
 }, z.core.$strip>;
-type CreateServiceForm = z.infer<typeof CreateServiceForm>;
+type ScheduleAppointmentForm = z.infer<typeof ScheduleAppointmentForm>;
+
+declare function scheduleAppointment(request: {
+    form: ScheduleAppointmentForm;
+    sender: UserDetails;
+    billing: SafeOmit<CompanyBilling, "uid" | "prepayments" | "lastModified">;
+    preferences: SafeOmit<CompanyPreferences, "uid" | "lastModified">;
+    state: CompanyState;
+    staff: CompanyStaff;
+    cost: number;
+    findClient: (uid: string) => Promise<ClientIdentity>;
+    createHash: (appointment: SafeOmit<MutableAppointmentDetails, "_hash">) => string;
+    options?: Partial<{
+        ignoreBalanceCheck: boolean;
+    }>;
+}): Promise<{
+    updates: {
+        state: {
+            uid: string;
+            credits: {
+                current: number;
+                lastModified: number | null;
+            };
+            maxStaff: {
+                current: number;
+                lastModified: number | null;
+            };
+            storageInBytes: Record<"used" | "max", {
+                current: number;
+                lastModified: number | null;
+            }>;
+            invoiceNoCounter: number;
+            tktNoCounter: number;
+            lastSavedAt: number | null;
+            lastModified: number | null;
+            createdAt: number;
+        };
+        staffDetails: {
+            uid: string;
+            members: Record<string, {
+                uid: string;
+                roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+                isAvailable: boolean;
+                isBusy: boolean;
+                status: "inviteSent" | "active" | "inactive";
+                appointments: Record<"ongoing" | "completed", number>;
+                lastActive: number | null;
+                isAvailableLastModified: number | null;
+                isBusyLastModified: number | null;
+                name: Record<"first" | "last", string>;
+                email: string;
+                photoUrl?: string | null | undefined;
+                phoneNumber?: string | undefined;
+            }>;
+            partnerMap: Record<string, Record<string, {
+                addedAt: number;
+            }>>;
+            updateQueue: Record<string, {
+                $REMOVE?: {
+                    addedAt: number;
+                } | undefined;
+                $CHANGE_ROLES?: {
+                    newRoles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+                    addedAt: number;
+                } | undefined;
+            }>;
+            timeline: Record<string, {
+                inviteSent: number | null;
+                inviteAccepted: number | null;
+            }>;
+            lastModified: number | null;
+        };
+    };
+    appointment: {
+        createdAt: number;
+        additionalFees: readonly {
+            createdAt: number;
+            fixedAmount: {
+                value: number;
+                currency: "JMD" | "USD" | "EUR" | "GBP" | "CAD";
+            };
+            percentage: number;
+            isOptional: boolean;
+            lastModified?: number | null | undefined;
+            description?: string | undefined;
+        }[] | null;
+        discounts: readonly {
+            createdAt: number;
+            fixedAmount: {
+                value: number;
+                currency: "JMD" | "USD" | "EUR" | "GBP" | "CAD";
+            };
+            percentage: number;
+            isOptional: boolean;
+            lastModified?: number | null | undefined;
+            description?: string | undefined;
+        }[] | null;
+        prepayments: {
+            createdAt: number;
+            fixedAmount: {
+                value: number;
+                currency: "JMD" | "USD" | "EUR" | "GBP" | "CAD";
+            };
+            percentage: number;
+            isOptional: boolean;
+            lastModified?: number | null | undefined;
+            description?: string | undefined;
+        }[] | null;
+        src: string;
+        timeline: {
+            scheduler: {
+                userUid: string;
+                postedAt?: number | null | undefined;
+            };
+            physAsst: "none" | {
+                userUid: string;
+                postedAt?: number | null | undefined;
+            };
+            doctor: {
+                userUid: string;
+                postedAt?: number | null | undefined;
+            };
+            cashier: {
+                userUid: string;
+                postedAt?: number | null | undefined;
+            } | null;
+        };
+        tkt: number;
+        _id: string;
+        charges: {
+            createdAt: number;
+            currency: "JMD" | "USD" | "EUR" | "GBP" | "CAD";
+            item: string;
+            cost: number;
+            lastModified?: number | null | undefined;
+        }[];
+        client: {
+            createdAt: number;
+            uid: string;
+            name: Record<"first" | "last", string>;
+            publicKey: string | null;
+            activated: boolean;
+            lastModified?: number | null | undefined;
+            email?: string | null | undefined;
+            address?: {
+                streetAddress: string;
+                parish: string;
+                country: string;
+                city?: string | undefined;
+            } | undefined;
+            phoneNumber?: string | undefined;
+            photoUrl?: string | null | undefined;
+            dob?: number | undefined;
+        };
+        _hash: string;
+        lastModified?: number | null | undefined;
+        payload?: {
+            lastModified: number | null;
+            vitals: Record<"heartRate" | "respiratoryRate" | "bloodPressure" | "bloodOxygen" | "bodyTemp", {
+                value: string;
+                lastModified: number | null;
+            }>;
+            doctorNote: {
+                value: string;
+                lastModified: number | null;
+            };
+            prescriptions?: {
+                createdAt: number;
+                brand: string;
+                quantity: string;
+                refills: string;
+                directions: string;
+                lastModified?: number | null | undefined;
+                expiresAt?: number | null | undefined;
+            }[][] | null | undefined;
+            physAsstNotes?: {
+                createdAt: number;
+                title: string;
+                content: string;
+                lastModified?: number | null | undefined;
+            }[] | undefined;
+        } | null | undefined;
+        reason?: {
+            createdAt: number;
+            value: string;
+            lastModified?: number | null | undefined;
+        } | undefined;
+        invoiceNo?: string | undefined;
+        cancelled?: {
+            doneAt: number;
+            reason: {
+                value: string;
+                lastModified: number;
+            };
+            doneBy: "doc" | "physAsst";
+        } | undefined;
+        payments?: {
+            createdAt: number;
+            method: "cash" | "card" | "insurance";
+            amount: number;
+            lastModified?: number | null | undefined;
+        }[] | null | undefined;
+    };
+}>;
+
+declare function findAvailableStaff(role: CompanyUserRole, staff: CompanyStaff): string[];
+
+declare function findNextAvailableStaff(userUids: string[], algorithm: CompanyPreferences["apptDistAlg"], staff: CompanyStaff): string | null;
 
 /**@returns an array of the users that have conflicting roles or are incompatible with the other partners, or null if none was found. */
 declare const findConflictingPartners: (...partners: CompanyUser[]) => {
@@ -1360,7 +1791,7 @@ declare const findConflictingPartners: (...partners: CompanyUser[]) => {
     isAvailable: boolean;
     isBusy: boolean;
     status: "inviteSent" | "active" | "inactive";
-    services: Record<"ongoing" | "completed", number>;
+    appointments: Record<"ongoing" | "completed", number>;
     lastActive: number | null;
     isAvailableLastModified: number | null;
     isBusyLastModified: number | null;
@@ -1372,4 +1803,4 @@ declare const findConflictingPartners: (...partners: CompanyUser[]) => {
 /**@returns the roles that are compatible with the selected role. */
 declare const getCompatibleRoles: (role: CompanyUserRole) => CompanyUserRole[];
 
-export { ClientIdentity, CompanyBilling, CompanyDetails, CompanyIdentity, CompanyInviteList, CompanyNotifications, type CompanyPartnerRole, CompanyPreferences, type CompanyServiceSelector, CompanyStaff, CompanyState, CompanyUser, type CompanyUserRole, CreateServiceForm, CreditCurrency, type EmployeeRole, type HealthcareProviderRole, InviteResponse, InvoiceNo, MedicalDetails, Medicine, MiniServiceDetails, MutableServiceDetails, Notification, type PaymentMethod, PriceAdjustment, PriceTag, Reason, Receipts, ServiceDetails, type ServiceDistAlg, StandardTime, TicketNo, type Tier, TierList, TimeLog, Timestamp, UserDetails, Vitals, companyPartnerRoles, companyServiceSelectors, companyUserRoles, employeeRoles, findConflictingPartners, getCompatibleRoles, healthcareProviderRoles, paymentMethods, serviceDistAlgs, serviceProviders, tiers, vitalKeys };
+export { AppointmentDetails, type AppointmentDistAlg, ClientIdentity, CompanyBilling, CompanyDetails, CompanyIdentity, CompanyInviteList, CompanyNotifications, type CompanyPartnerRole, CompanyPreferences, type CompanyServiceSelector, CompanyStaff, CompanyState, CompanyUser, type CompanyUserRole, CreditCurrency, type EmployeeRole, type HealthcareProviderRole, InviteResponse, InvoiceNo, MedicalDetails, Medicine, MiniAppointmentDetails, MutableAppointmentDetails, MutableCompanyBilling, MutableCompanyDetails, MutableCompanyIdentity, MutableCompanyPreferences, Notification, type PaymentMethod, PriceAdjustment, PriceTag, Reason, Receipts, ScheduleAppointmentForm, StandardTime, TicketNo, type Tier, TierList, TimeLog, Timestamp, UserDetails, Vitals, appointmentDistAlgs, companyPartnerRoles, companyServiceSelectors, companyUserRoles, employeeRoles, findAvailableStaff, findConflictingPartners, findNextAvailableStaff, getCompatibleRoles, healthcareProviderRoles, paymentMethods, scheduleAppointment, serviceProviders, tiers, vitalKeys };

package/dist/main.js

@@ -16,7 +16,7 @@ var healthcareProviderRoles = companyUserRoles.extract([
   "physAsst",
   "doc"
 ]);
-var serviceDistAlgs = z.enum(["RR", "LOR"]);
+var appointmentDistAlgs = z.enum(["RR", "LOR"]);
 var companyServiceSelectors = z.enum(["scheduler", "doctor"]);
 
 // src/enums/Global.ts
@@ -34,7 +34,7 @@ var vitalKeys = z3.enum([
   "bodyTemp"
 ]);
 
-// src/enums/Services.ts
+// src/enums/Appointments.ts
 import * as z4 from "zod";
 var serviceProviders = z4.enum([
   "scheduler",
@@ -148,7 +148,7 @@ var CompanyBilling = z8.object({
   discounts: createAdjustments("discount"),
   /** Optionally deductable from bills */
   prepayments: createAdjustments("pre-payment"),
-  services: z8.object({
+  offeredServices: z8.object({
     /** Forces service selectors to use the list of service(s) that you've created. */
     deployed: z8.boolean(),
     value: z8.record(z8.string(), PriceTag.omit({ uid: true }))
@@ -174,6 +174,10 @@ var CompanyBilling = z8.object({
   }),
   lastModified: Timestamp.nullable()
 });
+var MutableCompanyBilling = CompanyBilling.omit({
+  uid: true,
+  lastModified: true
+});
 
 // src/schemas/company/components/Identity.ts
 import * as z9 from "zod";
@@ -202,6 +206,12 @@ var CompanyIdentity = z9.object({
   }),
   lastModified: Timestamp.nullable()
 });
+var MutableCompanyIdentity = CompanyIdentity.pick({
+  address: true,
+  contact: true,
+  logo: true,
+  legal: true
+});
 
 // src/schemas/company/components/Notifications.ts
 import * as z11 from "zod";
@@ -288,17 +298,21 @@ var CompanyPreferences = z12.object({
    * @note
    * - only allowed when `serviceSelector === "scheduler"`
    *  */
-  enforcePaidServices: z12.boolean(),
+  enforcePaidAppointments: z12.boolean(),
   /**
    * @property RR (Round Robin): Even distribution.
    * @property LOR (Least Outstanding Requests): Distribute based on availability.
    */
-  serviceDistAlg: serviceDistAlgs.default("RR"),
+  apptDistAlg: appointmentDistAlgs.default("RR"),
   lastModified: Timestamp.nullable()
 }).refine(
-  (data) => !data.enforcePaidServices || data.enforcePaidServices && data.serviceSelector === "scheduler",
+  (data) => !data.enforcePaidAppointments || data.enforcePaidAppointments && data.serviceSelector === "scheduler",
   'Enforcing paid appointments is only allowed when the service selector is the "scheduler".'
 );
+var MutableCompanyPreferences = CompanyPreferences.omit({
+  uid: true,
+  lastModified: true
+});
 
 // src/schemas/company/components/Staff.ts
 import * as z15 from "zod";
@@ -380,7 +394,7 @@ var CompanyUser = z14.object({
   isAvailable: z14.boolean(),
   isBusy: z14.boolean(),
   status: z14.enum(["inviteSent", "active", "inactive"]),
-  services: z14.record(z14.literal(["ongoing", "completed"]), z14.int().min(0)),
+  appointments: z14.record(z14.literal(["ongoing", "completed"]), z14.int().min(0)),
   lastActive: Timestamp.nullable(),
   isAvailableLastModified: Timestamp.nullable(),
   isBusyLastModified: Timestamp.nullable()
@@ -495,6 +509,10 @@ var CompanyStaff = RawCompanyStaff.transform((d) => {
     }
   }
 });
+var MutableCompanyStaff = RawCompanyStaff.pick({
+  updateQueue: true,
+  partnerMap: true
+});
 
 // src/schemas/company/CompanyDetails.ts
 var CompanyDetails = z16.object({
@@ -507,6 +525,13 @@ var CompanyDetails = z16.object({
   billing: CompanyBilling.omit({ uid: true }),
   staff: RawCompanyStaff.omit({ uid: true })
 });
+var MutableCompanyDetails = z16.object({
+  uid: CompanyDetails.shape.uid,
+  identity: MutableCompanyIdentity.partial().optional(),
+  preferences: MutableCompanyPreferences.partial().optional(),
+  billing: MutableCompanyBilling.partial().optional(),
+  staff: MutableCompanyStaff.partial().optional()
+});
 
 // src/schemas/company/utils/InviteList.ts
 import * as z17 from "zod";
@@ -518,10 +543,10 @@ var CompanyInviteList = z17.record(
   "Insufficient amount of members invited."
 );
 
-// src/schemas/Client.ts
+// src/schemas/appointment/components/Client.ts
 var ClientIdentity = UserDetails.omit({ notifications: true });
 
-// src/schemas/Medical.ts
+// src/schemas/appointment/components/payload/Medical.ts
 import * as z18 from "zod";
 var Vitals = z18.record(
   vitalKeys,
@@ -556,13 +581,13 @@ var MedicalDetails = z18.object({
   ).optional()
 });
 
-// src/schemas/ServiceDetails.ts
+// src/schemas/appointment/Appointment.ts
 import * as z19 from "zod";
 var TimelineActivity = z19.object({
   postedAt: Timestamp.nullish(),
   userUid: CompanyUser.shape.uid.nonoptional()
 });
-var MiniServiceDetails = z19.object({
+var MiniAppointmentDetails = z19.object({
   /** A random uid that identifies the document. */
   _id: z19.uuidv4(),
   /** The company's uid */
@@ -622,10 +647,10 @@ var MiniServiceDetails = z19.object({
   }),
   ...TimeLog.shape
 });
-var ServiceDetails = MiniServiceDetails.omit({
+var AppointmentDetails = MiniAppointmentDetails.omit({
   clientUid: true
 }).extend(z19.object({ client: ClientIdentity }).shape);
-var MutableServiceDetails = ServiceDetails.safeExtend(
+var MutableAppointmentDetails = AppointmentDetails.safeExtend(
   z19.object({
     /**
      * @description An encrypted copy of the last state of the service.
@@ -634,20 +659,187 @@ var MutableServiceDetails = ServiceDetails.safeExtend(
     _hash: z19.string()
   }).shape
 );
-var CreateServiceForm = z19.object({
+var ScheduleAppointmentForm = z19.object({
   clientUid: ClientIdentity.shape.uid,
   /** A nullish value === next_available */
   serviceProviderUid: CompanyUser.shape.uid.nullish(),
-  charges: ServiceDetails.shape.charges.optional(),
-  prepayments: ServiceDetails.shape.prepayments.optional(),
-  payments: ServiceDetails.shape.payments.optional(),
+  charges: AppointmentDetails.shape.charges.optional(),
+  prepayments: AppointmentDetails.shape.prepayments.optional(),
+  payments: AppointmentDetails.shape.payments.optional(),
   ...TimeLog.shape
 });
 
-// src/functions/createCompanyService.ts
-import { findChanges, omit, TODO } from "@wavy/fn";
+// src/functions/scheduleAppointment.ts
+import { findChanges, omit } from "@wavy/fn";
 import { v4 } from "uuid";
+
+// src/functions/findAvailableStaff.ts
+function findAvailableStaff(role, staff) {
+  return Object.keys(role === "doc" ? staff.partnerMap : staff.members).filter(
+    (uid) => {
+      const user = staff.members[uid];
+      return !(uid in staff.updateQueue) && user.roles.includes(role) && user.status === "active" && user.isAvailable;
+    }
+  );
+}
+
+// src/functions/findNextAvailableStaff.ts
+function findNextAvailableStaff(userUids, algorithm, staff) {
+  let nextAvailable = null;
+  if (userUids.length === 1) return userUids[0];
+  switch (algorithm) {
+    case "RR": {
+      nextAvailable = userUids.find(
+        (uid) => staff.members[uid].appointments.ongoing < staff.members[userUids[0]].appointments.ongoing
+      ) || userUids[0];
+      break;
+    }
+    case "LOR": {
+      for (const uid of userUids) {
+        const user = staff.members[uid];
+        if (!nextAvailable || user.appointments.ongoing < staff.members[nextAvailable].appointments.ongoing) {
+          nextAvailable = uid;
+        }
+      }
+      break;
+    }
+    default:
+      return algorithm;
+  }
+  return nextAvailable;
+}
+
+// src/functions/scheduleAppointment.ts
+async function scheduleAppointment(request) {
+  request.form = ScheduleAppointmentForm.parse(request.form);
+  request.sender = UserDetails.parse(request.sender);
+  request.preferences = CompanyPreferences.omit({
+    uid: true,
+    lastModified: true
+  }).parse(request.preferences);
+  request.billing = CompanyBilling.omit({
+    uid: true,
+    prepayments: true,
+    lastModified: true
+  }).parse(request.billing);
+  const companyUser = request.staff?.members[request.sender.uid];
+  const staffDetailsCopy = CompanyStaff.parse(structuredClone(request.staff));
+  const stateCopy = CompanyState.parse(structuredClone(request.state));
+  let selectedDoctor = null;
+  let selectedPhysAsst = null;
+  const availableDoctors = findAvailableStaff("doc", staffDetailsCopy);
+  const today = Date.now();
+  if (!companyUser || !companyUser?.roles?.includes?.("rcpst")) {
+    throw new Error("Permissions missing.");
+  }
+  if (availableDoctors.length < 1) {
+    throw new Error("Insufficient staff available.");
+  }
+  if (request.form.serviceProviderUid && availableDoctors.includes(request.form.serviceProviderUid)) {
+    selectedDoctor = request.form.serviceProviderUid;
+  } else if (request.form.serviceProviderUid && staffDetailsCopy.members[request.form.serviceProviderUid]?.roles?.includes?.("doc")) {
+    throw new Error("Unavailable doctor selected.");
+  } else if (request.form.serviceProviderUid) {
+    throw new Error("Invalid doctor selected.");
+  }
+  if (request.form.serviceProviderUid === null || request.form.serviceProviderUid === void 0) {
+    selectedDoctor = findNextAvailableStaff(
+      availableDoctors,
+      request.preferences.apptDistAlg,
+      staffDetailsCopy
+    );
+  }
+  if (!selectedDoctor) {
+    throw new Error(
+      "Internal error found. Failed to find an available doctor."
+    );
+  } else {
+    selectedPhysAsst = findNextAvailableStaff(
+      Object.keys(staffDetailsCopy.partnerMap[selectedDoctor]),
+      "LOR",
+      staffDetailsCopy
+    );
+  }
+  if (request.preferences.serviceSelector === "scheduler" && (!request.form.charges || request.form.charges.length < 1)) {
+    throw new Error("Insufficient services selected.");
+  } else if (request.preferences.serviceSelector === "scheduler" && request.billing.offeredServices.deployed && request.form.charges.find(
+    (charge) => !!Object.values(request.billing.offeredServices.value).find(
+      (createdCharge) => findChanges(charge, createdCharge).length > 0
+    )
+  )) {
+    throw new Error("Invalid service(s) selected.");
+  }
+  if (request.preferences.enforcePaidAppointments && (!request.form.payments || request.form.payments.length < 1)) {
+    throw new Error("Insufficient payment transactions recorded.");
+  } else if (request.preferences.enforcePaidAppointments) {
+    const maxIterations = Math.max(
+      request.form.charges.length,
+      request.form.payments.length
+    );
+    let totalPaid = 0;
+    let totalOwed = 0;
+    for (let idx = 0; idx < maxIterations; idx++) {
+      totalPaid += request.form.payments[idx]?.amount || 0;
+      totalOwed += request.form.charges[idx]?.cost || 0;
+    }
+    if (totalPaid < totalOwed) throw new Error("Insufficient payments made.");
+  }
+  if (stateCopy.credits.current < request.cost) {
+    if (companyUser.roles.includes("admin")) {
+      throw new Error("Account balance has insufficient funds.");
+    } else {
+      throw new Error(
+        "Something went wrong. Please contact an admin to rectify the problem."
+      );
+    }
+  }
+  stateCopy.tktNoCounter++;
+  stateCopy.credits.current -= request.cost;
+  stateCopy.credits.lastModified = today;
+  stateCopy.lastModified = today;
+  staffDetailsCopy.members[selectedDoctor].appointments.ongoing++;
+  if (selectedPhysAsst) {
+    staffDetailsCopy.members[selectedPhysAsst].appointments.ongoing++;
+  }
+  staffDetailsCopy.lastModified = today;
+  const appointment = {
+    _id: v4(),
+    src: stateCopy.uid,
+    tkt: request.state.tktNoCounter,
+    discounts: Object.values(request.billing.discounts || {}).filter(
+      (disc) => !disc.isOptional
+    ),
+    additionalFees: Object.values(request.billing.additionalFees || {}).filter(
+      (fee) => !fee.isOptional
+    ),
+    payments: request.preferences.enforcePaidAppointments ? request.form.payments : null,
+    prepayments: request.preferences.enforcePaidAppointments ? request.form.prepayments || [] : null,
+    charges: request.preferences.serviceSelector === "scheduler" ? request.form.charges : [],
+    client: await request.findClient(request.form.clientUid),
+    _hash: "aa.aa.aa",
+    lastModified: null,
+    timeline: {
+      scheduler: { userUid: request.sender.uid, postedAt: today },
+      doctor: { userUid: selectedDoctor },
+      physAsst: selectedPhysAsst ? { userUid: selectedPhysAsst } : "none",
+      get cashier() {
+        if (request.preferences.enforcePaidAppointments) return this.scheduler;
+        return null;
+      }
+    },
+    createdAt: today
+  };
+  appointment._hash = request.createHash(omit(appointment, ["_hash"]));
+  return {
+    updates: {
+      state: stateCopy,
+      staffDetails: staffDetailsCopy
+    },
+    appointment: MutableAppointmentDetails.parse(appointment)
+  };
+}
 export {
+  AppointmentDetails,
   ClientIdentity,
   CompanyBilling,
   CompanyDetails,
@@ -658,20 +850,23 @@ export {
   CompanyStaff,
   CompanyState,
   CompanyUser,
-  CreateServiceForm,
   CreditCurrency,
   InviteResponse,
   InvoiceNo,
   MedicalDetails,
   Medicine,
-  MiniServiceDetails,
-  MutableServiceDetails,
+  MiniAppointmentDetails,
+  MutableAppointmentDetails,
+  MutableCompanyBilling,
+  MutableCompanyDetails,
+  MutableCompanyIdentity,
+  MutableCompanyPreferences,
   Notification,
   PriceAdjustment,
   PriceTag,
   Reason,
   Receipts,
-  ServiceDetails,
+  ScheduleAppointmentForm,
   StandardTime,
   TicketNo,
   TierList,
@@ -679,15 +874,18 @@ export {
   Timestamp,
   UserDetails,
   Vitals,
+  appointmentDistAlgs,
   companyPartnerRoles,
   companyServiceSelectors,
   companyUserRoles,
   employeeRoles,
+  findAvailableStaff,
   findConflictingPartners,
+  findNextAvailableStaff,
   getCompatibleRoles,
   healthcareProviderRoles,
   paymentMethods,
-  serviceDistAlgs,
+  scheduleAppointment,
   serviceProviders,
   tiers,
   vitalKeys

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bizmap/sdk",
-  "version": "0.0.58",
+  "version": "0.0.60",
   "main": "./dist/main.js",
   "types": "./dist/main.d.ts",
   "type": "module",