@mercurjs/dashboard-shared 2.3.6-canary.0 → 2.3.6-canary.1

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { HttpTypes, AdminOrder } from '@medusajs/types';
 import { z, ZodObject } from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
-import React__default, { ReactNode, PropsWithChildren, ComponentPropsWithoutRef, CSSProperties, ComponentType, ComponentProps, ForwardRefExoticComponent, Ref, RefAttributes, RefCallback } from 'react';
+import React__default, { ReactNode, PropsWithChildren, ComponentPropsWithoutRef, CSSProperties, ComponentType, ComponentProps, ForwardRefExoticComponent, Ref, RefAttributes, RefCallback, Dispatch, SetStateAction } from 'react';
 import { Tooltip, Heading, Text, DataTableColumnDef, DataTableFilter, DataTableCommand, DataTableEmptyStateProps, DataTableRowSelectionState, DataTableRow, Select, Input, Table, Drawer, FocusModal, ProgressStatus } from '@medusajs/ui';
 import * as react_hook_form from 'react-hook-form';
 import { FieldValues, FieldPath, ControllerProps, UseFormReturn, Control, UseFormProps } from 'react-hook-form';
@@ -1624,6 +1624,41 @@ declare const useResourcePermissions: (resource: PermissionResource) => {
     isLoading: boolean;
 };
 
