@natch-the-storage/heathershaw-platform-types 1.9.5 → 1.10.0

package/build/validators.d.ts

@@ -5,6 +5,8 @@ export declare const paymentStatusValues: readonly ["AWAITING_PAYMENT", "PAID",
 export declare const repeatStorageValues: readonly ["HEATHERSHAWS", "PHARMACY", "PATIENT"];
 export declare const scriptTypeValues: readonly ["eRx", "PAPER"];
 export declare const shippingTypeValues: readonly ["STANDARD", "COLD_CHAIN"];
+export declare const staffProfileRoleValues: readonly ["ACTIVE", "SUSPENDED"];
+export declare const staffProfileStatusValues: readonly ["ACTIVE", "SUSPENDED"];
 export type PaperScriptReminderStatus = (typeof paperScriptReminderStatusValues)[number];
 export type QuoteStatus = (typeof quoteStatusValues)[number];
 export type PaymentModeAtOrder = (typeof paymentModeAtOrderValues)[number];
@@ -12,6 +14,8 @@ export type PaymentStatus = (typeof paymentStatusValues)[number];
 export type RepeatStorage = (typeof repeatStorageValues)[number];
 export type ScriptType = (typeof scriptTypeValues)[number];
 export type ShippingType = (typeof shippingTypeValues)[number];
+export type StaffProfileRole = (typeof staffProfileRoleValues)[number];
+export type StaffProfileStatus = (typeof staffProfileStatusValues)[number];
 export interface Address {
     street: string;
     suburb: string;
@@ -31,15 +35,6 @@ export interface HealthInfo {
     additionalInfo?: string;
     lastUpdated?: string;
 }
-export interface ScriptSelect {
-    id: number;
-    patientRecordId: number;
-    partnerPharmacyProfileId?: number;
-    uploaded: string;
-    processed: boolean;
-    token?: string | null;
-    fileKey?: string | null;
-}
 export interface LineItem {
     id: string;
     name: string;
@@ -87,6 +82,18 @@ export interface Sms {
     to: string;
     from: string;
 }
+interface DashboardData {
+    label: string;
+    count: number;
+}
+export interface AdminDashboardData {
+    pendingOrders: DashboardData;
+    ordersRequiringCounselling: DashboardData;
+    unpaidOrders: DashboardData;
+    pendingQuotes: DashboardData;
+    unprocessedScripts: DashboardData;
+    unprocessedPaperScripts: DashboardData;
+}
 export interface User {
     id: string;
     name: string;
@@ -105,7 +112,7 @@ export interface User {
 }
 export interface DirectUserProfile {
     id: number;
-    userId?: string;
+    userId: string;
     remindersEnabled?: boolean;
 }
 export interface DirectUserProfileCreate {
@@ -137,7 +144,7 @@ export interface Order {
     counsellingPriority?: string;
     counselledBy?: string;
     consellingNotes?: string;
-    counselledStatus?: string;
+    counsellingStatus?: string;
     confirmationSentAt?: Date;
     patientCharged?: number;
     overage?: number;
@@ -171,7 +178,7 @@ export interface OrderCreate {
     counsellingPriority?: string;
     counselledBy?: string;
     consellingNotes?: string;
-    counselledStatus?: string;
+    counsellingStatus?: string;
     confirmationSentAt?: Date;
     patientCharged?: number;
     overage?: number;
@@ -203,8 +210,8 @@ export interface PaperScriptReminderCreate {
 }
 export interface PartnerPharmacyProfile {
     id: number;
-    userId?: string;
-    abn?: string;
+    userId: string;
+    abn: string;
     pharmacyName: string;
     contactName: string;
     invoiceEmail: string;
@@ -233,7 +240,7 @@ export interface PartnerPharmacyProfileCreate {
 export interface PartnerPharmacyProfileReportData {
     orderCount: number;
     patientRecordCount: number;
-    awaitingPatientPayment: number;
+    pendingPaperScripts: number;
 }
 export interface PatientRecord {
     id: number;
@@ -249,25 +256,25 @@ export interface PatientRecord {
     addresses?: Address[];
     healthInfo?: HealthInfo;
     reminderEnabled?: boolean;
-    scripts?: ScriptSelect[];
+    scripts?: Script[];
     orderHistory?: Order[];
     animalSpecies?: string;
     relationship?: string | null;
 }
 export interface PatientRecordCreate {
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string;
-    phone: string;
     partnerPharmacyProfileId?: number | null;
     directUserProfileId?: number | null;
     compoundDirectId?: number | null;
     userId?: string | null;
+    firstName: string;
+    lastName: string;
+    dateOfBirth: string;
+    phone: string;
     medicareNumber?: string | null;
     addresses?: Address[];
     healthInfo?: HealthInfo;
     reminderEnabled?: boolean;
-    scripts?: ScriptSelect[];
+    scripts?: Script[];
     orderHistory?: Order[];
     animalSpecies?: string;
     relationship?: string | null;
@@ -354,6 +361,36 @@ export interface getScriptsQuery {
     patientRecordId?: number;
     partnerPharmacyProfileId?: number;
 }
+export interface StaffProfile {
+    id: number;
+    userId: string;
+    name: string;
+    email: string;
+    userName: string;
+    role: StaffProfileRole;
+    status: StaffProfileStatus;
+}
+export interface StaffProfileCreate {
+    userId: string;
+    name: string;
+    email: string;
+    userName: string;
+    password: string;
+    role: StaffProfileRole;
+    status: StaffProfileStatus;
+}
+export interface UpdateStaffProfilePassword {
+    newPassword: string;
+}
+export interface StaffProfileSignIn {
+    userName: string;
+    password: string;
+}
+export interface GetStaffProfilesQuery {
+    page?: number;
+    limit?: number;
+    userId?: string;
+}
 export interface Cart {
     id: number;
     directUserProfileId?: number;
@@ -612,6 +649,37 @@ export declare const BucketObjects: {
     };
 };
 export declare const ApiRoutes: {
+    admin: {
+        getDashboardData: string;
+    };
+    cart: {
+        getByDirectUser: (id: number) => string;
+        getByPartnerPharmacy: (id: number) => string;
+        put: string;
+        deleteByDirectUser: (id: number) => string;
+        deleteByPartnerPharmacy: (id: number) => string;
+    };
+    compoundDirect: {
+        searchCustomers: string;
+        createCustomer: string;
+        getDraftScripts: string;
+        getDraftScriptById: (id: number) => string;
+        listFormulations: string;
+        getFormulationById: (id: number) => string;
+    };
+    directUserProfiles: {
+        list: string;
+        get: (id: number) => string;
+        getByUser: (userId: string) => string;
+        getOrders: (userId: number) => string;
+        create: string;
+        onboard: (userId: string) => string;
+        update: string;
+        delete: (id: number) => string;
+    };
+    email: {
+        contactFormInternal: string;
+    };
     orders: {
         list: (filters?: {
             partnerPharmacyProfileId?: number;
@@ -623,40 +691,26 @@ export declare const ApiRoutes: {
         update: string;
         delete: (id: number) => string;
     };
-    patientRecords: {
-        list: (id?: number, type?: "partner" | "direct") => string;
-        get: (id: number) => string;
-        getByUser: (userId: string) => string;
-        create: string;
-        update: string;
-        delete: (id: number) => string;
-    };
-    scripts: {
-        get: (filters?: getScriptsQuery) => string;
-        getById: (id: number) => string;
-        createEscript: string;
-        createPaperScript: string;
-        update: string;
-        delete: (id: number) => string;
-    };
-    quotes: {
+    paperScriptReminders: {
         list: string;
         get: (id: number) => string;
         create: string;
         update: string;
         delete: (id: number) => string;
     };
-    paperScriptReminders: {
+    partnerPharmacyProfiles: {
         list: string;
         get: (id: number) => string;
+        getByUser: (userId: string) => string;
         create: string;
         update: string;
         delete: (id: number) => string;
+        getReportData: (id: number) => string;
     };
-    repeatReminders: {
-        list: string;
+    patientRecords: {
+        list: (id?: number, type?: "partner" | "direct") => string;
         get: (id: number) => string;
-        history: (id: number) => string;
+        getByUser: (userId: string) => string;
         create: string;
         update: string;
         delete: (id: number) => string;
@@ -668,52 +722,51 @@ export declare const ApiRoutes: {
         update: string;
         delete: (id: number) => string;
     };
-    directUserProfiles: {
+    quotes: {
         list: string;
         get: (id: number) => string;
-        getByUser: (userId: string) => string;
-        getOrders: (userId: number) => string;
         create: string;
-        onboard: (userId: string) => string;
         update: string;
         delete: (id: number) => string;
     };
-    partnerPharmacyProfiles: {
+    repeatReminders: {
         list: string;
         get: (id: number) => string;
-        getByUser: (userId: string) => string;
+        history: (id: number) => string;
         create: string;
         update: string;
         delete: (id: number) => string;
-        getReportData: (id: number) => string;
-    };
-    users: {
-        data: (userId: string) => string;
     };
-    uploads: {
-        presign: string;
-        delete: string;
+    scripts: {
+        get: (filters?: getScriptsQuery) => string;
+        getById: (id: number) => string;
+        createEscript: string;
+        createPaperScript: string;
+        update: string;
+        delete: (id: number) => string;
     };
     sms: {
         twilioStatus: string;
         send: string;
     };
-    email: {
-        contactFormInternal: string;
+    staffProfiles: {
+        list: (filters?: {
+            userId?: string;
+            page?: number;
+            limit?: number;
+        }) => string;
+        get: (id: number) => string;
+        create: string;
+        update: string;
+        updatePassword: (id: number) => string;
+        signIn: string;
     };
-    cart: {
-        getByDirectUser: (id: number) => string;
-        getByPartnerPharmacy: (id: number) => string;
-        put: string;
-        deleteByDirectUser: (id: number) => string;
-        deleteByPartnerPharmacy: (id: number) => string;
+    uploads: {
+        presign: string;
+        delete: string;
     };
-    compoundDirect: {
-        searchCustomers: string;
-        createCustomer: string;
-        getDraftScripts: string;
-        getDraftScriptById: (id: number) => string;
-        listFormulations: string;
-        getFormulationById: (id: number) => string;
+    users: {
+        data: (userId: string) => string;
     };
 };
+export {};

package/build/validators.js

@@ -18,6 +18,8 @@ export const repeatStorageValues = [
 ];
 export const scriptTypeValues = ['eRx', 'PAPER'];
 export const shippingTypeValues = ['STANDARD', 'COLD_CHAIN'];
+export const staffProfileRoleValues = ['ACTIVE', 'SUSPENDED'];
+export const staffProfileStatusValues = ['ACTIVE', 'SUSPENDED'];
 // ─── Compound Direct ────────────────────────────────────────────────────────────
 export const CompoundDirectAnimalId = {
     dog: { id: 1, name: 'Dog' },
@@ -75,6 +77,37 @@ export const BucketObjects = {
     },
 };
 export const ApiRoutes = {
+    admin: {
+        getDashboardData: '/admin/dashboard-data',
+    },
+    cart: {
+        getByDirectUser: (id) => `/api/carts/direct-users/${id}`,
+        getByPartnerPharmacy: (id) => `/api/carts/partner-pharmacies/${id}`,
+        put: '/api/carts',
+        deleteByDirectUser: (id) => `/api/carts/direct-users/${id}`,
+        deleteByPartnerPharmacy: (id) => `/api/carts/partner-pharmacies/${id}`,
+    },
+    compoundDirect: {
+        searchCustomers: '/api/compound-direct/customers',
+        createCustomer: '/api/compound-direct/customer',
+        getDraftScripts: '/api/compound-direct/draft-scripts',
+        getDraftScriptById: (id) => `/api/compound-direct/draft-scripts/${id}`,
+        listFormulations: '/api/compound-direct/formulations',
+        getFormulationById: (id) => `/api/compound-direct/formulations/${id}`,
+    },
+    directUserProfiles: {
+        list: '/api/profiles/direct-users',
+        get: (id) => `/api/profiles/direct-users/${id}`,
+        getByUser: (userId) => `/api/profiles/direct-users/users/${userId}`,
+        getOrders: (userId) => `/api/profiles/direct-users/users/${userId}/orders`,
+        create: '/api/profiles/direct-users',
+        onboard: (userId) => `/api/profiles/direct-users/${userId}`,
+        update: '/api/profiles/direct-users',
+        delete: (id) => `/api/profiles/direct-users/${id}`,
+    },
+    email: {
+        contactFormInternal: '/api/emails/contact-requests',
+    },
     orders: {
         list: (filters) => {
             const params = new URLSearchParams();
@@ -92,6 +125,22 @@ export const ApiRoutes = {
         update: '/api/orders',
         delete: (id) => `/api/orders/${id}`,
     },
+    paperScriptReminders: {
+        list: '/api/paper-script-reminders',
+        get: (id) => `/api/paper-script-reminders/${id}`,
+        create: '/api/paper-script-reminders',
+        update: '/api/paper-script-reminders',
+        delete: (id) => `/api/paper-script-reminders/${id}`,
+    },
+    partnerPharmacyProfiles: {
+        list: '/api/profiles/partner-pharmacies',
+        get: (id) => `/api/profiles/partner-pharmacies/${id}`,
+        getByUser: (userId) => `/api/profiles/partner-pharmacies/user/${userId}`,
+        create: '/api/profiles/partner-pharmacies',
+        update: '/api/profiles/partner-pharmacies',
+        delete: (id) => `/api/profiles/partner-pharmacies/${id}`,
+        getReportData: (id) => `/api/profiles/partner-pharmacies/${id}/reports`,
+    },
     patientRecords: {
         list: (id, type) => '/api/patient-records' + `${type ? '?' + type + '=' + id : ''}`,
         get: (id) => `/api/patient-records/${id}`,
@@ -100,21 +149,12 @@ export const ApiRoutes = {
         update: '/api/patient-records',
         delete: (id) => `/api/patient-records/${id}`,
     },
-    scripts: {
-        get: (filters) => {
-            const params = new URLSearchParams();
-            if (filters?.partnerPharmacyProfileId)
-                params.set('partnerPharmacyProfileId', String(filters.partnerPharmacyProfileId));
-            if (filters?.patientRecordId)
-                params.set('patientRecordId', String(filters.patientRecordId));
-            const query = params.toString();
-            return `/api/scripts${query ? `/?${query}` : ''}`;
-        },
-        getById: (id) => `/api/scripts/${id}`,
-        createEscript: '/api/scripts/escripts',
-        createPaperScript: '/api/scripts/paper-scripts',
-        update: '/api/scripts',
-        delete: (id) => `/api/scripts/${id}`,
+    priceMatches: {
+        list: '/api/price-matches',
+        get: (id) => `/api/price-matches/${id}`,
+        create: '/api/price-matches',
+        update: '/api/price-matches',
+        delete: (id) => `/api/price-matches/${id}`,
     },
     quotes: {
         list: '/api/quotes',
@@ -123,13 +163,6 @@ export const ApiRoutes = {
         update: '/api/quotes',
         delete: (id) => `/api/quotes/${id}`,
     },
-    paperScriptReminders: {
-        list: '/api/paper-script-reminders',
-        get: (id) => `/api/paper-script-reminders/${id}`,
-        create: '/api/paper-script-reminders',
-        update: '/api/paper-script-reminders',
-        delete: (id) => `/api/paper-script-reminders/${id}`,
-    },
     repeatReminders: {
         list: '/api/reminders/repeats',
         get: (id) => `/api/reminders/repeats/${id}`,
@@ -138,59 +171,49 @@ export const ApiRoutes = {
         update: '/api/reminders/repeats',
         delete: (id) => `/api/reminders/repeats/${id}`,
     },
-    priceMatches: {
-        list: '/api/price-matches',
-        get: (id) => `/api/price-matches/${id}`,
-        create: '/api/price-matches',
-        update: '/api/price-matches',
-        delete: (id) => `/api/price-matches/${id}`,
-    },
-    directUserProfiles: {
-        list: '/api/profiles/direct-users',
-        get: (id) => `/api/profiles/direct-users/${id}`,
-        getByUser: (userId) => `/api/profiles/direct-users/users/${userId}`,
-        getOrders: (userId) => `/api/profiles/direct-users/users/${userId}/orders`,
-        create: '/api/profiles/direct-users',
-        onboard: (userId) => `/api/profiles/direct-users/${userId}`,
-        update: '/api/profiles/direct-users',
-        delete: (id) => `/api/profiles/direct-users/${id}`,
-    },
-    partnerPharmacyProfiles: {
-        list: '/api/profiles/partner-pharmacies',
-        get: (id) => `/api/profiles/partner-pharmacies/${id}`,
-        getByUser: (userId) => `/api/profiles/partner-pharmacies/user/${userId}`,
-        create: '/api/profiles/partner-pharmacies',
-        update: '/api/profiles/partner-pharmacies',
-        delete: (id) => `/api/profiles/partner-pharmacies/${id}`,
-        getReportData: (id) => `/api/profiles/partner-pharmacies/${id}/reports`,
-    },
-    users: {
-        data: (userId) => `/api/users/data/${userId}`,
-    },
-    uploads: {
-        presign: '/api/uploads/presign',
-        delete: '/api/uploads',
+    scripts: {
+        get: (filters) => {
+            const params = new URLSearchParams();
+            if (filters?.partnerPharmacyProfileId)
+                params.set('partnerPharmacyProfileId', String(filters.partnerPharmacyProfileId));
+            if (filters?.patientRecordId)
+                params.set('patientRecordId', String(filters.patientRecordId));
+            const query = params.toString();
+            return `/api/scripts${query ? `?${query}` : ''}`;
+        },
+        getById: (id) => `/api/scripts/${id}`,
+        createEscript: '/api/scripts/escripts',
+        createPaperScript: '/api/scripts/paper-scripts',
+        update: '/api/scripts',
+        delete: (id) => `/api/scripts/${id}`,
     },
     sms: {
         twilioStatus: '/api/webhooks/twilio/status',
         send: '/api/reminders/sms',
     },
-    email: {
-        contactFormInternal: '/api/emails/contact-requests',
+    staffProfiles: {
+        list: (filters) => {
+            const params = new URLSearchParams();
+            if (filters?.userId)
+                params.set('userId', filters.userId);
+            if (filters?.page)
+                params.set('page', String(filters.page));
+            if (filters?.limit)
+                params.set('limit', String(filters.limit));
+            const query = params.toString();
+            return `/api/profiles/staff-profiles${query ? `?${query}` : ''}`;
+        },
+        get: (id) => `/api/profiles/staff-profiles/${id}`,
+        create: '/api/profiles/staff-profiles',
+        update: '/api/profiles/staff-profiles',
+        updatePassword: (id) => `/api/profiles/staff-profiles/${id}/password`,
+        signIn: '/api/profiles/staff-profiles/sign-in',
     },
-    cart: {
-        getByDirectUser: (id) => `/api/carts/direct-users/${id}`,
-        getByPartnerPharmacy: (id) => `/api/carts/partner-pharmacies/${id}`,
-        put: '/api/carts',
-        deleteByDirectUser: (id) => `/api/carts/direct-users/${id}`,
-        deleteByPartnerPharmacy: (id) => `/api/carts/partner-pharmacies/${id}`,
+    uploads: {
+        presign: '/api/uploads/presign',
+        delete: '/api/uploads',
     },
-    compoundDirect: {
-        searchCustomers: '/api/compound-direct/customers',
-        createCustomer: '/api/compound-direct/customer',
-        getDraftScripts: '/api/compound-direct/draft-scripts',
-        getDraftScriptById: (id) => `/api/compound-direct/draft-scripts/${id}`,
-        listFormulations: '/api/compound-direct/formulations',
-        getFormulationById: (id) => `/api/compound-direct/formulations/${id}`,
+    users: {
+        data: (userId) => `/api/users/data/${userId}`,
     },
 };

package/package.json

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