@scalar/api-reference 1.24.20 → 1.24.21

package/dist/features/BaseUrl/ServerUrlSelect.vue2.js

@@ -0,0 +1,56 @@
+import { defineComponent as v, computed as s, openBlock as r, createElementBlock as f, createVNode as i, unref as l, withCtx as u, normalizeClass as g, createElementVNode as h, renderSlot as S, createBlock as _, createCommentVNode as V } from "vue";
+import { ScalarListbox as C, ScalarButton as k, ScalarIcon as x } from "@scalar/components";
+const B = { class: "w-full" }, N = /* @__PURE__ */ v({
+  __name: "ServerUrlSelect",
+  props: {
+    options: {},
+    value: {}
+  },
+  emits: ["change"],
+  setup(c, { emit: d }) {
+    const n = c, m = d, o = s(
+      () => n.options.map((e, t) => ({
+        id: t.toString(),
+        label: e.url ?? ""
+      }))
+    ), a = s({
+      get: () => {
+        var e;
+        return (e = o.value) == null ? void 0 : e.find((t) => t.id === n.value.toString());
+      },
+      set: (e) => m("change", (e == null ? void 0 : e.id) ?? "")
+    });
+    return (e, t) => (r(), f("div", B, [
+      i(l(C), {
+        modelValue: a.value,
+        "onUpdate:modelValue": t[0] || (t[0] = (p) => a.value = p),
+        options: o.value,
+        resize: ""
+      }, {
+        default: u(() => [
+          i(l(k), {
+            class: g(["url-select", { "pointer-events-none": o.value.length <= 1 }]),
+            fullWidth: "",
+            variant: "ghost"
+          }, {
+            default: u(() => [
+              h("span", null, [
+                S(e.$slots, "default", {}, void 0, !0)
+              ]),
+              o.value.length > 1 ? (r(), _(l(x), {
+                key: 0,
+                icon: "ChevronDown",
+                size: "xs"
+              })) : V("", !0)
+            ]),
+            _: 3
+          }, 8, ["class"])
+        ]),
+        _: 3
+      }, 8, ["modelValue", "options"])
+    ]));
+  }
+});
+export {
+  N as default
+};

package/dist/features/BaseUrl/ServerVariablesForm.vue.d.ts

@@ -0,0 +1,23 @@
+import type { ServerVariableValues, ServerVariables } from './types';
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
+    variables?: ServerVariables | undefined;
+    values?: ServerVariableValues | undefined;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:variable": (name: string, value: string) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
+    variables?: ServerVariables | undefined;
+    values?: ServerVariableValues | undefined;
+}>>> & {
+    "onUpdate:variable"?: ((name: string, value: string) => any) | undefined;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+//# sourceMappingURL=ServerVariablesForm.vue.d.ts.map

package/dist/features/BaseUrl/ServerVariablesForm.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerVariablesForm.vue.d.ts","sourceRoot":"","sources":["../../../src/features/BaseUrl/ServerVariablesForm.vue"],"names":[],"mappings":"AA6EA,OAAO,KAAK,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;;;;;;;;;;;;AAmIpE,wBAOG;AAOH,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AAC5D,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC"}

package/dist/features/BaseUrl/ServerVariablesForm.vue.js

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

package/dist/features/BaseUrl/ServerVariablesForm.vue2.js

@@ -0,0 +1,53 @@
+import { defineComponent as h, openBlock as t, createElementBlock as o, Fragment as k, renderList as y, createElementVNode as m, toDisplayString as V, createBlock as p, createCommentVNode as C } from "vue";
+import S from "./ServerVariablesSelect.vue.js";
+import _ from "./ServerVariablesTextbox.vue.js";
+const B = {
+  key: 0,
+  class: "variable-container"
+}, j = ["for"], O = /* @__PURE__ */ h({
+  __name: "ServerVariablesForm",
+  props: {
+    variables: {},
+    values: {}
+  },
+  emits: ["update:variable"],
+  setup(d, { emit: f }) {
+    const i = d, g = f;
+    function n(a, r) {
+      g("update:variable", a, r);
+    }
+    const s = (a) => {
+      var r, e;
+      return (((r = i.values) == null ? void 0 : r[a]) ?? ((e = i.variables) == null ? void 0 : e[a].default) ?? "").toString();
+    };
+    return (a, r) => a.variables && Object.keys(a.variables ?? {}).length ? (t(), o("div", B, [
+      (t(!0), o(k, null, y(Object.keys(a.variables), (e) => {
+        var u, v, b, c;
+        return t(), o("div", {
+          key: e,
+          class: "variable-container-item"
+        }, [
+          m("label", {
+            class: "variable-label",
+            for: `variable-${e}`
+          }, [
+            m("code", null, V(e), 1)
+          ], 8, j),
+          (v = (u = a.variables) == null ? void 0 : u[e].enum) != null && v.length ? (t(), p(S, {
+            key: 0,
+            enum: ((c = (b = a.variables[e]) == null ? void 0 : b.enum) == null ? void 0 : c.map((l) => `${l}`)) ?? [],
+            value: s(e),
+            onChange: (l) => n(e, l)
+          }, null, 8, ["enum", "value", "onChange"])) : (t(), p(_, {
+            key: 1,
+            value: s(e),
+            onChange: (l) => n(e, l)
+          }, null, 8, ["value", "onChange"]))
+        ]);
+      }), 128))
+    ])) : C("", !0);
+  }
+});
+export {
+  O as default
+};

package/dist/{components/Content/BaseUrl/ServerVariableSelect.vue.d.ts → features/BaseUrl/ServerVariablesSelect.vue.d.ts}

@@ -19,4 +19,4 @@ type __VLS_TypePropsToOption<T> = {
         required: true;
     };
 };
