@vendure/dashboard 3.2.0

package/src/app/routes/_authenticated/_shipping-methods/components/shipping-eligibility-checker-selector.tsx

@@ -0,0 +1,101 @@
+import { ConfigurableOperationInput } from '@/components/shared/configurable-operation-input.js';
+import { Button } from '@/components/ui/button.js';
+import {
+    DropdownMenu,
+    DropdownMenuContent,
+    DropdownMenuItem,
+    DropdownMenuTrigger,
+} from '@/components/ui/dropdown-menu.js';
+import { api } from '@/graphql/api.js';
+import { configurableOperationDefFragment, ConfigurableOperationDefFragment } from '@/graphql/fragments.js';
+import { graphql } from '@/graphql/graphql.js';
+import { Trans } from '@/lib/trans.js';
+import { useQuery } from '@tanstack/react-query';
+import { ConfigurableOperationInput as ConfigurableOperationInputType } from '@vendure/common/lib/generated-types';
+import { Plus } from 'lucide-react';
+
+export const shippingEligibilityCheckersDocument = graphql(
+    `
+        query GetShippingEligibilityCheckers {
+            shippingEligibilityCheckers {
+                ...ConfigurableOperationDef
+            }
+        }
+    `,
+    [configurableOperationDefFragment],
+);
+
+interface ShippingEligibilityCheckerSelectorProps {
+    value: ConfigurableOperationInputType | undefined;
+    onChange: (value: ConfigurableOperationInputType | undefined) => void;
+}
+
+export function ShippingEligibilityCheckerSelector({ value, onChange }: ShippingEligibilityCheckerSelectorProps) {
+    const { data: checkersData } = useQuery({
+        queryKey: ['shippingEligibilityCheckers'],
+        queryFn: () => api.query(shippingEligibilityCheckersDocument),
+        staleTime: 1000 * 60 * 60 * 5,
+    });
+
+    const checkers = checkersData?.shippingEligibilityCheckers;
+
+    const onCheckerSelected = (checker: ConfigurableOperationDefFragment) => {
+        const checkerDef = checkers?.find(c => c.code === checker.code);
+        if (!checkerDef) {
+            return;
+        }
+        onChange(
+            {
+                code: checker.code,
+                arguments: checkerDef.args.map(arg => ({
+                    name: arg.name,
+                    value: arg.defaultValue != null ? arg.defaultValue.toString() : '',
+                })),
+            },
+        );
+    };
+
+    const onOperationValueChange = (
+        newVal: ConfigurableOperationInputType,
+    ) => {
+        onChange(newVal);
+    };
+
+    const onOperationRemove = () => {
+        onChange(undefined);
+    };
+
+    const checkerDef = checkers?.find(c => c.code === value?.code);
+
+    return (
+        <div className="flex flex-col gap-2 mt-4">
+            {value && checkerDef && (
+                <div className="flex flex-col gap-2">
+                    <ConfigurableOperationInput
+                        operationDefinition={checkerDef}
+                        value={value}
+                        onChange={value => onOperationValueChange(value)}
+                        onRemove={() => onOperationRemove()}
+                    />
+                </div>
+            )}
+            <DropdownMenu>
+                {!value && (
+                    <DropdownMenuTrigger asChild>
+                        <Button variant="outline">
+                            <Plus />
+                            <Trans context="Add new promotion action">Select Shipping Eligibility Checker</Trans>
+                        </Button>
+                    </DropdownMenuTrigger>
+                )}
+                <DropdownMenuContent className="w-96">
+                    {checkers?.map(checker => (
+                        <DropdownMenuItem key={checker.code} onClick={() => onCheckerSelected(checker)}>
+                            {checker.description}
+                        </DropdownMenuItem>
+                    ))}
+                </DropdownMenuContent>
+            </DropdownMenu>
+        </div>
+    );
+}

package/src/app/routes/_authenticated/_shipping-methods/components/test-shipping-method-dialog.tsx

@@ -0,0 +1,32 @@
+import { Button } from '@/components/ui/button.js';
+import {
+    Dialog,
+    DialogContent,
+    DialogDescription,
+    DialogHeader,
+    DialogTitle,
+    DialogTrigger,
+} from '@/components/ui/dialog.js';
+import { Trans } from '@/lib/trans.js';
+import { TestTube } from 'lucide-react';
+
+export function TestShippingMethodDialog() {
+    return (
+        <Dialog>
+            <DialogTrigger asChild>
+                <Button variant="secondary">
+                    <TestTube />
+                    <Trans>Test shipping method</Trans>
+                </Button>
+            </DialogTrigger>
+            <DialogContent className="min-w-[800px]">
+                <DialogHeader>
+                    <DialogTitle>Test shipping method</DialogTitle>
+                    <DialogDescription>
+                        Test your shipping method by simulating a new order.
+                    </DialogDescription>
+                </DialogHeader>
+            </DialogContent>
+        </Dialog>
+    );
+}

