@bizmap/sdk 0.0.13 → 0.0.15

package/dist/main.d.ts

@@ -54,6 +54,8 @@ declare const CompanyOpState: z.ZodObject<{
     uid: z.ZodReadonly<z.ZodString>;
     availableBalance: z.ZodNumber;
     preferences: z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodNumber>;
+        lastModified: z.ZodNullable<z.ZodNumber>;
         userProvisions: z.ZodNumber;
         apptDistAlg: z.ZodEnum<{
             RR: "RR";
@@ -67,16 +69,14 @@ declare const CompanyBillingModel: z.ZodObject<{
     lastModified: z.ZodNullable<z.ZodNumber>;
     uid: z.ZodReadonly<z.ZodString>;
     preferences: z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodNumber>;
+        lastModified: z.ZodNullable<z.ZodNumber>;
         allowInvoiceDist: z.ZodBoolean;
-        serviceDecider: z.ZodEnum<{
+        serviceSelector: z.ZodEnum<{
             scheduler: "scheduler";
             doctor: "doctor";
         }>;
         enforcePaidAppts: z.ZodBoolean;
-        paymentCollector: z.ZodNullable<z.ZodEnum<{
-            doc: "doc";
-            cshr: "cshr";
-        }>>;
         primaryCurrency: z.ZodEnum<{
             JMD: "JMD";
         }>;
@@ -176,19 +176,19 @@ type CompanyRegistrationClaims = z.infer<typeof CompanyRegistrationClaims>;
 declare const CompanyUser: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodNumber>;
     lastModified: z.ZodNullable<z.ZodNumber>;
-    lastActive: z.ZodNumber;
     status: z.ZodEnum<{
         inviteSent: "inviteSent";
         active: "active";
         inactive: "inactive";
     }>;
-    roles: z.ZodArray<z.ZodEnum<{
+    roles: 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")[]>>;
+    lastActive: z.ZodNumber;
     name: z.ZodRecord<z.ZodEnum<{
         first: "first";
         last: "last";
@@ -200,24 +200,24 @@ declare const CompanyUser: z.ZodObject<{
 }, z.core.$strip>;
 type CompanyUser = z.infer<typeof CompanyUser>;
 /** The unpacked Staff Details */
-declare const StaffDetails: z.ZodObject<{
+declare const StaffDetails: z.ZodPipe<z.ZodObject<{
     uid: z.ZodReadonly<z.ZodString>;
     members: z.ZodArray<z.ZodObject<{
         createdAt: z.ZodReadonly<z.ZodNumber>;
         lastModified: z.ZodNullable<z.ZodNumber>;
-        lastActive: z.ZodNumber;
         status: z.ZodEnum<{
             inviteSent: "inviteSent";
             active: "active";
             inactive: "inactive";
         }>;
-        roles: z.ZodArray<z.ZodEnum<{
+        roles: 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")[]>>;
+        lastActive: z.ZodNumber;
         name: z.ZodRecord<z.ZodEnum<{
             first: "first";
             last: "last";
@@ -227,10 +227,186 @@ declare const StaffDetails: z.ZodObject<{
         phoneNumber: z.ZodOptional<z.ZodString>;
         uid: z.ZodString;
     }, z.core.$strip>>;
-    partnerMap: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
-    blackList: z.ZodArray<z.ZodString>;
-}, z.core.$strip>;
+    partnerMap: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+    blackList: z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>;
+}, z.core.$strip>, z.ZodTransform<{
+    uid: string;
+    members: {
+        createdAt: number;
+        lastModified: number | null;
+        status: "inviteSent" | "active" | "inactive";
+        roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+        lastActive: number;
+        name: Record<"first" | "last", string>;
+        email: string;
+        uid: string;
+        photoUrl?: string | undefined;
+        phoneNumber?: string | undefined;
+    }[];
+    partnerMap: Record<string, string[]>;
+    blackList: string[];
+}, {
+    uid: string;
+    members: {
+        createdAt: number;
+        lastModified: number | null;
+        status: "inviteSent" | "active" | "inactive";
+        roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+        lastActive: number;
+        name: Record<"first" | "last", string>;
+        email: string;
+        uid: string;
+        photoUrl?: string | undefined;
+        phoneNumber?: string | undefined;
+    }[];
+    partnerMap: Record<string, string[]>;
+    blackList: string[];
+}>>;
 type StaffDetails = z.infer<typeof StaffDetails>;
+declare const CompanyDetails: z.ZodObject<{
+    uid: z.ZodString;
+    identity: z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodNumber>;
+        lastModified: z.ZodNullable<z.ZodNumber>;
+        uid: z.ZodReadonly<z.ZodString>;
+        displayName: z.ZodString;
+        logo: z.ZodOptional<z.ZodString>;
+        contact: z.ZodObject<{
+            email: z.ZodEmail;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        address: z.ZodRecord<z.ZodEnum<{
+            streetAddress: "streetAddress";
+            city: "city";
+            parish: "parish";
+            country: "country";
+        }>, z.ZodString>;
+        legal: z.ZodObject<{
+            regNo: z.ZodReadonly<z.ZodString>;
+            trn: z.ZodOptional<z.ZodString>;
+            gctRegNo: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    opState: z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodNumber>;
+        lastModified: z.ZodNullable<z.ZodNumber>;
+        uid: z.ZodReadonly<z.ZodString>;
+        availableBalance: z.ZodNumber;
+        preferences: z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodNumber>;
+            lastModified: z.ZodNullable<z.ZodNumber>;
+            userProvisions: z.ZodNumber;
+            apptDistAlg: z.ZodEnum<{
+                RR: "RR";
+                LOR: "LOR";
+            }>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    billing: z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodNumber>;
+        lastModified: z.ZodNullable<z.ZodNumber>;
+        uid: z.ZodReadonly<z.ZodString>;
+        preferences: z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodNumber>;
+            lastModified: z.ZodNullable<z.ZodNumber>;
+            allowInvoiceDist: z.ZodBoolean;
+            serviceSelector: z.ZodEnum<{
+                scheduler: "scheduler";
+                doctor: "doctor";
+            }>;
+            enforcePaidAppts: z.ZodBoolean;
+            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>;
+            description: z.ZodOptional<z.ZodString>;
+            fixedAmount: z.ZodNumber;
+            percentage: z.ZodNumber;
+        }, z.core.$strip>>>;
+        discounts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodNumber>;
+            lastModified: z.ZodNullable<z.ZodNumber>;
+            description: z.ZodOptional<z.ZodString>;
+            fixedAmount: z.ZodNumber;
+            percentage: z.ZodNumber;
+        }, z.core.$strip>>>;
+        services: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodNumber>;
+            lastModified: z.ZodNullable<z.ZodNumber>;
+            item: z.ZodString;
+            cost: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+    staffDetails: z.ZodPipe<z.ZodObject<{
+        uid: z.ZodReadonly<z.ZodString>;
+        members: z.ZodArray<z.ZodObject<{
+            createdAt: z.ZodReadonly<z.ZodNumber>;
+            lastModified: z.ZodNullable<z.ZodNumber>;
+            status: z.ZodEnum<{
+                inviteSent: "inviteSent";
+                active: "active";
+                inactive: "inactive";
+            }>;
+            roles: 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")[]>>;
+            lastActive: z.ZodNumber;
+            name: z.ZodRecord<z.ZodEnum<{
+                first: "first";
+                last: "last";
+            }>, z.ZodString>;
+            photoUrl: z.ZodOptional<z.ZodString>;
+            email: z.ZodEmail;
+            phoneNumber: z.ZodOptional<z.ZodString>;
+            uid: z.ZodString;
+        }, z.core.$strip>>;
+        partnerMap: z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+        blackList: z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>;
+    }, z.core.$strip>, z.ZodTransform<{
+        uid: string;
+        members: {
+            createdAt: number;
+            lastModified: number | null;
+            status: "inviteSent" | "active" | "inactive";
+            roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+            lastActive: number;
+            name: Record<"first" | "last", string>;
+            email: string;
+            uid: string;
+            photoUrl?: string | undefined;
+            phoneNumber?: string | undefined;
+        }[];
+        partnerMap: Record<string, string[]>;
+        blackList: string[];
+    }, {
+        uid: string;
+        members: {
+            createdAt: number;
+            lastModified: number | null;
+            status: "inviteSent" | "active" | "inactive";
+            roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+            lastActive: number;
+            name: Record<"first" | "last", string>;
+            email: string;
+            uid: string;
+            photoUrl?: string | undefined;
+            phoneNumber?: string | undefined;
+        }[];
+        partnerMap: Record<string, string[]>;
+        blackList: string[];
+    }>>;
+}, z.core.$strip>;
+type CompanyDetails = z.infer<typeof CompanyDetails>;
 
 declare const TimeLog: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodNumber>;
@@ -265,4 +441,20 @@ declare const appointmentDistAlgs: z.ZodEnum<{
 }>;
 type AppointmentDistAlg = z.infer<typeof appointmentDistAlgs>;
 
-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 };
+/**@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[]) => {
+    createdAt: number;
+    lastModified: number | null;
+    status: "inviteSent" | "active" | "inactive";
+    roles: ("doc" | "physAsst" | "rcpst" | "cshr" | "admin")[];
+    lastActive: number;
+    name: Record<"first" | "last", string>;
+    email: string;
+    uid: string;
+    photoUrl?: string | undefined;
+    phoneNumber?: string | undefined;
+}[] | null;
+/**@returns the roles that are compatible with the selected role. */
+declare const getCompatibleRoles: (role: CompanyUserRole) => CompanyUserRole[];
+
+export { type AppointmentDistAlg, CompanyBillingModel, CompanyDetails, CompanyIdentity, CompanyOpState, type CompanyPartnerRole, CompanyRegistrationClaims, CompanyUser, type CompanyUserRole, type EmployeeRole, PriceAdjustment, PriceTag, PricingRate, RegisterCompanyForm, StaffDetails, Time, TimeLog, appointmentDistAlgs, companyPartnerRoles, companyUserRoles, employeeRoles, findConflictingPartners, getCompatibleRoles };

package/dist/main.js

@@ -84,12 +84,13 @@ var CompanyOpState = z4.object({
   // This can be changed by the company's admin
   preferences: z4.object({
     /** The amount of user provisions made for this company */
-    userProvisions: z4.number(),
+    userProvisions: z4.number().min(10, { error: "The total user provisions must atleast be 10." }).max(150, { error: "The total user provisions can't exceed 150" }),
     /**
      * @property RR (Round Robin): Even distribution.
      * @property LOR (Least Outstanding Requests): Distribute based on availability.
      */
-    apptDistAlg: appointmentDistAlgs
+    apptDistAlg: appointmentDistAlgs,
+    ...TimeLog.shape
   }),
   ...TimeLog.shape
 });
@@ -99,7 +100,7 @@ var CompanyBillingModel = 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"]),
+    serviceSelector: z4.enum(["scheduler", "doctor"]),
     /** A record of the payments made must be attached before creating the
      * appointment
      * @note
@@ -107,27 +108,15 @@ var CompanyBillingModel = z4.object({
      * - 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)
+    acceptedCurrencies: z4.array(currencies),
+    ...TimeLog.shape
   }).superRefine((data, ctx) => {
-    if (data.enforcePaidAppts && data.serviceDecider !== "scheduler") {
+    if (data.enforcePaidAppts && data.serviceSelector !== "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(),
@@ -151,22 +140,165 @@ var CompanyRegistrationClaims = z4.object({
 });
 var CompanyUser = z4.object({
   ...UserModel.shape,
-  lastActive: z4.number(),
   status: z4.enum(["inviteSent", "active", "inactive"]),
-  roles: z4.array(companyUserRoles),
+  roles: z4.array(companyUserRoles).transform((roles) => {
+    const newRoles = [];
+    for (const role of roles) {
+      if (!role || typeof role !== "string") continue;
+      if (!newRoles.includes(role)) newRoles.push(role);
+    }
+    return newRoles;
+  }).refine((roles) => {
+    const compatibleRoles = getCompatibleRoles(roles[0]);
+    return roles.every(
+      (role, i) => i === 0 || compatibleRoles.includes(role)
+    );
+  }, "A user is not allowed to have conflicting roles."),
+  lastActive: z4.number(),
   ...TimeLog.shape
 });
 var StaffDetails = z4.object({
   uid: CompanyIdentity.shape.uid,
-  members: z4.array(CompanyUser),
+  members: z4.array(CompanyUser).superRefine((users, ctx) => {
+    const duplicateUids = [];
+    const duplicateEmails = [];
+    const uids = [];
+    const emails = [];
+    for (const user of users) {
+      if (uids.includes(user.uid)) {
+        duplicateUids.push(user.uid);
+      } else {
+        uids.push(user.uid);
+      }
+      if (emails.includes(user.email)) {
+        duplicateEmails.push(user.email);
+      } else {
+        emails.push(user.email);
+      }
+    }
+    if (duplicateUids.length > 0) {
+      ctx.addIssue(
+        `Having multiple members with the same uid is prohibited (${duplicateUids.join()}).`
+      );
+    }
+    if (duplicateEmails.length > 0) {
+      ctx.addIssue(
+        `Having multiple members with the same email is prohibited (${duplicateEmails.join()}).`
+      );
+    }
+  }),
   /**
    * @relationship one -> many
    *@description A map of doctor `uids` to their assistants `uids` */
-  partnerMap: z4.record(CompanyUser.shape.uid, z4.array(CompanyUser.shape.uid)),
-  blackList: z4.array(CompanyUser.shape.uid)
+  partnerMap: z4.record(
+    CompanyUser.shape.uid,
+    z4.array(CompanyUser.shape.uid).min(
+      1,
+      "At least (1) partner, excluding the leader, is required to create a partner group."
+    ).transform((pUids) => {
+      const partners = [];
+      for (const uid of pUids) {
+        if (!uid || typeof uid !== "string") continue;
+        if (!partners.some((p) => p.toLowerCase() === uid.toLowerCase())) {
+          partners.push(uid);
+        }
+      }
+      return partners;
+    })
+  ),
+  blackList: z4.array(CompanyUser.shape.uid).transform((list) => {
+    const newList = [];
+    for (const uid of list) {
+      if (!uid || typeof uid !== "string") continue;
+      if (!newList.some(
+        (newUid) => newUid.toLowerCase() === uid.toLowerCase()
+      )) {
+        newList.push(uid);
+      }
+    }
+    return newList;
+  })
+  // ...TimeLog.shape,
+}).transform((d) => {
+  let blackListWithExisitingUsers = [];
+  for (const uid of d.blackList) {
+    if (!uid || typeof uid !== "string") continue;
+    if (d.members.find((m) => m.uid.toLowerCase() === uid.toLowerCase())) {
+      blackListWithExisitingUsers.push(uid);
+    }
+  }
+  if (blackListWithExisitingUsers.length !== d.blackList.length) {
+    d.blackList = blackListWithExisitingUsers;
+  }
+  return d;
+}).superRefine((details, ctx) => {
+  const findMember = (uid) => details.members.find((m) => m.uid === uid);
+  for (const [docUid, physAssts] of Object.entries(details.partnerMap)) {
+    const queriedDoc = findMember(docUid);
+    if (!queriedDoc) {
+      ctx.addIssue(
+        `Only existing members of a company are allowed to be leaders of a partner group (${docUid}).`
+      );
+    } else if (!queriedDoc?.roles?.includes?.("doc")) {
+      ctx.addIssue(
+        `A partner group leader must have the "doc" role (${docUid}).`
+      );
+    }
+    for (const asstUid of physAssts) {
+      const queriedAsst = findMember(asstUid);
+      if (!queriedAsst) {
+        ctx.addIssue(
+          `Only existing members of a company are allowed to be apart of a partner group (${asstUid}).`
+        );
+      } else if (!queriedAsst?.roles?.includes?.("physAsst")) {
+        ctx.addIssue(
+          `A partner group member must have the "physAsst" role (${asstUid}).`
+        );
+      }
+    }
+  }
 });
+var CompanyDetails = z4.object({
+  uid: z4.string(),
+  identity: CompanyIdentity,
+  opState: CompanyOpState,
+  billing: CompanyBillingModel,
+  staffDetails: StaffDetails
+});
+
+// src/functions/helper-functions.ts
+var findConflictingPartners = (...partners) => {
+  let hasSingleDoctor = false;
+  const conflicts = [];
+  if (!partners) return partners;
+  for (const partner of partners) {
+    if (!partner.roles || partner.roles.some(
+      (r) => !companyPartnerRoles.options.includes(r)
+    ) || !CompanyUser.shape.roles.safeParse(partner.roles).success) {
+      conflicts.push(partner);
+      continue;
+    }
+    if (partner.roles.includes("doc") && !hasSingleDoctor) {
+      hasSingleDoctor = true;
+    } else if (partner.roles.includes("doc")) {
+      conflicts.push(partner);
+      continue;
+    }
+  }
+  return conflicts.length === 0 ? null : conflicts;
+};
+var getCompatibleRoles = (role) => {
+  if (role === "physAsst") {
+    return companyUserRoles.exclude(["admin", "doc", role]).options;
+  }
+  if (role === "admin" || role === "doc") {
+    return companyUserRoles.exclude(["physAsst", role]).options;
+  }
+  return companyUserRoles.exclude([role]).options;
+};
 export {
   CompanyBillingModel,
+  CompanyDetails,
   CompanyIdentity,
   CompanyOpState,
   CompanyRegistrationClaims,
@@ -181,5 +313,7 @@ export {
   appointmentDistAlgs,
   companyPartnerRoles,
   companyUserRoles,
-  employeeRoles
+  employeeRoles,
+  findConflictingPartners,
+  getCompatibleRoles
 };

package/package.json

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