@bizmap/sdk 0.0.11 → 0.0.13

package/dist/main.d.ts

@@ -53,34 +53,37 @@ declare const CompanyOpState: z.ZodObject<{
     lastModified: z.ZodNullable<z.ZodNumber>;
     uid: z.ZodReadonly<z.ZodString>;
     availableBalance: z.ZodNumber;
-    isOffline: z.ZodBoolean;
+    preferences: z.ZodObject<{
+        userProvisions: z.ZodNumber;
+        apptDistAlg: z.ZodEnum<{
+            RR: "RR";
+            LOR: "LOR";
+        }>;
+    }, z.core.$strip>;
 }, z.core.$strip>;
 type CompanyOpState = z.infer<typeof CompanyOpState>;
-declare const CompanyPreferences: z.ZodObject<{
-    createdAt: z.ZodReadonly<z.ZodNumber>;
-    lastModified: z.ZodNullable<z.ZodNumber>;
-    uid: z.ZodReadonly<z.ZodString>;
-    userProvisions: z.ZodNumber;
-    apptDistAlg: z.ZodEnum<{
-        RR: "RR";
-        LOR: "LOR";
-    }>;
-}, z.core.$strip>;
-type CompanyPreferences = z.infer<typeof CompanyPreferences>;
 declare const CompanyBillingModel: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodNumber>;
     lastModified: z.ZodNullable<z.ZodNumber>;
     uid: z.ZodReadonly<z.ZodString>;