package/src/app/routes/_authenticated/_shipping-methods/shipping-methods.graphql.ts

@@ -0,0 +1,83 @@
+import { configurableOperationFragment } from '@/graphql/fragments.js';
+import { graphql } from '@/graphql/graphql.js';
+
+export const shippingMethodItemFragment = graphql(`
+    fragment ShippingMethodItem on ShippingMethod {
+        id
+        name
+        code
+        description
+        fulfillmentHandlerCode
+        createdAt
+        updatedAt
+    }
+`);
+
+export const shippingMethodListQuery = graphql(
+    `
+        query ShippingMethodList {
+            shippingMethods {
+                items {
+                    ...ShippingMethodItem
+                }
+                totalItems
+            }
+        }
+    `,
+    [shippingMethodItemFragment],
+);
+
+export const shippingMethodDetailDocument = graphql(
+    `
+        query ShippingMethodDetail($id: ID!) {
+            shippingMethod(id: $id) {
+                id
+                createdAt
+                updatedAt
+                code
+                name
+                description
+                fulfillmentHandlerCode
+                checker {
+                    ...ConfigurableOperation
+                }
+                calculator {
+                    ...ConfigurableOperation
+                }
+                translations {
+                    id
+                    languageCode
+                    name
+                    description
+                }
+                customFields
+            }
+        }
+    `,
+    [configurableOperationFragment],
+);
+
+export const createShippingMethodDocument = graphql(`
+    mutation CreateShippingMethod($input: CreateShippingMethodInput!) {
+        createShippingMethod(input: $input) {
+            id
+        }
+    }
+`);
+
+export const updateShippingMethodDocument = graphql(`
+    mutation UpdateShippingMethod($input: UpdateShippingMethodInput!) {
+        updateShippingMethod(input: $input) {
+            id
+        }
+    }
+`);
+
+export const deleteShippingMethodDocument = graphql(`
+    mutation DeleteShippingMethod($id: ID!) {
+        deleteShippingMethod(id: $id) {
+            result
+            message
+        }
+    }
+`);

package/src/app/routes/_authenticated/_shipping-methods/shipping-methods.tsx

@@ -0,0 +1,55 @@
+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 { TestShippingMethodDialog } from './components/test-shipping-method-dialog.js';
+import { deleteShippingMethodDocument, shippingMethodListQuery } from './shipping-methods.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_shipping-methods/shipping-methods')({
+    component: ShippingMethodListPage,
+    loader: () => ({ breadcrumb: () => <Trans>Shipping Methods</Trans> }),
+});
+
+function ShippingMethodListPage() {
+    return (
+        <ListPage
+            pageId="shipping-method-list"
+            listQuery={shippingMethodListQuery}
+            deleteMutation={deleteShippingMethodDocument}
+            route={Route}
+            title="Shipping Methods"
+            defaultVisibility={{
+                name: true,
+                code: true,
+                fulfillmentHandlerCode: true,
+            }}
+            customizeColumns={{
+                name: {
+                    header: 'Name',
+                    cell: ({ row }) => <DetailPageButton id={row.original.id} label={row.original.name} />,
+                },
+            }}
+            onSearchTermChange={searchTerm => {
+                return {
+                    name: { contains: searchTerm },
+                };
+            }}
+        >
+            <PageActionBarRight>
+                <PermissionGuard requires={['CreateShippingMethod']}>
+                    <Button asChild>
+                        <Link to="./new">
+                            <PlusIcon className="mr-2 h-4 w-4" />
+                            <Trans>New Shipping Method</Trans>
+                        </Link>
+                    </Button>
+                </PermissionGuard>
+                <TestShippingMethodDialog />
+            </PageActionBarRight>
+        </ListPage>
+    );
+}

package/src/app/routes/_authenticated/_shipping-methods/shipping-methods_.$id.tsx

