@scalar/api-client 2.1.26 → 2.1.28

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @scalar/api-client
 
+## 2.1.28
+
+### Patch Changes
+
+- dea4f88: chore: update wording on settings page
+
+## 2.1.27
+
+### Patch Changes
+
+- 4e50d65: feat: added openapi watcher to live update the api client
+- 4e50d65: feat: adds watch toggle in request sidebar item menu
+- Updated dependencies [4e50d65]
+- Updated dependencies [4e50d65]
+- Updated dependencies [4e50d65]
+- Updated dependencies [4e50d65]
+- Updated dependencies [4e50d65]
+- Updated dependencies [6bbb815]
+  - @scalar/components@0.12.56
+  - @scalar/oas-utils@0.2.59
+  - @scalar/themes@0.9.40
+  - @scalar/use-codemirror@0.11.23
+
 ## 2.1.26
 
 ### Patch Changes

package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommandPaletteImport.vue.d.ts","sourceRoot":"","sources":["../../../src/components/CommandPalette/CommandPaletteImport.vue"],"names":[],"mappings":";;;;;;;AAmfA,wBASG"}
+{"version":3,"file":"CommandPaletteImport.vue.d.ts","sourceRoot":"","sources":["../../../src/components/CommandPalette/CommandPaletteImport.vue"],"names":[],"mappings":";;;;;;;AA6sBA,wBASG"}

package/dist/components/CommandPalette/CommandPaletteImport.vue.js

