@scalar/api-reference 1.31.8 → 1.31.9

package/dist/features/ExampleRequest/ExampleRequest.vue2.js

@@ -1,125 +1,145 @@
-import { defineComponent as ce, useId as me, ref as T, inject as z, computed as c, watch as L, onMounted as de, createBlock as V, createCommentVNode as j, unref as l, openBlock as y, withCtx as n, createVNode as s, createElementVNode as w, renderSlot as S, createTextVNode as h, createElementBlock as B, Fragment as W, toDisplayString as R } from "vue";
-import { useWorkspace as pe } from "@scalar/api-client/store";
-import { getSnippet as fe } from "@scalar/api-client/views/Components/CodeSnippet";
-import { filterSecurityRequirements as ye } from "@scalar/api-client/views/Request/RequestSection";
-import { ScalarCodeBlock as ve } from "@scalar/components";
-import { freezeElement as ge } from "@scalar/helpers/dom/freeze-element";
-import J from "../../components/ScreenReader.vue.js";
-import { useConfig as xe } from "../../hooks/useConfig.js";
-import { EXAMPLE_CONTEXT as he, DISCRIMINATOR_CONTEXT as Ee } from "../../hooks/useDiscriminator.js";
-import { useHttpClientStore as Ke } from "../../stores/useHttpClientStore.js";
-import be from "./ExamplePicker.vue.js";
-import ke from "./TextSelect.vue.js";
+import { defineComponent as pe, useId as fe, ref as R, inject as Q, computed as c, watch as Y, onMounted as ye, createBlock as w, createCommentVNode as J, unref as r, openBlock as g, withCtx as s, createVNode as n, createElementVNode as U, renderSlot as N, createTextVNode as K, createElementBlock as D, Fragment as Z, toDisplayString as I } from "vue";
+import { useWorkspace as ve } from "@scalar/api-client/store";
+import { getSnippet as ge } from "@scalar/api-client/views/Components/CodeSnippet";
+import { filterSecurityRequirements as xe } from "@scalar/api-client/views/Request/RequestSection";
+import { ScalarCodeBlock as he } from "@scalar/components";
+import { freezeElement as qe } from "@scalar/helpers/dom/freeze-element";
+import { requestSchema as Ee, createExampleFromRequest as Ke } from "@scalar/oas-utils/entities/spec";
+import { isDereferenced as be } from "@scalar/openapi-types/helpers";
+import H from "../../components/ScreenReader.vue.js";
+import { useConfig as Se } from "../../hooks/useConfig.js";
+import { EXAMPLE_CONTEXT as ke, DISCRIMINATOR_CONTEXT as Ce } from "../../hooks/useDiscriminator.js";
+import { useHttpClientStore as Oe } from "../../stores/useHttpClientStore.js";
+import Ne from "./ExamplePicker.vue.js";
+import $e from "./TextSelect.vue.js";
 /* empty css                */
