@vendure/dashboard 3.2.0

package/src/app/routes/_authenticated/_product-variants/product-variants.tsx

@@ -0,0 +1,78 @@
+import { Money } from '@/components/data-display/money.js';
+import { DetailPageButton } from '@/components/shared/detail-page-button.js';
+import { PageActionBar } from '@/framework/layout-engine/page-layout.js';
+import { ListPage } from '@/framework/page/list-page.js';
+import { useLocalFormat } from '@/hooks/use-local-format.js';
+import { Trans } from '@/lib/trans.js';
+import { createFileRoute } from '@tanstack/react-router';
+import { deleteProductVariantDocument, productVariantListDocument } from './product-variants.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_product-variants/product-variants')({
+    component: ProductListPage,
+    loader: () => ({ breadcrumb: () => <Trans>Product Variants</Trans> }),
+});
+
+function ProductListPage() {
+    const { formatCurrencyName } = useLocalFormat();
+    return (
+        <ListPage
+            pageId="product-variant-list"
+            title={<Trans>Product Variants</Trans>}
+            listQuery={productVariantListDocument}
+            deleteMutation={deleteProductVariantDocument}
+            customizeColumns={{
+                name: {
+                    header: 'Product Name',
+                    cell: ({ row }) => <DetailPageButton id={row.original.id} label={row.original.name} />,
+                },
+                currencyCode: {
+                    cell: ({ cell, row }) => {
+                        const value = cell.getValue();
+                        return formatCurrencyName(value as string, 'full');
+                    },
+                },
+                price: {
+                    cell: ({ cell, row }) => {
+                        const value = cell.getValue();
+                        const currencyCode = row.original.currencyCode;
+                        if (typeof value === 'number') {
+                            return <Money value={value} currency={currencyCode} />;
+                        }
+                        return value;
+                    },
+                },
+                priceWithTax: {
+                    cell: ({ cell, row }) => {
+                        const value = cell.getValue();
+                        const currencyCode = row.original.currencyCode;
+                        if (typeof value === 'number') {
+                            return <Money value={value} currency={currencyCode} />;
+                        }
+                        return value;
+                    },
+                },
+                stockLevels: {
+                    cell: ({ cell, row }) => {
+                        const value = cell.getValue();
+                        if (Array.isArray(value)) {
+                            const totalOnHand = value.reduce((acc, curr) => acc + curr.stockOnHand, 0);
+                            const totalAllocated = value.reduce((acc, curr) => acc + curr.stockAllocated, 0);
+                            return (
+                                <span>
+                                    {totalOnHand} / {totalAllocated}
+                                </span>
+                            );
+                        }
+                        return value;
+                    },
+                },
+            }}
+            onSearchTermChange={searchTerm => {
+                return {
+                    name: { contains: searchTerm },
+                };
+            }}
+            route={Route}
+        ></ListPage>
+    );
+}

package/src/app/routes/_authenticated/_product-variants/product-variants_.$id.tsx