-    biller: z.ZodEnum<{
-        doc: "doc";
-        fdc: "fdc";
-    }>;
-    primaryCurrency: z.ZodEnum<{
-        JMD: "JMD";
-    }>;
-    acceptedCurrencies: z.ZodArray<z.ZodEnum<{
-        JMD: "JMD";
-    }>>;
+    preferences: z.ZodObject<{
+        allowInvoiceDist: z.ZodBoolean;
+        serviceDecider: z.ZodEnum<{
+            scheduler: "scheduler";
+            doctor: "doctor";
+        }>;
+        enforcePaidAppts: z.ZodBoolean;
+        paymentCollector: z.ZodNullable<z.ZodEnum<{
+            doc: "doc";
+            cshr: "cshr";
+        }>>;
+        primaryCurrency: z.ZodEnum<{
+            JMD: "JMD";
+        }>;
+        acceptedCurrencies: z.ZodArray<z.ZodEnum<{
+            JMD: "JMD";
+        }>>;
+    }, z.core.$strip>;
     additionalFees: z.ZodOptional<z.ZodArray<z.ZodObject<{
         createdAt: z.ZodReadonly<z.ZodNumber>;
         lastModified: z.ZodNullable<z.ZodNumber>;
@@ -184,7 +187,6 @@ declare const CompanyUser: z.ZodObject<{
         physAsst: "physAsst";
         rcpst: "rcpst";
         cshr: "cshr";
-        fdc: "fdc";
         admin: "admin";
     }>>;
     name: z.ZodRecord<z.ZodEnum<{
@@ -214,7 +216,6 @@ declare const StaffDetails: z.ZodObject<{
             physAsst: "physAsst";
             rcpst: "rcpst";
             cshr: "cshr";
-            fdc: "fdc";
             admin: "admin";
         }>>;
         name: z.ZodRecord<z.ZodEnum<{
@@ -243,7 +244,6 @@ declare const companyUserRoles: z.ZodEnum<{
     physAsst: "physAsst";
     rcpst: "rcpst";
     cshr: "cshr";
-    fdc: "fdc";
     admin: "admin";
 }>;
 type CompanyUserRole = z.infer<typeof companyUserRoles>;
@@ -257,7 +257,6 @@ declare const employeeRoles: z.ZodEnum<{
     physAsst: "physAsst";
     rcpst: "rcpst";
     cshr: "cshr";
-    fdc: "fdc";
 }>;
 type EmployeeRole = z.infer<typeof employeeRoles>;
 declare const appointmentDistAlgs: z.ZodEnum<{
@@ -266,4 +265,4 @@ declare const appointmentDistAlgs: z.ZodEnum<{
 }>;
 type AppointmentDistAlg = z.infer<typeof appointmentDistAlgs>;
 
-export { type AppointmentDistAlg, CompanyBillingModel, CompanyIdentity, CompanyOpState, type CompanyPartnerRole, CompanyPreferences, CompanyRegistrationClaims, CompanyUser, type CompanyUserRole, type EmployeeRole, PriceAdjustment, PriceTag, PricingRate, RegisterCompanyForm, StaffDetails, Time, TimeLog, appointmentDistAlgs, companyPartnerRoles, companyUserRoles, employeeRoles };
+export { type AppointmentDistAlg, CompanyBillingModel, CompanyIdentity, CompanyOpState, type CompanyPartnerRole, CompanyRegistrationClaims, CompanyUser, type CompanyUserRole, type EmployeeRole, PriceAdjustment, PriceTag, PricingRate, RegisterCompanyForm, StaffDetails, Time, TimeLog, appointmentDistAlgs, companyPartnerRoles, companyUserRoles, employeeRoles };

package/dist/main.js

@@ -48,7 +48,6 @@ var companyUserRoles = z3.enum([
   "physAsst",
   "rcpst",
   "cshr",
-  "fdc",
   "admin"
 ]);
 var companyPartnerRoles = companyUserRoles.extract([
@@ -80,40 +79,59 @@ var CompanyIdentity = z4.object({
 var CompanyOpState = z4.object({
   // The company's uid
   uid: CompanyIdentity.shape.uid,
+  // This can only be changed by the server/app admin
   availableBalance: z4.number(),
-  isOffline: z4.boolean(),
-  ...TimeLog.shape
-});
-var CompanyPreferences = z4.object({
-  // The company's uid
-  uid: CompanyIdentity.shape.uid,
-  /** The amount of user provisions made for this company */
-  userProvisions: z4.number(),
-  /**
-   * @property RR (Round Robin): Even distribution.
-   * @property LOR (Least Outstanding Requests): Distribute based on availability.
-   */
-  apptDistAlg: appointmentDistAlgs,
-  // // Required to determine:
-  // //  [1] when the working directory on the server should reset
-  // //  [2] the time that company session requests are cut-off
-  // //      (the cutoff time affects non-admins)
-  // workingHours: z.object({
-  //   start: Time,
-  //   end: Time,
-  // }),
+  // This can be changed by the company's admin
+  preferences: z4.object({
+    /** The amount of user provisions made for this company */
+    userProvisions: z4.number(),
+    /**
+     * @property RR (Round Robin): Even distribution.
+     * @property LOR (Least Outstanding Requests): Distribute based on availability.
+     */
+    apptDistAlg: appointmentDistAlgs
+  }),
   ...TimeLog.shape
 });
 var CompanyBillingModel = z4.object({
   uid: CompanyIdentity.shape.uid,
-  // Preferences
-  /** The user that provides the bill to the client */
-  biller: companyUserRoles.extract(["doc", "fdc"]),
-  primaryCurrency: currencies,
-  acceptedCurrencies: z4.array(currencies),
+  preferences: z4.object({
+    /** Allows the serviceDecider to distribute invoices. */
+    allowInvoiceDist: z4.boolean(),
+    /** The user that's allowed to record the client's services. */
+    serviceDecider: z4.enum(["scheduler", "doctor"]),
+    /** A record of the payments made must be attached before creating the
+     * appointment
+     * @note
+     * - only allowed when `serviceDecider === "scheduler"`
+     * - removes the `cshr` role from the company's allowed user roles
+     *  */
+    enforcePaidAppts: z4.boolean(),
+    /**
+     * Determines who collects & records payments made by clients.
+     * @default "cshr"
+     * @note
+     * - if `collector === "doc"`, the `cshr` role will be removed from the company's allowed user roles.
+     * - if `enforcePaidAppts === true`, this should be null.
+     */
+    paymentCollector: companyUserRoles.extract(["doc", "cshr"]).nullable(),
+    primaryCurrency: currencies,
+    acceptedCurrencies: z4.array(currencies)
+  }).superRefine((data, ctx) => {
+    if (data.enforcePaidAppts && data.serviceDecider !== "scheduler") {
+      ctx.addIssue(
+        "serviceDecider must be scheduler when enforcePaidAppts is true."
+      );
+    }
+    if (data.enforcePaidAppts && data.paymentCollector !== null) {
+      ctx.addIssue(
+        "paymentCollector must be null when enforcePaidAppts is true."
+      );
+    }
+  }),
   additionalFees: z4.array(PriceAdjustment).optional(),
   discounts: z4.array(PriceAdjustment).optional(),
-  services: z4.array(PriceTag.omit({ uid: true })).optional(),
+  services: z4.array(PriceTag.omit({ uid: true })).min(1).max(100).optional(),
   ...TimeLog.shape
 });
 var RegisterCompanyForm = z4.object({
@@ -151,7 +169,6 @@ export {
   CompanyBillingModel,
   CompanyIdentity,
   CompanyOpState,
-  CompanyPreferences,
   CompanyRegistrationClaims,
   CompanyUser,
   PriceAdjustment,

package/package.json

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