@dereekb/dbx-cli 13.11.10 → 13.11.12

package/test/index.esm.js

@@ -0,0 +1,377 @@
+import { vi } from 'vitest';
+import { createCliContext, createCli } from '@dereekb/dbx-cli';
+
+function _array_like_to_array(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _array_without_holes(arr) {
+    if (Array.isArray(arr)) return _array_like_to_array(arr);
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _instanceof(left, right) {
+    "@swc/helpers - instanceof";
+    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
+        return !!right[Symbol.hasInstance](left);
+    } else {
+        return left instanceof right;
+    }
+}
+function _iterable_to_array(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+function _non_iterable_spread() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _to_consumable_array(arr) {
+    return _array_without_holes(arr) || _iterable_to_array(arr) || _unsupported_iterable_to_array(arr) || _non_iterable_spread();
+}
+function _type_of(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+}
+function _unsupported_iterable_to_array(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _array_like_to_array(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array(o, minLen);
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    }, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype), d = Object.defineProperty;
+    return d(g, "next", {
+        value: verb(0)
+    }), d(g, "throw", {
+        value: verb(1)
+    }), d(g, "return", {
+        value: verb(2)
+    }), typeof Symbol === "function" && d(g, Symbol.iterator, {
+        value: function() {
+            return this;
+        }
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(g && (g = 0, op[0] && (_ = 0)), _)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+/**
+ * Builds a {@link CliContext} for use as `testCliContext` on {@link createCli}.
+ *
+ * Thin wrapper around {@link createCliContext} that exists so test code can import from a single
+ * test-only entry without pulling in production-only types.
+ *
+ * @param input - The context inputs (cliName, envName, env, accessToken, optional modelManifest).
+ * @returns The constructed {@link CliContext} that drives `callModel` / `getModel` / `getMultipleModels`
+ *   against `input.env.apiBaseUrl` with `input.accessToken` as the Bearer token.
+ * @__NO_SIDE_EFFECTS__
+ */ function buildTestCliContext(input) {
+    return createCliContext({
+        cliName: input.cliName,
+        envName: input.envName,
+        env: input.env,
+        accessToken: input.accessToken,
+        modelManifest: input.modelManifest
+    });
+}
+/**
+ * Drives a CLI invocation in-process and captures all output.
+ *
+ * Creates a fresh yargs `Argv` per call (so middleware/option defaults can't leak across tests),
+ * parses `args`, and collects `process.stdout.write` / `process.stderr.write` / `console.log` /
+ * `console.error` output via `vi.spyOn`. The spies are always restored on completion.
+ *
+ * Always resolves — handler errors and yargs failures are surfaced in {@link RunCliCommandResult.error}
+ * instead of being thrown.
+ *
+ * @param input - The {@link CreateCliInput} used to build the CLI for this invocation. Pass a fresh
+ *   object each call (or rely on the caller-side factory) — yargs `Argv` state is not reused across
+ *   invocations.
+ * @param args - The argv vector to parse (e.g. `['get', 'p/abc']`).
+ * @returns The captured output envelope.
+ */ function runCliCommand(input, args) {
+    return _async_to_generator(function() {
+        var stdoutChunks, stderrChunks, writeSpy, errSpy, logSpy, errLogSpy, capturedExitCode, exitSentinel, exitSpy, capturedArgv, capturedError, helpOutput, e, result;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    stdoutChunks = [];
+                    stderrChunks = [];
+                    writeSpy = vi.spyOn(process.stdout, 'write').mockImplementation(function(chunk) {
+                        stdoutChunks.push(toChunkString(chunk));
+                        return true;
+                    });
+                    errSpy = vi.spyOn(process.stderr, 'write').mockImplementation(function(chunk) {
+                        stderrChunks.push(toChunkString(chunk));
+                        return true;
+                    });
+                    logSpy = vi.spyOn(console, 'log').mockImplementation(function() {
+                        for(var _len = arguments.length, parts = new Array(_len), _key = 0; _key < _len; _key++){
+                            parts[_key] = arguments[_key];
+                        }
+                        stdoutChunks.push(parts.map(function(p) {
+                            return stringifyConsolePart(p);
+                        }).join(' ') + '\n');
+                    });
+                    errLogSpy = vi.spyOn(console, 'error').mockImplementation(function() {
+                        for(var _len = arguments.length, parts = new Array(_len), _key = 0; _key < _len; _key++){
+                            parts[_key] = arguments[_key];
+                        }
+                        stderrChunks.push(parts.map(function(p) {
+                            return stringifyConsolePart(p);
+                        }).join(' ') + '\n');
+                    });
+                    exitSentinel = new Error('__cli_test_process_exit__');
+                    exitSpy = vi.spyOn(process, 'exit').mockImplementation(function(code) {
+                        capturedExitCode = typeof code === 'number' ? code : 0;
+                        throw exitSentinel;
+                    });
+                    helpOutput = '';
+                    _state.label = 1;
+                case 1:
+                    _state.trys.push([
+                        1,
+                        3,
+                        4,
+                        5
+                    ]);
+                    return [
+                        4,
+                        createCli(input).exitProcess(false).parse(_to_consumable_array(args), function(err, argv, output) {
+                            capturedArgv = argv;
+                            if (err) capturedError = err;
+                            helpOutput = output;
+                        })
+                    ];
+                case 2:
+                    _state.sent();
+                    return [
+                        3,
+                        5
+                    ];
+                case 3:
+                    e = _state.sent();
+                    if (e !== exitSentinel) {
+                        capturedError = _instanceof(e, Error) ? e : new Error(String(e));
+                    }
+                    return [
+                        3,
+                        5
+                    ];
+                case 4:
+                    writeSpy.mockRestore();
+                    errSpy.mockRestore();
+                    logSpy.mockRestore();
+                    errLogSpy.mockRestore();
+                    exitSpy.mockRestore();
+                    return [
+                        7
+                    ];
+                case 5:
+                    result = {
+                        stdout: stdoutChunks,
+                        stderr: stderrChunks,
+                        stdoutText: stdoutChunks.join(''),
+                        stderrText: stderrChunks.join(''),
+                        argv: capturedArgv,
+                        helpOutput: helpOutput,
+                        error: capturedError,
+                        exitCode: capturedExitCode
+                    };
+                    return [
+                        2,
+                        result
+                    ];
+            }
+        });
+    })();
+}
+/**
+ * Idempotently binds the fixture's NestJS application to `127.0.0.1:0` (or the supplied host) and
+ * returns the live `apiBaseUrl` so the CLI's `fetch` calls have a real socket to hit.
+ *
+ * Safe to call multiple times against the same app — when `app.getHttpServer().listening` is true,
+ * skips re-binding and just resolves the current address.
+ *
+ * The caller does NOT need to `.close()` explicitly: the demoApi/firebase-admin-nest fixture closes
+ * the underlying NestJS app at the end of its describe block, which closes the HTTP listener.
+ *
+ * @param input - The fixture app + optional global route prefix (defaults to `'api'` to match
+ *   demo-api's production prefix) and host (defaults to `127.0.0.1`).
+ * @returns The bound `apiBaseUrl` (e.g. `http://127.0.0.1:54321/api`) and the resolved port.
+ */ function listenOnNestAppForTest(input) {
+    return _async_to_generator(function() {
+        var _input_host, _input_apiPrefix, host, prefix, server, address, port, trimmedPrefix, apiBaseUrl;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    host = (_input_host = input.host) !== null && _input_host !== void 0 ? _input_host : '127.0.0.1';
+                    prefix = (_input_apiPrefix = input.apiPrefix) !== null && _input_apiPrefix !== void 0 ? _input_apiPrefix : 'api';
+                    server = input.app.getHttpServer();
+                    if (!!server.listening) return [
+                        3,
+                        2
+                    ];
+                    return [
+                        4,
+                        input.app.listen(0, host)
+                    ];
+                case 1:
+                    _state.sent();
+                    _state.label = 2;
+                case 2:
+                    address = server.address();
+                    port = (typeof address === "undefined" ? "undefined" : _type_of(address)) === 'object' && address ? address.port : 0;
+                    trimmedPrefix = prefix.replace(/^\/+|\/+$/g, '');
+                    apiBaseUrl = trimmedPrefix.length > 0 ? "http://".concat(host, ":").concat(port, "/").concat(trimmedPrefix) : "http://".concat(host, ":").concat(port);
+                    return [
+                        2,
+                        {
+                            apiBaseUrl: apiBaseUrl,
+                            port: port
+                        }
+                    ];
+            }
+        });
+    })();
+}
+function toChunkString(chunk) {
+    var result;
+    if (typeof chunk === 'string') {
+        result = chunk;
+    } else if (_instanceof(chunk, Uint8Array)) {
+        result = Buffer.from(chunk).toString('utf8');
+    } else {
+        result = String(chunk);
+    }
+    return result;
+}
+function stringifyConsolePart(part) {
+    var result;
+    if (typeof part === 'string') {
+        result = part;
+    } else if (_instanceof(part, Error)) {
+        var _part_stack;
+        result = (_part_stack = part.stack) !== null && _part_stack !== void 0 ? _part_stack : part.message;
+    } else {
+        try {
+            result = JSON.stringify(part);
+        } catch (unused) {
+            result = String(part);
+        }
+    }
+    return result;
+}
+
+export { buildTestCliContext, listenOnNestAppForTest, runCliCommand };