-//# sourceMappingURL=ServerVariableSelect.vue.d.ts.map
+//# sourceMappingURL=ServerVariablesSelect.vue.d.ts.map

package/dist/features/BaseUrl/ServerVariablesSelect.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerVariablesSelect.vue.d.ts","sourceRoot":"","sources":["../../../src/features/BaseUrl/ServerVariablesSelect.vue"],"names":[],"mappings":";;;;;;;;;;;AA6LA,wBAOG;AAOH,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AAC5D,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC"}

package/dist/features/BaseUrl/ServerVariablesSelect.vue.js

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

package/dist/{components/Content/BaseUrl/ServerVariableSelect.vue2.js → features/BaseUrl/ServerVariablesSelect.vue2.js}

@@ -1,7 +1,7 @@
 import { defineComponent as p, computed as i, openBlock as v, createElementBlock as f, createVNode as t, unref as a, withCtx as r, createElementVNode as _, toDisplayString as h } from "vue";
 import { ScalarListbox as S, ScalarButton as V, ScalarIcon as g } from "@scalar/components";
 const b = { class: "w-full" }, B = /* @__PURE__ */ p({
-  __name: "ServerVariableSelect",
+  __name: "ServerVariablesSelect",
   props: {
     enum: {},
     value: {}

package/dist/{components/Content/BaseUrl/ServerVariableTextbox.vue.d.ts → features/BaseUrl/ServerVariablesTextbox.vue.d.ts}

@@ -17,4 +17,4 @@ type __VLS_TypePropsToOption<T> = {
         required: true;
     };
 };
-//# sourceMappingURL=ServerVariableTextbox.vue.d.ts.map
+//# sourceMappingURL=ServerVariablesTextbox.vue.d.ts.map

package/dist/features/BaseUrl/ServerVariablesTextbox.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerVariablesTextbox.vue.d.ts","sourceRoot":"","sources":["../../../src/features/BaseUrl/ServerVariablesTextbox.vue"],"names":[],"mappings":";;;;;;;;;AAwGA,wBAOG;AAOH,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AAC5D,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACpC;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAC9D;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CACzD,CAAC"}

package/dist/features/BaseUrl/ServerVariablesTextbox.vue.js

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

package/dist/{components/Content/BaseUrl/ServerVariableTextbox.vue2.js → features/BaseUrl/ServerVariablesTextbox.vue2.js}

@@ -1,17 +1,17 @@
-import { defineComponent as r, computed as s, withDirectives as u, openBlock as m, createElementBlock as i, vModelText as v } from "vue";
-const x = /* @__PURE__ */ r({
-  __name: "ServerVariableTextbox",
+import { defineComponent as p, computed as r, withDirectives as u, openBlock as m, createElementBlock as i, vModelText as v } from "vue";
+const x = /* @__PURE__ */ p({
+  __name: "ServerVariablesTextbox",
   props: {
     value: {}
   },
   emits: ["change"],
   setup(l, { emit: a }) {
-    const n = l, c = a, e = s({
+    const n = l, s = a, e = r({
       get: () => n.value,
-      set: (t) => c("change", t)
+      set: (t) => s("change", t)
     });
     return (t, o) => u((m(), i("input", {
-      "onUpdate:modelValue": o[0] || (o[0] = (p) => e.value = p),
+      "onUpdate:modelValue": o[0] || (o[0] = (c) => e.value = c),
       autocomplete: "off",
       class: "variable-textbox",
       placeholder: "value",

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/BaseUrl/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,eAAe,CAAA;AAElD,cAAc,SAAS,CAAA"}

package/dist/features/BaseUrl/types.d.ts

@@ -0,0 +1,10 @@
+import type { OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
+export type Server = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerObject;
+export type ServerVariables = {
+    [variable: string]: ServerVariable;
+};
+export type ServerVariableValues = {
+    [variable: string]: string;
+};
+export type ServerVariable = OpenAPIV3.ServerVariableObject | OpenAPIV3_1.ServerVariableObject;
+//# sourceMappingURL=types.d.ts.map

package/dist/features/BaseUrl/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/features/BaseUrl/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpE,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,CAAA;AAEtE,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,cAAc,GACtB,SAAS,CAAC,oBAAoB,GAC9B,WAAW,CAAC,oBAAoB,CAAA"}

package/dist/features/BaseUrl/utils/getServers.d.ts

@@ -0,0 +1,15 @@
+import type { Spec } from '@scalar/oas-utils';
+import type { Server } from '../types';
+export type DefaultServerUrlOption = {
+    /**
+     * Sometimes you can’t add an URL to your OpenAPI document, so you can provide a default one here.
+     */
+    defaultServerUrl?: string;
+};
+/**
+ * Provide a specification and get the servers from it.
+ * If no servers are found, it will default to a specified URL or the current URL.
+ * Relative paths will be prepended with the default server URL or the current URL.
+ */
+export declare function getServers(specification: Spec | undefined, options?: DefaultServerUrlOption): Server[];
+//# sourceMappingURL=getServers.d.ts.map

package/dist/features/BaseUrl/utils/getServers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getServers.d.ts","sourceRoot":"","sources":["../../../../src/features/BaseUrl/utils/getServers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAG7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,aAAa,EAAE,IAAI,GAAG,SAAS,EAC/B,OAAO,CAAC,EAAE,sBAAsB,YA6DjC"}

package/dist/features/BaseUrl/utils/getServers.js

@@ -0,0 +1,29 @@
+import { findVariables as v, concatenateUrlAndPath as w } from "@scalar/oas-utils/helpers";
+function S(r, l) {
+  var h;
+  let e = [];
+  return r != null && r.servers && (r == null ? void 0 : r.servers.length) > 0 ? e = r.servers : r != null && r.host ? e = [
+    {
+      url: `${((h = r.schemes) == null ? void 0 : h[0]) ?? "http"}://${r.host}${(r == null ? void 0 : r.basePath) ?? ""}`
+    }
+  ] : e = [
+    {
+      url: l != null && l.defaultServerUrl ? l == null ? void 0 : l.defaultServerUrl : typeof window < "u" ? window.location.origin : "/"
+    }
+  ], (l != null && l.defaultServerUrl || typeof window < "u") && (e = e.map((d) => b(d, l))), e.map((d) => {
+    const a = d.variables ?? {};
+    return v(d.url ?? "").filter((u) => !a[u]).forEach((u) => {
+      d.variables === void 0 && (d.variables = {}), d.variables[u] = {};
+    }), d;
+  });
+}
+function b(r, l) {
+  var e;
+  return (e = r.url) != null && e.match(/^(?!(https?|file):\/\/|{).+/) && (r.url = w(
+    l != null && l.defaultServerUrl ? l == null ? void 0 : l.defaultServerUrl : typeof window < "u" ? window.location.origin : "",
+    r.url
+  )), r;
+}
+export {
+  S as getServers
+};

package/dist/features/BaseUrl/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './getServers.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/features/BaseUrl/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/features/BaseUrl/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/helpers/createEmptySpecification.d.ts

@@ -3,5 +3,5 @@ import type { Spec } from '@scalar/oas-utils';
  * Creates an empty specification object.
  * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.
  */
-export declare function createEmptySpecification(): Spec;
+export declare function createEmptySpecification(partialSpecification?: Partial<Spec>): Spec;
 //# sourceMappingURL=createEmptySpecification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"createEmptySpecification.d.ts","sourceRoot":"","sources":["../../src/helpers/createEmptySpecification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAsB/C"}
+{"version":3,"file":"createEmptySpecification.d.ts","sourceRoot":"","sources":["../../src/helpers/createEmptySpecification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAI7C;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,QAsB5E"}

package/dist/helpers/createEmptySpecification.js

@@ -1,5 +1,6 @@
-function e() {
-  return {
+import { deepMerge as r } from "./deepMerge.js";
+function i(e) {
+  return r(e ?? {}, {
     info: {
       title: "",
       description: "",
@@ -19,8 +20,8 @@ function e() {
     },
     servers: [],
     tags: []
-  };
+  });
 }
 export {
-  e as createEmptySpecification
+  i as createEmptySpecification
 };

package/dist/helpers/getModels.d.ts

@@ -3,5 +3,5 @@ import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
 /**
  * Returns all models from the specification, no matter if it’s Swagger 2.0 or OpenAPI 3.x.
  */
-export declare function getModels(spec?: Spec): Record<string, OpenAPIV3_1.SchemaObject> | OpenAPIV2.DefinitionsObject | Record<string, OpenAPIV3.SchemaObject>;
+export declare function getModels(spec?: Spec): OpenAPIV2.DefinitionsObject | Record<string, OpenAPIV3_1.SchemaObject> | Record<string, OpenAPIV3.SchemaObject>;
 //# sourceMappingURL=getModels.d.ts.map

package/dist/hooks/useReactiveSpec.d.ts

@@ -147,15 +147,15 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
             description?: string | undefined;
         } | undefined;
         servers?: {
-            uid: string;
-            url: string;
+            url?: string | undefined;
             description?: string | undefined;
-            variables?: Record<string, {
-                default: string;
-                uid: string;
-                description?: string | undefined;
-                enum?: string[] | undefined;
-            }> | null | undefined;
+            variables?: {
+                [variable: string]: import("@scalar/openapi-parser").OpenAPIV3.ServerVariableObject;
+            } | undefined;
+        }[] | {
+            url?: string | undefined;
+            description?: string | undefined;
+            variables?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ServerVariableObject> | undefined;
         }[] | undefined;
         components?: {
             schemas?: {