@wilshop/dashboard 3.5.2

package/src/lib/framework/defaults.ts

@@ -0,0 +1,270 @@
+import { registerAlert } from '@/vdb/framework/alert/alert-extensions.js';
+import { searchIndexBufferAlert } from '@/vdb/framework/alert/search-index-buffer-alert/search-index-buffer-alert.js';
+import { setNavMenuConfig } from '@/vdb/framework/nav-menu/nav-menu-extensions.js';
+import { ChartLine, Percent, Settings2, ShoppingBag, Tags, 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: 'insights',
+                title: /* i18n*/ 'Insights',
+                placement: 'top',
+                icon: ChartLine,
+                url: '/',
+                order: 100,
+            },
+            {
+                id: 'catalog',
+                title: /* i18n*/ 'Catalog',
+                icon: Tags,
+                placement: 'top',
+                order: 200,
+                items: [
+                    {
+                        id: 'products',
+                        title: /* i18n*/ 'Products',
+                        url: '/products',
+                        order: 100,
+                        requiresPermission: ['ReadProduct', 'ReadCatalog'],
+                    },
+                    {
+                        id: 'product-variants',
+                        title: /* i18n*/ 'Product Variants',
+                        url: '/product-variants',
+                        order: 200,
+                        requiresPermission: ['ReadProduct', 'ReadCatalog'],
+                    },
+                    {
+                        id: 'facets',
+                        title: /* i18n*/ 'Facets',
+                        url: '/facets',
+                        order: 300,
+                        requiresPermission: ['ReadProduct', 'ReadCatalog'],
+                    },
+                    {
+                        id: 'collections',
+                        title: /* i18n*/ 'Collections',
+                        url: '/collections',
+                        order: 400,
+                        requiresPermission: ['ReadCollection', 'ReadCatalog'],
+                    },
+                    {
+                        id: 'assets',
+                        title: /* i18n*/ 'Assets',
+                        url: '/assets',
+                        order: 500,
+                        requiresPermission: ['ReadAsset', 'ReadCatalog'],
+                    },
+                ],
+            },
+            {
+                id: 'sales',
+                title: /* i18n*/ 'Sales',
+                icon: ShoppingBag,
+                placement: 'top',
+                order: 300,
+                items: [
+                    {
+                        id: 'orders',
+                        title: /* i18n*/ 'Orders',
+                        url: '/orders',
+                        order: 100,
+                        requiresPermission: ['ReadOrder'],
+                    },
+                ],
+            },
+            {
+                id: 'customers',
+                title: /* i18n*/ 'Customers',
+                icon: Users,
+                placement: 'top',
+                order: 400,
+                items: [
+                    {
+                        id: 'customers',
+                        title: /* i18n*/ 'Customers',
+                        url: '/customers',
+                        order: 100,
+                        requiresPermission: ['ReadCustomer'],
+                    },
+                    {
+                        id: 'customer-groups',
+                        title: /* i18n*/ 'Customer Groups',
+                        url: '/customer-groups',
+                        order: 200,
+                        requiresPermission: ['ReadCustomerGroup'],
+                    },
+                ],
+            },
+            {
+                id: 'marketing',
+                title: /* i18n*/ 'Marketing',
+                icon: Percent,
+                placement: 'top',
+                order: 500,
+                items: [
+                    {
+                        id: 'promotions',
+                        title: /* i18n*/ 'Promotions',
+                        url: '/promotions',
+                        order: 100,
+                        requiresPermission: ['ReadPromotion'],
+                    },
+                ],
+            },
+            {
+                id: 'system',
+                title: /* i18n*/ 'System',
+                icon: Terminal,
+                placement: 'bottom',
+                order: 200,
+                items: [
+                    {
+                        id: 'job-queue',
+                        title: /* i18n*/ 'Job Queue',
+                        url: '/job-queue',
+                        order: 100,
+                        requiresPermission: ['ReadSystem'],
+                    },
+                    {
+                        id: 'healthchecks',
+                        title: /* i18n*/ 'Healthchecks',
+                        url: '/healthchecks',
+                        order: 200,
+                        requiresPermission: ['ReadSystem'],
+                    },
+                    {
+                        id: 'scheduled-tasks',
+                        title: /* i18n*/ 'Scheduled Tasks',
+                        url: '/scheduled-tasks',
+                        order: 300,
+                        requiresPermission: ['ReadSystem'],
+                    },
+                ],
+            },
+            {
+                id: 'settings',
+                title: /* i18n*/ 'Settings',
+                icon: Settings2,
+                placement: 'bottom',
+                order: 100,
+                items: [
+                    {
+                        id: 'sellers',
+                        title: /* i18n*/ 'Sellers',
+                        url: '/sellers',
+                        order: 100,
+                        requiresPermission: ['ReadSeller'],
+                    },
+                    {
+                        id: 'channels',
+                        title: /* i18n*/ 'Channels',
+                        url: '/channels',
+                        order: 200,
+                        requiresPermission: ['ReadChannel'],
+                    },
+                    {
+                        id: 'stock-locations',
+                        title: /* i18n*/ 'Stock Locations',
+                        url: '/stock-locations',
+                        order: 300,
+                        requiresPermission: ['ReadStockLocation'],
+                    },
+                    {
+                        id: 'administrators',
+                        title: /* i18n*/ 'Administrators',
+                        url: '/administrators',
+                        order: 400,
+                        requiresPermission: ['ReadAdministrator'],
+                    },
+                    {
+                        id: 'roles',
+                        title: /* i18n*/ 'Roles',
+                        url: '/roles',
+                        order: 500,
+                        requiresPermission: ['ReadAdministrator'],
+                    },
+                    {
+                        id: 'shipping-methods',
+                        title: /* i18n*/ 'Shipping Methods',
+                        url: '/shipping-methods',
+                        order: 600,
+                        requiresPermission: ['ReadShippingMethod'],
+                    },
+                    {
+                        id: 'payment-methods',
+                        title: /* i18n*/ 'Payment Methods',
+                        url: '/payment-methods',
+                        order: 700,
+                        requiresPermission: ['ReadPaymentMethod'],
+                    },
+                    {
+                        id: 'tax-categories',
+                        title: /* i18n*/ 'Tax Categories',
+                        url: '/tax-categories',
+                        order: 800,
+                        requiresPermission: ['ReadTaxCategory'],
+                    },
+                    {
+                        id: 'tax-rates',
+                        title: /* i18n*/ 'Tax Rates',
+                        url: '/tax-rates',
+                        order: 900,
+                        requiresPermission: ['ReadTaxRate'],
+                    },
+                    {
+                        id: 'countries',
+                        title: /* i18n*/ 'Countries',
+                        url: '/countries',
+                        order: 1000,
+                        requiresPermission: ['ReadCountry'],
+                    },
+                    {
+                        id: 'zones',
+                        title: /* i18n*/ 'Zones',
+                        url: '/zones',
+                        order: 1100,
+                        requiresPermission: ['ReadZone'],
+                    },
+                    {
+                        id: 'global-settings',
+                        title: /* i18n*/ 'Global Settings',
+                        url: '/global-settings',
+                        order: 1200,
+                        requiresPermission: ['UpdateGlobalSettings'],
+                    },
+                ],
+            },
+        ],
+    });
+
+    registerDashboardWidget({
+        id: 'metrics-widget',
+        name: /* i18n*/ 'Metrics Widget',
+        component: MetricsWidget,
+        defaultSize: { w: 12, h: 6, x: 0, y: 0 },
+        minSize: { w: 6, h: 4 },
+    });
+
+    registerDashboardWidget({
+        id: '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: /* i18n*/ 'Orders Summary Widget',
+        component: OrdersSummaryWidget,
+        defaultSize: { w: 6, h: 3, x: 6, y: 0 },
+    });
+
+    registerAlert(searchIndexBufferAlert);
+}

