@crvouga/mockingbird-service-aws-speech 3.2.0 → 3.4.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/server.d.ts CHANGED
@@ -145,7 +145,7 @@ type ClockState$1 = {
145
145
  now: number;
146
146
  /** True while time does not advance on its own. */
147
147
  frozen: boolean;
148
- /** Milliseconds this clock adds to its underlying source. */
148
+ /** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
149
149
  offsetMs: number;
150
150
  };
151
151
  type Clock$1 = {
@@ -181,7 +181,10 @@ type Rng$1 = {
181
181
  state(): number;
182
182
  /** Restore a state previously returned by {@link state}. */
183
183
  setState(state: number): void;
184
- seed: number;
184
+ /** Restart the stream from a new seed. `reset` then returns to this seed. */
185
+ reseed(seed: number | string): void;
186
+ /** The seed the stream currently starts from. */
187
+ readonly seed: number;
185
188
  };
186
189
 
187
190
  /**
@@ -190,44 +193,83 @@ type Rng$1 = {
190
193
  * This is how a suite reaches the vendor's failure modes without the vendor: the
191
194
  * quota error that only appears when a shared sandbox is full, the 429 that only
192
195
  * appears under load, the 5xx that proves a retry path works.
196
+ *
197
+ * A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
198
+ * it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
199
+ * and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
193
200
  */
194
201
  type FaultRule$1 = {
195
- /** Stable id, so a suite can retire exactly the rule it added. */
202
+ /** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
196
203
  id: string;
197
204
  /** Fault only this operation. Omit to match every operation. */
198
205
  operationId?: string;
199
206
  /** Fault only this HTTP method, case-insensitive. Omit to match every method. */
200
207
  method?: string;
208
+ /** Fault only this exact path. */
209
+ path?: string;
201
210
  /** Fault only paths starting with this prefix. Omit to match every path. */
202
211
  pathPrefix?: string;
212
+ /** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
213
+ pathPattern?: string;
214
+ /** Fault only requests carrying these headers. `"*"` matches any value. */
215
+ requestHeaders?: Record<string, string>;
216
+ /** Fault only requests carrying these query parameters. `"*"` matches any value. */
217
+ query?: Record<string, string>;
203
218
  /**
204
219
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
205
220
  * an in-process caller usually wants, and what a parallel worker usually does not:
206
221
  * rules added through `POST /__admin/faults` default to the calling namespace.
207
222
  */
208
223
  namespace?: string;
224
+ /** Let this many matching requests through first. */
225
+ after?: number;
226
+ /** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
227
+ every?: number;
228
+ /** Retire the rule after this many faults. Omit to keep it until removed. */
229
+ count?: number;
230
+ /** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
231
+ rate?: number;
232
+ /**
233
+ * Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
234
+ * clock when the rule was added. Listed as epoch ms.
235
+ */
236
+ from?: Instant$1 | Duration$1;
237
+ /** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
238
+ until?: Instant$1 | Duration$1;
209
239
  /**
210
- * Status of the injected response. Omit for a rule that only delays (`delayMs` /
211
- * `latencyMs`), only drops the connection (`drop`), or only switches on an `effect`:
212
- * the request then still reaches the service.
240
+ * Status of the injected response. Omit for a rule that only delays, times out, drops,
241
+ * truncates, or switches on an `effect`: the request then still reaches the service.
213
242
  */
214
243
  status?: number;
215
244
  /** Response body, serialized as JSON. A string is sent as-is. */
216
245
  body?: unknown;
246
+ /** Response headers. */
217
247
  headers?: Record<string, string>;
218
- /** Retire the rule after this many faults. Omit to keep it until removed. */
219
- count?: number;
220
- /** Fault this fraction of matching requests, `0`–`1`. Default `1`. */
221
- rate?: number;
222
- /** Hold the response back this long, to exercise timeouts. */
248
+ /** Hold the response back this long. Listed as `delayMs`. */
249
+ delay?: Duration$1;
250
+ /** `delay`, in milliseconds. */
223
251
  delayMs?: number;
224
252
  /** Alias of `delayMs`. */
225
253
  latencyMs?: number;
254
+ /** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
255
+ jitter?: Duration$1;
256
+ jitterMs?: number;
257
+ /**
258
+ * Never answer: hold the request this long, then drop the connection. Listed as
259
+ * `timeoutMs`. With virtual time the wait is spent on the mock clock.
260
+ */
261
+ timeout?: Duration$1;
262
+ timeoutMs?: number;
226
263
  /**
227
264
  * Drop the connection instead of answering: an in-process `fetch` rejects with a
228
265
  * `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
229
266
  */
230
267
  drop?: boolean;
268
+ /**
269
+ * Cut the response body off after this many bytes: the status and headers arrive, then
270
+ * the connection dies mid-body.
271
+ */
272
+ truncate?: number;
231
273
  /**
232
274
  * A named service behaviour to switch on for the matching request instead of (or
233
275
  * before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
@@ -236,8 +278,8 @@ type FaultRule$1 = {
236
278
  effect?: string;
237
279
  /** Parameters for `effect`. */
238
280
  params?: Record<string, unknown>;
239
- /** From the preset this rule was expanded from, if any. */
240
- preset?: string;
281
+ /** The preset this rule was expanded from, if any. */
282
+ fromPreset?: string;
241
283
  };
242
284
  /** A fault that fired for one request. */
