@crvouga/mockingbird-service-oauth 3.6.0 → 3.8.0

package/dist/cli.js

@@ -3,8 +3,8 @@ import {
   runCli,
   serveCommand,
   serveTarget
-} from "./chunk-OYEO5VHR.js";
-import "./chunk-ANDSQ2HK.js";
+} from "./chunk-AAKIJOPV.js";
+import "./chunk-VAXKCT3L.js";
 
 // src/cli.ts
 var code = await runCli(

package/dist/index.d.ts

@@ -172,6 +172,12 @@ declare class Collection<T> {
     }>;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase = number | string;
+
 /** Options every provider constructor accepts. */
 type APIOptions = {
     /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -267,6 +273,15 @@ type FaultRule = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -333,6 +348,8 @@ type FaultRule = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit = {
     id: string;
@@ -370,6 +387,11 @@ type FaultCandidate = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -892,6 +914,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
     mount(prefix: string): MountedAPI;
     readonly sqlite: SqliteClient$1;
     readonly clock: Clock;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase): number;
     readonly faults: FaultRegistry;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry;
@@ -1233,12 +1261,42 @@ type Account = {
         }[];
     };
 };
+type RedirectPolicy = {
+    /**
+     * RFC 8252 section 7.3: an `http://` loopback redirect (`127.0.0.1`, `[::1]` or `localhost`) may
+     * use any port. It must match a registered loopback URI on the same host, path and query.
+     */
+    loopbackAnyPort?: boolean;
+    /**
+     * Custom schemes (for example `["exp:"]` for Expo dev clients) whose host and port may vary per
+     * request, such as a LAN address. A request must still match a registered URI with the same
+     * scheme, path and query. `http:`/`https:` and executable schemes are rejected.
+     */
+    schemes?: string[];
+};
 type Client = {
     id: string;
     name: string;
     redirectUris: string[];
     secret?: string;
     requirePkce?: boolean;
+    /**
+     * Cognito-style public app client: let a client without a secret omit PKCE. A challenge that is
+     * sent is still verified. Default `false`: public clients must use S256 PKCE. Incompatible with
+     * `requirePkce: true` and with a client `secret`/`apple` configuration.
+     */
+    pkceOptional?: boolean;
+    /**
+     * Cognito-style refresh tokens: every authorization-code exchange returns a `refresh_token`,
+     * whether or not `offline_access` was requested. Default `false`: the profile's own rule applies
+     * (`offline_access` for OIDC and Microsoft, `access_type=offline` for Google; Apple always).
+     */
+    alwaysIssueRefreshToken?: boolean;
+    /**
+     * Opt-in redirect matching for dev clients. Exact registered URIs always match; this adds
+     * variants of registered URIs, never arbitrary URIs. Default: exact match only.
+     */
+    redirectPolicy?: RedirectPolicy;
     /** Apple developer/app grouping or OIDC pairwise identity sector. */
     subjectGroup?: string;
     /** Verify an Apple ES256 client-secret JWT instead of a static fixture secret. */
@@ -1589,4 +1647,4 @@ declare class OAuthAPI {
 }
 
 export { OAUTH_PRESETS, OAUTH_SCENARIOS, OAuthAPI, createMultiRuntime, createRuntime, document, operationIds, supportedOperationIds };
-export type { Account, AppleNotificationType, BehaviorEvent, BehaviorInput, Client, CredentialOptions, EdgeCase, GrantView, NotificationDelivery, OAuthAPIOptions, OAuthBehavior, OAuthMount, OAuthMultiRuntime, OAuthMultiRuntimeOptions, OAuthRuntime, OAuthRuntimeOptions, OAuthScenario, Provider, SigningKey };
+export type { Account, AppleNotificationType, BehaviorEvent, BehaviorInput, Client, CredentialOptions, EdgeCase, GrantView, NotificationDelivery, OAuthAPIOptions, OAuthBehavior, OAuthMount, OAuthMultiRuntime, OAuthMultiRuntimeOptions, OAuthRuntime, OAuthRuntimeOptions, OAuthScenario, Provider, RedirectPolicy, SigningKey };

package/dist/index.js

@@ -7,7 +7,7 @@ import {
   document,
   operationIds,
   supportedOperationIds
-} from "./chunk-ANDSQ2HK.js";
+} from "./chunk-VAXKCT3L.js";
 export {
   OAUTH_PRESETS,
   OAUTH_SCENARIOS,

package/dist/server.d.ts

@@ -132,6 +132,12 @@ interface SqliteClient$2 {
     transaction<T>(fn: () => T): T;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase$1 = number | string;
+
 /**
  * The single source of time for a service.
  *
@@ -214,6 +220,15 @@ type FaultRule$1 = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue$1>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -280,6 +295,8 @@ type FaultRule$1 = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue$1 = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit$1 = {
     id: string;
@@ -304,6 +321,11 @@ type FaultCandidate$1 = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -826,6 +848,12 @@ type ServiceRuntime$1<T extends ServiceInstance$1> = FetchAPI$1 & {
     mount(prefix: string): MountedAPI$1;
     readonly sqlite: SqliteClient$2;
     readonly clock: Clock$1;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase$1): number;
     readonly faults: FaultRegistry$1;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry$1;
@@ -931,6 +959,12 @@ type CommonServeOptions = {
     /** Synthetic provider fixture objects supplied by a fleet entry. */
     fixtures?: Record<string, unknown>;
     baseUrl?: string;
+    /**
+     * Boot settings from `--settings`, `MOCKINGBIRD_SETTINGS` or a fleet entry's `settings`,
+     * already checked by the target's {@link ServeTarget.parseSettings}. Pass them to the
+     * service's own `settings` option so they become every namespace's defaults.
+     */
+    settings?: Record<string, unknown>;
 };
 /**
  * What a service contributes to `serve`: how to build its runtime from CLI flags,
@@ -943,6 +977,13 @@ type ServeTarget = {
     defaultPort: number;
     /** Serve flags beyond the common ones. */
     options?: Record<string, CliOption>;
+    /**
+     * Check the boot settings a caller supplied (`--settings`, `MOCKINGBIRD_SETTINGS`, a fleet
+     * entry's `settings`) against the service's settings schema, returning them normalized
+     * or throwing a message naming the bad field. A target without one takes no boot settings,
+     * and supplying some is refused before a port is bound.
+     */
+    parseSettings?(settings: Record<string, unknown>): Record<string, unknown>;
     create(values: CliValues, common: CommonServeOptions): Promise<ServiceRuntime$1<ServiceInstance$1>> | ServiceRuntime$1<ServiceInstance$1>;
     /** Startup lines after the listen address, e.g. the loaded corpus version. */
     banner?(runtime: ServiceRuntime$1<ServiceInstance$1>): string[];
@@ -1124,6 +1165,12 @@ declare class Collection<T> {
     }>;
 }
 
