@scalar/api-reference 1.25.103 → 1.25.105

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

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

package/dist/helpers/get-request.d.ts

@@ -15,6 +15,8 @@ export declare const getRequest: (requests: WorkspaceStore["requests"], path: st
         url: string;
         description?: string | undefined;
     } | undefined;
+    'x-internal'?: boolean | undefined;
+    'x-scalar-ignore'?: boolean | undefined;
     security?: Record<string, string[]>[] | undefined;
     tags?: string[] | undefined;
     deprecated?: boolean | undefined;

package/dist/helpers/get-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aACX,cAAc,CAAC,UAAU,CAAC,QAC9B,MAAM,UACJ,MAAM;;;;;;;;;;;;;mBAKu4S,CAAC;;;;;;;;;;;mBAAia,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAwC,CAAC;mBAAkC,CAAC;;;;;aADtoU,CAAA"}
+{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aACX,cAAc,CAAC,UAAU,CAAC,QAC9B,MAAM,UACJ,MAAM;;;;;;;;;;;;;mBAKmqT,CAAC;;;;;;;;;;;;;mBAA8f,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAwC,CAAC;mBAAkC,CAAC;;;;;aAD//U,CAAA"}

package/dist/helpers/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAMxD;;;;GAIG;AACH,eAAO,MAAM,KAAK,kBACD,aAAa,GAAG,MAAM,GAAG,SAAS,kBAG9C;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,KACA,OAAO,CAAC,IAAI,CA0Dd,CAAA"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAMxD;;;;GAIG;AACH,eAAO,MAAM,KAAK,kBACD,aAAa,GAAG,MAAM,GAAG,SAAS,kBAG9C;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,KACA,OAAO,CAAC,IAAI,CA0Dd,CAAA"}

package/dist/helpers/parse.js

