@crvouga/mockingbird-service-slack 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli.js CHANGED
@@ -3,8 +3,8 @@ import {
3
3
  runCli,
4
4
  serveCommand,
5
5
  serveTarget
6
- } from "./chunk-TMQCTVOT.js";
7
- import "./chunk-4JPRLFNZ.js";
6
+ } from "./chunk-OIN4LUJA.js";
7
+ import "./chunk-WBNF7Q2J.js";
8
8
  import "./chunk-6Z2MR3PO.js";
9
9
 
10
10
  // src/cli.ts
package/dist/index.d.ts CHANGED
@@ -353,6 +353,12 @@ declare class Collection<T> {
353
353
  }>;
354
354
  }
355
355
 
356
+ /**
357
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
358
+ * which derives the base from the wall clock when the runtime is created.
359
+ */
360
+ type IdBase = number | string;
361
+
356
362
  /** Options every provider constructor accepts. */
357
363
  type APIOptions = {
358
364
  /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -448,6 +454,15 @@ type FaultRule = {
448
454
  requestHeaders?: Record<string, string>;
449
455
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
450
456
  query?: Record<string, string>;
457
+ /**
458
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
459
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
460
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
461
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
462
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
463
+ * response a rule injects.
464
+ */
465
+ requestBody?: Record<string, RequestBodyValue>;
451
466
  /**
452
467
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
453
468
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -514,6 +529,8 @@ type FaultRule = {
514
529
  /** The preset this rule was expanded from, if any. */
515
530
  fromPreset?: string;
516
531
  };
532
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
533
+ type RequestBodyValue = string | number | boolean | null;
517
534
  /** A fault that fired for one request. */
518
535
  type FaultHit = {
519
536
  id: string;
@@ -551,6 +568,11 @@ type FaultCandidate = {
551
568
  /** Request headers and query, for rules that match on them. */
552
569
  headers?: Headers;
553
570
  query?: URLSearchParams;
571
+ /**
572
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
573
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
574
+ */
575
+ readJson?: () => Promise<unknown>;
554
576
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
555
577
  now?: number;
556
578
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -1073,6 +1095,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
1073
1095
  mount(prefix: string): MountedAPI;
1074
1096
  readonly sqlite: SqliteClient$1;
1075
1097
  readonly clock: Clock;
1098
+ /**
1099
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
1100
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
1101
+ * one run.
1102
+ */
1103
+ setIdBase(base: IdBase): number;
1076
1104
  readonly faults: FaultRegistry;
1077
1105
  /** Baseline response time per namespace. */
1078
1106
  readonly latency: LatencyRegistry;
package/dist/index.js CHANGED
@@ -11,7 +11,7 @@ import {
11
11
  operationIds,
12
12
  slackCredential,
13
13
  supportedOperationIds
14
- } from "./chunk-4JPRLFNZ.js";
14
+ } from "./chunk-WBNF7Q2J.js";
15
15
  import "./chunk-6Z2MR3PO.js";
16
16
  export {
17
17
  DEFAULT_CHANNELS,
package/dist/server.d.ts CHANGED
@@ -133,6 +133,12 @@ interface SqliteClient$3 {
133
133
  transaction<T>(fn: () => T): T;
134
134
  }
135
135
 
136
+ /**
137
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
138
+ * which derives the base from the wall clock when the runtime is created.
139
+ */
140
+ type IdBase$1 = number | string;
141
+
136
142
  /**
137
143
  * The single source of time for a service.
138
144
  *
@@ -215,6 +221,15 @@ type FaultRule$1 = {
215
221
  requestHeaders?: Record<string, string>;
216
222
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
217
223
  query?: Record<string, string>;
224
+ /**
225
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
226
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
227
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
228
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
229
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
230
+ * response a rule injects.
231
+ */
232
+ requestBody?: Record<string, RequestBodyValue$1>;
218
233
  /**
219
234
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
220
235
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -281,6 +296,8 @@ type FaultRule$1 = {
281
296
  /** The preset this rule was expanded from, if any. */
282
297
  fromPreset?: string;
283
298
  };
299
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
300
+ type RequestBodyValue$1 = string | number | boolean | null;
284
301
  /** A fault that fired for one request. */
285
302
  type FaultHit$1 = {
286
303
  id: string;
@@ -305,6 +322,11 @@ type FaultCandidate$1 = {
305
322
  /** Request headers and query, for rules that match on them. */
306
323
  headers?: Headers;
307
324
  query?: URLSearchParams;
325
+ /**
326
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
327
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
328
+ */
329
+ readJson?: () => Promise<unknown>;
308
330
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
309
331
  now?: number;
310
332
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -827,6 +849,12 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$2 & {
827
849
  mount(prefix: string): MountedAPI$1;
828
850
  readonly sqlite: SqliteClient$3;
829
851
  readonly clock: Clock$1;
852
+ /**
853
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
854
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
855
+ * one run.
856
+ */
857
+ setIdBase(base: IdBase$1): number;
830
858
  readonly faults: FaultRegistry$1;
831
859
  /** Baseline response time per namespace. */
832
860
  readonly latency: LatencyRegistry$1;
@@ -932,6 +960,12 @@ type CommonServeOptions = {
932
960
  /** Synthetic provider fixture objects supplied by a fleet entry. */
933
961
  fixtures?: Record<string, unknown>;
934
962
  baseUrl?: string;
963
+ /**
964
+ * Boot settings from `--settings`, `MOCKINGBIRD_SETTINGS` or a fleet entry's `settings`,
965
+ * already checked by the target's {@link ServeTarget.parseSettings}. Pass them to the
966
+ * service's own `settings` option so they become every namespace's defaults.
967
+ */
968
+ settings?: Record<string, unknown>;
935
969
  };
936
970
  /**
937
971
  * What a service contributes to `serve`: how to build its runtime from CLI flags,
@@ -944,6 +978,13 @@ type ServeTarget = {
944
978
  defaultPort: number;
945
979
  /** Serve flags beyond the common ones. */
946
980
  options?: Record<string, CliOption>;
981
+ /**
982
+ * Check the boot settings a caller supplied (`--settings`, `MOCKINGBIRD_SETTINGS`, a fleet
983
+ * entry's `settings`) against the service's settings schema, returning them normalized
984
+ * or throwing a message naming the bad field. A target without one takes no boot settings,
985
+ * and supplying some is refused before a port is bound.
986
+ */
987
+ parseSettings?(settings: Record<string, unknown>): Record<string, unknown>;
947
988
  create(values: CliValues, common: CommonServeOptions): Promise<ServiceRuntime$1<ServiceInstance$1>> | ServiceRuntime$1<ServiceInstance$1>;
948
989
  /** Startup lines after the listen address, e.g. the loaded corpus version. */
949
990
  banner?(runtime: ServiceRuntime$1<ServiceInstance$1>): string[];
@@ -1125,6 +1166,12 @@ declare class Collection<T> {
1125
1166
  }>;
1126
1167
  }
1127
1168
 
1169
+ /**
1170
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
1171
+ * which derives the base from the wall clock when the runtime is created.
1172
+ */
1173
+ type IdBase = number | string;
1174
+
1128
1175
  /** Options every provider constructor accepts. */
1129
1176
  type APIOptions$1 = {
1130
1177
  /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -1220,6 +1267,15 @@ type FaultRule = {
1220
1267
  requestHeaders?: Record<string, string>;
1221
1268
  /** Fault only requests carrying these query parameters. `"*"` matches any value. */
1222
1269
  query?: Record<string, string>;
1270
+ /**
1271
+ * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
1272
+ * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
1273
+ * and each value is what the field must equal: a string, number, boolean or `null`, compared
1274
+ * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
1275
+ * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
1276
+ * response a rule injects.
1277
+ */
1278
+ requestBody?: Record<string, RequestBodyValue>;
1223
1279
  /**
1224
1280
  * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
1225
1281
  * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -1286,6 +1342,8 @@ type FaultRule = {
1286
1342
  /** The preset this rule was expanded from, if any. */
1287
1343
  fromPreset?: string;
1288
1344
  };
1345
+ /** What a field of the request body must equal in {@link FaultRule.requestBody}. */
1346
+ type RequestBodyValue = string | number | boolean | null;
1289
1347
  /** A fault that fired for one request. */
1290
1348
  type FaultHit = {
1291
1349
  id: string;
@@ -1310,6 +1368,11 @@ type FaultCandidate = {
1310
1368
  /** Request headers and query, for rules that match on them. */
1311
1369
  headers?: Headers;
1312
1370
  query?: URLSearchParams;
1371
+ /**
1372
+ * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
1373
+ * `undefined` for a body that is missing or not JSON. It must leave the request readable.
1374
+ */
1375
+ readJson?: () => Promise<unknown>;
1313
1376
  /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
1314
1377
  now?: number;
1315
1378
  /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -1832,6 +1895,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
1832
1895
  mount(prefix: string): MountedAPI;
1833
1896
  readonly sqlite: SqliteClient$2;
1834
1897
  readonly clock: Clock;
1898
+ /**
1899
+ * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
1900
+ * return the number it resolved to. Set it before the first request so a boot's ids stay
1901
+ * one run.
1902
+ */
1903
+ setIdBase(base: IdBase): number;
1835
1904
  readonly faults: FaultRegistry;
1836
1905
  /** Baseline response time per namespace. */
1837
1906
  readonly latency: LatencyRegistry;
package/dist/server.js CHANGED
@@ -2,8 +2,8 @@ import {
2
2
  DEFAULT_PORT,
3
3
  createServer,
4
4
  serveTarget
5
- } from "./chunk-TMQCTVOT.js";
6
- import "./chunk-4JPRLFNZ.js";
5
+ } from "./chunk-OIN4LUJA.js";
6
+ import "./chunk-WBNF7Q2J.js";
7
7
  import "./chunk-6Z2MR3PO.js";
8
8
  export {
9
9
  DEFAULT_PORT,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crvouga/mockingbird-service-slack",
3
- "version": "3.6.0",
3
+ "version": "3.7.0",
4
4
  "description": "Stateful emulator of Slack incoming webhooks, the Web API, and the Socket Mode control plane, with an outbox of every alert the app sent.",
5
5
  "license": "MIT",
6
6
  "type": "module",