vocs 2.0.17 → 2.1.2

package/dist/internal/openapi/sample.d.ts

@@ -0,0 +1,115 @@
+import { type HarRequest } from '@scalar/snippetz';
+import { type SchemaPath } from './anchors.js';
+import type { IrOperation } from './parser.js';
+/**
+ * A generated request code sample for a single client (e.g. cURL, JS fetch).
+ *
+ * `lang` is a Shiki language id so the React layer can highlight it with the
+ * same highlighter used for the rest of the docs.
+ */
+export type CodeSample = {
+    /**
+     * Clickable spans within `display` that link to a parameter's documentation
+     * row. Each `range` is a `[start, end]` character range into `display`; `id`
+     * is the target element id. Used for path parameters, which sit inline within
+     * the URL line, so only their value (not the whole line) is clickable.
+     */
+    anchors: {
+        range: [number, number];
+        id: string;
+    }[];
+    /** Generated source code, used verbatim for the copy-to-clipboard action. */
+    code: string;
+    /**
+     * Collapsed view shown by default when the request has more than 2 query
+     * parameters: the same snippet rendered with only the first 2, plus its own
+     * `anchors`/`lineAnchors`/`colorRanges` (line counts differ from the full
+     * `display`). Absent when there is nothing to collapse.
+     */
+    collapsed?: {
+        display: string;
+        anchors: {
+            range: [number, number];
+            id: string;
+        }[];
+        colorRanges: {
+            range: [number, number];
+            kind: 'key' | 'value';
+        }[];
+        lineAnchors: (string | undefined)[];
+    };
+    /**
+     * `[start, end]` character ranges within `display` to recolor so the URL reads
+     * like the JSON response example: parameter names use the JSON-string color
+     * (`'key'`) and parameter values the JSON-number color (`'value'`). Covers
+     * query parameter names/values; path parameter values are colored via their
+     * {@link anchors} entry instead (those already wrap the value).
+     */
+    colorRanges: {
+        range: [number, number];
+        kind: 'key' | 'value';
+    }[];
+    /**
+     * Display variant of {@link code} with each query parameter placed on its own
+     * line for readability. Formatted language-aware so it stays syntactically
+     * highlightable (TypeScript uses string concatenation; cURL breaks inside the
+     * quoted URL). This is what gets highlighted/rendered; `code` is copied.
+     */
+    display: string;
+    /** Number of query parameters hidden in {@link collapsed}. */
+    hiddenQueryCount?: number;
+    /** Stable id, e.g. `shell/curl`. */
+    id: string;
+    /** Display label for the language tab, e.g. `cURL`. */
+    label: string;
+    /** Shiki language id for highlighting, e.g. `bash`, `js`. */
+    lang: string;
+    /**
+     * Per-line anchor ids (0-based) for `display`. Since each query parameter is
+     * placed on its own line, the whole line is made clickable — mirroring the
+     * response example lines. `undefined` for non-parameter lines.
+     */
+    lineAnchors: (string | undefined)[];
+};
+/**
+ * Builds request code samples for an operation using `@scalar/snippetz` — the
+ * same snippet generator Scalar uses. Returns one entry per supported client.
+ */
+export declare function codeSamples(operation: IrOperation, server?: string): CodeSample[];
+/**
+ * Constructs a HAR-style request from an operation by filling path/query/header
+ * parameters and the request body with representative sample values. This is the
+ * input `snippetz` consumes to render code samples.
+ */
+export declare function harRequest(operation: IrOperation, server?: string): Partial<HarRequest>;
+/**
+ * A response code sample (the example body for a single status code), ready to
+ * be highlighted as JSON in the right-hand panel.
+ */
+export type ResponseSample = {
+    status: string;
+    description?: string | undefined;
+    /**
+     * Id base for this response's schema rows, used to resolve per-line anchors
+     * (see {@link linePaths}) to the matching documentation row's element id.
+     */
+    idBase: string;
+    lang: string;
+    code: string;
+    /**
+     * `[start, end]` character ranges (into `code`) of synthesized placeholder
+     * values — leaves with no authored `example`/`default`/`enum` whose value was
+     * derived solely from the declared type (e.g. `"string"`, `0`). The UI dims
+     * these so authored examples stand out.
+     */
+    placeholders: [number, number][];
+    /**
+     * Per-line schema path: `linePaths[i]` is the path of the property whose value
+     * appears on line `i` of `code` (undefined for closing braces / blank lines).
+     * The UI turns these into clickable anchors to the left-hand schema rows.
+     */
+    linePaths: (SchemaPath | undefined)[];
+};
+/** Builds JSON response samples for each response that has a usable schema/example. */
+export declare function responseSamples(operation: IrOperation): ResponseSample[];
+//# sourceMappingURL=sample.d.ts.map

