@bizmap/sdk 0.0.54 → 0.0.56

package/dist/main.js

@@ -1,4 +1,4 @@
-// src/enums/CompanyEnums.ts
+// src/enums/Company.ts
 import * as z from "zod";
 var companyUserRoles = z.enum([
   "doc",
@@ -19,33 +19,21 @@ var healthcareProviderRoles = companyUserRoles.extract([
 var appointmentDistAlgs = z.enum(["RR", "LOR"]);
 var companyServiceSelectors = z.enum(["scheduler", "doctor"]);
 
-// src/enums/Global.ts
+// src/enums/App.ts
 import * as z2 from "zod";
 var tiers = z2.enum(["free", "pro", "premium", "gold"]);
+var paymentMethods = z2.enum(["cash", "card", "insurance"]);
 
 // src/schemas/Billing.ts
 import { currencies } from "@wavy/util";
 import * as z4 from "zod";
 
 // src/schemas/utils.ts
-import { validate, version } from "uuid";
 import * as z3 from "zod";
 var InvoiceNo = z3.string().regex(
   /^[0-9]{4}-(01|(0[2-9])|(1[0-2]))-(30|31|([1-2][0-9])|0[1-9])-[0-9]{7}/,
   'An invoice no. must match the pattern "yyyy-mm-dd-9999999".'
 );
-var UuidV4 = z3.string().readonly().refine(
-  (uid) => validate(uid) && version(uid) === 4,
-  "Expected a v4 uuid but received an invalid uuid."
-);
-var UuidV7 = z3.string().readonly().refine(
-  (uid) => validate(uid) && version(uid) === 7,
-  "Expected a v7 uuid but received an invalid uuid."
-);
-var Jwt = z3.string().regex(
-  /^[A-Za-z0-9_-]{2,}(?:\.[A-Za-z0-9_-]{2,}){2}$/,
-  "An invalid jwt token was used."
-);
 var StandardTime = z3.string().regex(
   /^(01|(0[2-9])|(1[0-2])):(([1-5][0-9])|0[0-9]) (am|pm)/i,
   "A standard time must match the pattern hh:mm A."
@@ -59,6 +47,14 @@ var TimeLog = z3.object({
   createdAt: Timestamp.readonly(),
   lastModified: Timestamp.nullish()
 });
+var TicketNo = z3.int().positive().refine(
+  (t) => t.toString().length <= 10,
+  "A ticket no. can only have (10) max digits."
+).readonly();
+var Reason = z3.object({
+  value: z3.string().trim().max(150),
+  lastModified: Timestamp
+});
 
 // src/schemas/Billing.ts
 var PriceAdjustment = z4.object({
@@ -71,7 +67,7 @@ var PriceAdjustment = z4.object({
   ...TimeLog.shape
 });
 var PriceTag = z4.object({
-  uid: UuidV4,
+  uid: z4.uuidv4(),
   /**The name of the item that's being priced */
   item: z4.string().trim().min(3, "The price item must be atleast (3) characters long.").max(50, "The price item can't be more than (50) characters long."),
   cost: z4.number().min(1, "The minimum allowed cost is $1.00").max(1e9, "The max allowed cost is $1,000,000,000.00."),
@@ -80,8 +76,8 @@ var PriceTag = z4.object({
 });
 
 // src/schemas/Company.ts
-import { Address, PhoneNumber, UserModel } from "@wavy/util";
-import * as z6 from "zod";
+import { Address as Address2, PhoneNumber, UserModel as UserModel2 } from "@wavy/util";
+import * as z7 from "zod";
 
 // src/functions/helper-functions.ts
 var findConflictingPartners = (...partners) => {
@@ -114,7 +110,7 @@ var getCompatibleRoles = (role) => {
   return companyUserRoles.exclude([role]).options;
 };
 
-// src/schemas/Global.ts
+// src/schemas/App.ts
 import * as z5 from "zod";
 import { currencies as currencies2 } from "@wavy/util";
 var TierList = z5.record(
@@ -151,7 +147,7 @@ var Notification = z5.object({
   };
   switch (data.code) {
     case "COMPANY_INVITE":
-      if (!Jwt.safeParse(data.payload).success) {
+      if (!z5.jwt().safeParse(data.payload).success) {
         ctx.addIssue("The payload of company invite must be a valid jwt.");
       }
       break;
@@ -172,23 +168,47 @@ var Notification = z5.object({
       return data.code;
   }
 });
-var Credit = z5.object({
-  uid: UuidV4,
+var CreditCurrency = z5.object({
+  uid: z5.uuidv4(),
   cost: z5.object({ value: z5.number().min(0), currency: currencies2 }),
   value: z5.int().min(0),
   ...TimeLog.shape
 });
 
-// src/schemas/Company.ts
-var CompanyUser = z6.object({
+// src/schemas/User.ts
+import { Address, UserModel } from "@wavy/util";
+import * as z6 from "zod";
+var UserDetails = z6.object({
   ...UserModel.shape,
-  uid: UuidV7,
-  status: z6.enum(["inviteSent", "active", "inactive"]),
-  availability: z6.object({
-    isAvailable: z6.boolean().default(true),
+  uid: z6.uuidv4(),
+  email: UserModel.shape.email.nullish(),
+  dob: Timestamp.optional(),
+  address: Address.optional(),
+  publicKey: z6.string().nullable(),
+  notifications: z6.array(Notification),
+  activated: z6.boolean(),
+  ...TimeLog.shape
+}).superRefine((data, ctx) => {
+  if (data.activated && data.publicKey === null) {
+    ctx.addIssue("An activated user must have a valid public key.");
+  } else if (!data.activated && data.publicKey !== null) {
+    ctx.addIssue("An inactive user can't have a public key.");
+  }
+  if (data.activated && !data.email) {
+    ctx.addIssue("An activated user must have a valid email.");
+  }
+});
+
+// src/schemas/Company.ts
+var CompanyUser = z7.object({
+  ...UserModel2.shape,
+  uid: UserDetails.shape.uid,
+  status: z7.enum(["inviteSent", "active", "inactive"]),
+  availability: z7.object({
+    isAvailable: z7.boolean().default(true),
     lastModified: Timestamp.nullable().default(null)
   }),
-  roles: z6.array(companyUserRoles).transform((roles) => {
+  roles: z7.array(companyUserRoles).transform((roles) => {
     const newRoles = [];
     for (const role of roles) {
       if (!!role && !newRoles.includes(role)) newRoles.push(role);
@@ -199,11 +219,11 @@ var CompanyUser = z6.object({
       (role, i) => i === 0 || getCompatibleRoles(roles[0]).includes(role)
     );
   }, "A user is not allowed to have conflicting roles."),
-  isBusy: z6.boolean(),
+  isBusy: z7.boolean(),
   /** This should reset at the end of every cycle. */
-  appointmentCounter: z6.record(
-    z6.literal(["ongoing", "completed"]),
-    z6.int().min(0)
+  appointmentCounter: z7.record(
+    z7.literal(["ongoing", "completed"]),
+    z7.int().min(0)
   ),
   lastActive: Timestamp.nullable(),
   inviteSent: Timestamp.nullable(),
@@ -224,43 +244,49 @@ var CompanyUser = z6.object({
     );
   }
 });
-var CompanyInviteList = z6.record(
+var CompanyInviteList = z7.record(
   CompanyUser.shape.email,
-  z6.object({ createdAt: Timestamp, roles: CompanyUser.shape.roles })
+  z7.object({ createdAt: Timestamp, roles: CompanyUser.shape.roles })
 ).refine(
   (data) => Object.keys(data).length > 0,
   "Insufficient amount of members invited."
 );
-var CompanyIdentity = z6.object({
-  displayName: z6.string().min(3).max(25),
-  logo: z6.string().max(2500).nullish(),
-  contact: z6.object({
-    email: z6.email().max(25),
+var CompanyIdentity = z7.object({
+  displayName: z7.string().min(3).max(25),
+  logo: z7.string().max(2500).nullish(),
+  /** Hash this field */
+  // password: z.string(),
+  contact: z7.object({
+    email: z7.email().max(25),
     phoneNumber: PhoneNumber.optional()
   }),
-  address: Address,
+  address: Address2,
   // Can only be changed by the server
-  tier: z6.object({
+  tier: z7.object({
     current: tiers,
     lastModified: Timestamp.nullable()
   }),
-  legal: z6.object({
-    regNo: z6.string().max(20).readonly(),
+  legal: z7.object({
+    regNo: z7.string().max(20).readonly(),
     // The company's registration number
-    trn: z6.string().regex(/[0-9]{3}-[0-9]{3}-[0-9]{3}/).nullish(),
-    gctRegNo: z6.string().max(15).nullish()
+    trn: z7.string().regex(/[0-9]{3}-[0-9]{3}-[0-9]{3}/).nullish(),
+    gctRegNo: z7.string().max(15).nullish()
   }),
   lastModified: Timestamp.nullable()
 });
-var CompanyState = z6.object({
-  credits: z6.object({
-    current: z6.number(),
+var CompanyState = z7.object({
+  credits: z7.object({
+    current: z7.number(),
+    lastModified: Timestamp.nullable()
+  }),
+  maxStaff: z7.object({
+    current: z7.int().min(1),
     lastModified: Timestamp.nullable()
   }),
-  storageInBytes: z6.record(
-    z6.literal(["used", "max"]),
-    z6.object({
-      current: z6.number(),
+  storageInBytes: z7.record(
+    z7.literal(["used", "max"]),
+    z7.object({
+      current: z7.number(),
       lastModified: Timestamp.nullable()
     })
   ).refine(
@@ -270,13 +296,13 @@ var CompanyState = z6.object({
   /** A counter for the company's invoice no.
    * @note This should only be null when the cycle resets
    */
-  invoiceNoCounter: z6.int().min(1),
+  invoiceNoCounter: z7.int().min(1),
   /**  A counter for the company's ticket no. */
-  tktNoCounter: z6.int().min(1),
+  tktNoCounter: z7.int().min(1),
   lastSavedAt: Timestamp.nullable(),
   lastModified: Timestamp.nullable()
 });
-var CompanyPreferences = z6.object({
+var CompanyPreferences = z7.object({
   /** The user that's allowed to record the client's services. */
   serviceSelector: companyServiceSelectors,
   /** A record of the payments made must be attached before creating the
@@ -284,7 +310,7 @@ var CompanyPreferences = z6.object({
    * @note
    * - only allowed when `serviceDecider === "scheduler"`
    *  */
-  enforcePaidAppts: z6.boolean(),
+  enforcePaidAppts: z7.boolean(),
   /**
    * @property RR (Round Robin): Even distribution.
    * @property LOR (Least Outstanding Requests): Distribute based on availability.
@@ -295,13 +321,16 @@ var CompanyPreferences = z6.object({
   (data) => !data.enforcePaidAppts || data.enforcePaidAppts && data.serviceSelector === "scheduler",
   'Enforcing paid appointments is only allowed when the service selector is the "scheduler".'
 );
-var Billing = z6.object({
-  additionalFees: z6.array(PriceAdjustment).default([]),
-  discounts: z6.array(PriceAdjustment).default([]),
-  services: z6.object({
+var Billing = z7.object({
+  additionalFees: z7.array(PriceAdjustment).max(100).default([]),
+  /** Automatically deducted from ALL bills */
+  discounts: z7.array(PriceAdjustment).max(100).default([]),
+  /** Optionally deductable from bills */
+  prepayments: z7.array(PriceAdjustment).max(100).default([]),
+  services: z7.object({
     /** Forces service selectors to use the list of service(s) that you've created. */
-    deployed: z6.boolean(),
-    value: z6.record(z6.string(), PriceTag.omit({ uid: true }))
+    deployed: z7.boolean(),
+    value: z7.record(z7.string(), PriceTag.omit({ uid: true }))
   }).superRefine((data, ctx) => {
     const services = Object.entries(data.value);
     if (services.length > 150) {
@@ -324,8 +353,8 @@ var Billing = z6.object({
   }),
   lastModified: Timestamp.nullable()
 });
-var Staff = z6.object({
-  members: z6.record(CompanyUser.shape.uid, CompanyUser).superRefine((data, ctx) => {
+var Staff = z7.object({
+  members: z7.record(CompanyUser.shape.uid, CompanyUser).superRefine((data, ctx) => {
     const emails = [];
     for (const [uid, user] of Object.entries(data)) {
       if (uid !== user.uid) {
@@ -345,15 +374,15 @@ var Staff = z6.object({
   /**
    * @relationship one -> many
    *@description A map of doctor `uids` to their assistants `uids` */
-  partnerMap: z6.record(
+  partnerMap: z7.record(
     CompanyUser.shape.uid,
-    z6.record(CompanyUser.shape.uid, z6.object({ addedAt: Timestamp }))
+    z7.record(CompanyUser.shape.uid, z7.object({ addedAt: Timestamp }))
   ),
-  updateQueue: z6.record(
+  updateQueue: z7.record(
     CompanyUser.shape.uid,
-    z6.object({
-      $REMOVE: z6.object({ addedAt: Timestamp }),
-      $CHANGE_ROLES: z6.object({
+    z7.object({
+      $REMOVE: z7.object({ addedAt: Timestamp }),
+      $CHANGE_ROLES: z7.object({
         newRoles: CompanyUser.shape.roles,
         addedAt: Timestamp
       })
@@ -414,14 +443,14 @@ var Staff = z6.object({
     }
   }
 });
-var CompanyNotifications = z6.array(Notification).refine(
+var CompanyNotifications = z7.array(Notification).refine(
   (data) => data.every((notif) => notif.code !== "COMPANY_INVITE"),
   "A company can't receive a company invite."
 );
-var Receipts = z6.array(PriceTag.omit({ uid: true, lastModified: true }));
+var Receipts = z7.array(PriceTag.omit({ uid: true, lastModified: true }));
 var createCompanyDetails = (options) => {
-  return z6.object({
-    uid: UuidV7,
+  return z7.object({
+    uid: z7.uuidv4(),
     identity: CompanyIdentity,
     notifications: options.partial ? CompanyNotifications.nullish() : CompanyNotifications,
     receipts: options.partial ? Receipts.nullish() : Receipts,
@@ -434,24 +463,175 @@ var createCompanyDetails = (options) => {
 };
 var CompanyDetails = createCompanyDetails({ partial: false });
 var PartialCompanyDetails = createCompanyDetails({ partial: true });
+
+// src/schemas/Medical.ts
+import * as z9 from "zod";
+
+// src/enums/Medical.ts
+import * as z8 from "zod";
+var vitalKeys = z8.enum([
+  "heartRate",
+  "respiratoryRate",
+  "bloodPressure",
+  "bloodOxygen",
+  "bodyTemp"
+]);
+
+// src/schemas/Medical.ts
+var Vitals = z9.record(
+  vitalKeys,
+  z9.object({
+    value: z9.string().trim().regex(/^\d{0,3}((\/|\.)\d{1,3})?/),
+    lastModified: Timestamp.nullable()
+  })
+);
+var Medicine = z9.object({
+  brand: z9.string().trim(),
+  expiresAt: Timestamp.nullish(),
+  quantity: z9.string().trim().regex(/^\d+(\.\d{1,3})? ?[a-zA-Z]{1,20}/, {
+    error: "Failed to match the pattern <number>+(.<number>{1,3})? ?[a-zA-Z]{1,20}"
+  }),
+  refills: z9.string().trim().regex(/^[0-8]/, { error: "Must be between 0 and 8" }),
+  directions: z9.string().trim().max(100, { error: "Must be 100 characters or less" }),
+  ...TimeLog.shape
+});
+var MedicalDetails = z9.object({
+  vitals: Vitals,
+  prescriptions: z9.array(z9.array(Medicine)).nullish(),
+  doctorNote: z9.object({
+    value: z9.string(),
+    lastModified: Timestamp.nullable()
+  }),
+  physAsstNotes: z9.array(
+    z9.object({
+      title: z9.string(),
+      content: z9.string(),
+      ...TimeLog.shape
+    })
+  ).optional()
+});
+
+// src/schemas/mini/Services.ts
+import * as z10 from "zod";
+
+// src/schemas/Client.ts
+var ClientIdentity = UserDetails.omit({ notifications: true });
+
+// src/schemas/mini/Services.ts
+var TimelineActivity = z10.object({
+  postedAt: Timestamp.nullish(),
+  userUid: CompanyUser.shape.uid.nonoptional()
+});
+var MiniServiceDetails = z10.object({
+  /** A random uid that identifies the document. */
+  _id: z10.uuidv4(),
+  /** The company's uid */
+  src: CompanyDetails.shape.uid,
+  /** The ticket number */
+  tkt: TicketNo,
+  /**The reason for the service */
+  reason: z10.object({
+    value: Reason.shape.value,
+    ...TimeLog.shape
+  }).optional(),
+  /**
+   * This gets resolved after the service provider attaches an invoice and posts the client
+   * (resolving after posting the client is required for consistency - if it's added when the
+   * appointment is created and the appointment get cancelled, then there would be a missing
+   * invoiceNo, which will seem a bit suspicious...)
+   */
+  invoiceNo: InvoiceNo.optional(),
+  /** The services that the client has done/will do. */
+  charges: z10.array(PriceTag.omit({ uid: true })).max(4),
+  /**Required to calculate the accurate grandTotal of the charges */
+  additionalFees: z10.array(PriceAdjustment).nullable().readonly(),
+  /**Required to calculate the accurate grandTotal of the charges */
+  discounts: z10.array(PriceAdjustment).nullable().readonly(),
+  prepayments: z10.array(PriceAdjustment).nullable(),
+  /** The client's identity */
+  clientUid: ClientIdentity.shape.uid,
+  /**
+   * Data that is specific to the entity (for now it's just medical data).
+   * It will only be defined for the participants that have access to it.
+   */
+  payload: z10.object({
+    ...MedicalDetails.shape,
+    lastModified: z10.number().nullable()
+  }).nullish(),
+  /** Only defined when either the service provider or the client cancelled their appointment */
+  cancelled: z10.object({
+    /** The time that the confirm cancel button was clicked */
+    doneAt: Timestamp,
+    reason: Reason,
+    doneBy: companyUserRoles.extract(["doc", "physAsst"])
+  }).optional(),
+  /** Add this after consulting with company owners about payment expectations */
+  // paymentDueDate: Timestamp.nullish(),
+  payments: z10.array(
+    z10.object({
+      method: paymentMethods,
+      amount: z10.number().positive(),
+      ...TimeLog.shape
+    })
+  ).max(100).nullish(),
+  timeline: z10.object({
+    scheduler: TimelineActivity,
+    physAsst: TimelineActivity.or(z10.literal("none")),
+    doctor: TimelineActivity,
+    cashier: TimelineActivity.nullable()
+  }),
+  ...TimeLog.shape
+});
+
+// src/schemas/unpacked/Services.ts
+import { nameKeys } from "@wavy/util";
+import * as z11 from "zod";
+var ServiceDetails = MiniServiceDetails.omit({
+  clientUid: true
+}).extend(z11.object({ client: ClientIdentity }).shape);
+var MutableServiceDetails = ServiceDetails.safeExtend(
+  z11.object({
+    /**
+     * @description An encrypted copy of the last state of the service.
+     * @note Used to accurately update the service without having to query the database
+     */
+    _hash: z11.string()
+  }).shape
+);
+var CreateServiceForm = z11.object({
+  clientName: z11.record(nameKeys, z11.string().trim().min(2)),
+  /** A nullish value === next_available */
+  providerUid: CompanyUser.shape.uid.nullish(),
+  charges: ServiceDetails.shape.charges.optional(),
+  prepayments: ServiceDetails.shape.prepayments.optional(),
+  payments: ServiceDetails.shape.payments.optional(),
+  ...TimeLog.shape
+});
 export {
   CompanyDetails,
   CompanyInviteList,
   CompanyUser,
-  Credit,
+  CreateServiceForm,
+  CreditCurrency,
   InviteResponse,
   InvoiceNo,
-  Jwt,
+  MedicalDetails,
+  Medicine,
+  MiniServiceDetails,
+  MutableServiceDetails,
   Notification,
   PartialCompanyDetails,
   PriceAdjustment,
   PriceTag,
+  Reason,
+  ServiceDetails,
   StandardTime,
+  TicketNo,
   TierList,
   TimeLog,
   Timestamp,
-  UuidV4,
-  UuidV7,
+  UserDetails,
+  Vitals,
   appointmentDistAlgs,
   companyPartnerRoles,
   companyServiceSelectors,
@@ -460,5 +640,6 @@ export {
   findConflictingPartners,
   getCompatibleRoles,
   healthcareProviderRoles,
+  paymentMethods,
   tiers
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bizmap/sdk",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "main": "./dist/main.js",
   "types": "./dist/main.d.ts",
   "type": "module",
@@ -16,12 +16,17 @@
   "author": "",
   "license": "MIT",
   "peerDependencies": {
-    "@wavy/util": "^0.0.11",
+    "@wavy/fn": "^0.0.40",
+    "@wavy/util": "^0.0.12",
+    "jsonwebtoken": "^9.0.3",
     "zod": "^4.2.1"
   },
   "description": "",
   "devDependencies": {
-    "@wavy/util": "^0.0.11",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@wavy/fn": "^0.0.40",
+    "@wavy/util": "^0.0.12",
+    "jsonwebtoken": "^9.0.3",
     "tsup": "^8.5.0",
     "typescript": "^5.9.2",
     "zod": "^4.2.1"