243
285
  type FaultHit$1 = {
@@ -245,6 +287,10 @@ type FaultHit$1 = {
245
287
  /** The injected response; absent when the rule only delays, drops, or sets an effect. */
246
288
  response?: Response;
247
289
  drop?: boolean;
290
+ /** Set with `drop` when the rule held the request for its `timeout` first. */
291
+ timeout?: boolean;
292
+ /** Bytes of response body to let through before the connection dies. */
293
+ truncate?: number;
248
294
  effect?: {
249
295
  name: string;
250
296
  params: Record<string, unknown>;
@@ -256,38 +302,202 @@ type FaultCandidate$1 = {
256
302
  method: string;
257
303
  path: string;
258
304
  namespace: string;
305
+ /** Request headers and query, for rules that match on them. */
306
+ headers?: Headers;
307
+ query?: URLSearchParams;
308
+ /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
309
+ now?: number;
310
+ /** How to spend a delay for this request. Default: the registry's own sleep. */
311
+ wait?: (ms: number) => Promise<void>;
312
+ };
313
+ /** A stored rule and how often it was consulted. */
314
+ type FaultListing$1 = FaultRule$1 & {
315
+ /** Faults left before the rule retires. `null` when it has no `count`. */
316
+ remaining: number | null;
317
+ /** Times the rule faulted a request. */
318
+ hits: number;
319
+ /** Requests that matched the rule, faulted or not. */
320
+ seen: number;
321
+ };
322
+ /** A namespace's own rules, with their counters, in the order they are tried. */
323
+ type FaultSnapshot$1 = {
324
+ /**
325
+ * `position` is how many `"*"` rules are tried before the rule, which is what its place
326
+ * in the order means to a request and holds in any process.
327
+ */
328
+ rules: (FaultListing$1 & {
329
+ position?: number;
330
+ })[];
331
+ /** How many `fault_<n>` ids the namespace has handed out. */
332
+ nextId?: number;
259
333
  };
260
334
  type FaultRegistry$1 = {
261
- isolateNamespaces(): void;
262
- snapshot(namespace: string): {
263
- rules: (FaultRule$1 & {
264
- remaining: number | null;
265
- hits: number;
266
- position: number;
267
- })[];
268
- rngState: number;
269
- };
335
+ snapshot(namespace: string): FaultSnapshot$1;
336
+ /** Add a rule, or replace the rule with the same id in the same namespace. */
270
337
  add(rule: FaultRule$1): FaultRule$1;
271
- list(): (FaultRule$1 & {
272
- remaining: number | null;
273
- hits: number;
274
- })[];
275
- remove(id: string): boolean;
276
- clear(): void;
277
- restore(namespace: string, state: {
278
- rules: (FaultRule$1 & {
279
- remaining: number | null;
280
- hits: number;
281
- position: number;
282
- })[];
283
- rngState: number;
284
- }): void;
338
+ /** The next unused `fault_<n>` id in `namespace`. */
339
+ nextId(namespace: string): string;
340
+ /** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
341
+ list(namespace?: string): FaultListing$1[];
342
+ get(id: string, namespace?: string): FaultListing$1 | undefined;
343
+ /** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
344
+ remove(id: string, namespace?: string): boolean;
345
+ /** Remove every rule, or one namespace's own rules. */
346
+ clear(namespace?: string): void;
347
+ /** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
348
+ restore(namespace: string, state: FaultSnapshot$1): void;
285
349
  /**
286
350
  * Every fault this request should get, in rule order, stopping at the first that answers
287
351
  * or drops (effect-only and delay-only rules let later rules match too). Consumes one of
288
352
  * each matching rule's remaining uses.
289
353
  */
290
354
  take(candidate: FaultCandidate$1): Promise<FaultHit$1[]>;
355
+ /**
356
+ * Fire these rules at one request without storing them: no matching, no schedule, in order,
357
+ * stopping at the first that answers or drops. Jitter draws from the namespace's stream.
358
+ */
359
+ fire(rules: readonly FaultRule$1[], candidate: FaultCandidate$1): Promise<FaultHit$1[]>;
360
+ };
361
+
362
+ /**
363
+ * The admin controls every mock shares, as one document.
364
+ *
365
+ * The same shape is accepted in three places, and means the same thing in each:
366
+ *
367
+ * - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
368
+ * `MOCKINGBIRD_ADMIN_CONTROLS`
369
+ * - over HTTP: `PUT /__admin/controls`
370
+ * - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
371
+ *
372
+ * Every control is deterministic: given the same seed, clock and requests, a mock answers
373
+ * the same bytes. Nothing here reads the wall clock or `Math.random`.
374
+ */
375
+ /** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
376
+ type Duration$1 = number | string;
377
+ /** Epoch milliseconds, or an ISO-8601 string. */
378
+ type Instant$1 = number | string;
379
+ type ClockControls$1 = {
380
+ /** Move the clock to this instant. */
381
+ now?: Instant$1;
382
+ /** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
383
+ frozen?: boolean;
384
+ /**
385
+ * Step the clock forward by this much before every vendor request. With a frozen clock
386
+ * each request still gets its own, reproducible timestamp.
387
+ */
388
+ autoAdvance?: Duration$1;
389
+ };
390
+ /** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
391
+ type LatencyRuleInput$1 = {
392
+ delay?: Duration$1;
393
+ jitter?: Duration$1;
394
+ };
395
+ type LatencyControls$1 = LatencyRuleInput$1 & {
396
+ /** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
397
+ operations?: Record<string, Duration$1 | LatencyRuleInput$1>;
398
+ };
399
+ /** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
400
+ type FaultInput$1 = (Omit<FaultRule$1, "id"> & {
401
+ id?: string;
402
+ }) | ({
403
+ preset: string;
404
+ } & Partial<FaultRule$1>);
405
+ /** Identifies a {@link SnapshotDocument}. */
406
+ declare const SNAPSHOT_FORMAT$1 = "mockingbird.snapshot/v1";
407
+ /**
408
+ * A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
409
+ * `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
410
+ * `records` are required, so a hand-written seed file is a valid snapshot.
411
+ */
412
+ type SnapshotDocument$1 = {
413
+ format: typeof SNAPSHOT_FORMAT$1;
414
+ /** The service that wrote it. A snapshot is rejected by any other service. */
415
+ service?: string;
416
+ /**
417
+ * Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
418
+ * the stored text of a row that is not a plain record, and replaces `value` when present.
419
+ */
420
+ records: {
421
+ collection: string;
422
+ id: string;
423
+ seq?: number;
424
+ value?: unknown;
425
+ raw?: string;
426
+ }[];
427
+ /** Id counters, so the next generated id continues where the snapshot left off. */
428
+ sequences?: {
429
+ name: string;
430
+ kind: string;
431
+ value: number;
432
+ }[];
433
+ clock?: {
434
+ now: number;
435
+ frozen: boolean;
436
+ autoAdvanceMs?: number;
437
+ };
438
+ seed?: number | string;
439
+ /** Positions of the seeded random streams. */
440
+ rng?: {
441
+ state: number;
442
+ faults?: number;
443
+ latency?: number;
444
+ };
445
+ faults?: unknown;
446
+ latency?: unknown;
447
+ virtualTime?: boolean;
448
+ /** Quiescent webhook endpoints, delivery history and fault state. Contains private configuration. */
449
+ webhooks?: unknown;
450
+ };
451
+ /** Controls for one namespace. */
452
+ type NamespaceControls$1 = {
453
+ /** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
454
+ seed?: number | string;
455
+ clock?: ClockControls$1;
456
+ /**
457
+ * Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
458
+ * wall clock: the request returns at once, the clock has moved, and the journal records
459
+ * the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
460
+ */
461
+ virtualTime?: boolean;
462
+ /** Baseline response time for every vendor request. A bare duration is its `delay`. */
463
+ latency?: Duration$1 | LatencyControls$1;
464
+ faults?: readonly FaultInput$1[];
465
+ /** Start from this state instead of the service's own seed data. */
466
+ snapshot?: SnapshotDocument$1;
467
+ };
468
+ /** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
469
+ type MockControls$1 = NamespaceControls$1 & {
470
+ /** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
471
+ credentials?: Record<string, string>;
472
+ /** Overrides for named namespaces. A key given here replaces the shared value. */
473
+ namespaces?: Record<string, NamespaceControls$1>;
474
+ };
475
+ /** A latency rule in milliseconds. */
476
+ type LatencyRule$1 = {
477
+ delayMs: number;
478
+ jitterMs: number;
479
+ };
480
+ /** Baseline latency for a namespace, normalized. */
481
+ type LatencyState$1 = LatencyRule$1 & {
482
+ operations: Record<string, LatencyRule$1>;
483
+ };
484
+ /** What {@link controlHeaders} turns into request headers. */
485
+ type ControlHeaderInput$1 = {
486
+ namespace?: string;
487
+ adminKey?: string;
488
+ branch?: string;
489
+ at?: string;
490
+ reset?: boolean;
491
+ restore?: string;
492
+ seed?: number | string;
493
+ time?: Instant$1 | Date;
494
+ advance?: Duration$1;
495
+ virtualTime?: boolean;
496
+ delay?: Duration$1;
497
+ timeout?: Duration$1;
498
+ /** A status, `"drop"`, a preset name, or a fault rule. */
499
+ fault?: number | string | Record<string, unknown>;
500
+ snapshot?: string;
291
501
  };
292
502
 
293
503
  /**
@@ -327,6 +537,8 @@ type RequestLog$1 = {
327
537
  unmatched: boolean;
328
538
  /** Set when a fault rule produced the response. */
329
539
  faultId?: string;
540
+ /** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
541
+ delayMs?: number;
330
542
  /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
331
543
  ids?: Record<string, string>;
332
544
  /** Set when the service created a resource the request referred to but that did not exist. */
@@ -372,6 +584,12 @@ type JournalQuery$1 = {
372
584
  /** Only this namespace. Omit for every namespace, oldest first across all of them. */
373
585
  namespace?: string;
374
586
  operationId?: string;
587
+ /** Only this HTTP method, case-insensitive. */
588
+ method?: string;
589
+ /** Only this exact path. */
590
+ path?: string;
591
+ /** Only requests this fault rule answered or shaped. */
592
+ faultId?: string;
375
593
  status?: number;
376
594
  /** Only entries at or after this instant (epoch ms). */
377
595
  since?: number;
@@ -386,6 +604,50 @@ type Journal$1 = {
386
604
  clear(namespace?: string): void;
387
605
  };
388
606
 
607
+ /**
608
+ * Baseline response time, per namespace: how long every vendor request takes before any
609
+ * fault is considered. Jitter draws from a stream the caller owns, one per namespace and
610
+ * separate from the fault stream, so adding latency never shifts which requests a `rate`
611
+ * fault hits.
612
+ */
613
+ type LatencyRegistry$1 = {
614
+ get(namespace: string): LatencyState$1;
615
+ set(namespace: string, state: LatencyState$1): LatencyState$1;
616
+ /** Remove one namespace's latency, or every namespace's. */
617
+ clear(namespace?: string): void;
618
+ /** Milliseconds this request waits. Draws jitter, so call it once per request. */
619
+ take(namespace: string, operationId: string | undefined): number;
620
+ };
621
+
622
+ /** Clock state as the admin API reports it. */
623
+ type ControlClock$1 = ClockState$1 & {
624
+ /** `now`, as ISO-8601. */
625
+ iso: string;
626
+ /** Milliseconds the clock steps before every vendor request. */
627
+ autoAdvanceMs: number;
628
+ };
629
+ /** One namespace's controls: the body of `GET /__admin/controls`. */
630
+ type ControlState$1 = {
631
+ namespace: string;
632
+ seed: number | string;
633
+ clock: ControlClock$1;
634
+ virtualTime: boolean;
635
+ latency: LatencyState$1;
636
+ faults: FaultListing$1[];
637
+ };
638
+
639
+ /** What `GET /__admin/snapshots` lists for each snapshot. */
640
+ type SnapshotInfo$1 = {
641
+ id: string;
642
+ namespace: string;
643
+ /** Stored rows in the snapshot. */
644
+ records: number;
645
+ /** The namespace clock when it was taken, epoch ms. */
646
+ at: number;
647
+ /** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
648
+ portable: boolean;
649
+ };
650
+
389
651
  /** Credential → namespace mapping behind `PUT /__admin/credentials`. */
390
652
  type CredentialRegistry$1 = {
391
653
  set(credential: string, namespace: string): void;
@@ -398,6 +660,8 @@ type CredentialRegistry$1 = {
398
660
  }[];
399
661
  };
400
662
 
663
+ type OwnedTransport$1 = (request: Request, namespace: string, send: typeof fetch) => Promise<Response>;
664
+
401
665
  /**
402
666
  * A point-in-time copy of everything a service namespace holds.
403
667
  *
@@ -515,8 +779,16 @@ type PublishInput$1 = {
515
779
  id?: string;
516
780
  };
517
781
  type WebhookHub$1 = {
782
+ observeDeliveries(listener: (event: {
783
+ namespace: string;
784
+ state: string;
785
+ deliveryId: string;
786
+ }) => void): () => void;
787
+ setTransportPolicy(policy: OwnedTransport$1): void;
518
788
  pending(namespace: string): number;
519
789
  snapshot(namespace: string): unknown;
790
+ exportSnapshot(handle: unknown): unknown;
791
+ importSnapshot(namespace: string, document: unknown): unknown;
520
792
  restore(namespace: string, snapshot: unknown): void;
521
793
  publish(input: PublishInput$1): WebhookMessage$1;
522
794
  /** Replace a namespace's own endpoints (`PUT /__admin/webhook-endpoints`). */
@@ -529,7 +801,7 @@ type WebhookHub$1 = {
529
801
  /** Run every pending retry (and release held reordered messages) now, and every retry those attempts schedule, until nothing is pending. */
530
802
  flush(): Promise<void>;
531
803
  /** Resolve once nothing is in flight. */
532
- idle(): Promise<void>;
804
+ idle(namespace?: string): Promise<void>;
533
805
  fault(namespace: string, fault: WebhookFault$1): void;
534
806
  clear(namespace?: string): void;
535
807
  };
@@ -540,7 +812,10 @@ type ServiceInstance$1 = FetchAPI$2 & {
540
812
  };
541
813
  type ServiceTimelineState$1 = Readonly<{
542
814
  snapshot: NamespaceSnapshot$1;
543
- clock: Readonly<ReturnType<Clock$1["state"]>>;
815
+ /** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
816
+ clock: Readonly<ClockState$1 & {
817
+ pinned?: boolean;
818
+ }>;
544
819
  rngState: number;
545
820
  }>;
546
821
  type ServiceCheckpoint$1 = Checkpoint$1<ServiceTimelineState$1>;
@@ -553,27 +828,63 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
553
828
  readonly sqlite: SqliteClient$2;
554
829
  readonly clock: Clock$1;
555
830
  readonly faults: FaultRegistry$1;
831
+ /** Baseline response time per namespace. */
832
+ readonly latency: LatencyRegistry$1;
556
833
  readonly metrics: Metrics$1;
557
834
  readonly journal: Journal$1;
558
835
  readonly rng: Rng$1;
559
836
  readonly credentials: CredentialRegistry$1;
560
837
  /** The webhook hub, when the service has outbound webhooks. */
561
838
  readonly webhooks: WebhookHub$1 | undefined;
562
- /** Enable independent namespace clocks and PRNGs before serving a fleet. */
563
- isolateNamespaces(): void;
839
+ /**
840
+ * A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
841
+ * offset and a freeze of its own, so moving one never moves another.
842
+ */
564
843
  namespaceClock(namespace?: string): Clock$1;
565
844
  namespaceOf(request: Request): string;
566
845
  /** Opaque in-process checkpoint including records, controls and webhook history. */
567
846
  fleetSnapshot(namespace: string): object;
568
847
  fleetRestore(snapshot: unknown, namespace: string): void;
848
+ fleetExport(snapshot: unknown): SnapshotDocument$1;
849
+ fleetImport(namespace: string, document: unknown): object;
569
850
  /** Expand a named preset into fault rules (and webhook faults) for `namespace`. */
570
851
  applyPreset(name: string, namespace?: string, overrides?: Partial<FaultRule$1>): FaultRule$1[];
571
852
  /** The instance behind `namespace` (the default one when omitted), created on first use. */
572
853
  instance(namespace?: string): T;
573
854
  /** Public names of every namespace created so far. */
574
855
  namespaces(): string[];
575
- /** Reset one namespace, or every namespace with `"*"`. */
856
+ /** Return one namespace to its boot state, or every namespace with `"*"`. */
576
857
  reset(namespace?: string): Promise<void>;
858
+ /** Reset a namespace and forget it, releasing everything it held. */
859
+ dropNamespace(namespace: string): Promise<void>;
860
+ /** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
861
+ controls(namespace?: string): ControlState$1 & {
862
+ snapshots: SnapshotInfo$1[];
863
+ };
864
+ /** Apply a control document to a namespace. A given key replaces that control. */
865
+ configure(controls: NamespaceControls$1, namespace?: string): ControlState$1 & {
866
+ snapshots: SnapshotInfo$1[];
867
+ };
868
+ /** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
869
+ readonly snapshots: {
870
+ /** Capture the namespace now. Reusing a name replaces that snapshot. */
871
+ create(options?: {
872
+ name?: string;
873
+ namespace?: string;
874
+ }): SnapshotInfo$1;
875
+ list(namespace?: string): SnapshotInfo$1[];
876
+ /** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
877
+ export(id: string, namespace?: string): SnapshotDocument$1;
878
+ /** Store a document as a snapshot without restoring it. */
879
+ import(document: SnapshotDocument$1, options?: {
880
+ name?: string;
881
+ namespace?: string;
882
+ }): SnapshotInfo$1;
883
+ restore(id: string, namespace?: string): void;
884
+ delete(id: string, namespace?: string): boolean;
885
+ };
886
+ /** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
887
+ headers(input: ControlHeaderInput$1): Record<string, string>;
577
888
  snapshot(namespace?: string): NamespaceSnapshot$1;
578
889
  restore(snapshot: NamespaceSnapshot$1, namespace?: string): void;
579
890
  /** Capture the current branch. Mutating HTTP calls do this automatically. */
@@ -616,6 +927,8 @@ type CommonServeOptions = {
616
927
  adminKey: string | undefined;
617
928
  seed: string | undefined;
618
929
  onLog: ((entry: RequestLog$1) => void) | undefined;
930
+ /** Admin controls to boot with: clock, latency, faults, a starting snapshot. */
931
+ adminControls?: MockControls$1;
619
932
  /** Synthetic provider fixture objects supplied by a fleet entry. */
620
933
  fixtures?: Record<string, unknown>;
621
934
  baseUrl?: string;
@@ -626,6 +939,7 @@ type CommonServeOptions = {
626
939
  * `serveTarget`, which is also how `serve --config` finds services by name.
627
940
  */
628
941
  type ServeTarget = {
942
+ packageVersion?: string;
629
943
  name: string;
630
944
  defaultPort: number;
631
945
  /** Serve flags beyond the common ones. */
@@ -865,7 +1179,7 @@ type ClockState = {
865
1179
  now: number;
866
1180
  /** True while time does not advance on its own. */
867
1181
  frozen: boolean;
868
- /** Milliseconds this clock adds to its underlying source. */
1182
+ /** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
869
1183
  offsetMs: number;
870
1184
  };
871
1185
  type Clock = {
@@ -901,7 +1215,10 @@ type Rng = {
901
1215
  state(): number;
902
1216
  /** Restore a state previously returned by {@link state}. */
903
1217
  setState(state: number): void;
904
- seed: number;
1218
+ /** Restart the stream from a new seed. `reset` then returns to this seed. */
1219
+ reseed(seed: number | string): void;
1220
+ /** The seed the stream currently starts from. */
1221
+ readonly seed: number;
905
1222
  };
906
1223
 
907
1224
  /**
@@ -910,44 +1227,83 @@ type Rng = {
910
1227
  * This is how a suite reaches the vendor's failure modes without the vendor: the
911
1228
  * quota error that only appears when a shared sandbox is full, the 429 that only
912
1229
  * appears under load, the 5xx that proves a retry path works.
1230
+ *
1231
+ * A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
1232
+ * it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
1233
+ * and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
913
1234
  */
914
1235
  type FaultRule = {
915
- /** Stable id, so a suite can retire exactly the rule it added. */
1236
+ /** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
916
1237
  id: string;
917
1238
  /** Fault only this operation. Omit to match every operation. */
918
1239
  operationId?: string;
919
1240
  /** Fault only this HTTP method, case-insensitive. Omit to match every method. */
920
1241
  method?: string;
1242
+ /** Fault only this exact path. */
1243
+ path?: string;
921
1244
  /** Fault only paths starting with this prefix. Omit to match every path. */
922
1245
  pathPrefix?: string;
1246
+ /** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
1247
+ pathPattern?: string;
1248
+ /** Fault only requests carrying these headers. `"*"` matches any value. */
1249
+ requestHeaders?: Record<string, string>;
1250
+ /** Fault only requests carrying these query parameters. `"*"` matches any value. */
1251
+ query?: Record<string, string>;
923
1252
  /**
924
1253
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
925
1254
  * an in-process caller usually wants, and what a parallel worker usually does not:
926
1255
  * rules added through `POST /__admin/faults` default to the calling namespace.
927
1256
  */
928
1257
  namespace?: string;
1258
+ /** Let this many matching requests through first. */
1259
+ after?: number;
1260
+ /** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
1261
+ every?: number;
1262
+ /** Retire the rule after this many faults. Omit to keep it until removed. */
1263
+ count?: number;
1264
+ /** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
1265
+ rate?: number;
1266
+ /**
1267
+ * Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
1268
+ * clock when the rule was added. Listed as epoch ms.
1269
+ */
1270
+ from?: Instant | Duration;
1271
+ /** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
1272
+ until?: Instant | Duration;
929
1273
  /**
930
- * Status of the injected response. Omit for a rule that only delays (`delayMs` /
931
- * `latencyMs`), only drops the connection (`drop`), or only switches on an `effect`:
932
- * the request then still reaches the service.
1274
+ * Status of the injected response. Omit for a rule that only delays, times out, drops,
1275
+ * truncates, or switches on an `effect`: the request then still reaches the service.
933
1276
  */
934
1277
  status?: number;
935
1278
  /** Response body, serialized as JSON. A string is sent as-is. */
936
1279
  body?: unknown;
1280
+ /** Response headers. */
937
1281
  headers?: Record<string, string>;
938
- /** Retire the rule after this many faults. Omit to keep it until removed. */
939
- count?: number;
940
- /** Fault this fraction of matching requests, `0`–`1`. Default `1`. */
941
- rate?: number;
942
- /** Hold the response back this long, to exercise timeouts. */
1282
+ /** Hold the response back this long. Listed as `delayMs`. */
1283
+ delay?: Duration;
1284
+ /** `delay`, in milliseconds. */
943
1285
  delayMs?: number;
944
1286
  /** Alias of `delayMs`. */
945
1287
  latencyMs?: number;
1288
+ /** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
1289
+ jitter?: Duration;
1290
+ jitterMs?: number;
1291
+ /**
1292
+ * Never answer: hold the request this long, then drop the connection. Listed as
1293
+ * `timeoutMs`. With virtual time the wait is spent on the mock clock.
1294
+ */
1295
+ timeout?: Duration;
1296
+ timeoutMs?: number;
946
1297
  /**
947
1298
  * Drop the connection instead of answering: an in-process `fetch` rejects with a
948
1299
  * `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
949
1300
  */
950
1301
  drop?: boolean;
1302
+ /**
1303
+ * Cut the response body off after this many bytes: the status and headers arrive, then
1304
+ * the connection dies mid-body.
1305
+ */
1306
+ truncate?: number;
951
1307
  /**
952
1308
  * A named service behaviour to switch on for the matching request instead of (or
953
1309
  * before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
@@ -956,8 +1312,8 @@ type FaultRule = {
956
1312
  effect?: string;
957
1313
  /** Parameters for `effect`. */
958
1314
  params?: Record<string, unknown>;
959
- /** From the preset this rule was expanded from, if any. */
960
- preset?: string;
1315
+ /** The preset this rule was expanded from, if any. */
1316
+ fromPreset?: string;
961
1317
  };
962
1318
  /** A fault that fired for one request. */
963
1319
  type FaultHit = {
@@ -965,6 +1321,10 @@ type FaultHit = {
965
1321
  /** The injected response; absent when the rule only delays, drops, or sets an effect. */
966
1322
  response?: Response;
967
1323
  drop?: boolean;
1324
+ /** Set with `drop` when the rule held the request for its `timeout` first. */
1325
+ timeout?: boolean;
1326
+ /** Bytes of response body to let through before the connection dies. */
1327
+ truncate?: number;
968
1328
  effect?: {
969
1329
  name: string;
970
1330
  params: Record<string, unknown>;
@@ -976,38 +1336,202 @@ type FaultCandidate = {
976
1336
  method: string;
977
1337
  path: string;
978
1338
  namespace: string;
1339
+ /** Request headers and query, for rules that match on them. */
1340
+ headers?: Headers;
1341
+ query?: URLSearchParams;
1342
+ /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
1343
+ now?: number;
1344
+ /** How to spend a delay for this request. Default: the registry's own sleep. */
1345
+ wait?: (ms: number) => Promise<void>;
1346
+ };
1347
+ /** A stored rule and how often it was consulted. */
1348
+ type FaultListing = FaultRule & {
1349
+ /** Faults left before the rule retires. `null` when it has no `count`. */
1350
+ remaining: number | null;
1351
+ /** Times the rule faulted a request. */
1352
+ hits: number;
1353
+ /** Requests that matched the rule, faulted or not. */
1354
+ seen: number;
1355
+ };
1356
+ /** A namespace's own rules, with their counters, in the order they are tried. */
1357
+ type FaultSnapshot = {
1358
+ /**
1359
+ * `position` is how many `"*"` rules are tried before the rule, which is what its place
1360
+ * in the order means to a request and holds in any process.
1361
+ */
1362
+ rules: (FaultListing & {
1363
+ position?: number;
1364
+ })[];
1365
+ /** How many `fault_<n>` ids the namespace has handed out. */
1366
+ nextId?: number;
979
1367
  };
980
1368
  type FaultRegistry = {
981
- isolateNamespaces(): void;
982
- snapshot(namespace: string): {
983
- rules: (FaultRule & {
984
- remaining: number | null;
985
- hits: number;
986
- position: number;
987
- })[];
988
- rngState: number;
989
- };
1369
+ snapshot(namespace: string): FaultSnapshot;
1370
+ /** Add a rule, or replace the rule with the same id in the same namespace. */
990
1371
  add(rule: FaultRule): FaultRule;
991
- list(): (FaultRule & {
992
- remaining: number | null;
993
- hits: number;
994
- })[];
995
- remove(id: string): boolean;
996
- clear(): void;
997
- restore(namespace: string, state: {
998
- rules: (FaultRule & {
999
- remaining: number | null;
1000
- hits: number;
1001
- position: number;
1002
- })[];
1003
- rngState: number;
1004
- }): void;
1372
+ /** The next unused `fault_<n>` id in `namespace`. */
1373
+ nextId(namespace: string): string;
1374
+ /** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
1375
+ list(namespace?: string): FaultListing[];
1376
+ get(id: string, namespace?: string): FaultListing | undefined;
1377
+ /** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
1378
+ remove(id: string, namespace?: string): boolean;
1379
+ /** Remove every rule, or one namespace's own rules. */
1380
+ clear(namespace?: string): void;
1381
+ /** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
1382
+ restore(namespace: string, state: FaultSnapshot): void;
1005
1383
  /**
1006
1384
  * Every fault this request should get, in rule order, stopping at the first that answers
1007
1385
  * or drops (effect-only and delay-only rules let later rules match too). Consumes one of
1008
1386
  * each matching rule's remaining uses.
1009
1387
  */
1010
1388
  take(candidate: FaultCandidate): Promise<FaultHit[]>;
1389
+ /**
1390
+ * Fire these rules at one request without storing them: no matching, no schedule, in order,
1391
+ * stopping at the first that answers or drops. Jitter draws from the namespace's stream.
1392
+ */
1393
+ fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
1394
+ };
1395
+
1396
+ /**
1397
+ * The admin controls every mock shares, as one document.
1398
+ *
1399
+ * The same shape is accepted in three places, and means the same thing in each:
1400
+ *
1401
+ * - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
1402
+ * `MOCKINGBIRD_ADMIN_CONTROLS`
1403
+ * - over HTTP: `PUT /__admin/controls`
1404
+ * - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
1405
+ *
1406
+ * Every control is deterministic: given the same seed, clock and requests, a mock answers
1407
+ * the same bytes. Nothing here reads the wall clock or `Math.random`.
1408
+ */
1409
+ /** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
1410
+ type Duration = number | string;
1411
+ /** Epoch milliseconds, or an ISO-8601 string. */
1412
+ type Instant = number | string;
1413
+ type ClockControls = {
1414
+ /** Move the clock to this instant. */
1415
+ now?: Instant;
1416
+ /** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
1417
+ frozen?: boolean;
1418
+ /**
1419
+ * Step the clock forward by this much before every vendor request. With a frozen clock
1420
+ * each request still gets its own, reproducible timestamp.
1421
+ */
1422
+ autoAdvance?: Duration;
1423
+ };
1424
+ /** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
1425
+ type LatencyRuleInput = {
1426
+ delay?: Duration;
1427
+ jitter?: Duration;
1428
+ };
1429
+ type LatencyControls = LatencyRuleInput & {
1430
+ /** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
1431
+ operations?: Record<string, Duration | LatencyRuleInput>;
1432
+ };
1433
+ /** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
1434
+ type FaultInput = (Omit<FaultRule, "id"> & {
1435
+ id?: string;
1436
+ }) | ({
1437
+ preset: string;
1438
+ } & Partial<FaultRule>);
1439
+ /** Identifies a {@link SnapshotDocument}. */
1440
+ declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
1441
+ /**
1442
+ * A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
1443
+ * `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
1444
+ * `records` are required, so a hand-written seed file is a valid snapshot.
1445
+ */
1446
+ type SnapshotDocument = {
1447
+ format: typeof SNAPSHOT_FORMAT;
1448
+ /** The service that wrote it. A snapshot is rejected by any other service. */
1449
+ service?: string;
1450
+ /**
1451
+ * Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
1452
+ * the stored text of a row that is not a plain record, and replaces `value` when present.
1453
+ */
1454
+ records: {
1455
+ collection: string;
1456
+ id: string;
1457
+ seq?: number;
1458
+ value?: unknown;
1459
+ raw?: string;
1460
+ }[];
1461
+ /** Id counters, so the next generated id continues where the snapshot left off. */
1462
+ sequences?: {
1463
+ name: string;
1464
+ kind: string;
1465
+ value: number;
1466
+ }[];
1467
+ clock?: {
1468
+ now: number;
1469
+ frozen: boolean;
1470
+ autoAdvanceMs?: number;
1471
+ };
1472
+ seed?: number | string;
1473
+ /** Positions of the seeded random streams. */
1474
+ rng?: {
1475
+ state: number;
1476
+ faults?: number;
1477
+ latency?: number;
1478
+ };
1479
+ faults?: unknown;
1480
+ latency?: unknown;
1481
+ virtualTime?: boolean;
1482
+ /** Quiescent webhook endpoints, delivery history and fault state. Contains private configuration. */
1483
+ webhooks?: unknown;
1484
+ };
1485
+ /** Controls for one namespace. */
1486
+ type NamespaceControls = {
1487
+ /** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
1488
+ seed?: number | string;
1489
+ clock?: ClockControls;
1490
+ /**
1491
+ * Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
1492
+ * wall clock: the request returns at once, the clock has moved, and the journal records
1493
+ * the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
1494
+ */
1495
+ virtualTime?: boolean;
1496
+ /** Baseline response time for every vendor request. A bare duration is its `delay`. */
1497
+ latency?: Duration | LatencyControls;
1498
+ faults?: readonly FaultInput[];
1499
+ /** Start from this state instead of the service's own seed data. */
1500
+ snapshot?: SnapshotDocument;
1501
+ };
1502
+ /** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
1503
+ type MockControls = NamespaceControls & {
1504
+ /** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
1505
+ credentials?: Record<string, string>;
1506
+ /** Overrides for named namespaces. A key given here replaces the shared value. */
1507
+ namespaces?: Record<string, NamespaceControls>;
1508
+ };
1509
+ /** A latency rule in milliseconds. */
1510
+ type LatencyRule = {
1511
+ delayMs: number;
1512
+ jitterMs: number;
1513
+ };
1514
+ /** Baseline latency for a namespace, normalized. */
1515
+ type LatencyState = LatencyRule & {
1516
+ operations: Record<string, LatencyRule>;
1517
+ };
1518
+ /** What {@link controlHeaders} turns into request headers. */
1519
+ type ControlHeaderInput = {
1520
+ namespace?: string;
1521
+ adminKey?: string;
1522
+ branch?: string;
1523
+ at?: string;
1524
+ reset?: boolean;
1525
+ restore?: string;
1526
+ seed?: number | string;
1527
+ time?: Instant | Date;
1528
+ advance?: Duration;
1529
+ virtualTime?: boolean;
1530
+ delay?: Duration;
1531
+ timeout?: Duration;
1532
+ /** A status, `"drop"`, a preset name, or a fault rule. */
1533
+ fault?: number | string | Record<string, unknown>;
1534
+ snapshot?: string;
1011
1535
  };
1012
1536
 
1013
1537
  /**
@@ -1047,6 +1571,8 @@ type RequestLog = {
1047
1571
  unmatched: boolean;
1048
1572
  /** Set when a fault rule produced the response. */
1049
1573
  faultId?: string;
1574
+ /** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
1575
+ delayMs?: number;
1050
1576
  /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
1051
1577
  ids?: Record<string, string>;
1052
1578
  /** Set when the service created a resource the request referred to but that did not exist. */
@@ -1092,6 +1618,12 @@ type JournalQuery = {
1092
1618
  /** Only this namespace. Omit for every namespace, oldest first across all of them. */
1093
1619
  namespace?: string;
1094
1620
  operationId?: string;
1621
+ /** Only this HTTP method, case-insensitive. */
1622
+ method?: string;
1623
+ /** Only this exact path. */
1624
+ path?: string;
1625
+ /** Only requests this fault rule answered or shaped. */
1626
+ faultId?: string;
1095
1627
  status?: number;
1096
1628
  /** Only entries at or after this instant (epoch ms). */
1097
1629
  since?: number;
@@ -1106,6 +1638,50 @@ type Journal = {
1106
1638
  clear(namespace?: string): void;
1107
1639
  };
1108
1640
 
1641
+ /**
1642
+ * Baseline response time, per namespace: how long every vendor request takes before any
1643
+ * fault is considered. Jitter draws from a stream the caller owns, one per namespace and
1644
+ * separate from the fault stream, so adding latency never shifts which requests a `rate`
1645
+ * fault hits.
1646
+ */
1647
+ type LatencyRegistry = {
1648
+ get(namespace: string): LatencyState;
1649
+ set(namespace: string, state: LatencyState): LatencyState;
1650
+ /** Remove one namespace's latency, or every namespace's. */
1651
+ clear(namespace?: string): void;
1652
+ /** Milliseconds this request waits. Draws jitter, so call it once per request. */
1653
+ take(namespace: string, operationId: string | undefined): number;
1654
+ };
1655
+
1656
+ /** Clock state as the admin API reports it. */
1657
+ type ControlClock = ClockState & {
1658
+ /** `now`, as ISO-8601. */
1659
+ iso: string;
1660
+ /** Milliseconds the clock steps before every vendor request. */
1661
+ autoAdvanceMs: number;
1662
+ };
1663
+ /** One namespace's controls: the body of `GET /__admin/controls`. */
1664
+ type ControlState = {
1665
+ namespace: string;
1666
+ seed: number | string;
1667
+ clock: ControlClock;
1668
+ virtualTime: boolean;
1669
+ latency: LatencyState;
1670
+ faults: FaultListing[];
1671
+ };
1672
+
1673
+ /** What `GET /__admin/snapshots` lists for each snapshot. */
1674
+ type SnapshotInfo = {
1675
+ id: string;
1676
+ namespace: string;
1677
+ /** Stored rows in the snapshot. */
1678
+ records: number;
1679
+ /** The namespace clock when it was taken, epoch ms. */
1680
+ at: number;
1681
+ /** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
1682
+ portable: boolean;
1683
+ };
1684
+
1109
1685
  /** Credential → namespace mapping behind `PUT /__admin/credentials`. */
1110
1686
  type CredentialRegistry = {
1111
1687
  set(credential: string, namespace: string): void;
@@ -1118,6 +1694,8 @@ type CredentialRegistry = {
1118
1694
  }[];
1119
1695
  };
1120
1696
 
1697
+ type OwnedTransport = (request: Request, namespace: string, send: typeof fetch) => Promise<Response>;
1698
+
1121
1699
  /**
1122
1700
  * A point-in-time copy of everything a service namespace holds.
1123
1701
  *
@@ -1235,8 +1813,16 @@ type PublishInput = {
1235
1813
  id?: string;
1236
1814
  };
1237
1815
  type WebhookHub = {
1816
+ observeDeliveries(listener: (event: {
1817
+ namespace: string;
1818
+ state: string;
1819
+ deliveryId: string;
1820
+ }) => void): () => void;
1821
+ setTransportPolicy(policy: OwnedTransport): void;
1238
1822
  pending(namespace: string): number;
1239
1823
  snapshot(namespace: string): unknown;
1824
+ exportSnapshot(handle: unknown): unknown;
1825
+ importSnapshot(namespace: string, document: unknown): unknown;
1240
1826
  restore(namespace: string, snapshot: unknown): void;
1241
1827
  publish(input: PublishInput): WebhookMessage;
1242
1828
  /** Replace a namespace's own endpoints (`PUT /__admin/webhook-endpoints`). */
@@ -1249,7 +1835,7 @@ type WebhookHub = {
1249
1835
  /** Run every pending retry (and release held reordered messages) now, and every retry those attempts schedule, until nothing is pending. */
1250
1836
  flush(): Promise<void>;
1251
1837
  /** Resolve once nothing is in flight. */
1252
- idle(): Promise<void>;
1838
+ idle(namespace?: string): Promise<void>;
1253
1839
  fault(namespace: string, fault: WebhookFault): void;
1254
1840
  clear(namespace?: string): void;
1255
1841
  };
@@ -1260,7 +1846,10 @@ type ServiceInstance = FetchAPI & {
1260
1846
  };
1261
1847
  type ServiceTimelineState = Readonly<{
1262
1848
  snapshot: NamespaceSnapshot;
1263
- clock: Readonly<ReturnType<Clock["state"]>>;
1849
+ /** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
1850
+ clock: Readonly<ClockState & {
1851
+ pinned?: boolean;
1852
+ }>;
1264
1853
  rngState: number;
1265
1854
  }>;
1266
1855
  type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
@@ -1273,27 +1862,63 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
1273
1862
  readonly sqlite: SqliteClient$1;
1274
1863
  readonly clock: Clock;
1275
1864
  readonly faults: FaultRegistry;
1865
+ /** Baseline response time per namespace. */
1866
+ readonly latency: LatencyRegistry;
1276
1867
  readonly metrics: Metrics;
1277
1868
  readonly journal: Journal;
1278
1869
  readonly rng: Rng;
1279
1870
  readonly credentials: CredentialRegistry;
1280
1871
  /** The webhook hub, when the service has outbound webhooks. */
1281
1872
  readonly webhooks: WebhookHub | undefined;
1282
- /** Enable independent namespace clocks and PRNGs before serving a fleet. */
1283
- isolateNamespaces(): void;
1873
+ /**
1874
+ * A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
1875
+ * offset and a freeze of its own, so moving one never moves another.
1876
+ */
1284
1877
  namespaceClock(namespace?: string): Clock;
1285
1878
  namespaceOf(request: Request): string;
1286
1879
  /** Opaque in-process checkpoint including records, controls and webhook history. */
1287
1880
  fleetSnapshot(namespace: string): object;
1288
1881
  fleetRestore(snapshot: unknown, namespace: string): void;
1882
+ fleetExport(snapshot: unknown): SnapshotDocument;
1883
+ fleetImport(namespace: string, document: unknown): object;
1289
1884
  /** Expand a named preset into fault rules (and webhook faults) for `namespace`. */
1290
1885
  applyPreset(name: string, namespace?: string, overrides?: Partial<FaultRule>): FaultRule[];
1291
1886
  /** The instance behind `namespace` (the default one when omitted), created on first use. */
1292
1887
  instance(namespace?: string): T;
1293
1888
  /** Public names of every namespace created so far. */
1294
1889
  namespaces(): string[];
1295
- /** Reset one namespace, or every namespace with `"*"`. */
1890
+ /** Return one namespace to its boot state, or every namespace with `"*"`. */
1296
1891
  reset(namespace?: string): Promise<void>;
1892
+ /** Reset a namespace and forget it, releasing everything it held. */
1893
+ dropNamespace(namespace: string): Promise<void>;
1894
+ /** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
1895
+ controls(namespace?: string): ControlState & {
1896
+ snapshots: SnapshotInfo[];
1897
+ };
1898
+ /** Apply a control document to a namespace. A given key replaces that control. */
1899
+ configure(controls: NamespaceControls, namespace?: string): ControlState & {
1900
+ snapshots: SnapshotInfo[];
1901
+ };
1902
+ /** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
1903
+ readonly snapshots: {
1904
+ /** Capture the namespace now. Reusing a name replaces that snapshot. */
1905
+ create(options?: {
1906
+ name?: string;
1907
+ namespace?: string;
1908
+ }): SnapshotInfo;
1909
+ list(namespace?: string): SnapshotInfo[];
1910
+ /** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
1911
+ export(id: string, namespace?: string): SnapshotDocument;
1912
+ /** Store a document as a snapshot without restoring it. */
1913
+ import(document: SnapshotDocument, options?: {
1914
+ name?: string;
1915
+ namespace?: string;
1916
+ }): SnapshotInfo;
1917
+ restore(id: string, namespace?: string): void;
1918
+ delete(id: string, namespace?: string): boolean;
1919
+ };
1920
+ /** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
1921
+ headers(input: ControlHeaderInput): Record<string, string>;
1297
1922
  snapshot(namespace?: string): NamespaceSnapshot;
1298
1923
  restore(snapshot: NamespaceSnapshot, namespace?: string): void;
1299
1924
  /** Capture the current branch. Mutating HTTP calls do this automatically. */
@@ -1517,6 +2142,8 @@ type SpeechRuntimeOptions = {
1517
2142
  seed?: number | string;
1518
2143
  adminPrefix?: string;
1519
2144
  adminKey?: string;
2145
+ /** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
2146
+ adminControls?: MockControls;
1520
2147
  onLog?: (entry: RequestLog) => void;
1521
2148
  settings?: Partial<Settings>;
1522
2149
  /** Transcripts every namespace starts with (and returns to on reset). */