@redocly/client-generator 0.0.0-snapshot.1784554531

package/lib/runtime/setup.js

@@ -0,0 +1,13 @@
+/**
+ * Merge a publisher's baked setup (`defineClientSetup({...})`) with the app's config:
+ * app config fields win per-field over baked defaults, while middleware composes —
+ * baked middleware runs first, then the app's.
+ */
+export function mergeSetup(setup, config = {}) {
+    return {
+        ...setup?.config,
+        ...config,
+        middleware: [...(setup?.middleware ?? []), ...(config.middleware ?? [])],
+    };
+}
+//# sourceMappingURL=setup.js.map

package/lib/runtime/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/runtime/setup.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,KAAuE,EACvE,SAAuB,EAAE;IAEzB,OAAO;QACL,GAAG,KAAK,EAAE,MAAM;QAChB,GAAG,MAAM;QACT,UAAU,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;KACzE,CAAC;AACJ,CAAC"}

package/lib/runtime/sse.d.ts

@@ -0,0 +1,21 @@
+import type { ClientConfig, OperationContext, ServerSentEvent, SseOptions } from './types.js';
+/**
+ * A terminally malformed event stream — unparseable JSON `data` or an unbounded frame.
+ * A stable bad payload, not a dropped connection, so the stream never reconnects on it.
+ */
+export declare class SseParseError extends Error {
+}
+/**
+ * Consume a `text/event-stream` operation as typed events (capability module — wired
+ * into `createClient`). Auto-reconnects on dropped connections, resuming from the last
+ * seen event id via `Last-Event-ID` (backoff: the server's `retry:` value, then
+ * `reconnectDelay`, then 1s — exponential with jitter, capped at 30s). A clean stream
+ * end flushes a trailing frame and finishes; `break`/abort end the iterator cleanly.
+ */
+export declare function sse<T>(config: ClientConfig, op: OperationContext, prepare: () => Promise<{
+    url: string;
+    init: SseOptions;
+}>, dataKind?: 'json' | 'text'): AsyncGenerator<ServerSentEvent<T>>;
+/** Parse one raw SSE frame (its lines) into an event; returns undefined for comment-only frames. */
+export declare function parseSseFrame(raw: string, dataKind: 'json' | 'text'): ServerSentEvent<unknown> | undefined;
+//# sourceMappingURL=sse.d.ts.map

package/lib/runtime/sse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.d.ts","sourceRoot":"","sources":["../../src/runtime/sse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ9F;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;CAAG;AAE3C;;;;;;GAMG;AACH,wBAAuB,GAAG,CAAC,CAAC,EAC1B,MAAM,EAAE,YAAY,EACpB,EAAE,EAAE,gBAAgB,EACpB,OAAO,EAAE,MAAM,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,EACzD,QAAQ,GAAE,MAAM,GAAG,MAAe,GACjC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CA8FpC;AAED,oGAAoG;AACpG,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,GAAG,MAAM,GACxB,eAAe,CAAC,OAAO,CAAC,GAAG,SAAS,CAkCtC"}

package/lib/runtime/sse.js

