vocs 2.1.5 → 2.1.7

package/dist/react/internal/openapi/OperationStandalone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationStandalone.js","sourceRoot":"","sources":["../../../../src/react/internal/openapi/OperationStandalone.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,SAAS,CAAC,KAAsB;IAC9C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,yDAAqC,CAAA;QACrE,OAAO,CACL,0EACgD,kCAAiB,SAAI,GAAG,EACtE,2CAAgC,gBAAW,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAC1D,CACL,CAAA;IACH,CAAC;IAED,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IACvB,IAAI,CAAC,EAAE;QAAE,OAAO,0DAAkC,KAAK,SAAM,CAAA;IAE7D,MAAM,SAAS,GAAG,aAAa,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC1C,IAAI,CAAC,SAAS;QACZ,OAAO,CACL,8EACqD,KAAK,gBAAW,yCAAwB,aACtF,oCAAmB,WAAK,kCAAiB,SAC5C,CACL,CAAA;IAEH,OAAO,CACL,gDACE,KAAC,kBAAkB,IAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,YACnD,KAAC,aAAa,IACZ,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAC1B,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,CAAC,EACrC,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,eAAe,EAAE,KAAK,CAAC,eAAe,GACtC,GACiB,GACjB,CACP,CAAA;AACH,CAAC"}

package/dist/react/internal/openapi/PlaygroundStandalone.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Renders just the interactive request/response code sample for a single
+ * OpenAPI operation — the bordered "playground" box (the cURL/response viewer
+ * with Copy, "Try", and per-status tabs) that normally sits in the right column
+ * of a generated operation page, with none of the surrounding documentation.
+ *
+ * This is an opt-in component for dropping the playground box into an authored
+ * MDX page. For the full operation block (title, parameters, responses, and this
+ * box together) use {@link file://./OperationStandalone.tsx `<OpenApi.Operation />`}.
+ *
+ * The target operation is located by either:
+ * - `operationId` — matched against the operation's anchor id (the slugified
+ *   `operationId` from the spec), or
+ * - `method` + `path` — matched against the HTTP method and templated path
+ *   (e.g. `method="GET" path="/v1/blocks"`).
+ *
+ * The spec is resolved from `spec` (the OpenAPI mount, e.g. `/api`). When
+ * omitted, it defaults to the only configured spec; if multiple specs exist,
+ * `spec` is required.
+ */
+export declare function Playground(props: Playground.Props): import("react/jsx-runtime").JSX.Element | null;
+export declare namespace Playground {
+    type Props = {
+        /**
+         * OpenAPI mount path identifying which spec to read (e.g. `/api`).
+         * Optional when only one spec is configured.
+         */
+        spec?: string | undefined;
+        /**
+         * Target operation by its anchor id — the slugified `operationId` from the
+         * spec (e.g. `operationId="getBlocks"`). Mutually exclusive with
+         * `method` + `path`.
+         */
+        operationId?: string | undefined;
+        /** HTTP method of the target operation (e.g. `GET`). Pairs with `path`. */
+        method?: string | undefined;
+        /** Templated path of the target operation (e.g. `/v1/blocks`). Pairs with `method`. */
+        path?: string | undefined;
+        /**
+         * Render the clickable schema cross-links in the request/response sample
+         * (the hover-highlighted spans/lines that jump to a parameter or property
+         * row). Set `false` for a static, non-interactive sample.
+         *
+         * @default true
+         */
+        anchors?: boolean | undefined;
+        /**
+         * Omit query parameters from the generated request sample.
+         *
+         * @default false
+         */
+        hideQueryParams?: boolean | undefined;
+    };
+}
+//# sourceMappingURL=PlaygroundStandalone.d.ts.map

