@scalar/api-client 2.1.45 → 2.1.47

package/dist/libs/create-client.js

@@ -1,24 +1,25 @@
 import { loadAllResources as j } from "./local-storage.js";
-import { workspaceSchema as q } from "@scalar/oas-utils/entities/workspace";
-import { LS_KEYS as P, objectMerge as L } from "@scalar/oas-utils/helpers";
-import { DATA_VERSION_LS_LEY as E, DATA_VERSION as K } from "@scalar/oas-utils/migrations";
-import { createApp as R, watch as T } from "vue";
-import { createWorkspaceStore as W } from "../store/store.js";
-const V = ({
-  el: k,
+import { workspaceSchema as P } from "@scalar/oas-utils/entities/workspace";
+import { LS_KEYS as L, objectMerge as E } from "@scalar/oas-utils/helpers";
+import { DATA_VERSION_LS_LEY as K, DATA_VERSION as R } from "@scalar/oas-utils/migrations";
+import { createApp as T, watch as W } from "vue";
+import { createWorkspaceStore as F } from "../store/store.js";
+const $ = ({
+  el: x,
   appComponent: A,
   configuration: t = {},
   isReadOnly: c = !1,
   store: M,
   persistData: b = !0,
   mountOnInitialize: I = !0,
-  router: d
+  layout: O = "desktop",
+  router: u
 }) => {
-  const a = M || W(d, {
+  const a = M || F(u, {
     useLocalStorage: b,
     defaultProxyUrl: t.proxyUrl
   });
-  if (localStorage.getItem(P.WORKSPACE) && !c) {
+  if (localStorage.getItem(L.WORKSPACE) && !c) {
     const e = {};
     let r = 0, l = 0, s = "";
     for (s in localStorage)
@@ -30,9 +31,9 @@ const V = ({
       name: "Workspace",
       isReadOnly: c,
       proxyUrl: t.proxyUrl
-    }), localStorage.setItem(E, K);
+    }), localStorage.setItem(K, R);
   else {
-    const e = q.parse({
+    const e = P.parse({
       uid: "default",
       name: "Workspace",
       isReadOnly: !0,
@@ -40,20 +41,20 @@ const V = ({
     });
     a.workspaceMutators.rawAdd(e);
   }
-  const u = R(A);
-  u.use(d), u.provide("workspace", a);
+  const p = T(A);
+  p.use(u), p.provide("workspace", a), p.provide("layout", O);
   const {
-    activeCollection: p,
+    activeCollection: d,
     activeWorkspace: o,
     collectionMutators: v,
-    importSpecFile: O,
-    importSpecFromUrl: w,
+    importSpecFile: w,
+    importSpecFromUrl: q,
     modalState: h,
-    requests: S,
+    requests: i,
     securitySchemes: C,
-    servers: i,
+    servers: S,
     workspaceMutators: m
-  } = a, U = (e = k) => {
+  } = a, U = (e = x) => {
     if (!e) {
       console.error(
         "[@scalar/api-client-modal] Could not create the API client.",
@@ -62,7 +63,7 @@ const V = ({
       );
       return;
     }
-    u.mount(e);
+    p.mount(e);
   };
   o.value && (I && U(), t != null && t.proxyUrl && m.edit(
     o.value.uid,
@@ -73,12 +74,12 @@ const V = ({
     "themeId",
     t == null ? void 0 : t.themeId
   ));
-  const x = async (e) => {
-    e != null && e.url ? await w(e.url, o.value.uid, {
+  const y = async (e) => {
+    e != null && e.url ? await q(e.url, o.value.uid, {
       proxy: t == null ? void 0 : t.proxyUrl,
       setCollectionSecurity: !0,
       ...t
-    }) : e != null && e.content ? await O(e == null ? void 0 : e.content, o.value.uid, {
+    }) : e != null && e.content ? await w(e == null ? void 0 : e.content, o.value.uid, {
       setCollectionSecurity: !0,
       ...t
     }) : console.error(
@@ -89,35 +90,35 @@ const V = ({
   };
   return {
     /** The vue app instance for the modal, be careful with this */
-    app: u,
-    updateSpec: x,
+    app: p,
+    updateSpec: y,
     /**
      * Update the API client config
      *
      * Deletes the current store before importing again for now, in the future will Diff
      */
     updateConfig(e, r = !0) {
-      r ? Object.assign(t ?? {}, e) : L(t ?? {}, e), e.spec && (a.collectionMutators.reset(), a.requestMutators.reset(), a.requestExampleMutators.reset(), a.securitySchemeMutators.reset(), a.serverMutators.reset(), a.tagMutators.reset(), m.edit(o.value.uid, "collections", []), x(e.spec));
+      r ? Object.assign(t ?? {}, e) : E(t ?? {}, e), e.spec && (a.collectionMutators.reset(), a.requestMutators.reset(), a.requestExampleMutators.reset(), a.securitySchemeMutators.reset(), a.serverMutators.reset(), a.tagMutators.reset(), m.edit(o.value.uid, "collections", []), y(e.spec));
     },
     /** Update the currently selected server via URL */
     updateServer: (e) => {
       var l;
-      const r = Object.values(i).find((s) => s.url === e);
-      r && p.value && v.edit(
-        (l = p.value) == null ? void 0 : l.uid,
+      const r = Object.values(S).find((s) => s.url === e);
+      r && d.value && v.edit(
+        (l = d.value) == null ? void 0 : l.uid,
         "selectedServerUid",
         r.uid
       );
     },
     /** Update the currently selected server via URL */
     onUpdateServer: (e) => {
-      T(
+      W(
         () => {
           var r;
-          return (r = p.value) == null ? void 0 : r.selectedServerUid;
+          return (r = d.value) == null ? void 0 : r.selectedServerUid;
         },
         (r) => {
-          const l = Object.values(i).find((s) => s.uid === r);
+          const l = Object.values(S).find((s) => s.uid === r);
           l != null && l.url && e(l.url);
         }
       );
@@ -130,25 +131,31 @@ const V = ({
       propertyKey: r,
       value: l
     }) => {
-      const y = Object.values(C).find((_) => _.nameKey === e);
-      y && p.value && v.edit(
-        p.value.uid,
-        `auth.${y.uid}.${r}`,
+      const k = Object.values(C).find((_) => _.nameKey === e);
+      k && d.value && v.edit(
+        d.value.uid,
+        `auth.${k.uid}.${r}`,
         // @ts-expect-error why typescript why
         l
       );
     },
     /** Route to a method + path */
     route: (e) => {
-      const r = Object.values(S).find(
+      const r = Object.values(i).find(
         ({ path: l, method: s }) => l === e.path && s.toUpperCase() === e.method.toUpperCase()
       );
-      r && d.push(`/workspace/default/request/${r.uid}`);
+      r && u.push({
+        name: "request",
+        params: {
+          workspace: "default",
+          request: r.uid
+        }
+      });
     },
     /** Open the API client modal and optionally route to a request */
     open: (e) => {
       if (e) {
-        const r = Object.values(S).find(
+        const r = Object.values(i).find(
           ({ path: l, method: s }) => e ? (
             // The given operation
             l === e.path && s.toUpperCase() === e.method.toUpperCase()
@@ -157,7 +164,13 @@ const V = ({
             !0
           )
         );
-        r && d.push(`/workspace/default/request/${r.uid}`);
+        r && u.push({
+          name: "request",
+          params: {
+            workspace: "default",
+            request: r.uid
+          }
+        });
       }
       h.open = !0;
     },
@@ -170,5 +183,5 @@ const V = ({
   };
 };
 export {
-  V as createApiClient
+  $ as createApiClient
 };

package/dist/libs/hot-keys.d.ts

@@ -24,7 +24,7 @@ export declare const getModifiers: (modifiers: HotKeyModifiers) => ("metaKey" |
  * This is the brain of the operation, we turn keybindings -> events
  */
 export declare const handleHotKeyDown: (ev: KeyboardEvent, eventBus: EventBus<HotKeyEvent>, { hotKeys, modifiers, }?: {
-    hotKeys?: Partial<Record<"" | "." | "a" | "b" | "i" | "p" | "q" | "s" | "u" | "g" | ";" | "/" | "=" | "0" | "-" | "k" | "v" | "1" | "2" | "ArrowLeft" | "ArrowRight" | "Delete" | "Backspace" | "n" | "3" | "4" | "5" | "6" | "Space" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "7" | "8" | "9" | "c" | "d" | "e" | "f" | "h" | "j" | "l" | "m" | "o" | "r" | "t" | "w" | "x" | "y" | "z" | "*" | "+" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "," | "`" | "[" | "\\" | "]", {
+    hotKeys?: Partial<Record<"" | "0" | "1" | "n" | "a" | "b" | "i" | "p" | "q" | "s" | "u" | "." | "g" | ";" | "/" | "=" | "-" | "k" | "v" | "2" | "ArrowLeft" | "ArrowRight" | "Delete" | "Backspace" | "3" | "4" | "5" | "6" | "Space" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "7" | "8" | "9" | "c" | "d" | "e" | "f" | "h" | "j" | "l" | "m" | "o" | "r" | "t" | "w" | "x" | "y" | "z" | "*" | "+" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "," | "`" | "[" | "\\" | "]", {
         event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
         modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
     }>> | undefined;

package/dist/router.d.ts

@@ -1,45 +1,8 @@
-import { type RouteLocationNormalized, type Router } from 'vue-router';
-export declare enum PathId {
-    Request = "request",
-    Examples = "examples",
-    Cookies = "cookies",
-    Collection = "collection",
-    Schema = "schema",
-    Environment = "environment",
-    Servers = "servers",
-    Workspace = "workspace",
-    Settings = "settings"
-}
-/** Routes required by the API client modal */
-export declare const modalRoutes: ({
-    path: string;
-    redirect: string;
-    children?: undefined;
-} | {
-    path: string;
-    children: ({
-        path: string;
-        redirect: (to: import("vue-router").RouteLocation) => string;
-        name?: undefined;
-        component?: undefined;
-    } | {
-        name: PathId;
-        path: string;
-        component: () => Promise<typeof import("./views/Request/Request.vue.js")>;
-        redirect?: undefined;
-    })[];
-    redirect?: undefined;
-})[];
+export { PathId, saveActiveWorkspace } from './routes.js';
 /** Router for the API client app */
-export declare const createWebHistoryRouter: () => Router;
+export declare const createWebHistoryRouter: () => import("vue-router").Router;
 /** Router factory for the API client app (but using hash history) */
-export declare const createWebHashRouter: () => Router;
+export declare const createWebHashRouter: () => import("vue-router").Router;
 /** Router factory for the API Client modal */
-export declare const createModalRouter: () => Router;
-/** Save the active workspace in localstorage for when the client reloads */
-export declare function saveWorkspace(to: RouteLocationNormalized): void;
-/** Redirect to the saved workspace or the default workspace */
-export declare function redirectToDefaultWorkspace(): string;
-/** If we try to navigate to a entity UID that does not exist then we fallback to the default */
-export declare function fallbackMissingParams(router: Router, key: PathId, item: Record<string, any> | undefined): void;
+export declare const createModalRouter: () => import("vue-router").Router;
 //# sourceMappingURL=router.d.ts.map

package/dist/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,EAE5B,KAAK,MAAM,EAKZ,MAAM,YAAY,CAAA;AAEnB,oBAAY,MAAM;IAChB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAwBD,8CAA8C;AAC9C,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;IAaI,CAAA;AAoF5B,oCAAoC;AACpC,eAAO,MAAM,sBAAsB,cAI/B,CAAA;AAEJ,qEAAqE;AACrE,eAAO,MAAM,mBAAmB,cAI5B,CAAA;AAEJ,8CAA8C;AAC9C,eAAO,MAAM,iBAAiB,cAI1B,CAAA;AAKJ,4EAA4E;AAC5E,wBAAgB,aAAa,CAAC,EAAE,EAAE,uBAAuB,QAGxD;AAED,+DAA+D;AAC/D,wBAAgB,0BAA0B,WAGzC;AAED,gGAAgG;AAChG,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,QAmBtC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEtD,oCAAoC;AACpC,eAAO,MAAM,sBAAsB,mCAI/B,CAAA;AAEJ,qEAAqE;AACrE,eAAO,MAAM,mBAAmB,mCAI5B,CAAA;AAEJ,8CAA8C;AAC9C,eAAO,MAAM,iBAAiB,mCAI1B,CAAA"}

package/dist/router.js

@@ -1,151 +1,20 @@
-import { createRouter as r, createWebHistory as u, createWebHashHistory as i, createMemoryHistory as m } from "vue-router";
-var f = /* @__PURE__ */ ((e) => (e.Request = "request", e.Examples = "examples", e.Cookies = "cookies", e.Collection = "collection", e.Schema = "schema", e.Environment = "environment", e.Servers = "servers", e.Workspace = "workspace", e.Settings = "settings", e))(f || {});
-const c = [
-  {
-    path: "",
-    redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/request/default`
-  },
-  {
-    path: "request",
-    redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/default`
-  },
-  {
-    name: "request",
-    path: "request/:request",
-    component: () => import("./views/Request/Request.vue.js")
-  },
-  {
-    name: "examples",
-    path: "request/:request/examples/:examples",
-    component: () => import("./views/Request/Request.vue.js")
-  }
-], h = [
-  {
-    path: "/",
-    redirect: "/workspace/default/request/default"
-  },
-  {
-    path: "/workspace",
-    redirect: "/workspace/default/request/default"
-  },
-  {
-    path: "/workspace/:workspace",
-    children: c
-  }
-], n = [
-  {
-    path: "/",
-    redirect: o
-  },
-  {
-    path: "/workspace",
-    redirect: o
-  },
-  {
-    path: "/workspace/:workspace",
-    children: [
-      ...c,
-      // {
-      //   path: 'collection',
-      //   redirect: (to) =>
-      //     `${to.fullPath.replace(/\/$/, '')}/default`,
-      // },
-      // {
-      //   name: PathId.Collection,
-      //   path: `collection/:${PathId.Collection}`,
-      //   component: () => import('./views/Collection/Collection.vue'),
-      //   children: [
-      //     // Nested collection request
-      //     {
-      //       path: `request/${PathId.Request}`,
-      //       component: () => import('./views/Request/Request.vue.js'),
-      //     },
-      //   ],
-      // },
-      /** Components will map to each section of the spec components object */
-      // {
-      //   path: 'components',
-      //   redirect: '/components/schemas/default',
-      //   children: [
-      //     {
-      //       path: `schemas/:${PathId.Schema}`,
-      //       component: () => import('@/views/Components/Schemas/Schemas.vue'),
-      //     },
-      //   ],
-      // },
-      {
-        path: "environment",
-        redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/default`
-      },
-      {
-        name: "environment",
-        path: "environment/:environment",
-        component: () => import("./views/Environment/Environment.vue.js")
-      },
-      {
-        path: "cookies",
-        redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/default`
-      },
-      {
-        name: "cookies",
-        path: "cookies/:cookies",
-        component: () => import("./views/Cookies/Cookies.vue.js")
-      },
-      {
-        path: "servers",
-        redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/default`
-      },
-      {
-        name: "servers",
-        path: "servers/:servers",
-        component: () => import("./views/Servers/Servers.vue.js")
-      },
-      {
-        path: "settings",
-        redirect: (e) => `${e.fullPath.replace(/\/$/, "")}/general`
-      },
-      {
-        name: "settings",
-        path: "settings/:settings",
-        component: () => import("./views/Settings/Settings.vue.js")
-      }
-    ]
-  }
-], k = () => r({
-  history: u(),
-  routes: n
-}), d = () => r({
-  history: i(),
-  routes: n
-}), v = () => r({
-  history: m(),
-  routes: h
-}), p = "activeWorkspace";
-function w(e) {
-  const t = e.params.workspace;
-  t && localStorage.setItem(p, `${t}`);
-}
-function o() {
-  return `/workspace/${localStorage.getItem(p) ?? "default"}/request/default`;
-}
-function q(e, t, l) {
-  var a, s;
-  e.currentRoute.value && // If the item is missing then we know the UID is no longer in use and redirect to the default
-  !l && ((a = e.currentRoute.value) != null && a.params[t]) && ((s = e.currentRoute.value) == null ? void 0 : s.params[t]) !== "default" && // We only redirect if the key is missing for the matching route
-  e.currentRoute.value.path.includes(t) && e.push({
-    params: {
-      ...e.currentRoute.value.params,
-      [t]: "default"
-    }
-  });
-}
+import { routes as t, modalRoutes as r } from "./routes.js";
+import { PathId as p, saveActiveWorkspace as R } from "./routes.js";
+import { createRouter as e, createWebHistory as o, createWebHashHistory as s, createMemoryHistory as a } from "vue-router";
+const y = () => e({
+  history: o(),
+  routes: t
+}), m = () => e({
+  history: s(),
+  routes: t
+}), u = () => e({
+  history: a(),
+  routes: r
+});
 export {
-  f as PathId,
-  v as createModalRouter,
-  d as createWebHashRouter,
-  k as createWebHistoryRouter,
-  q as fallbackMissingParams,
-  h as modalRoutes,
-  o as redirectToDefaultWorkspace,
-  w as saveWorkspace
+  p as PathId,
+  u as createModalRouter,
+  m as createWebHashRouter,
+  y as createWebHistoryRouter,
+  R as saveActiveWorkspace
 };

package/dist/routes.d.ts

@@ -0,0 +1,150 @@
+import type { RouteLocationNormalized } from 'vue-router';
+export declare enum PathId {
+    Request = "request",
+    Examples = "examples",
+    Cookies = "cookies",
+    Collection = "collection",
+    Schema = "schema",
+    Environment = "environment",
+    Servers = "servers",
+    Workspace = "workspace",
+    Settings = "settings"
+}
+/** Save the active workspace in localStorage for when the client reloads */
+export declare function saveActiveWorkspace(to: RouteLocationNormalized): void;
+/** Redirect to the saved workspace or the default workspace */
+export declare function redirectToActiveWorkspace(): {
+    name: string;
+    params?: undefined;
+} | {
+    name: string;
+    params: {
+        workspace: string;
+    };
+};
+/** Routes required by the API client modal */
+export declare const modalRoutes: ({
+    name: string;
+    path: string;
+    redirect: typeof redirectToActiveWorkspace;
+    children?: undefined;
+} | {
+    name: string;
+    path: string;
+    redirect: {
+        name: string;
+        params: {
+            workspace: string;
+        };
+    };
+    children?: undefined;
+} | {
+    name: string;
+    path: string;
+    redirect: {
+        name: string;
+        params?: undefined;
+    };
+    children: ({
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                request: string;
+            };
+        };
+        component?: undefined;
+    } | {
+        name: string;
+        path: string;
+        component: () => Promise<typeof import("./views/Request/Request.vue.js")>;
+        redirect?: undefined;
+    })[];
+})[];
+/** Routes for the API client app */
+export declare const routes: ({
+    name: string;
+    path: string;
+    redirect: typeof redirectToActiveWorkspace;
+    children?: undefined;
+} | {
+    name: string;
+    path: string;
+    redirect: {
+        name: string;
+        params: {
+            workspace: string;
+        };
+    };
+    children?: undefined;
+} | {
+    name: string;
+    path: string;
+    redirect: {
+        name: string;
+        params?: undefined;
+    };
+    children: ({
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                request: string;
+            };
+        };
+        component?: undefined;
+    } | {
+        name: string;
+        path: string;
+        component: () => Promise<typeof import("./views/Request/Request.vue.js")>;
+        redirect?: undefined;
+    } | {
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                environment: string;
+            };
+        };
+        component?: undefined;
+    } | {
+        name: string;
+        path: string;
+        component: () => Promise<typeof import("./views/Environment/Environment.vue.js")>;
+        redirect?: undefined;
+    } | {
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                cookies: string;
+            };
+        };
+        component?: undefined;
+    } | {
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                servers: string;
+            };
+        };
+        component?: undefined;
+    } | {
+        name: string;
+        path: string;
+        redirect: (to: import("vue-router").RouteLocation) => {
+            name: string;
+            params: {
+                settings: string;
+            };
+        };
+        component?: undefined;
+    })[];
+})[];
+//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAkB,MAAM,YAAY,CAAA;AAEzE,oBAAY,MAAM;IAChB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACtB;AAKD,4EAA4E;AAC5E,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,uBAAuB,QAM9D;AAED,+DAA+D;AAC/D,wBAAgB,yBAAyB;;;;;;;;EAkBxC;AAgCD,8CAA8C;AAC9C,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwBI,CAAA;AAE5B,oCAAoC;AACpC,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0GS,CAAA"}