@mercurjs/dashboard-shared 2.1.2 → 2.2.0-canary.2

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { QueryKey, UseQueryOptions } from '@tanstack/react-query';
+import { ProductChangeActionDTO, HttpTypes } from '@mercurjs/types';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
 import React__default, { ReactNode, PropsWithChildren, ComponentPropsWithoutRef, CSSProperties, ComponentType, Ref, RefCallback } from 'react';
 import { Tooltip, Heading, Text, DataTableColumnDef, DataTableFilter, DataTableCommand, DataTableEmptyStateProps, DataTableRowSelectionState, DataTableRow, Drawer, FocusModal, ProgressStatus } from '@medusajs/ui';
-import { HttpTypes } from '@mercurjs/types';
 import * as react_hook_form from 'react-hook-form';
 import { FieldValues, FieldPath, ControllerProps, UseFormReturn, Control } from 'react-hook-form';
 import { Label, Slot } from 'radix-ui';
@@ -33,6 +33,31 @@ type TQueryKey<TKey, TListQuery = any, TDetailQuery = string> = {
 type UseQueryOptionsWrapper<TQueryFn = unknown, E = Error, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFn, E, TQueryFn, TQueryKey>, "queryKey" | "queryFn">;
 declare const queryKeysFactory: <T, TListQueryType = any, TDetailQueryType = string>(globalKey: T) => TQueryKey<T, TListQueryType, TDetailQueryType>;
 
+type FieldDiff = {
+    field: string;
+    previous: unknown;
+    next: unknown;
+};
+type ProductChangePartition = {
+    updated: FieldDiff[];
+    added: ProductChangeActionDTO[];
+    removed: ProductChangeActionDTO[];
+    deleteRequested: boolean;
+};
+type ReferenceField = "brand_id" | "type_id" | "collection_id" | "categories" | "tags";
+declare const REFERENCE_FIELDS: ReferenceField[];
+declare const isReferenceField: (field: string) => field is ReferenceField;
+declare const isImageList: (value: unknown) => value is {
+    url: string;
+}[];
+declare const extractReferenceIds: (field: ReferenceField, value: unknown) => string[];
+declare const humanizeFieldName: (field: string) => string;
+declare const formatFieldValue: (value: unknown, field?: string) => string;
+declare const partitionProductChangeActions: (actions: ProductChangeActionDTO[]) => ProductChangePartition;
+declare const describeProductChangeAction: (action: ProductChangeActionDTO, fallbacks: {
+    variant: string;
+}) => string;
+
 type Action = {
     icon: ReactNode;
     label: string;
@@ -100,6 +125,56 @@ type ConditionalTooltipProps = PropsWithChildren<ComponentPropsWithoutRef<typeof
 }>;
 declare const ConditionalTooltip: ({ children, showTooltip, ...props }: ConditionalTooltipProps) => string | number | boolean | Iterable<React$1.ReactNode> | react_jsx_runtime.JSX.Element | null | undefined;
 
+type ConfirmPromptProps = {
+    /**
+     * Whether the prompt is visible. Controlled — pair with `onOpenChange`.
+     */
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    /**
+     * Visual variant of the underlying `@medusajs/ui` Prompt.
+     * Defaults to `confirmation`.
+     */
+    variant?: "confirmation" | "danger";
+    title: string;
+    description?: ReactNode;
+    /**
+     * When provided, a `<Textarea>` is rendered between the description and the
+     * footer. The current value is forwarded to `onConfirm`. Omit this prop to
+     * render a plain confirmation prompt with no input.
+     */
+    noteLabel?: string;
+    noteOptional?: boolean;
+    notePlaceholder?: string;
+    /**
+     * Initial note value. Reset to this whenever `open` transitions to `true`.
+     */
+    defaultNote?: string;
+    cancelLabel?: string;
+    confirmLabel?: string;
+    /**
+     * Disables the inputs and footer buttons, and blocks `onOpenChange` from
+     * closing the dialog while a submit is in flight.
+     */
+    isLoading?: boolean;
+    /**
+     * Called when the user clicks Confirm. Receives the trimmed note (or
+     * `undefined` when no note input is rendered or the field is empty).
+     * The parent is responsible for closing the dialog once submission resolves.
+     */
+    onConfirm: (note: string | undefined) => void | Promise<void>;
+};
+/**
+ * Reusable confirmation prompt with an optional note input. Mirrors Medusa's
+ * `@medusajs/ui` `Prompt` shape — title, description, footer — with an
+ * optional `<Textarea>` slotted between the description and the footer.
+ *
+ * Use for destructive or significant actions where the operator should be
+ * able to attach a short note. For pure yes/no confirmations, prefer the
+ * `usePrompt` hook from `@medusajs/ui`.
+ */
+declare const ConfirmPrompt: ({ open, onOpenChange, variant, title, description, noteLabel, noteOptional, notePlaceholder, defaultNote, cancelLabel, confirmLabel, isLoading, onConfirm, }: ConfirmPromptProps) => react_jsx_runtime.JSX.Element;
+
 declare const CustomerInfo: {
     ID: ({ data }: {
         data: HttpTypes.AdminOrder;
@@ -1099,4 +1174,4 @@ type QueryParams<T extends string> = {
 };
 declare function useQueryParams<T extends string>(keys: T[], prefix?: string): QueryParams<T>;
 
-export { type Action, type ActionGroup, ActionMenu, AddressForm, BadgeListSummary, ChipGroup, CodeCell, CodeHeader, type Command, ConditionalTooltip, CreatedAtCell, CreatedAtHeader, CustomerInfo, DataGrid, DataTable, DateCell, DateHeader, DateRangeDisplay, EmailCell, EmailForm, EmailHeader, FilePreview, type FileType, FileUpload, type FileUploadProps, type Filter, FilterGroup, Form, GeneralSectionSkeleton, HeadingSkeleton, IconAvatar, IconButtonSkeleton, ImageAvatar, IncludesTaxTooltip, InfiniteList, JsonViewSection, JsonViewSectionSkeleton, LinkButton, ListSummary, Listicle, type ListicleProps, MetadataForm, MetadataSection, MoneyAmountCell, NameCell, NameHeader, NoRecords, NoResults, type NoResultsProps, OrderBy, PlaceholderCell, ProgressBar, Query, RouteDrawer, RouteFocusModal, SectionRow, type SectionRowProps, SegmentedControl, type SegmentedControlOption, SidebarLink, type SidebarLinkProps, SingleColumnPage, SingleColumnPageSkeleton, Skeleton, SortableList, SortableTree, StackedDrawer, StackedFocusModal, StatusCell, SwitchBox, type TQueryKey, type TabDefinition, TabbedForm, TableFooterSkeleton, TableSectionSkeleton, TableSkeleton, TextCell, TextHeader, TextSkeleton, Thumbnail, TwoColumnPage, TwoColumnPageSkeleton, type UseQueryOptionsWrapper, _DataTable, createDataGridHelper, createDataGridPriceColumns, queryKeysFactory, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDocumentDirection, useQueryParams, useRouteModal, useStackedModal, useTabManagement, useTabbedForm };
+export { type Action, type ActionGroup, ActionMenu, AddressForm, BadgeListSummary, ChipGroup, CodeCell, CodeHeader, type Command, ConditionalTooltip, ConfirmPrompt, type ConfirmPromptProps, CreatedAtCell, CreatedAtHeader, CustomerInfo, DataGrid, DataTable, DateCell, DateHeader, DateRangeDisplay, EmailCell, EmailForm, EmailHeader, type FieldDiff, FilePreview, type FileType, FileUpload, type FileUploadProps, type Filter, FilterGroup, Form, GeneralSectionSkeleton, HeadingSkeleton, IconAvatar, IconButtonSkeleton, ImageAvatar, IncludesTaxTooltip, InfiniteList, JsonViewSection, JsonViewSectionSkeleton, LinkButton, ListSummary, Listicle, type ListicleProps, MetadataForm, MetadataSection, MoneyAmountCell, NameCell, NameHeader, NoRecords, NoResults, type NoResultsProps, OrderBy, PlaceholderCell, type ProductChangePartition, ProgressBar, Query, REFERENCE_FIELDS, type ReferenceField, RouteDrawer, RouteFocusModal, SectionRow, type SectionRowProps, SegmentedControl, type SegmentedControlOption, SidebarLink, type SidebarLinkProps, SingleColumnPage, SingleColumnPageSkeleton, Skeleton, SortableList, SortableTree, StackedDrawer, StackedFocusModal, StatusCell, SwitchBox, type TQueryKey, type TabDefinition, TabbedForm, TableFooterSkeleton, TableSectionSkeleton, TableSkeleton, TextCell, TextHeader, TextSkeleton, Thumbnail, TwoColumnPage, TwoColumnPageSkeleton, type UseQueryOptionsWrapper, _DataTable, createDataGridHelper, createDataGridPriceColumns, describeProductChangeAction, extractReferenceIds, formatFieldValue, humanizeFieldName, isImageList, isReferenceField, partitionProductChangeActions, queryKeysFactory, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDocumentDirection, useQueryParams, useRouteModal, useStackedModal, useTabManagement, useTabbedForm };