@scalar/api-client 2.22.2 → 2.23.0

package/dist/v2/features/import-listener/components/WorkspaceSelector.vue.js

@@ -0,0 +1,83 @@
+import { defineComponent as w, createElementBlock as p, openBlock as i, createVNode as t, unref as e, withCtx as l, createElementVNode as o, toDisplayString as m, Fragment as x, renderList as k, createBlock as h, withModifiers as v, normalizeClass as _ } from "vue";
+import { useModal as g, ScalarDropdown as C, ScalarButton as b, ScalarIcon as n, ScalarDropdownItem as f, ScalarDropdownDivider as S } from "@scalar/components";
+import y from "../../app/components/CreateWorkspaceModal.vue.js";
+const D = { class: "flex w-[inherit] items-center text-base" }, W = { class: "m-0 flex items-center gap-1 text-sm font-medium" }, z = { class: "line-clamp-1 w-[calc(100%-10px)] text-left text-xs" }, B = { class: "overflow-hidden text-ellipsis" }, j = { class: "flex h-4 w-4 items-center justify-center" }, V = /* @__PURE__ */ w({
+  __name: "WorkspaceSelector",
+  props: {
+    activeWorkspace: {},
+    workspaces: {}
+  },
+  emits: ["select:workspace", "create:workspace"],
+  setup(r, { emit: u }) {
+    const c = u, d = g();
+    return (M, a) => (i(), p("div", D, [
+      t(e(C), null, {
+        items: l(() => [
+          (i(!0), p(x, null, k(r.workspaces, (s) => (i(), h(e(f), {
+            key: s.id,
+            class: "group/item flex w-full items-center gap-1.5 overflow-hidden text-ellipsis whitespace-nowrap",
+            onClick: v((N) => c("select:workspace", s.id), ["stop"])
+          }, {
+            default: l(() => [
+              o("div", {
+                class: _([
+                  "flex h-4 w-4 items-center justify-center rounded-full p-[3px]",
+                  r.activeWorkspace?.id === s.id ? "bg-c-accent text-b-1" : "shadow-border text-transparent"
+                ])
+              }, [
+                t(e(n), {
+                  class: "size-2.5",
+                  icon: "Checkmark",
+                  thickness: "3"
+                })
+              ], 2),
+              o("span", B, m(s.label), 1)
+            ]),
+            _: 2
+          }, 1032, ["onClick"]))), 128)),
+          t(e(S)),
+          t(e(f), {
+            class: "flex items-center gap-1.5",
+            onClick: a[0] || (a[0] = (s) => e(d).show())
+          }, {
+            default: l(() => [
+              o("div", j, [
+                t(e(n), {
+                  icon: "Add",
+                  size: "sm"
+                })
+              ]),
+              a[2] || (a[2] = o("span", null, "New Workspace", -1))
+            ]),
+            _: 1
+          })
+        ]),
+        default: l(() => [
+          t(e(b), {
+            class: "hover:bg-b-2 text-c-3 line-clamp-1 h-full w-fit justify-start px-1.5 py-1 font-normal",
+            variant: "ghost"
+          }, {
+            default: l(() => [
+              o("div", W, [
+                o("h2", z, m(r.activeWorkspace?.label), 1),
+                t(e(n), {
+                  icon: "ChevronDown",
+                  size: "md"
+                })
+              ])
+            ]),
+            _: 1
+          })
+        ]),
+        _: 1
+      }),
+      t(e(y), {
+        state: e(d),
+        "onCreate:workspace": a[1] || (a[1] = (s) => c("create:workspace", s))
+      }, null, 8, ["state"])
+    ]));
+  }
+});
+export {
+  V as default
+};

package/dist/v2/features/import-listener/components/WorkspaceSelector.vue2.js

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

package/dist/v2/features/import-listener/helpers/generate-unique-slug.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generates a unique slug for an imported document based on its title.
+ *
+ * This ensures the imported document does not conflict with existing documents
+ * by appending a number suffix if necessary (e.g., "my-api", "my-api-1", "my-api-2").
+ *
+ * The function will retry up to 100 times to find a unique slug. If all attempts fail,
+ * it returns null, which should be handled as an import error.
+ *
+ * @param defaultValue - The original document title to base the slug on
+ * @param currentDocuments - Set of existing document slugs to check against
+ *
+ * @returns Promise resolving to a unique slug, or null if unable to generate one
+ */
+export declare const generateUniqueSlug: (defaultValue: string | undefined, currentDocuments: Set<string>) => Promise<string | undefined>;
+//# sourceMappingURL=generate-unique-slug.d.ts.map