@@ -0,0 +1,171 @@
+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 { TranslatableFormFieldWrapper } from '@/components/shared/translatable-form-field.js';
+import { Button } from '@/components/ui/button.js';
+import { Input } from '@/components/ui/input.js';
+import { Textarea } from '@/components/ui/textarea.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 { FulfillmentHandlerSelector } from './components/fulfillment-handler-selector.js';
+import { ShippingCalculatorSelector } from './components/shipping-calculator-selector.js';
+import { ShippingEligibilityCheckerSelector } from './components/shipping-eligibility-checker-selector.js';
+import {
+    createShippingMethodDocument,
+    shippingMethodDetailDocument,
+    updateShippingMethodDocument,
+} from './shipping-methods.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_shipping-methods/shipping-methods_/$id')({
+    component: ShippingMethodDetailPage,
+    loader: detailPageRouteLoader({
+        queryDocument: shippingMethodDetailDocument,
+        breadcrumb(isNew, entity) {
+            return [
+                { path: '/shipping-methods', label: 'Shipping methods' },
+                isNew ? <Trans>New shipping method</Trans> : entity?.name,
+            ];
+        },
+    }),
+    errorComponent: ({ error }) => <ErrorPage message={error.message} />,
+});
+
+function ShippingMethodDetailPage() {
+    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: shippingMethodDetailDocument,
+        createDocument: createShippingMethodDocument,
+        updateDocument: updateShippingMethodDocument,
+        setValuesForUpdate: entity => {
+            return {
+                id: entity.id,
+                name: entity.name,
+                code: entity.code,
+                description: entity.description,
+                fulfillmentHandler: entity.fulfillmentHandlerCode,
+                checker: entity.checker && {
+                    code: entity.checker?.code,
+                    arguments: entity.checker?.args,
+                },
+                calculator: entity.calculator && {
+                    code: entity.calculator?.code,
+                    arguments: entity.calculator?.args,
+                },
+                translations: entity.translations.map(translation => ({
+                    id: translation.id,
+                    languageCode: translation.languageCode,
+                    name: translation.name,
+                    description: translation.description,
+                })),
+                customFields: entity.customFields,
+            };
+        },
+        params: { id: params.id },
+        onSuccess: async data => {
+            toast.success(i18n.t('Successfully updated shipping method'));
+            resetForm();
+            if (creatingNewEntity) {
+                await navigate({ to: `../$id`, params: { id: data.id } });
+            }
+        },
+        onError: err => {
+            toast.error(i18n.t('Failed to update shipping method'), {
+                description: err instanceof Error ? err.message : 'Unknown error',
+            });
+        },
+    });
+
+    return (
+        <Page pageId="shipping-method-detail" form={form} submitHandler={submitHandler}>
+            <PageTitle>
+                {creatingNewEntity ? <Trans>New shipping method</Trans> : (entity?.name ?? '')}
+            </PageTitle>
+            <PageActionBar>
+                <PageActionBarRight>
+                    <PermissionGuard requires={['UpdateShippingMethod']}>
+                        <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>
+                        <TranslatableFormFieldWrapper
+                            control={form.control}
+                            name="name"
+                            label={<Trans>Name</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="code"
+                            label={<Trans>Code</Trans>}
+                            render={({ field }) => <Input {...field} />}
+                        />
+                    </DetailFormGrid>
+                    <TranslatableFormFieldWrapper
+                        control={form.control}
+                        name="description"
+                        label={<Trans>Description</Trans>}
+                        render={({ field }) => <Textarea {...field} />}
+                    />
+                    <DetailFormGrid>
+                        <FormFieldWrapper
+                            control={form.control}
+                            name="fulfillmentHandler"
+                            label={<Trans>Fulfillment handler</Trans>}
+                            render={({ field }) => (
+                                <FulfillmentHandlerSelector value={field.value} onChange={field.onChange} />
+                            )}
+                        />
+                    </DetailFormGrid>
+                </PageBlock>
+                <CustomFieldsPageBlock column="main" entityType="Promotion" control={form.control} />
+                <PageBlock column="main" blockId="conditions" title={<Trans>Conditions</Trans>}>
+                    <FormFieldWrapper
+                        control={form.control}
+                        name="checker"
+                        render={({ field }) => (
+                            <ShippingEligibilityCheckerSelector
+                                value={field.value}
+                                onChange={field.onChange}
+                            />
+                        )}
+                    />
+                </PageBlock>
+                <PageBlock column="main" blockId="calculator" title={<Trans>Calculator</Trans>}>
+                    <FormFieldWrapper
+                        control={form.control}
+                        name="calculator"
+                        render={({ field }) => (
+                            <ShippingCalculatorSelector value={field.value} onChange={field.onChange} />
+                        )}
+                    />
+                </PageBlock>
+            </PageLayout>
+        </Page>
+    );
+}

package/src/app/routes/_authenticated/_stock-locations/stock-locations.graphql.ts

