@c9up/ream 0.1.26 → 0.1.27

package/dist/services/console.js

@@ -0,0 +1,35 @@
+/**
+ * Console singleton service.
+ *
+ * Usage:
+ *   import consoleApp from '@c9up/ream/services/console'
+ *   if (await consoleApp.hasCommand('make:controller')) {
+ *     const command = await consoleApp.exec('make:controller', ['user', '--resource'])
+ *   }
+ */
+let instance;
+/** @internal Set the consoleApp instance (called by Ignitor). */
+export function setConsole(consoleApp) {
+    instance = consoleApp;
+}
+/**
+ * @internal Unset the locator IF it still points at `consoleApp` (called by
+ * Ignitor.stop()) — same ownership guard as the app service: a second Ignitor
+ * rebinding the locator must not be torn down by the first one stopping.
+ */
+export function clearConsole(consoleApp) {
+    if (instance === consoleApp)
+        instance = undefined;
+}
+const consoleApp = new Proxy({}, {
+    get(_target, prop) {
+        if (!instance) {
+            throw new Error('Console accessed before initialization. ' +
+                'Ensure this code runs during or after the boot phase.');
+        }
+        const value = Reflect.get(instance, prop, instance);
+        return typeof value === 'function' ? value.bind(instance) : value;
+    },
+});
+export default consoleApp;
+//# sourceMappingURL=console.js.map

package/dist/services/console.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.js","sourceRoot":"","sources":["../../src/services/console.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,IAAI,QAA6B,CAAA;AAEjC,iEAAiE;AACjE,MAAM,UAAU,UAAU,CAAC,UAAmB;IAC5C,QAAQ,GAAG,UAAU,CAAA;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,UAAmB;IAC9C,IAAI,QAAQ,KAAK,UAAU;QAAE,QAAQ,GAAG,SAAS,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,GAAY,IAAI,KAAK,CAAC,EAAa,EAAE;IACnD,GAAG,CAAC,OAAO,EAAE,IAAI;QACf,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CACb,0CAA0C;gBACxC,uDAAuD,CAC1D,CAAA;QACH,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;QACnD,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IACnE,CAAC;CACF,CAAC,CAAA;AAEF,eAAe,UAAU,CAAA"}