package/dist/v2/features/import-listener/helpers/generate-unique-slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-unique-slug.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/import-listener/helpers/generate-unique-slug.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,GAAU,cAAc,MAAM,GAAG,SAAS,EAAE,kBAAkB,GAAG,CAAC,MAAM,CAAC,gCAOvG,CAAA"}

package/dist/v2/features/import-listener/helpers/generate-unique-slug.js

@@ -0,0 +1,11 @@
+import { generateUniqueValue as r } from "@scalar/workspace-store/helpers/generate-unique-value";
+import { slugify as i } from "../../../helpers/slugify.js";
+const u = async (e, a) => await r({
+  defaultValue: e,
+  validation: (t) => !a.has(t),
+  maxRetries: 100,
+  transformation: i
+});
+export {
+  u as generateUniqueSlug
+};

package/dist/v2/features/import-listener/helpers/get-url-query-parameter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Gets the value of a specific query parameter from the current URL.
+ *
+ * @param parameterName - The name of the query parameter to retrieve
+ * @returns The value of the query parameter, or null if it does not exist
+ */
+export declare const getUrlQueryParameter: (parameterName: string) => string | null;
+//# sourceMappingURL=get-url-query-parameter.d.ts.map

package/dist/v2/features/import-listener/helpers/get-url-query-parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-url-query-parameter.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/import-listener/helpers/get-url-query-parameter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,eAAe,MAAM,KAAG,MAAM,GAAG,IAGrE,CAAA"}

package/dist/v2/features/import-listener/helpers/get-url-query-parameter.js

@@ -0,0 +1,4 @@
+const a = (e) => new URLSearchParams(window.location.search).get(e);
+export {
+  a as getUrlQueryParameter
+};

package/dist/v2/features/import-listener/helpers/import-document-to-workspace.d.ts

@@ -0,0 +1,30 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { InMemoryWorkspace } from '@scalar/workspace-store/schemas/inmemory-workspace';
+/**
+ * Imports a single document from a workspace state into the current workspace.
+ *
+ * This function handles the complete import process including slug generation,
+ * document loading, and sidebar updates. It ensures the imported document does not
+ * conflict with existing documents by generating a unique slug.
+ *
+ * The meta from the importing workspace is intentionally excluded to preserve
+ * the current workspace settings and avoid unintended configuration changes.
+ *
+ * @param workspaceStore - The active workspace store where the document will be imported
+ * @param workspaceState - The in-memory workspace containing the document to import
+ * @param name - The original slug/name of the document in the source workspace state
+ *
+ * @returns Promise that resolves to the slug of the imported document
+ */
+export declare const importDocumentToWorkspace: ({ workspaceStore, workspaceState, name, }: {
+    workspaceStore: WorkspaceStore | null;
+    workspaceState: InMemoryWorkspace;
+    name: string;
+}) => Promise<{
+    ok: true;
+    slug: string;
+} | {
+    ok: false;
+    error: string;
+}>;
+//# sourceMappingURL=import-document-to-workspace.d.ts.map

package/dist/v2/features/import-listener/helpers/import-document-to-workspace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-document-to-workspace.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/import-listener/helpers/import-document-to-workspace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AAI3F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,yBAAyB,GAAU,2CAI7C;IACD,cAAc,EAAE,cAAc,GAAG,IAAI,CAAA;IACrC,cAAc,EAAE,iBAAiB,CAAA;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,KAAG,OAAO,CAAC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAsDpE,CAAA"}

package/dist/v2/features/import-listener/helpers/import-document-to-workspace.js

