@scalar/api-client 2.12.0 → 2.13.0

package/dist/v2/features/command-palette/components/CommandPaletteImportCurl.vue2.js

@@ -0,0 +1,115 @@
+import { defineComponent as y, ref as b, computed as i, createBlock as B, openBlock as N, withCtx as r, createVNode as n, createElementVNode as m, unref as l, toDisplayString as d, createTextVNode as D, normalizeClass as I } from "vue";
+import { ScalarListbox as $, ScalarButton as K, ScalarIcon as R } from "@scalar/components";
+import { useRouter as U } from "vue-router";
+import j from "../../../blocks/operation-code-sample/components/HttpMethod.vue.js";
+import z from "./CommandActionForm.vue.js";
+import E from "./CommandActionInput.vue.js";
+import { getOperationFromCurl as k } from "../helpers/get-operation-from-curl.js";
+const O = { class: "flex flex-1 flex-col gap-2" }, T = { class: "flex h-9 flex-row items-center gap-2 rounded border p-[3px] text-sm" }, q = { class: "scroll-timeline-x whitespace-nowrap" }, F = { class: "flex items-center gap-2" }, L = {
+  name: "CommandPaletteImportCurl"
+}, Q = /* @__PURE__ */ y({
+  ...L,
+  props: {
+    workspaceStore: {},
+    eventBus: {},
+    curl: {}
+  },
+  emits: ["close", "back"],
+  setup(a, { emit: w }) {
+    const p = w, S = U(), u = b(""), c = i(() => u.value.trim()), { path: f, method: v, operation: C } = k(a.curl), x = i(
+      () => Object.keys(a.workspaceStore.workspace.documents).map((t) => ({
+        id: t,
+        label: t
+      }))
+    ), o = b(
+      x.value[0]
+    ), h = i(() => !!(!c.value || !o.value || a.workspaceStore.workspace.documents[o.value.id]?.paths?.[f]?.[v])), g = () => {
+      const t = o.value;
+      if (h.value || !t)
+        return;
+      const e = k(a.curl, c.value);
+      a.eventBus.emit("operation:create:operation", {
+        documentName: t.id,
+        path: e.path,
+        method: e.method,
+        operation: e.operation,
+        exampleKey: c.value,
+        callback: (s) => {
+          if (s) {
+            a.workspaceStore.buildSidebar(t.id);
+            const _ = e.path.startsWith("/") ? e.path : `/${e.path}`;
+            S.push({
+              name: "example",
+              params: {
+                documentSlug: t.id,
+                pathEncoded: encodeURIComponent(_),
+                method: e.method,
+                exampleName: c.value
+              }
+            });
+          }
+        }
+      }), p("close");
+    }, V = (t) => {
+      p("back", t);
+    };
+    return (t, e) => (N(), B(z, {
+      disabled: h.value,
+      onSubmit: g
+    }, {
+      options: r(() => [
+        m("div", F, [
+          n(l($), {
+            modelValue: o.value,
+            "onUpdate:modelValue": e[1] || (e[1] = (s) => o.value = s),
+            options: x.value
+          }, {
+            default: r(() => [
+              n(l(K), {
+                class: "hover:bg-b-2 max-h-8 w-full justify-between gap-1 p-2 text-xs",
+                variant: "outlined"
+              }, {
+                default: r(() => [
+                  m("span", {
+                    class: I(["whitespace-nowrap", o.value ? "text-c-1" : "text-c-3"])
+                  }, d(o.value ? o.value.label : "Select Collection"), 3),
+                  n(l(R), {
+                    class: "text-c-3",
+                    icon: "ChevronDown",
+                    size: "md"
+                  })
+                ]),
+                _: 1
+              })
+            ]),
+            _: 1
+          }, 8, ["modelValue", "options"])
+        ])
+      ]),
+      submit: r(() => [...e[2] || (e[2] = [
+        D("Import Request", -1)
+      ])]),
+      default: r(() => [
+        n(E, {
+          modelValue: u.value,
+          "onUpdate:modelValue": e[0] || (e[0] = (s) => u.value = s),
+          placeholder: "Curl example key (e.g., example-1)",
+          onDelete: V
+        }, null, 8, ["modelValue"]),
+        m("div", O, [
+          m("div", T, [
+            n(j, {
+              class: "border-r-1 px-1",
+              method: l(v)
+            }, null, 8, ["method"]),
+            m("span", q, d(l(C).servers?.[0]?.url || "") + d(l(f)), 1)
+          ])
+        ])
+      ]),
+      _: 1
+    }, 8, ["disabled"]));
+  }
+});
+export {
+  Q as default
+};

