@vendure/dashboard 3.3.6-master-202507090236 → 3.3.6-master-202507110238

package/src/lib/components/data-input/relation-selector.tsx

@@ -40,6 +40,12 @@ export interface RelationSelectorConfig<T = any> {
 
 export interface RelationSelectorProps<T = any> {
     config: RelationSelectorConfig<T>;
+    /**
+     * @description
+     * The label for the selector trigger. Default is
+     * "Select item" for single select and "Select items" for multi select.
+     */
+    selectorLabel?: React.ReactNode;
     value?: string | string[];
     onChange: (value: string | string[]) => void;
     disabled?: boolean;
@@ -186,6 +192,7 @@ export function RelationSelector<T>({
     onChange,
     disabled,
     className,
+    selectorLabel,
 }: Readonly<RelationSelectorProps<T>>) {
     const [open, setOpen] = useState(false);
     const [selectedItemsCache, setSelectedItemsCache] = useState<T[]>([]);
@@ -396,10 +403,10 @@ export function RelationSelector<T>({
                             {isMultiple
                                 ? selectedItems.length > 0
                                     ? `Add more (${selectedItems.length} selected)`
-                                    : 'Select items'
+                                    : selectorLabel ?? <Trans>Select items</Trans>
                                 : selectedItems.length > 0
                                   ? 'Change selection'
-                                  : 'Select item'}
+                                  : selectorLabel ?? <Trans>Select item</Trans>}
                         </Trans>
                     </Button>
                 </PopoverTrigger>

package/src/lib/components/data-table/data-table-utils.ts

@@ -0,0 +1,34 @@
+import { FieldInfo } from '@/vdb/framework/document-introspection/get-document-structure.js';
+
+/**
+ * Returns the default column visibility configuration.
+ *
+ * @example
+ * ```ts
+ * const columnVisibility = getColumnVisibility(fields, {
+ *     id: false,
+ *     createdAt: false,
+ *     updatedAt: false,
+ * });
+ * ```
+ */
+export function getColumnVisibility(
+    fields: FieldInfo[],
+    defaultVisibility?: Record<string, boolean | undefined>,
+    customFieldColumnNames?: string[],
+): Record<string, boolean> {
+    const allDefaultsTrue = defaultVisibility && Object.values(defaultVisibility).every(v => v === true);
+    const allDefaultsFalse = defaultVisibility && Object.values(defaultVisibility).every(v => v === false);
+    return {
+        id: false,
+        createdAt: false,
+        updatedAt: false,
+        ...(allDefaultsTrue ? { ...Object.fromEntries(fields.map(f => [f.name, false])) } : {}),
+        ...(allDefaultsFalse ? { ...Object.fromEntries(fields.map(f => [f.name, true])) } : {}),
+        // Make custom fields hidden by default unless overridden
+        ...(customFieldColumnNames
+            ? { ...Object.fromEntries(customFieldColumnNames.map(f => [f, false])) }
+            : {}),
+        ...defaultVisibility,
+    };
+}

package/src/lib/components/data-table/data-table-view-options.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-import { DndContext, closestCenter } from '@dnd-kit/core';
+import { closestCenter, DndContext } from '@dnd-kit/core';
 import { restrictToVerticalAxis } from '@dnd-kit/modifiers';
 import { SortableContext, useSortable, verticalListSortingStrategy } from '@dnd-kit/sortable';
 import { CSS } from '@dnd-kit/utilities';
@@ -83,7 +83,7 @@ export function DataTableViewOptions<TData>({ table }: DataTableViewOptionsProps
                         <Trans>Columns</Trans>
                     </Button>
                 </DropdownMenuTrigger>
-                <DropdownMenuContent align="end" className="w-[150px]">
+                <DropdownMenuContent align="end">
                     <DndContext
                         collisionDetection={closestCenter}
                         onDragEnd={handleDragEnd}

package/src/lib/components/data-table/data-table.tsx

@@ -36,6 +36,7 @@ export interface FacetedFilter {
 }
 
 interface DataTableProps<TData> {
+    children?: React.ReactNode;
     columns: ColumnDef<TData, any>[];
     data: TData[];
     totalItems: number;
@@ -62,6 +63,7 @@ interface DataTableProps<TData> {
 }
 
 export function DataTable<TData>({
+    children,
     columns,
     data,
     totalItems,
@@ -178,7 +180,7 @@ export function DataTable<TData>({
                                 />
                             ))}
                         </Suspense>
-                        <AddFilterMenu columns={table.getAllColumns()} />
+                        {onFilterChange && <AddFilterMenu columns={table.getAllColumns()} />}
                     </div>
                     <div className="flex gap-1">
                         {columnFilters
@@ -266,11 +268,12 @@ export function DataTable<TData>({
                                 </TableCell>
                             </TableRow>
                         )}
+                        {children}
                     </TableBody>
                 </Table>
                 <DataTableBulkActions bulkActions={bulkActions ?? []} table={table} />
             </div>
-            <DataTablePagination table={table} />
+            {onPageChange && totalItems != null && <DataTablePagination table={table} />}
         </>
     );
 }

package/src/lib/components/data-table/use-generated-columns.tsx

@@ -0,0 +1,307 @@
+import { DisplayComponent } from '@/vdb/framework/component-registry/dynamic-component.js';
+import { FieldInfo, getTypeFieldInfo } from '@/vdb/framework/document-introspection/get-document-structure.js';
+import { api } from '@/vdb/graphql/api.js';
+import { Trans, useLingui } from '@/vdb/lib/trans.js';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { useMutation } from '@tanstack/react-query';
+import { AccessorKeyColumnDef, createColumnHelper, Row } from '@tanstack/react-table';
+import { EllipsisIcon, TrashIcon } from 'lucide-react';
+import { useMemo } from 'react';
+import { toast } from 'sonner';
+import {
+    AdditionalColumns,
+    AllItemFieldKeys,
+    CustomizeColumnConfig,
+    FacetedFilterConfig,
+    PaginatedListItemFields,
+    RowAction,
+    usePaginatedList,
+} from '../shared/paginated-list-data-table.js';
+import {
+    AlertDialog,
+    AlertDialogAction,
+    AlertDialogCancel,
+    AlertDialogContent,
+    AlertDialogDescription,
+    AlertDialogFooter,
+    AlertDialogHeader,
+    AlertDialogTitle,
+    AlertDialogTrigger,
+} from '../ui/alert-dialog.js';
+import { Button } from '../ui/button.js';
+import { Checkbox } from '../ui/checkbox.js';
+import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from '../ui/dropdown-menu.js';
+import { DataTableColumnHeader } from './data-table-column-header.js';
+
+/**
+ * @description
+ * This hook is used to generate the columns for a data table, combining the fields
+ * from the query with the additional columns and the custom fields.
+ *
+ * It also
+ * - adds the row actions and the delete mutation.
+ * - adds the row selection column.
+ * - adds the custom field columns.
+ */
+export function useGeneratedColumns<T extends TypedDocumentNode<any, any>>({
+    fields,
+    customizeColumns,
+    rowActions,
+    deleteMutation,
+    additionalColumns,
+    defaultColumnOrder,
+    facetedFilters,
+    includeSelectionColumn = true,
+    includeActionsColumn = true,
+    enableSorting = true,
+}: Readonly<{
+    fields: FieldInfo[];
+    customizeColumns?: CustomizeColumnConfig<T>;
+    rowActions?: RowAction<PaginatedListItemFields<T>>[];
+    deleteMutation?: TypedDocumentNode<any, any>;
+    additionalColumns?: AdditionalColumns<T>;
+    defaultColumnOrder?: Array<string | number | symbol>;
+    facetedFilters?: FacetedFilterConfig<T>;
+    includeSelectionColumn?: boolean;
+    includeActionsColumn?: boolean;
+    enableSorting?: boolean;
+}>) {
+    const columnHelper = createColumnHelper<PaginatedListItemFields<T>>();
+
+    const { columns, customFieldColumnNames } = useMemo(() => {
+        const columnConfigs: Array<{ fieldInfo: FieldInfo; isCustomField: boolean }> = [];
+        const customFieldColumnNames: string[] = [];
+
+        columnConfigs.push(
+            ...fields // Filter out custom fields
+                .filter(field => field.name !== 'customFields' && !field.type.endsWith('CustomFields'))
+                .map(field => ({ fieldInfo: field, isCustomField: false })),
+        );
+
+        const customFieldColumn = fields.find(field => field.name === 'customFields');
+        if (customFieldColumn && customFieldColumn.type !== 'JSON') {
+            const customFieldFields = getTypeFieldInfo(customFieldColumn.type);
+            columnConfigs.push(
+                ...customFieldFields.map(field => ({ fieldInfo: field, isCustomField: true })),
+            );
+            customFieldColumnNames.push(...customFieldFields.map(field => field.name));
+        }
+
+        const queryBasedColumns = columnConfigs.map(({ fieldInfo, isCustomField }) => {
+            const customConfig = customizeColumns?.[fieldInfo.name as unknown as AllItemFieldKeys<T>] ?? {};
+            const { header, ...customConfigRest } = customConfig;
+            const enableColumnFilter = fieldInfo.isScalar && !facetedFilters?.[fieldInfo.name];
+
+            return columnHelper.accessor(fieldInfo.name as any, {
+                id: fieldInfo.name,
+                meta: { fieldInfo, isCustomField },
+                enableColumnFilter,
+                enableSorting: fieldInfo.isScalar && enableSorting,
+                // Filtering is done on the server side, but we set this to 'equalsString' because
+                // otherwise the TanStack Table with apply an "auto" function which somehow
+                // prevents certain filters from working.
+                filterFn: 'equalsString',
+                cell: ({ cell, row }) => {
+                    const cellValue = cell.getValue();
+                    const value =
+                        cellValue ??
+                        (isCustomField ? row.original?.customFields?.[fieldInfo.name] : undefined);
+
+                    if (fieldInfo.list && Array.isArray(value)) {
+                        return value.join(', ');
+                    }
+                    if (
+                        (fieldInfo.type === 'DateTime' && typeof value === 'string') ||
+                        value instanceof Date
+                    ) {
+                        return <DisplayComponent id="vendure:dateTime" value={value} />;
+                    }
+                    if (fieldInfo.type === 'Boolean') {
+                        if (cell.column.id === 'enabled') {
+                            return <DisplayComponent id="vendure:booleanBadge" value={value} />;
+                        } else {
+                            return <DisplayComponent id="vendure:booleanCheckbox" value={value} />;
+                        }
+                    }
+                    if (fieldInfo.type === 'Asset') {
+                        return <DisplayComponent id="vendure:asset" value={value} />;
+                    }
+                    if (value !== null && typeof value === 'object') {
+                        return JSON.stringify(value);
+                    }
+                    return value;
+                },
+                header: headerContext => {
+                    return (
+                        <DataTableColumnHeader headerContext={headerContext} customConfig={customConfig} />
+                    );
+                },
+                ...customConfigRest,
+            });
+        });
+
+        let finalColumns = [...queryBasedColumns];
+
+        for (const [id, column] of Object.entries(additionalColumns ?? {})) {
+            if (!id) {
+                throw new Error('Column id is required');
+            }
+            finalColumns.push(columnHelper.accessor(id as any, { ...column, id }));
+        }
+
+        if (defaultColumnOrder) {
+            // ensure the columns with ids matching the items in defaultColumnOrder
+            // appear as the first columns in sequence, and leave the remainder in the
+            // existing order
+            const orderedColumns = finalColumns
+                .filter(column => column.id && defaultColumnOrder.includes(column.id as any))
+                .sort(
+                    (a, b) =>
+                        defaultColumnOrder.indexOf(a.id as any) - defaultColumnOrder.indexOf(b.id as any),
+                );
+            const remainingColumns = finalColumns.filter(
+                column => !column.id || !defaultColumnOrder.includes(column.id as any),
+            );
+            finalColumns = [...orderedColumns, ...remainingColumns];
+        }
+
+        if (includeActionsColumn && (rowActions || deleteMutation)) {
+            const rowActionColumn = getRowActions(rowActions, deleteMutation);
+            if (rowActionColumn) {
+                finalColumns.push(rowActionColumn);
+            }
+        }
+
+        if (includeSelectionColumn) {
+            // Add the row selection column
+            finalColumns.unshift({
+                id: 'selection',
+                accessorKey: 'selection',
+                header: ({ table }) => (
+                    <Checkbox
+                        className="mx-1"
+                        checked={table.getIsAllRowsSelected()}
+                        onCheckedChange={checked =>
+                            table.toggleAllRowsSelected(checked === 'indeterminate' ? undefined : checked)
+                        }
+                    />
+                ),
+                enableColumnFilter: false,
+                cell: ({ row }) => {
+                    return (
+                        <Checkbox
+                            className="mx-1"
+                            checked={row.getIsSelected()}
+                            onCheckedChange={row.getToggleSelectedHandler()}
+                        />
+                    );
+                },
+            });
+        }
+
+        return { columns: finalColumns, customFieldColumnNames };
+    }, [fields, customizeColumns, rowActions, deleteMutation, additionalColumns, defaultColumnOrder]);
+
+    return { columns, customFieldColumnNames };
+}
+
+function getRowActions(
+    rowActions?: RowAction<any>[],
+    deleteMutation?: TypedDocumentNode<any, any>,
+): AccessorKeyColumnDef<any> | undefined {
+    return {
+        id: 'actions',
+        accessorKey: 'actions',
+        header: () => <Trans>Actions</Trans>,
+        enableColumnFilter: false,
+        cell: ({ row }) => {
+            return (
+                <DropdownMenu>
+                    <DropdownMenuTrigger asChild>
+                        <Button variant="ghost" size="icon">
+                            <EllipsisIcon />
+                        </Button>
+                    </DropdownMenuTrigger>
+                    <DropdownMenuContent>
+                        {rowActions?.map((action, index) => (
+                            <DropdownMenuItem
+                                onClick={() => action.onClick?.(row)}
+                                key={`${action.label}-${index}`}
+                            >
+                                {action.label}
+                            </DropdownMenuItem>
+                        ))}
+                        {deleteMutation && (
+                            <DeleteMutationRowAction deleteMutation={deleteMutation} row={row} />
+                        )}
+                    </DropdownMenuContent>
+                </DropdownMenu>
+            );
+        },
+    };
+}
+
+function DeleteMutationRowAction({
+    deleteMutation,
+    row,
+}: Readonly<{
+    deleteMutation: TypedDocumentNode<any, any>;
+    row: Row<{ id: string }>;
+}>) {
+    const { refetchPaginatedList } = usePaginatedList();
+    const { i18n } = useLingui();
+    const { mutate: deleteMutationFn } = useMutation({
+        mutationFn: api.mutate(deleteMutation),
+        onSuccess: (result: { [key: string]: { result: 'DELETED' | 'NOT_DELETED'; message: string } }) => {
+            const unwrappedResult = Object.values(result)[0];
+            if (unwrappedResult.result === 'DELETED') {
+                refetchPaginatedList();
+                toast.success(i18n.t('Deleted successfully'));
+            } else {
+                toast.error(i18n.t('Failed to delete'), {
+                    description: unwrappedResult.message,
+                });
+            }
+        },
+        onError: (err: Error) => {
+            toast.error(i18n.t('Failed to delete'), {
+                description: err.message,
+            });
+        },
+    });
+    return (
+        <AlertDialog>
+            <AlertDialogTrigger asChild>
+                <DropdownMenuItem onSelect={e => e.preventDefault()}>
+                    <div className="flex items-center gap-2 text-destructive">
+                        <TrashIcon className="w-4 h-4 text-destructive" />
+                        <Trans>Delete</Trans>
+                    </div>
+                </DropdownMenuItem>
+            </AlertDialogTrigger>
+            <AlertDialogContent>
+                <AlertDialogHeader>
+                    <AlertDialogTitle>
+                        <Trans>Confirm deletion</Trans>
+                    </AlertDialogTitle>
+                    <AlertDialogDescription>
+                        <Trans>
+                            Are you sure you want to delete this item? This action cannot be undone.
+                        </Trans>
+                    </AlertDialogDescription>
+                </AlertDialogHeader>
+                <AlertDialogFooter>
+                    <AlertDialogCancel>
+                        <Trans>Cancel</Trans>
+                    </AlertDialogCancel>
+                    <AlertDialogAction
+                        onClick={() => deleteMutationFn({ id: row.original.id })}
+                        className="bg-destructive text-destructive-foreground hover:bg-destructive/90"
+                    >
+                        <Trans>Delete</Trans>
+                    </AlertDialogAction>
+                </AlertDialogFooter>
+            </AlertDialogContent>
+        </AlertDialog>
+    );
+}