@crvouga/mockingbird-service-slack 3.2.0 → 3.3.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,200 @@ 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
+ };
449
+ /** Controls for one namespace. */
450
+ type NamespaceControls$1 = {
451
+ /** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
452
+ seed?: number | string;
453
+ clock?: ClockControls$1;
454
+ /**
455
+ * Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
456
+ * wall clock: the request returns at once, the clock has moved, and the journal records
457
+ * the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
458
+ */
459
+ virtualTime?: boolean;
460
+ /** Baseline response time for every vendor request. A bare duration is its `delay`. */
461
+ latency?: Duration$1 | LatencyControls$1;
462
+ faults?: readonly FaultInput$1[];
463
+ /** Start from this state instead of the service's own seed data. */
464
+ snapshot?: SnapshotDocument$1;
465
+ };
466
+ /** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
467
+ type MockControls$1 = NamespaceControls$1 & {
468
+ /** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
469
+ credentials?: Record<string, string>;
470
+ /** Overrides for named namespaces. A key given here replaces the shared value. */
471
+ namespaces?: Record<string, NamespaceControls$1>;
472
+ };
473
+ /** A latency rule in milliseconds. */
474
+ type LatencyRule$1 = {
475
+ delayMs: number;
476
+ jitterMs: number;
477
+ };
478
+ /** Baseline latency for a namespace, normalized. */
479
+ type LatencyState$1 = LatencyRule$1 & {
480
+ operations: Record<string, LatencyRule$1>;
481
+ };
482
+ /** What {@link controlHeaders} turns into request headers. */
483
+ type ControlHeaderInput$1 = {
484
+ namespace?: string;
485
+ adminKey?: string;
486
+ branch?: string;
487
+ at?: string;
488
+ reset?: boolean;
489
+ restore?: string;
490
+ seed?: number | string;
491
+ time?: Instant$1 | Date;
492
+ advance?: Duration$1;
493
+ virtualTime?: boolean;
494
+ delay?: Duration$1;
495
+ timeout?: Duration$1;
496
+ /** A status, `"drop"`, a preset name, or a fault rule. */
497
+ fault?: number | string | Record<string, unknown>;
498
+ snapshot?: string;
291
499
  };
292
500
 
293
501
  /**
@@ -327,6 +535,8 @@ type RequestLog$1 = {
327
535
  unmatched: boolean;
328
536
  /** Set when a fault rule produced the response. */
329
537
  faultId?: string;
538
+ /** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
539
+ delayMs?: number;
330
540
  /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
331
541
  ids?: Record<string, string>;
332
542
  /** Set when the service created a resource the request referred to but that did not exist. */
