@crvouga/mockingbird-service-wholescripts 3.5.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli.js CHANGED
@@ -3,8 +3,8 @@ import {
3
3
  runCli,
4
4
  serveCommand,
5
5
  serveTarget
6
- } from "./chunk-7DALIULQ.js";
7
- import "./chunk-T6P2TKQO.js";
6
+ } from "./chunk-R57VJDWN.js";
7
+ import "./chunk-4BLJLSNN.js";
8
8
 
9
9
  // src/cli.ts
10
10
  var code = await runCli(
package/dist/index.d.ts CHANGED
@@ -184,6 +184,12 @@ declare class Collection<T> {
184
184
  }>;
185
185
  }
186
186
 
187
+ /**
188
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
189
+ * which derives the base from the wall clock when the runtime is created.
190
+ */
191
+ type IdBase = number | string;
192
+
187
193
  /** Options every provider constructor accepts. */
188
194
  type APIOptions = {
189
195
  /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -279,6 +285,15 @@ type FaultRule = {
279
285
  requestHeaders?: Record<string, string>;
280
286
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
281
287
  query?: Record<string, string>;
288
+ /**
289
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
290
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
291
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
292
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
293
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
294
+ * response a rule injects.
295
+ */
296
+ requestBody?: Record<string, RequestBodyValue>;
282
297
  /**
283
298
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
284
299
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -345,6 +360,8 @@ type FaultRule = {
345
360
  /** The preset this rule was expanded from, if any. */
346
361
  fromPreset?: string;
347
362
  };
363
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
364
+ type RequestBodyValue = string | number | boolean | null;
348
365
  /** A fault that fired for one request. */
349
366
  type FaultHit = {
350
367
  id: string;
@@ -382,6 +399,11 @@ type FaultCandidate = {
382
399
  /** Request headers and query, for rules that match on them. */
383
400
  headers?: Headers;
384
401
  query?: URLSearchParams;
402
+ /**
403
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
404
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
405
+ */
406
+ readJson?: () => Promise<unknown>;
385
407
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
386
408
  now?: number;
387
409
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -904,6 +926,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
904
926
  mount(prefix: string): MountedAPI;
905
927
  readonly sqlite: SqliteClient$1;
906
928
  readonly clock: Clock;
929
+ /**
930
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
931
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
932
+ * one run.
933
+ */
934
+ setIdBase(base: IdBase): number;
907
935
  readonly faults: FaultRegistry;
908
936
  /** Baseline response time per namespace. */
909
937
  readonly latency: LatencyRegistry;
@@ -1070,6 +1098,18 @@ declare const MEDPAX_BOX_SKU = "000000000200095263";
1070
1098
  * scheduler's catalog sync reads. `Protein Powder` is out of stock (`instockonly` drops it).
1071
1099
  */
1072
1100
  declare const DEFAULT_CATALOG: Catalog;
1101
+ /**
1102
+ * Check a catalog document and fill the fields a row may leave out. The document is
1103
+ * `{products?, medPaxPills?, privateLabelCartons?}` (or a bare array of products); a row needs
1104
+ * its `sku` (and a product its `productName`), and every other string defaults to `""`,
1105
+ * every number to `0`, and `defaultDosing` to none. Throws a message naming the bad field.
1106
+ */
1107
+ declare const parseCatalogDocument: (input: unknown) => Partial<Catalog>;
1108
+ /**
1109
+ * Lay `extra` onto `base`: a row with a SKU `base` already has replaces it in place, any other
1110
+ * is appended, and a list `extra` leaves out is kept as it is.
1111
+ */
1112
+ declare const mergeCatalog: (base: Catalog, extra: Partial<Catalog>) => Catalog;
1073
1113
 
1074
1114
  type Tracking = {
1075
1115
  trackingNumber: string;
@@ -1390,5 +1430,5 @@ declare class WholescriptsAPI implements FetchAPI$1 {
1390
1430
  orders(): OrderRecord[];
1391
1431
  }
1392
1432
 
1393
- export { DEFAULT_CATALOG, MEDPAX_BOX_SKU, WHOLESCRIPTS_NAMESPACE, WHOLESCRIPTS_PRESETS, WholescriptsAPI, basicUsername, canonicalStatus, createRuntime, document, operationIds, supportedOperationIds };
1433
+ export { DEFAULT_CATALOG, MEDPAX_BOX_SKU, WHOLESCRIPTS_NAMESPACE, WHOLESCRIPTS_PRESETS, WholescriptsAPI, basicUsername, canonicalStatus, createRuntime, document, mergeCatalog, operationIds, parseCatalogDocument, supportedOperationIds };
1394
1434
  export type { AutoAdvance, Catalog, FetchAPI$1 as FetchAPI, MedPaxDetails, MedPaxPill, OperationId, OrderRecord, PrivateLabelCarton, Product, Settings, SqliteClient, SupportedOperationId, Tracking, TransitionInput, WholescriptsAPIOptions, WholescriptsRuntime, WholescriptsRuntimeOptions };
package/dist/index.js CHANGED
@@ -8,9 +8,11 @@ import {
8
8
  canonicalStatus,
9
9
  createRuntime,
10
10
  document,
11
+ mergeCatalog,
11
12
  operationIds,
13
+ parseCatalogDocument,
12
14
  supportedOperationIds
13
- } from "./chunk-T6P2TKQO.js";
15
+ } from "./chunk-4BLJLSNN.js";
14
16
  export {
15
17
  DEFAULT_CATALOG,
16
18
  MEDPAX_BOX_SKU,
@@ -21,7 +23,9 @@ export {
21
23
  canonicalStatus,
22
24
  createRuntime,
23
25
  document,
26
+ mergeCatalog,
24
27
  operationIds,
28
+ parseCatalogDocument,
25
29
  supportedOperationIds
26
30
  };
27
31
  //# sourceMappingURL=index.js.map
package/dist/server.d.ts CHANGED
@@ -133,6 +133,12 @@ interface SqliteClient$2 {
133
133
  transaction<T>(fn: () => T): T;
134
134
  }
135
135
 
136
+ /**
137
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
138
+ * which derives the base from the wall clock when the runtime is created.
139
+ */
140
+ type IdBase$1 = number | string;
141
+
136
142
  /**
137
143
  * The single source of time for a service.
138
144
  *
@@ -215,6 +221,15 @@ type FaultRule$1 = {
215
221
  requestHeaders?: Record<string, string>;
216
222
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
217
223
  query?: Record<string, string>;
224
+ /**
225
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
226
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
227
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
228
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
229
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
230
+ * response a rule injects.
231
+ */
232
+ requestBody?: Record<string, RequestBodyValue$1>;
218
233
  /**
219
234
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
220
235
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -281,6 +296,8 @@ type FaultRule$1 = {
281
296
  /** The preset this rule was expanded from, if any. */
282
297
  fromPreset?: string;
283
298
  };
299
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
300
+ type RequestBodyValue$1 = string | number | boolean | null;
284
301
  /** A fault that fired for one request. */
285
302
  type FaultHit$1 = {
286
303
  id: string;
@@ -305,6 +322,11 @@ type FaultCandidate$1 = {
305
322
  /** Request headers and query, for rules that match on them. */
306
323
  headers?: Headers;
307
324
  query?: URLSearchParams;
325
+ /**
326
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
327
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
328
+ */
329
+ readJson?: () => Promise<unknown>;
308
330
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
309
331
  now?: number;
310
332
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -827,6 +849,12 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
827
849
  mount(prefix: string): MountedAPI$1;
828
850
  readonly sqlite: SqliteClient$2;
829
851
  readonly clock: Clock$1;
852
+ /**
853
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
854
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
855
+ * one run.
856
+ */
857
+ setIdBase(base: IdBase$1): number;
830
858
  readonly faults: FaultRegistry$1;
831
859
  /** Baseline response time per namespace. */
832
860
  readonly latency: LatencyRegistry$1;
@@ -932,6 +960,12 @@ type CommonServeOptions = {
932
960
  /** Synthetic provider fixture objects supplied by a fleet entry. */
933
961
  fixtures?: Record<string, unknown>;
934
962
  baseUrl?: string;
963
+ /**
964
+ * Boot settings from `--settings`, `MOCKINGBIRD_SETTINGS` or a fleet entry's `settings`,
965
+ * already checked by the target's {@link ServeTarget.parseSettings}. Pass them to the
966
+ * service's own `settings` option so they become every namespace's defaults.
967
+ */
968
+ settings?: Record<string, unknown>;
935
969
  };
936
970
  /**
937
971
  * What a service contributes to `serve`: how to build its runtime from CLI flags,
@@ -944,6 +978,13 @@ type ServeTarget = {
944
978
  defaultPort: number;
945
979
  /** Serve flags beyond the common ones. */
946
980
  options?: Record<string, CliOption>;
981
+ /**
982
+ * Check the boot settings a caller supplied (`--settings`, `MOCKINGBIRD_SETTINGS`, a fleet
983
+ * entry's `settings`) against the service's settings schema, returning them normalized
984
+ * or throwing a message naming the bad field. A target without one takes no boot settings,
985
+ * and supplying some is refused before a port is bound.
986
+ */
987
+ parseSettings?(settings: Record<string, unknown>): Record<string, unknown>;
947
988
  create(values: CliValues, common: CommonServeOptions): Promise<ServiceRuntime$1<ServiceInstance$1>> | ServiceRuntime$1<ServiceInstance$1>;
948
989
  /** Startup lines after the listen address, e.g. the loaded corpus version. */
949
990
  banner?(runtime: ServiceRuntime$1<ServiceInstance$1>): string[];
@@ -951,6 +992,56 @@ type ServeTarget = {
951
992
  listening?(server: Listening): void;
952
993
  };
953
994
 
995
+ /** MedPax-specific pricing and stock, present on products that can go into a MedPax pack. */
996
+ type MedPaxDetails = {
997
+ name: string;
998
+ genericName: string;
999
+ quantity: number;
1000
+ wholesalePrice: number;
1001
+ retailPrice: number;
1002
+ };
1003
+ /** One `GET /api/Orders/ProductList` row, in the field names our consumers parse. */
1004
+ type Product = {
1005
+ productName: string;
1006
+ sku: string;
1007
+ medPaxSku: string;
1008
+ categories: string;
1009
+ retailPrice: number;
1010
+ upc: string;
1011
+ descriptionShort: string;
1012
+ descriptionFull?: string;
1013
+ brand: string;
1014
+ productImage: string;
1015
+ quantity: number;
1016
+ countUnit: string;
1017
+ wholesalePrice: number;
1018
+ supplementFactsHTML: string;
1019
+ defaultDosing: {
1020
+ time: string;
1021
+ qty: number;
1022
+ }[];
1023
+ medPaxDetails?: MedPaxDetails | null;
1024
+ };
1025
+ /** One `medPaxPills` row of `GET /api/Orders/PrivateLabelProductList`. */
1026
+ type MedPaxPill = {
1027
+ sku: string;
1028
+ genericName: string;
1029
+ privateLabelName: string;
1030
+ quantity: number;
1031
+ };
1032
+ /** One `privateLabelCartons` row of `GET /api/Orders/PrivateLabelProductList`. */
1033
+ type PrivateLabelCarton = {
1034
+ sku: string;
1035
+ name: string;
1036
+ cartonImage: string;
1037
+ quantity: number;
1038
+ };
1039
+ type Catalog = {
1040
+ products: Product[];
1041
+ medPaxPills: MedPaxPill[];
1042
+ privateLabelCartons: PrivateLabelCarton[];
1043
+ };
1044
+
954
1045
  type MountedAPI = FetchAPI$1 & {
955
1046
  readonly prefix: string;
956
1047
  GET: FetchHandler;
@@ -1125,6 +1216,12 @@ declare class Collection<T> {
1125
1216
  }>;
1126
1217
  }
1127
1218
 
1219
+ /**
1220
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
1221
+ * which derives the base from the wall clock when the runtime is created.
1222
+ */
1223
+ type IdBase = number | string;
1224
+
1128
1225
  /** Options every provider constructor accepts. */
1129
1226
  type APIOptions = {
1130
1227
  /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -1220,6 +1317,15 @@ type FaultRule = {
1220
1317
  requestHeaders?: Record<string, string>;
1221
1318
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
1222
1319
  query?: Record<string, string>;
1320
+ /**
1321
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
1322
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
1323
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
1324
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
1325
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
1326
+ * response a rule injects.
1327
+ */
1328
+ requestBody?: Record<string, RequestBodyValue>;
1223
1329
  /**
1224
1330
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
1225
1331
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -1286,6 +1392,8 @@ type FaultRule = {
1286
1392
  /** The preset this rule was expanded from, if any. */
1287
1393
  fromPreset?: string;
1288
1394
  };
1395
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
1396
+ type RequestBodyValue = string | number | boolean | null;
1289
1397
  /** A fault that fired for one request. */
1290
1398
  type FaultHit = {
1291
1399
  id: string;
@@ -1310,6 +1418,11 @@ type FaultCandidate = {
1310
1418
  /** Request headers and query, for rules that match on them. */
1311
1419
  headers?: Headers;
1312
1420
  query?: URLSearchParams;
1421
+ /**
1422
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
1423
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
1424
+ */
1425
+ readJson?: () => Promise<unknown>;
1313
1426
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
1314
1427
  now?: number;
1315
1428
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -1832,6 +1945,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
1832
1945
  mount(prefix: string): MountedAPI;
1833
1946
  readonly sqlite: SqliteClient$1;
1834
1947
  readonly clock: Clock;
1948
+ /**
1949
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
1950
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
1951
+ * one run.
1952
+ */
1953
+ setIdBase(base: IdBase): number;
1835
1954
  readonly faults: FaultRegistry;
1836
1955
  /** Baseline response time per namespace. */
1837
1956
  readonly latency: LatencyRegistry;
@@ -1939,56 +2058,6 @@ interface SqliteClient {
1939
2058
  transaction<T>(fn: () => T): T;
1940
2059
  }
1941
2060
 
1942
- /** MedPax-specific pricing and stock, present on products that can go into a MedPax pack. */
1943
- type MedPaxDetails = {
1944
- name: string;
1945
- genericName: string;
1946
- quantity: number;
1947
- wholesalePrice: number;
1948
- retailPrice: number;
1949
- };
1950
- /** One `GET /api/Orders/ProductList` row, in the field names our consumers parse. */
1951
- type Product = {
1952
- productName: string;
1953
- sku: string;
1954
- medPaxSku: string;
1955
- categories: string;
1956
- retailPrice: number;
1957
- upc: string;
1958
- descriptionShort: string;
1959
- descriptionFull?: string;
1960
- brand: string;
1961
- productImage: string;
1962
- quantity: number;
1963
- countUnit: string;
1964
- wholesalePrice: number;
1965
- supplementFactsHTML: string;
1966
- defaultDosing: {
1967
- time: string;
1968
- qty: number;
1969
- }[];
1970
- medPaxDetails?: MedPaxDetails | null;
1971
- };
1972
- /** One `medPaxPills` row of `GET /api/Orders/PrivateLabelProductList`. */
1973
- type MedPaxPill = {
1974
- sku: string;
1975
- genericName: string;
1976
- privateLabelName: string;
1977
- quantity: number;
1978
- };
1979
- /** One `privateLabelCartons` row of `GET /api/Orders/PrivateLabelProductList`. */
1980
- type PrivateLabelCarton = {
1981
- sku: string;
1982
- name: string;
1983
- cartonImage: string;
1984
- quantity: number;
1985
- };
1986
- type Catalog = {
1987
- products: Product[];
1988
- medPaxPills: MedPaxPill[];
1989
- privateLabelCartons: PrivateLabelCarton[];
1990
- };
1991
-
1992
2061
  /**
1993
2062
  * Anything that can answer a Fetch `Request` with a `Response`.
1994
2063
  *
@@ -2144,8 +2213,15 @@ type WholescriptsServer = Listening & {
2144
2213
  };
2145
2214
  /** Serve the Wholescripts mock over `node:http`, with auto-advance ticking every 100 ms. */
2146
2215
  declare const createServer: (options?: WholescriptsServerOptions) => Promise<WholescriptsServer>;
2216
+ /**
2217
+ * Read a catalog file (`{products?, medPaxPills?, privateLabelCartons?}`, or a bare array of
2218
+ * products) and lay it onto {@link DEFAULT_CATALOG} (`merge`, the default: a SKU the default has
2219
+ * is replaced in place, any other is added) or use it as the whole catalog (`replace`: a list the
2220
+ * file leaves out is empty).
2221
+ */
2222
+ declare const loadCatalogFile: (path: string, mode?: "merge" | "replace") => Catalog;
2147
2223
  /** How `serve` (and `serve --config`) builds the Wholescripts mock from flags. */
2148
2224
  declare const serveTarget: ServeTarget;
2149
2225
 
2150
- export { DEFAULT_PORT, createServer, serveTarget };
2226
+ export { DEFAULT_PORT, createServer, loadCatalogFile, serveTarget };
2151
2227
  export type { WholescriptsServer, WholescriptsServerOptions };
package/dist/server.js CHANGED
@@ -1,12 +1,14 @@
1
1
  import {
2
2
  DEFAULT_PORT,
3
3
  createServer,
4
+ loadCatalogFile,
4
5
  serveTarget
5
- } from "./chunk-7DALIULQ.js";
6
- import "./chunk-T6P2TKQO.js";
6
+ } from "./chunk-R57VJDWN.js";
7
+ import "./chunk-4BLJLSNN.js";
7
8
  export {
8
9
  DEFAULT_PORT,
9
10
  createServer,
11
+ loadCatalogFile,
10
12
  serveTarget
11
13
  };
12
14
  //# sourceMappingURL=server.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crvouga/mockingbird-service-wholescripts",
3
- "version": "3.5.0",
3
+ "version": "3.7.0",
4
4
  "description": "Stateful emulator of the Wholescripts supplement fulfilment API: product and private-label catalogs, order submit, status polling and cancel, with admin status transitions.",
5
5
  "license": "MIT",
6
6
  "type": "module",