@scalar/api-reference 1.25.69 → 1.25.71

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

@@ -0,0 +1,114 @@
+import { defineComponent as m, inject as f, openBlock as r, createBlock as s, unref as e, createSlots as h, withCtx as n, createElementVNode as t, createVNode as i, toDisplayString as u, createCommentVNode as _, withModifiers as v } from "vue";
+import y from "../../../components/OperationPath.vue.js";
+import { ScalarIcon as b, ScalarIconButton as C, ScalarMarkdown as S } from "@scalar/components";
+import { useClipboard as k } from "@scalar/use-hooks/useClipboard";
+import T from "../components/OperationParameters.vue.js";
+import B from "../components/OperationResponses.vue.js";
+import E from "../../../components/Section/SectionAccordion.vue.js";
+import R from "../../../components/HttpMethod/HttpMethod.vue.js";
+import I from "../../../components/Anchor/Anchor.vue.js";
+import g from "../../TestRequestButton/TestRequestButton.vue.js";
+import w from "../../ExampleResponses/ExampleResponses.vue.js";
+import N from "../../ExampleRequest/ExampleRequest.vue.js";
+import { HIDE_TEST_REQUEST_BUTTON_SYMBOL as V } from "../../../helpers/provideSymbols.js";
+const $ = { class: "operation-title" }, q = { class: "operation-details" }, L = { class: "endpoint-label" }, M = { class: "endpoint-label-path" }, O = { class: "endpoint-label-name" }, U = { class: "endpoint-content" }, A = { class: "operation-details-card" }, D = { class: "operation-details-card-item" }, H = { class: "operation-details-card-item" }, to = /* @__PURE__ */ m({
+  __name: "ClassicLayout",
+  props: {
+    id: {},
+    operation: {}
+  },
+  setup(P) {
+    const { copyToClipboard: d } = k(), c = f(V);
+    return (o, p) => (r(), s(e(E), {
+      id: o.id,
+      class: "reference-endpoint",
+      transparent: ""
+    }, h({
+      title: n(() => [
+        t("h3", $, [
+          t("div", q, [
+            i(e(R), {
+              class: "endpoint-type",
+              method: o.operation.httpVerb,
+              short: ""
+            }, null, 8, ["method"]),
+            i(e(I), {
+              id: o.id ?? "",
+              class: "endpoint-anchor"
+            }, {
+              default: n(() => {
+                var a;
+                return [
+                  t("div", L, [
+                    t("div", M, [
+                      i(y, {
+                        deprecated: (a = o.operation.information) == null ? void 0 : a.deprecated,
+                        path: o.operation.path
+                      }, null, 8, ["deprecated", "path"])
+                    ]),
+                    t("div", O, u(o.operation.name), 1)
+                  ])
+                ];
+              }),
+              _: 1
+            }, 8, ["id"])
+          ])
+        ])
+      ]),
+      actions: n(({ active: a }) => {
+        var l;
+        return [
+          a ? (r(), s(e(g), {
+            key: 0,
+            operation: o.operation
+          }, null, 8, ["operation"])) : (l = e(c)) != null && l() ? _("", !0) : (r(), s(e(b), {
+            key: 1,
+            class: "endpoint-try-hint",
+            icon: "Play",
+            thickness: "1.75px"
+          })),
+          i(e(C), {
+            class: "endpoint-copy",
+            icon: "Clipboard",
+            label: "Copy endpoint URL",
+            size: "xs",
+            variant: "ghost",
+            onClick: p[0] || (p[0] = v((j) => e(d)(o.operation.path), ["stop"]))
+          })
+        ];
+      }),
+      default: n(() => [
+        t("div", U, [
+          t("div", A, [
+            t("div", D, [
+              i(T, { operation: o.operation }, null, 8, ["operation"])
+            ]),
+            t("div", H, [
+              i(B, {
+                collapsableItems: !1,
+                operation: o.operation
+              }, null, 8, ["operation"])
+            ])
+          ]),
+          i(e(w), { operation: o.operation }, null, 8, ["operation"]),
+          i(e(N), { operation: o.operation }, null, 8, ["operation"])
+        ])
+      ]),
+      _: 2
+    }, [
+      o.operation.description ? {
+        name: "description",
+        fn: n(() => [
+          i(e(S), {
+            value: o.operation.description,
+            withImages: ""
+          }, null, 8, ["value"])
+        ]),
+        key: "0"
+      } : void 0
+    ]), 1032, ["id"]));
+  }
+});
+export {
+  to as default
+};

package/dist/{components/Content/Operation/Operation.vue.d.ts → features/Operation/layouts/ModernLayout.vue.d.ts}

@@ -5,4 +5,4 @@ type __VLS_Props = {
 };
 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;
