@natch-the-storage/heathershaw-platform-types 1.1.0 → 1.2.1

package/README.md

@@ -35,3 +35,17 @@ import type { ShippingType } from "@natch-the-storage/heathershaw-platform-types
 ## Notes
 
 - ESM only — requires a bundler (Vite, Next.js, webpack 5, etc.)
+
+## Publishing to npm
+
+1. Bump the version in `package.json`
+2. Build the output:
+   ```bash
+   npm run build
+   ```
+3. Publish:
+   ```bash
+   npm publish --access public
+   ```
+
+> You must be logged in (`npm login`) and have publish access to the `@natch-the-storage` scope.

package/build/validators.d.ts

@@ -84,39 +84,15 @@ export interface Sms {
     to: string;
     from: string;
 }
-export interface CreateDirectUserProfileBody {
-    userId: string;
-    patientRecordId?: number | null;
-    compoundDirectId?: string | null;
-    remindersEnabled?: boolean;
-    scriptSubmissions: ScriptSelect[] | null;
-}
-export interface UpdateDirectUserProfileBody {
+export interface DirectUserProfile {
     id: number;
     userId?: string;
-    patientRecordId?: number | null;
     compoundDirectId?: string | null;
     remindersEnabled?: boolean;
-    scriptSubmissions?: ScriptSelect[] | null;
-}
-export interface CreateOrderBody {
-    partnerPharmacyProfileId?: number | null;
-    patientRecordId?: number | null;
-    completed?: boolean;
-    paymentModeAtOrder: PaymentModeAtOrder;
-    paymentStatus: PaymentStatus;
-    scriptType: ScriptType;
-    paperScriptReceived?: boolean;
-    shippingType: ShippingType;
-    shippingFee: string;
-    lineItems?: unknown;
-    orderChangeNotes?: string | null;
-    counsellingRequired?: boolean;
-    confirmationSentAt?: Date | null;
-    hubspotContactId?: string | null;
-    createdByUserId?: string | null;
+    scriptSubmissions?: ScriptSelect[];
 }
-export interface UpdateOrderBody {
+export type DirectUserProfileCreate = Omit<DirectUserProfile, "id">;
+export interface Order {
     id: number;
     partnerPharmacyProfileId?: number | null;
     patientRecordId?: number | null;
@@ -134,16 +110,8 @@ export interface UpdateOrderBody {
     hubspotContactId?: string | null;
     createdByUserId?: string | null;
 }
-export interface CreatePaperScriptReminderBody {
-    orderId: number;
-    partnerPharmacyProfileId: number;
-    status: PaperScriptReminderStatus;
-    remindersSent: number;
-    reminderIntervalDays?: number;
-    escalationEmail: string;
-    receivedMarked: boolean;
-}
-export interface UpdatePaperScriptReminderBody {
+export type OrderCreate = Omit<Order, "id">;
+export interface PaperScriptReminder {
     id: number;
     orderId?: number;
     partnerPharmacyProfileId?: number;
@@ -151,104 +119,60 @@ export interface UpdatePaperScriptReminderBody {
     remindersSent?: number;
     reminderIntervalDays?: number;
     escalationEmail?: string;
-    receivedMarked?: boolean;
-}
-export interface CreatePartnerPharmacyProfileBody {
-    userId: string;
-    abn: string;
-    contactName: string;
-    invoiceEmail: string;
-    phone: string;
-    discountTier: string;
-    paymentMode: PaymentModeAtOrder;
-    remindersEnabled?: boolean;
-    priceMatches?: unknown;
-    dispatchAddress: Address | null;
-    orders?: unknown;
-    xeroContactId?: string | null;
+    received?: boolean;
+    lastSentAt?: string | null;
 }
-export interface UpdatePartnerPharmacyProfileBody {
+export type PaperScriptReminderCreate = Omit<PaperScriptReminder, "id">;
+export interface PartnerPharmacyProfile {
     id: number;
     userId?: string;
     abn?: string;
     contactName?: string;
     invoiceEmail?: string;
-    phone?: string;
     discountTier?: string;
     paymentMode?: PaymentModeAtOrder;
     remindersEnabled?: boolean;
     priceMatches?: unknown;
-    dispatchAddress?: Address | null;
+    dispatchAddress?: Address;
     orders?: unknown;
     xeroContactId?: string | null;
 }
+export type PartnerPharmacyProfileCreate = Omit<PartnerPharmacyProfile, "id">;
 export interface GetPatientRecordsQuery extends GetAll {
     partner_pharmacy_profile_id?: number;
 }
-export interface CreatePatientRecordBody {
-    partnerPharmacyProfileId?: number | null;
-    userId?: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string;
-    medicareNumber?: string | null;
-    phone: string;
-    address: Address | null;
-    healthInfo: HealthInfo | null;
-    reminderEnabled?: boolean;
-    scripts: ScriptSelect[] | null;
-    orderHistory: OrderSelect[] | null;
-}
-export interface UpdatePatientRecordBody {
+export interface PatientRecord {
     id: number;
     partnerPharmacyProfileId?: number | null;
+    directUserProfileId?: number | null;
     userId?: string | null;
     firstName?: string;
     lastName?: string;
     dateOfBirth?: string;
     medicareNumber?: string | null;
     phone?: string;
-    address?: Address | null;
-    healthInfo?: HealthInfo | null;
+    address?: Address;
+    healthInfo?: HealthInfo;
     reminderEnabled?: boolean;
-    scripts?: ScriptSelect[] | null;
-    orderHistory?: OrderSelect[] | null;
+    scripts?: ScriptSelect[];
+    orderHistory?: OrderSelect[];
 }
-export interface CreatePrescriberBody {
-    name: string;
-    email: string;
-    phone: string;
-}
-export interface UpdatePrescriberBody {
+export type PatientRecordCreate = Omit<PatientRecord, "id">;
+export interface Prescriber {
     id: number;
     name?: string;
     email?: string;
     phone?: string;
 }
-export interface CreatePriceMatchBody {
-    partnerPharmacyProfileId: number;
-    productId: number;
-    overridePrice: string;
-}
-export interface UpdatePriceMatchBody {
+export type PrescriberCreate = Omit<Prescriber, "id">;
+export interface PriceMatch {
     id: number;
     partnerPharmacyProfileId?: number;
     productId?: number;
     overridePrice?: string;
 }
-export interface CreateProductBody {
-    name: string;
-    imageKey?: string | null;
-    abbreviations?: string[] | null;
-    category: ProductCategory;
-    rrp: string;
-    hazardTags?: HazardTag[] | null;
-    compoundDirectId?: string | null;
-    requiresFridge?: boolean;
-    flavours?: string[] | null;
-    requiresS8Medicare?: boolean;
-}
-export interface UpdateProductBody {
+export type PriceMatchCreate = Omit<PriceMatch, "id">;
+export interface Product {
     id: number;
     name?: string;
     imageKey?: string | null;
@@ -261,16 +185,8 @@ export interface UpdateProductBody {
     flavours?: string[] | null;
     requiresS8Medicare?: boolean;
 }
-export interface CreateQuoteBody {
-    status?: QuoteStatus;
-    partnerPharmacyProfileId: number;
-    name: string;
-    strength: string;
-    form: string;
-    quantity: number;
-    patientContext: string;
-}
-export interface UpdateQuoteBody {
+export type ProductCreate = Omit<Product, "id">;
+export interface Quote {
     id: number;
     status?: QuoteStatus;
     partnerPharmacyProfileId?: number;
@@ -280,18 +196,8 @@ export interface UpdateQuoteBody {
     quantity?: number;
     patientContext?: string;
 }
-export interface CreateRepeatReminderBody {
-    orderId: number;
-    patientRecordId: number;
-    daysSupply: number;
-    dispatchedAt: Date;
-    reminderDueAt: Date;
-    reminderOffsetDays?: number;
-    pharmacyReminderSent?: boolean;
-    patientSmsSent?: boolean;
-    enabled?: boolean;
-}
-export interface UpdateRepeatReminderBody {
+export type QuoteCreate = Omit<Quote, "id">;
+export interface RepeatReminder {
     id: number;
     orderId?: number;
     patientRecordId?: number;
@@ -303,19 +209,8 @@ export interface UpdateRepeatReminderBody {
     patientSmsSent?: boolean;
     enabled?: boolean;
 }
-export interface CreateScriptBody {
-    prescriberId: number;
-    patientRecordId: number;
-    productId: number;
-    dateIssued: string;
-    processed?: boolean;
-    repeatsRemaining?: number;
-    daysSupply: number;
-    repeatStorage: RepeatStorage;
-    compoundDirectId?: string | null;
-    imageKey?: string | null;
-}
-export interface UpdateScriptBody {
+export type RepeatReminderCreate = Omit<RepeatReminder, "id">;
+export interface Script {
     id: number;
     prescriberId?: number;
     patientRecordId?: number;
@@ -328,3 +223,4 @@ export interface UpdateScriptBody {
     compoundDirectId?: string | null;
     imageKey?: string | null;
 }
+export type ScriptCreate = Omit<Script, "id">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natch-the-storage/heathershaw-platform-types",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Validation and interfaces to use on the client",
   "license": "ISC",
   "author": "Natch Surana",