package/dist/internal/openapi/sample.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample.d.ts","sourceRoot":"","sources":["../../../src/internal/openapi/sample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAA+B,KAAK,UAAU,EAAQ,MAAM,cAAc,CAAA;AACjF,OAAO,KAAK,EAAe,WAAW,EAAe,MAAM,aAAa,CAAA;AAGxE;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;OAKG;IACH,OAAO,EAAE;QAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAClD,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,SAAS,CAAC,EAAE;QACV,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE;YAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QAClD,WAAW,EAAE;YAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAA;SAAE,EAAE,CAAA;QACjE,WAAW,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;KACpC,CAAA;IACD;;;;;;OAMG;IACH,WAAW,EAAE;QAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAA;KAAE,EAAE,CAAA;IACjE;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oCAAoC;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAA;IACb,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,WAAW,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;CACpC,CAAA;AAeD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CA0CjF;AA4HD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CA+BvF;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAA;IAChC;;;;OAIG;IACH,SAAS,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;CACtC,CAAA;AAED,uFAAuF;AACvF,wBAAgB,eAAe,CAAC,SAAS,EAAE,WAAW,GAAG,cAAc,EAAE,CA6BxE"}

package/dist/internal/openapi/sample.js

@@ -0,0 +1,434 @@
+import { snippetz } from '@scalar/snippetz';
+import { mediaIdBase, responseIdBase, slug } from './anchors.js';
+import { unionVariantSchemas, unionVariantSegment } from './union.js';
+/** Query parameters above this count collapse behind a "Show more" toggle. */
+const collapseQueryThreshold = 2;
+/**
+ * The set of clients we expose in the code-sample selector. Kept intentionally
+ * small (cURL + JavaScript fetch) to start; the `snippetz` library supports many
+ * more targets if we widen this later.
+ */
+const clients = [
+    { id: 'shell/curl', target: 'shell', client: 'curl', label: 'cURL', lang: 'bash' },
+    { id: 'js/fetch', target: 'js', client: 'fetch', label: 'TypeScript', lang: 'ts' },
+];
+/**
+ * Builds request code samples for an operation using `@scalar/snippetz` — the
+ * same snippet generator Scalar uses. Returns one entry per supported client.
+ */
+export function codeSamples(operation, server) {
+    const request = harRequest(operation, server);
+    const generator = snippetz();
+    const queryCount = request.queryString?.length ?? 0;
+    // When there are many query params, also prepare a request limited to the
+    // first few so the sample can collapse the rest behind a "Show more" toggle.
+    const collapsedRequest = queryCount > collapseQueryThreshold
+        ? { ...request, queryString: (request.queryString ?? []).slice(0, collapseQueryThreshold) }
+        : undefined;
+    const samples = [];
+    for (const client of clients) {
+        const code = generator.print(client.target, client.client, request);
+        if (!code)
+            continue;
+        const display = splitQueryLines(code, client.lang);
+        const sample = {
+            id: client.id,
+            label: client.label,
+            lang: client.lang,
+            code,
+            display,
+            anchors: pathAnchors(display, operation),
+            colorRanges: queryColorRanges(display, operation),
+            lineAnchors: queryLineAnchors(display, operation),
+        };
+        if (collapsedRequest) {
+            const collapsedCode = generator.print(client.target, client.client, collapsedRequest);
+            if (collapsedCode) {
+                const collapsedDisplay = splitQueryLines(collapsedCode, client.lang);
+                sample.collapsed = {
+                    display: collapsedDisplay,
+                    anchors: pathAnchors(collapsedDisplay, operation),
+                    colorRanges: queryColorRanges(collapsedDisplay, operation),
+                    lineAnchors: queryLineAnchors(collapsedDisplay, operation),
+                };
+                sample.hiddenQueryCount = queryCount - collapseQueryThreshold;
+            }
+        }
+        samples.push(sample);
+    }
+    return samples;
+}
+/**
+ * Reformats a generated request snippet so each query parameter sits on its own
+ * line. The query string lives in the first single-quoted URL containing `?`.
+ *
+ * - TypeScript: splits the URL literal into `'base' + '?a=1' + '&b=2'`, which is
+ *   valid JS (and identical at runtime), so the copied/displayed code both work.
+ * - cURL (and other shells): inserts literal newlines inside the quoted URL.
+ *   This is for display only — the unformatted {@link CodeSample.code} is what
+ *   the copy button uses, so the runnable request stays intact.
+ */
+function splitQueryLines(code, lang) {
+    const match = code.match(/'([^'\n]*\?[^'\n]*)'/);
+    if (!match)
+        return code;
+    const [token, url = ''] = match;
+    const questionIndex = url.indexOf('?');
+    const base = url.slice(0, questionIndex);
+    const params = url.slice(questionIndex + 1).split('&');
+    if (params.length === 0)
+        return code;
+    const replacement = lang === 'ts' || lang === 'js'
+        ? [`'${base}'`, `'?${params[0]}'`, ...params.slice(1).map((p) => `'&${p}'`)].join(' +\n  ')
+        : `'${base}\n  ?${params[0]}${params
+            .slice(1)
+            .map((p) => `\n  &${p}`)
+            .join('')}'`;
+    return code.replace(token, replacement);
+}
+/**
+ * Locates clickable path-parameter spans within a request sample. The
+ * substituted value is matched against `display` and mapped to its docs row id
+ * (`<operationId>-<slug(name)>`). Path params sit inline within the URL line, so
+ * only their value is anchored (query params get whole-line anchors instead).
+ *
+ * Matching is deliberately conservative: a value is only anchored when it
+ * appears exactly once, so an ambiguous value (e.g. a generic `0`/`string` that
+ * also appears in the body) silently degrades to non-clickable.
+ */
+function pathAnchors(display, operation) {
+    const anchors = [];
+    for (const parameter of operation.parameters) {
+        if (parameter.deprecated || parameter.in !== 'path')
+            continue;
+        const value = encodeURIComponent(String(sampleParameter(parameter)));
+        const index = singleIndexOf(display, value);
+        if (index >= 0)
+            anchors.push({
+                range: [index, index + value.length],
+                id: `${operation.id}-${slug(parameter.name)}`,
+            });
+    }
+    return anchors;
+}
+/**
+ * Maps each line of `display` to a query parameter's docs row id, so the whole
+ * line can be made clickable (like response example lines). Relies on
+ * {@link splitQueryLines} having placed each query parameter on its own line
+ * starting with `?`/`&` (optionally quoted in the TS variant).
+ */
+function queryLineAnchors(display, operation) {
+    const ids = new Map();
+    for (const parameter of operation.parameters)
+        if (parameter.in === 'query' && !parameter.deprecated)
+            ids.set(parameter.name, `${operation.id}-${slug(parameter.name)}`);
+    return display.split('\n').map((line) => {
+        const match = line.match(/^\s*'?[?&]([^=]+)=/);
+        return match ? ids.get(match[1] ?? '') : undefined;
+    });
+}
+/**
+ * Computes character ranges for each query parameter's name and value within
+ * `display` so the UI can recolor them like the JSON response example (names use
+ * the JSON-string color, values the JSON-number color). Relies on
+ * {@link splitQueryLines} having placed each query parameter on its own line
+ * starting with `?`/`&` (optionally quoted in the TS variant).
+ */
+function queryColorRanges(display, operation) {
+    const names = new Set();
+    for (const parameter of operation.parameters)
+        if (parameter.in === 'query' && !parameter.deprecated)
+            names.add(parameter.name);
+    const ranges = [];
+    let offset = 0;
+    for (const line of display.split('\n')) {
+        // Capture: (prefix incl. quote + ?/&)(name)(=)(value up to closing quote/EOL)
+        const match = line.match(/^(\s*'?[?&])([^=]+)(=)([^'\n]*)/);
+        if (match) {
+            const [, prefix = '', name = '', , value = ''] = match;
+            if (names.has(name)) {
+                // Color the `?`/`&` separator (last char of the prefix) and the name
+                // together as one green span.
+                const nameStart = offset + prefix.length - 1;
+                const nameEnd = offset + prefix.length + name.length;
+                ranges.push({ range: [nameStart, nameEnd], kind: 'key' });
+                if (value.length > 0) {
+                    const valueStart = nameEnd + 1; // skip '='
+                    ranges.push({ range: [valueStart, valueStart + value.length], kind: 'value' });
+                }
+            }
+        }
+        offset += line.length + 1; // +1 for the consumed newline
+    }
+    return ranges;
+}
+/** Returns the index of `needle` in `haystack`, or -1 unless it occurs once. */
+function singleIndexOf(haystack, needle) {
+    if (!needle)
+        return -1;
+    const first = haystack.indexOf(needle);
+    if (first < 0)
+        return -1;
+    if (haystack.indexOf(needle, first + 1) >= 0)
+        return -1;
+    return first;
+}
+/**
+ * Constructs a HAR-style request from an operation by filling path/query/header
+ * parameters and the request body with representative sample values. This is the
+ * input `snippetz` consumes to render code samples.
+ */
+export function harRequest(operation, server) {
+    const base = (server ?? '').replace(/\/$/, '');
+    let path = operation.path;
+    const headers = [];
+    const queryString = [];
+    for (const parameter of operation.parameters) {
+        if (parameter.deprecated)
+            continue;
+        const value = String(sampleParameter(parameter));
+        if (parameter.in === 'path')
+            path = path.replace(`{${parameter.name}}`, encodeURIComponent(value));
+        else if (parameter.in === 'query')
+            queryString.push({ name: parameter.name, value });
+        else if (parameter.in === 'header' && parameter.required)
+            headers.push({ name: parameter.name, value });
+    }
+    let postData;
+    const media = operation.requestBody?.content[0];
+    if (media) {
+        headers.push({ name: 'Content-Type', value: media.mediaType });
+        postData = { mimeType: media.mediaType, text: sampleBody(media) };
+    }
+    return {
+        method: operation.method,
+        url: `${base}${path}`,
+        headers,
+        queryString,
+        ...(postData ? { postData } : {}),
+    };
+}
+/** Builds JSON response samples for each response that has a usable schema/example. */
+export function responseSamples(operation) {
+    const samples = [];
+    for (const response of operation.responses) {
+        const media = response.content.find((entry) => entry.mediaType.includes('json'));
+        if (!media)
+            continue;
+        const idBase = mediaIdBase(responseIdBase(operation.id, response.status), media.mediaType, response.content.length);
+        // An authored example for the whole media type has no synthesized
+        // placeholders; build a tree from the literal value so we can still emit
+        // per-line anchors. Otherwise build a tagged tree from the schema so we can
+        // also dim type-derived leaves.
+        const tree = media.example !== undefined ? sampleTreeFromValue(media.example) : sampleTree(media.schema);
+        if (tree === undefined)
+            continue;
+        const { code, placeholders, linePaths } = serializeSample(tree);
+        samples.push({
+            status: response.status,
+            description: response.description,
+            idBase,
+            lang: 'json',
+            code,
+            placeholders,
+            linePaths,
+        });
+    }
+    return samples;
+}
+/** Serializes a request body media type to its example/sample JSON text. */
+function sampleBody(media) {
+    const value = media.example ?? sampleFromSchema(media.schema);
+    if (media.mediaType.includes('json'))
+        return JSON.stringify(value ?? {}, null, 2);
+    return typeof value === 'string' ? value : JSON.stringify(value ?? {});
+}
+/** Produces a representative value for a single parameter. */
+function sampleParameter(parameter) {
+    const value = sampleFromSchema(parameter.schema);
+    if (value !== undefined)
+        return value;
+    return parameter.name;
+}
+/**
+ * Builds a tagged sample tree from a (dereferenced) JSON Schema, preferring
+ * authored `example`/`default`/`enum` values and otherwise synthesizing one
+ * from the declared type. Bounded by a recursion depth to guard against cycles.
+ */
+function sampleTree(schema, depth = 0) {
+    if (!schema || depth > 6)
+        return undefined;
+    if (schema['example'] !== undefined)
+        return { kind: 'leaf', value: schema['example'], placeholder: false };
+    const examples = schema['examples'];
+    if (Array.isArray(examples) && examples.length > 0)
+        return { kind: 'leaf', value: examples[0], placeholder: false };
+    if (schema['default'] !== undefined)
+        return { kind: 'leaf', value: schema['default'], placeholder: false };
+    const enumValues = schema['enum'];
+    if (Array.isArray(enumValues) && enumValues.length > 0)
+        return { kind: 'leaf', value: enumValues[0], placeholder: false };
+    // oneOf/anyOf variant picker (matching the docs renderer): sample the first
+    // variant and tag the resulting node with the variant's path segment, so its
+    // children's anchor paths line up with the variant-qualified docs rows.
+    if (schema['type'] !== 'array') {
+        const variants = unionVariantSchemas(schema);
+        if (variants) {
+            const node = sampleTree(variants[0], depth + 1);
+            if (node && (node.kind === 'object' || node.kind === 'array'))
+                return { ...node, pathSegment: unionVariantSegment(0) };
+            return node;
+        }
+    }
+    // Composition keywords: fall back to the first usable subschema.
+    for (const key of ['allOf', 'anyOf', 'oneOf']) {
+        const subschemas = schema[key];
+        if (Array.isArray(subschemas) && subschemas[0])
+            return sampleTree(subschemas[0], depth + 1);
+    }
+    const rawType = schema['type'];
+    const type = Array.isArray(rawType) ? rawType[0] : rawType;
+    if (type === 'object' || schema['properties']) {
+        const properties = (schema['properties'] ?? {});
+        const entries = [];
+        for (const [name, property] of Object.entries(properties)) {
+            const node = sampleTree(property, depth + 1);
+            // Match `JSON.stringify`, which drops keys whose value is `undefined`.
+            if (node !== undefined)
+                entries.push([name, node]);
+        }
+        return { kind: 'object', entries };
+    }
+    if (type === 'array') {
+        const items = schema['items'];
+        const item = sampleTree(items, depth + 1);
+        return { kind: 'array', items: item === undefined ? [] : [item] };
+    }
+    if (type === 'string') {
+        const format = schema['format'];
+        if (format === 'date-time')
+            return { kind: 'leaf', value: new Date(0).toISOString(), placeholder: true };
+        if (format === 'date')
+            return { kind: 'leaf', value: new Date(0).toISOString().slice(0, 10), placeholder: true };
+        if (format === 'uuid')
+            return { kind: 'leaf', value: '00000000-0000-0000-0000-000000000000', placeholder: true };
+        return { kind: 'leaf', value: 'string', placeholder: true };
+    }
+    if (type === 'integer' || type === 'number')
+        return { kind: 'leaf', value: 0, placeholder: true };
+    if (type === 'boolean')
+        return { kind: 'leaf', value: true, placeholder: true };
+    return undefined;
+}
+/**
+ * Builds a {@link SampleNode} tree from an already-resolved literal value (an
+ * authored media-type example). All leaves are non-placeholders since the value
+ * was authored. Object keys whose value serializes to `undefined` are dropped to
+ * match `JSON.stringify`.
+ */
+function sampleTreeFromValue(value) {
+    if (Array.isArray(value))
+        return { kind: 'array', items: value.map((item) => sampleTreeFromValue(item ?? null)) };
+    if (value && typeof value === 'object') {
+        const entries = [];
+        for (const [key, child] of Object.entries(value)) {
+            if (JSON.stringify(child) === undefined)
+                continue;
+            entries.push([key, sampleTreeFromValue(child)]);
+        }
+        return { kind: 'object', entries };
+    }
+    return { kind: 'leaf', value, placeholder: false };
+}
+/** Strips the placeholder tags from a {@link SampleNode} into a plain value. */
+function toValue(node) {
+    if (node === undefined)
+        return undefined;
+    if (node.kind === 'leaf')
+        return node.value;
+    if (node.kind === 'array')
+        return node.items.map(toValue);
+    const result = {};
+    for (const [name, child] of node.entries)
+        result[name] = toValue(child);
+    return result;
+}
+/**
+ * Pretty-prints a {@link SampleNode} as JSON (matching
+ * `JSON.stringify(value, null, 2)`) while recording `[start, end]` character
+ * ranges of placeholder leaf literals.
+ */
+function serializeSample(root) {
+    let code = '';
+    let line = 0;
+    const placeholders = [];
+    const linePaths = [];
+    function mark(path) {
+        if (path.length > 0)
+            linePaths[line] = path;
+    }
+    function newline() {
+        code += '\n';
+        line++;
+    }
+    function walk(node, indent, path) {
+        const pad = '  '.repeat(indent);
+        const padInner = '  '.repeat(indent + 1);
+        // Union variant nodes carry a virtual path segment (e.g. `variant-0`) so
+        // their children's anchor paths match the variant-qualified docs rows.
+        const childBase = node.kind !== 'leaf' && node.pathSegment ? [...path, node.pathSegment] : path;
+        if (node.kind === 'object') {
+            if (node.entries.length === 0) {
+                code += '{}';
+                return;
+            }
+            code += '{';
+            newline();
+            node.entries.forEach(([key, value], index) => {
+                const childPath = [...childBase, key];
+                mark(childPath);
+                code += `${padInner}${JSON.stringify(key)}: `;
+                walk(value, indent + 1, childPath);
+                code += index < node.entries.length - 1 ? ',' : '';
+                newline();
+            });
+            code += `${pad}}`;
+            return;
+        }
+        if (node.kind === 'array') {
+            if (node.items.length === 0) {
+                code += '[]';
+                return;
+            }
+            code += '[';
+            newline();
+            node.items.forEach((item, index) => {
+                // Scalar array items map to the array property's own path.
+                if (item.kind === 'leaf')
+                    mark(childBase);
+                code += padInner;
+                walk(item, indent + 1, childBase);
+                code += index < node.items.length - 1 ? ',' : '';
+                newline();
+            });
+            code += `${pad}]`;
+            return;
+        }
+        const literal = JSON.stringify(node.value) ?? 'null';
+        const start = code.length;
+        code += literal;
+        if (node.placeholder)
+            placeholders.push([start, code.length]);
+    }
+    walk(root, 0, []);
+    return { code, placeholders, linePaths };
+}
+/**
+ * Generates a representative value from a (dereferenced) JSON Schema, preferring
+ * authored `example`/`default`/`enum` values and otherwise synthesizing one from
+ * the declared type. Bounded by a recursion depth to guard against cycles.
+ */
+function sampleFromSchema(schema, depth = 0) {
+    return toValue(sampleTree(schema, depth));
+}
+//# sourceMappingURL=sample.js.map

