@schmock/cli 2.4.0 → 2.5.0

package/dist/admin.d.ts

@@ -0,0 +1,41 @@
+import type * as Schmock from "@schmock/core";
+import type { HeaderSource } from "./cors.js";
+import type { CliOptions } from "./types.js";
+/**
+ * Requests retained for `GET /schmock-admin/history` when
+ * `--admin-history-limit` is not given. Core's own `maxHistorySize` defaults
+ * to unbounded, which a server left running all day cannot afford.
+ */
+export declare const DEFAULT_ADMIN_HISTORY_LIMIT = 500;
+/**
+ * Whether a request targets the admin surface. Kept as one predicate because
+ * two sites depend on the same answer: the CORS decisions (the preflight
+ * short-circuit and the extra headers, which must *not* apply to admin paths)
+ * and admin dispatch itself.
+ */
+export declare function isAdminPath(admin: boolean, path: string): boolean;
+export interface AdminRequest {
+    /** The raw request, for the `Origin` check and the presented token. */
+    readonly req: HeaderSource;
+    readonly method: Schmock.HttpMethod;
+    readonly path: string;
+    readonly mock: Schmock.CallableMockInstance;
+    /** The token every admin request must present; see `resolveAdminToken`. */
+    readonly adminToken: string | undefined;
+}
+/**
+ * Answer a request on the admin surface ({@link isAdminPath}): a refusal
+ * unless it presents the admin token without an `Origin`, otherwise the
+ * endpoint's answer. Throws only when the mock's routes or state cannot be
+ * serialized.
+ */
+export declare function answerAdminRequest(request: AdminRequest): Schmock.Response;
+export declare function isUsableAdminToken(value: string): boolean;
+/**
+ * Settle the admin token once, at the outermost entry point, so every later
+ * consumer (listen, reload, the printed banner) sees the same value.
+ *
+ * @throws SchmockError `INVALID_CONFIG` for an empty token or one containing
+ *   whitespace
+ */
+export declare function resolveAdminToken(options: CliOptions): string | undefined;

package/dist/args.d.ts

@@ -0,0 +1,17 @@
+import type { CliOptions } from "./types.js";
+/**
+ * Loopback binds are `127.0.0.0/8` (also IPv4-mapped, `::ffff:127.x.x.x`),
+ * `::1` and `localhost`; everything else is reachable off-box.
+ */
+export declare function isLoopbackHost(hostname: string): boolean;
+/**
+ * Parse `schmock` command-line arguments into {@link CliOptions}.
+ *
+ * @throws SchmockError `INVALID_CONFIG` for a flag value the CLI refuses, a
+ *   second positional argument, or `--admin-token` without `--admin`. An
+ *   unknown flag throws Node's own `parseArgs` error.
+ */
+export declare function parseCliArgs(args: string[]): CliOptions & {
+    help: boolean;
+};
+export declare const USAGE = "Usage: schmock <spec> [options]\n       schmock --spec <path> [options]\n\nOptions:\n  --spec <path>       OpenAPI/Swagger spec file (or pass as first argument)\n  --port <number>     Port to listen on (default: 3000)\n  --hostname <host>   Hostname to bind to (default: 127.0.0.1)\n  --seed <path>       JSON file with seed data\n  --cors              Enable CORS for mock responses (never for /schmock-admin/*)\n  --debug             Enable debug logging\n  --errors            Enable request body validation against spec\n  --watch             Watch spec file and hot-reload on changes\n  --admin             Enable /schmock-admin/* introspection endpoints\n  --admin-token <token>\n                      Bearer token required by /schmock-admin/*. Generated and\n                      printed to stderr when --admin is set without it.\n  --admin-history-limit <n>\n                      Requests retained for /schmock-admin/history (default: 500).\n                      Without --admin no history is retained at all.\n  --strict            Validate the spec against the OpenAPI schema at startup\n  --refs-external     Resolve $refs to files outside the spec document\n  --refs-allow-http <hosts>\n                      Also resolve http(s) $refs, limited to this comma-separated\n                      host list (empty list = any public host). Requires\n                      --refs-external.\n  --seed-random <n>   Seed for deterministic random generation\n  -h, --help          Show this help message\n";

package/dist/bin.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env node
 export {};
-//# sourceMappingURL=bin.d.ts.map