package/dist/testing/ApiResponse.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Rich HTTP test response — `@japa/api-client`'s `ApiResponse` parity.
+ *
+ * Wraps the raw {@link TestResponse} and exposes the full Japa response surface:
+ * accessor METHODS (`status()`, `headers()`, `body()`, `text()`, `header()`,
+ * `cookies()`, `redirects()`, `error()`, …) matching Japa exactly, the complete
+ * `assert*` family, response `dump*()` debuggers, and `macro()`/`getter()` for
+ * consumer extension.
+ *
+ * `json()` is kept as an additive convenience (not in Japa, but harmless for
+ * parity — Japa code never calls it) so `res.json()` call sites need no change.
+ */
+import type { Dict } from '../types/helpers.js';
+/** The raw response shape the low-level sender produces. */
+export interface TestResponse {
+    status: number;
+    headers: Dict;
+    body: string;
+    json<T = unknown>(): T;
+}
+/** Assertion failure — plain Error so tests see a clean stack trace. */
+export declare class ExpectationError extends Error {
+    constructor(message: string);
+}
+export declare function capBody(s: string, max?: number): string;
+/** Narrowing guard — a non-null, non-array object usable as a string map. */
+export declare function isRecord(x: unknown): x is Record<string, unknown>;
+/** Exact structural equality (order-insensitive object keys) for `assertBody`. */
+export declare function deepEqual(a: unknown, b: unknown): boolean;
+/**
+ * Partial deep-match. For objects, every key in `expected` must match in
+ * `actual`. For arrays, every element in `expected` must match SOMEWHERE in
+ * `actual` (order-independent). Primitives compared by strict equality.
+ */
+export declare function partialMatch(actual: unknown, expected: unknown): boolean;
+/** A parsed response cookie — `name` + `value` plus any attributes present. */
+export interface ResponseCookie {
+    name: string;
+    value: string;
+    [attr: string]: string;
+}
+/** A file parsed from a `multipart/form-data` response — Japa `files()` entry. */
+export interface ResponseFile {
+    /** The form field name. */
+    fieldName: string;
+    /** The advertised filename. */
+    filename: string;
+    /** The part's `Content-Type`. */
+    type: string;
+    /** Byte length of the file content. */
+    size: number;
+    /** The raw file bytes. */
+    content: Buffer;
+}
+/** The Japa error object returned by `response.error()`. */
+export interface ResponseError {
+    /** The error status code (>= 400). */
+    status: number;
+    /** The response text. */
+    text: string;
+}
+/** Extra context the builder threads into the response. */
+export interface ApiResponseMeta {
+    /** The (final) request method — Japa `response.method()`. */
+    method?: string;
+    /** URLs followed when redirects were configured — Japa `response.redirects()`. */
+    redirects?: string[];
+}
+/**
+ * Every Japa status-shortcut assertion, as `methodName → code`. Consumed to
+ * generate the `assert*` methods on both {@link ApiResponse} and the builder,
+ * so the two surfaces never drift.
+ */
+export declare const STATUS_ASSERTIONS: {
+    readonly assertOk: 200;
+    readonly assertCreated: 201;
+    readonly assertAccepted: 202;
+    readonly assertNoContent: 204;
+    readonly assertMovedPermanently: 301;
+    readonly assertFound: 302;
+    readonly assertBadRequest: 400;
+    readonly assertUnauthorized: 401;
+    readonly assertPaymentRequired: 402;
+    readonly assertForbidden: 403;
+    readonly assertNotFound: 404;
+    readonly assertMethodNotAllowed: 405;
+    readonly assertNotAcceptable: 406;
+    readonly assertRequestTimeout: 408;
+    readonly assertConflict: 409;
+    readonly assertGone: 410;
+    readonly assertLengthRequired: 411;
+    readonly assertPreconditionFailed: 412;
+    readonly assertPayloadTooLarge: 413;
+    readonly assertURITooLong: 414;
+    readonly assertUnsupportedMediaType: 415;
+    readonly assertRangeNotSatisfiable: 416;
+    readonly assertImATeapot: 418;
+    readonly assertUnprocessableEntity: 422;
+    readonly assertLocked: 423;
+    readonly assertTooManyRequests: 429;
+    /** ream extra (not in Japa's list, kept for convenience). */
+    readonly assertInternalServerError: 500;
+};
+/**
+ * The rich response. Constructed by the request builder from a raw
+ * {@link TestResponse}; exposes the Japa accessor + assertion surface.
+ *
+ * PARITY NOTE: the status code / headers / raw text are METHODS — `status()`,
+ * `headers()`, `text()` — and `body()` returns the content-type-parsed body,
+ * exactly like Japa. `json()` is kept as an additive convenience.
+ */
+export declare class ApiResponse {
+    #private;
+    constructor(raw: TestResponse, meta?: ApiResponseMeta);
+    /** HTTP status code — Japa `status()`. */
+    status(): number;
+    /** Status class digit (2 for 2xx, 4 for 4xx, …) — Japa `statusType()`. */
+    statusType(): number;
+    /** All response headers (lower-cased keys) — Japa `headers()`. */
+    headers(): Dict;
+    /** A single response header value — Japa `header(name)`. */
+    header(name: string): string | undefined;
+    /** Raw response text — Japa `text()`. */
+    text(): string;
+    /**
+     * The parsed response body — Japa `body()`. Parses by `Content-Type`:
+     * `application/json` → object, `application/x-www-form-urlencoded` → object,
+     * `multipart/form-data` → the non-file fields (files come from {@link files});
+     * otherwise the raw text. A registered parser (`ApiResponse.addParser`) for the
+     * content-type takes precedence.
+     */
+    body(): unknown;
+    /** Convenience JSON parse (additive; not in Japa). */
+    json<T = unknown>(): T;
+    /** The request method that produced this response — Japa `method()`. */
+    method(): string;
+    /** Response `Content-Type` without parameters — Japa `type()`. */
+    type(): string | undefined;
+    /** Charset from `Content-Type`, if any — Japa `charset()`. */
+    charset(): string | undefined;
+    /** All response cookies, parsed from `Set-Cookie` — Japa `cookies()`. */
+    cookies(): Record<string, ResponseCookie>;
+    /** A single parsed response cookie — Japa `cookie(name)`. */
+    cookie(name: string): ResponseCookie | undefined;
+    /** URLs followed for a redirected request — Japa `redirects()`. */
+    redirects(): string[];
+    /** Parsed `Link` header (`rel → url`) — Japa `links()`. */
+    links(): Record<string, string>;
+    /**
+     * Files parsed from a `multipart/form-data` response — Japa `files()`. Each
+     * entry carries the field name, filename, content-type and the raw bytes.
+     * Empty for non-multipart responses.
+     */
+    files(): Record<string, ResponseFile>;
+    /** Whether the response carries a body — Japa `hasBody()`. */
+    hasBody(): boolean;
+    /** Whether the status is an error (>= 400) — Japa `hasError()`. */
+    hasError(): boolean;
+    /** Whether the status is a server error (>= 500) — Japa `hasFatalError()`. */
+    hasFatalError(): boolean;
+    /**
+     * The error object when the response is an error, else `undefined` — Japa
+     * `error()`. Exposes `.status` and `.text` (superagent-style).
+     */
+    error(): ResponseError | undefined;
+    /** Print status + headers + body to stderr — Japa `response.dump()`. */
+    dump(): this;
+    /** Print only the response body — Japa `response.dumpBody()`. */
+    dumpBody(): this;
+    /** Print only the response headers — Japa `response.dumpHeaders()`. */
+    dumpHeaders(): this;
+    /** Print only the response cookies — Japa `response.dumpCookies()`. */
+    dumpCookies(): this;
+    /** Print the error object, if any — Japa `response.dumpError()`. */
+    dumpError(): this;
+    assertStatus(code: number): this;
+    assertHeader(name: string, value?: string | RegExp): this;
+    assertHeaderMissing(name: string): this;
+    assertCookie(name: string, value?: string | RegExp): this;
+    assertCookieMissing(name: string): this;
+    assertBody(expected: unknown): this;
+    assertBodyContains(subset: unknown): this;
+    assertBodyNotContains(subset: unknown): this;
+    assertTextIncludes(substring: string): this;
+    /**
+     * Assert the request was redirected to `path` — Japa `assertRedirectsTo`.
+     * Checks the followed redirect chain (`redirects()`); also accepts a direct
+     * 3xx `Location` match when no redirects were followed.
+     */
+    assertRedirectsTo(path: string): this;
+    /**
+     * Assert the response conforms to the registered OpenAPI spec — Japa
+     * `assertAgainstApiSpec()`. Japa ships this via the SEPARATE opt-in
+     * `@japa/openapi-assertions` plugin; register a validator with
+     * {@link ApiResponse.registerApiSpecValidator} to enable it. Without one, this
+     * throws (never silently passes).
+     */
+    assertAgainstApiSpec(): this;
+    /**
+     * Register a shared property (Japa `ApiResponse.macro`) or lazy getter
+     * (`ApiResponse.getter`). The callback is invoked with `this` bound to the
+     * response AND the response as its first argument, so both Japa's
+     * `function () { return this.header('x') }` and `(res) => res.header('x')` work.
+     */
+    static macro(name: string, value: unknown): void;
+    static getter(name: string, fn: (this: ApiResponse, res: ApiResponse) => unknown): void;
+    /** Register a response body parser for a content-type — Japa `ApiRequest.addParser`. */
+    static addParser(contentType: string, fn: (body: string, headers: Dict) => unknown): void;
+    /** Register the validator backing {@link assertAgainstApiSpec} (OpenAPI opt-in). */
+    static registerApiSpecValidator(fn: (res: ApiResponse) => void): void;
+}
+/** The status-shortcut assertion methods, typed onto ApiResponse + the builder. */
+export type StatusAssertions<T> = {
+    [K in keyof typeof STATUS_ASSERTIONS]: () => T;
+};
+export interface ApiResponse extends StatusAssertions<ApiResponse> {
+}
+//# sourceMappingURL=ApiResponse.d.ts.map