@@ -0,0 +1,331 @@
+import { MoneyInput } from '@/components/data-input/money-input.js';
+import { AssignedFacetValues } from '@/components/shared/assigned-facet-values.js';
+import { EntityAssets } from '@/components/shared/entity-assets.js';
+import { ErrorPage } from '@/components/shared/error-page.js';
+import { FormFieldWrapper } from '@/components/shared/form-field-wrapper.js';
+import { PermissionGuard } from '@/components/shared/permission-guard.js';
+import { TaxCategorySelector } from '@/components/shared/tax-category-selector.js';
+import { TranslatableFormFieldWrapper } from '@/components/shared/translatable-form-field.js';
+import { Button } from '@/components/ui/button.js';
+import {
+    FormControl,
+    FormDescription,
+    FormField,
+    FormItem,
+    FormLabel,
+    FormMessage,
+} from '@/components/ui/form.js';
+import { Input } from '@/components/ui/input.js';
+import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/components/ui/select.js';
+import { Switch } from '@/components/ui/switch.js';
+import { NEW_ENTITY_PATH } from '@/constants.js';
+import {
+    CustomFieldsPageBlock,
+    DetailFormGrid,
+    Page,
+    PageActionBar,
+    PageActionBarRight,
+    PageBlock,
+    PageLayout,
+    PageTitle,
+} from '@/framework/layout-engine/page-layout.js';
+import { detailPageRouteLoader } from '@/framework/page/detail-page-route-loader.js';
+import { useDetailPage } from '@/framework/page/use-detail-page.js';
+import { useChannel } from '@/hooks/use-channel.js';
+import { Trans, useLingui } from '@/lib/trans.js';
+import { createFileRoute, useNavigate } from '@tanstack/react-router';
+import { Fragment } from 'react/jsx-runtime';
+import { toast } from 'sonner';
+import { VariantPriceDetail } from './components/variant-price-detail.js';
+import {
+    createProductVariantDocument,
+    productVariantDetailDocument,
+    updateProductVariantDocument,
+} from './product-variants.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_product-variants/product-variants_/$id')({
+    component: ProductVariantDetailPage,
+    loader: detailPageRouteLoader({
+        queryDocument: productVariantDetailDocument,
+        breadcrumb(_isNew, entity) {
+            return [{ path: '/product-variants', label: 'Product variants' }, entity?.name];
+        },
+    }),
+    errorComponent: ({ error }) => <ErrorPage message={error.message} />,
+});
+
+function ProductVariantDetailPage() {
+    const params = Route.useParams();
+    const navigate = useNavigate();
+    const creatingNewEntity = params.id === NEW_ENTITY_PATH;
+    const { i18n } = useLingui();
+    const { activeChannel } = useChannel();
+
+    const { form, submitHandler, entity, isPending, resetForm } = useDetailPage({
+        queryDocument: productVariantDetailDocument,
+        createDocument: createProductVariantDocument,
+        updateDocument: updateProductVariantDocument,
+        setValuesForUpdate: entity => {
+            return {
+                id: entity.id,
+                enabled: entity.enabled,
+                sku: entity.sku,
+                featuredAssetId: entity.featuredAsset?.id,
+                assetIds: entity.assets.map(asset => asset.id),
+                facetValueIds: entity.facetValues.map(facetValue => facetValue.id),
+                taxCategoryId: entity.taxCategory.id,
+                price: entity.price,
+                prices: [],
+                trackInventory: entity.trackInventory,
+                outOfStockThreshold: entity.outOfStockThreshold,
+                stockLevels: entity.stockLevels.map(stockLevel => ({
+                    stockOnHand: stockLevel.stockOnHand,
+                    stockLocationId: stockLevel.stockLocation.id,
+                })),
+                translations: entity.translations.map(translation => ({
+                    id: translation.id,
+                    languageCode: translation.languageCode,
+                    name: translation.name,
+                    customFields: (translation as any).customFields,
+                })),
+                customFields: entity.customFields,
+            };
+        },
+        params: { id: params.id },
+        onSuccess: data => {
+            toast.success(i18n.t('Successfully updated product'));
+            resetForm();
+            if (creatingNewEntity) {
+                navigate({ to: `../${(data as any)?.[0]?.id}`, from: Route.id });
+            }
+        },
+        onError: err => {
+            toast.error(i18n.t('Failed to update product'), {
+                description: err instanceof Error ? err.message : 'Unknown error',
+            });
+        },
+    });
+
+    const [price, taxCategoryId] = form.watch(['price', 'taxCategoryId']);
+
+    return (
+        <Page pageId="product-variant-detail" form={form} submitHandler={submitHandler}>
+            <PageTitle>
+                {creatingNewEntity ? <Trans>New product variant</Trans> : (entity?.name ?? '')}
+            </PageTitle>
+            <PageActionBar>
+                <PageActionBarRight>
+                    <PermissionGuard requires={['UpdateProduct', 'UpdateCatalog']}>
+                        <Button
+                            type="submit"
+                            disabled={!form.formState.isDirty || !form.formState.isValid || isPending}
+                        >
+                            <Trans>Update</Trans>
+                        </Button>
+                    </PermissionGuard>
+                </PageActionBarRight>
+            </PageActionBar>
+            <PageLayout>
+                <PageBlock column="side" blockId="enabled">
+                    <FormFieldWrapper
+                        control={form.control}
+                        name="enabled"
+                        label={<Trans>Enabled</Trans>}
+                        description={<Trans>When enabled, a product is available in the shop</Trans>}
+                        render={({ field }) => (
+                            <Switch checked={field.value} onCheckedChange={field.onChange} />
+                        )}
+                    />
+                </PageBlock>
+                <PageBlock column="main" blockId="main-form">
+                    <DetailFormGrid>
+                        <TranslatableFormFieldWrapper
+                            control={form.control}
+                            name="name"
+                            label={<Trans>Product name</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="sku"
+                            label={<Trans>SKU</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+                    </DetailFormGrid>
+                </PageBlock>
+                <CustomFieldsPageBlock column="main" entityType="ProductVariant" control={form.control} />
+
+                <PageBlock column="main" blockId="price-and-tax" title={<Trans>Price and tax</Trans>}>
+                    <div className="grid grid-cols-2 gap-4 items-start">
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="taxCategoryId"
+                            label={<Trans>Tax category</Trans>}
+                            render={({ field }) => (
+                                <TaxCategorySelector value={field.value} onChange={field.onChange} />
+                            )}
+                        />
+
+                        <div>
+                            <FormFieldWrapper
+                                control={form.control}
+                                name="price"
+                                label={<Trans>Price</Trans>}
+                                render={({ field }) => (
+                                    <MoneyInput {...field} currency={entity?.currencyCode} />
+                                )}
+                            />
+                            <VariantPriceDetail
+                                priceIncludesTax={activeChannel?.pricesIncludeTax ?? false}
+                                price={price}
+                                currencyCode={
+                                    entity?.currencyCode ?? activeChannel?.defaultCurrencyCode ?? ''
+                                }
+                                taxCategoryId={taxCategoryId}
+                            />
+                        </div>
+                    </div>
+                </PageBlock>
+                <PageBlock column="main" blockId="stock" title={<Trans>Stock</Trans>}>
+                    <DetailFormGrid>
+                        {entity?.stockLevels.map((stockLevel, index) => (
+                            <Fragment key={stockLevel.id}>
+                                <FormFieldWrapper
+                                    control={form.control}
+                                    name={`stockLevels.${index}.stockOnHand`}
+                                    render={({ field }) => (
+                                        <FormItem>
+                                            <FormLabel>
+                                                <Trans>Stock level</Trans>
+                                            </FormLabel>
+                                            <FormControl>
+                                                <Input type="number" {...field} />
+                                            </FormControl>
+                                        </FormItem>
+                                    )}
+                                />
+                                <div>
+                                    <FormItem>
+                                        <FormLabel>
+                                            <Trans>Allocated</Trans>
+                                        </FormLabel>
+                                        <div className="text-sm pt-1.5">{stockLevel.stockAllocated}</div>
+                                    </FormItem>
+                                </div>
+                            </Fragment>
+                        ))}
+
+                        <FormField
+                            control={form.control}
+                            name="trackInventory"
+                            render={({ field }) => (
+                                <FormItem>
+                                    <FormLabel>
+                                        <Trans>Track inventory</Trans>
+                                    </FormLabel>
+                                    <Select onValueChange={field.onChange} value={field.value}>
+                                        <FormControl>
+                                            <SelectTrigger className="">
+                                                <SelectValue placeholder="Track inventory" />
+                                            </SelectTrigger>
+                                        </FormControl>
+                                        <SelectContent>
+                                            <SelectItem value="INHERIT">
+                                                <Trans>Inherit from global settings</Trans>
+                                            </SelectItem>
+                                            <SelectItem value="TRUE">
+                                                <Trans>Track</Trans>
+                                            </SelectItem>
+                                            <SelectItem value="FALSE">
+                                                <Trans>Do not track</Trans>
+                                            </SelectItem>
+                                        </SelectContent>
+                                    </Select>
+                                </FormItem>
+                            )}
+                        />
+                        <FormField
+                            control={form.control}
+                            name="outOfStockThreshold"
+                            render={({ field }) => (
+                                <FormItem>
+                                    <FormLabel>
+                                        <Trans>Out-of-stock threshold</Trans>
+                                    </FormLabel>
+                                    <FormControl>
+                                        <Input type="number" {...field} />
+                                    </FormControl>
+                                    <FormDescription>
+                                        <Trans>
+                                            Sets the stock level at which this variant is considered to be out
+                                            of stock. Using a negative value enables backorder support.
+                                        </Trans>
+                                    </FormDescription>
+                                </FormItem>
+                            )}
+                        />
+                        <FormField
+                            control={form.control}
+                            name="useGlobalOutOfStockThreshold"
+                            render={({ field }) => (
+                                <FormItem>
+                                    <FormLabel>
+                                        <Trans>Use global out-of-stock threshold</Trans>
+                                    </FormLabel>
+                                    <FormControl>
+                                        <Switch checked={field.value} onCheckedChange={field.onChange} />
+                                    </FormControl>
+                                    <FormDescription>
+                                        <Trans>
+                                            Sets the stock level at which this variant is considered to be out
+                                            of stock. Using a negative value enables backorder support.
+                                        </Trans>
+                                    </FormDescription>
+                                </FormItem>
+                            )}
+                        />
+                    </DetailFormGrid>
+                </PageBlock>
+
+                <PageBlock column="side" blockId="facet-values">
+                    <FormFieldWrapper
+                        control={form.control}
+                        name="facetValueIds"
+                        label={<Trans>Facet values</Trans>}
+                        render={({ field }) => (
+                            <AssignedFacetValues facetValues={entity?.facetValues ?? []} {...field} />
+                        )}
+                    />
+                </PageBlock>
+                <PageBlock column="side" blockId="assets">
+                    <FormItem>
+                        <FormLabel>
+                            <Trans>Assets</Trans>
+                        </FormLabel>
+                        <FormControl>
+                            <EntityAssets
+                                assets={entity?.assets}
+                                featuredAsset={entity?.featuredAsset}
+                                compact={true}
+                                value={form.getValues()}
+                                onChange={value => {
+                                    form.setValue('featuredAssetId', value.featuredAssetId ?? undefined, {
+                                        shouldDirty: true,
+                                        shouldValidate: true,
+                                    });
+                                    form.setValue('assetIds', value.assetIds ?? undefined, {
+                                        shouldDirty: true,
+                                        shouldValidate: true,
+                                    });
+                                }}
+                            />
+                        </FormControl>
+                        <FormDescription></FormDescription>
+                        <FormMessage />
+                    </FormItem>
+                </PageBlock>
+            </PageLayout>
+        </Page>
+    );
+}

package/src/app/routes/_authenticated/_products/components/create-product-variants-dialog.tsx

@@ -0,0 +1,228 @@
+import { useCallback, useMemo, useState } from 'react';
+import { CreateProductVariants, VariantConfiguration } from './create-product-variants.js';
+import {
+    Dialog,
+    DialogContent,
+    DialogFooter,
+    DialogHeader,
+    DialogTitle,
+    DialogDescription,
+    DialogTrigger,
+} from '@/components/ui/dialog.js';
+import { Button } from '@/components/ui/button.js';
+import { Plus } from 'lucide-react';
+import { useChannel } from '@/hooks/use-channel.js';
+import { Trans } from '@/lib/trans.js';
+import { graphql } from '@/graphql/graphql.js';
+import { api } from '@/graphql/api.js';
+import { useMutation } from '@tanstack/react-query';
+import { normalizeString } from '@/lib/utils.js';
+
+const createProductOptionsMutation = graphql(`
+    mutation CreateOptionGroups($input: CreateProductOptionGroupInput!) {
+        createProductOptionGroup(input: $input) {
+            id
+            name
+            options {
+                id
+                code
+                name
+            }
+        }
+    }
+`);
+
+export const addOptionGroupToProductDocument = graphql(`
+    mutation AddOptionGroupToProduct($productId: ID!, $optionGroupId: ID!) {
+        addOptionGroupToProduct(productId: $productId, optionGroupId: $optionGroupId) {
+            id
+            optionGroups {
+                id
+                code
+                options {
+                    id
+                    code
+                }
+            }
+        }
+    }
+`);
+
+export const createProductVariantsDocument = graphql(`
+    mutation CreateProductVariants($input: [CreateProductVariantInput!]!) {
+        createProductVariants(input: $input) {
+            id
+            name
+        }
+    }
+`);
+
+export function CreateProductVariantsDialog({
+    productId,
+    productName,
+    onSuccess,
+}: {
+    productId: string;
+    productName: string;
+    onSuccess?: () => void;
+}) {
+    const { activeChannel } = useChannel();
+    const [variantData, setVariantData] = useState<VariantConfiguration | null>(null);
+    const [open, setOpen] = useState(false);
+
+    const createOptionGroupMutation = useMutation({
+        mutationFn: api.mutate(createProductOptionsMutation),
+    });
+
+    const addOptionGroupToProductMutation = useMutation({
+        mutationFn: api.mutate(addOptionGroupToProductDocument),
+    });
+
+    const createProductVariantsMutation = useMutation({
+        mutationFn: api.mutate(createProductVariantsDocument),
+    });
+
+    async function handleCreateVariants() {
+        if (!variantData || !activeChannel?.defaultLanguageCode) return;
+
+        try {
+            // 1. Create option groups and their options
+            const createdOptionGroups = await Promise.all(
+                variantData.optionGroups.map(async optionGroup => {
+                    const result = await createOptionGroupMutation.mutateAsync({
+                        input: {
+                            code: normalizeString(optionGroup.name, '-'),
+                            translations: [
+                                {
+                                    languageCode: activeChannel.defaultLanguageCode,
+                                    name: optionGroup.name,
+                                },
+                            ],
+                            options: optionGroup.values.map(value => ({
+                                code: normalizeString(value.value, '-'),
+                                translations: [
+                                    {
+                                        languageCode: activeChannel.defaultLanguageCode,
+                                        name: value.value,
+                                    },
+                                ],
+                            })),
+                        },
+                    });
+                    return result.createProductOptionGroup;
+                }),
+            );
+
+            // 2. Add option groups to product
+            await Promise.all(
+                createdOptionGroups.map(group =>
+                    addOptionGroupToProductMutation.mutateAsync({
+                        productId,
+                        optionGroupId: group.id,
+                    }),
+                ),
+            );
+
+            // 3. Create variants
+            const variantsToCreate = variantData.variants
+                .filter(variant => variant.enabled)
+                .map(variant => {
+                    const name = variant.options.length
+                        ? `${productName} ${variant.options.map(option => option.value).join(' ')}`
+                        : productName;
+                    return {
+                        productId,
+                        sku: variant.sku,
+                        price: Number(variant.price),
+                        stockOnHand: Number(variant.stock),
+                        optionIds: variant.options.map(option => {
+                            const optionGroup = createdOptionGroups.find(g => g.name === option.name);
+                            if (!optionGroup) {
+                                throw new Error(`Could not find option group ${option.name}`);
+                            }
+                            const createdOption = optionGroup.options.find(o => o.name === option.value);
+                            if (!createdOption) {
+                                throw new Error(
+                                    `Could not find option ${option.value} in group ${option.name}`,
+                                );
+                            }
+                            return createdOption.id;
+                        }),
+                        translations: [
+                            {
+                                languageCode: activeChannel.defaultLanguageCode,
+                                name: name,
+                            },
+                        ],
+                    };
+                });
+
+            await createProductVariantsMutation.mutateAsync({ input: variantsToCreate });
+            setOpen(false);
+            onSuccess?.();
+        } catch (error) {
+            console.error('Error creating variants:', error);
+            // Handle error (show toast notification, etc.)
+        }
+    }
+
+    const handleOnChange = useCallback(
+        ({ data }: { data: VariantConfiguration }) => setVariantData(data),
+        [],
+    );
+
+    return (
+        <>
+            <Dialog open={open} onOpenChange={setOpen}>
+                <DialogTrigger asChild>
+                    <Button type="button">
+                        <Plus className="mr-2 h-4 w-4" /> Create Variants
+                    </Button>
+                </DialogTrigger>
+
+                <DialogContent>
+                    <DialogHeader>
+                        <DialogTitle>
+                            <Trans>Create Variants</Trans>
+                        </DialogTitle>
+                        <DialogDescription>
+                            <Trans>Create variants for your product</Trans>
+                        </DialogDescription>
+                    </DialogHeader>
+                    <div className="mt-4">
+                        <CreateProductVariants
+                            onChange={handleOnChange}
+                            currencyCode={activeChannel?.defaultCurrencyCode}
+                        />
+                    </div>
+                    <DialogFooter>
+                        <Button
+                            type="button"
+                            onClick={handleCreateVariants}
+                            disabled={
+                                !variantData ||
+                                createOptionGroupMutation.isPending ||
+                                addOptionGroupToProductMutation.isPending ||
+                                createProductVariantsMutation.isPending
+                            }
+                        >
+                            {createOptionGroupMutation.isPending ||
+                            addOptionGroupToProductMutation.isPending ||
+                            createProductVariantsMutation.isPending ? (
+                                <Trans>Creating...</Trans>
+                            ) : (
+                                <Trans>
+                                    Create{' '}
+                                    {variantData
+                                        ? Object.values(variantData.variants).filter(v => v.enabled).length
+                                        : 0}{' '}
+                                    variants
+                                </Trans>
+                            )}
+                        </Button>
+                    </DialogFooter>
+                </DialogContent>
+            </Dialog>
+        </>
+    );
+}