@vendure/dashboard 3.2.0

package/src/lib/framework/defaults.ts

@@ -0,0 +1,219 @@
+import { setNavMenuConfig } from '@/framework/nav-menu/nav-menu-extensions.js';
+import {
+    LayoutDashboardIcon,
+    Mail,
+    Settings2,
+    ShoppingCart,
+    SquareTerminal,
+    Terminal,
+    Users,
+} from 'lucide-react';
+
+import { LatestOrdersWidget } from './dashboard-widget/latest-orders-widget/index.js';
+import { MetricsWidget } from './dashboard-widget/metrics-widget/index.js';
+import { OrdersSummaryWidget } from './dashboard-widget/orders-summary/index.js';
+import { registerDashboardWidget } from './dashboard-widget/widget-extensions.js';
+
+export function registerDefaults() {
+    setNavMenuConfig({
+        sections: [
+            {
+                id: 'dashboard',
+                title: 'Dashboard',
+                placement: 'top',
+                icon: LayoutDashboardIcon,
+                url: '/',
+            },
+            {
+                id: 'catalog',
+                title: 'Catalog',
+                icon: SquareTerminal,
+                defaultOpen: true,
+                placement: 'top',
+                items: [
+                    {
+                        id: 'products',
+                        title: 'Products',
+                        url: '/products',
+                    },
+                    {
+                        id: 'product-variants',
+                        title: 'Product Variants',
+                        url: '/product-variants',
+                    },
+                    {
+                        id: 'facets',
+                        title: 'Facets',
+                        url: '/facets',
+                    },
+                    {
+                        id: 'collections',
+                        title: 'Collections',
+                        url: '/collections',
+                    },
+                    {
+                        id: 'assets',
+                        title: 'Assets',
+                        url: '/assets',
+                    },
+                ],
+            },
+            {
+                id: 'sales',
+                title: 'Sales',
+                icon: ShoppingCart,
+                defaultOpen: true,
+                placement: 'top',
+                items: [
+                    {
+                        id: 'orders',
+                        title: 'Orders',
+                        url: '/orders',
+                    },
+                ],
+            },
+            {
+                id: 'customers',
+                title: 'Customers',
+                icon: Users,
+                defaultOpen: false,
+                placement: 'top',
+                items: [
+                    {
+                        id: 'customers',
+                        title: 'Customers',
+                        url: '/customers',
+                    },
+                    {
+                        id: 'customer-groups',
+                        title: 'Customer Groups',
+                        url: '/customer-groups',
+                    },
+                ],
+            },
+            {
+                id: 'marketing',
+                title: 'Marketing',
+                icon: Mail,
+                defaultOpen: false,
+                placement: 'top',
+                items: [
+                    {
+                        id: 'promotions',
+                        title: 'Promotions',
+                        url: '/promotions',
+                    },
+                ],
+            },
+            {
+                id: 'system',
+                title: 'System',
+                icon: Terminal,
+                defaultOpen: false,
+                placement: 'bottom',
+                items: [
+                    {
+                        id: 'job-queue',
+                        title: 'Job Queue',
+                        url: '/job-queue',
+                    },
+                    {
+                        id: 'healthchecks',
+                        title: 'Healthchecks',
+                        url: '/healthchecks',
+                    },
+                ],
+            },
+            {
+                id: 'settings',
+                title: 'Settings',
+                icon: Settings2,
+                defaultOpen: false,
+                placement: 'bottom',
+                items: [
+                    {
+                        id: 'sellers',
+                        title: 'Sellers',
+                        url: '/sellers',
+                    },
+                    {
+                        id: 'channels',
+                        title: 'Channels',
+                        url: '/channels',
+                    },
+                    {
+                        id: 'stock-locations',
+                        title: 'Stock Locations',
+                        url: '/stock-locations',
+                    },
+                    {
+                        id: 'administrators',
+                        title: 'Administrators',
+                        url: '/administrators',
+                    },
+                    {
+                        id: 'roles',
+                        title: 'Roles',
+                        url: '/roles',
+                    },
+                    {
+                        id: 'shipping-methods',
+                        title: 'Shipping Methods',
+                        url: '/shipping-methods',
+                    },
+                    {
+                        id: 'payment-methods',
+                        title: 'Payment Methods',
+                        url: '/payment-methods',
+                    },
+                    {
+                        id: 'tax-categories',
+                        title: 'Tax Categories',
+                        url: '/tax-categories',
+                    },
+                    {
+                        id: 'tax-rates',
+                        title: 'Tax Rates',
+                        url: '/tax-rates',
+                    },
+                    {
+                        id: 'countries',
+                        title: 'Countries',
+                        url: '/countries',
+                    },
+                    {
+                        id: 'zones',
+                        title: 'Zones',
+                        url: '/zones',
+                    },
+                    {
+                        id: 'global-settings',
+                        title: 'Global Settings',
+                        url: '/global-settings',
+                    },
+                ],
+            },
+        ],
+    });
+
+    registerDashboardWidget({
+        id: 'metrics-widget',
+        name: 'Metrics Widget',
+        component: MetricsWidget,
+        defaultSize: { w: 12, h: 6, x: 0, y: 0 },
+    });
+
+    registerDashboardWidget({
+        id: 'latest-orders-widget',
+        name: 'Latest Orders Widget',
+        component: LatestOrdersWidget,
+        defaultSize: { w: 6, h: 7, x: 0, y: 0 },
+    });
+
+    registerDashboardWidget({
+        id: 'orders-summary-widget',
+        name: 'Orders Summary Widget',
+        component: OrdersSummaryWidget,
+        defaultSize: { w: 6, h: 3, x: 6, y: 0 },
+    });
+}