-//# sourceMappingURL=Operation.vue.d.ts.map
+//# sourceMappingURL=ModernLayout.vue.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModernLayout.vue.d.ts","sourceRoot":"","sources":["../../../../src/features/Operation/layouts/ModernLayout.vue"],"names":[],"mappings":"AA0GA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAOhE,KAAK,WAAW,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,oBAAoB,CAAA;CAChC,CAAC;;AAoMF,wBAOG"}

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

@@ -0,0 +1,7 @@
+import o from "./ModernLayout.vue2.js";
+/* empty css                  */
+import t from "../../../_virtual/_plugin-vue_export-helper.js";
+const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-f5ec41fb"]]);
+export {
+  e as default
+};

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

@@ -0,0 +1,114 @@
+import { defineComponent as f, openBlock as l, createBlock as m, unref as t, withCtx as r, createVNode as o, createTextVNode as d, createCommentVNode as u, createElementVNode as n, normalizeClass as c, toDisplayString as h } from "vue";
+import _ from "../../../components/OperationPath.vue.js";
+import { ScalarMarkdown as C } from "@scalar/components";
+import S from "../components/OperationParameters.vue.js";
+import v from "../components/OperationResponses.vue.js";
+import k from "../../../components/Section/Section.vue.js";
+import g from "../../../components/Section/SectionContent.vue.js";
+import y from "../../../components/Section/SectionColumns.vue.js";
+import s from "../../../components/Section/SectionColumn.vue.js";
+import B from "../../../components/Badge/Badge.vue.js";
+import N from "../../../components/Section/SectionHeader.vue.js";
+import V from "../../../components/Anchor/Anchor.vue.js";
+import b from "../../ExampleRequest/ExampleRequest.vue.js";
+import w from "../../TestRequestButton/TestRequestButton.vue.js";
+import E from "../../ExampleResponses/ExampleResponses.vue.js";
+const R = { class: "operation-details" }, q = { class: "examples" }, Q = /* @__PURE__ */ f({
+  __name: "ModernLayout",
+  props: {
+    id: {},
+    operation: {}
+  },
+  setup(D) {
+    return (e, i) => (l(), m(t(k), {
+      id: e.id,
+      label: e.operation.name
+    }, {
+      default: r(() => [
+        o(t(g), null, {
+          default: r(() => [
+            o(t(y), null, {
+              default: r(() => [
+                o(t(s), null, {
+                  default: r(() => {
+                    var a, p;
+                    return [
+                      (a = e.operation.information) != null && a.deprecated ? (l(), m(t(B), { key: 0 }, {
+                        default: r(() => i[0] || (i[0] = [
+                          d(" Deprecated ")
+                        ])),
+                        _: 1
+                      })) : u("", !0),
+                      n("div", {
+                        class: c((p = e.operation.information) != null && p.deprecated ? "deprecated" : "")
+                      }, [
+                        o(t(N), { level: 3 }, {
+                          default: r(() => [
+                            o(t(V), {
+                              id: e.id ?? ""
+                            }, {
+                              default: r(() => [
+                                d(h(e.operation.name), 1)
+                              ]),
+                              _: 1
+                            }, 8, ["id"])
+                          ]),
+                          _: 1
+                        })
+                      ], 2),
+                      n("div", R, [
+                        o(t(C), {
+                          value: e.operation.description,
+                          withImages: ""
+                        }, null, 8, ["value"]),
+                        o(S, { operation: e.operation }, null, 8, ["operation"]),
+                        o(v, { operation: e.operation }, null, 8, ["operation"])
+                      ])
+                    ];
+                  }),
+                  _: 1
+                }),
+                o(t(s), null, {
+                  default: r(() => [
+                    n("div", q, [
+                      o(t(b), {
+                        fallback: "",
+                        operation: e.operation
+                      }, {
+                        header: r(() => {
+                          var a;
+                          return [
+                            o(_, {
+                              class: "example-path",
+                              deprecated: (a = e.operation.information) == null ? void 0 : a.deprecated,
+                              path: e.operation.path
+                            }, null, 8, ["deprecated", "path"])
+                          ];
+                        }),
+                        footer: r(() => [
+                          o(t(w), { operation: e.operation }, null, 8, ["operation"])
+                        ]),
+                        _: 1
+                      }, 8, ["operation"]),
+                      o(t(E), {
+                        operation: e.operation,
+                        style: { "margin-top": "12px" }
+                      }, null, 8, ["operation"])
+                    ])
+                  ]),
+                  _: 1
+                })
+              ]),
+              _: 1
+            })
+          ]),
+          _: 1
+        })
+      ]),
+      _: 1
+    }, 8, ["id", "label"]));
+  }
+});
+export {
+  Q as default
+};

package/dist/features/Search/SearchButton.vue.js

@@ -1,7 +1,7 @@
 import o from "./SearchButton.vue2.js";
 /* empty css                  */
 import t from "../../_virtual/_plugin-vue_export-helper.js";
