@scalar/api-reference 1.36.0 → 1.36.2

package/dist/features/toolbar/ApiReferenceToolbarShareRegister.vue.js

@@ -0,0 +1,50 @@
+import { defineComponent as p, createElementBlock as t, openBlock as o, Fragment as c, createElementVNode as l, createVNode as n, renderList as m, createBlock as u, createTextVNode as a, resolveDynamicComponent as d, toDisplayString as S, withCtx as f } from "vue";
+import { ScalarIconLockSimple as g, ScalarIconGlobeSimple as b, ScalarIconWarningOctagon as k, ScalarIconGitBranch as _, ScalarIconFileMd as w, ScalarIconBracketsCurly as h } from "@scalar/icons";
+import x from "./ApiReferenceToolbarBlurb.vue.js";
+import B from "./ApiReferenceToolbarRegisterButton.vue.js";
+const I = { class: "text-c-2 grid grid-cols-2 gap-2.5 font-medium" }, T = /* @__PURE__ */ p({
+  __name: "ApiReferenceToolbarShareRegister",
+  props: {
+    workspace: {}
+  },
+  setup(R) {
+    const i = [
+      { icon: g, label: "Password Protected" },
+      { icon: b, label: "Custom Domains" },
+      { icon: k, label: "Spectral Rules" },
+      { icon: _, label: "Bi-directional Git" },
+      { icon: w, label: "Markdown Files" },
+      { icon: h, label: "Json Schema Support" }
+    ];
+    return (s, r) => (o(), t(c, null, [
+      l("ul", I, [
+        (o(), t(c, null, m(i, (e) => l("li", {
+          key: e.label,
+          class: "flex items-center gap-2"
+        }, [
+          (o(), u(d(e.icon), {
+            weight: "bold",
+            class: "text-c-3 size-3.5"
+          })),
+          a(" " + S(e.label), 1)
+        ])), 64))
+      ]),
+      n(B, { workspace: s.workspace }, null, 8, ["workspace"]),
+      n(x, null, {
+        default: f(() => r[0] || (r[0] = [
+          a(" Uploading links to Scalar Registry, is part of Scalar's Premium features. Explore all features on our "),
+          l("a", {
+            href: "https://guides.scalar.com/",
+            target: "_blank"
+          }, " guides", -1),
+          a(". ")
+        ])),
+        _: 1,
+        __: [0]
+      })
+    ], 64));
+  }
+});
+export {
+  T as default
+};

package/dist/features/toolbar/ApiReferenceToolbarShareRegister.vue2.js

@@ -0,0 +1,4 @@
+import f from "./ApiReferenceToolbarShareRegister.vue.js";
+export {
+  f as default
+};

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue.d.ts