@@ -0,0 +1,163 @@
+import { ApiError } from './errors.js';
+import { readError } from './parse.js';
+import { sleep } from './retry.js';
+import { send, toHeaderRecord } from './send.js';
+/**
+ * A frame delimiter: two consecutive line terminators (each CR, LF, or CRLF, per the SSE
+ * spec — so mixed endings like `\n\r\n` are valid boundaries, not just matching pairs).
+ */
+const FRAME_DELIMITER = /(?:\r\n|\r|\n){2}/;
+/**
+ * A terminally malformed event stream — unparseable JSON `data` or an unbounded frame.
+ * A stable bad payload, not a dropped connection, so the stream never reconnects on it.
+ */
+export class SseParseError extends Error {
+}
+/**
+ * Consume a `text/event-stream` operation as typed events (capability module — wired
+ * into `createClient`). Auto-reconnects on dropped connections, resuming from the last
+ * seen event id via `Last-Event-ID` (backoff: the server's `retry:` value, then
+ * `reconnectDelay`, then 1s — exponential with jitter, capped at 30s). A clean stream
+ * end flushes a trailing frame and finishes; `break`/abort end the iterator cleanly.
+ */
+export async function* sse(config, op, prepare, dataKind = 'text') {
+    let lastEventId;
+    let serverRetry;
+    let failures = 0;
+    while (true) {
+        // Re-prepare each attempt so a refresh-style TokenProvider yields a fresh credential
+        // on reconnect (the auth is baked into `url` query + `init.headers`). `reconnect`,
+        // `reconnectDelay`, and `signal` come from the caller's original options unchanged.
+        const { url, init } = await prepare();
+        const { reconnect = true, reconnectDelay, ...rest } = init;
+        const signal = rest.signal ?? undefined;
+        if (signal?.aborted)
+            return;
+        const headers = {
+            Accept: 'text/event-stream',
+            ...toHeaderRecord(rest.headers),
+        };
+        const sendHeaders = lastEventId === undefined ? headers : { ...headers, 'Last-Event-ID': lastEventId };
+        try {
+            const { response } = await send(config, op, url, { ...rest, method: rest.method ?? 'GET', headers: sendHeaders }, undefined, false, {});
+            if (!response.ok) {
+                const errorBody = await readError(response);
+                throw new ApiError(url, response.status, response.statusText, errorBody);
+            }
+            failures = 0;
+            const body = response.body;
+            if (!body)
+                return;
+            const reader = body.getReader();
+            const decoder = new TextDecoder();
+            let buffer = '';
+            try {
+                while (true) {
+                    const { done, value } = await reader.read();
+                    buffer += done ? decoder.decode() : decoder.decode(value, { stream: true });
+                    let match;
+                    while ((match = buffer.match(FRAME_DELIMITER)) !== null) {
+                        const index = match.index;
+                        const raw = buffer.slice(0, index);
+                        buffer = buffer.slice(index + match[0].length);
+                        const event = parseSseFrame(raw, dataKind);
+                        if (event) {
+                            if (event.id !== undefined)
+                                lastEventId = event.id;
+                            if (event.retry !== undefined)
+                                serverRetry = event.retry;
+                            yield event;
+                        }
+                    }
+                    if (done) {
+                        // Stream closed cleanly. Flush a final event that arrived without a trailing
+                        // delimiter, then finish — a clean end is not a dropped connection, so do not reconnect.
+                        const event = buffer.length > 0 ? parseSseFrame(buffer, dataKind) : undefined;
+                        if (event) {
+                            if (event.id !== undefined)
+                                lastEventId = event.id;
+                            if (event.retry !== undefined)
+                                serverRetry = event.retry;
+                            yield event;
+                        }
+                        return;
+                    }
+                    // Bound memory: a server that never sends a frame delimiter would otherwise
+                    // grow `buffer` without limit. 1 MiB is far above any real SSE frame.
+                    if (buffer.length > 1048576) {
+                        throw new SseParseError('SSE frame exceeded 1048576 characters without a delimiter');
+                    }
+                }
+            }
+            finally {
+                await reader.cancel().catch(() => undefined);
+            }
+        }
+        catch (error) {
+            if (signal?.aborted)
+                return;
+            // A non-OK HTTP response (4xx/5xx) or an unparseable JSON payload is a definitive
+            // error, not a transient drop — surface it instead of reconnecting in a loop (a
+            // stable bad payload would otherwise reconnect forever).
+            if (error instanceof ApiError || error instanceof SseParseError)
+                throw error;
+            // A transport failure (connect/DNS/reset) when opening the request, or a mid-stream
+            // read error, is a dropped connection: fall through to backoff/reconnect when enabled.
+            if (!reconnect)
+                throw error;
+        }
+        // Only the swallowed-drop path reaches here: reconnect is on and the signal not aborted.
+        failures++;
+        const base = serverRetry ?? reconnectDelay ?? 1000;
+        const delay = Math.min(base * Math.pow(2, failures - 1), 30_000);
+        try {
+            await sleep(Math.random() * delay, signal);
+        }
+        catch {
+            return; // sleep rejects only on abort — end the iterator cleanly
+        }
+    }
+}
+/** Parse one raw SSE frame (its lines) into an event; returns undefined for comment-only frames. */
+export function parseSseFrame(raw, dataKind) {
+    let event;
+    const dataLines = [];
+    let id;
+    let retry;
+    let sawField = false;
+    for (const line of raw.split(/\r\n|\n|\r/)) {
+        if (line === '' || line.startsWith(':'))
+            continue;
+        const colon = line.indexOf(':');
+        const field = colon === -1 ? line : line.slice(0, colon);
+        let val = colon === -1 ? '' : line.slice(colon + 1);
+        if (val.startsWith(' '))
+            val = val.slice(1);
+        sawField = true;
+        if (field === 'event')
+            event = val;
+        else if (field === 'data')
+            dataLines.push(val);
+        else if (field === 'id')
+            id = val;
+        else if (field === 'retry') {
+            const n = Number(val);
+            if (!Number.isNaN(n))
+                retry = n;
+        }
+    }
+    if (!sawField)
+        return undefined;
+    const dataText = dataLines.join('\n');
+    let data = dataText;
+    if (dataKind === 'json' && dataText !== '') {
+        try {
+            data = JSON.parse(dataText);
+        }
+        catch (error) {
+            throw new SseParseError(`Failed to parse SSE event data as JSON: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    return { event, data, id, retry };
+}
+//# sourceMappingURL=sse.js.map

package/lib/runtime/sse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.js","sourceRoot":"","sources":["../../src/runtime/sse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAGjD;;;GAGG;AACH,MAAM,eAAe,GAAG,mBAAmB,CAAC;AAE5C;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;CAAG;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,GAAG,CACxB,MAAoB,EACpB,EAAoB,EACpB,OAAyD,EACzD,WAA4B,MAAM;IAElC,IAAI,WAA+B,CAAC;IACpC,IAAI,WAA+B,CAAC;IACpC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,OAAO,IAAI,EAAE,CAAC;QACZ,qFAAqF;QACrF,mFAAmF;QACnF,oFAAoF;QACpF,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,OAAO,EAAE,CAAC;QACtC,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC;QACxC,IAAI,MAAM,EAAE,OAAO;YAAE,OAAO;QAC5B,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,mBAAmB;YAC3B,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC;SAChC,CAAC;QACF,MAAM,WAAW,GACf,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAC7B,MAAM,EACN,EAAE,EACF,GAAG,EACH,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,EAC/D,SAAS,EACT,KAAK,EACL,EAAE,CACH,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAC5C,MAAM,IAAI,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAC3E,CAAC;YACD,QAAQ,GAAG,CAAC,CAAC;YACb,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC;gBACH,OAAO,IAAI,EAAE,CAAC;oBACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC5C,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC5E,IAAI,KAA8B,CAAC;oBACnC,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;wBACxD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAM,CAAC;wBAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;wBACnC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;wBAC/C,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;wBAC3C,IAAI,KAAK,EAAE,CAAC;4BACV,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS;gCAAE,WAAW,GAAG,KAAK,CAAC,EAAE,CAAC;4BACnD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;gCAAE,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC;4BACzD,MAAM,KAA2B,CAAC;wBACpC,CAAC;oBACH,CAAC;oBACD,IAAI,IAAI,EAAE,CAAC;wBACT,6EAA6E;wBAC7E,yFAAyF;wBACzF,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;wBAC9E,IAAI,KAAK,EAAE,CAAC;4BACV,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS;gCAAE,WAAW,GAAG,KAAK,CAAC,EAAE,CAAC;4BACnD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;gCAAE,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC;4BACzD,MAAM,KAA2B,CAAC;wBACpC,CAAC;wBACD,OAAO;oBACT,CAAC;oBACD,4EAA4E;oBAC5E,sEAAsE;oBACtE,IAAI,MAAM,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC;wBAC5B,MAAM,IAAI,aAAa,CAAC,2DAA2D,CAAC,CAAC;oBACvF,CAAC;gBACH,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,EAAE,OAAO;gBAAE,OAAO;YAC5B,kFAAkF;YAClF,gFAAgF;YAChF,yDAAyD;YACzD,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,YAAY,aAAa;gBAAE,MAAM,KAAK,CAAC;YAC7E,oFAAoF;YACpF,uFAAuF;YACvF,IAAI,CAAC,SAAS;gBAAE,MAAM,KAAK,CAAC;QAC9B,CAAC;QACD,yFAAyF;QACzF,QAAQ,EAAE,CAAC;QACX,MAAM,IAAI,GAAG,WAAW,IAAI,cAAc,IAAI,IAAI,CAAC;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC;YACH,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,yDAAyD;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,aAAa,CAC3B,GAAW,EACX,QAAyB;IAEzB,IAAI,KAAyB,CAAC;IAC9B,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,EAAsB,CAAC;IAC3B,IAAI,KAAyB,CAAC;IAC9B,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3C,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACzD,IAAI,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,QAAQ,GAAG,IAAI,CAAC;QAChB,IAAI,KAAK,KAAK,OAAO;YAAE,KAAK,GAAG,GAAG,CAAC;aAC9B,IAAI,KAAK,KAAK,MAAM;YAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC1C,IAAI,KAAK,KAAK,IAAI;YAAE,EAAE,GAAG,GAAG,CAAC;aAC7B,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAAE,KAAK,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,IAAI,CAAC,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChC,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,IAAI,GAAY,QAAQ,CAAC;IAC7B,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,aAAa,CACrB,2CAA2C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpG,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;AACpC,CAAC"}

package/lib/runtime/types.d.ts

@@ -0,0 +1,232 @@
+/**
+ * The public type surface of the client runtime — `@redocly/client-generator`'s
+ * app-facing runtime module. Pure types, no runtime code (excluded from coverage).
+ * The generator emits `OPERATIONS` literals typed
+ * `satisfies Record<string, OperationDescriptor>` against this module, so an
+ * incompatible runtime/generated pair fails the consumer's build (the semver skew guard).
+ */
+/** How one operation parameter is sent: its location plus OpenAPI query-serialization hints. */
+export type ParamSpec = {
+    name: string;
+    in: 'path' | 'query' | 'header';
+    style?: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+    explode?: boolean;
+    allowReserved?: boolean;
+};
+/** One security scheme, denormalized onto the operation (`scheme` names the spec's scheme). */
+export type SecuritySpec = {
+    scheme: string;
+    kind: 'bearer' | 'basic';
+} | {
+    scheme: string;
+    kind: 'apiKey';
+    name: string;
+    in: 'header' | 'query' | 'cookie';
+};
+/**
+ * How to auto-iterate a paginated operation (drives its `.pages()`/`.items()` members).
+ * `nextCursor` and `items` are RFC 6901 JSON pointers into the page (response) value.
+ */
+export type PaginationSpec = {
+    style: 'cursor' | 'offset' | 'page';
+    /** The query param the iterator advances: the cursor (`cursor`) or number (`offset`/`page`). */
+    param: string;
+    /** Optional page-size query param (recorded for tooling; never set by the runtime). */
+    limitParam?: string;
+    /** Cursor style only: pointer to the next cursor in the page. */
+    nextCursor?: string;
+    /** Pointer to the page's item array. */
+    items: string;
+};
+/** The frozen data contract between generated code and the runtime: one operation's wire shape. */
+export type OperationDescriptor = {
+    id: string;
+    method: string;
+    path: string;
+    tags?: readonly string[];
+    params?: readonly ParamSpec[];
+    /** `multipart: true` marks a typed object body serialized to FormData by the runtime. */
+    body?: {
+        contentType: string;
+        multipart?: boolean;
+    };
+    /** Defaults to `'json'` (content-type negotiation on parse). */
+    responseKind?: 'json' | 'text' | 'blob' | 'void' | 'sse';
+    sseDataKind?: 'json' | 'text';
+    /** OR-alternatives, each an AND-set: the runtime applies the first fully-configured one. */
+    security?: readonly (readonly SecuritySpec[])[];
+    pagination?: PaginationSpec;
+};
+/** A query value: scalars, arrays of scalars, or objects (serialized as deepObject brackets). */
+export type QueryValue = string | number | boolean | null | undefined | Array<string | number | boolean | null | undefined> | Record<string, unknown>;
+/** A credential: a literal, or a (possibly async) function resolved per request (refresh flows). */
+export type TokenProvider = string | (() => string | Promise<string>);
+/** Per-instance credentials, keyed by the scheme kinds the runtime can inject. */
+export type AuthCredentials = {
+    bearer?: TokenProvider;
+    basic?: {
+        username: string;
+        password: string;
+    };
+    apiKey?: Record<string, TokenProvider>;
+};
+/** Backoff shape: 'fixed' = constant delay; 'exponential' = doubling per attempt. */
+export type RetryStrategy = 'fixed' | 'exponential';
+/**
+ * The operation's identity, exposed to middleware for targeting (`ctx.operation`).
+ * Generated clients instantiate the type parameters with the spec's literal unions
+ * (`OperationId`/`OperationPath`/`OperationTag`) so a misspelled operation id in a
+ * middleware comparison fails to compile; the string defaults keep every
+ * spec-independent consumer (`runtime-contract.ts`, the runtime internals) working
+ * with the base shape. `tags` stays mutable (`Tag[]`) so setup-contract types
+ * (byte-locked to generated output) remain assignable through middleware callbacks.
+ */
+export type OperationContext<Id extends string = string, Path extends string = string, Tag extends string = string> = {
+    id: Id;
+    path: Path;
+    tags: Tag[];
+};
+/** The mutable request context threaded through the middleware chain. */
+export type RequestContext<Op extends OperationContext = OperationContext> = {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body?: unknown;
+    operation: Op;
+};
+/** The failed attempt handed to a custom `retryOn`: exactly one of `response`/`error` is set. */
+export type RetryContext<Op extends OperationContext = OperationContext> = {
+    attempt: number;
+    request: RequestContext<Op>;
+    response?: Response;
+    error?: unknown;
+};
+/** Opt-in retry policy; a per-call override merges field-by-field over the config policy. */
+export type RetryConfig<Op extends OperationContext = OperationContext> = {
+    retries?: number;
+    retryDelay?: number;
+    retryStrategy?: RetryStrategy;
+    jitter?: boolean;
+    retryOn?: (ctx: RetryContext<Op>) => boolean | Promise<boolean>;
+};
+/**
+ * Structural stand-in for the runtime's ApiError so this module stays import-free
+ * (pure types); the real `ApiError` class is assignable to it.
+ */
+export type ApiErrorLike = globalThis.Error & {
+    url: string;
+    status: number;
+    statusText: string;
+    body: unknown;
+};
+/** One interceptor: any subset of the three hooks. */
+export type Middleware<Op extends OperationContext = OperationContext> = {
+    onRequest?: (ctx: RequestContext<Op>) => void | Promise<void>;
+    onResponse?: (response: Response, ctx: RequestContext<Op>) => Response | void | Promise<Response | void>;
+    /** Throw mode only: may map/replace the error. */
+    onError?: (error: ApiErrorLike, ctx: RequestContext<Op>) => globalThis.Error | Promise<globalThis.Error>;
+};
+/** Client configuration: transport, defaults, retry policy, middleware, and credentials. */
+export type ClientConfig<Op extends OperationContext = OperationContext> = {
+    serverUrl?: string;
+    fetch?: typeof fetch;
+    headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
+    retry?: RetryConfig<Op>;
+    middleware?: Middleware<Op>[];
+    auth?: AuthCredentials;
+    /** Fixed at generate time by the generator (`'throw'` when omitted); `configure()` ignores it. */
+    errorMode?: 'throw' | 'result';
+    onRequest?: Middleware<Op>['onRequest'];
+    onResponse?: Middleware<Op>['onResponse'];
+    onError?: Middleware<Op>['onError'];
+};
+/** Response readers for the per-call `parseAs` override. */
+export type ParseAs = 'auto' | 'json' | 'text' | 'blob' | 'arrayBuffer' | 'formData' | 'stream';
+/** Per-call options: standard `RequestInit` plus a retry override and a forced reader. */
+export type RequestOptions = RequestInit & {
+    retry?: RetryConfig;
+    parseAs?: ParseAs;
+};
+/** Per-call options for an SSE stream; reconnect defaults to true. */
+export type SseOptions = RequestInit & {
+    reconnect?: boolean;
+    reconnectDelay?: number;
+};
+/** A single decoded Server-Sent Event with its payload typed from the spec. */
+export type ServerSentEvent<T> = {
+    event?: string;
+    data: T;
+    id?: string;
+    retry?: number;
+};
+/** Result-mode return shape: exactly one of `data`/`error` is set. */
+export type Result<TData, TError> = {
+    data: TData;
+    error: undefined;
+    response: Response;
+} | {
+    data: undefined;
+    error: TError;
+    response: Response;
+};
+/**
+ * The generated `Ops` type's shape: per-operation args/result, plus `kind: 'sse'` for
+ * streams and, for paginated operations, `item` (the page's element type) and — on
+ * result-mode clients only — `page` (the RAW page type `.pages()` yields, since
+ * iteration unwraps the `Result` envelope the one-shot `result` carries).
+ */
+export type OpsShape = Record<string, {
+    args: object;
+    result: unknown;
+    kind?: 'sse';
+    item?: unknown;
+    page?: unknown;
+}>;
+/** The always-present client members (assigned after the operation loop — they win collisions). */
+export type ClientCore<Op extends OperationContext = OperationContext> = {
+    /** Merge into the config; note `middleware` REPLACES the chain (use `use()` to compose). */
+    configure(config: ClientConfig<Op>): void;
+    /** Append interceptors (composes with baked/publisher middleware). */
+    use(...middleware: Middleware<Op>[]): void;
+    auth: {
+        bearer(token: TokenProvider): void;
+        basic(username: string, password: string): void;
+        apiKey(scheme: string, value: TokenProvider): void;
+    };
+};
+/**
+ * The standard TypeScript optionality probe: `{}` has no required members, so
+ * `{} extends A` is true exactly when every member of `A` is optional.
+ */
+type NoRequiredKeys<A> = {} extends A ? true : false;
+/**
+ * The page type `.pages()` yields: the RAW page declared by `page` (the generator
+ * writes it only on result-mode paginated entries, whose `result` is the envelope),
+ * or the method's own `result` (throw mode — already the raw page).
+ */
+type PageOf<Entry extends OpsShape[string]> = Entry extends {
+    page: unknown;
+} ? Entry['page'] : Entry['result'];
+/**
+ * The auto-pagination members intersected onto a paginated method — present exactly when
+ * the Ops entry declares `item` (the generator writes it only for paginated operations).
+ * Args optionality mirrors the method's own; `unknown` otherwise (identity under `&`).
+ * Iteration is error-mode-agnostic: `.pages()`/`.items()` yield raw pages/items, and a
+ * failed page aborts iteration by throwing `ApiError`, even on result-mode clients; the
+ * `onError` middleware hook (throw-mode-only) is not invoked.
+ */
+type Paginated<Entry extends OpsShape[string]> = 'item' extends keyof Entry ? NoRequiredKeys<Entry['args']> extends true ? {
+    pages(args?: Entry['args'], init?: RequestOptions): AsyncGenerator<PageOf<Entry>>;
+    items(args?: Entry['args'], init?: RequestOptions): AsyncGenerator<Entry['item']>;
+} : {
+    pages(args: Entry['args'], init?: RequestOptions): AsyncGenerator<PageOf<Entry>>;
+    items(args: Entry['args'], init?: RequestOptions): AsyncGenerator<Entry['item']>;
+} : unknown;
+/** The typed instance client: one bound method per operation plus the core members. */
+export type Client<Ops extends OpsShape, Op extends OperationContext = OperationContext> = {
+    [K in keyof Ops]: Ops[K] extends {
+        kind: 'sse';
+    } ? NoRequiredKeys<Ops[K]['args']> extends true ? (args?: Ops[K]['args'], init?: SseOptions) => AsyncGenerator<ServerSentEvent<Ops[K]['result']>> : (args: Ops[K]['args'], init?: SseOptions) => AsyncGenerator<ServerSentEvent<Ops[K]['result']>> : (NoRequiredKeys<Ops[K]['args']> extends true ? (args?: Ops[K]['args'], init?: RequestOptions) => Promise<Ops[K]['result']> : (args: Ops[K]['args'], init?: RequestOptions) => Promise<Ops[K]['result']>) & Paginated<Ops[K]>;
+} & ClientCore<Op>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/lib/runtime/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/runtime/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,gGAAgG;AAChG,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,gBAAgB,GAAG,eAAe,GAAG,YAAY,CAAC;IACnE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,+FAA+F;AAC/F,MAAM,MAAM,YAAY,GACpB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAA;CAAE,GAC5C;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CAAE,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,gGAAgG;IAChG,KAAK,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,mGAAmG;AACnG,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,SAAS,SAAS,EAAE,CAAC;IAC9B,yFAAyF;IACzF,IAAI,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACpD,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;IACzD,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,SAAS,CAAC,SAAS,YAAY,EAAE,CAAC,EAAE,CAAC;IAChD,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B,CAAC;AAEF,iGAAiG;AACjG,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,GACnD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B,oGAAoG;AACpG,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAEtE,kFAAkF;AAClF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACxC,CAAC;AAEF,qFAAqF;AACrF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,aAAa,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC1B,EAAE,SAAS,MAAM,GAAG,MAAM,EAC1B,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,GAAG,SAAS,MAAM,GAAG,MAAM,IACzB;IAAE,EAAE,EAAE,EAAE,CAAC;IAAC,IAAI,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,GAAG,EAAE,CAAA;CAAE,CAAC;AAExC,yEAAyE;AACzE,MAAM,MAAM,cAAc,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IAC3E,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,EAAE,CAAC;CACf,CAAC;AAEF,iGAAiG;AACjG,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,6FAA6F;AAC7F,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACjE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,GAAG;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,UAAU,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACvE,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,UAAU,CAAC,EAAE,CACX,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,cAAc,CAAC,EAAE,CAAC,KACpB,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAChD,kDAAkD;IAElD,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,YAAY,EACnB,GAAG,EAAE,cAAc,CAAC,EAAE,CAAC,KACpB,UAAU,CAAC,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;CACnD,CAAC;AAEF,4FAA4F;AAC5F,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,OAAO,CAAC,EACJ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;IACxB,UAAU,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,kGAAkG;IAClG,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC/B,SAAS,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;CACrC,CAAC;AAEF,4DAA4D;AAC5D,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEhG,0FAA0F;AAC1F,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtF,sEAAsE;AACtE,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExF,+EAA+E;AAC/E,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,CAAC,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1F,sEAAsE;AACtE,MAAM,MAAM,MAAM,CAAC,KAAK,EAAE,MAAM,IAC5B;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAC3B,MAAM,EACN;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAChF,CAAC;AAEF,mGAAmG;AACnG,MAAM,MAAM,UAAU,CAAC,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IACvE,4FAA4F;IAC5F,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IAC1C,sEAAsE;IACtE,GAAG,CAAC,GAAG,UAAU,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,EAAE;QACJ,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;QACnC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAChD,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;KACpD,CAAC;CACH,CAAC;AAEF;;;GAGG;AAEH,KAAK,cAAc,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAErD;;;;GAIG;AACH,KAAK,MAAM,CAAC,KAAK,SAAS,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACzE,KAAK,CAAC,MAAM,CAAC,GACb,KAAK,CAAC,QAAQ,CAAC,CAAC;AAEpB;;;;;;;GAOG;AACH,KAAK,SAAS,CAAC,KAAK,SAAS,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,SAAS,MAAM,KAAK,GACvE,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,IAAI,GACxC;IACE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAClF,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;CACnF,GACD;IACE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjF,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;CAClF,GACH,OAAO,CAAC;AAEZ,uFAAuF;AACvF,MAAM,MAAM,MAAM,CAAC,GAAG,SAAS,QAAQ,EAAE,EAAE,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;KACxF,CAAC,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,KAAK,CAAA;KAAE,GAC5C,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,IAAI,GACzC,CACE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EACrB,IAAI,CAAC,EAAE,UAAU,KACd,cAAc,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GACtD,CACE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EACpB,IAAI,CAAC,EAAE,UAAU,KACd,cAAc,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GACxD,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,IAAI,GACxC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAC3E,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAC7E,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACxB,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC"}

package/lib/runtime/types.js

@@ -0,0 +1,9 @@
+/**
+ * The public type surface of the client runtime — `@redocly/client-generator`'s
+ * app-facing runtime module. Pure types, no runtime code (excluded from coverage).
+ * The generator emits `OPERATIONS` literals typed
+ * `satisfies Record<string, OperationDescriptor>` against this module, so an
+ * incompatible runtime/generated pair fails the consumer's build (the semver skew guard).
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/lib/runtime/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/runtime/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/lib/runtime/url.d.ts

@@ -0,0 +1,25 @@
+import type { ParamSpec, QueryValue } from './types.js';
+/**
+ * The RESOLVED OpenAPI serialization spec for one query parameter — callers apply the
+ * OpenAPI defaults (`style: 'form'`, `explode: true`) before building one.
+ */
+export type QueryStyle = {
+    style: NonNullable<ParamSpec['style']>;
+    explode: boolean;
+    allowReserved?: boolean;
+};
+/**
+ * Encode everything except the RFC-3986 reserved set, for `allowReserved: true` params —
+ * `filter=a/b` survives instead of `filter=a%2Fb`.
+ */
+export declare function encodeReserved(value: string): string;
+/** Substitute `{name}` template segments with encoded values; a missing value is a caller bug. */
+export declare function substitutePath(template: string, values: Record<string, unknown>): string;
+/**
+ * Build the request URL: `serverUrl` (trailing slash trimmed) + path + serialized query.
+ * Query parameters honor their OpenAPI `style`/`explode`/`allowReserved` (from `styles`);
+ * without a spec, arrays repeat the key (`form`+`explode`), objects serialize as
+ * `deepObject` brackets, and `null`/`undefined` entries are skipped.
+ */
+export declare function buildUrl(serverUrl: string, path: string, query?: Record<string, QueryValue>, styles?: Record<string, QueryStyle>): string;
+//# sourceMappingURL=url.d.ts.map

package/lib/runtime/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/runtime/url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAKpD;AAED,kGAAkG;AAClG,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAMxF;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAClC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAClC,MAAM,CA4DR"}

package/lib/runtime/url.js

@@ -0,0 +1,97 @@
+/**
+ * Encode everything except the RFC-3986 reserved set, for `allowReserved: true` params —
+ * `filter=a/b` survives instead of `filter=a%2Fb`.
+ */
+export function encodeReserved(value) {
+    return encodeURIComponent(value).replace(/%(3A|2F|3F|23|5B|5D|40|21|24|26|27|28|29|2A|2B|2C|3B|3D)/g, (match) => decodeURIComponent(match));
+}
+/** Substitute `{name}` template segments with encoded values; a missing value is a caller bug. */
+export function substitutePath(template, values) {
+    return template.replace(/\{([^{}]+)\}/g, (_match, name) => {
+        const value = values[name];
+        if (value === undefined)
+            throw new Error(`Missing path parameter "${name}"`);
+        return encodeURIComponent(String(value));
+    });
+}
+/**
+ * Build the request URL: `serverUrl` (trailing slash trimmed) + path + serialized query.
+ * Query parameters honor their OpenAPI `style`/`explode`/`allowReserved` (from `styles`);
+ * without a spec, arrays repeat the key (`form`+`explode`), objects serialize as
+ * `deepObject` brackets, and `null`/`undefined` entries are skipped.
+ */
+export function buildUrl(serverUrl, path, query, styles) {
+    // Trim trailing slashes with a scan, not `/\/+$/` — an anchored `+` regex is
+    // quadratic on adversarial many-slash input (the server URL is caller data).
+    let end = serverUrl.length;
+    while (end > 0 && serverUrl.charCodeAt(end - 1) === 47 /* '/' */)
+        end--;
+    const url = serverUrl.slice(0, end) + path;
+    if (!query)
+        return url;
+    const params = new URLSearchParams();
+    const raw = [];
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined || value === null)
+            continue;
+        const spec = styles?.[key];
+        if (!spec) {
+            if (Array.isArray(value)) {
+                for (const v of value) {
+                    if (v !== undefined && v !== null)
+                        params.append(key, String(v));
+                }
+            }
+            else if (Object(value) === value) {
+                // Object-valued query params use `deepObject` style: key[subKey]=subValue.
+                for (const [subKey, subValue] of Object.entries(value)) {
+                    if (subValue !== undefined && subValue !== null) {
+                        params.append(`${key}[${subKey}]`, String(subValue));
+                    }
+                }
+            }
+            else {
+                params.append(key, String(value));
+            }
+            continue;
+        }
+        if (Array.isArray(value)) {
+            const items = value.filter((v) => v !== undefined && v !== null).map(String);
+            if (spec.style === 'form' && spec.explode) {
+                for (const v of items) {
+                    if (spec.allowReserved)
+                        raw.push(`${key}=${encodeReserved(v)}`);
+                    else
+                        params.append(key, v);
+                }
+            }
+            else {
+                // Delimited styles put the LITERAL delimiter on the wire; only the
+                // values are encoded. `%20` (not `+`) is the literal space delimiter.
+                const delim = spec.style === 'pipeDelimited' ? '|' : spec.style === 'spaceDelimited' ? '%20' : ',';
+                const enc = spec.allowReserved ? encodeReserved : encodeURIComponent;
+                raw.push(`${encodeURIComponent(key)}=${items.map(enc).join(delim)}`);
+            }
+        }
+        else if (Object(value) === value) {
+            // `deepObject` (and any object spec, for now): key[subKey]=subValue.
+            for (const [subKey, subValue] of Object.entries(value)) {
+                if (subValue !== undefined && subValue !== null) {
+                    if (spec.allowReserved)
+                        raw.push(`${key}[${subKey}]=${encodeReserved(String(subValue))}`);
+                    else
+                        params.append(`${key}[${subKey}]`, String(subValue));
+                }
+            }
+        }
+        else if (spec.allowReserved) {
+            raw.push(`${key}=${encodeReserved(String(value))}`);
+        }
+        else {
+            params.append(key, String(value));
+        }
+    }
+    const qs = [params.toString(), ...raw].filter(Boolean).join('&');
+    return qs ? `${url}?${qs}` : url;
+}
+//# sourceMappingURL=url.js.map

package/lib/runtime/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/runtime/url.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,OAAO,CACtC,2DAA2D,EAC3D,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,CACrC,CAAC;AACJ,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,cAAc,CAAC,QAAgB,EAAE,MAA+B;IAC9E,OAAO,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE;QAChE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,GAAG,CAAC,CAAC;QAC7E,OAAO,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CACtB,SAAiB,EACjB,IAAY,EACZ,KAAkC,EAClC,MAAmC;IAEnC,6EAA6E;IAC7E,6EAA6E;IAC7E,IAAI,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC;IAC3B,OAAO,GAAG,GAAG,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,SAAS;QAAE,GAAG,EAAE,CAAC;IACxE,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IACvB,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QACpD,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI;wBAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnE,CAAC;YACH,CAAC;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;gBACnC,2EAA2E;gBAC3E,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBAChD,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,MAAM,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACvD,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpC,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC7E,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;oBACtB,IAAI,IAAI,CAAC,aAAa;wBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;;wBAC3D,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,mEAAmE;gBACnE,sEAAsE;gBACtE,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,KAAK,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;gBACvF,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBACrE,GAAG,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YACnC,qEAAqE;YACrE,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBAChD,IAAI,IAAI,CAAC,aAAa;wBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;;wBACrF,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,MAAM,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AACnC,CAAC"}

package/lib/runtime-contract.d.ts

@@ -0,0 +1,27 @@
+import type { Middleware, RequestContext, RetryConfig } from './runtime/types.js';
+export type { Middleware, OperationContext, RequestContext, RetryConfig, RetryContext, RetryStrategy, } from './runtime/types.js';
+/**
+ * The spec-independent subset of a client's `ClientConfig` a publisher may bake in
+ * (everything except the spec-derived `auth`).
+ */
+export type ClientSetupConfig = {
+    serverUrl?: string;
+    headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
+    fetch?: typeof fetch;
+    onRequest?: (ctx: RequestContext) => void | Promise<void>;
+    onResponse?: (response: Response, ctx: RequestContext) => Response | void | Promise<Response | void>;
+    onError?: (error: Error, ctx: RequestContext) => Error;
+    retry?: RetryConfig;
+};
+export type ClientSetup = {
+    config?: ClientSetupConfig;
+    middleware?: Middleware[];
+};
+/**
+ * Identity helper for authoring a `--setup` module: gives full type inference and a stable
+ * call the baker recognises. `export default defineClientSetup({ config, middleware })`.
+ *
+ * @experimental The setup API may change between minor versions until stabilized.
+ */
+export declare function defineClientSetup(setup: ClientSetup): ClientSetup;
+//# sourceMappingURL=runtime-contract.d.ts.map