package/test/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dereekb/dbx-cli/test",
+  "version": "13.11.12",
+  "peerDependencies": {
+    "@dereekb/date": "13.11.12",
+    "@dereekb/dbx-cli": "13.11.12",
+    "@dereekb/firebase": "13.11.12",
+    "@dereekb/firebase-server/test": "13.11.12",
+    "@dereekb/model": "13.11.12",
+    "@dereekb/nestjs": "13.11.12",
+    "@dereekb/rxjs": "13.11.12",
+    "@dereekb/util": "13.11.12",
+    "@nestjs/common": "^11.1.19",
+    "arktype": "^2.2.0",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {},
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.d.ts"
+}

package/test/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/test/src/lib/cli-test.d.ts

@@ -0,0 +1,101 @@
+import { type INestApplication } from '@nestjs/common';
+import { type CliContext, type CliEnvConfig, type CliModelManifest, type CreateCliInput } from '@dereekb/dbx-cli';
+/**
+ * Input for {@link buildTestCliContext}.
+ */
+export interface BuildTestCliContextInput {
+    readonly cliName: string;
+    readonly envName: string;
+    readonly env: CliEnvConfig;
+    readonly accessToken: string;
+    readonly modelManifest?: CliModelManifest;
+}
+/**
+ * Builds a {@link CliContext} for use as `testCliContext` on {@link createCli}.
+ *
+ * Thin wrapper around {@link createCliContext} that exists so test code can import from a single
+ * test-only entry without pulling in production-only types.
+ *
+ * @param input - The context inputs (cliName, envName, env, accessToken, optional modelManifest).
+ * @returns The constructed {@link CliContext} that drives `callModel` / `getModel` / `getMultipleModels`
+ *   against `input.env.apiBaseUrl` with `input.accessToken` as the Bearer token.
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function buildTestCliContext(input: BuildTestCliContextInput): CliContext;
+/**
+ * Result envelope returned by {@link runCliCommand}.
+ *
+ * Captures everything tests typically want to assert on: stdout/stderr chunks, the parsed argv,
+ * yargs's help output (if any), any handler error, and the exit code if the handler called
+ * `process.exit` (which is intercepted so it does not actually terminate vitest).
+ *
+ * {@link runCliCommand} always resolves — errors come back in {@link RunCliCommandResult.error}
+ * and exit attempts in {@link RunCliCommandResult.exitCode} so tests can assert on error envelopes
+ * without try/catch boilerplate.
+ */
+export interface RunCliCommandResult {
+    readonly stdout: readonly string[];
+    readonly stderr: readonly string[];
+    readonly stdoutText: string;
+    readonly stderrText: string;
+    readonly argv: unknown;
+    readonly helpOutput: string;
+    readonly error?: Error;
+    /**
+     * Set when the CLI's handler called `process.exit(code)`. Captured (so the test process is not
+     * killed) and surfaced here so tests can assert on the intended exit status.
+     *
+     * Production CLI handlers exit with `1` on CliError (via `wrapCommandHandler`) and `4` on auth
+     * middleware failures. With the `testCliContext` override the auth middleware never exits, but
+     * handler errors still go through `wrapCommandHandler`.
+     */
+    readonly exitCode?: number;
+}
+/**
+ * Drives a CLI invocation in-process and captures all output.
+ *
+ * Creates a fresh yargs `Argv` per call (so middleware/option defaults can't leak across tests),
+ * parses `args`, and collects `process.stdout.write` / `process.stderr.write` / `console.log` /
+ * `console.error` output via `vi.spyOn`. The spies are always restored on completion.
+ *
+ * Always resolves — handler errors and yargs failures are surfaced in {@link RunCliCommandResult.error}
+ * instead of being thrown.
+ *
+ * @param input - The {@link CreateCliInput} used to build the CLI for this invocation. Pass a fresh
+ *   object each call (or rely on the caller-side factory) — yargs `Argv` state is not reused across
+ *   invocations.
+ * @param args - The argv vector to parse (e.g. `['get', 'p/abc']`).
+ * @returns The captured output envelope.
+ */
+export declare function runCliCommand(input: CreateCliInput, args: readonly string[]): Promise<RunCliCommandResult>;
+/**
+ * Idempotently binds the fixture's NestJS application to `127.0.0.1:0` (or the supplied host) and
+ * returns the live `apiBaseUrl` so the CLI's `fetch` calls have a real socket to hit.
+ *
+ * Safe to call multiple times against the same app — when `app.getHttpServer().listening` is true,
+ * skips re-binding and just resolves the current address.
+ *
+ * The caller does NOT need to `.close()` explicitly: the demoApi/firebase-admin-nest fixture closes
+ * the underlying NestJS app at the end of its describe block, which closes the HTTP listener.
+ *
+ * @param input - The fixture app + optional global route prefix (defaults to `'api'` to match
+ *   demo-api's production prefix) and host (defaults to `127.0.0.1`).
+ * @returns The bound `apiBaseUrl` (e.g. `http://127.0.0.1:54321/api`) and the resolved port.
+ */
+export declare function listenOnNestAppForTest(input: ListenOnNestAppForTestInput): Promise<ListenOnNestAppForTestResult>;
+export interface ListenOnNestAppForTestInput {
+    readonly app: INestApplication;
+    /**
+     * Global route prefix the NestJS app is mounted under. Defaults to `'api'` to match the demo-api
+     * production configuration. Pass an empty string to skip the prefix.
+     */
+    readonly apiPrefix?: string;
+    /**
+     * Host to bind to. Defaults to `127.0.0.1`.
+     */
+    readonly host?: string;
+}
+export interface ListenOnNestAppForTestResult {
+    readonly apiBaseUrl: string;
+    readonly port: number;
+}

package/test/src/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './cli-test';