package/dist/v2/features/command-palette/components/CommandPaletteRequest.vue.d.ts

@@ -0,0 +1,39 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+/**
+ * Command Palette Request Component
+ *
+ * Provides a form for creating a new API request (operation) in a document.
+ * Users can specify the request path, HTTP method, document (collection),
+ * and optionally assign it to a tag.
+ *
+ * Validates that no operation with the same path and method already exists
+ * in the selected document to prevent duplicates.
+ *
+ * @example
+ * <CommandPaletteRequest
+ *   :workspaceStore="workspaceStore"
+ *   :eventBus="eventBus"
+ *   @close="handleClose"
+ *   @back="handleBack"
+ * />
+ */
+declare const _default: import("vue").DefineComponent<{
+    /** The workspace store for accessing documents and operations */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting operation creation events */
+    eventBus: WorkspaceEventBus;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    close: () => any;
+    back: (keyboardEvent: KeyboardEvent) => any;
+}, string, import("vue").PublicProps, Readonly<{
+    /** The workspace store for accessing documents and operations */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting operation creation events */
+    eventBus: WorkspaceEventBus;
+}> & Readonly<{
+    onClose?: (() => any) | undefined;
+    onBack?: ((keyboardEvent: KeyboardEvent) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;
+//# sourceMappingURL=CommandPaletteRequest.vue.d.ts.map

package/dist/v2/features/command-palette/components/CommandPaletteRequest.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandPaletteRequest.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/command-palette/components/CommandPaletteRequest.vue"],"names":[],"mappings":"AAiWA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAUvE;;;;;;;;;;;;;;;;;GAiBG;;IAGD,iEAAiE;oBACjD,cAAc;IAC9B,uDAAuD;cAC7C,iBAAiB;;;;;IAH3B,iEAAiE;oBACjD,cAAc;IAC9B,uDAAuD;cAC7C,iBAAiB;;;;;AAL7B,wBAsjBC"}

package/dist/v2/features/command-palette/components/CommandPaletteRequest.vue.js

@@ -0,0 +1,213 @@
+import { defineComponent as I, ref as p, computed as v, createBlock as f, openBlock as m, withCtx as o, createVNode as n, createTextVNode as O, createElementVNode as r, unref as s, normalizeClass as D, toDisplayString as b, createCommentVNode as H, createElementBlock as T, Fragment as V, renderList as y } from "vue";
+import { ScalarListbox as L, ScalarButton as x, ScalarIcon as w, ScalarDropdown as z, ScalarDropdownItem as B } from "@scalar/components";
+import { HTTP_METHODS as W } from "@scalar/helpers/http/http-methods";
+import { useRouter as F } from "vue-router";
+import N from "../../../blocks/operation-code-sample/components/HttpMethod.vue.js";
+import A from "./CommandActionForm.vue.js";
+import G from "./CommandActionInput.vue.js";
+const J = { class: "flex flex-1 gap-1" }, K = { class: "flex items-center gap-2" }, Q = { class: "custom-scroll max-h-40" }, X = { class: "custom-scroll max-h-40" }, Y = { class: "truncate" }, Z = {
+  name: "CommandPaletteRequest"
+}, ue = /* @__PURE__ */ I({
+  ...Z,
+  props: {
+    workspaceStore: {},
+    eventBus: {}
+  },
+  emits: ["close", "back"],
+  setup(i, { emit: $ }) {
+    const k = $, P = F(), h = p("/"), u = v(() => h.value.trim()), S = v(
+      () => Object.entries(i.workspaceStore.workspace.documents).map(
+        ([e, a]) => ({
+          id: e,
+          label: a.info.title || e
+        })
+      )
+    ), _ = W.map((e) => ({
+      id: e,
+      label: e.toUpperCase(),
+      method: e
+    })), t = p(
+      S.value[0] ?? void 0
+    ), c = p(
+      _.find((e) => e.method === "get")
+    ), d = p(void 0), g = v(() => {
+      if (!t.value)
+        return [];
+      const e = i.workspaceStore.workspace.documents[t.value.id];
+      return e ? [
+        { id: "", label: "No Tag" },
+        ...e.tags?.map((a) => ({
+          id: a.name,
+          label: a.name
+        })) ?? []
+      ] : [];
+    }), j = v(() => {
+      if (!t.value || !c.value || !u.value)
+        return !1;
+      const e = i.workspaceStore.workspace.documents[t.value.id], a = u.value.startsWith("/") ? u.value : `/${u.value}`;
+      return !!e?.paths?.[a]?.[c.value.method];
+    }), C = v(() => !!(!u.value || !t.value || !c.value || j.value)), q = (e) => {
+      e && (c.value = e);
+    }, E = (e) => {
+      e && (d.value = e);
+    }, R = () => {
+      C.value || !t.value || !c.value || !i.workspaceStore.workspace.documents[t.value.id] || (i.eventBus.emit("operation:create:operation", {
+        documentName: t.value.id,
+        path: u.value,
+        method: c.value.method,
+        operation: {
+          tags: d.value?.id ? [d.value.id] : void 0
+        },
+        callback: (a) => {
+          if (a) {
+            i.workspaceStore.buildSidebar(t.value?.id ?? "");
+            const l = u.value.startsWith("/") ? u.value : `/${u.value}`;
+            P.push({
+              name: "example",
+              params: {
+                documentSlug: t.value?.id,
+                pathEncoded: encodeURIComponent(l),
+                method: c.value?.method,
+                exampleName: "default"
+              }
+            });
+          }
+        }
+      }), k("close"));
+    }, M = (e) => {
+      k("back", e);
+    };
+    return (e, a) => (m(), f(A, {
+      disabled: C.value,
+      onSubmit: R
+    }, {
+      options: o(() => [
+        r("div", J, [
+          n(s(L), {
+            modelValue: t.value,
+            "onUpdate:modelValue": a[1] || (a[1] = (l) => t.value = l),
+            options: S.value
+          }, {
+            default: o(() => [
+              n(s(x), {
+                class: "hover:bg-b-2 max-h-8 w-[150px] min-w-[150px] justify-between gap-1 p-2 text-xs",
+                variant: "outlined"
+              }, {
+                default: o(() => [
+                  r("span", {
+                    class: D(t.value ? "text-c-1 truncate" : "text-c-3")
+                  }, b(t.value ? t.value.label : "Select Document"), 3),
+                  n(s(w), {
+                    class: "text-c-3",
+                    icon: "ChevronDown",
+                    size: "md"
+                  })
+                ]),
+                _: 1
+              })
+            ]),
+            _: 1
+          }, 8, ["modelValue", "options"]),
+          n(s(z), {
+            placement: "bottom",
+            resize: ""
+          }, {
+            items: o(() => [
+              r("div", Q, [
+                (m(!0), T(V, null, y(s(_), (l) => (m(), f(s(B), {
+                  key: l.id,
+                  class: "flex h-7 w-full items-center justify-center px-1",
+                  onClick: (U) => q(l)
+                }, {
+                  default: o(() => [
+                    n(N, {
+                      method: l.method
+                    }, null, 8, ["method"])
+                  ]),
+                  _: 2
+                }, 1032, ["onClick"]))), 128))
+              ])
+            ]),
+            default: o(() => [
+              n(s(x), {
+                class: "hover:bg-b-2 max-h-8 w-[100px] min-w-[100px] justify-between gap-1 p-2 text-xs",
+                variant: "outlined"
+              }, {
+                default: o(() => [
+                  r("div", K, [
+                    c.value ? (m(), f(N, {
+                      key: 0,
+                      method: c.value.method
+                    }, null, 8, ["method"])) : H("", !0),
+                    n(s(w), {
+                      class: "text-c-3",
+                      icon: "ChevronDown",
+                      size: "md"
+                    })
+                  ])
+                ]),
+                _: 1
+              })
+            ]),
+            _: 1
+          }),
+          n(s(z), {
+            placement: "bottom",
+            resize: ""
+          }, {
+            items: o(() => [
+              r("div", X, [
+                (m(!0), T(V, null, y(g.value, (l) => (m(), f(s(B), {
+                  key: l.id,
+                  class: "flex h-7 w-full items-center px-1",
+                  onClick: (U) => E(l)
+                }, {
+                  default: o(() => [
+                    r("span", Y, b(l.label), 1)
+                  ]),
+                  _: 2
+                }, 1032, ["onClick"]))), 128))
+              ])
+            ]),
+            default: o(() => [
+              n(s(x), {
+                class: "hover:bg-b-2 max-h-8 w-full justify-between gap-1 p-2 text-xs",
+                disabled: !g.value.length,
+                variant: "outlined"
+              }, {
+                default: o(() => [
+                  r("span", {
+                    class: D(d.value ? "text-c-1 truncate" : "text-c-3")
+                  }, b(d.value ? d.value.label : "Select Tag (Optional)"), 3),
+                  n(s(w), {
+                    class: "text-c-3",
+                    icon: "ChevronDown",
+                    size: "md"
+                  })
+                ]),
+                _: 1
+              }, 8, ["disabled"])
+            ]),
+            _: 1
+          })
+        ])
+      ]),
+      submit: o(() => [...a[2] || (a[2] = [
+        O("Create Request", -1)
+      ])]),
+      default: o(() => [
+        n(G, {
+          modelValue: h.value,
+          "onUpdate:modelValue": a[0] || (a[0] = (l) => h.value = l),
+          label: "Request Path",
+          placeholder: "/users",
+          onDelete: M
+        }, null, 8, ["modelValue"])
+      ]),
+      _: 1
+    }, 8, ["disabled"]));
+  }
+});
+export {
+  ue as default
+};

package/dist/v2/features/command-palette/components/CommandPaletteRequest.vue2.js

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

package/dist/v2/features/command-palette/components/CommandPaletteTag.vue.d.ts

@@ -0,0 +1,38 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+/**
+ * Command Palette Tag Component
+ *
+ * Provides a form for creating a new tag in a document (collection).
+ * Tags are used to organize and group related API operations.
+ *
+ * Validates that the tag name does not already exist in the selected document
+ * to prevent duplicates.
+ *
+ * @example
+ * <CommandPaletteTag
+ *   :workspaceStore="workspaceStore"
+ *   :eventBus="eventBus"
+ *   @close="handleClose"
+ *   @back="handleBack"
+ * />
+ */
+declare const _default: import("vue").DefineComponent<{
+    /** The workspace store for accessing documents and tags */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting tag creation events */
+    eventBus: WorkspaceEventBus;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    close: () => any;
+    back: (keyboardEvent: KeyboardEvent) => any;
+}, string, import("vue").PublicProps, Readonly<{
+    /** The workspace store for accessing documents and tags */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting tag creation events */
+    eventBus: WorkspaceEventBus;
+}> & Readonly<{
+    onClose?: (() => any) | undefined;
+    onBack?: ((keyboardEvent: KeyboardEvent) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;
+//# sourceMappingURL=CommandPaletteTag.vue.d.ts.map

package/dist/v2/features/command-palette/components/CommandPaletteTag.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandPaletteTag.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/command-palette/components/CommandPaletteTag.vue"],"names":[],"mappings":"AA4JA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAOvE;;;;;;;;;;;;;;;;GAgBG;;IAGD,2DAA2D;oBAC3C,cAAc;IAC9B,iDAAiD;cACvC,iBAAiB;;;;;IAH3B,2DAA2D;oBAC3C,cAAc;IAC9B,iDAAiD;cACvC,iBAAiB;;;;;AAL7B,wBA8OC"}

package/dist/v2/features/command-palette/components/CommandPaletteTag.vue.js

@@ -0,0 +1,89 @@
+import { defineComponent as S, ref as f, computed as i, createBlock as x, openBlock as g, withCtx as l, createVNode as n, createTextVNode as w, unref as m, createElementVNode as V, normalizeClass as C, toDisplayString as B } from "vue";
+import { ScalarListbox as D, ScalarButton as N, ScalarIcon as T } from "@scalar/components";
+import _ from "./CommandActionForm.vue.js";
+import h from "./CommandActionInput.vue.js";
+const j = {
+  name: "CommandPaletteTag"
+}, E = /* @__PURE__ */ S({
+  ...j,
+  props: {
+    workspaceStore: {},
+    eventBus: {}
+  },
+  emits: ["close", "back"],
+  setup(o, { emit: p }) {
+    const c = p, u = f(""), r = i(() => u.value.trim()), d = i(
+      () => Object.entries(o.workspaceStore.workspace.documents).map(
+        ([t, a]) => ({
+          id: t,
+          label: a.info.title || t
+        })
+      )
+    ), e = f(
+      d.value[0] ?? void 0
+    ), v = i(() => {
+      if (!r.value || !e.value)
+        return !0;
+      const t = o.workspaceStore.workspace.documents[e.value.id];
+      return !!(!t || t.tags?.some((a) => a.name === r.value));
+    }), b = () => {
+      v.value || !e.value || (o.eventBus.emit("tag:create:tag", {
+        name: r.value,
+        documentName: e.value.id,
+        callback: (t) => {
+          t && o.workspaceStore.buildSidebar(e.value?.id ?? "");
+        }
+      }), c("close"));
+    }, k = (t) => {
+      c("back", t);
+    };
+    return (t, a) => (g(), x(_, {
+      disabled: v.value,
+      onSubmit: b
+    }, {
+      options: l(() => [
+        n(m(D), {
+          modelValue: e.value,
+          "onUpdate:modelValue": a[1] || (a[1] = (s) => e.value = s),
+          options: d.value
+        }, {
+          default: l(() => [
+            n(m(N), {
+              class: "hover:bg-b-2 max-h-8 w-fit justify-between gap-1 p-2 text-xs",
+              variant: "outlined"
+            }, {
+              default: l(() => [
+                V("span", {
+                  class: C(e.value ? "text-c-1" : "text-c-3")
+                }, B(e.value ? e.value.label : "Select Collection"), 3),
+                n(m(T), {
+                  class: "text-c-3",
+                  icon: "ChevronDown",
+                  size: "md"
+                })
+              ]),
+              _: 1
+            })
+          ]),
+          _: 1
+        }, 8, ["modelValue", "options"])
+      ]),
+      submit: l(() => [...a[2] || (a[2] = [
+        w("Create Tag", -1)
+      ])]),
+      default: l(() => [
+        n(h, {
+          modelValue: u.value,
+          "onUpdate:modelValue": a[0] || (a[0] = (s) => u.value = s),
+          label: "Tag Name",
+          placeholder: "Tag Name",
+          onDelete: k
+        }, null, 8, ["modelValue"])
+      ]),
+      _: 1
+    }, 8, ["disabled"]));
+  }
+});
+export {
+  E as default
+};

package/dist/v2/features/command-palette/components/CommandPaletteTag.vue2.js

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

package/dist/v2/features/command-palette/components/TheCommandPalette.vue.d.ts

@@ -0,0 +1,41 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+import type { UseCommandPaletteStateReturn } from '../../../../v2/features/command-palette/hooks/use-command-palette-state.js';
+/**
+ * The Command Palette Component
+ *
+ * A keyboard-driven command menu for quick access to common actions like:
+ * - Creating documents, requests, tags, and examples
+ * - Importing from OpenAPI, Swagger, Postman, or cURL
+ * - Navigating to different routes
+ *
+ * Supports:
+ * - Fuzzy search filtering
+ * - Keyboard navigation (arrow keys, enter, escape)
+ * - Command grouping and organization
+ * - Dynamic command components with props
+ *
+ * @example
+ * <TheCommandPalette
+ *   :paletteState="paletteState"
+ *   :workspaceStore="workspaceStore"
+ *   :eventBus="eventBus"
+ * />
+ */
+declare const _default: import("vue").DefineComponent<{
+    /** The command palette state management hook */
+    paletteState: UseCommandPaletteStateReturn;
+    /** The workspace store for accessing documents and operations */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting workspace events */
+    eventBus: WorkspaceEventBus;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+    /** The command palette state management hook */
+    paletteState: UseCommandPaletteStateReturn;
+    /** The workspace store for accessing documents and operations */
+    workspaceStore: WorkspaceStore;
+    /** Event bus for emitting workspace events */
+    eventBus: WorkspaceEventBus;
+}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;
+//# sourceMappingURL=TheCommandPalette.vue.d.ts.map

package/dist/v2/features/command-palette/components/TheCommandPalette.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TheCommandPalette.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/command-palette/components/TheCommandPalette.vue"],"names":[],"mappings":"AAoXA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAUvE,OAAO,KAAK,EAKV,4BAA4B,EAC7B,MAAM,+DAA+D,CAAA;AAItE;;;;;;;;;;;;;;;;;;;;GAoBG;;IAGD,gDAAgD;kBAClC,4BAA4B;IAC1C,iEAAiE;oBACjD,cAAc;IAC9B,8CAA8C;cACpC,iBAAiB;;IAL3B,gDAAgD;kBAClC,4BAA4B;IAC1C,iEAAiE;oBACjD,cAAc;IAC9B,8CAA8C;cACpC,iBAAiB;;AAP7B,wBA8dC"}

package/dist/v2/features/command-palette/components/TheCommandPalette.vue.js

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