@vendure/dashboard 3.4.3-master-202509260228 → 3.5.0-minor-202510012036

package/src/lib/framework/defaults.ts

@@ -19,7 +19,7 @@ export function registerDefaults() {
         sections: [
             {
                 id: 'insights',
-                title: 'Insights',
+                title: /* i18n*/ 'Insights',
                 placement: 'top',
                 icon: LayoutDashboardIcon,
                 url: '/',
@@ -27,42 +27,42 @@ export function registerDefaults() {
             },
             {
                 id: 'catalog',
-                title: 'Catalog',
+                title: /* i18n*/ 'Catalog',
                 icon: SquareTerminal,
                 placement: 'top',
                 order: 200,
                 items: [
                     {
                         id: 'products',
-                        title: 'Products',
+                        title: /* i18n*/ 'Products',
                         url: '/products',
                         order: 100,
                         requiresPermission: ['ReadProduct', 'ReadCatalog'],
                     },
                     {
                         id: 'product-variants',
-                        title: 'Product Variants',
+                        title: /* i18n*/ 'Product Variants',
                         url: '/product-variants',
                         order: 200,
                         requiresPermission: ['ReadProduct', 'ReadCatalog'],
                     },
                     {
                         id: 'facets',
-                        title: 'Facets',
+                        title: /* i18n*/ 'Facets',
                         url: '/facets',
                         order: 300,
                         requiresPermission: ['ReadProduct', 'ReadCatalog'],
                     },
                     {
                         id: 'collections',
-                        title: 'Collections',
+                        title: /* i18n*/ 'Collections',
                         url: '/collections',
                         order: 400,
                         requiresPermission: ['ReadCollection', 'ReadCatalog'],
                     },
                     {
                         id: 'assets',
-                        title: 'Assets',
+                        title: /* i18n*/ 'Assets',
                         url: '/assets',
                         order: 500,
                         requiresPermission: ['ReadAsset', 'ReadCatalog'],
@@ -71,14 +71,14 @@ export function registerDefaults() {
             },
             {
                 id: 'sales',
-                title: 'Sales',
+                title: /* i18n*/ 'Sales',
                 icon: ShoppingCart,
                 placement: 'top',
                 order: 300,
                 items: [
                     {
                         id: 'orders',
-                        title: 'Orders',
+                        title: /* i18n*/ 'Orders',
                         url: '/orders',
                         order: 100,
                         requiresPermission: ['ReadOrder'],
@@ -87,21 +87,21 @@ export function registerDefaults() {
             },
             {
                 id: 'customers',
-                title: 'Customers',
+                title: /* i18n*/ 'Customers',
                 icon: Users,
                 placement: 'top',
                 order: 400,
                 items: [
                     {
                         id: 'customers',
-                        title: 'Customers',
+                        title: /* i18n*/ 'Customers',
                         url: '/customers',
                         order: 100,
                         requiresPermission: ['ReadCustomer'],
                     },
                     {
                         id: 'customer-groups',
-                        title: 'Customer Groups',
+                        title: /* i18n*/ 'Customer Groups',
                         url: '/customer-groups',
                         order: 200,
                         requiresPermission: ['ReadCustomerGroup'],
@@ -110,14 +110,14 @@ export function registerDefaults() {
             },
             {
                 id: 'marketing',
-                title: 'Marketing',
+                title: /* i18n*/ 'Marketing',
                 icon: Mail,
                 placement: 'top',
                 order: 500,
                 items: [
                     {
                         id: 'promotions',
-                        title: 'Promotions',
+                        title: /* i18n*/ 'Promotions',
                         url: '/promotions',
                         order: 100,
                         requiresPermission: ['ReadPromotion'],
@@ -126,28 +126,28 @@ export function registerDefaults() {
             },
             {
                 id: 'system',
-                title: 'System',
+                title: /* i18n*/ 'System',
                 icon: Terminal,
                 placement: 'bottom',
                 order: 200,
                 items: [
                     {
                         id: 'job-queue',
-                        title: 'Job Queue',
+                        title: /* i18n*/ 'Job Queue',
                         url: '/job-queue',
                         order: 100,
                         requiresPermission: ['ReadSystem'],
                     },
                     {
                         id: 'healthchecks',
-                        title: 'Healthchecks',
+                        title: /* i18n*/ 'Healthchecks',
                         url: '/healthchecks',
                         order: 200,
                         requiresPermission: ['ReadSystem'],
                     },
                     {
                         id: 'scheduled-tasks',
-                        title: 'Scheduled Tasks',
+                        title: /* i18n*/ 'Scheduled Tasks',
                         url: '/scheduled-tasks',
                         order: 300,
                         requiresPermission: ['ReadSystem'],
@@ -156,91 +156,91 @@ export function registerDefaults() {
             },
             {
                 id: 'settings',
-                title: 'Settings',
+                title: /* i18n*/ 'Settings',
                 icon: Settings2,
                 placement: 'bottom',
                 order: 100,
                 items: [
                     {
                         id: 'sellers',
-                        title: 'Sellers',
+                        title: /* i18n*/ 'Sellers',
                         url: '/sellers',
                         order: 100,
                         requiresPermission: ['ReadSeller'],
                     },
                     {
                         id: 'channels',
-                        title: 'Channels',
+                        title: /* i18n*/ 'Channels',
                         url: '/channels',
                         order: 200,
                         requiresPermission: ['ReadChannel'],
                     },
                     {
                         id: 'stock-locations',
-                        title: 'Stock Locations',
+                        title: /* i18n*/ 'Stock Locations',
                         url: '/stock-locations',
                         order: 300,
                         requiresPermission: ['ReadStockLocation'],
                     },
                     {
                         id: 'administrators',
-                        title: 'Administrators',
+                        title: /* i18n*/ 'Administrators',
                         url: '/administrators',
                         order: 400,
                         requiresPermission: ['ReadAdministrator'],
                     },
                     {
                         id: 'roles',
-                        title: 'Roles',
+                        title: /* i18n*/ 'Roles',
                         url: '/roles',
                         order: 500,
                         requiresPermission: ['ReadAdministrator'],
                     },
                     {
                         id: 'shipping-methods',
-                        title: 'Shipping Methods',
+                        title: /* i18n*/ 'Shipping Methods',
                         url: '/shipping-methods',
                         order: 600,
                         requiresPermission: ['ReadShippingMethod'],
                     },
                     {
                         id: 'payment-methods',
-                        title: 'Payment Methods',
+                        title: /* i18n*/ 'Payment Methods',
                         url: '/payment-methods',
                         order: 700,
                         requiresPermission: ['ReadPaymentMethod'],
                     },
                     {
                         id: 'tax-categories',
-                        title: 'Tax Categories',
+                        title: /* i18n*/ 'Tax Categories',
                         url: '/tax-categories',
                         order: 800,
                         requiresPermission: ['ReadTaxCategory'],
                     },
                     {
                         id: 'tax-rates',
-                        title: 'Tax Rates',
+                        title: /* i18n*/ 'Tax Rates',
                         url: '/tax-rates',
                         order: 900,
                         requiresPermission: ['ReadTaxRate'],
                     },
                     {
                         id: 'countries',
-                        title: 'Countries',
+                        title: /* i18n*/ 'Countries',
                         url: '/countries',
                         order: 1000,
                         requiresPermission: ['ReadCountry'],
                     },
                     {
                         id: 'zones',
-                        title: 'Zones',
+                        title: /* i18n*/ 'Zones',
                         url: '/zones',
                         order: 1100,
                         requiresPermission: ['ReadZone'],
                     },
                     {
                         id: 'global-settings',
-                        title: 'Global Settings',
+                        title: /* i18n*/ 'Global Settings',
                         url: '/global-settings',
                         order: 1200,
                         requiresPermission: ['UpdateGlobalSettings'],
@@ -252,7 +252,7 @@ export function registerDefaults() {
 
     registerDashboardWidget({
         id: 'metrics-widget',
-        name: 'Metrics Widget',
+        name: /* i18n*/ 'Metrics Widget',
         component: MetricsWidget,
         defaultSize: { w: 12, h: 6, x: 0, y: 0 },
         minSize: { w: 6, h: 4 },
@@ -260,44 +260,15 @@ export function registerDefaults() {
 
     registerDashboardWidget({
         id: 'latest-orders-widget',
-        name: 'Latest Orders Widget',
+        name: /* i18n*/ 'Latest Orders Widget',
         component: LatestOrdersWidget,
         defaultSize: { w: 6, h: 7, x: 0, y: 0 },
     });
 
     registerDashboardWidget({
         id: 'orders-summary-widget',
-        name: 'Orders Summary Widget',
+        name: /* i18n*/ 'Orders Summary Widget',
         component: OrdersSummaryWidget,
         defaultSize: { w: 6, h: 3, x: 6, y: 0 },
     });
-
-    // registerAlert<boolean>({
-    //     id: 'test-alert',
-    //     title: data => `Test Alert ${String(data)}`,
-    //     description: 'This is a test alert',
-    //     severity: 'info',
-    //     check: () => Promise.resolve(true),
-    //     actions: [
-    //         {
-    //             label: 'Test Action',
-    //             onClick: () => console.log('Test Action'),
-    //         },
-    //     ],
-    // });
-
-    // registerAlert<boolean>({
-    //     id: 'test-alert-2',
-    //     title: 'Test Alert 2',
-    //     description: 'This is a test alert 2',
-    //     severity: 'info',
-    //     check: () => Promise.resolve(true),
-    //     shouldShow: data => data === true,
-    //     actions: [
-    //         {
-    //             label: 'Test Action',
-    //             onClick: () => console.log('Test Action'),
-    //         },
-    //     ],
-    // });
 }

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

@@ -1,14 +1,7 @@
 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 { DocumentNode, FieldNode, FragmentDefinitionNode, Kind, print } from 'graphql';
+import { beforeEach, describe, expect, it } from 'vitest';
 
 import { addCustomFields } from './add-custom-fields.js';
 
@@ -239,4 +232,321 @@ describe('addCustomFields()', () => {
             addsCustomFieldsToType('Address', addressFragment);
         });
     });
+
+    describe('Nested entity handling', () => {
+        it('User example: Should not add custom fields to Asset fragment used in nested featuredAsset', () => {
+            const assetFragment = graphql(`
+                fragment Asset on Asset {
+                    id
+                    createdAt
+                    updatedAt
+                    name
+                    fileSize
+                    mimeType
+                    type
+                    preview
+                    source
+                    width
+                    height
+                    focalPoint {
+                        x
+                        y
+                    }
+                }
+            `);
+
+            const documentNode = graphql(
+                `
+                    query CollectionList($options: CollectionListOptions) {
+                        collections(options: $options) {
+                            items {
+                                id
+                                createdAt
+                                updatedAt
+                                featuredAsset {
+                                    ...Asset
+                                }
+                                name
+                                slug
+                                breadcrumbs {
+                                    id
+                                    name
+                                    slug
+                                }
+                                children {
+                                    id
+                                    name
+                                }
+                                position
+                                isPrivate
+                                parentId
+                                productVariants {
+                                    totalItems
+                                }
+                            }
+                            totalItems
+                        }
+                    }
+                `,
+                [assetFragment],
+            );
+
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Collection', [
+                { name: 'featuredProducts', type: 'relation', list: true, scalarFields: ['id', 'name'] },
+                { name: 'alternativeAsset', type: 'relation', list: false, scalarFields: ['id', 'name'] },
+            ]);
+            customFieldsConfig.set('Asset', [
+                { name: 'assetCustomField1', type: 'string', list: false },
+                { name: 'assetCustomField2', type: 'string', list: false },
+                { name: 'assetCustomField3', type: 'string', list: false },
+            ]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const printed = print(result);
+
+            // Should add customFields ONLY to Collection items (top-level entity)
+            expect(printed).toContain('customFields {');
+            expect(printed).toContain('featuredProducts {');
+            expect(printed).toContain('alternativeAsset {');
+
+            // Should NOT add customFields to Asset fragment (only used in nested context)
+            const fragmentMatch = printed.match(/fragment Asset on Asset\s*\{[^}]*\}/s);
+            expect(fragmentMatch).toBeTruthy();
+            expect(fragmentMatch![0]).not.toContain('customFields');
+            expect(fragmentMatch![0]).not.toContain('assetCustomField1');
+
+            // Should NOT add customFields to children (nested Collection entities)
+            const childrenMatch = printed.match(/children\s*\{[^}]+\}/s);
+            expect(childrenMatch).toBeTruthy();
+            expect(childrenMatch![0]).not.toContain('customFields');
+
+            // Should NOT add customFields to breadcrumbs
+            const breadcrumbsMatch = printed.match(/breadcrumbs\s*\{[^}]+\}/s);
+            expect(breadcrumbsMatch).toBeTruthy();
+            expect(breadcrumbsMatch![0]).not.toContain('customFields');
+        });
+
+        it('Should only add custom fields to top-level entity, not nested related entities', () => {
+            const documentNode = graphql(`
+                query CollectionList($options: CollectionListOptions) {
+                    collections(options: $options) {
+                        items {
+                            id
+                            name
+                            slug
+                            featuredAsset {
+                                id
+                                preview
+                            }
+                            children {
+                                id
+                                name
+                                slug
+                            }
+                            breadcrumbs {
+                                id
+                                name
+                                slug
+                            }
+                        }
+                        totalItems
+                    }
+                }
+            `);
+
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Collection', [
+                { name: 'featuredProducts', type: 'relation', list: true, scalarFields: ['id', 'name'] },
+                { name: 'alternativeAsset', type: 'relation', list: false, scalarFields: ['id', 'name'] },
+            ]);
+            customFieldsConfig.set('Asset', [
+                { name: 'assetCustomField1', type: 'string', list: false },
+                { name: 'assetCustomField2', type: 'string', list: false },
+            ]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const printed = print(result);
+
+            // Should add customFields to top-level Collection (items)
+            expect(printed).toContain('customFields {');
+            expect(printed).toContain('featuredProducts {');
+            expect(printed).toContain('alternativeAsset {');
+
+            // Should NOT add customFields to nested Collection entities (children, breadcrumbs)
+            const childrenMatch = printed.match(/children\s*\{[^}]+\}/s);
+            const breadcrumbsMatch = printed.match(/breadcrumbs\s*\{[^}]+\}/s);
+
+            expect(childrenMatch).toBeTruthy();
+            expect(breadcrumbsMatch).toBeTruthy();
+            expect(childrenMatch![0]).not.toContain('customFields');
+            expect(breadcrumbsMatch![0]).not.toContain('customFields');
+
+            // Should NOT add customFields to nested Asset entity (featuredAsset)
+            const featuredAssetMatch = printed.match(/featuredAsset\s*\{[^}]+\}/s);
+            expect(featuredAssetMatch).toBeTruthy();
+            expect(featuredAssetMatch![0]).not.toContain('customFields');
+            expect(featuredAssetMatch![0]).not.toContain('assetCustomField1');
+        });
+
+        it('Should NOT add custom fields to fragments that are only used in nested contexts', () => {
+            const assetFragment = graphql(`
+                fragment Asset on Asset {
+                    id
+                    name
+                    preview
+                }
+            `);
+
+            const documentNode = graphql(
+                `
+                    query ProductList($options: ProductListOptions) {
+                        products(options: $options) {
+                            items {
+                                id
+                                name
+                                featuredAsset {
+                                    ...Asset
+                                }
+                                variants {
+                                    id
+                                    name
+                                    assets {
+                                        ...Asset
+                                    }
+                                }
+                            }
+                            totalItems
+                        }
+                    }
+                `,
+                [assetFragment],
+            );
+
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [{ name: 'productCustomField', type: 'string', list: false }]);
+            customFieldsConfig.set('Asset', [{ name: 'assetCustomField', type: 'string', list: false }]);
+            customFieldsConfig.set('ProductVariant', [
+                { name: 'variantCustomField', type: 'string', list: false },
+            ]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const printed = print(result);
+
+            // Should add customFields to Product (top-level query entity)
+            expect(printed).toContain('customFields {');
+            expect(printed).toContain('productCustomField');
+
+            // Should NOT add customFields to Asset fragment (only used in nested contexts)
+            expect(printed).not.toMatch(/fragment Asset on Asset\s*\{[^}]*customFields/s);
+
+            // Should NOT add customFields to nested ProductVariant entities
+            const variantsMatch = printed.match(/variants\s*\{[^}]+\}/s);
+            expect(variantsMatch).toBeTruthy();
+            expect(variantsMatch![0]).not.toContain('customFields');
+            expect(variantsMatch![0]).not.toContain('variantCustomField');
+        });
+
+        it('Should add custom fields to fragments used at top level', () => {
+            const productFragment = graphql(`
+                fragment ProductDetails on Product {
+                    id
+                    name
+                    slug
+                }
+            `);
+
+            const documentNode = graphql(
+                `
+                    query ProductList($options: ProductListOptions) {
+                        products(options: $options) {
+                            items {
+                                ...ProductDetails
+                                featuredAsset {
+                                    id
+                                    preview
+                                }
+                            }
+                            totalItems
+                        }
+                    }
+                `,
+                [productFragment],
+            );
+
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Product', [{ name: 'productCustomField', type: 'string', list: false }]);
+            customFieldsConfig.set('Asset', [{ name: 'assetCustomField', type: 'string', list: false }]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const printed = print(result);
+
+            // Should add customFields to ProductDetails fragment (used at top level in items)
+            expect(printed).toContain('fragment ProductDetails on Product');
+            expect(printed).toContain('productCustomField');
+
+            // Should NOT add customFields to featuredAsset (nested entity)
+            const featuredAssetMatch = printed.match(/featuredAsset\s*\{[^}]+\}/s);
+            expect(featuredAssetMatch).toBeTruthy();
+            expect(featuredAssetMatch![0]).not.toContain('customFields');
+        });
+
+        it('Should handle complex nested structure with multiple entity types', () => {
+            const documentNode = graphql(`
+                query ComplexQuery {
+                    orders {
+                        items {
+                            id
+                            code
+                            customer {
+                                id
+                                firstName
+                                addresses {
+                                    id
+                                    streetLine1
+                                    country {
+                                        id
+                                        name
+                                    }
+                                }
+                            }
+                            lines {
+                                id
+                                productVariant {
+                                    id
+                                    name
+                                    product {
+                                        id
+                                        name
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            `);
+
+            const customFieldsConfig = new Map<string, CustomFieldConfig[]>();
+            customFieldsConfig.set('Order', [{ name: 'orderCustomField', type: 'string', list: false }]);
+            customFieldsConfig.set('Customer', [
+                { name: 'customerCustomField', type: 'string', list: false },
+            ]);
+            customFieldsConfig.set('Address', [{ name: 'addressCustomField', type: 'string', list: false }]);
+            customFieldsConfig.set('Product', [{ name: 'productCustomField', type: 'string', list: false }]);
+
+            const result = addCustomFields(documentNode, { customFieldsMap: customFieldsConfig });
+            const printed = print(result);
+
+            // Should only add customFields to top-level Order entity
+            expect(printed).toContain('customFields {');
+            expect(printed).toContain('orderCustomField');
+
+            // Should NOT add customFields to any nested entities
+            expect(printed).not.toMatch(/customer\s*\{[^}]*customFields/s);
+            expect(printed).not.toMatch(/addresses\s*\{[^}]*customFields/s);
+            expect(printed).not.toMatch(/country\s*\{[^}]*customFields/s);
+            expect(printed).not.toMatch(/productVariant\s*\{[^}]*customFields/s);
+            expect(printed).not.toMatch(/product\s*\{[^}]*customFields/s);
+        });
+    });
 });