@scalar/api-reference 1.25.71 → 1.25.74

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

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

package/dist/helpers/getExampleCode.d.ts

@@ -1,9 +1,9 @@
 import { type Request, type ClientId as SnippetzClientId, type TargetId as SnippetzTargetId } from '@scalar/snippetz';
 import { type ClientId as HttpSnippetLiteClientId, type TargetId as HttpSnippetLiteTargetId } from 'httpsnippet-lite';
 export type TargetId = HttpSnippetLiteTargetId | SnippetzTargetId;
-export type ClientId = HttpSnippetLiteClientId | SnippetzClientId;
+export type ClientId<T extends SnippetzTargetId> = HttpSnippetLiteClientId | SnippetzClientId<T>;
 /**
  * Returns a code example for given HAR request
  */
-export declare function getExampleCode(request: Request, target: TargetId, client: ClientId): Promise<string>;
+export declare function getExampleCode<T extends SnippetzTargetId>(request: Request, target: TargetId, client: ClientId<T>): Promise<string | undefined>;
 //# sourceMappingURL=getExampleCode.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getExampleCode.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleCode.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,IAAI,gBAAgB,EACjC,KAAK,QAAQ,IAAI,gBAAgB,EAElC,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAEL,KAAK,QAAQ,IAAI,uBAAuB,EACxC,KAAK,QAAQ,IAAI,uBAAuB,EACzC,MAAM,kBAAkB,CAAA;AAEzB,MAAM,MAAM,QAAQ,GAAG,uBAAuB,GAAG,gBAAgB,CAAA;AACjE,MAAM,MAAM,QAAQ,GAAG,uBAAuB,GAAG,gBAAgB,CAAA;AAEjE;;GAEG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,QAAQ,mBAyCjB"}