@@ -0,0 +1,62 @@
+import { graphql } from '@/graphql/graphql.js';
+
+export const stockLocationFragment = graphql(`
+    fragment StockLocationItem on StockLocation {
+        id
+        createdAt
+        updatedAt
+        name
+        description
+    }
+`);
+
+export const stockLocationListQuery = graphql(
+    `
+        query StockLocationList {
+            stockLocations {
+                items {
+                    ...StockLocationItem
+                }
+                totalItems
+            }
+        }
+    `,
+    [stockLocationFragment],
+);
+
+export const stockLocationDetailQuery = graphql(
+    `
+        query StockLocationDetail($id: ID!) {
+            stockLocation(id: $id) {
+                ...StockLocationItem
+                customFields
+            }
+        }
+    `,
+    [stockLocationFragment],
+);
+
+export const createStockLocationDocument = graphql(`
+    mutation CreateStockLocation($input: CreateStockLocationInput!) {
+        createStockLocation(input: $input) {
+            id
+        }
+    }
+`);
+
+export const updateStockLocationDocument = graphql(`
+    mutation UpdateStockLocation($input: UpdateStockLocationInput!) {
+        updateStockLocation(input: $input) {
+            id
+        }
+    }
+`);
+
+export const deleteStockLocationDocument = graphql(`
+    mutation DeleteStockLocation($id: ID!) {
+        deleteStockLocation(input: { id: $id }) {
+            result
+            message
+        }
+    }
+`);

package/src/app/routes/_authenticated/_stock-locations/stock-locations.tsx

@@ -0,0 +1,48 @@
+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 { deleteStockLocationDocument, stockLocationListQuery } from './stock-locations.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_stock-locations/stock-locations')({
+    component: StockLocationListPage,
+    loader: () => ({ breadcrumb: () => <Trans>Stock Locations</Trans> }),
+});
+
+function StockLocationListPage() {
+    return (
+        <ListPage
+            pageId="stock-location-list"
+            title="Stock Locations"
+            listQuery={stockLocationListQuery}
+            deleteMutation={deleteStockLocationDocument}
+            route={Route}
+            customizeColumns={{
+                name: {
+                    header: 'Name',
+                    cell: ({ row }) => <DetailPageButton id={row.original.id} label={row.original.name} />,
+                },
+            }}
+            onSearchTermChange={searchTerm => {
+                return {
+                    name: { contains: searchTerm },
+                };
+            }}
+        >
+            <PageActionBarRight>
+                <PermissionGuard requires={['CreateStockLocation']}>
+                    <Button asChild>
+                        <Link to="./new">
+                            <PlusIcon className="mr-2 h-4 w-4" />
+                            New Stock Location
+                        </Link>
+                    </Button>
+                </PermissionGuard>
+            </PageActionBarRight>
+        </ListPage>
+    );
+}

package/src/app/routes/_authenticated/_stock-locations/stock-locations_.$id.tsx

@@ -0,0 +1,115 @@
+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 { Textarea } from '@/components/ui/textarea.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 {
+    createStockLocationDocument,
+    stockLocationDetailQuery,
+    updateStockLocationDocument,
+} from './stock-locations.graphql.js';
+
+export const Route = createFileRoute('/_authenticated/_stock-locations/stock-locations_/$id')({
+    component: StockLocationDetailPage,
+    loader: detailPageRouteLoader({
+        queryDocument: stockLocationDetailQuery,
+        breadcrumb(isNew, entity) {
+            return [
+                { path: '/stock-locations', label: 'Stock locations' },
+                isNew ? <Trans>New stock location</Trans> : entity?.name,
+            ];
+        },
+    }),
+    errorComponent: ({ error }) => <ErrorPage message={error.message} />,
+});
+
+function StockLocationDetailPage() {
+    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: stockLocationDetailQuery,
+        createDocument: createStockLocationDocument,
+        updateDocument: updateStockLocationDocument,
+        setValuesForUpdate: entity => {
+            return {
+                id: entity.id,
+                name: entity.name,
+                description: entity.description,
+                customFields: entity.customFields,
+            };
+        },
+        params: { id: params.id },
+        onSuccess: async data => {
+            toast.success(i18n.t('Successfully updated stock location'));
+            resetForm();
+            if (creatingNewEntity) {
+                await navigate({ to: `../$id`, params: { id: data.id } });
+            }
+        },
+        onError: err => {
+            toast.error(i18n.t('Failed to update stock location'), {
+                description: err instanceof Error ? err.message : 'Unknown error',
+            });
+        },
+    });
+
+    return (
+        <Page pageId="stock-location-detail" form={form} submitHandler={submitHandler}>
+            <PageTitle>
+                {creatingNewEntity ? <Trans>New stock location</Trans> : (entity?.name ?? '')}
+            </PageTitle>
+            <PageActionBar>
+                <PageActionBarRight>
+                    <PermissionGuard requires={['UpdateStockLocation']}>
+                        <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}
+                            label={<Trans>Name</Trans>}
+                            name="name"
+                            render={({ field }) => <Input {...field} />}
+                        />
+                        <div></div>
+                    </DetailFormGrid>
+                    <FormFieldWrapper
+                        control={form.control}
+                        name="description"
+                        label={<Trans>Description</Trans>}
+                        render={({ field }) => <Textarea {...field} />}
+                    />
+                </PageBlock>
+                <CustomFieldsPageBlock column="main" entityType="StockLocation" control={form.control} />
+            </PageLayout>
+        </Page>
+    );
+}