-const p = /* @__PURE__ */ t(o, [["__scopeId", "data-v-d362607b"]]);
+const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-3ed69c39"]]);
 export {
-  p as default
+  e as default
 };

package/dist/features/Search/SearchButton.vue2.js

@@ -31,7 +31,7 @@ const C = { class: "sidebar-search-input" }, H = { class: "sidebar-search-shortc
         (...m) => a(t).show && a(t).show(...m))
       }, [
         l(a(k), {
-          class: "search-icon",
+          class: "scalar-search-icon",
           icon: "Search",
           size: "sm",
           thickness: "2.5"

package/dist/features/Search/useSearchIndex.js

@@ -2,14 +2,14 @@ import H from "fuse.js";
 import { ref as c, computed as N, watch as V } from "vue";
 import { extractRequestBody as A } from "../../helpers/specHelpers.js";
 import { useSidebar as B } from "../../hooks/useSidebar.js";
-import { useOperation as P } from "../../hooks/useOperation.js";
-import { useNavState as z } from "../../hooks/useNavState.js";
-import { getHeadingsFromMarkdown as G } from "../../helpers/getHeadingsFromMarkdown.js";
-import { getModels as J } from "../../helpers/getModels.js";
+import { getHeadingsFromMarkdown as P } from "../../helpers/getHeadingsFromMarkdown.js";
+import { useOperation as z } from "../../hooks/useOperation.js";
+import { getModels as G } from "../../helpers/getModels.js";
+import { useNavState as J } from "../../hooks/useNavState.js";
 function te({
   specification: a
 }) {
-  const { getHeadingId: O, getWebhookId: R, getModelId: T, getOperationId: j, getTagId: L } = z(), { hideModels: W } = B(), o = c([]), n = c([]), h = c(0), s = c(""), d = new H(o.value, {
+  const { getHeadingId: O, getWebhookId: R, getModelId: T, getOperationId: j, getTagId: L } = J(), { hideModels: W } = B(), o = c([]), n = c([]), h = c(0), s = c(""), d = new H(o.value, {
     keys: ["title", "description", "body"]
   }), q = () => {
     h.value = 0, n.value = d.search(s.value);
@@ -30,7 +30,7 @@ function te({
         d.setCollection([]);
         return;
       }
-      const i = [], r = G(
+      const i = [], r = P(
         ((M = (k = a.value) == null ? void 0 : k.info) == null ? void 0 : M.description) ?? ""
       );
       r.length && (r.forEach((e) => {
@@ -52,7 +52,7 @@ function te({
           body: ""
         };
         o.value.push(E), e.operations && e.operations.forEach((t) => {
-          const { parameterMap: u } = P({ operation: t }), S = A(t) || u.value;
+          const { parameterMap: u } = z(t), S = A(t) || u.value;
           let v = null;
           typeof S != "boolean" && (v = S);
           const x = {
@@ -86,7 +86,7 @@ function te({
           });
         }), o.value = o.value.concat(f);
       });
-      const p = W.value ? {} : J(a.value), m = [];
+      const p = W.value ? {} : G(a.value), m = [];
       p && (Object.keys(p).forEach((e) => {
         m.push({
           type: "model",

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

@@ -0,0 +1 @@
+{"version":3,"file":"TestRequestButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/TestRequestButton/TestRequestButton.vue"],"names":[],"mappings":"AA4EA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAKhE,KAAK,WAAW,GAAG;IACjB,SAAS,EAAE,oBAAoB,CAAA;CAChC,CAAC;;AAiGF,wBAMG"}

package/dist/features/TestRequestButton/TestRequestButton.vue.js

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

package/dist/{components/Content/Operation → features/TestRequestButton}/TestRequestButton.vue2.js

@@ -1,8 +1,8 @@
 import { defineComponent as d, inject as f, unref as o, openBlock as p, createElementBlock as i, withModifiers as c, createVNode as s, createElementVNode as h, withCtx as T, createTextVNode as a, toDisplayString as m, Fragment as b } from "vue";
-import { ScalarIcon as B } from "@scalar/components";
-import E from "../../ScreenReader.vue.js";
-import { HIDE_TEST_REQUEST_BUTTON_SYMBOL as S } from "../../../helpers/provideSymbols.js";
-import { useApiClient as V } from "../../../features/ApiClientModal/useApiClient.js";
+import B from "../../components/ScreenReader.vue.js";
+import { ScalarIcon as E } from "@scalar/components";
+import { HIDE_TEST_REQUEST_BUTTON_SYMBOL as S } from "../../helpers/provideSymbols.js";
+import { useApiClient as V } from "../ApiClientModal/useApiClient.js";
 const _ = ["method"], w = /* @__PURE__ */ d({
   __name: "TestRequestButton",
   props: {
@@ -25,12 +25,12 @@ const _ = ["method"], w = /* @__PURE__ */ d({
           });
         }, ["stop"]))
       }, [
-        s(o(B), {
+        s(o(E), {
           icon: "Play",
           size: "sm"
         }),
         e[1] || (e[1] = h("span", null, "Test Request", -1)),
-        s(E, null, {
+        s(B, null, {
           default: T(() => [
             a("(" + m(t.operation.httpVerb) + " " + m(t.operation.path) + ")", 1)
           ]),

package/dist/features/TestRequestButton/index.d.ts

@@ -0,0 +1,2 @@
+export { default as TestRequestButton } from './TestRequestButton.vue.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/features/TestRequestButton/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/TestRequestButton/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,yBAAyB,CAAA"}

package/dist/hooks/index.d.ts

@@ -4,6 +4,5 @@ export * from './useNavState.js';
 export * from './useOperation.js';
 export * from './useReactiveSpec.js';
 export * from './useRefOnMount.js';
-export * from './useResponses.js';
 export * from './useSidebar.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,0BAA0B,CAAA;AACxC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,0BAA0B,CAAA;AACxC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA"}

package/dist/hooks/useOperation.d.ts

@@ -1,18 +1,15 @@
-import type { Parameters, TransformedOperation } from '@scalar/types/legacy';
+import type { Parameter, TransformedOperation } from '@scalar/types/legacy';
 export type ParamMap = {
-    path: Parameters[];
-    query: Parameters[];
-    header: Parameters[];
-    body: Parameters[];
-    formData: Parameters[];
-};
-export type OperationProps = {
-    operation: TransformedOperation;
+    path: Parameter[];
+    query: Parameter[];
+    header: Parameter[];
+    body: Parameter[];
+    formData: Parameter[];
 };
 /**
  * This hook is used to generate the parameters for the request from the parameters in the swagger file
  */
-export declare function useOperation(props: OperationProps): {
+export declare function useOperation(operation: TransformedOperation): {
     parameterMap: import("vue").ComputedRef<ParamMap>;
 };
 //# sourceMappingURL=useOperation.d.ts.map

package/dist/hooks/useOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useOperation.d.ts","sourceRoot":"","sources":["../../src/hooks/useOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAG5E,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,UAAU,EAAE,CAAA;IAClB,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,IAAI,EAAE,UAAU,EAAE,CAAA;IAClB,QAAQ,EAAE,UAAU,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,oBAAoB,CAAA;CAChC,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,cAAc;;EAiDjD"}
+{"version":3,"file":"useOperation.d.ts","sourceRoot":"","sources":["../../src/hooks/useOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAG3E,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,SAAS,EAAE,CAAA;IACjB,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,IAAI,EAAE,SAAS,EAAE,CAAA;IACjB,QAAQ,EAAE,SAAS,EAAE,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;EAkD3D"}

package/dist/hooks/useOperation.js

@@ -1,23 +1,25 @@
-import { computed as f } from "vue";
-function t(h) {
+import { computed as o } from "vue";
+function e(h) {
   return {
-    parameterMap: f(() => {
-      var n;
-      const s = ((n = h.operation.information) == null ? void 0 : n.parameters) ?? [], o = {
+    parameterMap: o(() => {
+      var u;
+      const i = {
         path: [],
         query: [],
         header: [],
         body: [],
         formData: []
       };
-      return h.operation.pathParameters && h.operation.pathParameters.forEach((i) => {
-        i.in === "path" ? o.path.push(i) : i.in === "query" ? o.query.push(i) : i.in === "header" ? o.header.push(i) : i.in === "body" ? o.body.push(i) : i.in === "formData" && o.formData.push(i);
-      }), s && s.forEach((i) => {
-        i.in === "path" ? o.path.push(i) : i.in === "query" ? o.query.push(i) : i.in === "header" ? o.header.push(i) : i.in === "body" ? o.body.push(i) : i.in === "formData" && o.formData.push(i);
-      }), o;
+      h.pathParameters && h.pathParameters.forEach((s) => {
+        s.in === "path" ? i.path.push(s) : s.in === "query" ? i.query.push(s) : s.in === "header" ? i.header.push(s) : s.in === "body" ? i.body.push(s) : s.in === "formData" && i.formData.push(s);
+      });
+      const f = ((u = h.information) == null ? void 0 : u.parameters) ?? [];
+      return f && f.forEach((s) => {
+        s.in === "path" ? i.path.push(s) : s.in === "query" ? i.query.push(s) : s.in === "header" ? i.header.push(s) : s.in === "body" ? i.body.push(s) : s.in === "formData" && i.formData.push(s);
+      }), i;
     })
   };
 }
 export {
-  t as useOperation
+  e as useOperation
 };