package/src/lib/framework/document-extension/extend-detail-form-query.ts

@@ -0,0 +1,50 @@
+import { extendDocument } from '@/vdb/framework/document-extension/extend-document.js';
+import { getDetailQueryDocuments } from '@/vdb/framework/form-engine/custom-form-component-extensions.js';
+import { DocumentNode } from 'graphql';
+
+/**
+ * @description
+ * Extends a detail page query document with any registered extensions provided by
+ * the `extendDetailDocument` function for the given page.
+ */
+export function extendDetailFormQuery<T extends DocumentNode>(
+    detailQuery: T,
+    pageId?: string,
+): {
+    extendedQuery: T;
+    errorMessage?: string | null;
+} {
+    let result: T = detailQuery;
+    let errorMessage: string | null = null;
+
+    if (!pageId) {
+        // If no pageId is provided, return the original query without any extensions
+        return { extendedQuery: detailQuery };
+    }
+
+    const detailQueryExtensions = getDetailQueryDocuments(pageId);
+
+    try {
+        result = detailQueryExtensions.reduce(
+            (acc, extension) => extendDocument(acc, extension),
+            detailQuery,
+        ) as T;
+    } catch (err) {
+        errorMessage = err instanceof Error ? err.message : String(err);
+        // Continue with the original query instead of the extended one
+        result = detailQuery;
+    }
+
+    // Store error for useEffect to handle
+    if (errorMessage) {
+        // Log the error and continue with the original query
+        // eslint-disable-next-line no-console
+        console.warn(`${errorMessage}. Continuing with original query.`, {
+            pageId,
+            extensionsCount: detailQueryExtensions.length,
+            error: errorMessage,
+        });
+    }
+
+    return { extendedQuery: result, errorMessage };
+}