@crvouga/mockingbird-service-docker 1.6.0 → 1.7.0

package/dist/index.d.ts

@@ -184,6 +184,12 @@ declare class Collection<T> {
     }>;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase = number | string;
+
 /**
  * The slice of OpenAPI 3.1 (and JSON Schema 2020-12) Mockingbird understands.
  * Unknown keys (including `x-*` extensions) are preserved on every object.
@@ -444,6 +450,15 @@ type FaultRule = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -510,6 +525,8 @@ type FaultRule = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit = {
     id: string;
@@ -547,6 +564,11 @@ type FaultCandidate = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -1159,6 +1181,13 @@ type RuntimeOptions<T extends ServiceInstance> = {
     sqlite?: SqliteClient$1;
     /** Defaults to a live clock over `Date.now`. */
     clock?: Clock;
+    /**
+     * Where this boot's generated ids start. Counters restart at 0 on every boot, so by default
+     * every boot reissues the previous boot's ids; a different base gives an unrelated run of ids
+     * (a reset returns to the same run). A non-negative integer, or `"boot"` for one derived from
+     * the wall clock when the runtime is created. Default `0`: the same ids on every boot.
+     */
+    idBase?: IdBase;
     /** Seeds every random choice the runtime makes (fault rates, jitter). Default `0`. */
     seed?: number | string;
     /**
@@ -1242,6 +1271,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
     mount(prefix: string): MountedAPI;
     readonly sqlite: SqliteClient$1;
     readonly clock: Clock;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase): number;
     readonly faults: FaultRegistry;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry;

package/dist/index.js

@@ -5,7 +5,7 @@ import {
   document,
   operationIds,
   supportedOperationIds
-} from "./chunk-PEU54Q4H.js";
+} from "./chunk-7DDFNYJE.js";
 export {
   DOCKER_NAMESPACE,
   DockerAPI,

package/dist/server.d.ts

@@ -133,6 +133,12 @@ interface SqliteClient$2 {
     transaction<T>(fn: () => T): T;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase$1 = number | string;
+
 /**
  * The single source of time for a service.
  *
@@ -215,6 +221,15 @@ type FaultRule$1 = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue$1>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -281,6 +296,8 @@ type FaultRule$1 = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue$1 = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit$1 = {
     id: string;
@@ -305,6 +322,11 @@ type FaultCandidate$1 = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** 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 & {
     mount(prefix: string): MountedAPI$1;
     readonly sqlite: SqliteClient$2;
     readonly clock: Clock$1;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase$1): number;
     readonly faults: FaultRegistry$1;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry$1;
@@ -932,6 +960,12 @@ type CommonServeOptions = {
     /** Synthetic provider fixture objects supplied by a fleet entry. */
     fixtures?: Record<string, unknown>;
     baseUrl?: string;
+    /**
+     * Boot settings from `--settings`, `MOCKINGBIRD_SETTINGS` or a fleet entry's `settings`,
+     * already checked by the target's {@link ServeTarget.parseSettings}. Pass them to the
+     * service's own `settings` option so they become every namespace's defaults.
+     */
+    settings?: Record<string, unknown>;
 };
 /**
  * What a service contributes to `serve`: how to build its runtime from CLI flags,
@@ -944,6 +978,13 @@ type ServeTarget = {
     defaultPort: number;
     /** Serve flags beyond the common ones. */
     options?: Record<string, CliOption>;
+    /**
+     * Check the boot settings a caller supplied (`--settings`, `MOCKINGBIRD_SETTINGS`, a fleet
+     * entry's `settings`) against the service's settings schema, returning them normalized
+     * or throwing a message naming the bad field. A target without one takes no boot settings,
+     * and supplying some is refused before a port is bound.
+     */
+    parseSettings?(settings: Record<string, unknown>): Record<string, unknown>;
     create(values: CliValues, common: CommonServeOptions): Promise<ServiceRuntime$1<ServiceInstance$1>> | ServiceRuntime$1<ServiceInstance$1>;
     /** Startup lines after the listen address, e.g. the loaded corpus version. */
     banner?(runtime: ServiceRuntime$1<ServiceInstance$1>): string[];
@@ -1135,6 +1176,12 @@ declare class Collection<T> {
     }>;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase = number | string;
+
 /**
  * The slice of OpenAPI 3.1 (and JSON Schema 2020-12) Mockingbird understands.
  * Unknown keys (including `x-*` extensions) are preserved on every object.
@@ -1395,6 +1442,15 @@ type FaultRule = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -1461,6 +1517,8 @@ type FaultRule = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit = {
     id: string;
@@ -1498,6 +1556,11 @@ type FaultCandidate = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -2110,6 +2173,13 @@ type RuntimeOptions<T extends ServiceInstance> = {
     sqlite?: SqliteClient$1;
     /** Defaults to a live clock over `Date.now`. */
     clock?: Clock;
+    /**
+     * Where this boot's generated ids start. Counters restart at 0 on every boot, so by default
+     * every boot reissues the previous boot's ids; a different base gives an unrelated run of ids
+     * (a reset returns to the same run). A non-negative integer, or `"boot"` for one derived from
+     * the wall clock when the runtime is created. Default `0`: the same ids on every boot.
+     */
+    idBase?: IdBase;
     /** Seeds every random choice the runtime makes (fault rates, jitter). Default `0`. */
     seed?: number | string;
     /**
@@ -2193,6 +2263,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
     mount(prefix: string): MountedAPI;
     readonly sqlite: SqliteClient$1;
     readonly clock: Clock;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase): number;
     readonly faults: FaultRegistry;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry;

package/dist/server.js

@@ -2,8 +2,8 @@ import {
   DEFAULT_PORT,
   createServer,
   serveTarget
-} from "./chunk-DG4KWFV5.js";
-import "./chunk-PEU54Q4H.js";
+} from "./chunk-2VTSZWES.js";
+import "./chunk-7DDFNYJE.js";
 export {
   DEFAULT_PORT,
   createServer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-docker",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Stateful Docker Engine API v1.52 emulator with portable controls and Node transport.",
   "license": "MIT",
   "type": "module",