@@ -0,0 +1,14 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+type __VLS_Props = {
+    workspace: WorkspaceStore;
+};
+type __VLS_PublicProps = __VLS_Props & {
+    'url'?: string;
+};
+declare const _default: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:url": (value: string | undefined) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:url"?: ((value: string | undefined) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;
+//# sourceMappingURL=ApiReferenceToolbarShareTemporary.vue.d.ts.map

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiReferenceToolbarShareTemporary.vue.d.ts","sourceRoot":"","sources":["../../../src/features/toolbar/ApiReferenceToolbarShareTemporary.vue"],"names":[],"mappings":"AA8FA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAMpE,KAAK,WAAW,GAAG;IACjB,SAAS,EAAE,cAAc,CAAA;CAC1B,CAAC;AAyCF,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;;;;;;AAqIF,wBAOG"}

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue.js

@@ -0,0 +1,83 @@
+import { defineComponent as p, mergeModels as f, useModel as v, createElementBlock as k, openBlock as b, Fragment as g, createVNode as t, unref as r, createSlots as y, withCtx as s, createTextVNode as m } from "vue";
+import { useLoadingState as S, ScalarTextInput as T, ScalarIconButton as C, ScalarButton as w } from "@scalar/components";
+import { ScalarIconCopy as x } from "@scalar/icons";
+import { useClipboard as R } from "@scalar/use-hooks/useClipboard";
+import { useToasts as A } from "@scalar/use-toasts";
+import { REGISTRY_SHARE_URL as B } from "../../consts/urls.js";
+import L from "./ApiReferenceToolbarBlurb.vue.js";
+import { uploadTempDocument as E } from "./uploadTempDocument.js";
+const N = /* @__PURE__ */ p({
+  __name: "ApiReferenceToolbarShareTemporary",
+  props: /* @__PURE__ */ f({
+    workspace: {}
+  }, {
+    url: {},
+    urlModifiers: {}
+  }),
+  emits: ["update:url"],
+  setup(l) {
+    const { toast: d } = A(), a = S(), o = v(l, "url");
+    async function c() {
+      if (a.isLoading || !l.workspace || o.value)
+        return;
+      a.startLoading();
+      const i = l.workspace.exportActiveDocument("json");
+      if (!i) {
+        d("Unable to export active document", "error"), a.invalidate();
+        return;
+      }
+      try {
+        o.value = await E(i), n(o.value), a.validate();
+      } catch (e) {
+        const u = e instanceof Error ? e.message : "An unknown error occurred";
+        d(u, "error"), a.invalidate();
+      }
+    }
+    const { copyToClipboard: n } = R();
+    return (i, e) => (b(), k(g, null, [
+      t(r(T), {
+        readonly: "",
+        placeholder: `${r(B)}/apis/...`,
+        modelValue: o.value,
+        onClick: e[1] || (e[1] = (u) => o.value && r(n)(o.value))
+      }, y({ _: 2 }, [
+        o.value ? {
+          name: "aside",
+          fn: s(() => [
+            t(r(C), {
+              icon: r(x),
+              label: "Copy link to clipboard",
+              class: "-m-1.5 -ml-1",
+              size: "sm",
+              onClick: e[0] || (e[0] = (u) => r(n)(o.value))
+            }, null, 8, ["icon"])
+          ]),
+          key: "0"
+        } : void 0
+      ]), 1032, ["placeholder", "modelValue"]),
+      t(r(w), {
+        class: "h-auto p-2.5",
+        loading: r(a),
+        variant: "outlined",
+        disabled: !!o.value,
+        onClick: c
+      }, {
+        default: s(() => e[2] || (e[2] = [
+          m(" Generate ")
+        ])),
+        _: 1,
+        __: [2]
+      }, 8, ["loading", "disabled"]),
+      t(L, { class: "-mt-1" }, {
+        default: s(() => e[3] || (e[3] = [
+          m(" Shared documents will automatically be deleted after 7 days. ")
+        ])),
+        _: 1,
+        __: [3]
+      })
+    ], 64));
+  }
+});
+export {
+  N as default
+};

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue2.js

@@ -0,0 +1,4 @@
+import f from "./ApiReferenceToolbarShareTemporary.vue.js";
+export {
+  f as default
+};

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+//# sourceMappingURL=ApiReferenceToolbarTitle.vue.d.ts.map

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiReferenceToolbarTitle.vue.d.ts","sourceRoot":"","sources":["../../../src/features/toolbar/ApiReferenceToolbarTitle.vue"],"names":[],"mappings":";AA+LA,wBAKG"}

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.js

@@ -0,0 +1,51 @@
+import { defineComponent as s, createBlock as p, openBlock as d, withCtx as r, createElementVNode as t, createTextVNode as e, createVNode as l, toDisplayString as u, unref as n } from "vue";
+import { ScalarIconButton as c } from "@scalar/components";
+import { ScalarIconCopy as m, ScalarIconInfo as f } from "@scalar/icons";
+import { useClipboard as b } from "@scalar/use-hooks/useClipboard";
+import g from "./ApiReferenceToolbarPopover.vue.js";
+const x = {
+  type: "button",
+  class: "text-c-2 hover:text-c-1 hover:bg-b-2 flex items-center gap-1 rounded px-2 py-2.25 text-base leading-none"
+}, y = { class: "-m-2 flex flex-col gap-2 leading-relaxed" }, T = { class: "bg-b-2 inline-flex items-center gap-0.5 rounded border px-1 py-0.5 text-sm" }, i = 'showToolbar: "never"', k = /* @__PURE__ */ s({
+  __name: "ApiReferenceToolbarTitle",
+  setup(v) {
+    const { copyToClipboard: a } = b();
+    return (C, o) => (d(), p(g, {
+      class: "w-120",
+      placement: "bottom-start"
+    }, {
+      button: r(() => [
+        t("button", x, [
+          o[1] || (o[1] = e(" Configuration Toolbar ")),
+          l(n(f))
+        ])
+      ]),
+      info: r(() => o[5] || (o[5] = [
+        e(" The configuration toolbar will only appear when running on localhost ")
+      ])),
+      default: r(() => [
+        t("div", y, [
+          o[4] || (o[4] = t("div", null, " The configuration toolbar allows you to customize the appearance and behavior of your documentation. You can also share your documentation using the Scalar Registry. ", -1)),
+          t("div", null, [
+            o[2] || (o[2] = e(" To disable the toolbar, set ")),
+            t("div", T, [
+              t("code", { class: "font-code" }, u(i)),
+              l(n(c), {
+                icon: n(m),
+                label: "Copy link to clipboard",
+                class: "-m-1 p-1.25",
+                size: "sm",
+                onClick: o[0] || (o[0] = (w) => n(a)(i))
+              }, null, 8, ["icon"])
+            ]),
+            o[3] || (o[3] = e(" in your configuration. "))
+          ])
+        ])
+      ]),
+      _: 1
+    }));
+  }
+});
+export {
+  k as default
+};

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue2.js

@@ -0,0 +1,4 @@
+import f from "./ApiReferenceToolbarTitle.vue.js";
+export {
+  f as default
+};

package/dist/features/toolbar/uploadTempDocument.d.ts

@@ -0,0 +1,3 @@
+/** Upload a document and return a temporary URL */
+export declare function uploadTempDocument(document: string): Promise<string>;
+//# sourceMappingURL=uploadTempDocument.d.ts.map

package/dist/features/toolbar/uploadTempDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadTempDocument.d.ts","sourceRoot":"","sources":["../../../src/features/toolbar/uploadTempDocument.ts"],"names":[],"mappings":"AASA,mDAAmD;AACnD,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB1E"}

package/dist/features/toolbar/uploadTempDocument.js

@@ -0,0 +1,21 @@
+import { redirectToProxy as n } from "@scalar/oas-utils/helpers";
+import { PROXY_URL as i, UPLOAD_TEMP_API_URL as s } from "../../consts/urls.js";
+function p(e) {
+  return !!e && typeof e == "object" && "url" in e && typeof e.url == "string";
+}
+async function f(e) {
+  const t = JSON.stringify({ document: e }), r = await fetch(n(i, s), {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: t
+  });
+  if (!r.ok)
+    throw new Error(` Failed to generate temporary link, server responded with ${r.status}`);
+  const o = await r.json();
+  if (!p(o))
+    throw new Error("Failed to generate temporary link, invalid response from server");
+  return o.url;
+}
+export {
+  f as uploadTempDocument
+};

package/dist/helpers/convert-security-scheme.d.ts

@@ -3,7 +3,7 @@ import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/
 /**
  * Convert the old security scheme to the new one with secret extensions
  *
- * Remove this once we are migrated to the workspace store
+ * Remove this once we are migrated to the workspace store. We are going to double up on secrets temporarily.
  */
 export declare const convertSecurityScheme: (scheme: SecurityScheme) => SecuritySchemeObject;
 //# sourceMappingURL=convert-security-scheme.d.ts.map