@vc-shell/framework 2.5.0-pr313.14efcac → 2.5.0-pr314.c87af9d

package/dist/core/composables/useMenuExpanded/index.d.ts

@@ -1,9 +1,22 @@
-import { type Ref } from "vue";
+import type { Ref } from "vue";
+/**
+ * @deprecated Use `UseSidebarStateReturn` from `useSidebarState`. Will be removed in the
+ * next major.
+ */
 export interface UseMenuExpandedReturn {
     isExpanded: Ref<boolean>;
     toggleExpanded: () => void;
     isHoverExpanded: Ref<boolean>;
     toggleHoverExpanded: (shouldExpand?: boolean) => void;
 }
+/**
+ * Sidebar pinned/hover state with localStorage persistence.
+ *
+ * @deprecated Use `useSidebarState()`. Will be removed in the next major.
+ *
+ * Each call builds its own instance, so the returned `isHoverExpanded` is NOT the
+ * one the sidebar renders from - only the pinned state is shared, through the
+ * localStorage key. `useSidebarState()` returns the single provided instance.
+ */
 export declare const useMenuExpanded: () => UseMenuExpandedReturn;
 //# sourceMappingURL=index.d.ts.map

package/dist/core/composables/useMenuExpanded/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useMenuExpanded/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAEpD,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,mBAAmB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACvD;AAgBD,eAAO,MAAM,eAAe,QAAO,qBA8ClC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useMenuExpanded/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAG/B;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,mBAAmB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACvD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,QAAO,qBASlC,CAAC"}

package/dist/core/composables/useSidebarState/_internal.d.ts

@@ -0,0 +1,47 @@
+import type { Ref, ComputedRef } from "vue";
+export interface SidebarState {
+    /** Sidebar is pinned open by user (persisted to localStorage) */
+    isPinned: Ref<boolean>;
+    /** Sidebar is temporarily expanded on mouse hover (desktop only) */
+    isHoverExpanded: Ref<boolean>;
+    /** Mobile menu overlay is visible */
+    isMenuOpen: Ref<boolean>;
+    /** Derived: sidebar content should render in expanded mode (pinned OR hovered) */
+    isExpanded: ComputedRef<boolean>;
+}
+export interface SidebarActions {
+    /** Toggle the pinned state (persists to localStorage) */
+    togglePin: () => void;
+    /** Set hover expansion state with delay for opening */
+    setHoverExpanded: (value: boolean) => void;
+    /** Open the mobile menu / widget overlay */
+    openMenu: () => void;
+    /** Close the mobile menu / widget overlay */
+    closeMenu: () => void;
+}
+export type UseSidebarStateReturn = SidebarState & SidebarActions;
+/** @deprecated Use UseSidebarStateReturn instead */
+export type SidebarStateReturn = UseSidebarStateReturn;
+/**
+ * Shape of a freshly built instance. Identical to `UseSidebarStateReturn` except that
+ * `setHoverExpanded` also accepts `undefined` as a no-op, which the deprecated
+ * `useMenuExpanded` adapter forwards. Assignable to `UseSidebarStateReturn`.
+ */
+export type SidebarStateInstance = Omit<UseSidebarStateReturn, "setHoverExpanded"> & {
+    setHoverExpanded: (value?: boolean) => void;
+};
+/**
+ * localStorage key holding the pinned state, scoped per application.
+ * The app name defaults to the first segment of `window.location.pathname`
+ * ("/vendor-portal/" -> "vendor-portal"), so several vc-shell apps on one
+ * domain keep independent sidebar states.
+ */
+export declare function sidebarStorageKey(appName?: string): string;
+/**
+ * Builds a standalone sidebar state instance. Not provided, not shared:
+ * `provideSidebarState()` owns the one instance the component tree sees, and the
+ * deprecated `useMenuExpanded()` builds its own because it may be called outside
+ * the VcApp tree, where no provider exists.
+ */
+export declare function createSidebarStateInstance(): SidebarStateInstance;
+//# sourceMappingURL=_internal.d.ts.map

package/dist/core/composables/useSidebarState/_internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_internal.d.ts","sourceRoot":"","sources":["../../../../core/composables/useSidebarState/_internal.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAG5C,MAAM,WAAW,YAAY;IAC3B,iEAAiE;IACjE,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,oEAAoE;IACpE,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,qCAAqC;IACrC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,kFAAkF;IAClF,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,uDAAuD;IACvD,gBAAgB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,cAAc,CAAC;AAElE,oDAAoD;AACpD,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,GAAG;IACnF,gBAAgB,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CAC7C,CAAC;AAKF;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAG1D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,oBAAoB,CA0DjE"}

package/dist/core/composables/useSidebarState/index.d.ts

@@ -1,32 +1,9 @@
-import type { Ref, ComputedRef } from "vue";
-export interface SidebarState {
-    /** Sidebar is pinned open by user (persisted to localStorage) */
-    isPinned: Ref<boolean>;
-    /** Sidebar is temporarily expanded on mouse hover (desktop only) */
-    isHoverExpanded: Ref<boolean>;
-    /** Mobile menu overlay is visible */
-    isMenuOpen: Ref<boolean>;
-    /** Derived: sidebar content should render in expanded mode (pinned OR hovered) */
-    isExpanded: ComputedRef<boolean>;
-}
-export interface SidebarActions {
-    /** Toggle the pinned state (persists to localStorage) */
-    togglePin: () => void;
-    /** Set hover expansion state with delay for opening */
-    setHoverExpanded: (value: boolean) => void;
-    /** Open the mobile menu / widget overlay */
-    openMenu: () => void;
-    /** Close the mobile menu / widget overlay */
-    closeMenu: () => void;
-}
-export type UseSidebarStateReturn = SidebarState & SidebarActions;
-/** @deprecated Use UseSidebarStateReturn instead */
-export type SidebarStateReturn = UseSidebarStateReturn;
+import type { UseSidebarStateReturn } from "./_internal";
+export type { SidebarState, SidebarActions, UseSidebarStateReturn, SidebarStateReturn } from "./_internal";
+export { sidebarStorageKey } from "./_internal";
 /**
  * Provides sidebar state to the component tree. Must be called once in VcApp setup.
- * Idempotent: returns existing instance if already provided in the current tree.
- * Internally delegates to useMenuExpanded() for shared reactive state,
- * ensuring UserDropdownButton (which uses useMenuExpanded directly) stays in sync.
+ * Idempotent: returns the existing instance if already provided in the current tree.
  */
 export declare function provideSidebarState(): UseSidebarStateReturn;
 /**

package/dist/core/composables/useSidebarState/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useSidebarState/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAgB,MAAM,KAAK,CAAC;AAG1D,MAAM,WAAW,YAAY;IAC3B,iEAAiE;IACjE,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,oEAAoE;IACpE,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,qCAAqC;IACrC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,kFAAkF;IAClF,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,uDAAuD;IACvD,gBAAgB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,cAAc,CAAC;AAElE,oDAAoD;AACpD,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAIvD;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,qBAAqB,CAoC3D;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,qBAAqB,CAMvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useSidebarState/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAIhD;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,qBAAqB,CAQ3D;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,qBAAqB,CAMvD"}