@scalar/api-reference 1.32.7 → 1.32.8

package/dist/features/example-responses/ExampleResponses.vue2.js

@@ -1,162 +1,155 @@
-import { defineComponent as M, useId as N, ref as E, computed as v, createBlock as r, createCommentVNode as x, openBlock as o, unref as s, withCtx as u, createVNode as f, createElementVNode as g, createElementBlock as k, Fragment as C, renderList as O, createTextVNode as R, toDisplayString as F, withDirectives as I, vModelCheckbox as A } from "vue";
-import { ScalarIcon as D, ScalarCodeBlock as K, ScalarMarkdown as P } from "@scalar/components";
-import { normalizeMimeTypeObject as U, getObjectKeys as H } from "@scalar/oas-utils/helpers";
-import { useClipboard as J } from "@scalar/use-hooks/useClipboard";
-import L from "../../components/ScreenReader.vue.js";
-import T from "./ExampleResponse.vue.js";
-import W from "../../components/Card/Card.vue.js";
-import q from "../../components/Card/CardTabHeader.vue.js";
-import G from "../../components/Card/CardTab.vue.js";
-import Q from "../../components/Card/CardContent.vue.js";
-import X from "../../components/Card/CardFooter.vue.js";
-import Y from "../example-request/ExamplePicker.vue.js";
-const Z = {
+import { defineComponent as N, useId as O, ref as R, computed as v, createBlock as t, createCommentVNode as x, openBlock as o, unref as l, withCtx as u, createVNode as f, createElementBlock as k, Fragment as _, renderList as C, createTextVNode as g, toDisplayString as F, withDirectives as I, createElementVNode as w, vModelCheckbox as A } from "vue";
+import { ScalarCard as D, ScalarIcon as K, ScalarCardSection as L, ScalarCodeBlock as U, ScalarCardFooter as J, ScalarMarkdown as P } from "@scalar/components";
+import { normalizeMimeTypeObject as W, getObjectKeys as $ } from "@scalar/oas-utils/helpers";
+import { useClipboard as q } from "@scalar/use-hooks/useClipboard";
+import G from "../../components/ScreenReader.vue.js";
+import j from "./ExampleResponse.vue.js";
+import H from "./ExampleResponseTab.vue.js";
+import Q from "./ExampleResponseTabList.vue.js";
+import X from "../../v2/blocks/scalar-request-example-block/components/ExamplePicker.vue2.js";
+const Y = {
   key: 1,
   class: "scalar-card-checkbox"
-}, $ = ["aria-controls"], z = { class: "scalar-card-container custom-scroll" }, ee = {
+}, Z = ["aria-controls"], z = {
   key: 1,
   class: "response-description"
-}, de = /* @__PURE__ */ M({
+}, ne = /* @__PURE__ */ N({
   __name: "ExampleResponses",
   props: {
     responses: {}
   },
-  setup(w) {
-    const n = N(), { copyToClipboard: V } = J(), p = E(), h = v(() => Object.keys(w.responses ?? {}).sort()), y = v(
-      () => !!l.value.examples
-    ), j = E(0), i = v(() => {
+  setup(E) {
+    const p = O(), { copyToClipboard: T } = q(), c = R(""), S = v(() => Object.keys(E.responses ?? {}).sort()), y = v(
+      () => !!s.value.examples
+    ), V = R(0), i = v(() => {
       var a;
-      const e = h.value[j.value];
-      return (a = w.responses) == null ? void 0 : a[e];
-    }), l = v(() => {
+      const e = S.value[V.value];
+      return (a = E.responses) == null ? void 0 : a[e];
+    }), s = v(() => {
       var m;
-      const e = U(
+      const e = W(
         (m = i.value) == null ? void 0 : m.content
-      ), a = H(e ?? {});
+      ), a = $(e ?? {});
       return (
         // OpenAPI 3.x
         (e == null ? void 0 : e["application/json"]) ?? (e == null ? void 0 : e["application/xml"]) ?? (e == null ? void 0 : e["text/plain"]) ?? (e == null ? void 0 : e["text/html"]) ?? (e == null ? void 0 : e["*/*"]) ?? // Take the first key - in the future we may want to use the selected content type
         (e == null ? void 0 : e[a[0]]) ?? // Swagger 2.0
         i.value
       );
-    }), _ = () => {
+    }), B = () => {
       if (!y.value)
-        return l.value.example;
-      if (Array.isArray(l.value.examples))
-        return l.value.examples[0];
-      const e = Object.keys(l.value.examples)[0];
-      return l.value.examples[e];
+        return s.value.example;
+      if (Array.isArray(s.value.examples))
+        return s.value.examples[0];
+      const e = Object.keys(s.value.examples)[0], a = s.value.examples[e];
+      return (a == null ? void 0 : a.value) ?? a;
     }, b = v(() => ({
-      ...l.value,
-      example: y.value && p.value ? l.value.examples[p.value].value ?? l.value.examples[p.value] : _()
-    })), B = (e) => {
-      j.value = e, p.value = void 0;
-    }, S = E(!1);
-    return (e, a) => h.value.length ? (o(), r(s(W), {
+      ...s.value,
+      example: y.value && c.value ? s.value.examples[c.value].value ?? s.value.examples[c.value] : B()
+    })), M = (e) => {
+      V.value = e, c.value = "";
+    }, h = R(!1);
+    return (e, a) => S.value.length ? (o(), t(l(D), {
       key: 0,
       "aria-label": "Example Responses",
-      role: "region"
+      role: "region",
+      class: "response-card"
     }, {
       default: u(() => {
         var m;
         return [
-          f(s(q), {
-            muted: "",
-            x: "as",
-            onChange: B
-          }, {
+          f(Q, { onChange: M }, {
             actions: u(() => {
-              var t, d;
+              var r, d;
               return [
-                (t = l.value) != null && t.example ? (o(), k("button", {
+                (r = s.value) != null && r.example ? (o(), k("button", {
                   key: 0,
                   class: "code-copy",
                   type: "button",
                   onClick: a[0] || (a[0] = () => {
-                    var c;
-                    return s(V)((c = l.value) == null ? void 0 : c.example);
+                    var n;
+                    return l(T)((n = s.value) == null ? void 0 : n.example);
                   })
                 }, [
-                  f(s(D), {
+                  f(l(K), {
                     icon: "Clipboard",
                     width: "12px"
                   })
                 ])) : x("", !0),
-                (d = l.value) != null && d.schema ? (o(), k("label", Z, [
-                  a[4] || (a[4] = R(" Show Schema ")),
-                  I(g("input", {
-                    "onUpdate:modelValue": a[1] || (a[1] = (c) => S.value = c),
-                    "aria-controls": s(n),
+                (d = s.value) != null && d.schema ? (o(), k("label", Y, [
+                  a[4] || (a[4] = g(" Show Schema ")),
+                  I(w("input", {
+                    "onUpdate:modelValue": a[1] || (a[1] = (n) => h.value = n),
+                    "aria-controls": l(p),
                     class: "scalar-card-checkbox-input",
                     type: "checkbox"
-                  }, null, 8, $), [
-                    [A, S.value]
+                  }, null, 8, Z), [
+                    [A, h.value]
                   ]),
-                  a[5] || (a[5] = g("span", { class: "scalar-card-checkbox-checkmark" }, null, -1))
+                  a[5] || (a[5] = w("span", { class: "scalar-card-checkbox-checkmark" }, null, -1))
                 ])) : x("", !0)
               ];
             }),
             default: u(() => [
-              (o(!0), k(C, null, O(h.value, (t) => (o(), r(s(G), {
-                key: t,
-                "aria-controls": s(n)
+              (o(!0), k(_, null, C(S.value, (r) => (o(), t(H, {
+                key: r,
+                "aria-controls": l(p)
               }, {
                 default: u(() => [
-                  f(L, null, {
+                  f(G, null, {
                     default: u(() => a[3] || (a[3] = [
-                      R("Status:")
+                      g("Status:")
                     ])),
-                    _: 1
+                    _: 1,
+                    __: [3]
                   }),
-                  R(" " + F(t), 1)
+                  g(" " + F(r), 1)
                 ]),
                 _: 2
               }, 1032, ["aria-controls"]))), 128))
             ]),
             _: 1
           }),
-          g("div", z, [
-            f(s(Q), { muted: "" }, {
-              default: u(() => {
-                var t;
-                return [
-                  (t = l.value) != null && t.schema ? (o(), k(C, { key: 0 }, [
-                    S.value && b.value ? (o(), r(s(K), {
-                      key: 0,
-                      id: s(n),
-                      class: "-outline-offset-2",
-                      content: b.value,
-                      lang: "json"
-                    }, null, 8, ["id", "content"])) : (o(), r(T, {
-                      key: 1,
-                      id: s(n),
-                      response: b.value
-                    }, null, 8, ["id", "response"]))
-                  ], 64)) : (o(), r(T, {
+          f(l(L), { class: "grid flex-1" }, {
+            default: u(() => {
+              var r;
+              return [
+                (r = s.value) != null && r.schema ? (o(), k(_, { key: 0 }, [
+                  h.value && b.value ? (o(), t(l(U), {
+                    key: 0,
+                    id: l(p),
+                    class: "-outline-offset-2",
+                    content: b.value,
+                    lang: "json"
+                  }, null, 8, ["id", "content"])) : (o(), t(j, {
                     key: 1,
-                    id: s(n),
+                    id: l(p),
                     response: b.value
                   }, null, 8, ["id", "response"]))
-                ];
-              }),
-              _: 1
-            })
-          ]),
-          (m = i.value) != null && m.description || y.value ? (o(), r(s(X), {
+                ], 64)) : (o(), t(j, {
+                  key: 1,
+                  id: l(p),
+                  response: b.value
+                }, null, 8, ["id", "response"]))
+              ];
+            }),
+            _: 1
+          }),
+          (m = i.value) != null && m.description || y.value ? (o(), t(l(J), {
             key: 0,
-            class: "response-card-footer",
-            muted: ""
+            class: "response-card-footer"
           }, {
             default: u(() => {
-              var t, d;
+              var r, d;
               return [
-                y.value ? (o(), r(s(Y), {
+                y.value ? (o(), t(l(X), {
                   key: 0,
                   class: "response-example-selector",
-                  examples: (t = l.value) == null ? void 0 : t.examples,
-                  "onUpdate:modelValue": a[2] || (a[2] = (c) => p.value = c)
-                }, null, 8, ["examples"])) : (d = i.value) != null && d.description ? (o(), k("div", ee, [
-                  f(s(P), {
+                  examples: (r = s.value) == null ? void 0 : r.examples,
+                  modelValue: c.value,
+                  "onUpdate:modelValue": a[2] || (a[2] = (n) => c.value = n)
+                }, null, 8, ["examples", "modelValue"])) : (d = i.value) != null && d.description ? (o(), k("div", z, [
+                  f(l(P), {
                     class: "markdown",
                     value: i.value.description
                   }, null, 8, ["value"])
@@ -172,5 +165,5 @@ const Z = {
   }
 });
 export {
-  de as default
+  ne as default
 };

package/dist/features/test-request-button/TestRequestButton.vue.d.ts

@@ -1,6 +1,7 @@
-import type { Request as RequestEntity } from '@scalar/oas-utils/entities/spec';
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 type __VLS_Props = {
-    operation?: Pick<RequestEntity, 'method' | 'path' | 'uid'>;
+    method: HttpMethod;
+    path: string;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/features/test-request-button/TestRequestButton.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TestRequestButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/test-request-button/TestRequestButton.vue"],"names":[],"mappings":"AAmFA,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAS/E,KAAK,WAAW,GAAG;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,CAAA;CAC3D,CAAC;;AAsGF,wBAMG"}
+{"version":3,"file":"TestRequestButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/test-request-button/TestRequestButton.vue"],"names":[],"mappings":"AAkFA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAUnE,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACb,CAAC;;AAsGF,wBAMG"}

package/dist/features/test-request-button/TestRequestButton.vue.js

@@ -1,7 +1,7 @@
 import t from "./TestRequestButton.vue2.js";
 /* empty css                       */
 import o from "../../_virtual/_plugin-vue_export-helper.js";
-const a = /* @__PURE__ */ o(t, [["__scopeId", "data-v-958886da"]]);
+const m = /* @__PURE__ */ o(t, [["__scopeId", "data-v-db173467"]]);
 export {
-  a as default
+  m as default
 };

package/dist/features/test-request-button/TestRequestButton.vue2.js

@@ -1,42 +1,44 @@
-import { defineComponent as d, computed as c, createElementBlock as i, openBlock as r, withModifiers as f, createVNode as a, createElementVNode as h, unref as k, withCtx as C, createTextVNode as s, toDisplayString as u, Fragment as y } from "vue";
-import { ScalarIcon as B } from "@scalar/components";
-import b from "../../components/ScreenReader.vue.js";
-import { useConfig as g } from "../../hooks/useConfig.js";
-import { useApiClient as q } from "../api-client-modal/useApiClient.js";
-const v = ["method"], S = /* @__PURE__ */ d({
+import { defineComponent as c, computed as d, createElementBlock as n, openBlock as i, withModifiers as h, createVNode as s, createElementVNode as f, unref as k, withCtx as C, createTextVNode as l, toDisplayString as r, Fragment as g } from "vue";
+import { ScalarIconPlay as y } from "@scalar/icons";
+import B from "../../components/ScreenReader.vue.js";
+import { useConfig as b } from "../../hooks/useConfig.js";
+import { useApiClient as w } from "../api-client-modal/useApiClient.js";
+const R = ["method"], S = /* @__PURE__ */ c({
   __name: "TestRequestButton",
   props: {
-    operation: {}
+    method: {},
+    path: {}
   },
-  setup(o) {
-    const { client: t } = q(), p = g(), l = c(
-      () => p.value.hideTestRequestButton !== !0
-    ), m = () => {
+  setup(t) {
+    const { client: a } = w(), m = b(), u = d(
+      () => m.value.hideTestRequestButton !== !0
+    ), p = () => {
       var e;
-      o.operation && ((e = t == null ? void 0 : t.value) != null && e.open) && t.value.open({
-        requestUid: o.operation.uid
+      (e = a.value) == null || e.open({
+        method: t.method,
+        path: t.path
       });
     };
-    return (e, n) => e.operation && l.value ? (r(), i("button", {
+    return (e, o) => u.value ? (i(), n("button", {
       key: 0,
       class: "show-api-client-button",
-      method: e.operation.method,
+      method: e.method,
       type: "button",
-      onClick: f(m, ["stop"])
+      onClick: h(p, ["stop"])
     }, [
-      a(k(B), {
-        icon: "Play",
-        size: "sm"
+      s(k(y), {
+        class: "size-3",
+        weight: "fill"
       }),
-      n[0] || (n[0] = h("span", null, "Test Request", -1)),
-      a(b, null, {
+      o[0] || (o[0] = f("span", null, "Test Request", -1)),
+      s(B, null, {
         default: C(() => [
-          s("(" + u(e.operation.method) + " " + u(e.operation.path) + ")", 1)
+          l("(" + r(e.method) + " " + r(e.path) + ")", 1)
         ]),
         _: 1
       })
-    ], 8, v)) : (r(), i(y, { key: 1 }, [
-      s(" ")
+    ], 8, R)) : (i(), n(g, { key: 1 }, [
+      l(" ")
     ], 64));
   }
 });

package/dist/helpers/convert-security-scheme.js

@@ -0,0 +1,23 @@
+const e = (r) => r.type === "apiKey" ? {
+  ...r,
+  "x-scalar-secret-token": r.value
+} : r.type === "http" ? {
+  ...r,
+  "x-scalar-secret-token": r.token,
+  "x-scalar-secret-username": r.username,
+  "x-scalar-secret-password": r.password
+} : r.type === "oauth2" ? {
+  ...r,
+  flows: Object.fromEntries(
+    Object.entries(r.flows).map(([a, t]) => [
+      a,
+      t && {
+        ...t,
+        "x-scalar-secret-token": t.token
+      }
+    ])
+  )
+} : r;
+export {
+  e as convertSecurityScheme
+};

package/dist/index.d.ts

@@ -4,10 +4,8 @@ export { SearchButton, SearchModal } from './features/Search';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
 export { createApiReference } from './standalone/lib/html-api.js';
 export { useSidebar, Sidebar } from './features/sidebar';
-export { Card, CardHeader, CardContent, CardFooter, CardTabHeader, CardTab } from './components/Card';
 export { parse } from './helpers/parse.js';
 export { createEmptySpecification } from './libs/openapi.js';
 export { useNavState } from './hooks/useNavState.js';
-export { useHttpClientStore } from './stores/useHttpClientStore.js';
 export type { ApiReferenceConfiguration, ReferenceProps, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAE3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAExD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAGrG,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAE3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAGxD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}