@mercurjs/dashboard-shared 2.3.6-canary.6 → 2.3.6-canary.7

package/dist/index.d.ts

@@ -3,8 +3,10 @@ import { ProductChangeActionDTO, HttpTypes as HttpTypes$1, AttributeType, Produc
 import { HttpTypes, AdminOrder } from '@medusajs/types';
 import { z, ZodObject } from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as _mercurjs_dashboard_sdk from '@mercurjs/dashboard-sdk';
+import { Permission, PermissionsContextValue, PermissionMap, PermissionKey, PermissionRight, CustomFieldsConfig, NavItemOverride, ActivityEntry, CustomFormField, CustomDisplayField, SectionAction, CustomListExtension } from '@mercurjs/dashboard-sdk';
 import * as React$1 from 'react';
-import React__default, { ReactNode, PropsWithChildren, ComponentPropsWithoutRef, CSSProperties, ComponentType, ComponentProps, ForwardRefExoticComponent, Ref, RefAttributes, RefCallback, Dispatch, SetStateAction } from 'react';
+import React__default, { ReactNode, PropsWithChildren, ComponentPropsWithoutRef, CSSProperties, ComponentType, ComponentProps, ForwardRefExoticComponent, Ref, RefAttributes, RefCallback, ReactElement, 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';
@@ -16,8 +18,6 @@ import { CellContext, Row, ColumnDef, ColumnDefTemplate, HeaderContext, Table as
 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, PermissionMap, Permission, PermissionKey, CustomFieldsConfig, NavItemOverride, ActivityEntry, CustomFormField, CustomDisplayField, SectionAction, CustomListExtension } from '@mercurjs/dashboard-sdk';
 
 type TQueryKey<TKey, TListQuery = any, TDetailQuery = string> = {
     all: readonly [TKey];
@@ -198,6 +198,13 @@ type Action = {
      * Optional tooltip to display when a disabled action is hovered.
      */
     disabledTooltip?: string | ReactNode;
+    /**
+     * Permission(s) of the endpoint this action calls. An actor who lacks it
+     * gets the action disabled with a tooltip.
+     */
+    permission?: Permission | Permission[];
+    /** If true, ALL `permission` entries are required. Defaults to ANY. */
+    requireAll?: boolean;
 } & ({
     to: string;
     onClick?: never;
@@ -212,7 +219,7 @@ type ActionMenuProps = PropsWithChildren<{
     groups: ActionGroup[];
     variant?: "transparent" | "primary";
 }>;
-declare const ActionMenu: ({ groups, variant, children, }: ActionMenuProps) => react_jsx_runtime.JSX.Element;
+declare const ActionMenu: ({ groups: declaredGroups, variant, children, }: ActionMenuProps) => react_jsx_runtime.JSX.Element;
 
 type BadgeListSummaryProps = {
     /**
@@ -340,6 +347,8 @@ type ActionProps = {
     action?: {
         to: string;
         label: string;
+        /** Permission of what the target route does; disabled without it. */
+        permission?: Permission | Permission[];
     };
 };
 type NoRecordsProps = {
@@ -826,11 +835,46 @@ type CreateDataGridPriceColumnsProps<TData, TFieldValues extends FieldValues> =
 };
 declare const createDataGridPriceColumns: <TData, TFieldValues extends FieldValues>({ currencies, regions, pricePreferences, isReadyOnly, getFieldName, t, }: CreateDataGridPriceColumnsProps<TData, TFieldValues>) => ColumnDef<TData, unknown>[];
 
+type PermissionChecks$1 = Pick<PermissionsContextValue, "hasAnyPermission" | "hasAllPermissions">;
+type Permissioned = {
+    permission?: Permission | Permission[];
+    requireAll?: boolean;
+};
+type DisableableAction = Permissioned & {
+    disabled?: boolean;
+    disabledTooltip?: string | ReactNode;
+};
+/**
+ * Disables the actions the actor lacks the permission for and explains why in
+ * the tooltip. The action stays visible so the menu doesn't change shape
+ * between roles.
+ */
+declare const applyActionPermissions: <TAction extends DisableableAction, TGroup extends {
+    actions: TAction[];
+}>(groups: TGroup[], checks: PermissionChecks$1 | null, deniedTooltip: string) => TGroup[];
+type PermissionedCommand<TCommand> = TCommand & Permissioned;
+/**
+ * The Medusa UI command bar can't render a disabled command, so bulk commands
+ * the actor may not run are left out.
+ */
+declare const filterCommandsByPermission: <TCommand>(commands: PermissionedCommand<TCommand>[], checks: PermissionChecks$1 | null) => TCommand[];
+/**
+ * @example
+ * ```tsx
+ * const commands = usePermittedCommands([
+ *   { label: t("actions.delete"), shortcut: "d", action, permission: "offers:manage" },
+ * ])
+ * ```
+ */
+declare const usePermittedCommands: <TCommand>(commands: PermissionedCommand<TCommand>[]) => TCommand[];
+
 type VisibilityState = Record<string, boolean>;
 type ColumnOrderState = string[];
 type DataTableActionProps = {
     label: string;
     disabled?: boolean;
+    /** Permission of the endpoint the action calls; disabled without it. */
+    permission?: Permission | Permission[];
 } & ({
     to: string;
 } | {
@@ -855,7 +899,8 @@ interface DataTableProps$1<TData> {
     data?: TData[];
     columns: DataTableColumnDef<TData, any>[];
     filters?: DataTableFilter[];
-    commands?: DataTableCommand[];
+    /** A command with a `permission` is left out when the actor lacks it. */
+    commands?: PermissionedCommand<DataTableCommand>[];
     action?: DataTableActionProps;
     actions?: DataTableActionProps[];
     actionMenu?: DataTableActionMenuProps;
@@ -892,7 +937,7 @@ interface DataTableProps$1<TData> {
     };
     filterBarContent?: React__default.ReactNode;
 }
-declare const DataTable: <TData>({ data, columns, filters, commands, action, actions, actionMenu, getRowId, rowCount, enablePagination, enableSearch, autoFocusSearch: _autoFocusSearch, enableFilterMenu, rowHref, heading, headingLevel, subHeading, prefix, pageSize, emptyState, rowSelection, isLoading, layout, enableColumnVisibility, initialColumnVisibility, onColumnVisibilityChange, columnOrder, onColumnOrderChange, filterBarContent, }: DataTableProps$1<TData>) => react_jsx_runtime.JSX.Element;
+declare const DataTable: <TData>({ data, columns, filters, commands: declaredCommands, action, actions, actionMenu, getRowId, rowCount, enablePagination, enableSearch, autoFocusSearch: _autoFocusSearch, enableFilterMenu, rowHref, heading, headingLevel, subHeading, prefix, pageSize, emptyState, rowSelection, isLoading, layout, enableColumnVisibility, initialColumnVisibility, onColumnVisibilityChange, columnOrder, onColumnOrderChange, filterBarContent, }: DataTableProps$1<TData>) => react_jsx_runtime.JSX.Element;
 
 type FilterGroupProps = {
     filters: {
@@ -1296,6 +1341,9 @@ type BulkCommand = {
     label: string;
     shortcut: string;
     action: (selection: Record<string, boolean>) => Promise<void>;
+    /** Permission(s) of the endpoint the command calls; disabled without it. */
+    permission?: Permission | Permission[];
+    requireAll?: boolean;
 };
 interface DataTableRootProps<TData> {
     /**
@@ -1584,6 +1632,102 @@ declare const useResourcePermissions: (key: PermissionKey) => {
     isLoading: boolean;
 };
 
+type PermissionChecks = Pick<PermissionsContextValue, "hasAnyPermission" | "hasAllPermissions">;
+declare const toPermissionList: (permission?: Permission | Permission[]) => Permission[];
+/**
+ * A null `checks` means no provider is mounted (public routes); nothing is
+ * enforced there, so everything is permitted.
+ */
+declare const isPermitted: (checks: PermissionChecks | null, permission?: Permission | Permission[], requireAll?: boolean) => boolean;
+/** Same check against a raw permission map, for code outside React. */
+declare const permissionMapAllows: (map: PermissionMap | null | undefined, permission: Permission | Permission[], requireAll?: boolean) => boolean;
+/** True for a 403 from the API (`ClientError.status`). */
+declare const isForbidden: (error: unknown) => boolean;
+
+/**
+ * @example
+ * ```tsx
+ * const canViewCustomers = useCan("customers")
+ *
+ * useCustomers(query, { enabled: canViewCustomers })
+ * ```
+ */
+declare const useCan: (key: PermissionKey, right?: PermissionRight) => boolean;
+
+/**
+ * For controls that stay visible but must not fire when the actor lacks the
+ * permission of the endpoint they call.
+ *
+ * @example
+ * ```tsx
+ * const gate = usePermissionGate("orders:edit")
+ *
+ * <Tooltip content={gate.tooltip}>
+ *   <Button disabled={gate.denied}>Cancel</Button>
+ * </Tooltip>
+ * ```
+ */
+declare const usePermissionGate: (permission?: Permission | Permission[], requireAll?: boolean) => {
+    allowed: boolean;
+    denied: boolean;
+    tooltip: string | undefined;
+};
+
+type ActionElementProps = {
+    disabled?: boolean;
+    asChild?: boolean;
+    children?: ReactNode;
+};
+type PermissionActionProps = {
+    permission: Permission | Permission[];
+    /** When several permissions are given, require all of them. Defaults to any. */
+    requireAll?: boolean;
+    children: ReactElement<ActionElementProps>;
+};
+/**
+ * Disables a button (or a button wrapping a link) with a tooltip when the
+ * actor lacks the permission of the endpoint it calls.
+ *
+ * @example
+ * ```tsx
+ * <PermissionAction permission="products:edit">
+ *   <Button size="small" variant="secondary" asChild>
+ *     <Link to="create">Create</Link>
+ *   </Button>
+ * </PermissionAction>
+ * ```
+ */
+declare const PermissionAction: ({ permission, requireAll, children, }: PermissionActionProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Inline state for a section whose data the actor may not read. Sections
+ * render this for a 403 instead of throwing to the page's error boundary.
+ */
+declare const SectionNoAccess: ({ className }: {
+    className?: string;
+}) => react_jsx_runtime.JSX.Element;
+
+type Loader<TArgs, TResult> = (args: TArgs) => TResult | Promise<TResult>;
+/**
+ * Loaders run before `RoutePermissionGuard` (an element) gets to refuse the
+ * route, so a loader has to check the permission itself. A denied loader
+ * resolves to `null`. The return type stays the loader's own because the guard
+ * renders Access Denied instead of the page, so nothing ever reads that value.
+ *
+ * @example
+ * ```ts
+ * export const withPermission = createWithPermission(async () => {
+ *   const { user } = await queryClient.ensureQueryData(meQueryOptions())
+ *   return user.permissions ?? null
+ * })
+ *
+ * export const loader = withPermission(productLoader, "products:view")
+ * ```
+ */
+declare const createWithPermission: (getPermissions: () => Promise<PermissionMap | null | undefined>) => <TArgs, TResult>(loader: Loader<TArgs, TResult>, permission: Permission | Permission[], options?: {
+    requireAll?: boolean;
+}) => (args: TArgs) => Promise<TResult>;
+
 /**
  * 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
@@ -1645,6 +1789,7 @@ type Widget = {
     }>;
     zone: string[];
     widgetId: string;
+    permission?: Permission[];
 };
 type WidgetModule = {
     widgets?: Widget[];
@@ -1666,6 +1811,7 @@ type ResolvedDisplays = {
 type ResolvedWidget = {
     Component: Widget["Component"];
     widgetId: string;
+    permission?: Permission[];
 };
 type ZoneWidgets = {
     before: ResolvedWidget[];
@@ -2037,4 +2183,4 @@ 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 };
+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, PermissionAction, type PermissionActionProps, PermissionGuard, type PermissionGuardProps, type PermissionedCommand, 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, SectionNoAccess, 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, applyActionPermissions, applyNavOverrides, buildAdditionalDataDefaults, buildAdditionalDataSchema, buildOfferGridData, buildProductChangeView, countries, createDataGridHelper, createDataGridPriceColumns, createFormHelper, createWithPermission, currencies, extractPricesFromOffers, extractReferenceIds, filterCommandsByPermission, formatFieldValue, genericForwardRef, getCountryByIso2, getCurrencySymbol, getDecimalDigits, getExtensionRegistry, getFormattedAddress, getFormattedCountry, getLinkQuery, getLocaleAmount, getNativeSymbol, getPriceListStatus, getStylizedAmount, humanizeFieldName, isAmountLessThenRoundingError, isForbidden, isHtml, isImageList, isOrderActionable, isOrderAwaitingAction, isPermitted, isPriceListGroupRow, isProductRow, isReferenceField, isSameAddress, linkFields, permissionMapAllows, plainTextToHtml, productChangeViewHasContent, queryClient, queryKeysFactory, richTextContentClasses, sanitizeRichText, toPermissionList, useActionLocks, useCan, useCollapsedSidebar, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDisplayFieldOverride, useDocumentDirection, useExpandedSidebar, useExtendableForm, useExtendableTable, useExtension, useExtensionActivity, useLinkQuery, usePermissionGate, usePermissions, usePermittedCommands, useQueryParams, useResourcePermissions, useRouteModal, useSidebar, useSidebarMenuPlacement, useStackedModal, useTabManagement, useTabbedForm, withLinkFields };