@vendure/dashboard 3.2.0

package/src/app/routes/_authenticated/_tax-rates/tax-rates.tsx

@@ -0,0 +1,108 @@
+import { BooleanDisplayBadge } from '@/components/data-display/boolean.js';
+import { DetailPageButton } from '@/components/shared/detail-page-button.js';
+import { PermissionGuard } from '@/components/shared/permission-guard.js';
+import { Button } from '@/components/ui/button.js';
+import { PageActionBarRight } from '@/framework/layout-engine/page-layout.js';
+import { ListPage } from '@/framework/page/list-page.js';
+import { api } from '@/graphql/api.js';
+import { Trans } from '@/lib/trans.js';
+import { createFileRoute, Link } from '@tanstack/react-router';
+import { PlusIcon } from 'lucide-react';
+import { taxCategoryListQuery } from '../_tax-categories/tax-categories.graphql.js';
+import { zoneListQuery } from '../_zones/zones.graphql.js';
+import { deleteTaxRateDocument, taxRateListQuery } from './tax-rates.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_tax-rates/tax-rates')({
+    component: TaxRateListPage,
+    loader: () => ({ breadcrumb: () => <Trans>Tax Rates</Trans> }),
+});
+
+function TaxRateListPage() {
+    return (
+        <ListPage
+            pageId="tax-rate-list"
+            listQuery={taxRateListQuery}
+            deleteMutation={deleteTaxRateDocument}
+            route={Route}
+            title="Tax Rates"
+            defaultVisibility={{
+                name: true,
+                enabled: true,
+                category: true,
+                zone: true,
+                value: true,
+            }}
+            onSearchTermChange={searchTerm => {
+                if (searchTerm === '') {
+                    return {};
+                }
+
+                return {
+                    name: { contains: searchTerm },
+                };
+            }}
+            facetedFilters={{
+                enabled: {
+                    title: 'Enabled',
+                    options: [
+                        { label: 'Enabled', value: true },
+                        { label: 'Disabled', value: false },
+                    ],
+                },
+                category: {
+                    title: 'Category',
+                    optionsFn: async () => {
+                        const { taxCategories } = await api.query(taxCategoryListQuery);
+                        return taxCategories.items.map(category => ({
+                            label: category.name,
+                            value: category.id,
+                        }));
+                    },
+                },
+                zone: {
+                    title: 'Zone',
+                    optionsFn: async () => {
+                        const { zones } = await api.query(zoneListQuery);
+                        return zones.items.map(zone => ({
+                            label: zone.name,
+                            value: zone.id,
+                        }));
+                    },
+                },
+            }}
+            customizeColumns={{
+                name: {
+                    header: 'Name',
+                    cell: ({ row }) => <DetailPageButton id={row.original.id} label={row.original.name} />,
+                },
+                enabled: {
+                    header: 'Enabled',
+                    cell: ({ row }) => <BooleanDisplayBadge value={row.original.enabled} />,
+                },
+                category: {
+                    header: 'Category',
+                    cell: ({ row }) => row.original.category?.name,
+                },
+                zone: {
+                    header: 'Zone',
+                    cell: ({ row }) => row.original.zone?.name,
+                },
+                value: {
+                    header: 'Value',
+                    cell: ({ row }) => `${row.original.value}%`,
+                },
+            }}
+        >
+            <PageActionBarRight>
+                <PermissionGuard requires={['CreateTaxRate']}>
+                    <Button asChild>
+                        <Link to="./new">
+                            <PlusIcon />
+                            <Trans>New Tax Rate</Trans>
+                        </Link>
+                    </Button>
+                </PermissionGuard>
+            </PageActionBarRight>
+        </ListPage>
+    );
+}

package/src/app/routes/_authenticated/_tax-rates/tax-rates_.$id.tsx