@@ -372,6 +582,12 @@ type JournalQuery$1 = {
372
582
  /** Only this namespace. Omit for every namespace, oldest first across all of them. */
373
583
  namespace?: string;
374
584
  operationId?: string;
585
+ /** Only this HTTP method, case-insensitive. */
586
+ method?: string;
587
+ /** Only this exact path. */
588
+ path?: string;
589
+ /** Only requests this fault rule answered or shaped. */
590
+ faultId?: string;
375
591
  status?: number;
376
592
  /** Only entries at or after this instant (epoch ms). */
377
593
  since?: number;
@@ -386,6 +602,50 @@ type Journal$1 = {
386
602
  clear(namespace?: string): void;
387
603
  };
388
604
 
605
+ /**
606
+ * Baseline response time, per namespace: how long every vendor request takes before any
607
+ * fault is considered. Jitter draws from a stream the caller owns, one per namespace and
608
+ * separate from the fault stream, so adding latency never shifts which requests a `rate`
609
+ * fault hits.
610
+ */
611
+ type LatencyRegistry$1 = {
612
+ get(namespace: string): LatencyState$1;
613
+ set(namespace: string, state: LatencyState$1): LatencyState$1;
614
+ /** Remove one namespace's latency, or every namespace's. */
615
+ clear(namespace?: string): void;
616
+ /** Milliseconds this request waits. Draws jitter, so call it once per request. */
617
+ take(namespace: string, operationId: string | undefined): number;
618
+ };
619
+
620
+ /** Clock state as the admin API reports it. */
621
+ type ControlClock$1 = ClockState$1 & {
622
+ /** `now`, as ISO-8601. */
623
+ iso: string;
624
+ /** Milliseconds the clock steps before every vendor request. */
625
+ autoAdvanceMs: number;
626
+ };
627
+ /** One namespace's controls: the body of `GET /__admin/controls`. */
628
+ type ControlState$1 = {
629
+ namespace: string;
630
+ seed: number | string;
631
+ clock: ControlClock$1;
632
+ virtualTime: boolean;
633
+ latency: LatencyState$1;
634
+ faults: FaultListing$1[];
635
+ };
636
+
637
+ /** What `GET /__admin/snapshots` lists for each snapshot. */
638
+ type SnapshotInfo$1 = {
639
+ id: string;
640
+ namespace: string;
641
+ /** Stored rows in the snapshot. */
642
+ records: number;
643
+ /** The namespace clock when it was taken, epoch ms. */
644
+ at: number;
645
+ /** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
646
+ portable: boolean;
647
+ };
648
+
389
649
  /** Credential → namespace mapping behind `PUT /__admin/credentials`. */
390
650
  type CredentialRegistry$1 = {
391
651
  set(credential: string, namespace: string): void;
@@ -540,7 +800,10 @@ type ServiceInstance$1 = FetchAPI$2 & {
540
800
  };
541
801
  type ServiceTimelineState$1 = Readonly<{
542
802
  snapshot: NamespaceSnapshot$1;
543
- clock: Readonly<ReturnType<Clock$1["state"]>>;
803
+ /** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
804
+ clock: Readonly<ClockState$1 & {
805
+ pinned?: boolean;
806
+ }>;
544
807
  rngState: number;
545
808
  }>;
546
809
  type ServiceCheckpoint$1 = Checkpoint$1<ServiceTimelineState$1>;
@@ -553,14 +816,18 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
553
816
  readonly sqlite: SqliteClient$3;
554
817
  readonly clock: Clock$1;
555
818
  readonly faults: FaultRegistry$1;
819
+ /** Baseline response time per namespace. */
820
+ readonly latency: LatencyRegistry$1;
556
821
  readonly metrics: Metrics$1;
557
822
  readonly journal: Journal$1;
558
823
  readonly rng: Rng$1;
559
824
  readonly credentials: CredentialRegistry$1;
560
825
  /** The webhook hub, when the service has outbound webhooks. */
561
826
  readonly webhooks: WebhookHub$1 | undefined;
562
- /** Enable independent namespace clocks and PRNGs before serving a fleet. */
563
- isolateNamespaces(): void;
827
+ /**
828
+ * A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
829
+ * offset and a freeze of its own, so moving one never moves another.
830
+ */
564
831
  namespaceClock(namespace?: string): Clock$1;
565
832
  namespaceOf(request: Request): string;
566
833
  /** Opaque in-process checkpoint including records, controls and webhook history. */
@@ -572,8 +839,38 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
572
839
  instance(namespace?: string): T;
573
840
  /** Public names of every namespace created so far. */
574
841
  namespaces(): string[];
575
- /** Reset one namespace, or every namespace with `"*"`. */
842
+ /** Return one namespace to its boot state, or every namespace with `"*"`. */
576
843
  reset(namespace?: string): Promise<void>;
844
+ /** Reset a namespace and forget it, releasing everything it held. */
845
+ dropNamespace(namespace: string): Promise<void>;
846
+ /** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
847
+ controls(namespace?: string): ControlState$1 & {
848
+ snapshots: SnapshotInfo$1[];
849
+ };
850
+ /** Apply a control document to a namespace. A given key replaces that control. */
851
+ configure(controls: NamespaceControls$1, namespace?: string): ControlState$1 & {
852
+ snapshots: SnapshotInfo$1[];
853
+ };
854
+ /** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
855
+ readonly snapshots: {
856
+ /** Capture the namespace now. Reusing a name replaces that snapshot. */
857
+ create(options?: {
858
+ name?: string;
859
+ namespace?: string;
860
+ }): SnapshotInfo$1;
861
+ list(namespace?: string): SnapshotInfo$1[];
862
+ /** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
863
+ export(id: string, namespace?: string): SnapshotDocument$1;
864
+ /** Store a document as a snapshot without restoring it. */
865
+ import(document: SnapshotDocument$1, options?: {
866
+ name?: string;
867
+ namespace?: string;
868
+ }): SnapshotInfo$1;
869
+ restore(id: string, namespace?: string): void;
870
+ delete(id: string, namespace?: string): boolean;
871
+ };
872
+ /** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
873
+ headers(input: ControlHeaderInput$1): Record<string, string>;
577
874
  snapshot(namespace?: string): NamespaceSnapshot$1;
578
875
  restore(snapshot: NamespaceSnapshot$1, namespace?: string): void;
579
876
  /** Capture the current branch. Mutating HTTP calls do this automatically. */
@@ -616,6 +913,8 @@ type CommonServeOptions = {
616
913
  adminKey: string | undefined;
617
914
  seed: string | undefined;
618
915
  onLog: ((entry: RequestLog$1) => void) | undefined;
916
+ /** Admin controls to boot with: clock, latency, faults, a starting snapshot. */
917
+ adminControls?: MockControls$1;
619
918
  /** Synthetic provider fixture objects supplied by a fleet entry. */
620
919
  fixtures?: Record<string, unknown>;
621
920
  baseUrl?: string;
@@ -836,7 +1135,7 @@ type ClockState = {
836
1135
  now: number;
837
1136
  /** True while time does not advance on its own. */
838
1137
  frozen: boolean;
839
- /** Milliseconds this clock adds to its underlying source. */
1138
+ /** Milliseconds a running clock adds to its underlying source. `0` while frozen. */
840
1139
  offsetMs: number;
841
1140
  };
842
1141
  type Clock = {
@@ -872,7 +1171,10 @@ type Rng = {
872
1171
  state(): number;
873
1172
  /** Restore a state previously returned by {@link state}. */
874
1173
  setState(state: number): void;
875
- seed: number;
1174
+ /** Restart the stream from a new seed. `reset` then returns to this seed. */
1175
+ reseed(seed: number | string): void;
1176
+ /** The seed the stream currently starts from. */
1177
+ readonly seed: number;
876
1178
  };
877
1179
 
878
1180
  /**
@@ -881,44 +1183,83 @@ type Rng = {
881
1183
  * This is how a suite reaches the vendor's failure modes without the vendor: the
882
1184
  * quota error that only appears when a shared sandbox is full, the 429 that only
883
1185
  * appears under load, the 5xx that proves a retry path works.
1186
+ *
1187
+ * A rule has three parts. What it **matches** (`operationId`, `method`, `path`, …), **when**
1188
+ * it fires among the matching requests (`after`, `every`, `count`, `rate`, `from`, `until`),
1189
+ * and what it **does** (`status`, `delay`, `timeout`, `drop`, `truncate`, `effect`).
884
1190
  */
885
1191
  type FaultRule = {
886
- /** Stable id, so a suite can retire exactly the rule it added. */
1192
+ /** Stable id, so a suite can retire exactly the rule it added. Unique within a namespace. */
887
1193
  id: string;
888
1194
  /** Fault only this operation. Omit to match every operation. */
889
1195
  operationId?: string;
890
1196
  /** Fault only this HTTP method, case-insensitive. Omit to match every method. */
891
1197
  method?: string;
1198
+ /** Fault only this exact path. */
1199
+ path?: string;
892
1200
  /** Fault only paths starting with this prefix. Omit to match every path. */
893
1201
  pathPrefix?: string;
1202
+ /** Fault only paths matching this regular expression (JavaScript syntax, unanchored). */
1203
+ pathPattern?: string;
1204
+ /** Fault only requests carrying these headers. `"*"` matches any value. */
1205
+ requestHeaders?: Record<string, string>;
1206
+ /** Fault only requests carrying these query parameters. `"*"` matches any value. */
1207
+ query?: Record<string, string>;
894
1208
  /**
895
1209
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
896
1210
  * an in-process caller usually wants, and what a parallel worker usually does not:
897
1211
  * rules added through `POST /__admin/faults` default to the calling namespace.
898
1212
  */
899
1213
  namespace?: string;
1214
+ /** Let this many matching requests through first. */
1215
+ after?: number;
1216
+ /** Then fault only every nth matching request: `3` faults the 3rd, 6th, 9th. */
1217
+ every?: number;
1218
+ /** Retire the rule after this many faults. Omit to keep it until removed. */
1219
+ count?: number;
1220
+ /** Fault this fraction of the remaining requests, `0`–`1`, drawn from the seed. Default `1`. */
1221
+ rate?: number;
900
1222
  /**
901
- * Status of the injected response. Omit for a rule that only delays (`delayMs` /
902
- * `latencyMs`), only drops the connection (`drop`), or only switches on an `effect`:
903
- * the request then still reaches the service.
1223
+ * Fault only from this instant on the namespace clock. A duration (`"5m"`) counts from the
1224
+ * clock when the rule was added. Listed as epoch ms.
1225
+ */
1226
+ from?: Instant | Duration;
1227
+ /** Stop faulting at this instant on the namespace clock. A duration counts from when added. */
1228
+ until?: Instant | Duration;
1229
+ /**
1230
+ * Status of the injected response. Omit for a rule that only delays, times out, drops,
1231
+ * truncates, or switches on an `effect`: the request then still reaches the service.
904
1232
  */
905
1233
  status?: number;
906
1234
  /** Response body, serialized as JSON. A string is sent as-is. */
907
1235
  body?: unknown;
1236
+ /** Response headers. */
908
1237
  headers?: Record<string, string>;
909
- /** Retire the rule after this many faults. Omit to keep it until removed. */
910
- count?: number;
911
- /** Fault this fraction of matching requests, `0`–`1`. Default `1`. */
912
- rate?: number;
913
- /** Hold the response back this long, to exercise timeouts. */
1238
+ /** Hold the response back this long. Listed as `delayMs`. */
1239
+ delay?: Duration;
1240
+ /** `delay`, in milliseconds. */
914
1241
  delayMs?: number;
915
1242
  /** Alias of `delayMs`. */
916
1243
  latencyMs?: number;
1244
+ /** Extra seeded delay in `[0, jitter]`. Listed as `jitterMs`. */
1245
+ jitter?: Duration;
1246
+ jitterMs?: number;
1247
+ /**
1248
+ * Never answer: hold the request this long, then drop the connection. Listed as
1249
+ * `timeoutMs`. With virtual time the wait is spent on the mock clock.
1250
+ */
1251
+ timeout?: Duration;
1252
+ timeoutMs?: number;
917
1253
  /**
918
1254
  * Drop the connection instead of answering: an in-process `fetch` rejects with a
919
1255
  * `TypeError`, and a served mock destroys the socket. Models "unknown outcome" failures.
920
1256
  */
921
1257
  drop?: boolean;
1258
+ /**
1259
+ * Cut the response body off after this many bytes: the status and headers arrive, then
1260
+ * the connection dies mid-body.
1261
+ */
1262
+ truncate?: number;
922
1263
  /**
923
1264
  * A named service behaviour to switch on for the matching request instead of (or
924
1265
  * before) a canned response, e.g. `created_but_500` or `numeric_tracking_id`. Services
@@ -927,8 +1268,8 @@ type FaultRule = {
927
1268
  effect?: string;
928
1269
  /** Parameters for `effect`. */
929
1270
  params?: Record<string, unknown>;
930
- /** From the preset this rule was expanded from, if any. */
931
- preset?: string;
1271
+ /** The preset this rule was expanded from, if any. */
1272
+ fromPreset?: string;
932
1273
  };
933
1274
  /** A fault that fired for one request. */
934
1275
  type FaultHit = {
@@ -936,6 +1277,10 @@ type FaultHit = {
936
1277
  /** The injected response; absent when the rule only delays, drops, or sets an effect. */
937
1278
  response?: Response;
938
1279
  drop?: boolean;
1280
+ /** Set with `drop` when the rule held the request for its `timeout` first. */
1281
+ timeout?: boolean;
1282
+ /** Bytes of response body to let through before the connection dies. */
1283
+ truncate?: number;
939
1284
  effect?: {
940
1285
  name: string;
941
1286
  params: Record<string, unknown>;
@@ -947,38 +1292,200 @@ type FaultCandidate = {
947
1292
  method: string;
948
1293
  path: string;
949
1294
  namespace: string;
1295
+ /** Request headers and query, for rules that match on them. */
1296
+ headers?: Headers;
1297
+ query?: URLSearchParams;
1298
+ /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
1299
+ now?: number;
1300
+ /** How to spend a delay for this request. Default: the registry's own sleep. */
1301
+ wait?: (ms: number) => Promise<void>;
1302
+ };
1303
+ /** A stored rule and how often it was consulted. */
1304
+ type FaultListing = FaultRule & {
1305
+ /** Faults left before the rule retires. `null` when it has no `count`. */
1306
+ remaining: number | null;
1307
+ /** Times the rule faulted a request. */
1308
+ hits: number;
1309
+ /** Requests that matched the rule, faulted or not. */
1310
+ seen: number;
1311
+ };
1312
+ /** A namespace's own rules, with their counters, in the order they are tried. */
1313
+ type FaultSnapshot = {
1314
+ /**
1315
+ * `position` is how many `"*"` rules are tried before the rule, which is what its place
1316
+ * in the order means to a request and holds in any process.
1317
+ */
1318
+ rules: (FaultListing & {
1319
+ position?: number;
1320
+ })[];
1321
+ /** How many `fault_<n>` ids the namespace has handed out. */
1322
+ nextId?: number;
950
1323
  };
951
1324
  type FaultRegistry = {
952
- isolateNamespaces(): void;
953
- snapshot(namespace: string): {
954
- rules: (FaultRule & {
955
- remaining: number | null;
956
- hits: number;
957
- position: number;
958
- })[];
959
- rngState: number;
960
- };
1325
+ snapshot(namespace: string): FaultSnapshot;
1326
+ /** Add a rule, or replace the rule with the same id in the same namespace. */
961
1327
  add(rule: FaultRule): FaultRule;
962
- list(): (FaultRule & {
963
- remaining: number | null;
964
- hits: number;
965
- })[];
966
- remove(id: string): boolean;
967
- clear(): void;
968
- restore(namespace: string, state: {
969
- rules: (FaultRule & {
970
- remaining: number | null;
971
- hits: number;
972
- position: number;
973
- })[];
974
- rngState: number;
975
- }): void;
1328
+ /** The next unused `fault_<n>` id in `namespace`. */
1329
+ nextId(namespace: string): string;
1330
+ /** Every rule, or the rules a namespace's requests can hit: its own and the global ones. */
1331
+ list(namespace?: string): FaultListing[];
1332
+ get(id: string, namespace?: string): FaultListing | undefined;
1333
+ /** Remove a rule by id: from `namespace` (its own, then a global one), or wherever it is. */
1334
+ remove(id: string, namespace?: string): boolean;
1335
+ /** Remove every rule, or one namespace's own rules. */
1336
+ clear(namespace?: string): void;
1337
+ /** Replace a namespace's own rules with a snapshot's, wherever the snapshot was taken. */
1338
+ restore(namespace: string, state: FaultSnapshot): void;
976
1339
  /**
977
1340
  * Every fault this request should get, in rule order, stopping at the first that answers
978
1341
  * or drops (effect-only and delay-only rules let later rules match too). Consumes one of
979
1342
  * each matching rule's remaining uses.
980
1343
  */
981
1344
  take(candidate: FaultCandidate): Promise<FaultHit[]>;
1345
+ /**
1346
+ * Fire these rules at one request without storing them: no matching, no schedule, in order,
1347
+ * stopping at the first that answers or drops. Jitter draws from the namespace's stream.
1348
+ */
1349
+ fire(rules: readonly FaultRule[], candidate: FaultCandidate): Promise<FaultHit[]>;
1350
+ };
1351
+
1352
+ /**
1353
+ * The admin controls every mock shares, as one document.
1354
+ *
1355
+ * The same shape is accepted in three places, and means the same thing in each:
1356
+ *
1357
+ * - at boot: `createRuntime({ adminControls })`, `serve --admin-controls`,
1358
+ * `MOCKINGBIRD_ADMIN_CONTROLS`
1359
+ * - over HTTP: `PUT /__admin/controls`
1360
+ * - per request: the `x-mockingbird-*` headers in {@link CONTROL_HEADERS}
1361
+ *
1362
+ * Every control is deterministic: given the same seed, clock and requests, a mock answers
1363
+ * the same bytes. Nothing here reads the wall clock or `Math.random`.
1364
+ */
1365
+ /** Milliseconds, or a string like `"250ms"`, `"2s"`, `"15m"`, `"1h"`, `"3d"`. */
1366
+ type Duration = number | string;
1367
+ /** Epoch milliseconds, or an ISO-8601 string. */
1368
+ type Instant = number | string;
1369
+ type ClockControls = {
1370
+ /** Move the clock to this instant. */
1371
+ now?: Instant;
1372
+ /** Stop time. A frozen clock moves only when told to, so timestamps replay exactly. */
1373
+ frozen?: boolean;
1374
+ /**
1375
+ * Step the clock forward by this much before every vendor request. With a frozen clock
1376
+ * each request still gets its own, reproducible timestamp.
1377
+ */
1378
+ autoAdvance?: Duration;
1379
+ };
1380
+ /** How long a response takes: a fixed delay plus seeded jitter in `[0, jitter]`. */
1381
+ type LatencyRuleInput = {
1382
+ delay?: Duration;
1383
+ jitter?: Duration;
1384
+ };
1385
+ type LatencyControls = LatencyRuleInput & {
1386
+ /** Per-operation overrides, keyed by operationId. A bare duration is its `delay`. */
1387
+ operations?: Record<string, Duration | LatencyRuleInput>;
1388
+ };
1389
+ /** A fault to add: a rule (the id is assigned when omitted), or a named preset with overrides. */
1390
+ type FaultInput = (Omit<FaultRule, "id"> & {
1391
+ id?: string;
1392
+ }) | ({
1393
+ preset: string;
1394
+ } & Partial<FaultRule>);
1395
+ /** Identifies a {@link SnapshotDocument}. */
1396
+ declare const SNAPSHOT_FORMAT = "mockingbird.snapshot/v1";
1397
+ /**
1398
+ * A namespace, as portable JSON: what `GET /__admin/snapshots/:id` returns and what
1399
+ * `PUT /__admin/snapshots/:id` and the boot `snapshot` control accept. Only `format` and
1400
+ * `records` are required, so a hand-written seed file is a valid snapshot.
1401
+ */
1402
+ type SnapshotDocument = {
1403
+ format: typeof SNAPSHOT_FORMAT;
1404
+ /** The service that wrote it. A snapshot is rejected by any other service. */
1405
+ service?: string;
1406
+ /**
1407
+ * Stored rows. `seq` orders a collection; omitted, rows keep their listed order. `raw` is
1408
+ * the stored text of a row that is not a plain record, and replaces `value` when present.
1409
+ */
1410
+ records: {
1411
+ collection: string;
1412
+ id: string;
1413
+ seq?: number;
1414
+ value?: unknown;
1415
+ raw?: string;
1416
+ }[];
1417
+ /** Id counters, so the next generated id continues where the snapshot left off. */
1418
+ sequences?: {
1419
+ name: string;
1420
+ kind: string;
1421
+ value: number;
1422
+ }[];
1423
+ clock?: {
1424
+ now: number;
1425
+ frozen: boolean;
1426
+ autoAdvanceMs?: number;
1427
+ };
1428
+ seed?: number | string;
1429
+ /** Positions of the seeded random streams. */
1430
+ rng?: {
1431
+ state: number;
1432
+ faults?: number;
1433
+ latency?: number;
1434
+ };
1435
+ faults?: unknown;
1436
+ latency?: unknown;
1437
+ virtualTime?: boolean;
1438
+ };
1439
+ /** Controls for one namespace. */
1440
+ type NamespaceControls = {
1441
+ /** Seeds every random choice: fault rates, jitter, and whatever the service invents. */
1442
+ seed?: number | string;
1443
+ clock?: ClockControls;
1444
+ /**
1445
+ * Spend injected waits (latency, fault delays, timeouts) on the mock clock instead of the
1446
+ * wall clock: the request returns at once, the clock has moved, and the journal records
1447
+ * the wait exactly. Default `false`: waits are real, so a client's own timeout can fire.
1448
+ */
1449
+ virtualTime?: boolean;
1450
+ /** Baseline response time for every vendor request. A bare duration is its `delay`. */
1451
+ latency?: Duration | LatencyControls;
1452
+ faults?: readonly FaultInput[];
1453
+ /** Start from this state instead of the service's own seed data. */
1454
+ snapshot?: SnapshotDocument;
1455
+ };
1456
+ /** {@link NamespaceControls} for every namespace, with per-namespace overrides. */
1457
+ type MockControls = NamespaceControls & {
1458
+ /** Vendor credential → namespace, for SDKs that cannot send a namespace header. */
1459
+ credentials?: Record<string, string>;
1460
+ /** Overrides for named namespaces. A key given here replaces the shared value. */
1461
+ namespaces?: Record<string, NamespaceControls>;
1462
+ };
1463
+ /** A latency rule in milliseconds. */
1464
+ type LatencyRule = {
1465
+ delayMs: number;
1466
+ jitterMs: number;
1467
+ };
1468
+ /** Baseline latency for a namespace, normalized. */
1469
+ type LatencyState = LatencyRule & {
1470
+ operations: Record<string, LatencyRule>;
1471
+ };
1472
+ /** What {@link controlHeaders} turns into request headers. */
1473
+ type ControlHeaderInput = {
1474
+ namespace?: string;
1475
+ adminKey?: string;
1476
+ branch?: string;
1477
+ at?: string;
1478
+ reset?: boolean;
1479
+ restore?: string;
1480
+ seed?: number | string;
1481
+ time?: Instant | Date;
1482
+ advance?: Duration;
1483
+ virtualTime?: boolean;
1484
+ delay?: Duration;
1485
+ timeout?: Duration;
1486
+ /** A status, `"drop"`, a preset name, or a fault rule. */
1487
+ fault?: number | string | Record<string, unknown>;
1488
+ snapshot?: string;
982
1489
  };
983
1490
 
984
1491
  /**
@@ -1018,6 +1525,8 @@ type RequestLog = {
1018
1525
  unmatched: boolean;
1019
1526
  /** Set when a fault rule produced the response. */
1020
1527
  faultId?: string;
1528
+ /** Milliseconds of injected wait: latency, fault delays and timeouts. Absent when none. */
1529
+ delayMs?: number;
1021
1530
  /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
1022
1531
  ids?: Record<string, string>;
1023
1532
  /** Set when the service created a resource the request referred to but that did not exist. */
@@ -1063,6 +1572,12 @@ type JournalQuery = {
1063
1572
  /** Only this namespace. Omit for every namespace, oldest first across all of them. */
1064
1573
  namespace?: string;
1065
1574
  operationId?: string;
1575
+ /** Only this HTTP method, case-insensitive. */
1576
+ method?: string;
1577
+ /** Only this exact path. */
1578
+ path?: string;
1579
+ /** Only requests this fault rule answered or shaped. */
1580
+ faultId?: string;
1066
1581
  status?: number;
1067
1582
  /** Only entries at or after this instant (epoch ms). */
1068
1583
  since?: number;
@@ -1077,6 +1592,50 @@ type Journal = {
1077
1592
  clear(namespace?: string): void;
1078
1593
  };
1079
1594
 
1595
+ /**
1596
+ * Baseline response time, per namespace: how long every vendor request takes before any
1597
+ * fault is considered. Jitter draws from a stream the caller owns, one per namespace and
1598
+ * separate from the fault stream, so adding latency never shifts which requests a `rate`
1599
+ * fault hits.
1600
+ */
1601
+ type LatencyRegistry = {
1602
+ get(namespace: string): LatencyState;
1603
+ set(namespace: string, state: LatencyState): LatencyState;
1604
+ /** Remove one namespace's latency, or every namespace's. */
1605
+ clear(namespace?: string): void;
1606
+ /** Milliseconds this request waits. Draws jitter, so call it once per request. */
1607
+ take(namespace: string, operationId: string | undefined): number;
1608
+ };
1609
+
1610
+ /** Clock state as the admin API reports it. */
1611
+ type ControlClock = ClockState & {
1612
+ /** `now`, as ISO-8601. */
1613
+ iso: string;
1614
+ /** Milliseconds the clock steps before every vendor request. */
1615
+ autoAdvanceMs: number;
1616
+ };
1617
+ /** One namespace's controls: the body of `GET /__admin/controls`. */
1618
+ type ControlState = {
1619
+ namespace: string;
1620
+ seed: number | string;
1621
+ clock: ControlClock;
1622
+ virtualTime: boolean;
1623
+ latency: LatencyState;
1624
+ faults: FaultListing[];
1625
+ };
1626
+
1627
+ /** What `GET /__admin/snapshots` lists for each snapshot. */
1628
+ type SnapshotInfo = {
1629
+ id: string;
1630
+ namespace: string;
1631
+ /** Stored rows in the snapshot. */
1632
+ records: number;
1633
+ /** The namespace clock when it was taken, epoch ms. */
1634
+ at: number;
1635
+ /** Whether `GET /snapshots/:id` can return it as a {@link SnapshotDocument}. */
1636
+ portable: boolean;
1637
+ };
1638
+
1080
1639
  /** Credential → namespace mapping behind `PUT /__admin/credentials`. */
1081
1640
  type CredentialRegistry = {
1082
1641
  set(credential: string, namespace: string): void;
@@ -1231,7 +1790,10 @@ type ServiceInstance = FetchAPI$1 & {
1231
1790
  };
1232
1791
  type ServiceTimelineState = Readonly<{
1233
1792
  snapshot: NamespaceSnapshot;
1234
- clock: Readonly<ReturnType<Clock["state"]>>;
1793
+ /** `pinned`: the namespace's clock was frozen itself, not just following a frozen base. */
1794
+ clock: Readonly<ClockState & {
1795
+ pinned?: boolean;
1796
+ }>;
1235
1797
  rngState: number;
1236
1798
  }>;
1237
1799
  type ServiceCheckpoint = Checkpoint<ServiceTimelineState>;
@@ -1244,14 +1806,18 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
1244
1806
  readonly sqlite: SqliteClient$2;
1245
1807
  readonly clock: Clock;
1246
1808
  readonly faults: FaultRegistry;
1809
+ /** Baseline response time per namespace. */
1810
+ readonly latency: LatencyRegistry;
1247
1811
  readonly metrics: Metrics;
1248
1812
  readonly journal: Journal;
1249
1813
  readonly rng: Rng;
1250
1814
  readonly credentials: CredentialRegistry;
1251
1815
  /** The webhook hub, when the service has outbound webhooks. */
1252
1816
  readonly webhooks: WebhookHub | undefined;
1253
- /** Enable independent namespace clocks and PRNGs before serving a fleet. */
1254
- isolateNamespaces(): void;
1817
+ /**
1818
+ * A namespace's clock. Each follows the base clock, {@link ServiceRuntime.clock}, with an
1819
+ * offset and a freeze of its own, so moving one never moves another.
1820
+ */
1255
1821
  namespaceClock(namespace?: string): Clock;
1256
1822
  namespaceOf(request: Request): string;
1257
1823
  /** Opaque in-process checkpoint including records, controls and webhook history. */
@@ -1263,8 +1829,38 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
1263
1829
  instance(namespace?: string): T;
1264
1830
  /** Public names of every namespace created so far. */
1265
1831
  namespaces(): string[];
1266
- /** Reset one namespace, or every namespace with `"*"`. */
1832
+ /** Return one namespace to its boot state, or every namespace with `"*"`. */
1267
1833
  reset(namespace?: string): Promise<void>;
1834
+ /** Reset a namespace and forget it, releasing everything it held. */
1835
+ dropNamespace(namespace: string): Promise<void>;
1836
+ /** A namespace's controls: seed, clock, virtual time, latency, faults and snapshots. */
1837
+ controls(namespace?: string): ControlState & {
1838
+ snapshots: SnapshotInfo[];
1839
+ };
1840
+ /** Apply a control document to a namespace. A given key replaces that control. */
1841
+ configure(controls: NamespaceControls, namespace?: string): ControlState & {
1842
+ snapshots: SnapshotInfo[];
1843
+ };
1844
+ /** Named snapshots of a namespace: records, clock, random streams, faults and latency. */
1845
+ readonly snapshots: {
1846
+ /** Capture the namespace now. Reusing a name replaces that snapshot. */
1847
+ create(options?: {
1848
+ name?: string;
1849
+ namespace?: string;
1850
+ }): SnapshotInfo;
1851
+ list(namespace?: string): SnapshotInfo[];
1852
+ /** The snapshot as portable JSON, to commit beside a suite or boot another mock from. */
1853
+ export(id: string, namespace?: string): SnapshotDocument;
1854
+ /** Store a document as a snapshot without restoring it. */
1855
+ import(document: SnapshotDocument, options?: {
1856
+ name?: string;
1857
+ namespace?: string;
1858
+ }): SnapshotInfo;
1859
+ restore(id: string, namespace?: string): void;
1860
+ delete(id: string, namespace?: string): boolean;
1861
+ };
1862
+ /** Request headers that carry controls, checked: spread them into a `fetch` or an SDK's defaults. */
1863
+ headers(input: ControlHeaderInput): Record<string, string>;
1268
1864
  snapshot(namespace?: string): NamespaceSnapshot;
1269
1865
  restore(snapshot: NamespaceSnapshot, namespace?: string): void;
1270
1866
  /** Capture the current branch. Mutating HTTP calls do this automatically. */
@@ -1517,6 +2113,11 @@ type ProviderOptions = APIOptions & {
1517
2113
  fallbackUser?: AuthFallback;
1518
2114
  publicNamespace?: string;
1519
2115
  adminPrefix?: string;
2116
+ /**
2117
+ * A seeded stream of `[0, 1)` that ids and tokens are minted from, so a run replays from
2118
+ * its seed. Default: the platform's randomness.
2119
+ */
2120
+ random?: () => number;
1520
2121
  };
1521
2122
 
1522
2123
  /**
@@ -1652,7 +2253,7 @@ declare class SlackState {
1652
2253
  findMessage(channel: string, ts: string): SlackMessage | undefined;
1653
2254
  }
1654
2255
 
1655
- type SlackAPIOptions = APIOptions$1 & Pick<ProviderOptions, "tokens" | "baseUrl" | "publicNamespace" | "adminPrefix"> & {
2256
+ type SlackAPIOptions = APIOptions$1 & Pick<ProviderOptions, "tokens" | "baseUrl" | "publicNamespace" | "adminPrefix" | "random"> & {
1656
2257
  fixtures?: SlackSeedConfig;
1657
2258
  /** Initial per-namespace settings (workspace identity, accepted tokens, strict channels). */
1658
2259
  settings?: Partial<Settings>;
@@ -1727,6 +2328,8 @@ type SlackRuntimeOptions = Pick<SlackAPIOptions, "fixtures" | "baseUrl" | "token
1727
2328
  seed?: number | string;
1728
2329
  adminPrefix?: string;
1729
2330
  adminKey?: string;
2331
+ /** Admin controls to boot with: clock, latency, faults, seed, a starting snapshot. */
2332
+ adminControls?: MockControls;
1730
2333
  onLog?: (entry: RequestLog) => void;
1731
2334
  settings?: Partial<Settings>;
1732
2335
  };