@@ -1,133 +1,193 @@
-import { defineComponent as P, ref as R, computed as v, openBlock as l, createBlock as k, unref as r, withCtx as p, createVNode as y, createTextVNode as i, createElementBlock as u, Fragment as m, toDisplayString as w, createElementVNode as U, createCommentVNode as T } from "vue";
-import { useLoadingState as j, ScalarButton as D, ScalarIcon as M, ScalarCodeBlock as _ } from "@scalar/components";
-import { useToasts as z } from "@scalar/use-toasts";
-import E from "./CommandActionForm.vue.js";
-import W from "./CommandActionInput.vue.js";
-import { getOpenApiDocumentDetails as h } from "../../libs/getOpenApiDocumentDetails.js";
-import { isUrl as x } from "../../libs/isUrl.js";
-import { useFileDialog as J } from "../../hooks/useFileDialog.js";
-import { useWorkspace as Y } from "../../store/store.js";
-const q = { class: "flex justify-between" }, le = /* @__PURE__ */ P({
+import { defineComponent as M, ref as U, computed as w, watch as O, openBlock as a, createBlock as h, unref as l, withCtx as c, createElementVNode as d, createVNode as f, createTextVNode as n, normalizeClass as V, createElementBlock as i, Fragment as g, toDisplayString as _, createCommentVNode as N } from "vue";
+import { useLoadingState as $, ScalarButton as F, ScalarIcon as L, ScalarTooltip as j, ScalarToggle as E, ScalarCodeBlock as J } from "@scalar/components";
+import { useToasts as Y } from "@scalar/use-toasts";
+import q from "./CommandActionForm.vue.js";
+import G from "./CommandActionInput.vue.js";
+import { getOpenApiDocumentDetails as H } from "../../libs/getOpenApiDocumentDetails.js";
+import { isUrl as k } from "../../libs/isUrl.js";
+import { useFileDialog as K } from "../../hooks/useFileDialog.js";
+import { useWorkspace as Q } from "../../store/store.js";
+const X = { class: "flex justify-between" }, Z = { class: "flex flex-row items-center justify-between gap-3 w-full" }, ee = { class: "grid gap-1.5 pointer-events-none max-w-[320px] w-content shadow-lg rounded bg-b-1 z-100 p-2 text-xxs leading-5 z-10 text-c-1" }, te = { class: "flex items-center text-c-2" }, oe = { key: 0 }, ae = {
+  key: 1,
+  class: "text-pretty"
+}, ve = /* @__PURE__ */ M({
   __name: "CommandPaletteImport",
   emits: ["close", "back"],
-  setup(G, { emit: F }) {
-    const f = F, { activeWorkspace: g, importSpecFile: b, importSpecFromUrl: L } = Y(), { toast: c } = z(), s = j(), t = R(""), o = v(
-      () => h(t.value)
-    ), C = v(
-      () => o.value ? o.value.type : "json"
-    ), S = v(() => x(t.value)), V = v(() => !!o.value), { open: A } = J({
-      onChange: async (a) => {
-        const e = a == null ? void 0 : a[0];
+  setup(le, { emit: A }) {
+    const b = A, { activeWorkspace: x, importSpecFile: C, importSpecFromUrl: D } = Q(), { toast: m } = Y(), u = $(), t = U(""), p = U(!0), r = w(
+      () => H(t.value)
+    ), S = w(
+      () => r.value ? r.value.type : "json"
+    ), v = w(() => k(t.value)), R = w(() => !!r.value), { open: z } = K({
+      onChange: async (o) => {
+        const e = o == null ? void 0 : o[0];
         if (e) {
-          const n = new FileReader();
-          n.onload = async (N) => {
+          const s = new FileReader();
+          s.onload = async (T) => {
             var I;
-            const O = (I = N.target) == null ? void 0 : I.result;
+            const W = (I = T.target) == null ? void 0 : I.result;
             try {
-              await b(O, g.value.uid), c("Import successful", "info"), f("close");
-            } catch (d) {
-              console.error(d);
-              const $ = (d == null ? void 0 : d.message) || "Unknown error";
-              c(`Import failed: ${$}`, "error");
+              await C(W, x.value.uid), m("Import successful", "info"), b("close");
+            } catch (y) {
+              console.error(y);
+              const B = (y == null ? void 0 : y.message) || "Unknown error";
+              m(`Import failed: ${B}`, "error");
             }
-          }, n.readAsText(e);
+          }, s.readAsText(e);
         }
       },
       multiple: !1,
       accept: ".json,.yaml,.yml"
     });
-    async function B() {
-      if (!(!t.value || s.isLoading)) {
-        s.startLoading();
+    O(v, (o) => {
+      o || (p.value = !1);
+    }), O(t, (o) => {
+      k(o) || (p.value = !1);
+    });
+    async function P() {
+      if (!(!t.value || u.isLoading)) {
+        u.startLoading();
         try {
-          if (S.value)
-            await L(
+          if (v.value) {
+            const [o] = await D(
               t.value,
-              void 0,
-              void 0,
-              g.value.uid
+              x.value.uid,
+              {
+                proxy: x.value.proxyUrl,
+                watchForChanges: p.value
+              }
             );
-          else if (V.value)
-            await b(
+            if (o) {
+              m(
+                "There was a possible CORS error while importing your spec, please make sure this server is allowed in the CORS policy of your OpenAPI document.",
+                "error",
+                { timeout: 5e3 }
+              ), u.invalidate(2e3, !0);
+              return;
+            }
+          } else if (R.value)
+            await C(
               String(t.value),
-              g.value.uid
+              x.value.uid
             );
           else {
-            c("Import failed: Invalid URL or OpenAPI document", "error"), s.invalidate(2e3, !0);
+            m("Import failed: Invalid URL or OpenAPI document", "error"), u.invalidate(2e3, !0);
             return;
           }
-          s.clear(), f("close"), c("Import successful", "info");
-        } catch (a) {
-          console.error("[importCollection]", a);
-          const e = (a == null ? void 0 : a.message) || "Unknown error";
-          s.invalidate(2e3, !0), c(`Import failed: ${e}`, "error");
+          u.clear(), b("close"), m("Import successful", "info");
+        } catch (o) {
+          console.error("[importCollection]", o);
+          const e = (o == null ? void 0 : o.message) || "Unknown error";
+          u.invalidate(2e3, !0), m(`Import failed: ${e}`, "error");
         }
       }
     }
-    return (a, e) => (l(), k(E, {
+    return (o, e) => (a(), h(q, {
       disabled: !t.value.trim(),
-      loading: r(s),
-      onSubmit: B
+      loading: l(u),
+      onSubmit: P
     }, {
-      options: p(() => [
-        y(r(D), {
-          class: "p-2 max-h-8 gap-1.5 text-xs hover:bg-b-2 relative",
-          variant: "outlined",
-          onClick: r(A)
-        }, {
-          default: p(() => [
-            e[5] || (e[5] = i(" JSON, or YAML File ")),
-            y(r(M), {
-              class: "text-c-3",
-              icon: "UploadSimple",
-              size: "md"
-            })
-          ]),
-          _: 1
-        }, 8, ["onClick"])
+      options: c(() => [
+        d("div", Z, [
+          f(l(F), {
+            class: "p-2 max-h-8 gap-1.5 text-xs hover:bg-b-2 relative",
+            variant: "outlined",
+            onClick: l(z)
+          }, {
+            default: c(() => [
+              e[6] || (e[6] = n(" JSON, or YAML File ")),
+              f(l(L), {
+                class: "text-c-3",
+                icon: "UploadSimple",
+                size: "md"
+              })
+            ]),
+            _: 1
+          }, 8, ["onClick"]),
+          f(l(j), {
+            as: "div",
+            class: "z-[10001]",
+            side: "bottom",
+            sideOffset: 5
+          }, {
+            trigger: c(() => [
+              d("label", {
+                class: V([
+                  "p-3 py-1.5 rounded flex items-center text-sm text-c-2 gap-2 select-none",
+                  t.value && !v.value ? "cursor-default" : "cursor-pointer"
+                ]),
+                for: "watch-toggle"
+              }, [
+                d("span", {
+                  class: V(["text-c-1 flex gap-1 items-center font-medium text-xs", { "text-c-3": !p.value }])
+                }, [
+                  f(l(L), {
+                    icon: "Watch",
+                    size: "sm"
+                  }),
+                  e[7] || (e[7] = n(" Watch Mode "))
+                ], 2),
+                f(l(E), {
+                  id: "watch-toggle",
+                  modelValue: p.value,
+                  "onUpdate:modelValue": e[3] || (e[3] = (s) => p.value = s),
+                  disabled: !!t.value && !v.value
+                }, null, 8, ["modelValue", "disabled"])
+              ], 2)
+            ]),
+            content: c(() => [
+              d("div", ee, [
+                d("div", te, [
+                  t.value && !v.value ? (a(), i("span", oe, "Watch Mode is only supported with URL")) : (a(), i("span", ae, "Watch your OpenAPI URL for changes. Enabled it will update the API client for you."))
+                ])
+              ])
+            ]),
+            _: 1
+          })
+        ])
       ]),
-      submit: p(() => [
-        e[6] || (e[6] = i(" Import ")),
-        S.value ? (l(), u(m, { key: 0 }, [
-          i(" from URL ")
-        ], 64)) : o.value && C.value ? (l(), u(m, { key: 1 }, [
-          o.value.title ? (l(), u(m, { key: 0 }, [
-            i(' "' + w(o.value.title) + '" ', 1)
-          ], 64)) : (l(), u(m, { key: 1 }, [
-            i(w(o.value.version) + " Spec", 1)
+      submit: c(() => [
+        e[8] || (e[8] = n(" Import ")),
+        v.value ? (a(), i(g, { key: 0 }, [
+          n(" from URL ")
+        ], 64)) : r.value && S.value ? (a(), i(g, { key: 1 }, [
+          r.value.title ? (a(), i(g, { key: 0 }, [
+            n(' "' + _(r.value.title) + '" ', 1)
+          ], 64)) : (a(), i(g, { key: 1 }, [
+            n(_(r.value.version) + " Spec", 1)
           ], 64))
-        ], 64)) : (l(), u(m, { key: 2 }, [
-          i("Collection")
+        ], 64)) : (a(), i(g, { key: 2 }, [
+          n("Collection")
         ], 64))
       ]),
-      default: p(() => [
-        !o.value || r(x)(t.value) ? (l(), k(W, {
+      default: c(() => [
+        !r.value || l(k)(t.value) ? (a(), h(G, {
           key: 0,
           modelValue: t.value,
-          "onUpdate:modelValue": e[0] || (e[0] = (n) => t.value = n),
+          "onUpdate:modelValue": e[0] || (e[0] = (s) => t.value = s),
           placeholder: "OpenAPI/Swagger URL or document",
-          onOnDelete: e[1] || (e[1] = (n) => f("back", n))
-        }, null, 8, ["modelValue"])) : (l(), u(m, { key: 1 }, [
-          U("div", q, [
-            e[4] || (e[4] = U("div", { class: "pl-8 text-xs min-h-8 py-2 text-c-2" }, "Preview", -1)),
-            y(r(D), {
+          onOnDelete: e[1] || (e[1] = (s) => b("back", s))
+        }, null, 8, ["modelValue"])) : (a(), i(g, { key: 1 }, [
+          d("div", X, [
+            e[5] || (e[5] = d("div", { class: "pl-8 text-xs min-h-8 py-2 text-c-2" }, "Preview", -1)),
+            f(l(F), {
               class: "ml-auto p-2 max-h-8 gap-1.5 text-xs hover:bg-b-2 relative",
               variant: "ghost",
-              onClick: e[2] || (e[2] = (n) => t.value = "")
+              onClick: e[2] || (e[2] = (s) => t.value = "")
             }, {
-              default: p(() => e[3] || (e[3] = [
-                i(" Clear ")
+              default: c(() => e[4] || (e[4] = [
+                n(" Clear ")
               ])),
               _: 1
             })
           ]),
-          o.value && !r(x)(t.value) ? (l(), k(r(_), {
+          r.value && !l(k)(t.value) ? (a(), h(l(J), {
             key: 0,
             class: "border max-h-[40dvh] mt-1 bg-b-2 rounded [--scalar-small:--scalar-font-size-4]",
             content: t.value,
             copy: !1,
-            lang: C.value
-          }, null, 8, ["content", "lang"])) : T("", !0)
+            lang: S.value
+          }, null, 8, ["content", "lang"])) : N("", !0)
         ], 64))
       ]),
       _: 1
@@ -135,5 +195,5 @@ const q = { class: "flex justify-between" }, le = /* @__PURE__ */ P({
   }
 });
 export {
-  le as default
+  ve as default
 };

package/dist/components/ImportCollection/ImportNowButton.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ImportNowButton.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ImportCollection/ImportNowButton.vue"],"names":[],"mappings":";aA6GW,MAAM,GAAG,IAAI;cACZ,QAAQ,GAAG,MAAM;;;;aADlB,MAAM,GAAG,IAAI;cACZ,QAAQ,GAAG,MAAM;;;;AAkL7B,wBASG"}
+{"version":3,"file":"ImportNowButton.vue.d.ts","sourceRoot":"","sources":["../../../src/components/ImportCollection/ImportNowButton.vue"],"names":[],"mappings":";aA2GW,MAAM,GAAG,IAAI;cACZ,QAAQ,GAAG,MAAM;;;;aADlB,MAAM,GAAG,IAAI;cACZ,QAAQ,GAAG,MAAM;;;;AAgL7B,wBASG"}

package/dist/components/ImportCollection/ImportNowButton.vue.js

@@ -1,10 +1,10 @@
-import { defineComponent as x, openBlock as s, createElementBlock as b, Fragment as w, createBlock as m, unref as a, withCtx as p, createTextVNode as c, createCommentVNode as g } from "vue";
+import { defineComponent as b, openBlock as s, createElementBlock as v, Fragment as w, createBlock as m, unref as a, withCtx as p, createTextVNode as c, createCommentVNode as g } from "vue";
 import { isUrl as h } from "./utils/isUrl.js";
 import { ScalarButton as l } from "@scalar/components";
 import { useToasts as F } from "@scalar/use-toasts";
 import { useRouter as B } from "vue-router";
 import { useWorkspace as I } from "../../store/store.js";
-const R = /* @__PURE__ */ x({
+const R = /* @__PURE__ */ b({
   __name: "ImportNowButton",
   props: {
     source: {},
@@ -12,20 +12,18 @@ const R = /* @__PURE__ */ x({
   },
   emits: ["importFinished"],
   setup(f, { emit: d }) {
-    const o = f, k = d, y = B(), { importSpecFromUrl: v, importSpecFile: C, activeWorkspace: r } = I(), { toast: i } = F();
+    const o = f, k = d, y = B(), { importSpecFromUrl: C, importSpecFile: x, activeWorkspace: r } = I(), { toast: i } = F();
     async function n() {
       try {
         if (o.source) {
           if (h(o.source)) {
-            const t = await v(
+            const [t, e] = await C(
               o.source,
-              void 0,
-              void 0,
               r.value.uid
             );
-            u(t);
+            t || u(e);
           } else {
-            const t = await C(
+            const t = await x(
               o.source,
               r.value.uid
             );
@@ -48,7 +46,7 @@ const R = /* @__PURE__ */ x({
         }
       });
     }
-    return (t, e) => t.source ? (s(), b(w, { key: 0 }, [
+    return (t, e) => t.source ? (s(), v(w, { key: 0 }, [
       t.variant === "button" ? (s(), m(a(l), {
         key: 0,
         class: "text-[21px] py-2.5 px-6 rounded-lg font-bold h-fit mt-3 mb-1.5",