@natch-the-storage/heathershaw-platform-types 1.3.2 → 1.3.3

package/README.md

@@ -10,26 +10,67 @@ npm install @natch-the-storage/heathershaw-platform-types
 
 ## Usage
 
-### TypeScript types
+### Interfaces
+
+Each domain object has a base interface (with `id`) and a `Create` variant (base minus `id`):
 
 ```ts
-import type { CreateOrderBody, Address, ScriptSelect } from "@natch-the-storage/heathershaw-platform-types";
+import type {
+  // Domain objects
+  DirectUserProfile, DirectUserProfileCreate,
+  Order, OrderCreate,
+  PaperScriptReminder, PaperScriptReminderCreate,
+  PartnerPharmacyProfile, PartnerPharmacyProfileCreate,
+  PatientRecord, PatientRecordCreate,
+  Prescriber, PrescriberCreate,
+  PriceMatch, PriceMatchCreate,
+  Product, ProductCreate,
+  Quote, QuoteCreate,
+  RepeatReminder, RepeatReminderCreate,
+  Script, ScriptCreate,
+
+  // Shared sub-types
+  Address, HealthInfo, PrescriberSelect, ScriptSelect, OrderSelect,
+
+  // Query / utility types
+  GetById, GetAll, GetPatientRecordsQuery, DevEmail, Sms,
+} from "@natch-the-storage/heathershaw-platform-types";
 ```
 
 ### Enum value arrays
 
-The raw value arrays are exported for use in UI components (e.g. populating a select):
+Raw arrays for populating selects and similar UI components:
 
 ```ts
-import { shippingTypeValues } from "@natch-the-storage/heathershaw-platform-types";
-// ["STANDARD", "COLD_CHAIN"]
+import {
+  paperScriptReminderStatusValues,
+  quoteStatusValues,
+  paymentModeAtOrderValues,
+  paymentStatusValues,
+  productCategoryValues,
+  repeatStorageValues,
+  scriptTypeValues,
+  shippingTypeValues,
+  hazardTagsValues,
+} from "@natch-the-storage/heathershaw-platform-types";
 ```
 
-Each array also has a matching union type:
+### Enum union types
+
+Each array has a matching union type:
 
 ```ts
-import type { ShippingType } from "@natch-the-storage/heathershaw-platform-types";
-// "STANDARD" | "COLD_CHAIN"
+import type {
+  PaperScriptReminderStatus,
+  QuoteStatus,
+  PaymentModeAtOrder,
+  PaymentStatus,
+  ProductCategory,
+  RepeatStorage,
+  ScriptType,
+  ShippingType,
+  HazardTag,
+} from "@natch-the-storage/heathershaw-platform-types";
 ```
 
 ## Notes
@@ -39,13 +80,9 @@ import type { ShippingType } from "@natch-the-storage/heathershaw-platform-types
 ## Publishing to npm
 
 1. Bump the version in `package.json`
-2. Build the output:
-   ```bash
-   npm run build
-   ```
-3. Publish:
+2. Build and publish:
    ```bash
-   npm publish --access public
+   npm run publish
    ```
 
 > You must be logged in (`npm login`) and have publish access to the `@natch-the-storage` scope.

package/package.json

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