-import G from "../../components/Card/Card.vue.js";
-import Se from "../../components/Card/CardHeader.vue.js";
-import Q from "../../components/HttpMethod/HttpMethod.vue.js";
-import Y from "../../components/Card/CardContent.vue.js";
-import Oe from "../../components/Card/CardFooter.vue.js";
-import { useExampleStore as Ce } from "../../legacy/stores/useExampleStore.js";
-const qe = ["id"], Ne = ["id"], $e = {
+import _ from "../../components/Card/Card.vue.js";
+import Te from "../../components/Card/CardHeader.vue.js";
+import ee from "../../components/HttpMethod/HttpMethod.vue.js";
+import te from "../../components/Card/CardContent.vue.js";
+import Ve from "../../components/Card/CardFooter.vue.js";
+import { useExampleStore as Be } from "../../legacy/stores/useExampleStore.js";
+const je = ["id"], Re = ["id"], we = {
   key: 0,
   class: "request-card-footer-addon"
-}, Te = { class: "request-header" }, Qe = /* @__PURE__ */ ce({
+}, Je = { class: "request-header" }, rt = /* @__PURE__ */ pe({
   __name: "ExampleRequest",
   props: {
-    operation: {},
     server: {},
     collection: {},
+    operation: {},
+    request: {},
+    method: {},
     fallback: { type: Boolean },
-    transformedOperation: {},
     schemas: {}
   },
-  setup(o) {
-    const { selectedExampleKey: D, operationId: Z } = Ce(), { requestExamples: E, securitySchemes: H, requestExampleMutators: O } = pe(), _ = xe(), {
-      httpClient: i,
-      setHttpClient: ee,
-      availableTargets: I,
-      httpTargetTitle: te,
-      httpClientTitle: ae
-    } = Ke(), K = me(), v = T(!1), b = z(he), d = z(Ee), C = c(() => {
+  setup(l) {
+    const { selectedExampleKey: M, operationId: ae } = Be(), { requestExamples: b, securitySchemes: A, requestExampleMutators: $ } = ve(), le = Se(), {
+      httpClient: u,
+      setHttpClient: re,
+      availableTargets: F,
+      httpTargetTitle: oe,
+      httpClientTitle: se
+    } = Oe(), S = fe(), x = R(!1), k = Q(ke), y = Q(Ce), T = c(() => {
       var e;
-      return (e = d == null ? void 0 : d.value) == null ? void 0 : e.selectedType;
-    }), M = c(
+      return (e = y == null ? void 0 : y.value) == null ? void 0 : e.selectedType;
+    }), P = c(
       () => {
         var e;
-        return ((e = d == null ? void 0 : d.value) == null ? void 0 : e.hasDiscriminator) || !1;
+        return ((e = y == null ? void 0 : y.value) == null ? void 0 : e.hasDiscriminator) || !1;
       }
-    ), m = c(() => {
+    ), d = c(() => {
       var t;
       const e = ["x-custom-examples", "x-codeSamples", "x-code-samples"];
       for (const a of e)
-        if ((t = o.transformedOperation.information) != null && t[a])
-          return [...o.transformedOperation.information[a]];
+        if ((t = l.operation) != null && t[a])
+          return [...l.operation[a]];
       return [];
-    }), r = T(
+    }), o = R(
       // Default to first custom example
-      m.value.length ? {
+      d.value.length ? {
         targetKey: "customExamples",
         clientKey: 0
       } : (
         // Otherwise use the globally selected HTTP client
         {
-          targetKey: i.targetKey,
-          clientKey: i.clientKey
+          targetKey: u.targetKey,
+          clientKey: u.clientKey
         }
       )
     );
-    L(i, () => {
-      r.value = {
-        targetKey: i.targetKey,
-        clientKey: i.clientKey
+    Y(u, () => {
+      o.value = {
+        targetKey: u.targetKey,
+        clientKey: u.clientKey
       };
     });
-    const U = c(() => {
-      const e = q.value;
+    const X = c(() => {
+      const e = C.value;
       return Object.keys(e).length > 1;
-    }), le = () => {
-      var x;
-      if (r.value.targetKey === "customExamples")
-        return ((x = m.value[r.value.clientKey]) == null ? void 0 : x.source) ?? "";
-      const e = i.clientKey, t = i.targetKey, a = E[o.operation.examples[0]];
-      if (!a)
-        return "";
-      const u = ye(
-        o.operation.security || o.collection.security,
-        o.collection.selectedSecuritySchemeUids,
-        H
-      ), [g, k] = fe(t, e, {
-        operation: o.operation,
-        example: a,
-        server: o.server,
-        securitySchemes: u
+    }), ne = () => {
+      var h, q, E;
+      if (o.value.targetKey === "customExamples")
+        return ((h = d.value[o.value.clientKey]) == null ? void 0 : h.source) ?? "";
+      const e = u.clientKey, t = u.targetKey, a = l.request || Ee.parse({
+        uid: l.operation.operationId || "temp-request",
+        method: l.method,
+        path: l.operation.path,
+        parameters: l.operation.parameters || [],
+        requestBody: l.operation.requestBody,
+        examples: [],
+        type: "request",
+        selectedSecuritySchemeUids: [],
+        selectedServerUid: "",
+        servers: [],
+        summary: l.operation.summary || "Example Request"
+      });
+      let i = b[((E = (q = l.request) == null ? void 0 : q.examples) == null ? void 0 : E[0]) ?? ""];
+      if (!i) {
+        const m = C.value, B = Object.keys(m)[0];
+        i = Ke(a, B);
+      }
+      const p = xe(
+        l.operation.security || l.collection.security,
+        l.collection.selectedSecuritySchemeUids,
+        A
+      ), [f, O] = ge(t, e, {
+        operation: l.request,
+        example: i,
+        server: l.server,
+        securitySchemes: p
       });
-      return g ? g.message ?? "" : k;
-    }, A = c(() => {
+      return f ? f.message ?? "" : O;
+    }, z = c(() => {
       try {
-        return le();
+        return ne();
       } catch (e) {
         return console.error("[generateSnippet]", e), "";
       }
-    }), q = c(() => {
-      var a, u;
-      const e = ((u = (a = o.transformedOperation.information) == null ? void 0 : a.requestBody) == null ? void 0 : u.content) ?? {}, t = Object.values(e)[0];
+    }), C = c(() => {
+      var a;
+      if (!be(l.operation.requestBody))
+        return {};
+      const e = ((a = l.operation.requestBody) == null ? void 0 : a.content) ?? {}, t = Object.values(e)[0];
       return (t == null ? void 0 : t.examples) ?? {};
-    }), oe = c(() => {
+    }), ue = c(() => {
       var t, a;
       const e = (
         // Specified language
-        ((t = r.value) == null ? void 0 : t.targetKey) === "customExamples" ? ((a = m.value[r.value.clientKey]) == null ? void 0 : a.lang) ?? "plaintext" : (
+        ((t = o.value) == null ? void 0 : t.targetKey) === "customExamples" ? ((a = d.value[o.value.clientKey]) == null ? void 0 : a.lang) ?? "plaintext" : (
           // Or language for the globally selected HTTP client
-          i.targetKey
+          u.targetKey
         )
       );
-      return e === "shell" && A.value.includes("curl") ? "curl" : e === "Objective-C" ? "objc" : e;
-    }), re = c(
-      () => Object.values(H).flatMap((e) => e.type === "apiKey" ? e.value : (e == null ? void 0 : e.type) === "http" ? [
+      return e === "shell" && z.value.includes("curl") ? "curl" : e === "Objective-C" ? "objc" : e;
+    }), ie = c(
+      () => Object.values(A).flatMap((e) => e.type === "apiKey" ? e.value : (e == null ? void 0 : e.type) === "http" ? [
         e.token,
         e.password,
         btoa(`${e.username}:${e.password}`)
       ] : e.type === "oauth2" ? Object.values(e.flows).map((t) => t.token) : [])
-    ), ne = c(() => {
-      const e = I.value.map((t) => ({
+    ), ce = c(() => {
+      const e = F.value.map((t) => ({
         value: t.key,
         label: t.title,
         options: t.clients.map((a) => ({
@@ -130,10 +150,10 @@ const qe = ["id"], Ne = ["id"], $e = {
           label: a.title
         }))
       }));
-      return m.value.length && e.unshift({
+      return d.value.length && e.unshift({
         value: "customExamples",
         label: "Examples",
-        options: m.value.map((t, a) => ({
+        options: d.value.map((t, a) => ({
           value: JSON.stringify({
             targetKey: "customExamples",
             clientKey: a
@@ -141,198 +161,199 @@ const qe = ["id"], Ne = ["id"], $e = {
           label: t.label ?? t.lang ?? `Example #${a + 1}`
         }))
       }), e;
-    }), N = T(null);
-    function se(e) {
+    }), V = R(null);
+    function me(e) {
       const t = JSON.parse(e);
-      if (N.value) {
-        const a = ge(N.value.$el);
+      if (V.value) {
+        const a = qe(V.value.$el);
         setTimeout(() => {
           a();
         }, 300);
       }
-      t.targetKey === "customExamples" || r.value.targetKey === "customExamples" && t.targetKey === i.targetKey && t.clientKey === i.clientKey ? r.value = t : ee(t);
+      t.targetKey === "customExamples" || o.value.targetKey === "customExamples" && t.targetKey === u.targetKey && t.clientKey === u.clientKey ? o.value = t : re(t);
     }
-    function ie(e) {
-      D.value = e, Z.value = o.operation.operationId;
-      const t = E[o.operation.examples[0]], a = q.value[e];
+    function de(e) {
+      var i, p;
+      M.value = e, ae.value = l.operation.operationId;
+      const t = b[((p = (i = l.request) == null ? void 0 : i.examples) == null ? void 0 : p[0]) ?? ""], a = C.value[e];
       if (t && (a != null && a.value))
         try {
-          O.edit(
+          $.edit(
             t.uid,
             "body.raw.value",
             JSON.stringify(a.value, null, 2)
           );
-        } catch (u) {
-          console.error("[handleExampleUpdate]", u);
+        } catch (f) {
+          console.error("[handleExampleUpdate]", f);
         }
     }
-    de(() => {
-      M.value && C.value && !v.value && F(C.value);
+    ye(() => {
+      P.value && T.value && !x.value && L(T.value);
     });
-    const F = (e) => {
-      var t, a, u, g, k, x;
-      if (!v.value)
+    const L = (e) => {
+      var t, a, i, p, f, O, h, q, E;
+      if (!x.value)
         try {
-          v.value = !0;
-          const p = E[o.operation.examples[0]];
-          if (p && (b != null && b.generateExampleValue)) {
-            const ue = (a = (t = p.body) == null ? void 0 : t.raw) != null && a.value ? JSON.parse(p.body.raw.value) : void 0, $ = b.generateExampleValue(
-              Array.isArray(ue)
+          x.value = !0;
+          const m = b[l.operation.examples[0]];
+          if (m && (k != null && k.generateExampleValue)) {
+            const B = (a = (t = m.body) == null ? void 0 : t.raw) != null && a.value ? JSON.parse(m.body.raw.value) : void 0, j = k.generateExampleValue(
+              Array.isArray(B)
             );
-            if (O.edit(
-              p.uid,
+            if ($.edit(
+              m.uid,
               "body.raw.value",
-              JSON.stringify($, null, 2)
-            ), o.operation.examples[0]) {
-              const f = E[o.operation.examples[0]];
-              f && O.edit(
-                f.uid,
+              JSON.stringify(j, null, 2)
+            ), (p = (i = l.request) == null ? void 0 : i.examples) != null && p[0]) {
+              const v = b[(O = (f = l.request) == null ? void 0 : f.examples) == null ? void 0 : O[0]];
+              v && $.edit(
+                v.uid,
                 "body.raw.value",
-                JSON.stringify($, null, 2)
+                JSON.stringify(j, null, 2)
               );
             }
-            if ((x = (k = (g = (u = o.transformedOperation.information) == null ? void 0 : u.requestBody) == null ? void 0 : g.content) == null ? void 0 : k["application/json"]) != null && x.examples) {
-              const f = o.transformedOperation.information.requestBody.content["application/json"].examples;
-              Object.keys(f).forEach((P) => {
-                var X;
-                (X = f[P]) != null && X.value && (f[P].value = $);
+            if ((E = (q = (h = l.operation.requestBody) == null ? void 0 : h.content) == null ? void 0 : q["application/json"]) != null && E.examples) {
+              const v = l.operation.requestBody.content["application/json"].examples;
+              Object.keys(v).forEach((W) => {
+                var G;
+                (G = v[W]) != null && G.value && (v[W].value = j);
               });
             }
           }
-        } catch (p) {
-          console.error("[handleDiscriminatorChange]", p);
+        } catch (m) {
+          console.error("[handleDiscriminatorChange]", m);
         } finally {
-          v.value = !1;
+          x.value = !1;
         }
     };
-    return L(C, (e) => {
-      e && M.value && !v.value && F();
-    }), (e, t) => l(I).length || m.value.length ? (y(), V(l(G), {
+    return Y(T, (e) => {
+      e && P.value && !x.value && L();
+    }), (e, t) => r(F).length || d.value.length ? (g(), w(r(_), {
       key: 0,
-      "aria-labelledby": `${l(K)}-header`,
+      "aria-labelledby": `${r(S)}-header`,
       class: "dark-mode",
       ref_key: "elem",
-      ref: N,
+      ref: V,
       role: "region"
     }, {
-      default: n(() => [
-        s(l(Se), { muted: "" }, {
-          actions: n(() => [
-            s(ke, {
+      default: s(() => [
+        n(r(Te), { muted: "" }, {
+          actions: s(() => [
+            n($e, {
               class: "request-client-picker",
-              controls: `${l(K)}-example`,
-              modelValue: JSON.stringify(r.value),
-              options: ne.value,
-              "onUpdate:modelValue": se
+              controls: `${r(S)}-example`,
+              modelValue: JSON.stringify(o.value),
+              options: ce.value,
+              "onUpdate:modelValue": me
             }, {
-              default: n(() => [
-                r.value.targetKey === "customExamples" ? (y(), B(W, { key: 0 }, [
-                  s(J, null, {
-                    default: n(() => t[1] || (t[1] = [
-                      h("Selected Example:")
+              default: s(() => [
+                o.value.targetKey === "customExamples" ? (g(), D(Z, { key: 0 }, [
+                  n(H, null, {
+                    default: s(() => t[1] || (t[1] = [
+                      K("Selected Example:")
                     ])),
                     _: 1
                   }),
-                  h(" " + R(m.value[r.value.clientKey].label ?? "Example"), 1)
-                ], 64)) : (y(), B(W, { key: 1 }, [
-                  s(J, null, {
-                    default: n(() => t[2] || (t[2] = [
-                      h("Selected HTTP client:")
+                  K(" " + I(d.value[o.value.clientKey].label ?? "Example"), 1)
+                ], 64)) : (g(), D(Z, { key: 1 }, [
+                  n(H, null, {
+                    default: s(() => t[2] || (t[2] = [
+                      K("Selected HTTP client:")
                     ])),
                     _: 1
                   }),
-                  h(" " + R(l(te)) + " " + R(l(ae)), 1)
+                  K(" " + I(r(oe)) + " " + I(r(se)), 1)
                 ], 64))
               ]),
               _: 1
             }, 8, ["controls", "modelValue", "options"])
           ]),
-          default: n(() => [
-            w("div", {
-              id: `${l(K)}-header`,
+          default: s(() => [
+            U("div", {
+              id: `${r(S)}-header`,
               class: "request-header"
             }, [
-              s(J, null, {
-                default: n(() => t[0] || (t[0] = [
-                  h("Request Example for")
+              n(H, null, {
+                default: s(() => t[0] || (t[0] = [
+                  K("Request Example for")
                 ])),
                 _: 1
               }),
-              s(l(Q), {
+              n(r(ee), {
                 as: "span",
                 class: "request-method",
-                method: e.operation.method
+                method: e.method
               }, null, 8, ["method"]),
-              S(e.$slots, "header", {}, void 0, !0)
-            ], 8, qe)
+              N(e.$slots, "header", {}, void 0, !0)
+            ], 8, je)
           ]),
           _: 3
         }),
-        s(l(Y), {
+        n(r(te), {
           borderless: "",
           class: "request-editor-section custom-scroll",
           frameless: ""
         }, {
-          default: n(() => [
-            w("div", {
-              id: `${l(K)}-example`,
+          default: s(() => [
+            U("div", {
+              id: `${r(S)}-example`,
               class: "code-snippet"
             }, [
-              s(l(ve), {
+              n(r(he), {
                 class: "bg-b-2 -outline-offset-2",
-                content: A.value,
-                hideCredentials: re.value,
-                lang: oe.value,
+                content: z.value,
+                hideCredentials: ie.value,
+                lang: ue.value,
                 lineNumbers: ""
               }, null, 8, ["content", "hideCredentials", "lang"])
-            ], 8, Ne)
+            ], 8, Re)
           ]),
           _: 1
         }),
-        (U.value || !l(_).hideTestRequestButton) && e.$slots.footer ? (y(), V(l(Oe), {
+        (X.value || !r(le).hideTestRequestButton) && e.$slots.footer ? (g(), w(r(Ve), {
           key: 0,
           class: "request-card-footer",
           contrast: ""
         }, {
-          default: n(() => [
-            U.value ? (y(), B("div", $e, [
-              s(be, {
+          default: s(() => [
+            X.value ? (g(), D("div", we, [
+              n(Ne, {
                 class: "request-example-selector",
-                examples: q.value,
-                modelValue: l(D),
-                "onUpdate:modelValue": ie
+                examples: C.value,
+                modelValue: r(M),
+                "onUpdate:modelValue": de
               }, null, 8, ["examples", "modelValue"])
-            ])) : j("", !0),
-            S(e.$slots, "footer", {}, void 0, !0)
+            ])) : J("", !0),
+            N(e.$slots, "footer", {}, void 0, !0)
           ]),
           _: 3
-        })) : j("", !0)
+        })) : J("", !0)
       ]),
       _: 3
-    }, 8, ["aria-labelledby"])) : e.fallback ? (y(), V(l(G), {
+    }, 8, ["aria-labelledby"])) : e.fallback ? (g(), w(r(_), {
       key: 1,
       class: "dark-mode"
     }, {
-      default: n(() => [
-        s(l(Y), { class: "request-card-simple" }, {
-          default: n(() => [
-            w("div", Te, [
-              s(l(Q), {
+      default: s(() => [
+        n(r(te), { class: "request-card-simple" }, {
+          default: s(() => [
+            U("div", Je, [
+              n(r(ee), {
                 as: "span",
                 class: "request-method",
-                method: e.operation.method
+                method: e.method
               }, null, 8, ["method"]),
-              S(e.$slots, "header", {}, void 0, !0)
+              N(e.$slots, "header", {}, void 0, !0)
             ]),
-            S(e.$slots, "footer", {}, void 0, !0)
+            N(e.$slots, "footer", {}, void 0, !0)
           ]),
           _: 3
         })
       ]),
       _: 3
-    })) : j("", !0);
+    })) : J("", !0);
   }
 });
 export {
-  Qe as default
+  rt as default
 };

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

@@ -2,7 +2,6 @@ import type { Collection, Server } from '@scalar/oas-utils/entities/spec';
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { TransformedOperation } from '@scalar/types/legacy';
 type __VLS_Props = {
-    id?: string;
     layout?: 'modern' | 'classic';
     transformedOperation: TransformedOperation;
     collection: Collection;

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

@@ -1 +1 @@
-{"version":3,"file":"Operation.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Operation/Operation.vue"],"names":[],"mappings":"AAsGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAahE,KAAK,WAAW,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC7B,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,OAAO,CAAA;CAC7D,CAAC;;AA4JF,wBAMG"}
+{"version":3,"file":"Operation.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Operation/Operation.vue"],"names":[],"mappings":"AAiGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAYhE,KAAK,WAAW,GAAG;IACjB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC7B,oBAAoB,EAAE,oBAAoB,CAAA;IAC1C,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC,GAAG,OAAO,CAAA;CAC7D,CAAC;;AA2JF,wBAMG"}