@@ -0,0 +1,31 @@
+import { generateUniqueSlug as u } from "./generate-unique-slug.js";
+const m = async ({
+  workspaceStore: t,
+  workspaceState: o,
+  name: n
+}) => {
+  if (!t)
+    return { ok: !1, error: "Workspace store is not available" };
+  const r = o.documents[n];
+  if (!r)
+    return { ok: !1, error: "Importing document not found in workspace state" };
+  const i = new Set(Object.keys(t.workspace.documents)), e = await u(r.info.title || "default", i);
+  return e ? (t.loadWorkspace({
+    meta: {},
+    documents: {
+      [e]: r
+    },
+    intermediateDocuments: {
+      [e]: o.intermediateDocuments[n] ?? {}
+    },
+    originalDocuments: {
+      [e]: o.originalDocuments[n] ?? {}
+    },
+    overrides: {
+      [e]: o.overrides[n] ?? {}
+    }
+  }), t.buildSidebar(e), await t.saveDocument(e), { ok: !0, slug: e }) : { ok: !1, error: "Failed to generate a unique slug for the importing document" };
+};
+export {
+  m as importDocumentToWorkspace
+};

package/dist/v2/features/import-listener/helpers/load-document-from-source.d.ts

@@ -0,0 +1,15 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+/**
+ * Loads a document from a given source (URL or raw content) and adds it to the workspace.
+ *
+ * - If the source is a URL, adds the document from the URL and enables/disables watch mode as requested.
+ * - If the source is raw content (like pasted JSON/YAML), normalizes and adds it as a document.
+ *
+ * @param workspaceStore The workspace store to add the document to
+ * @param source The source to load the document from (URL or raw content)
+ * @param name The name of the document
+ * @param watchMode Whether to enable watch mode for URL sources
+ * @returns Promise resolving to true if the document is added successfully, false otherwise
+ */
+export declare const loadDocumentFromSource: (workspaceStore: WorkspaceStore, source: string | null, name: string, watchMode: boolean) => Promise<boolean>;
+//# sourceMappingURL=load-document-from-source.d.ts.map

package/dist/v2/features/import-listener/helpers/load-document-from-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-document-from-source.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/import-listener/helpers/load-document-from-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAIpE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,GACjC,gBAAgB,cAAc,EAC9B,QAAQ,MAAM,GAAG,IAAI,EACrB,MAAM,MAAM,EACZ,WAAW,OAAO,KACjB,OAAO,CAAC,OAAO,CAqCjB,CAAA"}

package/dist/v2/features/import-listener/helpers/load-document-from-source.js

@@ -0,0 +1,28 @@
+import { normalize as m } from "@scalar/openapi-parser";
+import { isUrl as i } from "../../../helpers/is-url.js";
+const f = async (r, t, n, o) => {
+  if (!t)
+    return !1;
+  if (i(t))
+    return await r.addDocument({
+      name: n,
+      url: t,
+      meta: {
+        "x-scalar-watch-mode": o
+      }
+    });
+  const e = ((a) => {
+    try {
+      return m(a);
+    } catch (l) {
+      return console.error(l), null;
+    }
+  })(t);
+  return e === null ? !1 : await r.addDocument({
+    name: n,
+    document: e
+  });
+};
+export {
+  f as loadDocumentFromSource
+};

package/dist/v2/features/import-listener/helpers/wait-for-condition.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Waits for a condition to be true with a timeout.
+ * Checks the condition at a specified interval up to a maximum wait time.
+ *
+ * @param checkCondition - Function that returns true when the condition is met
+ * @param options - Configuration options
+ * @param options.checkInterval - Time in milliseconds between checks (default: 100)
+ * @param options.maxWaitTime - Maximum time in milliseconds to wait (default: 3000)
+ * @returns Promise that resolves to true if the condition is met, false if it timed out
+ */
+export declare const waitForCondition: (checkCondition: () => boolean, options?: {
+    checkInterval?: number;
+    maxWaitTime?: number;
+}) => Promise<boolean>;
+//# sourceMappingURL=wait-for-condition.d.ts.map

package/dist/v2/features/import-listener/helpers/wait-for-condition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-condition.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/import-listener/helpers/wait-for-condition.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,GAC3B,gBAAgB,MAAM,OAAO,EAC7B,UAAS;IACP,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CAChB,KACL,OAAO,CAAC,OAAO,CAuBjB,CAAA"}

package/dist/v2/features/import-listener/helpers/wait-for-condition.js