+/**
+ * Applied to anything in the sidebar that has no place in the icon rail —
+ * labels, the store name, the shortcut hint. Expanding waits for the rail to
+ * make room before fading the content back in; collapsing clears it first so
+ * it is never caught mid-fade by the clip.
+ */
+declare const SIDEBAR_RAIL_FADE: string;
+
+type SidebarState = "expanded" | "collapsed";
+type SidebarContextValue = {
+    /**
+     * `collapsed` renders the desktop sidebar as an icon rail rather than
+     * hiding it. Mirrors the `data-state` attribute the layout styles read.
+     */
+    state: SidebarState;
+    desktop: boolean;
+    mobile: boolean;
+    toggle: (view: "desktop" | "mobile") => void;
+    setDesktop: Dispatch<SetStateAction<boolean>>;
+    setMobile: Dispatch<SetStateAction<boolean>>;
+};
+declare const SidebarContext: React$1.Context<SidebarContextValue | null>;
+
+declare const SidebarProvider: ({ children }: PropsWithChildren) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Collapses the desktop sidebar to its icon rail for as long as the calling
+ * component is mounted, restoring whatever the user had open before. Intended
+ * for dense, full-height surfaces — the inbox, the editor — that need the
+ * horizontal space but should not permanently change the user's preference.
+ */
+declare const useCollapsedSidebar: (collapsed?: boolean) => void;
+
+declare const useSidebar: () => SidebarContextValue;
+
 type WidgetPlacement = "before" | "after";
 type Widget = {
     Component: ComponentType<{
@@ -2018,4 +2053,4 @@ declare const extractPricesFromOffers: (offers: ExtractableOffers, regions: Http
     variant_id: string;
 }[];
 
-export { type Action, type ActionGroup, ActionMenu, AddressForm, AddressSchema, type AttributeChange, type AttributeChangeKind, AttributeValueInput, BadgeListSummary, ChipGroup, ChipInput, CodeCell, CodeHeader, Combobox, type Command, ConditionalTooltip, ConfirmPrompt, type ConfirmPromptProps, type CoreNavItem, CountrySelect, CreatedAtCell, CreatedAtHeader, type CurrencyInfo, type CustomFieldsModule, CustomerInfo, DataGrid, DataTable, DateCell, DateHeader, DateRangeDisplay, DeprecatedPercentageInput, DisplayExtensionZone, type DisplayExtensionZoneProps, DisplayField, type DisplayFieldProps, DisplaySection, type DisplaySectionField, type DisplaySectionProps, type EditAttributeAttribute, EditAttributeForm, type EditAttributeFormProps, EmailCell, EmailForm, EmailHeader, EmailSchema, ErrorBoundary, type ExtendableTable, ExtensionProvider, type ExtensionProviderProps, ExtensionRegistry, type ExtractableOffer, type ExtractableOffers, type FieldDiff, FilePreview, type FileType, FileUpload, type FileUploadProps, type Filter, FilterGroup, Form, FormExtensionZone, type FormExtensionZoneProps, GeneralSectionSkeleton, HandleInput, HeadingSkeleton, IconAvatar, IconButtonSkeleton, ImageAvatar, type ImageRef, IncludesTaxTooltip, InfiniteList, JsonViewSection, JsonViewSectionSkeleton, KeyboundForm, LinkButton, ListBadge, ListSummary, Listicle, type ListicleProps, LocalizedTablePagination, type MediaDiff, MetadataForm, MetadataSection, MoneyAmountCell, NameCell, NameHeader, type NavigationModule, NoRecords, type NoRecordsProps, NoResults, type NoResultsProps, OrderBy, PercentageInput, PermissionGuard, type PermissionGuardProps, type PermissionProps, PermissionsContext, PermissionsProvider, type PermissionsProviderProps, PermissionsRequirement, type PermissionsRequirementProps, PermissionsRequirementsContext, PermissionsRequirementsProvider, PlaceholderCell, PriceListDateStatus, type PriceListGridGroupRow, type PriceListGridOfferRow, type PriceListGridRow, PriceListStatus, PriceListType, type ProductAttributeBatchPayload, ProductAttributeSection, type ProductAttributeSectionProps, type ProductChangeAttribute, ProductChangePanel, type ProductChangePanelProps, type ProductChangeProduct, type ProductChangeResolvers, type ProductChangeVariant, type ProductChangeView, ProgressBar, ProvinceSelect, Query, REFERENCE_FIELDS, type ReferenceField, RequiredPermissionsSection, type ResolvedAttribute, type ResolvedDisplays, type ResolvedFormField, RouteDrawer, RouteFocusModal, RoutePermissionGuard, SectionRow, type SectionRowProps, SegmentedControl, type SegmentedControlOption, SidebarLink, type SidebarLinkProps, SingleColumnPage, SingleColumnPageSkeleton, Skeleton, SortableList, SortableTree, StackedDrawer, StackedFocusModal, type StaticCountry, StatusCell, SwitchBox, type TQueryKey, type TabDefinition, TabbedForm, TableFooterSkeleton, TableSectionSkeleton, TableSkeleton, TextCell, TextHeader, TextSkeleton, Thumbnail, TransferOwnershipSchema, TwoColumnPage, TwoColumnPageSkeleton, type UseExtendableFormProps, type UseExtendableTableProps, type UseQueryOptionsWrapper, type UseRegisterPermissionsOptions, type VariantGroup, VisuallyHidden, type Widget, type WidgetModule, type WidgetPlacement, WidgetZone, type WidgetZoneProps, type ZoneWidgets, _DataTable, applyNavOverrides, buildAdditionalDataDefaults, buildAdditionalDataSchema, buildOfferGridData, buildProductChangeView, countries, createDataGridHelper, createDataGridPriceColumns, createFormHelper, currencies, extractPricesFromOffers, extractReferenceIds, formatFieldValue, genericForwardRef, getCountryByIso2, getCurrencySymbol, getDecimalDigits, getExtensionRegistry, getFormattedAddress, getFormattedCountry, getLinkQuery, getLocaleAmount, getNativeSymbol, getPriceListStatus, getStylizedAmount, humanizeFieldName, isAmountLessThenRoundingError, isImageList, isOrderActionable, isOrderAwaitingAction, isPriceListGroupRow, isProductRow, isReferenceField, isSameAddress, linkFields, productChangeViewHasContent, queryClient, queryKeysFactory, resolvePermissionProps, useActionLocks, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDisplayFieldOverride, useDocumentDirection, useExtendableForm, useExtendableTable, useExtension, useExtensionActivity, useLinkQuery, usePermissions, useQueryParams, useRegisterPermissions, useRequiredPermissions, useResourcePermissions, useRouteModal, useStackedModal, useTabManagement, useTabbedForm, withLinkFields };
+export { type Action, type ActionGroup, ActionMenu, AddressForm, AddressSchema, type AttributeChange, type AttributeChangeKind, AttributeValueInput, BadgeListSummary, ChipGroup, ChipInput, CodeCell, CodeHeader, Combobox, type Command, ConditionalTooltip, ConfirmPrompt, type ConfirmPromptProps, type CoreNavItem, CountrySelect, CreatedAtCell, CreatedAtHeader, type CurrencyInfo, type CustomFieldsModule, CustomerInfo, DataGrid, DataTable, DateCell, DateHeader, DateRangeDisplay, DeprecatedPercentageInput, DisplayExtensionZone, type DisplayExtensionZoneProps, DisplayField, type DisplayFieldProps, DisplaySection, type DisplaySectionField, type DisplaySectionProps, type EditAttributeAttribute, EditAttributeForm, type EditAttributeFormProps, EmailCell, EmailForm, EmailHeader, EmailSchema, ErrorBoundary, type ExtendableTable, ExtensionProvider, type ExtensionProviderProps, ExtensionRegistry, type ExtractableOffer, type ExtractableOffers, type FieldDiff, FilePreview, type FileType, FileUpload, type FileUploadProps, type Filter, FilterGroup, Form, FormExtensionZone, type FormExtensionZoneProps, GeneralSectionSkeleton, HandleInput, HeadingSkeleton, IconAvatar, IconButtonSkeleton, ImageAvatar, type ImageRef, IncludesTaxTooltip, InfiniteList, JsonViewSection, JsonViewSectionSkeleton, KeyboundForm, LinkButton, ListBadge, ListSummary, Listicle, type ListicleProps, LocalizedTablePagination, type MediaDiff, MetadataForm, MetadataSection, MoneyAmountCell, NameCell, NameHeader, type NavigationModule, NoRecords, type NoRecordsProps, NoResults, type NoResultsProps, OrderBy, PercentageInput, PermissionGuard, type PermissionGuardProps, type PermissionProps, PermissionsContext, PermissionsProvider, type PermissionsProviderProps, PermissionsRequirement, type PermissionsRequirementProps, PermissionsRequirementsContext, PermissionsRequirementsProvider, PlaceholderCell, PriceListDateStatus, type PriceListGridGroupRow, type PriceListGridOfferRow, type PriceListGridRow, PriceListStatus, PriceListType, type ProductAttributeBatchPayload, ProductAttributeSection, type ProductAttributeSectionProps, type ProductChangeAttribute, ProductChangePanel, type ProductChangePanelProps, type ProductChangeProduct, type ProductChangeResolvers, type ProductChangeVariant, type ProductChangeView, ProgressBar, ProvinceSelect, Query, REFERENCE_FIELDS, type ReferenceField, RequiredPermissionsSection, type ResolvedAttribute, type ResolvedDisplays, type ResolvedFormField, RouteDrawer, RouteFocusModal, RoutePermissionGuard, SIDEBAR_RAIL_FADE, SectionRow, type SectionRowProps, SegmentedControl, type SegmentedControlOption, SidebarContext, type SidebarContextValue, SidebarLink, type SidebarLinkProps, SidebarProvider, type SidebarState, SingleColumnPage, SingleColumnPageSkeleton, Skeleton, SortableList, SortableTree, StackedDrawer, StackedFocusModal, type StaticCountry, StatusCell, SwitchBox, type TQueryKey, type TabDefinition, TabbedForm, TableFooterSkeleton, TableSectionSkeleton, TableSkeleton, TextCell, TextHeader, TextSkeleton, Thumbnail, TransferOwnershipSchema, TwoColumnPage, TwoColumnPageSkeleton, type UseExtendableFormProps, type UseExtendableTableProps, type UseQueryOptionsWrapper, type UseRegisterPermissionsOptions, type VariantGroup, VisuallyHidden, type Widget, type WidgetModule, type WidgetPlacement, WidgetZone, type WidgetZoneProps, type ZoneWidgets, _DataTable, applyNavOverrides, buildAdditionalDataDefaults, buildAdditionalDataSchema, buildOfferGridData, buildProductChangeView, countries, createDataGridHelper, createDataGridPriceColumns, createFormHelper, currencies, extractPricesFromOffers, extractReferenceIds, formatFieldValue, genericForwardRef, getCountryByIso2, getCurrencySymbol, getDecimalDigits, getExtensionRegistry, getFormattedAddress, getFormattedCountry, getLinkQuery, getLocaleAmount, getNativeSymbol, getPriceListStatus, getStylizedAmount, humanizeFieldName, isAmountLessThenRoundingError, isImageList, isOrderActionable, isOrderAwaitingAction, isPriceListGroupRow, isProductRow, isReferenceField, isSameAddress, linkFields, productChangeViewHasContent, queryClient, queryKeysFactory, resolvePermissionProps, useActionLocks, useCollapsedSidebar, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDisplayFieldOverride, useDocumentDirection, useExtendableForm, useExtendableTable, useExtension, useExtensionActivity, useLinkQuery, usePermissions, useQueryParams, useRegisterPermissions, useRequiredPermissions, useResourcePermissions, useRouteModal, useSidebar, useStackedModal, useTabManagement, useTabbedForm, withLinkFields };

package/dist/index.js

@@ -28531,6 +28531,77 @@ var useResourcePermissions = (resource) => {
   );
 };
 
+// src/providers/sidebar-provider/classes.ts
+var SIDEBAR_RAIL_FADE = [
+  "transition-opacity duration-150 delay-100 ease-out motion-reduce:transition-none",
+  "group-data-[state=collapsed]/sidebar:opacity-0",
+  "group-data-[state=collapsed]/sidebar:delay-0 group-data-[state=collapsed]/sidebar:duration-75"
+].join(" ");
+
+// src/providers/sidebar-provider/sidebar-context.tsx
+import { createContext as createContext12 } from "react";
+var SidebarContext = createContext12(null);
+
+// src/providers/sidebar-provider/sidebar-provider.tsx
+import { useCallback as useCallback29, useEffect as useEffect26, useMemo as useMemo27, useState as useState38 } from "react";
+import { useLocation as useLocation4 } from "react-router-dom";
+import { jsx as jsx111 } from "react/jsx-runtime";
+var SidebarProvider = ({ children }) => {
+  const [desktop, setDesktop] = useState38(true);
+  const [mobile, setMobile] = useState38(false);
+  const { pathname } = useLocation4();
+  useEffect26(() => {
+    setMobile(false);
+  }, [pathname]);
+  const toggle = useCallback29((view) => {
+    if (view === "desktop") {
+      setDesktop((open) => !open);
+    } else {
+      setMobile((open) => !open);
+    }
+  }, []);
+  const value = useMemo27(
+    () => ({
+      state: desktop ? "expanded" : "collapsed",
+      desktop,
+      mobile,
+      toggle,
+      setDesktop,
+      setMobile
+    }),
+    [desktop, mobile, toggle]
+  );
+  return /* @__PURE__ */ jsx111(SidebarContext.Provider, { value, children });
+};
+
+// src/providers/sidebar-provider/use-collapsed-sidebar.tsx
+import { useEffect as useEffect27, useRef as useRef17 } from "react";
+
+// src/providers/sidebar-provider/use-sidebar.tsx
+import { useContext as useContext13 } from "react";
+var useSidebar = () => {
+  const context = useContext13(SidebarContext);
+  if (!context) {
+    throw new Error("useSidebar must be used within a SidebarProvider");
+  }
+  return context;
+};
+
+// src/providers/sidebar-provider/use-collapsed-sidebar.tsx
+var useCollapsedSidebar = (collapsed = true) => {
+  const { desktop, setDesktop } = useSidebar();
+  const desktopRef = useRef17(desktop);
+  desktopRef.current = desktop;
+  useEffect27(() => {
+    if (!collapsed) {
+      return;
+    }
+    const previous = desktopRef.current;
+    setDesktop(false);
+    return () => setDesktop(previous);
+  }, [collapsed, setDesktop]);
+};
+
 // src/price-lists/constants.ts
 var PriceListStatus = /* @__PURE__ */ ((PriceListStatus2) => {
   PriceListStatus2["ACTIVE"] = "active";
@@ -28771,9 +28842,12 @@ export {
   RouteDrawer,
   RouteFocusModal,
   RoutePermissionGuard,
+  SIDEBAR_RAIL_FADE,
   SectionRow,
   SegmentedControl,
+  SidebarContext,
   SidebarLink,
+  SidebarProvider,
   SingleColumnPage,
   SingleColumnPageSkeleton,
   Skeleton,
@@ -28837,6 +28911,7 @@ export {
   queryKeysFactory,
   resolvePermissionProps,
   useActionLocks,
+  useCollapsedSidebar,
   useCombinedRefs,
   useCommandHistory,
   useDataTable2 as useDataTable,
@@ -28854,6 +28929,7 @@ export {
   useRequiredPermissions,
   useResourcePermissions,
   useRouteModal,
+  useSidebar,
   useStackedModal,
   useTabManagement,
   useTabbedForm,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercurjs/dashboard-shared",
-  "version": "2.3.6-canary.0",
+  "version": "2.3.6-canary.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/mercurjs/mercur",
@@ -23,7 +23,7 @@
     "build": "tsup"
   },
   "dependencies": {
-    "@mercurjs/client": "2.3.6-canary.0",
+    "@mercurjs/client": "2.3.6-canary.1",
     "@ariakit/react": "^0.4.15",
     "@babel/runtime": "^8.0.0",
     "@dnd-kit/core": "^6.1.0",
@@ -63,9 +63,9 @@
   },
   "devDependencies": {
     "@medusajs/types": "2.21.0",
-    "@mercurjs/core": "2.3.6-canary.0",
-    "@mercurjs/dashboard-sdk": "2.3.6-canary.0",
-    "@mercurjs/types": "2.3.6-canary.0",
+    "@mercurjs/core": "2.3.6-canary.1",
+    "@mercurjs/dashboard-sdk": "2.3.6-canary.1",
+    "@mercurjs/types": "2.3.6-canary.1",
     "@types/lodash.debounce": "^4.0.8",
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.2.22",