@@ -0,0 +1,148 @@
+import { AffixedInput } from '@/components/data-input/affixed-input.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 { ZoneSelector } from '@/components/shared/zone-selector.js';
+import { Button } from '@/components/ui/button.js';
+import { Input } from '@/components/ui/input.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 { Trans, useLingui } from '@/lib/trans.js';
+import { createFileRoute, useNavigate } from '@tanstack/react-router';
+import { toast } from 'sonner';
+import { createTaxRateDocument, taxRateDetailQuery, updateTaxRateDocument } from './tax-rates.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_tax-rates/tax-rates_/$id')({
+    component: TaxRateDetailPage,
+    loader: detailPageRouteLoader({
+        queryDocument: taxRateDetailQuery,
+        breadcrumb(isNew, entity) {
+            return [
+                { path: '/tax-rates', label: 'Tax rates' },
+                isNew ? <Trans>New tax rate</Trans> : entity?.name,
+            ];
+        },
+    }),
+    errorComponent: ({ error }) => <ErrorPage message={error.message} />,
+});
+
+function TaxRateDetailPage() {
+    const params = Route.useParams();
+    const navigate = useNavigate();
+    const creatingNewEntity = params.id === NEW_ENTITY_PATH;
+    const { i18n } = useLingui();
+
+    const { form, submitHandler, entity, isPending, resetForm } = useDetailPage({
+        queryDocument: taxRateDetailQuery,
+        createDocument: createTaxRateDocument,
+        updateDocument: updateTaxRateDocument,
+        setValuesForUpdate: entity => {
+            return {
+                id: entity.id,
+                name: entity.name,
+                value: entity.value,
+                enabled: entity.enabled,
+                categoryId: entity.category.id,
+                zoneId: entity.zone.id,
+                customerGroupId: entity.customerGroup?.id,
+                customFields: entity.customFields,
+            };
+        },
+        params: { id: params.id },
+        onSuccess: async data => {
+            toast.success(i18n.t('Successfully updated tax rate'));
+            resetForm();
+            if (creatingNewEntity) {
+                await navigate({ to: `../$id`, params: { id: data.id } });
+            }
+        },
+        onError: err => {
+            toast.error(i18n.t('Failed to update tax rate'), {
+                description: err instanceof Error ? err.message : 'Unknown error',
+            });
+        },
+    });
+
+    return (
+        <Page pageId="tax-rate-detail" form={form} submitHandler={submitHandler}>
+            <PageTitle>{creatingNewEntity ? <Trans>New tax rate</Trans> : (entity?.name ?? '')}</PageTitle>
+            <PageActionBar>
+                <PageActionBarRight>
+                    <PermissionGuard requires={['UpdateTaxRate']}>
+                        <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>}
+                        render={({ field }) => (
+                            <Switch checked={field.value} onCheckedChange={field.onChange} />
+                        )}
+                    />
+                </PageBlock>
+                <PageBlock column="main" blockId="main-form">
+                    <DetailFormGrid>
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="name"
+                            label={<Trans>Name</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="value"
+                            label={<Trans>Rate</Trans>}
+                            render={({ field }) => (
+                                <AffixedInput
+                                    type="number"
+                                    suffix="%"
+                                    value={field.value}
+                                    onChange={e => field.onChange(e.target.valueAsNumber)}
+                                />
+                            )}
+                        />
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="categoryId"
+                            label={<Trans>Tax category</Trans>}
+                            render={({ field }) => (
+                                <TaxCategorySelector value={field.value} onChange={field.onChange} />
+                            )}
+                        />
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="zoneId"
+                            label={<Trans>Zone</Trans>}
+                            render={({ field }) => (
+                                <ZoneSelector value={field.value} onChange={field.onChange} />
+                            )}
+                        />
+                    </DetailFormGrid>
+                </PageBlock>
+                <CustomFieldsPageBlock column="main" entityType="TaxRate" control={form.control} />
+            </PageLayout>
+        </Page>
+    );
+}