package/dist/react/internal/openapi/PlaygroundStandalone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaygroundStandalone.d.ts","sourceRoot":"","sources":["../../../../src/react/internal/openapi/PlaygroundStandalone.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,kDAkDjD;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,KAAK,KAAK,GAAG;QACX;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,2EAA2E;QAC3E,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC3B,uFAAuF;QACvF,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB;;;;;;WAMG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC7B;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KACtC,CAAA;CACF"}

package/dist/react/internal/openapi/PlaygroundStandalone.js

@@ -0,0 +1,49 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { specs } from 'virtual:vocs/openapi';
+import { codeSamples, responseSamples } from '../../../internal/openapi/sample.js';
+import { CodeSample } from './CodeSample.client.js';
+import { findOperation } from './find-operation.js';
+import { PlaygroundProvider, TestRequestButton } from './Playground.client.js';
+/**
+ * Renders just the interactive request/response code sample for a single
+ * OpenAPI operation — the bordered "playground" box (the cURL/response viewer
+ * with Copy, "Try", and per-status tabs) that normally sits in the right column
+ * of a generated operation page, with none of the surrounding documentation.
+ *
+ * This is an opt-in component for dropping the playground box into an authored
+ * MDX page. For the full operation block (title, parameters, responses, and this
+ * box together) use {@link file://./OperationStandalone.tsx `<OpenApi.Operation />`}.
+ *
+ * The target operation is located by either:
+ * - `operationId` — matched against the operation's anchor id (the slugified
+ *   `operationId` from the spec), or
+ * - `method` + `path` — matched against the HTTP method and templated path
+ *   (e.g. `method="GET" path="/v1/blocks"`).
+ *
+ * The spec is resolved from `spec` (the OpenAPI mount, e.g. `/api`). When
+ * omitted, it defaults to the only configured spec; if multiple specs exist,
+ * `spec` is required.
+ */
+export function Playground(props) {
+    const mounts = Object.keys(specs);
+    const mount = props.spec ?? (mounts.length === 1 ? mounts[0] : undefined);
+    if (!mount) {
+        if (mounts.length === 0)
+            return _jsx("p", { children: "No OpenAPI spec is configured." });
+        return (_jsxs("p", { children: ["Multiple OpenAPI specs are configured. Pass a ", _jsx("code", { children: "spec" }), " to", ' ', _jsx("code", { children: "<Playground />" }), " (one of: ", mounts.join(', '), ")."] }));
+    }
+    const ir = specs[mount];
+    if (!ir)
+        return _jsxs("p", { children: ["No OpenAPI spec is mounted at ", mount, "."] });
+    const operation = findOperation(ir, props);
+    if (!operation)
+        return (_jsxs("p", { children: ["No matching operation found in the API mounted at ", mount, ". Pass an ", _jsx("code", { children: "operationId" }), ", or a ", _jsx("code", { children: "method" }), " and ", _jsx("code", { children: "path" }), "."] }));
+    const samples = codeSamples(operation, ir.servers[0]?.url, {
+        hideQueryParams: props.hideQueryParams,
+    });
+    if (samples.length === 0)
+        return null;
+    const responses = responseSamples(operation);
+    return (_jsx("div", { "data-v-openapi": true, children: _jsx(PlaygroundProvider, { client: ir.client, mount: ir.path, children: _jsx(CodeSample, { samples: samples, responses: responses, anchors: props.anchors, action: _jsx(TestRequestButton, { method: operation.method, path: operation.path, example: operation.rpcExample }) }) }) }));
+}
+//# sourceMappingURL=PlaygroundStandalone.js.map

