@mercurjs/dashboard-shared 2.3.6-canary.2 → 2.3.6-canary.4

package/dist/index.d.ts

@@ -17,7 +17,7 @@ import { TFunction } from 'i18next';
 import { ClientError } from '@mercurjs/client';
 import * as react_currency_input_field from 'react-currency-input-field';
 import * as _mercurjs_dashboard_sdk from '@mercurjs/dashboard-sdk';
-import { PermissionsContextValue, UserPolicy, PermissionsRequirementsContextValue, Permission, PermissionResource, PermissionOperation, CustomFieldsConfig, NavItemOverride, ActivityEntry, CustomFormField, CustomDisplayField, SectionAction, CustomListExtension } from '@mercurjs/dashboard-sdk';
+import { PermissionsContextValue, PermissionMap, Permission, PermissionKey, CustomFieldsConfig, NavItemOverride, ActivityEntry, CustomFormField, CustomDisplayField, SectionAction, CustomListExtension } from '@mercurjs/dashboard-sdk';
 
 type TQueryKey<TKey, TListQuery = any, TDetailQuery = string> = {
     all: readonly [TKey];
@@ -524,6 +524,18 @@ type ProductChangePanelProps = {
 };
 declare const ProductChangePanel: ({ product, actions, resolvers, headerDescription, footer, }: ProductChangePanelProps) => react_jsx_runtime.JSX.Element | null;
 
+type RichTextProps = {
+    html?: string | null;
+    className?: string;
+    fallback?: string;
+    collapsedHeight?: number;
+    "data-testid"?: string;
+};
+declare const sanitizeRichText: (html: string) => string;
+declare const RichText: ({ html, className, fallback, collapsedHeight, "data-testid": dataTestId, }: RichTextProps) => react_jsx_runtime.JSX.Element;
+
+declare const richTextContentClasses: string;
+
 interface ProgressBarProps {
     /**
      * The duration of the animation in seconds.
@@ -1056,6 +1068,27 @@ type ProvinceSelectProps = ComponentPropsWithoutRef<typeof Select> & {
 };
 declare const ProvinceSelect: ComponentType<ProvinceSelectProps>;
 
+type RichTextEditorProps = Omit<ComponentPropsWithoutRef<"div">, "onChange" | "onBlur" | "defaultValue"> & {
+    value?: string | null;
+    onChange?: (value: string) => void;
+    onBlur?: () => void;
+    name?: string;
+    disabled?: boolean;
+    placeholder?: string;
+    onUpload?: (file: File) => Promise<string>;
+    contentClassName?: string;
+};
+declare const RichTextEditor: React$1.ForwardRefExoticComponent<Omit<Omit<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "defaultValue" | "onBlur" | "onChange"> & {
+    value?: string | null;
+    onChange?: (value: string) => void;
+    onBlur?: () => void;
+    name?: string;
+    disabled?: boolean;
+    placeholder?: string;
+    onUpload?: (file: File) => Promise<string>;
+    contentClassName?: string;
+} & React$1.RefAttributes<HTMLDivElement>>;
+
 interface PageProps<TData> {
     children: ReactNode;
     data?: TData;
@@ -1482,82 +1515,32 @@ declare function useQueryParams<T extends string>(keys: T[], prefix?: string): Q
 declare const PermissionsContext: React$1.Context<PermissionsContextValue | null>;
 
 interface PermissionsProviderProps extends PropsWithChildren {
-    policy: UserPolicy | null;
-    isLoading?: boolean;
     /**
-     * Whether the RBAC feature flag is enabled. When `false`, every permission
-     * check resolves to `true`.
+     * The actor's effective rights, read from `fields=+permissions`. Leave it
+     * `null`/`undefined` when the API returned no `permissions` field: nothing is
+     * being enforced, so every check passes.
      */
-    isRbacEnabled?: boolean;
+    permissions?: PermissionMap | null;
+    isLoading?: boolean;
 }
-declare const PermissionsProvider: ({ policy, isLoading, isRbacEnabled, children, }: PermissionsProviderProps) => react_jsx_runtime.JSX.Element;
-
-declare const PermissionsRequirementsContext: React$1.Context<PermissionsRequirementsContextValue | null>;
+declare const PermissionsProvider: ({ permissions, isLoading, children, }: PermissionsProviderProps) => react_jsx_runtime.JSX.Element;
 
-/**
- * Collects the permission requirements declared by descendant guards so a
- * page can surface them (see `RequiredPermissionsSection`). Mount it around a
- * page body; guards work fine without it.
- */
-declare const PermissionsRequirementsProvider: ({ children, }: PropsWithChildren) => react_jsx_runtime.JSX.Element;
-
-interface BasePermissionProps {
-    source?: string;
-    enabled?: boolean;
-}
-interface WithPermission extends BasePermissionProps {
-    permission: Permission;
-    permissions?: never;
-    resource?: never;
-    operation?: never;
-    requireAll?: never;
-}
-interface WithPermissions extends BasePermissionProps {
-    permissions: Permission[];
-    /** If true, ALL permissions are required. Defaults to ANY. */
+type PermissionGuardProps = PropsWithChildren<{
+    permission: Permission | Permission[];
+    /** When several permissions are given, require all of them. Defaults to any. */
     requireAll?: boolean;
-    permission?: never;
-    resource?: never;
-    operation?: never;
-}
-interface WithResourceOperation extends BasePermissionProps {
-    resource: PermissionResource;
-    operation: PermissionOperation;
-    permission?: never;
-    permissions?: never;
-    requireAll?: never;
-}
-type PermissionProps = WithPermission | WithPermissions | WithResourceOperation;
-declare const resolvePermissionProps: (props: PermissionProps) => {
-    permissions: Permission[] | null;
-    requireAll: boolean;
-};
-
-type PermissionsRequirementProps = PropsWithChildren<PermissionProps>;
-/**
- * Declares a permission requirement for the surrounding subtree without
- * gating it. Use `PermissionGuard` when the children should be hidden.
- */
-declare const PermissionsRequirement: ({ children, source, enabled, ...props }: PermissionsRequirementProps) => react_jsx_runtime.JSX.Element;
-
-type PermissionGuardProps = PropsWithChildren<PermissionProps & {
     /** Rendered when access is denied. Nothing renders when omitted. */
     fallback?: ReactNode;
-    showLoading?: boolean;
-    loadingComponent?: ReactNode;
 }>;
 /**
- * Hides its children unless the actor holds the declared permission, and
- * registers the requirement so the page can surface what is missing.
- *
  * @example
  * ```tsx
- * <PermissionGuard resource="product" operation="create">
+ * <PermissionGuard permission="products:edit">
  *   <Button>Create</Button>
  * </PermissionGuard>
  * ```
  */
-declare const PermissionGuard: ({ children, fallback, showLoading, loadingComponent, source, enabled, ...props }: PermissionGuardProps) => react_jsx_runtime.JSX.Element;
+declare const PermissionGuard: ({ children, permission, requireAll, fallback, }: PermissionGuardProps) => react_jsx_runtime.JSX.Element;
 
 /**
  * Route-level guard. Mount as a route's `element` and declare the requirement
@@ -1569,58 +1552,35 @@ declare const PermissionGuard: ({ children, fallback, showLoading, loadingCompon
  * {
  *   path: "roles",
  *   element: <RoutePermissionGuard />,
- *   handle: { permissions: "rbac_role:read" },
+ *   handle: { permissions: "roles:view" },
  *   children: [...],
  * }
  * ```
  */
 declare const RoutePermissionGuard: () => react_jsx_runtime.JSX.Element;
 
-/**
- * Renders the requirements that descendant guards registered with the nearest
- * `PermissionsRequirementsProvider`. Renders nothing when RBAC is off.
- */
-declare const RequiredPermissionsSection: () => react_jsx_runtime.JSX.Element | null;
-
 /**
  * @example
  * ```tsx
  * const { can, hasPermission } = usePermissions()
  *
- * if (can("customer", "create")) { ... }
- * if (hasPermission("customer:read")) { ... }
+ * if (can("customers", "edit")) { ... }
+ * if (hasPermission("customers:view")) { ... }
  * ```
  */
 declare const usePermissions: () => _mercurjs_dashboard_sdk.PermissionsContextValue;
 
-interface UseRegisterPermissionsOptions {
-    /** If true, ALL permissions are required. Defaults to ANY. */
-    requireAll?: boolean;
-    source?: string;
-    enabled?: boolean;
-}
-/**
- * Declares what the calling subtree needs. No-ops when there is no
- * `PermissionsRequirementsProvider` above it.
- */
-declare const useRegisterPermissions: (permissions: Permission[] | null | undefined, options?: UseRegisterPermissionsOptions) => void;
-
-declare const useRequiredPermissions: () => _mercurjs_dashboard_sdk.PermissionRequirement[];
-
 /**
  * @example
  * ```tsx
- * const { canCreate } = useResourcePermissions("product")
- * {canCreate && <Button>Create</Button>}
+ * const { canEdit } = useResourcePermissions("products")
  * ```
  */
-declare const useResourcePermissions: (resource: PermissionResource) => {
-    canRead: boolean;
-    canCreate: boolean;
-    canUpdate: boolean;
-    canDelete: boolean;
-    can: (operation: "read" | "create" | "update" | "delete") => boolean;
-    resource: PermissionResource;
+declare const useResourcePermissions: (key: PermissionKey) => {
+    canView: boolean;
+    canEdit: boolean;
+    canManage: boolean;
+    key: PermissionKey;
     isLoading: boolean;
 };
 
@@ -1631,6 +1591,11 @@ declare const useResourcePermissions: (resource: PermissionResource) => {
  * it is never caught mid-fade by the clip.
  */
 declare const SIDEBAR_RAIL_FADE: string;
+/**
+ * Sidebar dropdowns take the trigger's width, which in the icon rail is only
+ * the avatar — the floor keeps them readable when opened from the rail.
+ */
+declare const SIDEBAR_MENU_CONTENT = "w-[var(--radix-dropdown-menu-trigger-width)] min-w-[196px]";
 
 type SidebarState = "expanded" | "collapsed";
 type SidebarContextValue = {
@@ -1656,9 +1621,23 @@ declare const SidebarProvider: ({ children }: PropsWithChildren) => react_jsx_ru
  * horizontal space but should not permanently change the user's preference.
  */
 declare const useCollapsedSidebar: (collapsed?: boolean) => void;
+/**
+ * Opens the desktop sidebar on mount and restores the previous state on
+ * unmount. For sidebars without an icon rail, where arriving collapsed would
+ * leave nothing to navigate with.
+ */
+declare const useExpandedSidebar: (expanded?: boolean) => void;
 
 declare const useSidebar: () => SidebarContextValue;
 
+declare const useSidebarMenuPlacement: (align: "start" | "end") => {
+    side: "right";
+    align: "end" | "start";
+} | {
+    side?: undefined;
+    align?: undefined;
+};
+
 type WidgetPlacement = "before" | "after";
 type Widget = {
     Component: ComponentType<{
@@ -2053,4 +2032,9 @@ 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, 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 };
+declare const RICH_TEXT_ALLOWED_TAGS: string[];
+declare const RICH_TEXT_ALLOWED_ATTRIBUTES: string[];
+declare const isHtml: (value?: string | null) => boolean;
+declare const plainTextToHtml: (value?: string | null) => 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, PermissionsContext, PermissionsProvider, type PermissionsProviderProps, 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, RICH_TEXT_ALLOWED_ATTRIBUTES, RICH_TEXT_ALLOWED_TAGS, type ReferenceField, type ResolvedAttribute, type ResolvedDisplays, type ResolvedFormField, RichText, RichTextEditor, type RichTextEditorProps, RouteDrawer, RouteFocusModal, RoutePermissionGuard, SIDEBAR_MENU_CONTENT, 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 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, isHtml, isImageList, isOrderActionable, isOrderAwaitingAction, isPriceListGroupRow, isProductRow, isReferenceField, isSameAddress, linkFields, plainTextToHtml, productChangeViewHasContent, queryClient, queryKeysFactory, richTextContentClasses, sanitizeRichText, useActionLocks, useCollapsedSidebar, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDisplayFieldOverride, useDocumentDirection, useExpandedSidebar, useExtendableForm, useExtendableTable, useExtension, useExtensionActivity, useLinkQuery, usePermissions, useQueryParams, useResourcePermissions, useRouteModal, useSidebar, useSidebarMenuPlacement, useStackedModal, useTabManagement, useTabbedForm, withLinkFields };