package/src/app/routes/_authenticated/_zones/components/zone-countries-sheet.tsx

@@ -0,0 +1,31 @@
+import { Button } from '@/components/ui/button.js';
+import { ScrollArea } from '@/components/ui/scroll-area.js';
+import { Sheet, SheetContent, SheetHeader, SheetTitle, SheetTrigger } from '@/components/ui/sheet.js';
+import { ZoneCountriesTable } from './zone-countries-table.js';
+
+interface ZoneCountriesSheetProps {
+    zoneId: string;
+    zoneName: string;
+    children?: React.ReactNode;
+}
+
+export function ZoneCountriesSheet({ zoneId, zoneName, children }: ZoneCountriesSheetProps) {
+    return (
+        <Sheet>
+            <SheetTrigger asChild>
+                <Button variant="outline" size="sm" className="flex items-center gap-2">
+                    {children}
+                </Button>
+            </SheetTrigger>
+            <SheetContent className="min-w-[800px]">
+                <SheetHeader>
+                    <SheetTitle>{zoneName}</SheetTitle>
+                </SheetHeader>
+                <div className="flex items-center gap-2"></div>
+                <ScrollArea className="px-6 max-h-[600px]">
+                    <ZoneCountriesTable zoneId={zoneId} />
+                </ScrollArea>
+            </SheetContent>
+        </Sheet>
+    );
+}

package/src/app/routes/_authenticated/_zones/components/zone-countries-table.tsx

@@ -0,0 +1,79 @@
+import { DataTable } from '@/components/data-table/data-table.js';
+import { api } from '@/graphql/api.js';
+import { useMutation, useQuery } from '@tanstack/react-query';
+import { ColumnDef } from '@tanstack/react-table';
+import { useMemo, useState } from 'react';
+import { addCountryToZoneMutation, removeCountryFromZoneMutation, zoneMembersQuery } from '../zones.graphql.js';
+import { CountrySelector } from '@/components/shared/country-selector.js';
+
+interface ZoneCountriesTableProps {
+    zoneId: string;
+    canAddCountries?: boolean;
+}
+
+export function ZoneCountriesTable({ zoneId, canAddCountries = false }: ZoneCountriesTableProps) {
+    const { data, refetch } = useQuery({
+        queryKey: ['zone', zoneId],
+        queryFn: () => api.query(zoneMembersQuery, { zoneId }),
+    });
+
+    const { mutate: addCountryToZone } = useMutation({
+        mutationFn: api.mutate(addCountryToZoneMutation),
+        onSuccess: () => {
+            refetch();
+        },
+    });
+
+    const { mutate: removeCountryFromZone } = useMutation({
+        mutationFn: api.mutate(removeCountryFromZoneMutation),
+        onSuccess: () => {
+            refetch();
+        },
+    });
+
+    const [page, setPage] = useState(1);
+    const [pageSize, setPageSize] = useState(10);
+
+    const paginatedItems = useMemo(() => {
+        return data?.zone?.members?.slice((page - 1) * pageSize, page * pageSize);
+    }, [data, page, pageSize]);
+
+    const columns: ColumnDef<any>[] = [
+        {
+            header: 'Country',
+            accessorKey: 'name',
+        },
+        {
+            header: 'Enabled',
+            accessorKey: 'enabled',
+        },
+        {
+            header: 'Code',
+            accessorKey: 'code',
+        },
+    ];
+
+    return (
+        <div>
+            <DataTable
+                columns={columns}
+                data={paginatedItems ?? []}
+                onPageChange={(table, page, itemsPerPage) => {
+                setPage(page);
+                setPageSize(itemsPerPage);
+            }}
+                totalItems={data?.zone?.members?.length ?? 0}
+            />
+            {canAddCountries && (
+                <CountrySelector
+                    onSelect={country => {
+                        addCountryToZone({
+                            zoneId,
+                            memberIds: [country.id],
+                        });
+                    }}
+                />
+            )}
+        </div>
+    );
+}

