@bizmap/sdk 0.0.100 → 0.0.101

package/dist/main.d.ts

@@ -1,5 +1,5 @@
 import * as z from 'zod';
-import { SafeOmit } from '@wavy/util';
+import { SafeOmit, Prettify } from '@wavy/util';
 
 declare const companyUserRoles: z.ZodEnum<{
     doc: "doc";
@@ -956,7 +956,7 @@ declare const Reason: z.ZodObject<{
 declare const Version: z.ZodInt;
 declare const AlphaNumeric: z.ZodString;
 
-declare const PriceAdjustment: z.ZodObject<{
+declare const PriceMod: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodISODateTime>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
     description: z.ZodString;
@@ -969,7 +969,21 @@ declare const PriceAdjustment: z.ZodObject<{
     percentage: z.ZodNumber;
     isOptional: z.ZodBoolean;
 }, z.core.$strip>;
-type PriceAdjustment = z.infer<typeof PriceAdjustment>;
+type PriceMod = z.infer<typeof PriceMod>;
+declare const PriceModList: z.ZodRecord<z.ZodUUID, z.ZodObject<{
+    createdAt: z.ZodReadonly<z.ZodISODateTime>;
+    lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    description: z.ZodString;
+    fixedAmount: z.ZodObject<{
+        value: z.ZodNumber;
+        currency: z.ZodEnum<{
+            JMD: "JMD";
+        }>;
+    }, z.core.$strip>;
+    percentage: z.ZodNumber;
+    isOptional: z.ZodBoolean;
+}, z.core.$strip>>;
+type PriceModList = z.infer<typeof PriceModList>;
 declare const PriceTag: z.ZodObject<{
     createdAt: z.ZodReadonly<z.ZodISODateTime>;
     lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
@@ -1131,6 +1145,20 @@ declare const MiniAppointmentDetails: z.ZodObject<{
         percentage: z.ZodNumber;
         isOptional: z.ZodBoolean;
     }, z.core.$strip>>>>;
+    payments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        createdAt: z.ZodReadonly<z.ZodISODateTime>;
+        lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+        uid: z.ZodUUID;
+        method: z.ZodEnum<{
+            cash: "cash";
+            card: "card";
+            insurance: "insurance";
+        }>;
+        currency: z.ZodEnum<{
+            JMD: "JMD";
+        }>;
+        amount: z.ZodNumber;
+    }, z.core.$strip>>>>;
     clientUid: z.ZodUUID;
     payload: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         lastModified: z.ZodNullable<z.ZodNumber>;
@@ -1175,20 +1203,6 @@ declare const MiniAppointmentDetails: z.ZodObject<{
             physAsst: "physAsst";
         }>;
     }, z.core.$strip>>;
-    payments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
-        createdAt: z.ZodReadonly<z.ZodISODateTime>;
-        lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
-        uid: z.ZodUUID;
-        method: z.ZodEnum<{
-            cash: "cash";
-            card: "card";
-            insurance: "insurance";
-        }>;
-        currency: z.ZodEnum<{
-            JMD: "JMD";
-        }>;
-        amount: z.ZodNumber;
-    }, z.core.$strip>>>>;
     lockedBy: z.ZodOptional<z.ZodUUID>;
     timeline: z.ZodObject<{
         scheduler: z.ZodObject<{
@@ -1304,17 +1318,6 @@ declare const AppointmentDetails: z.ZodObject<{
         item: z.ZodString;
         cost: z.ZodNumber;
     }, z.core.$strip>>>>;
-    cancelled: z.ZodOptional<z.ZodObject<{
-        doneAt: z.ZodISODateTime;
-        reason: z.ZodObject<{
-            value: z.ZodString;
-            lastModified: z.ZodISODateTime;
-        }, z.core.$strip>;
-        doneBy: z.ZodEnum<{
-            doc: "doc";
-            physAsst: "physAsst";
-        }>;
-    }, z.core.$strip>>;
     payments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         createdAt: z.ZodReadonly<z.ZodISODateTime>;
         lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
@@ -1329,6 +1332,17 @@ declare const AppointmentDetails: z.ZodObject<{
         }>;
         amount: z.ZodNumber;
     }, z.core.$strip>>>>;
+    cancelled: z.ZodOptional<z.ZodObject<{
+        doneAt: z.ZodISODateTime;
+        reason: z.ZodObject<{
+            value: z.ZodString;
+            lastModified: z.ZodISODateTime;
+        }, z.core.$strip>;
+        doneBy: z.ZodEnum<{
+            doc: "doc";
+            physAsst: "physAsst";
+        }>;
+    }, z.core.$strip>>;
     lockedBy: z.ZodOptional<z.ZodUUID>;
     timeline: z.ZodObject<{
         scheduler: z.ZodObject<{
@@ -1483,17 +1497,6 @@ declare const MutableAppointmentDetails: z.ZodObject<{
         item: z.ZodString;
         cost: z.ZodNumber;
     }, z.core.$strip>>>>;
-    cancelled: z.ZodOptional<z.ZodObject<{
-        doneAt: z.ZodISODateTime;
-        reason: z.ZodObject<{
-            value: z.ZodString;
-            lastModified: z.ZodISODateTime;
-        }, z.core.$strip>;
-        doneBy: z.ZodEnum<{
-            doc: "doc";
-            physAsst: "physAsst";
-        }>;
-    }, z.core.$strip>>;
     payments: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         createdAt: z.ZodReadonly<z.ZodISODateTime>;
         lastModified: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
@@ -1508,6 +1511,17 @@ declare const MutableAppointmentDetails: z.ZodObject<{
         }>;
         amount: z.ZodNumber;
     }, z.core.$strip>>>>;
+    cancelled: z.ZodOptional<z.ZodObject<{
+        doneAt: z.ZodISODateTime;
+        reason: z.ZodObject<{
+            value: z.ZodString;
+            lastModified: z.ZodISODateTime;
+        }, z.core.$strip>;
+        doneBy: z.ZodEnum<{
+            doc: "doc";
+            physAsst: "physAsst";
+        }>;
+    }, z.core.$strip>>;
     lockedBy: z.ZodOptional<z.ZodUUID>;
     timeline: z.ZodObject<{
         scheduler: z.ZodObject<{
@@ -1830,14 +1844,6 @@ declare function scheduleAppointment(request: RequestParameter): Promise<{
             cost: number;
             lastModified?: string | null | undefined;
         }> | null | undefined;
-        cancelled?: {
-            doneAt: string;
-            reason: {
-                value: string;
-                lastModified: string;
-            };
-            doneBy: "doc" | "physAsst";
-        } | undefined;
         payments?: {
             createdAt: string;
             uid: string;
@@ -1846,12 +1852,23 @@ declare function scheduleAppointment(request: RequestParameter): Promise<{
             amount: number;
             lastModified?: string | null | undefined;
         }[] | null | undefined;
+        cancelled?: {
+            doneAt: string;
+            reason: {
+                value: string;
+                lastModified: string;
+            };
+            doneBy: "doc" | "physAsst";
+        } | undefined;
         lockedBy?: string | undefined;
     };
 }>;
 
 /** @disclaimer This doesn't handle currency conversion */
-declare function calcAppointmentFee(appointment: Pick<AppointmentDetails, "charges" | "discounts" | "additionalFees" | "prepayments">): number;
+declare function calcBalance(components: Prettify<Partial<Pick<AppointmentDetails, "charges" | "discounts" | "additionalFees" | "prepayments" | "payments">>>, options?: {
+    logger?: boolean;
+}): number;
+declare const calcPriceMod: (mods: PriceModList | null | undefined, subtotal: number) => number;
 
 /**
  * @param {CompanyUserRole} role The role used to filter the staff members
@@ -1914,4 +1931,4 @@ declare function createNotifId(options?: {
     to: string;
 }): string;
 
-export { type AcceptedCurrency, AlphaNumeric, AppointmentDetails, type AppointmentDistAlg, ClientForm, ClientIdentity, CompanyBilling, CompanyDetails, CompanyIdentity, CompanyInviteList, CompanyNotifications, type CompanyPartnerRole, CompanyPreferences, type CompanyServiceSelector, CompanyStaff, CompanyState, CompanyUser, type CompanyUserRole, CompanyUserSession, type CompanyUserStatus, CreateCompanyForm, CreditCurrency, type EmployeeRole, type Gender, type HealthcareProviderRole, type Industry, InviteResponse, InvoiceNo, MedicalDetails, Medicine, MiniAppointmentDetails, MiniCompanyUser, MutableAppointmentDetails, MutableCompanyBilling, MutableCompanyDetails, MutableCompanyIdentity, MutableCompanyPreferences, Notification, PaymentDetails, type PaymentMethod, PriceAdjustment, PriceTag, Reason, Receipts, ScheduleAppointmentForm, StandardTime, TicketNo, type Tier, TierList, TimeLog, Timestamp, Trn, UserDetails, Version, Vitals, acceptedCurrencies, adminRoles, appointmentDistAlgs, calcAppointmentFee, companyPartnerRoles, companyServiceSelectors, companyUserRoles, companyUserStatus, createNotifId, employeeRoles, findAvailableStaff, findConflictingPartners, findNextAvailableStaff, genders, getCompatibleRoles, healthcareProviderRoles, industries, normalizeCompanyId, normalizeNidKey, parseClientName, paymentMethods, scheduleAppointment, serviceProviders, tiers, vitalKeys };
+export { type AcceptedCurrency, AlphaNumeric, AppointmentDetails, type AppointmentDistAlg, ClientForm, ClientIdentity, CompanyBilling, CompanyDetails, CompanyIdentity, CompanyInviteList, CompanyNotifications, type CompanyPartnerRole, CompanyPreferences, type CompanyServiceSelector, CompanyStaff, CompanyState, CompanyUser, type CompanyUserRole, CompanyUserSession, type CompanyUserStatus, CreateCompanyForm, CreditCurrency, type EmployeeRole, type Gender, type HealthcareProviderRole, type Industry, InviteResponse, InvoiceNo, MedicalDetails, Medicine, MiniAppointmentDetails, MiniCompanyUser, MutableAppointmentDetails, MutableCompanyBilling, MutableCompanyDetails, MutableCompanyIdentity, MutableCompanyPreferences, Notification, PaymentDetails, type PaymentMethod, PriceMod, PriceModList, PriceTag, Reason, Receipts, ScheduleAppointmentForm, StandardTime, TicketNo, type Tier, TierList, TimeLog, Timestamp, Trn, UserDetails, Version, Vitals, acceptedCurrencies, adminRoles, appointmentDistAlgs, calcBalance, calcPriceMod, companyPartnerRoles, companyServiceSelectors, companyUserRoles, companyUserStatus, createNotifId, employeeRoles, findAvailableStaff, findConflictingPartners, findNextAvailableStaff, genders, getCompatibleRoles, healthcareProviderRoles, industries, normalizeCompanyId, normalizeNidKey, parseClientName, paymentMethods, scheduleAppointment, serviceProviders, tiers, vitalKeys };

package/dist/main.js

@@ -104,7 +104,7 @@ var AlphaNumeric = z5.string().trim().superRefine((data, ctx) => {
 });
 
 // src/schemas/utils/billing.ts
-var PriceAdjustment = z6.object({
+var PriceMod = z6.object({
   description: z6.string().trim().min(3, "A description must have atleast (3) characters.").max(25, "A description can't have more that (25) characters.").superRefine((data, ctx) => {
     const invalidCharIdx = data.search(/[^a-zA-Z0-9-\.:\(\)]/);
     if (invalidCharIdx > -1) {
@@ -119,6 +119,7 @@ var PriceAdjustment = z6.object({
   isOptional: z6.boolean(),
   ...TimeLog.shape
 });
+var PriceModList = z6.record(z6.uuidv4(), PriceMod);
 var PriceTag = z6.object({
   uid: z6.uuidv4(),
   /**The name of the item that's being priced */
@@ -178,16 +179,16 @@ var CompanyState = z7.object({
 });
 
 // src/schemas/company/components/Billing.ts
-var createAdjustments = (resource) => z8.record(z8.uuidv4(), PriceAdjustment).refine(
+var createMod = (resource) => PriceModList.refine(
   (d) => Object.values(d).length <= 100,
   `Adding more than 100 ${resource}s is prohibited.`
 );
 var CompanyBilling = z8.object({
   _id: CompanyState.shape._id,
-  additionalFees: createAdjustments("additional fee"),
-  discounts: createAdjustments("discount"),
+  additionalFees: createMod("additional fee"),
+  discounts: createMod("discount"),
   /** Optionally deductable from bills */
-  prepayments: createAdjustments("pre-payment"),
+  prepayments: createMod("pre-payment"),
   offeredServices: z8.record(z8.uuidv4(), PriceTag.omit({ uid: true })).superRefine((data, ctx) => {
     const services = Object.entries(data);
     if (services.length > 150) {
@@ -777,21 +778,25 @@ var MedicalDetails = z20.object({
 import { sumOf as sumOf2 } from "@wavy/fn";
 import * as z21 from "zod";
 
-// src/functions/calcAppointmentFee.ts
+// src/functions/calculations.ts
 import { sumOf } from "@wavy/fn";
-function calcAppointmentFee(appointment) {
+function calcBalance(components, options) {
   const subtotal = sumOf(
-    Object.values(appointment.charges || {})?.map((c) => c.cost)
+    Object.values(components.charges || {})?.map((c) => c.cost)
   );
-  const discount = calcAdjustment(appointment.discounts, subtotal);
-  const additionalFees = calcAdjustment(appointment.additionalFees, subtotal);
-  const prepayments = calcAdjustment(appointment.prepayments, subtotal);
-  console.log({ subtotal, discount, additionalFees, prepayments });
-  return subtotal + additionalFees - (discount + prepayments);
+  const discount = calcPriceMod(components.discounts, subtotal);
+  const additionalFees = calcPriceMod(components.additionalFees, subtotal);
+  const prepayments = calcPriceMod(components.prepayments, subtotal);
+  const payments = sumOf(components.payments?.map((p) => p.amount) ?? []);
+  const result = subtotal + additionalFees - (discount + prepayments + payments);
+  if (options?.logger) {
+    console.log({ subtotal, discount, additionalFees, prepayments, result });
+  }
+  return result;
 }
-var calcAdjustment = (adjustments, subtotal) => {
-  const castedAdjustments = !adjustments ? [] : Object.values(adjustments);
-  if (!adjustments || castedAdjustments.length < 1) return 0;
+var calcPriceMod = (mods, subtotal) => {
+  const castedAdjustments = !mods ? [] : Object.values(mods);
+  if (!mods || castedAdjustments.length < 1) return 0;
   return sumOf(
     castedAdjustments?.map(
       (d) => (d.fixedAmount?.value || 0) + (d.percentage ? d.percentage * 0.01 * subtotal : 0)
@@ -835,6 +840,7 @@ var MiniAppointmentDetails = z21.object({
   /**Required to calculate the accurate grandTotal of the charges */
   discounts: CompanyBilling.shape.discounts.nullish(),
   prepayments: CompanyBilling.shape.prepayments.nullish(),
+  payments: z21.array(PaymentDetails).max(100).nullish(),
   /** The client's identity */
   clientUid: ClientIdentity.shape._id,
   /**
@@ -852,9 +858,8 @@ var MiniAppointmentDetails = z21.object({
     reason: Reason,
     doneBy: companyUserRoles.extract(["doc", "physAsst"])
   }).optional(),
-  /** Add this after consulting with company owners about payment expectations */
+  //** Add this after consulting with company owners about payment expectations */
   // paymentDueDate: Timestamp.nullish(),
-  payments: z21.array(PaymentDetails).max(100).nullish(),
   // The user that is currently modifying the appointment
   lockedBy: UserDetails.shape._id.optional(),
   timeline: z21.object({
@@ -872,7 +877,7 @@ var MiniAppointmentDetails = z21.object({
   }),
   ...TimeLog.shape
 }).superRefine((data, ctx) => {
-  if (data.payments && data.charges && sumOf2(data.payments.map((p) => p.amount)) >= calcAppointmentFee(data)) {
+  if (data.payments && data.charges && sumOf2(data.payments.map((p) => p.amount)) >= calcBalance(data)) {
     const untrackedPayment = data.payments.find(
       (p) => !data.timeline.debtCollector?.some(
         (d) => p.uid in d.collectedPayments
@@ -1133,7 +1138,8 @@ export {
   MutableCompanyPreferences,
   Notification,
   PaymentDetails,
-  PriceAdjustment,
+  PriceMod,
+  PriceModList,
   PriceTag,
   Reason,
   Receipts,
@@ -1150,7 +1156,8 @@ export {
   acceptedCurrencies,
   adminRoles,
   appointmentDistAlgs,
-  calcAppointmentFee,
+  calcBalance,
+  calcPriceMod,
   companyPartnerRoles,
   companyServiceSelectors,
   companyUserRoles,

package/package.json

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