@@ -0,0 +1,16 @@
+const s = (t, l = {}) => {
+  const { checkInterval: r = 100, maxWaitTime: i = 3e3 } = l;
+  return new Promise((e) => {
+    if (t()) {
+      e(!0);
+      return;
+    }
+    let a = 0;
+    const n = setInterval(() => {
+      a += r, t() ? (clearInterval(n), e(!0)) : a >= i && (clearInterval(n), e(!1));
+    }, r);
+  });
+};
+export {
+  s as waitForCondition
+};

package/dist/v2/features/import-listener/index.d.ts

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

package/dist/v2/features/import-listener/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/import-listener/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/v2/features/import-listener/index.js

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

package/dist/v2/features/operation/Operation.vue.js

@@ -69,7 +69,7 @@ const b = {
       type: "document"
     }), h = n(
       () => C(o(e.options)?.hiddenClients)
-    ), f = "2.22.2";
+    ), f = "2.23.0";
     return (t, a) => e.path && e.method && e.exampleName && l.value ? (c(), x(i(p), {
       key: 0,
       appVersion: i(f),

package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js

@@ -33,7 +33,7 @@ const W = { class: "flex-center relative flex flex-1 flex-col gap-6 p-2 capitali
       }));
     }, f = (u) => {
       u?.createNew && g.name === "request" && p();
-    }, v = "2.22.2";
+    }, v = "2.23.0";
     return q(() => a.hotKeys.on(f)), R(() => a.hotKeys.off(f)), (u, e) => (l(), n("div", W, [
       s("div", {
         class: y(["flex h-[calc(100%_-_50px)] flex-col items-center justify-center", {

package/package.json

@@ -18,7 +18,7 @@
     "rest",
     "testing"
   ],
-  "version": "2.22.2",
+  "version": "2.23.0",
   "engines": {
     "node": ">=20"
   },
@@ -231,6 +231,11 @@
       "types": "./dist/v2/features/global-cookies/index.d.ts",
       "default": "./dist/v2/features/global-cookies/index.js"
     },
+    "./v2/features/import-listener": {
+      "import": "./dist/v2/features/import-listener/index.js",
+      "types": "./dist/v2/features/import-listener/index.d.ts",
+      "default": "./dist/v2/features/import-listener/index.js"
+    },
     "./v2/features/modal": {
       "import": "./dist/v2/features/modal/index.js",
       "types": "./dist/v2/features/modal/index.d.ts",
@@ -322,25 +327,25 @@
     "yaml": "^2.8.0",
     "zod": "^4.3.5",
     "@scalar/analytics-client": "1.0.1",
-    "@scalar/components": "0.17.1",
-    "@scalar/helpers": "0.2.10",
     "@scalar/draggable": "0.3.0",
+    "@scalar/components": "0.17.2",
+    "@scalar/helpers": "0.2.10",
     "@scalar/icons": "0.5.2",
-    "@scalar/import": "0.4.47",
-    "@scalar/object-utils": "1.2.24",
     "@scalar/json-magic": "0.9.5",
-    "@scalar/oas-utils": "0.6.31",
+    "@scalar/oas-utils": "0.6.32",
+    "@scalar/object-utils": "1.2.24",
+    "@scalar/import": "0.4.47",
     "@scalar/openapi-parser": "0.24.6",
     "@scalar/openapi-types": "0.5.3",
-    "@scalar/postman-to-openapi": "0.4.2",
-    "@scalar/sidebar": "0.7.24",
+    "@scalar/sidebar": "0.7.25",
     "@scalar/snippetz": "0.6.10",
     "@scalar/themes": "0.14.0",
     "@scalar/types": "0.6.1",
-    "@scalar/use-codemirror": "0.13.28",
-    "@scalar/use-toasts": "0.9.1",
+    "@scalar/postman-to-openapi": "0.4.2",
+    "@scalar/use-codemirror": "0.13.29",
     "@scalar/use-hooks": "0.3.7",
-    "@scalar/workspace-store": "0.28.0"
+    "@scalar/use-toasts": "0.9.1",
+    "@scalar/workspace-store": "0.28.1"
   },
   "devDependencies": {
     "@tailwindcss/vite": "^4.1.18",