package/src/app/routes/_authenticated/_zones/zones.graphql.ts

@@ -0,0 +1,96 @@
+import { graphql } from '@/graphql/graphql.js';
+
+export const zoneItemFragment = graphql(`
+    fragment ZoneItem on Zone {
+        id
+        createdAt
+        updatedAt
+        name
+    }
+`);
+
+export const zoneListQuery = graphql(
+    `
+        query ZoneList {
+            zones {
+                items {
+                    ...ZoneItem
+                }
+                totalItems
+            }
+        }
+    `,
+    [zoneItemFragment],
+);
+
+export const zoneMembersQuery = graphql(`
+    query ZoneMembers($zoneId: ID!) {
+        zone(id: $zoneId) {
+            id
+            createdAt
+            updatedAt
+            name
+            members {
+                createdAt
+                updatedAt
+                id
+                name
+                code
+                enabled
+            }
+        }
+    }
+`);
+
+export const zoneDetailQuery = graphql(
+    `
+        query ZoneDetail($id: ID!) {
+            zone(id: $id) {
+                ...ZoneItem
+                customFields
+            }
+        }
+    `,
+    [zoneItemFragment],
+);
+
+export const createZoneDocument = graphql(`
+    mutation CreateZone($input: CreateZoneInput!) {
+        createZone(input: $input) {
+            id
+        }
+    }
+`);
+
+export const updateZoneDocument = graphql(`
+    mutation UpdateZone($input: UpdateZoneInput!) {
+        updateZone(input: $input) {
+            id
+        }
+    }
+`);
+
+export const addCountryToZoneMutation = graphql(`
+    mutation AddMembersToZone($zoneId: ID!, $memberIds: [ID!]!) {
+        addMembersToZone(zoneId: $zoneId, memberIds: $memberIds) {
+            id
+        }
+    }
+`);
+
+export const removeCountryFromZoneMutation = graphql(`
+    mutation RemoveMembersFromZone($zoneId: ID!, $memberIds: [ID!]!) {
+        removeMembersFromZone(zoneId: $zoneId, memberIds: $memberIds) {
+            id
+        }
+    }
+`);
+
+export const deleteZoneDocument = graphql(`
+    mutation DeleteZone($id: ID!) {
+        deleteZone(id: $id) {
+            result
+            message
+        }
+    }
+`);

package/src/app/routes/_authenticated/_zones/zones.tsx

@@ -0,0 +1,57 @@
+import { DetailPageButton } from '@/components/shared/detail-page-button.js';
+import { PermissionGuard } from '@/components/shared/permission-guard.js';
+import { Button } from '@/components/ui/button.js';
+import { PageActionBarRight } from '@/framework/layout-engine/page-layout.js';
+import { ListPage } from '@/framework/page/list-page.js';
+import { Trans } from '@/lib/trans.js';
+import { createFileRoute, Link } from '@tanstack/react-router';
+import { PlusIcon } from 'lucide-react';
+import { ZoneCountriesSheet } from './components/zone-countries-sheet.js';
+import { deleteZoneDocument, zoneListQuery } from './zones.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_zones/zones')({
+    component: ZoneListPage,
+    loader: () => ({ breadcrumb: () => <Trans>Zones</Trans> }),
+});
+
+function ZoneListPage() {
+    return (
+        <ListPage
+            pageId="zone-list"
+            listQuery={zoneListQuery}
+            deleteMutation={deleteZoneDocument}
+            route={Route}
+            title="Zones"
+            defaultVisibility={{
+                name: true,
+            }}
+            customizeColumns={{
+                name: {
+                    header: 'Name',
+                    cell: ({ row }) => <DetailPageButton id={row.original.id} label={row.original.name} />,
+                },
+            }}
+            additionalColumns={{
+                regions: {
+                    header: 'Regions',
+                    cell: ({ row }) => (
+                        <ZoneCountriesSheet zoneId={row.original.id} zoneName={row.original.name}>
+                            <Trans>Edit members</Trans>
+                        </ZoneCountriesSheet>
+                    ),
+                },
+            }}
+        >
+            <PageActionBarRight>
+                <PermissionGuard requires={['CreateZone']}>
+                    <Button asChild>
+                        <Link to="./new">
+                            <PlusIcon />
+                            <Trans>New Zone</Trans>
+                        </Link>
+                    </Button>
+                </PermissionGuard>
+            </PageActionBarRight>
+        </ListPage>
+    );
+}

