@scalar/api-client 2.24.0 → 2.26.0

package/dist/v2/features/app/app-state.d.ts

@@ -1,5 +1,7 @@
-import type { ScalarListboxOption } from '@scalar/components';
+import type { ScalarListboxOption, WorkspaceGroup } from '@scalar/components';
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { LoaderPlugin } from '@scalar/json-magic/bundle';
+import { createSidebarState } from '@scalar/sidebar';
 import { type WorkspaceStore } from '@scalar/workspace-store/client';
 import { type WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { WorkspaceDocument } from '@scalar/workspace-store/schemas';
@@ -8,75 +10,6 @@ import type { Tab } from '@scalar/workspace-store/schemas/extensions/workspace/x
 import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
 import { type ComputedRef, type Ref, type ShallowRef } from 'vue';
 import type { RouteLocationNormalizedGeneric, Router } from 'vue-router';
-type WorkspaceOption = ScalarListboxOption & {
-    teamUid: string;
-    namespace: string;
-    slug: string;
-};
-/**
- * Navigates to the overview page of the specified workspace.
- * Updates the route based on the given namespace and slug.
- *
- * @param namespace - The workspace namespace.
- * @param slug - The unique workspace slug (identifier).
- */
-declare const navigateToWorkspace: (namespace?: string, slug?: string) => Promise<void>;
-/**
- * Creates a new workspace with the provided name.
- * - Generates a unique slug for the workspace (uses the provided slug if it is unique, otherwise generates a unique slug).
- * - Adds a default blank document ("drafts") to the workspace.
- * - Persists the workspace and navigates to it.
- *
- * Example usage:
- *   await createWorkspace({ name: 'My Awesome API' })
- *   // -> Navigates to /workspace/my-awesome-api (if available)
- */
-declare const createWorkspace: ({ teamUid, namespace, slug, name, }: {
-    teamUid?: string;
-    namespace?: string;
-    slug?: string;
-    name: string;
-}) => Promise<{
-    name: string;
-    namespace: string;
-    slug: string;
-    teamUid: string;
-} | undefined>;
-declare const sidebarState: {
-    items: ComputedRef<TraversedEntry[]>;
-    index: ComputedRef<Map<string, TraversedEntry & {
-        parent?: TraversedEntry | undefined;
-    }>>;
-    selectedItems: import("vue").Ref<Record<string, boolean>, Record<string, boolean>>;
-    expandedItems: import("vue").Ref<Record<string, boolean>, Record<string, boolean>>;
-    selectedItem: import("vue").Ref<string | null, string | null>;
-    setSelected: (id: string | null) => void;
-    setExpanded: (id: string, value: boolean) => void;
-    isExpanded: (id: string) => boolean;
-    isSelected: (id: string) => boolean;
-    getEntryById: (id: string) => (TraversedEntry & {
-        parent?: TraversedEntry | undefined;
-    }) | undefined;
-    reset: () => void;
-};
-/**
- * Looks up a sidebar entry by its unique API location.
- * - First tries to find an entry matching all provided properties (including example).
- * - If not found, falls back to matching only the operation (ignores example field).
- * This allows resolving either examples, operations, or documents as appropriate.
- *
- * @param location - Object specifying the document name, path, method, and optional example name.
- * @returns The matching sidebar entry, or undefined if none found.
- *
- * Example:
- *   const entry = getEntryByLocation({
- *     document: 'pets',
- *     path: '/pets',
- *     method: 'get',
- *     example: 'default',
- *   })
- */
-declare const getEntryByLocation: GetEntryByLocation;
 export type GetEntryByLocation = (location: {
     document: string;
     path?: string;
@@ -85,59 +18,107 @@ export type GetEntryByLocation = (location: {
 }) => (TraversedEntry & {
     parent?: TraversedEntry | undefined;
 }) | undefined;
-/**
- * Handles item selection from the sidebar and routes navigation accordingly.
- *
- * Example:
- *   handleSelectItem('id-of-entry')
- */
-declare const handleSelectItem: (id: string) => Promise<void | import("vue-router").NavigationFailure | undefined> | undefined;
-/** Handler for sidebar width changes. */
-declare const handleSidebarWidthUpdate: (width: number) => void | undefined;
-/**
- * Copies the URL of the tab at the given index to the clipboard.
- * Constructs the full URL using the current origin and the tab path.
- *
- * @throws Will silently fail if clipboard API is unavailable or the tab does not exist.
- */
-declare const copyTabUrl: (index: number) => Promise<void>;
+type WorkspaceOption = ScalarListboxOption & {
+    teamUid: string;
+    namespace: string;
+    slug: string;
+};
+/** Defines the overall application state structure and its main feature modules */
 export type AppState = {
+    /** The workspace store */
     store: ShallowRef<WorkspaceStore | null>;
+    /** The sidebar management */
     sidebar: {
-        state: typeof sidebarState;
+        /** The sidebar state */
+        state: ReturnType<typeof createSidebarState<TraversedEntry>>;
+        /** The width of the sidebar */
         width: ComputedRef<number>;
+        /** Whether the sidebar is open */
         isOpen: Ref<boolean>;
-        handleSelectItem: typeof handleSelectItem;
-        handleSidebarWidthUpdate: typeof handleSidebarWidthUpdate;
-        getEntryByLocation: typeof getEntryByLocation;
+        /** Handles the selection of an item in the sidebar */
+        handleSelectItem: (id: string) => void;
+        /** Handles the width update of the sidebar */
+        handleSidebarWidthUpdate: (width: number) => void;
+        /** Gets the entry by location */
+        getEntryByLocation: GetEntryByLocation;
     };
+    /** The tabs management */
     tabs: {
+        /** The tabs state */
         state: Ref<Tab[]>;
+        /** The active tab index */
         activeTabIndex: Ref<number>;
-        copyTabUrl: typeof copyTabUrl;
+        /** Copies the URL of the tab at the given index to the clipboard */
+        copyTabUrl: (index: number) => Promise<void>;
     };
+    /** The workspace management */
     workspace: {
-        create: typeof createWorkspace;
+        /** Creates a new workspace and navigates to it */
+        create: (payload: {
+            teamUid?: string;
+            namespace?: string;
+            slug?: string;
+            name: string;
+        }) => Promise<{
+            name: string;
+            namespace: string;
+            slug: string;
+            teamUid: string;
+        } | undefined>;
+        /** All workspace list */
         workspaceList: Ref<WorkspaceOption[]>;
-        activeWorkspace: ShallowRef<ScalarListboxOption | null>;
-        navigateToWorkspace: typeof navigateToWorkspace;
+        /** Filtered workspace list, based on the current teamUid */
+        filteredWorkspaceList: ComputedRef<WorkspaceOption[]>;
+        /**
+         * Groups workspaces into team and local categories for display in the workspace picker.
+         * Team workspaces are shown first (when not on local team), followed by local workspaces.
+         */
+        workspaceGroups: ComputedRef<WorkspaceGroup[]>;
+        /** The currently active workspace */
+        activeWorkspace: ShallowRef<{
+            id: string;
+            label: string;
+        } | null>;
+        /** Navigates to the specified workspace */
+        navigateToWorkspace: (namespace?: string, slug?: string) => Promise<void>;
+        /** Whether the workspace page is open */
         isOpen: ComputedRef<boolean>;
     };
+    /** The workspace event bus for handling workspace-level events */
     eventBus: WorkspaceEventBus;
-    router: ShallowRef<Router | null>;
+    /** The router instance */
+    router: Router;
+    /** The current route derived from the router */
     currentRoute: Ref<RouteLocationNormalizedGeneric | null>;
+    /** Whether the workspace is currently syncing */
     loading: Ref<boolean>;
+    /** The currently active entities */
     activeEntities: {
+        /** The namespace of the current entity, e.g. "default" or a custom namespace */
         namespace: Ref<string | undefined>;
+        /** The slug identifying the current workspace */
         workspaceSlug: Ref<string | undefined>;
+        /** The slug of the currently selected document in the workspace */
         documentSlug: Ref<string | undefined>;
+        /** The API path currently selected (e.g. "/users/{id}") */
         path: Ref<string | undefined>;
+        /** The HTTP method for the currently selected API path (e.g. GET, POST) */
         method: Ref<HttpMethod | undefined>;
+        /** The name of the currently selected example (for examples within an endpoint) */
         exampleName: Ref<string | undefined>;
+        /** The unique identifier for the selected team context */
+        teamUid: Ref<string>;
     };
+    /** The currently active environment */
     environment: ComputedRef<XScalarEnvironment>;
+    /** The currently active document */
     document: ComputedRef<WorkspaceDocument | null>;
+    /** Whether the current color mode is dark */
+    isDarkMode: ComputedRef<boolean>;
 };
-export declare function useAppState(_router: Router): AppState;
+export declare const createAppState: ({ router, fileLoader, }: {
+    router: Router;
+    fileLoader?: LoaderPlugin;
+}) => Promise<AppState>;
 export {};
 //# sourceMappingURL=app-state.d.ts.map

package/dist/v2/features/app/app-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-state.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/app/app-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gCAAgC,CAAA;AAC1F,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,gCAAgC,CAAA;AAKvC,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAEnF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oEAAoE,CAAA;AAC7F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,UAAU,EAAoC,MAAM,KAAK,CAAA;AACnG,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAoExE,KAAK,eAAe,GAAG,mBAAmB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AA8HjG;;;;;;GAMG;AACH,QAAA,MAAM,mBAAmB,GAAU,YAAY,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CAKlF,CAAA;AAED;;;;;;;;;GASG;AACH,QAAA,MAAM,eAAe,GAAU,qCAK5B;IACD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;;;;;cA8BA,CAAA;AA0FD,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;CAA8B,CAAA;AAoDhD;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,kBAAkB,EAAE,kBAgBzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,KACG,CAAC,cAAc,GAAG;IAChB,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;CACpC,CAAC,GACF,SAAS,CAAA;AAEb;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,IAAI,MAAM,mFAiFnC,CAAA;AAoED,yCAAyC;AACzC,QAAA,MAAM,wBAAwB,GAAI,OAAO,MAAM,qBAAyD,CAAA;AAwCxG;;;;;GAKG;AACH,QAAA,MAAM,UAAU,GAAU,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CAerD,CAAA;AA+FD,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACxC,OAAO,EAAE;QACP,KAAK,EAAE,OAAO,YAAY,CAAA;QAC1B,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;QAC1B,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,gBAAgB,EAAE,OAAO,gBAAgB,CAAA;QACzC,wBAAwB,EAAE,OAAO,wBAAwB,CAAA;QACzD,kBAAkB,EAAE,OAAO,kBAAkB,CAAA;KAC9C,CAAA;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;QACjB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3B,UAAU,EAAE,OAAO,UAAU,CAAA;KAC9B,CAAA;IACD,SAAS,EAAE;QACT,MAAM,EAAE,OAAO,eAAe,CAAA;QAC9B,aAAa,EAAE,GAAG,CAAC,eAAe,EAAE,CAAC,CAAA;QACrC,eAAe,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;QACvD,mBAAmB,EAAE,OAAO,mBAAmB,CAAA;QAC/C,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7B,CAAA;IACD,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACjC,YAAY,EAAE,GAAG,CAAC,8BAA8B,GAAG,IAAI,CAAC,CAAA;IACxD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACrB,cAAc,EAAE;QACd,SAAS,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QAClC,aAAa,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACtC,YAAY,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACrC,IAAI,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QAC7B,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;QACnC,WAAW,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;KACrC,CAAA;IACD,WAAW,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAA;IAC5C,QAAQ,EAAE,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;CAChD,CAAA;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CA0CrD"}
+{"version":3,"file":"app-state.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/app/app-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAG7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,kBAAkB,EAAwB,MAAM,iBAAiB,CAAA;AAC1E,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gCAAgC,CAAA;AAC1F,OAAO,EAEL,KAAK,iBAAiB,EAEvB,MAAM,gCAAgC,CAAA;AAKvC,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAEnF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oEAAoE,CAAA;AAC7F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,UAAU,EAA6B,MAAM,KAAK,CAAA;AAC5F,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAexE,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,KACG,CAAC,cAAc,GAAG;IAChB,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;CACpC,CAAC,GACF,SAAS,CAAA;AAEb,KAAK,eAAe,GAAG,mBAAmB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjG,mFAAmF;AACnF,MAAM,MAAM,QAAQ,GAAG;IACrB,0BAA0B;IAC1B,KAAK,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACxC,6BAA6B;IAC7B,OAAO,EAAE;QACP,wBAAwB;QACxB,KAAK,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAA;QAC5D,+BAA+B;QAC/B,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;QAC1B,kCAAkC;QAClC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,sDAAsD;QACtD,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;QACtC,8CAA8C;QAC9C,wBAAwB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;QACjD,iCAAiC;QACjC,kBAAkB,EAAE,kBAAkB,CAAA;KACvC,CAAA;IACD,0BAA0B;IAC1B,IAAI,EAAE;QACJ,qBAAqB;QACrB,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;QACjB,2BAA2B;QAC3B,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3B,oEAAoE;QACpE,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC7C,CAAA;IACD,+BAA+B;IAC/B,SAAS,EAAE;QACT,kDAAkD;QAClD,MAAM,EAAE,CAAC,OAAO,EAAE;YAChB,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,SAAS,CAAC,EAAE,MAAM,CAAA;YAClB,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,IAAI,EAAE,MAAM,CAAA;SACb,KAAK,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC,CAAA;QAC7F,yBAAyB;QACzB,aAAa,EAAE,GAAG,CAAC,eAAe,EAAE,CAAC,CAAA;QACrC,4DAA4D;QAC5D,qBAAqB,EAAE,WAAW,CAAC,eAAe,EAAE,CAAC,CAAA;QACrD;;;WAGG;QACH,eAAe,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAA;QAC9C,qCAAqC;QACrC,eAAe,EAAE,UAAU,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC,CAAA;QACjE,2CAA2C;QAC3C,mBAAmB,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QACzE,yCAAyC;QACzC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7B,CAAA;IACD,kEAAkE;IAClE,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,YAAY,EAAE,GAAG,CAAC,8BAA8B,GAAG,IAAI,CAAC,CAAA;IACxD,iDAAiD;IACjD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACrB,oCAAoC;IACpC,cAAc,EAAE;QACd,gFAAgF;QAChF,SAAS,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QAClC,iDAAiD;QACjD,aAAa,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACtC,mEAAmE;QACnE,YAAY,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACrC,2DAA2D;QAC3D,IAAI,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QAC7B,2EAA2E;QAC3E,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;QACnC,mFAAmF;QACnF,WAAW,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACpC,0DAA0D;QAC1D,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;KACrB,CAAA;IACD,uCAAuC;IACvC,WAAW,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAA;IAC5C,oCAAoC;IACpC,QAAQ,EAAE,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;IAC/C,6CAA6C;IAC7C,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;CACjC,CAAA;AAgBD,eAAO,MAAM,cAAc,GAAU,yBAGlC;IACD,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,YAAY,CAAA;CAC1B,KAAG,OAAO,CAAC,QAAQ,CAwwBnB,CAAA"}