@scalar/api-reference 1.32.9 → 1.33.0

package/dist/features/Operation/layouts/ClassicLayout.vue2.js

@@ -1,185 +1,201 @@
-import { defineComponent as S, computed as V, createBlock as l, openBlock as r, unref as o, createSlots as w, withCtx as i, createElementVNode as s, createVNode as t, createElementBlock as I, createCommentVNode as d, withModifiers as T, toDisplayString as f, normalizeClass as R, createTextVNode as y } from "vue";
-import { ScalarIconButton as $, ScalarMarkdown as E } from "@scalar/components";
-import { ScalarIconPlay as N, ScalarIconCopy as O, ScalarIconWebhooksLogo as P } from "@scalar/icons";
-import { isOperationDeprecated as W, getOperationStability as k, getOperationStabilityColor as _ } from "@scalar/oas-utils/helpers";
-import { useClipboard as z } from "@scalar/use-hooks/useClipboard";
-import A from "../../../components/OperationPath.vue.js";
-import D from "../components/callbacks/Callbacks.vue.js";
-import { useConfig as L } from "../../../hooks/useConfig.js";
-import U from "../components/OperationParameters.vue.js";
-import M from "../components/OperationResponses.vue.js";
-import j from "../../../components/Section/SectionAccordion.vue.js";
-import F from "../../example-responses/ExampleResponses.vue.js";
-import G from "../../example-request/ExampleRequest.vue.js";
-import H from "../../test-request-button/TestRequestButton.vue.js";
-import J from "../../../components/HttpMethod/HttpMethod.vue.js";
-import K from "../../../components/Anchor/Anchor.vue.js";
-import v from "../../../components/Badge/Badge.vue.js";
-const Q = { class: "operation-title" }, X = { class: "operation-details" }, Y = { class: "endpoint-label" }, Z = { class: "endpoint-label-path" }, x = { class: "endpoint-label-name" }, ee = { class: "endpoint-content" }, oe = { class: "operation-details-card" }, te = { class: "operation-details-card-item" }, se = { class: "operation-details-card-item" }, ae = {
+import { defineComponent as g, computed as B, createBlock as r, openBlock as i, unref as o, createSlots as O, withCtx as s, createElementVNode as a, createVNode as t, createElementBlock as w, createCommentVNode as n, withModifiers as V, toDisplayString as h, normalizeClass as $, createTextVNode as u } from "vue";
+import { ScalarErrorBoundary as q, ScalarIconButton as I, ScalarMarkdown as T } from "@scalar/components";
+import { ScalarIconPlay as D, ScalarIconCopy as E, ScalarIconWebhooksLogo as L } from "@scalar/icons";
+import { isOperationDeprecated as R, getOperationStability as f, getOperationStabilityColor as W } from "@scalar/oas-utils/helpers";
+import { useClipboard as N } from "@scalar/use-hooks/useClipboard";
+import P from "../../../components/OperationPath.vue.js";
+import _ from "../components/callbacks/Callbacks.vue.js";
+import z from "../components/OperationParameters.vue.js";
+import U from "../components/OperationResponses.vue.js";
+import { useConfig as A } from "../../../hooks/useConfig.js";
+import M from "../../../components/Section/SectionAccordion.vue.js";
+import j from "../../example-responses/ExampleResponses.vue.js";
+import F from "../../../components/LinkList/LinkList.vue.js";
+import G from "../../external-docs/ExternalDocs.vue.js";
+import H from "../../../v2/blocks/scalar-request-example-block/components/RequestExample.vue.js";
+import J from "../../test-request-button/TestRequestButton.vue.js";
+import K from "../../../components/HttpMethod/HttpMethod.vue.js";
+import Q from "../../../components/Anchor/Anchor.vue.js";
+import y from "../../../components/Badge/Badge.vue.js";
+const X = { class: "operation-title" }, Y = { class: "operation-details" }, Z = { class: "endpoint-label" }, x = { class: "endpoint-label-path" }, ee = { class: "endpoint-label-name" }, oe = { class: "endpoint-content" }, te = { class: "operation-details-card" }, ae = { class: "operation-details-card-item" }, se = { class: "operation-details-card-item" }, ie = {
   key: 0,
   class: "operation-details-card-item"
-}, qe = /* @__PURE__ */ S({
+}, Ve = /* @__PURE__ */ g({
   __name: "ClassicLayout",
   props: {
     id: {},
     path: {},
+    clientOptions: {},
     method: {},
     operation: {},
+    oldOperation: {},
+    parameters: {},
     isWebhook: { type: Boolean },
-    collection: {},
     server: {},
-    request: {},
-    schemas: {}
+    securitySchemes: {},
+    schemas: {},
+    store: {}
   },
   emits: ["update:modelValue"],
-  setup(m, { emit: b }) {
-    const g = V(() => {
-      var e;
-      return ((e = m.operation) == null ? void 0 : e.summary) || m.path || "";
-    }), { copyToClipboard: C } = z(), q = L(), B = b, h = (e) => {
-      B("update:modelValue", e);
+  setup(d, { emit: k }) {
+    const v = B(() => d.operation.summary || d.path || ""), { copyToClipboard: b } = N(), S = A(), C = k, m = (e) => {
+      C("update:modelValue", e);
     };
-    return (e, p) => {
-      var u;
-      return r(), l(o(j), {
-        id: e.id,
-        class: "reference-endpoint",
-        transparent: ""
-      }, w({
-        title: i(() => [
-          s("div", Q, [
-            s("div", X, [
-              t(o(J), {
-                class: "endpoint-type",
-                method: e.method,
-                short: ""
-              }, null, 8, ["method"]),
-              t(o(K), {
-                id: e.id,
-                class: "endpoint-anchor"
-              }, {
-                default: i(() => [
-                  s("h3", Y, [
-                    s("div", Z, [
-                      t(A, {
-                        deprecated: o(W)(e.operation),
-                        path: e.path
-                      }, null, 8, ["deprecated", "path"])
+    return (e, l) => (i(), r(o(M), {
+      id: e.id,
+      class: "reference-endpoint",
+      transparent: ""
+    }, O({
+      title: s(() => [
+        a("div", X, [
+          a("div", Y, [
+            t(o(K), {
+              class: "endpoint-type",
+              method: e.method,
+              short: ""
+            }, null, 8, ["method"]),
+            t(o(Q), {
+              id: e.id,
+              class: "endpoint-anchor"
+            }, {
+              default: s(() => [
+                a("h3", Z, [
+                  a("div", x, [
+                    t(P, {
+                      deprecated: o(R)(e.operation),
+                      path: e.path
+                    }, null, 8, ["deprecated", "path"])
+                  ]),
+                  a("div", ee, h(v.value), 1),
+                  o(f)(e.operation) ? (i(), r(o(y), {
+                    key: 0,
+                    class: $(o(W)(e.operation))
+                  }, {
+                    default: s(() => [
+                      u(h(o(f)(e.operation)), 1)
                     ]),
-                    s("div", x, f(g.value), 1),
-                    o(k)(e.operation) ? (r(), l(o(v), {
-                      key: 0,
-                      class: R(o(_)(e.operation))
-                    }, {
-                      default: i(() => [
-                        y(f(o(k)(e.operation)), 1)
-                      ]),
-                      _: 1
-                    }, 8, ["class"])) : d("", !0),
-                    e.isWebhook ? (r(), l(o(v), {
-                      key: 1,
-                      class: "font-code text-green flex w-fit items-center justify-center gap-1"
-                    }, {
-                      default: i(() => [
-                        t(o(P), { weight: "bold" }),
-                        p[1] || (p[1] = y("Webhook "))
-                      ]),
-                      _: 1,
-                      __: [1]
-                    })) : d("", !0)
-                  ])
+                    _: 1
+                  }, 8, ["class"])) : n("", !0),
+                  e.isWebhook ? (i(), r(o(y), {
+                    key: 1,
+                    class: "font-code text-green flex w-fit items-center justify-center gap-1"
+                  }, {
+                    default: s(() => [
+                      t(o(L), { weight: "bold" }),
+                      l[1] || (l[1] = u("Webhook "))
+                    ]),
+                    _: 1,
+                    __: [1]
+                  })) : n("", !0)
+                ])
+              ]),
+              _: 1
+            }, 8, ["id"])
+          ])
+        ])
+      ]),
+      actions: s(({ active: p }) => {
+        var c;
+        return [
+          p && !e.isWebhook ? (i(), r(o(J), {
+            key: 0,
+            method: e.method,
+            path: e.path
+          }, null, 8, ["method", "path"])) : (c = o(S)) != null && c.hideTestRequestButton ? n("", !0) : (i(), r(o(D), {
+            key: 1,
+            class: "endpoint-try-hint size-4.5"
+          })),
+          t(o(I), {
+            class: "endpoint-copy p-0.5",
+            icon: o(E),
+            label: "Copy endpoint URL",
+            size: "xs",
+            variant: "ghost",
+            onClick: l[0] || (l[0] = V((re) => o(b)(e.path), ["stop"]))
+          }, null, 8, ["icon"])
+        ];
+      }),
+      default: s(() => {
+        var p;
+        return [
+          a("div", oe, [
+            a("div", te, [
+              a("div", ae, [
+                t(z, {
+                  requestBody: e.oldOperation.requestBody,
+                  parameters: e.parameters,
+                  schemas: e.schemas,
+                  "onUpdate:modelValue": m
+                }, null, 8, ["requestBody", "parameters", "schemas"])
+              ]),
+              a("div", se, [
+                t(U, {
+                  collapsableItems: !1,
+                  responses: e.oldOperation.responses,
+                  schemas: e.schemas
+                }, null, 8, ["responses", "schemas"])
+              ]),
+              (p = e.operation) != null && p.callbacks ? (i(), w("div", ie, [
+                t(_, {
+                  method: e.method,
+                  path: e.path,
+                  callbacks: e.operation.callbacks,
+                  schemas: e.schemas
+                }, null, 8, ["method", "path", "callbacks", "schemas"])
+              ])) : n("", !0)
+            ]),
+            t(o(j), {
+              class: "operation-example-card",
+              responses: e.operation.responses
+            }, null, 8, ["responses"]),
+            a("div", null, [
+              e.operation.externalDocs ? (i(), r(o(F), { key: 0 }, {
+                default: s(() => [
+                  t(o(G), {
+                    value: e.operation.externalDocs
+                  }, null, 8, ["value"])
+                ]),
+                _: 1
+              })) : n("", !0),
+              t(o(q), null, {
+                default: s(() => [
+                  t(o(H), {
+                    class: "operation-example-card",
+                    method: e.method,
+                    selectedServer: e.server,
+                    clientOptions: e.clientOptions,
+                    selectedClient: e.store.workspace["x-scalar-default-client"],
+                    securitySchemes: e.securitySchemes,
+                    path: e.path,
+                    fallback: "",
+                    operation: e.operation,
+                    "onUpdate:modelValue": m
+                  }, null, 8, ["method", "selectedServer", "clientOptions", "selectedClient", "securitySchemes", "path", "operation"])
                 ]),
                 _: 1
-              }, 8, ["id"])
+              })
             ])
           ])
+        ];
+      }),
+      _: 2
+    }, [
+      e.operation.description ? {
+        name: "description",
+        fn: s(() => [
+          t(o(T), {
+            value: e.operation.description,
+            withImages: "",
+            withAnchors: "",
+            transformType: "heading",
+            anchorPrefix: e.id
+          }, null, 8, ["value", "anchorPrefix"])
         ]),
-        actions: i(({ active: a }) => {
-          var n;
-          return [
-            a && e.request ? (r(), l(o(H), {
-              key: 0,
-              operation: e.request
-            }, null, 8, ["operation"])) : (n = o(q)) != null && n.hideTestRequestButton ? d("", !0) : (r(), l(o(N), {
-              key: 1,
-              class: "endpoint-try-hint size-4.5"
-            })),
-            t(o($), {
-              class: "endpoint-copy p-0.5",
-              icon: o(O),
-              label: "Copy endpoint URL",
-              size: "xs",
-              variant: "ghost",
-              onClick: p[0] || (p[0] = T((c) => o(C)(e.path), ["stop"]))
-            }, null, 8, ["icon"])
-          ];
-        }),
-        default: i(() => {
-          var a, n, c;
-          return [
-            s("div", ee, [
-              s("div", oe, [
-                s("div", te, [
-                  t(U, {
-                    parameters: (a = e.operation) == null ? void 0 : a.parameters,
-                    requestBody: (n = e.operation) == null ? void 0 : n.requestBody,
-                    schemas: e.schemas,
-                    "onUpdate:modelValue": h
-                  }, null, 8, ["parameters", "requestBody", "schemas"])
-                ]),
-                s("div", se, [
-                  t(M, {
-                    collapsableItems: !1,
-                    responses: e.operation.responses,
-                    schemas: e.schemas
-                  }, null, 8, ["responses", "schemas"])
-                ]),
-                (c = e.operation) != null && c.callbacks ? (r(), I("div", ae, [
-                  t(D, {
-                    callbacks: e.operation.callbacks,
-                    schemas: e.schemas,
-                    collection: e.collection
-                  }, null, 8, ["callbacks", "schemas", "collection"])
-                ])) : d("", !0)
-              ]),
-              t(o(F), {
-                class: "operation-example-card",
-                responses: e.operation.responses
-              }, null, 8, ["responses"]),
-              t(o(G), {
-                class: "operation-example-card",
-                request: e.request,
-                method: e.method,
-                collection: e.collection,
-                operation: e.operation,
-                server: e.server,
-                "onUpdate:modelValue": h
-              }, null, 8, ["request", "method", "collection", "operation", "server"])
-            ])
-          ];
-        }),
-        _: 2
-      }, [
-        (u = e.operation) != null && u.description ? {
-          name: "description",
-          fn: i(() => {
-            var a;
-            return [
-              t(o(E), {
-                value: (a = e.operation) == null ? void 0 : a.description,
-                withImages: "",
-                withAnchors: "",
-                transformType: "heading",
-                anchorPrefix: e.id
-              }, null, 8, ["value", "anchorPrefix"])
-            ];
-          }),
-          key: "0"
-        } : void 0
-      ]), 1032, ["id"]);
-    };
+        key: "0"
+      } : void 0
+    ]), 1032, ["id"]));
   }
 });
 export {
-  qe as default
+  Ve as default
 };

package/dist/features/Operation/layouts/ClassicLayout.vue3.js

@@ -0,0 +1,4 @@
+const _ = "";
+export {
+  _ as default
+};

package/dist/features/Operation/layouts/ModernLayout.vue.d.ts

@@ -1,21 +1,26 @@
-import type { Collection, Request, Server } from '@scalar/oas-utils/entities/spec';
-import type { OpenAPIV3_1, XScalarStability } from '@scalar/types/legacy';
-import type { Schemas } from '../types/schemas';
+import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/parameter';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/path-operations';
+import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/security-scheme';
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server';
+import type { Dereference } from '@scalar/workspace-store/schemas/v3.1/type-guard';
+import type { Schemas } from '../../../features/Operation/types/schemas';
+import type { ClientOptionGroup } from '../../../v2/blocks/scalar-request-example-block/types';
 type __VLS_Props = {
     id: string;
     path: string;
-    method: OpenAPIV3_1.HttpMethods;
-    operation: OpenAPIV3_1.OperationObject<{
-        'x-scalar-stability': XScalarStability;
-    }>;
+    clientOptions: ClientOptionGroup[];
+    method: HttpMethodType;
+    operation: Dereference<OperationObject>;
+    oldOperation: OpenAPIV3_1.OperationObject;
+    parameters: ParameterObject[];
     isWebhook: boolean;
-    /**
-     * @deprecated Use `document` instead
-     */
-    collection: Collection;
-    server: Server | undefined;
-    request: Request | undefined;
+    securitySchemes: SecuritySchemeObject[];
+    server: ServerObject | undefined;
     schemas?: Schemas;
+    store: WorkspaceStore;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     "update:modelValue": (value: string) => any;

package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AAmMA,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,MAAM,EACP,MAAM,iCAAiC,CAAA;AAMxC,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAsBzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAI/C,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC;QACrC,oBAAoB,EAAE,gBAAgB,CAAA;KACvC,CAAC,CAAA;IACF,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAC;;;;;;AAiUF,wBAQG"}
+{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AAgNA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAOrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AACvG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AACtF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAoBlF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAA;AAIjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AAIvF,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,CAAA;IACvC,YAAY,EAAE,WAAW,CAAC,eAAe,CAAA;IACzC,UAAU,EAAE,eAAe,EAAE,CAAA;IAE7B,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,oBAAoB,EAAE,CAAA;IACvC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,cAAc,CAAA;CACtB,CAAC;;;;;;AAmVF,wBAQG"}

package/dist/features/Operation/layouts/ModernLayout.vue.js

@@ -1,7 +1,7 @@
 import o from "./ModernLayout.vue2.js";
-/* empty css                  */
+import "./ModernLayout.vue3.js";
 import t from "../../../_virtual/_plugin-vue_export-helper.js";
-const p = /* @__PURE__ */ t(o, [["__scopeId", "data-v-1030b20c"]]);
+const c = /* @__PURE__ */ t(o, [["__scopeId", "data-v-96cee8cf"]]);
 export {
-  p as default
+  c as default
 };