package/src/app/routes/_authenticated/_zones/zones_.$id.tsx

@@ -0,0 +1,103 @@
+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 { Button } from '@/components/ui/button.js';
+import { Input } from '@/components/ui/input.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 { Trans, useLingui } from '@/lib/trans.js';
+import { createFileRoute, useNavigate } from '@tanstack/react-router';
+import { toast } from 'sonner';
+import { ZoneCountriesTable } from './components/zone-countries-table.js';
+import { createZoneDocument, updateZoneDocument, zoneDetailQuery } from './zones.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_zones/zones_/$id')({
+    component: ZoneDetailPage,
+    loader: detailPageRouteLoader({
+        queryDocument: zoneDetailQuery,
+        breadcrumb(isNew, entity) {
+            return [{ path: '/zones', label: 'Zones' }, isNew ? <Trans>New zone</Trans> : entity?.name];
+        },
+    }),
+    errorComponent: ({ error }) => <ErrorPage message={error.message} />,
+});
+
+function ZoneDetailPage() {
+    const params = Route.useParams();
+    const navigate = useNavigate();
+    const creatingNewEntity = params.id === NEW_ENTITY_PATH;
+    const { i18n } = useLingui();
+
+    const { form, submitHandler, entity, isPending, resetForm } = useDetailPage({
+        queryDocument: zoneDetailQuery,
+        createDocument: createZoneDocument,
+        updateDocument: updateZoneDocument,
+        setValuesForUpdate: entity => {
+            return {
+                id: entity.id,
+                name: entity.name,
+                customFields: entity.customFields,
+            };
+        },
+        params: { id: params.id },
+        onSuccess: async data => {
+            toast.success(i18n.t('Successfully updated zone'));
+            resetForm();
+            if (creatingNewEntity) {
+                await navigate({ to: `../$id`, params: { id: data.id } });
+            }
+        },
+        onError: err => {
+            toast.error(i18n.t('Failed to update zone'), {
+                description: err instanceof Error ? err.message : 'Unknown error',
+            });
+        },
+    });
+
+    return (
+        <Page pageId="zone-detail" form={form} submitHandler={submitHandler}>
+            <PageTitle>{creatingNewEntity ? <Trans>New zone</Trans> : (entity?.name ?? '')}</PageTitle>
+            <PageActionBar>
+                <PageActionBarRight>
+                    <PermissionGuard requires={['UpdateZone']}>
+                        <Button
+                            type="submit"
+                            disabled={!form.formState.isDirty || !form.formState.isValid || isPending}
+                        >
+                            <Trans>Update</Trans>
+                        </Button>
+                    </PermissionGuard>
+                </PageActionBarRight>
+            </PageActionBar>
+            <PageLayout>
+                <PageBlock column="main" blockId="main-form">
+                    <DetailFormGrid>
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="name"
+                            label={<Trans>Name</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+                    </DetailFormGrid>
+                </PageBlock>
+                <CustomFieldsPageBlock column="main" entityType="Zone" control={form.control} />
+                {entity && (
+                    <PageBlock column="main" blockId="countries" title={<Trans>Countries</Trans>}>
+                        <ZoneCountriesTable zoneId={entity.id} canAddCountries={true} />
+                    </PageBlock>
+                )}
+            </PageLayout>
+        </Page>
+    );
+}