@@ -1,76 +1,94 @@
-import { redirectToProxy as R } from "@scalar/oas-utils/helpers";
-import { load as j, dereference as M } from "@scalar/openapi-parser";
-import { fetchUrls as q } from "@scalar/openapi-parser/plugins/fetch-urls";
-import { createEmptySpecification as m } from "./createEmptySpecification.js";
-import { normalizeRequestMethod as E } from "../legacy/helpers/normalizeRequestMethod.js";
-import { validRequestMethods as A } from "../legacy/fixtures/httpRequestMethods.js";
-const D = (p, {
+import { redirectToProxy as R, shouldIgnoreEntity as u } from "@scalar/oas-utils/helpers";
+import { load as M, dereference as q } from "@scalar/openapi-parser";
+import { fetchUrls as C } from "@scalar/openapi-parser/plugins/fetch-urls";
+import { createEmptySpecification as O } from "./createEmptySpecification.js";
+import { normalizeRequestMethod as k } from "../legacy/helpers/normalizeRequestMethod.js";
+import { validRequestMethods as F } from "../legacy/fixtures/httpRequestMethods.js";
+const H = (m, {
   proxyUrl: e
-} = {}) => new Promise(async (a, h) => {
-  var s;
+} = {}) => new Promise(async (o, E) => {
+  var h;
   try {
-    if (!p)
-      return a(
-        u(m())
+    if (!m)
+      return o(
+        I(O())
       );
-    const o = performance.now(), { filesystem: n } = await j(p, {
+    const s = performance.now(), { filesystem: i } = await M(m, {
       plugins: [
-        q({
-          fetch: (i) => fetch(e ? R(e, i) : i)
+        C({
+          fetch: (c) => fetch(e ? R(e, c) : c)
         })
       ]
-    }), { schema: t, errors: r } = await M(n), c = performance.now();
-    return console.log(`dereference: ${Math.round(c - o)} ms`), r != null && r.length && console.warn(
+    }), { schema: r, errors: t } = await q(i), n = performance.now();
+    return console.log(`dereference: ${Math.round(n - s)} ms`), t != null && t.length && console.warn(
       `Please open an issue on https://github.com/scalar/scalar
 `,
       `Scalar OpenAPI Parser Warning:
 `,
-      r
-    ), t === void 0 ? (h(((s = r == null ? void 0 : r[0]) == null ? void 0 : s.message) ?? "Failed to parse the OpenAPI file."), a(
-      u(m())
-    )) : a(u(t));
-  } catch (o) {
+      t
+    ), r === void 0 ? (E(((h = t == null ? void 0 : t[0]) == null ? void 0 : h.message) ?? "Failed to parse the OpenAPI file."), o(
+      I(O())
+    )) : o(I(r));
+  } catch (s) {
     console.error(
       "[@scalar/api-reference]",
       "Failed to parse the OpenAPI document. It might be invalid?"
-    ), console.error(o), h(o);
+    ), console.error(s), E(s);
   }
-  return a(
-    u(m())
+  return o(
+    I(O())
   );
-}), u = (p) => {
+}), I = (m) => {
+  var h;
   let e = {};
-  p && typeof p == "object" ? e = structuredClone(p) : e = m(), e.tags || (e.tags = []), e.paths || (e.paths = {});
-  const a = {};
+  m && typeof m == "object" ? e = structuredClone(m) : e = O(), e.tags || (e.tags = []), e.paths || (e.paths = {});
+  const o = {};
   return Object.keys(e.webhooks ?? {}).forEach((s) => {
-    var o;
-    Object.keys(((o = e.webhooks) == null ? void 0 : o[s]) ?? {}).forEach((n) => {
-      var r, c, i;
-      const t = (r = e.webhooks) == null ? void 0 : r[s][n];
-      (t == null ? void 0 : t["x-internal"]) !== !0 && (a[s] === void 0 && (a[s] = {}), a[s][n] = {
-        // Transformed data
-        httpVerb: E(n),
-        path: s,
-        operationId: (t == null ? void 0 : t.operationId) || s,
-        name: (t == null ? void 0 : t.summary) || s || "",
-        description: (t == null ? void 0 : t.description) || "",
-        pathParameters: (i = (c = e.paths) == null ? void 0 : c[s]) == null ? void 0 : i.parameters,
-        // Original webhook
-        information: {
-          ...t
+    var i;
+    Object.keys(((i = e.webhooks) == null ? void 0 : i[s]) ?? {}).forEach((r) => {
+      var n, c, l, g;
+      const t = (n = e.webhooks) == null ? void 0 : n[s][r];
+      if (!(!t || u(t))) {
+        if (Array.isArray(t.tags)) {
+          const a = (c = t.tags) == null ? void 0 : c.map((f) => {
+            var y;
+            return (y = e.tags) == null ? void 0 : y.find((w) => w.name === f);
+          });
+          if (t.tags = a == null ? void 0 : a.filter(
+            (f) => !u(f)
+          ), a != null && a.some(
+            (f) => u(f)
+          ))
+            return;
         }
-      });
+        o[s] === void 0 && (o[s] = {}), o[s][r] = {
+          // Transformed data
+          httpVerb: k(r),
+          path: s,
+          operationId: (t == null ? void 0 : t.operationId) || s,
+          name: (t == null ? void 0 : t.summary) || s || "",
+          description: (t == null ? void 0 : t.description) || "",
+          pathParameters: (g = (l = e.paths) == null ? void 0 : l[s]) == null ? void 0 : g.parameters,
+          // Original webhook
+          information: {
+            ...t
+          }
+        };
+      }
     });
+  }), Object.keys(((h = e.components) == null ? void 0 : h.schemas) ?? {}).forEach((s) => {
+    var i, r, t, n;
+    u((r = (i = e.components) == null ? void 0 : i.schemas) == null ? void 0 : r[s]) && ((n = (t = e.components) == null ? void 0 : t.schemas) == null || delete n[s]);
   }), Object.keys(e.paths).forEach((s) => {
     Object.keys(e.paths[s]).filter(
-      (n) => A.includes(n.toUpperCase())
-    ).forEach((n) => {
-      var c, i, g, w, y, I;
-      const t = e.paths[s][n];
-      if (t === void 0 || t["x-internal"] === !0)
+      (r) => F.includes(r.toUpperCase())
+    ).forEach((r) => {
+      var c, l, g, a, f, y, w;
+      const t = e.paths[s][r];
+      if (t === void 0 || u(t))
         return;
-      const r = {
-        httpVerb: E(n),
+      const n = {
+        httpVerb: k(r),
         path: s,
         operationId: t.operationId || s,
         name: t.summary || s || "",
@@ -78,40 +96,42 @@ const D = (p, {
         information: {
           ...t
         },
-        pathParameters: (i = (c = e.paths) == null ? void 0 : c[s]) == null ? void 0 : i.parameters
+        pathParameters: (l = (c = e.paths) == null ? void 0 : c[s]) == null ? void 0 : l.parameters
       };
       if (!t.tags || t.tags.length === 0) {
         (g = e.tags) != null && g.find(
-          (f) => f.name === "default"
-        ) || (w = e.tags) == null || w.push({
+          (d) => d.name === "default"
+        ) || (a = e.tags) == null || a.push({
           name: "default",
           description: "",
           operations: []
         });
-        const d = (y = e.tags) == null ? void 0 : y.findIndex(
-          (f) => f.name === "default"
+        const p = (f = e.tags) == null ? void 0 : f.findIndex(
+          (d) => d.name === "default"
         );
-        d >= 0 && ((I = e.tags[d]) == null || I.operations.push(r));
+        p >= 0 && ((y = e.tags[p]) == null || y.operations.push(n));
       } else
-        t.tags.forEach((d) => {
-          var O, x, P;
-          const f = (O = e.tags) == null ? void 0 : O.findIndex(
-            // @ts-expect-error TODO: The types are just screwed, needs refactoring
-            (b) => b.name === d
+        t.tags.forEach((p) => {
+          var b, x, j;
+          const d = (b = e.tags) == null ? void 0 : b.findIndex(
+            (A) => A.name === p
           );
-          f === -1 && ((x = e.tags) == null || x.push({
-            name: d,
+          d === -1 && ((x = e.tags) == null || x.push({
+            name: p,
             description: ""
           }));
-          const l = f !== -1 ? f : e.tags.length - 1;
-          typeof ((P = e.tags[l]) == null ? void 0 : P.operations) > "u" && (e.tags[l].operations = []), e.tags[l].operations.push(r);
+          const P = d !== -1 ? d : e.tags.length - 1;
+          typeof ((j = e.tags[P]) == null ? void 0 : j.operations) > "u" && (e.tags[P].operations = []), e.tags[P].operations.push(n);
         });
+      e.tags = (w = e.tags) == null ? void 0 : w.filter(
+        (p) => !u(p)
+      );
     });
   }), {
     ...e,
-    webhooks: a
+    webhooks: o
   };
 };
 export {
-  D as parse
+  H as parse
 };

package/dist/index.d.ts

@@ -5,7 +5,6 @@ export * from './features/Search';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
 export { createScalarReferences } from './esm.js';
 export { useReactiveSpec } from './hooks/useReactiveSpec.js';
-export * from './components/DarkModeToggle';
 export * from './components/Sidebar';
 export * from './components/Card';
 export * from './components/Layouts';

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,OAAO,IAAI,YAAY,EAAE,MAAM,uCAAuC,CAAA;AAC/E,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,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,OAAO,IAAI,YAAY,EAAE,MAAM,uCAAuC,CAAA;AAC/E,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}