@schmock/cli 2.3.0 → 2.4.0

package/dist/cli.d.ts

@@ -1,4 +1,5 @@
 import type { Server } from "node:http";
+import type * as Schmock from "@schmock/core";
 export interface CliOptions {
     spec: string;
     port?: number;
@@ -10,28 +11,64 @@ export interface CliOptions {
     errors?: boolean;
     watch?: boolean;
     admin?: boolean;
+    /**
+     * Bearer token required by every `/schmock-admin/*` request (`--admin-token`).
+     * When `admin` is on and this is omitted, a random token is minted once and
+     * surfaced on {@link CliServer.adminToken}.
+     */
+    adminToken?: string;
+    /**
+     * How many requests the mock retains for `GET /schmock-admin/history`
+     * (`--admin-history-limit`, default 500). Ignored — history is disabled
+     * entirely — when `admin` is off.
+     */
+    adminHistoryLimit?: number;
+    /** Validate the spec against the OpenAPI schema at startup (`--strict`). */
+    strict?: boolean;
+    /** Resolve `$ref`s outside the spec document (`--refs-external`). */
+    refsExternal?: boolean;
+    /**
+     * Hosts an `http(s)` `$ref` may target (`--refs-allow-http`). Supplying this
+     * also enables http resolution, which still requires `refsExternal`.
+     */
+    refsAllowHttp?: string[];
+    /**
+     * How long {@link CliServer.close} waits for in-flight requests before the
+     * remaining sockets are destroyed (default 5000 ms). A half-sent request
+     * never completes on its own, so without a bound the close would hang.
+     */
+    shutdownGraceMs?: number;
 }
 export interface CliServer {
     server: Server;
     port: number;
     hostname: string;
-    close(): void;
+    /**
+     * The bearer token this server requires on `/schmock-admin/*`. Present only
+     * when admin is enabled; supply it as `Authorization: Bearer <token>`.
+     */
+    adminToken?: string;
+    /**
+     * Stop watching, stop accepting, and settle once the socket is released —
+     * within {@link CliOptions.shutdownGraceMs}. Memoized: every call observes
+     * the same shutdown, so closing twice is safe and resolves twice.
+     */
+    close(): Promise<void>;
 }
+/**
+ * Read a `--seed` manifest.
+ *
+ * Every entry shape is checked explicitly and anything unrecognised throws:
+ * silently dropping a malformed entry used to start a server whose collections
+ * were quietly empty. File entries resolve relative to the manifest rather than
+ * the process CWD, and may not escape the manifest directory.
+ */
+export declare function loadSeedFile(seedPath: string): Schmock.SeedConfig;
 export declare function createCliServer(options: CliOptions): Promise<CliServer>;
+/** Loopback binds are `127.0.0.0/8`, `::1` and `localhost`; everything else is reachable off-box. */
+export declare function isLoopbackHost(hostname: string): boolean;
 export declare function parseCliArgs(args: string[]): CliOptions & {
     help: boolean;
 };
-export interface WatchHandle {
-    close(): void;
-}
-/**
- * Prepare a replacement before closing the live server, then bind it to the
- * same port. Invalid spec changes therefore leave the current server online.
- */
-export declare function reloadServer(current: CliServer, options: CliOptions): Promise<CliServer>;
-/**
- * Watch a spec file and hot-reload the server on changes.
- */
-export declare function startWatch(specPath: string, options: CliOptions, getCurrentServer: () => CliServer, onReload: (server: CliServer) => void): WatchHandle;
 export declare function run(args: string[]): Promise<void>;
 //# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAkB,MAAM,WAAW,CAAC;AAcxD,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,IAAI,IAAI,CAAC;CACf;AA6QD,wBAAsB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAG7E;AAYD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAqC3E;AAqBD,MAAM,WAAW,WAAW;IAC1B,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,SAAS,CAAC,CAWpB;AAED;;GAEG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,EACnB,gBAAgB,EAAE,MAAM,SAAS,EACjC,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,GACpC,WAAW,CAqCb;AAED,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiDvD"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAkB,MAAM,WAAW,CAAC;AAWxD,OAAO,KAAK,KAAK,OAAO,MAAM,eAAe,CAAC;AAgB9C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4EAA4E;IAC5E,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qEAAqE;IACrE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AA6ID;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAwCjE;AA4jBD,wBAAsB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAsB7E;AAED,qGAAqG;AACrG,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CASxD;AAqED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CA2D3E;AAwKD,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAyFvD"}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export type { CliOptions, CliServer } from "./cli.js";
-export { createCliServer, parseCliArgs, run } from "./cli.js";
+export { createCliServer, loadSeedFile, parseCliArgs, run } from "./cli.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}