@mercurjs/dashboard-shared 2.2.0-canary.3 → 2.2.0-canary.30

package/dist/index.d.ts

@@ -33,18 +33,50 @@ 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 ImageRef = {
+    url: string;
+};
+type MediaDiff = {
+    added: ImageRef[];
+    removed: ImageRef[];
+};
 type FieldDiff = {
     field: string;
     previous: unknown;
     next: unknown;
-};
-type ProductChangePartition = {
-    updated: FieldDiff[];
-    added: ProductChangeActionDTO[];
-    removed: ProductChangeActionDTO[];
+    variant_id?: string;
+};
+type AttributeChangeKind = "added" | "removed" | "updated";
+type AttributeChange = {
+    kind: AttributeChangeKind;
+    /** Set for existing (catalog) attributes referenced by id. */
+    attributeId?: string;
+    /** Set for inline attributes created in the same request (no id yet). */
+    inlineTitle?: string;
+    /** Value ids to associate / add (select types or shared axis subset). */
+    addValueIds: string[];
+    /** New value names to create (inline / exclusive axis). */
+    addValueNames: string[];
+    /** Value ids removed (updates only). */
+    removeValueIds: string[];
+    /** Free-form scalar for text / unit / toggle attributes. */
+    scalarValue?: string | number | boolean;
+};
+type VariantGroup = {
+    variantId: string;
+    fieldDiffs: FieldDiff[];
+    media: MediaDiff;
+};
+type ProductChangeView = {
+    productUpdated: FieldDiff[];
+    productMedia: MediaDiff;
+    attributes: AttributeChange[];
+    variantsAdded: ProductChangeActionDTO[];
+    variantsRemoved: ProductChangeActionDTO[];
+    variantGroups: VariantGroup[];
     deleteRequested: boolean;
 };
-type ReferenceField = "brand_id" | "type_id" | "collection_id" | "categories" | "tags";
+type ReferenceField = "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 {
@@ -52,11 +84,13 @@ declare const isImageList: (value: unknown) => value is {
 }[];
 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 BooleanLabels = {
+    true: string;
+    false: string;
+};
+declare const formatFieldValue: (value: unknown, field?: string, booleanLabels?: BooleanLabels) => string;
+declare const buildProductChangeView: (actions: ProductChangeActionDTO[]) => ProductChangeView;
+declare const productChangeViewHasContent: (view: ProductChangeView) => boolean;
 
 type Action = {
     icon: ReactNode;
@@ -340,6 +374,57 @@ type MetadataSectionProps<TData extends object> = {
 };
 declare const MetadataSection: <TData extends object>({ data, href, }: MetadataSectionProps<TData>) => react_jsx_runtime.JSX.Element | null;
 
+type WrappedAttributeValue = {
+    id: string;
+    name?: string | null;
+};
+type ProductChangeAttribute = {
+    id: string;
+    name?: string | null;
+    /** Values currently selected on the product (the "previous" side). */
+    values?: WrappedAttributeValue[] | null;
+    /** Every possible value of the attribute, used to resolve value ids. */
+    all_values?: WrappedAttributeValue[] | null;
+};
+type ProductChangeVariant = {
+    id: string;
+    title?: string | null;
+    sku?: string | null;
+    images?: {
+        url: string;
+    }[] | null;
+};
+type ProductChangeProduct = {
+    id: string;
+    title?: string | null;
+    thumbnail?: string | null;
+    variants?: (ProductChangeVariant | null)[] | null;
+    attributes?: ProductChangeAttribute[] | null;
+};
+type ResolvedAttribute = {
+    name: string;
+    values: {
+        id: string;
+        name: string;
+    }[];
+};
+type ProductChangeResolvers = {
+    getType: (id: string) => Promise<string | null | undefined>;
+    getCollection: (id: string) => Promise<string | null | undefined>;
+    getCategory: (id: string) => Promise<string | null | undefined>;
+    getTag: (id: string) => Promise<string | null | undefined>;
+    getAttribute: (id: string) => Promise<ResolvedAttribute | null | undefined>;
+    getVariant: (variantId: string) => Promise<ProductChangeVariant | null | undefined>;
+};
+type ProductChangePanelProps = {
+    product: ProductChangeProduct;
+    actions: ProductChangeActionDTO[];
+    resolvers: ProductChangeResolvers;
+    headerDescription?: ReactNode;
+    footer?: ReactNode;
+};
+declare const ProductChangePanel: ({ product, actions, resolvers, headerDescription, footer, }: ProductChangePanelProps) => react_jsx_runtime.JSX.Element | null;
+
 interface ProgressBarProps {
     /**
      * The duration of the animation in seconds.
@@ -1174,4 +1259,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, 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 };
+export { type Action, type ActionGroup, ActionMenu, AddressForm, type AttributeChange, type AttributeChangeKind, 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, type ImageRef, IncludesTaxTooltip, InfiniteList, JsonViewSection, JsonViewSectionSkeleton, LinkButton, ListSummary, Listicle, type ListicleProps, type MediaDiff, MetadataForm, MetadataSection, MoneyAmountCell, NameCell, NameHeader, NoRecords, NoResults, type NoResultsProps, OrderBy, PlaceholderCell, type ProductChangeAttribute, ProductChangePanel, type ProductChangePanelProps, type ProductChangeProduct, type ProductChangeResolvers, type ProductChangeVariant, type ProductChangeView, ProgressBar, Query, REFERENCE_FIELDS, type ReferenceField, type ResolvedAttribute, 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, type VariantGroup, _DataTable, buildProductChangeView, createDataGridHelper, createDataGridPriceColumns, extractReferenceIds, formatFieldValue, humanizeFieldName, isImageList, isReferenceField, productChangeViewHasContent, queryKeysFactory, useCombinedRefs, useCommandHistory, useDataTable, useDate, useDocumentDirection, useQueryParams, useRouteModal, useStackedModal, useTabManagement, useTabbedForm };