package/src/lib/framework/document-introspection/add-custom-fields.spec.ts

@@ -0,0 +1,242 @@
+import { CustomFieldConfig, CustomFields } from '@vendure/common/lib/generated-types';
+import { graphql } from 'gql.tada';
+import {
+    DocumentNode,
+    FieldNode,
+    FragmentDefinitionNode,
+    Kind,
+    OperationDefinitionNode,
+    print,
+} from 'graphql';
+import { describe, it, expect, beforeEach } from 'vitest';
+
+import { addCustomFields } from './add-custom-fields.js';
+
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+describe('addCustomFields()', () => {
+    /**
+     * Normalizes the indentation of a string to make it easier to compare with the expected output
+     */
+    function normalizeIndentation(str: string): string {
+        const lines = str.replace(/    /g, '  ').split('\n');
+        const indentLength = lines[1].search(/\S|$/); // Find the first non-whitespace character
+        return lines
+            .map(line => line.slice(indentLength))
+            .join('\n')
+            .trim()
+            .replace(/"/g, '');
+    }
+
+    describe('Query handling', () => {
+        it('Adds customFields to entity query', () => {
+            const documentNode = graphql(`
+                query GetProduct {
+                    product {
+                        id
+                        name
+                    }
+                }
+            `);
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [
+                { name: 'custom1', type: 'string', list: false },
+                { name: 'custom2', type: 'boolean', list: false },
+            ]);
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+
+            expect(print(result)).toBe(
+                normalizeIndentation(`
+                query GetProduct {
+                    product {
+                        id
+                        name
+                        customFields {
+                            custom1
+                            custom2
+                        }
+                    }
+                }
+            `),
+            );
+        });
+
+        it('Adds customFields to paginated list', () => {
+            const documentNode = graphql(`
+                query GetProducts {
+                    products {
+                        items {
+                            id
+                            name
+                        }
+                    }
+                }
+            `);
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [
+                { name: 'custom1', type: 'string', list: false },
+                { name: 'custom2', type: 'boolean', list: false },
+            ]);
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            expect(print(result)).toBe(
+                normalizeIndentation(`
+                query GetProducts {
+                    products {
+                        items {
+                            id
+                            name
+                            customFields {
+                                custom1
+                                custom2
+                            }
+                        }
+                    }
+                }
+            `),
+            );
+        });
+    });
+
+    describe('Fragment handling', () => {
+        const productWithVariantsFragment = graphql(`
+            fragment ProductWithVariants on Product {
+                id
+                translations {
+                    languageCode
+                    name
+                }
+            }
+        `);
+
+        const productVariantFragment = graphql(`
+            fragment ProductVariant on ProductVariant {
+                id
+            }
+        `);
+
+        const productOptionGroupFragment = graphql(`
+            fragment ProductOptionGroup on ProductOptionGroup {
+                id
+            }
+        `);
+
+        const productOptionFragment = graphql(`
+            fragment ProductOption on ProductOption {
+                id
+            }
+        `);
+
+        const userFragment = graphql(`
+            fragment User on User {
+                id
+            }
+        `);
+
+        const customerFragment = graphql(`
+            fragment Customer on Customer {
+                id
+            }
+        `);
+
+        const addressFragment = graphql(`
+            fragment Address on Address {
+                id
+            }
+        `);
+
+        let documentNode: DocumentNode;
+
+        beforeEach(() => {
+            documentNode = graphql(
+                `
+                    query GetProductWithVariants {
+                        product {
+                            ...ProductWithVariants
+                        }
+                    }
+                `,
+                [productWithVariantsFragment],
+            );
+        });
+
+        it('Adds customFields to Product fragment', () => {
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [
+                { name: 'custom1', type: 'string', list: false },
+                { name: 'custom2', type: 'boolean', list: false },
+            ]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const productFragmentDef = result.definitions[1] as FragmentDefinitionNode;
+            const customFieldsDef = productFragmentDef.selectionSet.selections[2] as FieldNode;
+            expect(productFragmentDef.selectionSet.selections.length).toBe(3);
+            expect(customFieldsDef.selectionSet!.selections.length).toBe(2);
+            expect((customFieldsDef.selectionSet!.selections[0] as FieldNode).name.value).toBe('custom1');
+            expect((customFieldsDef.selectionSet!.selections[1] as FieldNode).name.value).toBe('custom2');
+        });
+
+        it('Adds customFields to Product translations', () => {
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [
+                { name: 'customLocaleString', type: 'localeString', list: false },
+            ]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const productFragmentDef = result.definitions[1] as FragmentDefinitionNode;
+            const translationsField = productFragmentDef.selectionSet.selections[1] as FieldNode;
+            const customTranslationFieldsDef = translationsField.selectionSet!.selections[2] as FieldNode;
+            expect(translationsField.selectionSet!.selections.length).toBe(3);
+            expect((customTranslationFieldsDef.selectionSet!.selections[0] as FieldNode).name.value).toBe(
+                'customLocaleString',
+            );
+        });
+
+        function addsCustomFieldsToType(type: keyof CustomFields, fragment: DocumentNode) {
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set(type, [{ name: 'custom', type: 'boolean', list: false }]);
+
+            const result = addCustomFields(fragment, { customFieldsMap: customFieldsConfig });
+            const fragmentDef = result.definitions[0] as FragmentDefinitionNode;
+            const customFieldsDef = fragmentDef.selectionSet.selections[1] as FieldNode;
+            expect(fragmentDef.selectionSet.selections.length).toBe(2);
+            expect(customFieldsDef.selectionSet!.selections.length).toBe(1);
+            expect((customFieldsDef.selectionSet!.selections[0] as FieldNode).name.value).toBe('custom');
+        }
+
+        it('Does not duplicate customFields selection set', () => {
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [{ name: 'custom', type: 'boolean', list: false }]);
+            const result1 = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const result2 = addCustomFields(result1, { customFieldsMap: customFieldsConfig });
+
+            const fragmentDef = result2.definitions[1] as FragmentDefinitionNode;
+            const customFieldSelections = fragmentDef.selectionSet.selections.filter(
+                s => s.kind === Kind.FIELD && s.name.value === 'customFields',
+            );
+            expect(customFieldSelections.length).toBe(1);
+        });
+
+        it('Adds customFields to ProductVariant fragment', () => {
+            addsCustomFieldsToType('ProductVariant', productVariantFragment);
+        });
+
+        it('Adds customFields to ProductOptionGroup fragment', () => {
+            addsCustomFieldsToType('ProductOptionGroup', productOptionGroupFragment);
+        });
+
+        it('Adds customFields to ProductOption fragment', () => {
+            addsCustomFieldsToType('ProductOption', productOptionFragment);
+        });
+
+        it('Adds customFields to User fragment', () => {
+            addsCustomFieldsToType('User', userFragment);
+        });
+
+        it('Adds customFields to Customer fragment', () => {
+            addsCustomFieldsToType('Customer', customerFragment);
+        });
+
+        it('Adds customFields to Address fragment', () => {
+            addsCustomFieldsToType('Address', addressFragment);
+        });
+    });
+});