+/**
+ * What names an id base: a non-negative safe integer (or its decimal string) or `"boot"`,
+ * which derives the base from the wall clock when the runtime is created.
+ */
+type IdBase = number | string;
+
 /** Options every provider constructor accepts. */
 type APIOptions = {
     /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
@@ -1219,6 +1266,15 @@ type FaultRule = {
     requestHeaders?: Record<string, string>;
     /** Fault only requests carrying these query parameters. `"*"` matches any value. */
     query?: Record<string, string>;
+    /**
+     * Fault only requests whose JSON body carries these fields. Each key is a dotted path into
+     * the parsed body (`"patient_details.email"`; a number steps into an array, `"items.0.sku"`)
+     * and each value is what the field must equal: a string, number, boolean or `null`, compared
+     * strictly (`3` is not `"3"`). `"*"` matches any value that is present. A request whose body
+     * is missing, is not JSON, or is not a JSON object never matches. Not `body`, which is the
+     * response a rule injects.
+     */
+    requestBody?: Record<string, RequestBodyValue>;
     /**
      * Fault only this namespace. Omit (or `"*"`) to fault every namespace — which is what
      * an in-process caller usually wants, and what a parallel worker usually does not:
@@ -1285,6 +1341,8 @@ type FaultRule = {
     /** The preset this rule was expanded from, if any. */
     fromPreset?: string;
 };
+/** What a field of the request body must equal in {@link FaultRule.requestBody}. */
+type RequestBodyValue = string | number | boolean | null;
 /** A fault that fired for one request. */
 type FaultHit = {
     id: string;
@@ -1309,6 +1367,11 @@ type FaultCandidate = {
     /** Request headers and query, for rules that match on them. */
     headers?: Headers;
     query?: URLSearchParams;
+    /**
+     * The request body parsed as JSON, read only when a rule matches on `requestBody`. Resolve
+     * `undefined` for a body that is missing or not JSON. It must leave the request readable.
+     */
+    readJson?: () => Promise<unknown>;
     /** The namespace clock, for `from` / `until`. Rules with a window are skipped without it. */
     now?: number;
     /** How to spend a delay for this request. Default: the registry's own sleep. */
@@ -1831,6 +1894,12 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI & {
     mount(prefix: string): MountedAPI;
     readonly sqlite: SqliteClient$1;
     readonly clock: Clock;
+    /**
+     * Change the id base ({@link RuntimeOptions.idBase}) for ids generated from now on, and
+     * return the number it resolved to. Set it before the first request so a boot's ids stay
+     * one run.
+     */
+    setIdBase(base: IdBase): number;
     readonly faults: FaultRegistry;
     /** Baseline response time per namespace. */
     readonly latency: LatencyRegistry;
@@ -2172,12 +2241,42 @@ type Account = {
         }[];
     };
 };
+type RedirectPolicy = {
+    /**
+     * RFC 8252 section 7.3: an `http://` loopback redirect (`127.0.0.1`, `[::1]` or `localhost`) may
+     * use any port. It must match a registered loopback URI on the same host, path and query.
+     */
+    loopbackAnyPort?: boolean;
+    /**
+     * Custom schemes (for example `["exp:"]` for Expo dev clients) whose host and port may vary per
+     * request, such as a LAN address. A request must still match a registered URI with the same
+     * scheme, path and query. `http:`/`https:` and executable schemes are rejected.
+     */
+    schemes?: string[];
+};
 type Client = {
     id: string;
     name: string;
     redirectUris: string[];
     secret?: string;
     requirePkce?: boolean;
+    /**
+     * Cognito-style public app client: let a client without a secret omit PKCE. A challenge that is
+     * sent is still verified. Default `false`: public clients must use S256 PKCE. Incompatible with
+     * `requirePkce: true` and with a client `secret`/`apple` configuration.
+     */
+    pkceOptional?: boolean;
+    /**
+     * Cognito-style refresh tokens: every authorization-code exchange returns a `refresh_token`,
+     * whether or not `offline_access` was requested. Default `false`: the profile's own rule applies
+     * (`offline_access` for OIDC and Microsoft, `access_type=offline` for Google; Apple always).
+     */
+    alwaysIssueRefreshToken?: boolean;
+    /**
+     * Opt-in redirect matching for dev clients. Exact registered URIs always match; this adds
+     * variants of registered URIs, never arbitrary URIs. Default: exact match only.
+     */
+    redirectPolicy?: RedirectPolicy;
     /** Apple developer/app grouping or OIDC pairwise identity sector. */
     subjectGroup?: string;
     /** Verify an Apple ES256 client-secret JWT instead of a static fixture secret. */

package/dist/server.js

@@ -3,8 +3,8 @@ import {
   createMultiServer,
   createServer,
   serveTarget
-} from "./chunk-OYEO5VHR.js";
-import "./chunk-ANDSQ2HK.js";
+} from "./chunk-AAKIJOPV.js";
+import "./chunk-VAXKCT3L.js";
 export {
   DEFAULT_PORT,
   createMultiServer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-oauth",
-  "version": "3.6.0",
+  "version": "3.8.0",
   "description": "Social-login emulator with Google, Apple, Microsoft, GitHub and generic OIDC profiles, private relay identities, reproducible edge cases, signed tokens and an accessible UI.",
   "license": "MIT",
   "type": "module",