package/dist/react/internal/openapi/PlaygroundStandalone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaygroundStandalone.js","sourceRoot":"","sources":["../../../../src/react/internal/openapi/PlaygroundStandalone.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,UAAU,CAAC,KAAuB;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,yDAAqC,CAAA;QACrE,OAAO,CACL,0EACgD,kCAAiB,SAAI,GAAG,EACtE,4CAAiC,gBAAW,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAC3D,CACL,CAAA;IACH,CAAC;IAED,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IACvB,IAAI,CAAC,EAAE;QAAE,OAAO,0DAAkC,KAAK,SAAM,CAAA;IAE7D,MAAM,SAAS,GAAG,aAAa,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;IAC1C,IAAI,CAAC,SAAS;QACZ,OAAO,CACL,8EACqD,KAAK,gBAAW,yCAAwB,aACtF,oCAAmB,WAAK,kCAAiB,SAC5C,CACL,CAAA;IAEH,MAAM,OAAO,GAAG,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE;QACzD,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,CAAC,CAAA;IACF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACrC,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAA;IAE5C,OAAO,CACL,gDACE,KAAC,kBAAkB,IAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,YACnD,KAAC,UAAU,IACT,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,MAAM,EACJ,KAAC,iBAAiB,IAChB,MAAM,EAAE,SAAS,CAAC,MAAM,EACxB,IAAI,EAAE,SAAS,CAAC,IAAI,EACpB,OAAO,EAAE,SAAS,CAAC,UAAU,GAC7B,GAEJ,GACiB,GACjB,CACP,CAAA;AACH,CAAC"}

package/dist/react/internal/openapi/find-operation.d.ts

@@ -0,0 +1,18 @@
+import type { Ir, IrOperation } from '../../../internal/openapi/parser.js';
+/**
+ * Locates a single operation within a parsed {@link Ir}, by either its
+ * `operationId` (matched against the operation's anchor id — the slugified
+ * `operationId` from the spec) or an exact `method` + `path` pair.
+ *
+ * Shared by the public `<OpenApi.Operation />` component so the matching logic
+ * stays free of the `virtual:vocs/openapi` module and is unit-testable.
+ */
+export declare function findOperation(ir: Ir, target: findOperation.Target): IrOperation | undefined;
+export declare namespace findOperation {
+    type Target = {
+        operationId?: string | undefined;
+        method?: string | undefined;
+        path?: string | undefined;
+    };
+}
+//# sourceMappingURL=find-operation.d.ts.map

package/dist/react/internal/openapi/find-operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-operation.d.ts","sourceRoot":"","sources":["../../../../src/react/internal/openapi/find-operation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAA;AAE1E;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,CAkB3F;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,KAAK,MAAM,GAAG;QACZ,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAChC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC1B,CAAA;CACF"}

package/dist/react/internal/openapi/find-operation.js

@@ -0,0 +1,22 @@
+import { slug } from '../../../internal/openapi/anchors.js';
+/**
+ * Locates a single operation within a parsed {@link Ir}, by either its
+ * `operationId` (matched against the operation's anchor id — the slugified
+ * `operationId` from the spec) or an exact `method` + `path` pair.
+ *
+ * Shared by the public `<OpenApi.Operation />` component so the matching logic
+ * stays free of the `virtual:vocs/openapi` module and is unit-testable.
+ */
+export function findOperation(ir, target) {
+    const operations = ir.groups.flatMap((group) => group.operations);
+    if (target.operationId) {
+        const id = slug(target.operationId);
+        return operations.find((operation) => operation.id === target.operationId || operation.id === id);
+    }
+    if (target.method && target.path) {
+        const method = target.method.toUpperCase();
+        return operations.find((operation) => operation.method === method && operation.path === target.path);
+    }
+    return undefined;
+}
+//# sourceMappingURL=find-operation.js.map

package/dist/react/internal/openapi/find-operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-operation.js","sourceRoot":"","sources":["../../../../src/react/internal/openapi/find-operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sCAAsC,CAAA;AAG3D;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,EAAM,EAAE,MAA4B;IAChE,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAEjE,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,UAAU,CAAC,IAAI,CACpB,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,MAAM,CAAC,WAAW,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,CAC1E,CAAA;IACH,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAA;QAC1C,OAAO,UAAU,CAAC,IAAI,CACpB,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,MAAM,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAC7E,CAAA;IACH,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC"}