@natch-the-storage/heathershaw-platform-types 1.19.18 → 1.20.0

package/build/validators.d.ts

@@ -317,6 +317,7 @@ export interface ChargeOrder {
     customerIp?: string;
     orderUpdate?: Omit<OrderUpdate, 'id' | 'directUserProfileId' | 'partnerPharmacyProfileId' | 'patientRecordId'>;
     patientRecordUpdate?: Omit<PatientRecordUpdate, 'id'>;
+    isStaff?: boolean;
 }
 export interface PaperScriptReminder {
     id: number;
@@ -662,6 +663,12 @@ export declare const CompoundDirectAnimalId: {
     };
 };
 export declare const AnimalSpeciesKeys: [keyof typeof CompoundDirectAnimalId, ...(keyof typeof CompoundDirectAnimalId)[]];
+export interface CDEPrescription {
+    type: string;
+    /** If true, indicates this is an eRx script, if false or undefined, assume it is a paper script */
+    isETP2?: boolean;
+    fileUrl?: string;
+}
 export interface CDScriptPriceOption {
     id: number;
     quantity: number;
@@ -722,10 +729,7 @@ export interface CDScript {
         repeatsTotal: number;
         repeatsLeft: number;
         supplyNumber: number;
-        ePrescription?: {
-            type: string;
-            isETP2?: boolean; /** If true, indicates this is an eRx script, if false or undefined, assume it is a paper script */
-        };
+        ePrescription?: CDEPrescription;
     };
     formulation: {
         formulationId: number;
@@ -737,6 +741,117 @@ export interface CDScript {
     };
     itemCount: number;
 }
+export interface CDDispensedScript {
+    scriptId: number;
+    scriptNumber: number;
+    scriptBarcode: string;
+    scriptType: string;
+    name: string;
+    quantity: number;
+    itemCount: number;
+    isReorderable: boolean;
+    isArchived: boolean;
+    disableRiskAssessment: boolean;
+    comment?: string;
+    notes?: string;
+    draftScriptId?: number;
+    compound: Pick<CDFormulation, 'formulationId' | 'isCapsule' | 'unit' | 'dosageFormName'> & {
+        /** Expiry date of compounded product - ISO timestamp */
+        productExpiryDate: string;
+        expiryDays: number;
+    };
+    prescription: {
+        originalScriptNumber: string;
+        instructions: string;
+        /** yyyy-mm-dd ISO date */
+        datePrescribed?: string;
+        isExpired: boolean;
+        repeatsLeft: number;
+        repeatsTotal: number;
+        supplyNumber: number;
+        isRepeatDispensed: boolean;
+        /** Rx expiry date - yyyy-mm-dd ISO date */
+        expiryDate?: string;
+        customer?: CDCustomer;
+        additionalSupplyNumber: number;
+        comment?: '';
+        labelInstructions?: '';
+        ePrescription?: CDEPrescription;
+    };
+    /** Date a pharmacist has dispensed the script - ISO timestamp yyyy-mm-ddThh:mm:ss.000Z */
+    dateDispensed: string;
+    /** Date the script was generated - ISO timestamp yyyy-mm-ddThh:mm:ss.000Z */
+    createdDate: string;
+    /** ISO timestamp yyyy-mm-ddThh:mm:ss.000Z */
+    modifiedDate: string;
+    formulationProperties: CDScriptProperties[];
+    repeatChain: CDDispensedScriptRepeatChain[];
+}
+export interface CDDispensedScriptRepeatChain {
+    key: string;
+    repeatsLeft: number;
+    isDeleted: boolean;
+    isEmpty: boolean;
+    /** Supply number of the item. */
+    supplyNumber?: number;
+    /** Script number of the item */
+    number?: string;
+    quantity?: number | string;
+    date?: string;
+    draftScriptId?: number;
+    dispensedScriptId?: number;
+}
+/** The script item retrieved from a customer_scripts search on compound direct */
+export interface CDSearchScripts {
+    key: string;
+    id: number;
+    isDispensed: boolean;
+    scriptType: 'compound' | 'stockProduct' | 'retail' | 'drug' | 'externalBatchStock';
+    price: number;
+    repeatsLeft: number;
+    repeatsTotal: number;
+    labelName: string;
+    /** Dispensing instructions / SIG */
+    instructions: string;
+    isRepeatDispensed: boolean;
+    /** Quantity on the script */
+    quantity: number;
+    /** Number of items on the script. */
+    itemCount: number;
+    /** Date and time the record was created
+     * ISO timestamp yyyy-mm-ddThh:mm:ss.000Z */
+    createdDate: string;
+    /** Whether the script can be reordered */
+    isReorderable: boolean;
+    /** Whether the script is archived */
+    isArchived: boolean;
+    /** Whether the script is expired */
+    isExpired: boolean;
+    draftScriptId?: number;
+    dispensedScriptId?: number;
+    isEPrescription?: boolean;
+    unit?: string;
+    /** ISO timestamp yyyy-mm-ddThh:mm:ss.000Z */
+    dateDispensed?: '2026-06-19T06:29:02.000Z';
+    /** ISO date - yyyy-mm-dd  */
+    datePrescribed?: string;
+    supplyNumber?: number;
+    totalQuantityPrescribed?: number;
+    totalQuantityRemaining?: number;
+    minimumInterval?: number;
+    deferred?: boolean;
+    owing?: boolean;
+    originalQuantity?: number;
+    isVariableSupply?: boolean;
+    /** ISO date - yyyy-mm-dd  */
+    expiryDate?: string;
+    /** Number of days the supply covers */
+    daysSupply?: 30;
+    refillReminderEnabled?: boolean;
+    /** Default next refill reminder date
+     * ISO date - yyyy-mm-dd  */
+    defaultNextRefillReminderDate?: string;
+}
 /**
  * A customer object from Compound Direct
  * @dateOfBirth IsoDateString, only date portion
@@ -755,7 +870,7 @@ export interface CDCustomer {
     email: string;
     createdDate: string;
     modifiedDate: string;
-    isAnimal: false;
+    isAnimal: boolean;
     dateOfBirth: string;
     isMobileInvalid: boolean;
     note: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natch-the-storage/heathershaw-platform-types",
-  "version": "1.19.18",
+  "version": "1.20.0",
   "description": "Interfaces and routes to use on the client",
   "license": "ISC",
   "author": "Natch Surana",