+{"version":3,"file":"getExampleCode.d.ts","sourceRoot":"","sources":["../../src/helpers/getExampleCode.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,IAAI,gBAAgB,EACjC,KAAK,QAAQ,IAAI,gBAAgB,EAElC,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAEL,KAAK,QAAQ,IAAI,uBAAuB,EACxC,KAAK,QAAQ,IAAI,uBAAuB,EACzC,MAAM,kBAAkB,CAAA;AAEzB,MAAM,MAAM,QAAQ,GAAG,uBAAuB,GAAG,gBAAgB,CAAA;AACjE,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,gBAAgB,IAC3C,uBAAuB,GACvB,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAEvB;;GAEG;AACH,wBAAsB,cAAc,CAAC,CAAC,SAAS,gBAAgB,EAC7D,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,QAAQ,EAChB,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,+BAyCpB"}

package/dist/helpers/getExampleCode.js

@@ -1,20 +1,20 @@
-import { snippetz as r } from "@scalar/snippetz";
+import { snippetz as o } from "@scalar/snippetz";
 import { HTTPSnippet as s } from "httpsnippet-lite";
-async function f(e, t, p) {
-  const o = t;
-  if (r().hasPlugin(o, p))
-    return r().print(
-      t,
+async function f(t, e, p) {
+  const r = e;
+  if (o().hasPlugin(r, p))
+    return o().print(
+      r,
       p,
-      e
+      t
     );
-  if (e.url.startsWith("__"))
-    return e.url;
+  if (t.url.startsWith("__"))
+    return t.url;
   try {
-    const n = t == null ? void 0 : t.replace(
+    const n = e == null ? void 0 : e.replace(
       "js",
       "javascript"
-    ), c = p, i = await new s(e).convert(
+    ), c = p, i = await new s(t).convert(
       n,
       c
     );

package/dist/helpers/parse.d.ts

@@ -1,5 +1,5 @@
 import type { Spec } from '@scalar/types/legacy';
-export declare const parse: (specification: any, { proxy, }?: {
-    proxy?: string;
+export declare const parse: (specification: any, { proxyUrl, }?: {
+    proxyUrl?: string;
 }) => Promise<Spec>;
 //# sourceMappingURL=parse.d.ts.map

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;AAMhD,eAAO,MAAM,KAAK,kBACD,GAAG,eAGf;IACD,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,KACA,OAAO,CAAC,IAAI,CAyDd,CAAA"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAMhD,eAAO,MAAM,KAAK,kBACD,GAAG,kBAGf;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,KACA,OAAO,CAAC,IAAI,CA0Dd,CAAA"}

package/dist/helpers/parse.js

@@ -4,8 +4,8 @@ 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 z = (p, {
-  proxy: e
+const D = (p, {
+  proxyUrl: e
 } = {}) => new Promise(async (a, h) => {
   var s;
   try {
@@ -113,5 +113,5 @@ const z = (p, {
   };
 };
 export {
-  z as parse
+  D as parse
 };

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

@@ -1 +1 @@
-{"version":3,"file":"useDeprecationWarnings.d.ts","sourceRoot":"","sources":["../../src/hooks/useDeprecationWarnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAOlE;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,sBAAsB,QAoC3E"}
+{"version":3,"file":"useDeprecationWarnings.d.ts","sourceRoot":"","sources":["../../src/hooks/useDeprecationWarnings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAOlE;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,sBAAsB,QAgC3E"}

package/dist/hooks/useDeprecationWarnings.js

@@ -1,20 +1,17 @@
-import { watch as s } from "vue";
-const t = "https://api.scalar.com/request-proxy", o = "https://proxy.scalar.com", a = "http://localhost:5051";
-function n(e) {
-  s(
+import { watch as t } from "vue";
+const o = "https://api.scalar.com/request-proxy", r = "https://proxy.scalar.com";
+function p(e) {
+  t(
     () => e,
     () => {
-      var r;
-      e.proxy === t ? (console.warn(
-        `[DEPRECATED] Warning: configuration.proxy points to our old proxy (${t}).`
+      e.proxy && console.warn(
+        "[DEPRECATED] You’re using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package."
+      ), (e.proxyUrl || e.proxy) === o && (console.warn(
+        `[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${o}).`
       ), console.warn(
-        `[DEPRECATED] We are overwriting the value and use the new proxy URL (${o}) instead.`
-      ), e.proxy = o, console.warn(
-        `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${o}). Read more: https://github.com/scalar/scalar`
-      )) : (r = e.proxy) != null && r.length && e.proxy !== o && e.proxy !== a && (console.warn(
-        `[DEPRECATED] Warning: configuration.proxy points to a custom proxy (${e == null ? void 0 : e.proxy}).`
-      ), console.warn(
-        "[DEPRECATED] Action Required: You need to use our new proxy (written in Go). Read more: https://github.com/scalar/scalar/tree/main/examples/proxy-server"
+        `[DEPRECATED] We are overwriting the value and use the new proxy URL (${r}) instead.`
+      ), delete e.proxy, e.proxyUrl = r, console.warn(
+        `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${r}). Read more: https://github.com/scalar/scalar`
       ));
     },
     {
@@ -23,5 +20,5 @@ function n(e) {
   );
 }
 export {
-  n as useDeprecationWarnings
+  p as useDeprecationWarnings
 };

package/dist/hooks/useReactiveSpec.d.ts

@@ -3,9 +3,9 @@ import { type MaybeRefOrGetter } from 'vue';
 /**
  * Keep the raw spec content in a ref and update it when the configuration changes.
  */
-export declare function useReactiveSpec({ specConfig, proxy, }: {
+export declare function useReactiveSpec({ specConfig, proxyUrl, }: {
     specConfig?: MaybeRefOrGetter<SpecConfiguration>;
-    proxy?: MaybeRefOrGetter<string>;
+    proxyUrl?: MaybeRefOrGetter<string>;
 }): {
     rawSpec: import("vue").Ref<string, string>;
     parsedSpec: {
@@ -57,6 +57,17 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
                     summary?: string | undefined;
                     tags?: string[] | undefined;
                     deprecated?: boolean | undefined;
+                    servers?: ({
+                        url?: string | undefined;
+                        description?: string | undefined;
+                        variables?: {
+                            [variable: string]: import("@scalar/openapi-types").OpenAPIV3.ServerVariableObject;
+                        } | undefined;
+                    } | {
+                        url?: string | undefined;
+                        description?: string | undefined;
+                        variables?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject> | undefined;
+                    })[] | undefined;
                     'x-custom-examples'?: {
                         lang: string;
                         label: string;
@@ -73,6 +84,17 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
                         source: string;
                     }[] | undefined;
                 } | undefined;
+                servers?: ({
+                    url?: string | undefined;
+                    description?: string | undefined;
+                    variables?: {
+                        [variable: string]: import("@scalar/openapi-types").OpenAPIV3.ServerVariableObject;
+                    } | undefined;
+                } | {
+                    url?: string | undefined;
+                    description?: string | undefined;
+                    variables?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject> | undefined;
+                })[] | undefined;
                 pathParameters?: {
                     name: string;
                     in?: string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AAyD1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}
+{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AAyD1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,QAAQ,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}

package/dist/hooks/useReactiveSpec.js

@@ -18,14 +18,14 @@ const y = async ({ url: e, content: r }, n) => {
   if (typeof t == "object")
     return h(t);
 };
-function U({
+function C({
   specConfig: e,
-  proxy: r
+  proxyUrl: r
 }) {
   const n = u(""), t = v(l()), s = u(null);
   function c(o) {
     return o ? g(o, {
-      proxy: r ? a(r) : void 0
+      proxyUrl: r ? a(r) : void 0
     }).then((i) => {
       s.value = null, Object.assign(t, {
         servers: [],
@@ -54,5 +54,5 @@ function U({
   };
 }
 export {
-  U as useReactiveSpec
+  C as useReactiveSpec
 };