package/dist/internal/openapi/sample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sample.js","sourceRoot":"","sources":["../../../src/internal/openapi/sample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAmB,IAAI,EAAE,MAAM,cAAc,CAAA;AAEjF,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AA6DrE,8EAA8E;AAC9E,MAAM,sBAAsB,GAAG,CAAC,CAAA;AAEhC;;;;GAIG;AACH,MAAM,OAAO,GAAG;IACd,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;IAClF,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;CAC1E,CAAA;AAEV;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,SAAsB,EAAE,MAAe;IACjE,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IAC7C,MAAM,SAAS,GAAG,QAAQ,EAAE,CAAA;IAC5B,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,MAAM,IAAI,CAAC,CAAA;IACnD,0EAA0E;IAC1E,6EAA6E;IAC7E,MAAM,gBAAgB,GACpB,UAAU,GAAG,sBAAsB;QACjC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,EAAE;QAC3F,CAAC,CAAC,SAAS,CAAA;IAEf,MAAM,OAAO,GAAiB,EAAE,CAAA;IAChC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACnE,IAAI,CAAC,IAAI;YAAE,SAAQ;QACnB,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;QAClD,MAAM,MAAM,GAAe;YACzB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI;YACJ,OAAO;YACP,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC;YACxC,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC;YACjD,WAAW,EAAE,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC;SAClD,CAAA;QACD,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;YACrF,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,gBAAgB,GAAG,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;gBACpE,MAAM,CAAC,SAAS,GAAG;oBACjB,OAAO,EAAE,gBAAgB;oBACzB,OAAO,EAAE,WAAW,CAAC,gBAAgB,EAAE,SAAS,CAAC;oBACjD,WAAW,EAAE,gBAAgB,CAAC,gBAAgB,EAAE,SAAS,CAAC;oBAC1D,WAAW,EAAE,gBAAgB,CAAC,gBAAgB,EAAE,SAAS,CAAC;iBAC3D,CAAA;gBACD,MAAM,CAAC,gBAAgB,GAAG,UAAU,GAAG,sBAAsB,CAAA;YAC/D,CAAC;QACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACtB,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,IAAY;IACjD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;IAChD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IACvB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,KAAK,CAAA;IAC/B,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IACtC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACtD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IAEpC,MAAM,WAAW,GACf,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI;QAC5B,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC3F,CAAC,CAAC,IAAI,IAAI,QAAQ,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM;aAC/B,KAAK,CAAC,CAAC,CAAC;aACR,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;aACvB,IAAI,CAAC,EAAE,CAAC,GAAG,CAAA;IACpB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,WAAW,CAClB,OAAe,EACf,SAAsB;IAEtB,MAAM,OAAO,GAA8C,EAAE,CAAA;IAC7D,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;QAC7C,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,EAAE,KAAK,MAAM;YAAE,SAAQ;QAC7D,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACpE,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC3C,IAAI,KAAK,IAAI,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;gBACpC,EAAE,EAAE,GAAG,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;aAC9C,CAAC,CAAA;IACN,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAAe,EAAE,SAAsB;IAC/D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAA;IACrC,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU;QAC1C,IAAI,SAAS,CAAC,EAAE,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU;YACnD,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtE,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;QAC9C,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACpD,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,gBAAgB,CACvB,OAAe,EACf,SAAsB;IAEtB,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAA;IAC/B,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU;QAC1C,IAAI,SAAS,CAAC,EAAE,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAElF,MAAM,MAAM,GAAyD,EAAE,CAAA;IACvE,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,8EAA8E;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;QAC3D,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,AAAD,EAAG,KAAK,GAAG,EAAE,CAAC,GAAG,KAAK,CAAA;YACtD,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,qEAAqE;gBACrE,8BAA8B;gBAC9B,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;gBAC5C,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;gBACpD,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;gBACzD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrB,MAAM,UAAU,GAAG,OAAO,GAAG,CAAC,CAAA,CAAC,WAAW;oBAC1C,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;gBAChF,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA,CAAC,8BAA8B;IAC1D,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,gFAAgF;AAChF,SAAS,aAAa,CAAC,QAAgB,EAAE,MAAc;IACrD,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC,CAAA;IACtB,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACtC,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC,CAAA;IACxB,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC,CAAA;IACvD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,SAAsB,EAAE,MAAe;IAChE,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IAE9C,IAAI,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;IACzB,MAAM,OAAO,GAAsC,EAAE,CAAA;IACrD,MAAM,WAAW,GAAsC,EAAE,CAAA;IAEzD,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;QAC7C,IAAI,SAAS,CAAC,UAAU;YAAE,SAAQ;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAA;QAChD,IAAI,SAAS,CAAC,EAAE,KAAK,MAAM;YACzB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,IAAI,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAA;aAClE,IAAI,SAAS,CAAC,EAAE,KAAK,OAAO;YAAE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;aAC/E,IAAI,SAAS,CAAC,EAAE,KAAK,QAAQ,IAAI,SAAS,CAAC,QAAQ;YACtD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACjD,CAAC;IAED,IAAI,QAAwD,CAAA;IAC5D,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IAC/C,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAA;QAC9D,QAAQ,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;IACnE,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE;QACrB,OAAO;QACP,WAAW;QACX,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAClC,CAAA;AACH,CAAC;AA+BD,uFAAuF;AACvF,MAAM,UAAU,eAAe,CAAC,SAAsB;IACpD,MAAM,OAAO,GAAqB,EAAE,CAAA;IACpC,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;QAChF,IAAI,CAAC,KAAK;YAAE,SAAQ;QACpB,MAAM,MAAM,GAAG,WAAW,CACxB,cAAc,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC7C,KAAK,CAAC,SAAS,EACf,QAAQ,CAAC,OAAO,CAAC,MAAM,CACxB,CAAA;QACD,kEAAkE;QAClE,yEAAyE;QACzE,4EAA4E;QAC5E,gCAAgC;QAChC,MAAM,IAAI,GACR,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC7F,IAAI,IAAI,KAAK,SAAS;YAAE,SAAQ;QAChC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;QAC/D,OAAO,CAAC,IAAI,CAAC;YACX,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,MAAM;YACN,IAAI,EAAE,MAAM;YACZ,IAAI;YACJ,YAAY;YACZ,SAAS;SACV,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,4EAA4E;AAC5E,SAAS,UAAU,CAAC,KAAkB;IACpC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC7D,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IACjF,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;AACxE,CAAC;AAED,8DAA8D;AAC9D,SAAS,eAAe,CAAC,SAAsB;IAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAChD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAA;IACrC,OAAO,SAAS,CAAC,IAAI,CAAA;AACvB,CAAC;AAYD;;;;GAIG;AACH,SAAS,UAAU,CACjB,MAA2C,EAC3C,KAAK,GAAG,CAAC;IAET,IAAI,CAAC,MAAM,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,SAAS,CAAA;IAE1C,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,SAAS;QACjC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;IACvE,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;IACnC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAChD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;IACjE,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,SAAS;QACjC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;IACvE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QACpD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;IAEnE,4EAA4E;IAC5E,6EAA6E;IAC7E,wEAAwE;IACxE,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;QAC5C,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAA4B,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;YAC1E,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC;gBAC3D,OAAO,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAA;YACzD,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IAED,iEAAiE;IACjE,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAU,EAAE,CAAC;QACvD,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC;YAC5C,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,CAA4B,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAE1D,IAAI,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,CAA4C,CAAA;QAC1F,MAAM,OAAO,GAA2B,EAAE,CAAA;QAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;YAC5C,uEAAuE;YACvE,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QACpD,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;IACpC,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAwC,CAAA;QACpE,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QACzC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAA;IACnE,CAAC;IAED,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC/B,IAAI,MAAM,KAAK,WAAW;YACxB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;QAC9E,IAAI,MAAM,KAAK,MAAM;YACnB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;QAC3F,IAAI,MAAM,KAAK,MAAM;YACnB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,sCAAsC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;QAC3F,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;IAC7D,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;IACjG,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;IAE/E,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,KAAc;IACzC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACtB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,EAAE,CAAA;IACzF,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,OAAO,GAA2B,EAAE,CAAA;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS;gBAAE,SAAQ;YACjD,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACjD,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;IACpC,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAA;AACpD,CAAC;AAED,gFAAgF;AAChF,SAAS,OAAO,CAAC,IAA4B;IAC3C,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAA;IACxC,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC,KAAK,CAAA;IAC3C,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACzD,MAAM,MAAM,GAA4B,EAAE,CAAA;IAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO;QAAE,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;IACvE,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAgB;IAKvC,IAAI,IAAI,GAAG,EAAE,CAAA;IACb,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,MAAM,YAAY,GAAuB,EAAE,CAAA;IAC3C,MAAM,SAAS,GAA+B,EAAE,CAAA;IAEhD,SAAS,IAAI,CAAC,IAAgB;QAC5B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC7C,CAAC;IAED,SAAS,OAAO;QACd,IAAI,IAAI,IAAI,CAAA;QACZ,IAAI,EAAE,CAAA;IACR,CAAC;IAED,SAAS,IAAI,CAAC,IAAgB,EAAE,MAAc,EAAE,IAAgB;QAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACxC,yEAAyE;QACzE,uEAAuE;QACvE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC/F,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,IAAI,IAAI,CAAA;gBACZ,OAAM;YACR,CAAC;YACD,IAAI,IAAI,GAAG,CAAA;YACX,OAAO,EAAE,CAAA;YACT,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE;gBAC3C,MAAM,SAAS,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,CAAC,CAAA;gBACrC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACf,IAAI,IAAI,GAAG,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAA;gBAC7C,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;gBAClC,IAAI,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;gBAClD,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;YACF,IAAI,IAAI,GAAG,GAAG,GAAG,CAAA;YACjB,OAAM;QACR,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,IAAI,IAAI,IAAI,CAAA;gBACZ,OAAM;YACR,CAAC;YACD,IAAI,IAAI,GAAG,CAAA;YACX,OAAO,EAAE,CAAA;YACT,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBACjC,2DAA2D;gBAC3D,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;oBAAE,IAAI,CAAC,SAAS,CAAC,CAAA;gBACzC,IAAI,IAAI,QAAQ,CAAA;gBAChB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,SAAS,CAAC,CAAA;gBACjC,IAAI,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;gBAChD,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;YACF,IAAI,IAAI,GAAG,GAAG,GAAG,CAAA;YACjB,OAAM;QACR,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,MAAM,CAAA;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,IAAI,OAAO,CAAA;QACf,IAAI,IAAI,CAAC,WAAW;YAAE,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;IACjB,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,CAAA;AAC1C,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,MAA2C,EAAE,KAAK,GAAG,CAAC;IAC9E,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;AAC3C,CAAC"}

package/dist/internal/openapi/search.d.ts

@@ -0,0 +1,19 @@
+import type { SearchDocuments } from '../search.js';
+import type { Ir } from './parser.js';
+/**
+ * Builds search index documents for an OpenAPI section so the auto-generated
+ * reference is discoverable by Vocs's search (which otherwise only crawls
+ * `.md`/`.mdx` files).
+ *
+ * Mirrors the page/anchor structure of the rendered reference:
+ * - the `/api` landing page (one `page` document),
+ * - each category page `/api/<group>` (one `page` document), and
+ * - each operation as a `section` document anchored on its category page
+ *   (`/api/<group>#<operation>`).
+ *
+ * Operation documents fold the method, path, parameter names/descriptions and
+ * response descriptions into their searchable `text` so endpoints surface for a
+ * wide range of queries (summary, path, parameter, status code, …).
+ */
+export declare function toSearchDocuments(ir: Ir): SearchDocuments.Document[];
+//# sourceMappingURL=search.d.ts.map

package/dist/internal/openapi/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/internal/openapi/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,EAAE,EAAe,MAAM,aAAa,CAAA;AAElD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,QAAQ,EAAE,CAqDpE"}