package/dist/testing/ApiResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiResponse.d.ts","sourceRoot":"","sources":["../../src/testing/ApiResponse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAE/C,4DAA4D;AAC5D,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,IAAI,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,CAAC,GAAG,OAAO,KAAK,CAAC,CAAA;CACvB;AAED,wEAAwE;AACxE,qBAAa,gBAAiB,SAAQ,KAAK;gBAC7B,OAAO,EAAE,MAAM;CAI5B;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,SAAM,GAAG,MAAM,CAEpD;AAED,6EAA6E;AAC7E,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEjE;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAczD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAcxE;AAOD,+EAA+E;AAC/E,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAuBD,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAA;CAChB;AAqFD,4DAA4D;AAC5D,MAAM,WAAW,aAAa;IAC5B,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,2DAA2D;AAC3D,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2B5B,6DAA6D;;CAErD,CAAA;AAMV;;;;;;;GAOG;AAEH,qBAAa,WAAW;;gBAKV,GAAG,EAAE,YAAY,EAAE,IAAI,GAAE,eAAoB;IASzD,0CAA0C;IAC1C,MAAM,IAAI,MAAM;IAIhB,0EAA0E;IAC1E,UAAU,IAAI,MAAM;IAIpB,kEAAkE;IAClE,OAAO,IAAI,IAAI;IAIf,4DAA4D;IAC5D,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIxC,yCAAyC;IACzC,IAAI,IAAI,MAAM;IAId;;;;;;OAMG;IACH,IAAI,IAAI,OAAO;IAmBf,sDAAsD;IACtD,IAAI,CAAC,CAAC,GAAG,OAAO,KAAK,CAAC;IAItB,wEAAwE;IACxE,MAAM,IAAI,MAAM;IAIhB,kEAAkE;IAClE,IAAI,IAAI,MAAM,GAAG,SAAS;IAK1B,8DAA8D;IAC9D,OAAO,IAAI,MAAM,GAAG,SAAS;IAM7B,yEAAyE;IACzE,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC;IAIzC,6DAA6D;IAC7D,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIhD,mEAAmE;IACnE,SAAS,IAAI,MAAM,EAAE;IAIrB,2DAA2D;IAC3D,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAW/B;;;;OAIG;IACH,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAOrC,8DAA8D;IAC9D,OAAO,IAAI,OAAO;IAIlB,mEAAmE;IACnE,QAAQ,IAAI,OAAO;IAInB,8EAA8E;IAC9E,aAAa,IAAI,OAAO;IAIxB;;;OAGG;IACH,KAAK,IAAI,aAAa,GAAG,SAAS;IAOlC,wEAAwE;IACxE,IAAI,IAAI,IAAI;IAQZ,iEAAiE;IACjE,QAAQ,IAAI,IAAI;IAIhB,uEAAuE;IACvE,WAAW,IAAI,IAAI;IAMnB,uEAAuE;IACvE,WAAW,IAAI,IAAI;IAMnB,oEAAoE;IACpE,SAAS,IAAI,IAAI;IAOjB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAShC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAkBzD,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOvC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAoBzD,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAoBvC,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAUnC,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAUzC,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAU5C,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAS3C;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAoBrC;;;;;;OAMG;IACH,oBAAoB,IAAI,IAAI;IAW5B;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAGhD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,KAAK,OAAO,GAAG,IAAI;IAIvF,wFAAwF;IACxF,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,OAAO,GAAG,IAAI;IAIzF,oFAAoF;IACpF,MAAM,CAAC,wBAAwB,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,GAAG,IAAI;CAGtE;AAeD,mFAAmF;AACnF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;KAC/B,CAAC,IAAI,MAAM,OAAO,iBAAiB,GAAG,MAAM,CAAC;CAC/C,CAAA;AAID,MAAM,WAAW,WAAY,SAAQ,gBAAgB,CAAC,WAAW,CAAC;CAAG"}