@vendure/ui-devkit 2.2.0-next.6 → 2.2.0-next.8

package/compiler/scaffold.js

@@ -146,17 +146,17 @@ function generateLazyExtensionRoutes(extensions) {
     for (const extension of extensions) {
         for (const module of extension.ngModules ?? []) {
             if (module.type === 'lazy') {
-                routes.push(`  {
-    path: 'extensions/${module.route}',
-    loadChildren: () => import('${getModuleFilePath(extension.id, module)}').then(m => m.${module.ngModuleName}),
+                routes.push(`  {
+    path: 'extensions/${module.route}',
+    loadChildren: () => import('${getModuleFilePath(extension.id, module)}').then(m => m.${module.ngModuleName}),
   }`);
             }
         }
         for (const route of extension.routes ?? []) {
             const prefix = route.prefix === '' ? '' : `${route.prefix ?? 'extensions'}/`;
-            routes.push(`  {
-    path: '${prefix}${route.route}',
-    loadChildren: () => import('./extensions/${extension.id}/${path.basename(route.filePath, '.ts')}'),
+            routes.push(`  {
+    path: '${prefix}${route.route}',
+    loadChildren: () => import('./extensions/${extension.id}/${path.basename(route.filePath, '.ts')}'),
   }`);
         }
     }
@@ -189,16 +189,16 @@ function generateSharedExtensionModule(extensions) {
         .map((m, i) => (m.providers ?? []).map((f, j) => `...SharedProviders_${i}_${j}`).join(', '))
         .filter(val => !!val)
         .join(', ');
-    return `import { NgModule } from '@angular/core';
-import { CommonModule } from '@angular/common';
-${moduleImports}
-${providerImports}
-
-@NgModule({
-    imports: [CommonModule, ${modules}],
-    providers: [${providers}],
-})
-export class SharedExtensionsModule {}
+    return `import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+${moduleImports}
+${providerImports}
+
+@NgModule({
+    imports: [CommonModule, ${modules}],
+    providers: [${providers}],
+})
+export class SharedExtensionsModule {}
 `;
 }
 function getModuleFilePath(id, module) {

package/compiler/types.d.ts

@@ -73,6 +73,37 @@ export interface SassVariableOverridesExtension {
      */
     sassVariableOverrides: string;
 }
+/**
+ * @description
+ * Defines a route which will be added to the Admin UI application.
+ *
+ * @docsCategory UiDevkit
+ * @docsPage AdminUiExtension
+ */
+export interface UiExtensionRouteDefinition {
+    /**
+     * @description
+     * The name of the route. This will be used as the path in the URL.
+     */
+    route: string;
+    /**
+     * @description
+     * The path to the file which exports an array of Angular route definitions.
+     */
+    filePath: string;
+    /**
+     * @description
+     * All extensions will be mounted under the `/extensions/` route. This option allows you to specify a
+     * custom prefix rather than `/extensions/`. For example, setting this to `custom` would cause the extension
+     * to be mounted at `/custom/<route>` instead.
+     *
+     * A common use case for this is to mount the extension at the root of the Admin UI, by setting this to an empty string.
+     * This is useful when the extension is intended to replace the default Admin UI, rather than extend it.
+     *
+     * @since 2.2.0
+     */
+    prefix?: string;
+}
 /**
  * @description
  * Defines extensions to the Admin UI application by specifying additional
@@ -119,30 +150,7 @@ export interface AdminUiExtension extends Partial<TranslationExtension>, Partial
      * Defines routes that will be lazy-loaded at the `/extensions/` route. The filePath should point to a file
      * relative to the `extensionPath` which exports an array of Angular route definitions.
      */
-    routes?: Array<{
-        /**
-         * @description
-         * The name of the route. This will be used as the path in the URL.
-         */
-        route: string;
-        /**
-         * @description
-         * The path to the file which exports an array of Angular route definitions.
-         */
-        filePath: string;
-        /**
-         * @description
-         * All extensions will be mounted under the `/extensions/` route. This option allows you to specify a
-         * custom prefix rather than `/extensions/`. For example, setting this to `custom` would cause the extension
-         * to be mounted at `/custom/<route>` instead.
-         *
-         * A common use case for this is to mount the extension at the root of the Admin UI, by setting this to an empty string.
-         * This is useful when the extension is intended to replace the default Admin UI, rather than extend it.
-         *
-         * @since 2.2.0
-         */
-        prefix?: string;
-    }>;
+    routes?: UiExtensionRouteDefinition[];
     /**
      * @description
      * An optional alias for the module so it can be referenced by other UI extension modules.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vendure/ui-devkit",
-    "version": "2.2.0-next.6",
+    "version": "2.2.0-next.8",
     "description": "A library for authoring Vendure Admin UI extensions",
     "keywords": [
         "vendure",
@@ -40,8 +40,8 @@
         "@angular/cli": "^17.2.3",
         "@angular/compiler": "^17.2.4",
         "@angular/compiler-cli": "^17.2.4",
-        "@vendure/admin-ui": "2.2.0-next.6",
-        "@vendure/common": "2.2.0-next.6",
+        "@vendure/admin-ui": "2.2.0-next.8",
+        "@vendure/common": "2.2.0-next.8",
         "chalk": "^4.1.0",
         "chokidar": "^3.6.0",
         "fs-extra": "^11.2.0",
@@ -52,7 +52,7 @@
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-terser": "^0.4.4",
         "@types/fs-extra": "^11.0.4",
-        "@vendure/core": "2.2.0-next.6",
+        "@vendure/core": "2.2.0-next.8",
         "react": "^18.2.0",
         "react-dom": "^18.2.0",
         "rimraf": "^5.0.5",
@@ -61,5 +61,5 @@
         "tslib": "^2.6.2",
         "typescript": "5.3.3"
     },
-    "gitHead": "2357477d705829080cfa912db0cf04eedadeaa6e"
+    "gitHead": "4a5aec3b43e4632cab8217107c23aacc3fbe5bfb"
 }

package/scaffold/src/app.routes.ts

@@ -1,52 +1,52 @@
-import { Route } from '@angular/router';
-import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
-import { AppShellComponent, AuthGuard } from '@vendure/admin-ui/core';
-
-import { extensionRoutes } from './extension.routes';
-
-export const routes: Route[] = [
-    { path: 'login', loadChildren: () => import('@vendure/admin-ui/login').then(m => m.LoginModule) },
-    {
-        path: '',
-        canActivate: [AuthGuard],
-        component: AppShellComponent,
-        data: {
-            breadcrumb: _('breadcrumb.dashboard'),
-        },
-        children: [
-            // Defining the extension routes before the built-in routes allows
-            // the extension routes to take precedence over the built-in routes, enabling
-            // the extensions to override built-in functionality.
-            ...extensionRoutes,
-            {
-                path: '',
-                pathMatch: 'full',
-                loadChildren: () => import('@vendure/admin-ui/dashboard').then(m => m.DashboardModule),
-            },
-            {
-                path: 'catalog',
-                loadChildren: () => import('@vendure/admin-ui/catalog').then(m => m.CatalogModule),
-            },
-            {
-                path: 'customer',
-                loadChildren: () => import('@vendure/admin-ui/customer').then(m => m.CustomerModule),
-            },
-            {
-                path: 'orders',
-                loadChildren: () => import('@vendure/admin-ui/order').then(m => m.OrderModule),
-            },
-            {
-                path: 'marketing',
-                loadChildren: () => import('@vendure/admin-ui/marketing').then(m => m.MarketingModule),
-            },
-            {
-                path: 'settings',
-                loadChildren: () => import('@vendure/admin-ui/settings').then(m => m.SettingsModule),
-            },
-            {
-                path: 'system',
-                loadChildren: () => import('@vendure/admin-ui/system').then(m => m.SystemModule),
-            },
-        ],
-    },
-];
+import { Route } from '@angular/router';
+import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
+import { AppShellComponent, AuthGuard } from '@vendure/admin-ui/core';
+
+import { extensionRoutes } from './extension.routes';
+
+export const routes: Route[] = [
+    { path: 'login', loadChildren: () => import('@vendure/admin-ui/login').then(m => m.LoginModule) },
+    {
+        path: '',
+        canActivate: [AuthGuard],
+        component: AppShellComponent,
+        data: {
+            breadcrumb: _('breadcrumb.dashboard'),
+        },
+        children: [
+            // Defining the extension routes before the built-in routes allows
+            // the extension routes to take precedence over the built-in routes, enabling
+            // the extensions to override built-in functionality.
+            ...extensionRoutes,
+            {
+                path: '',
+                pathMatch: 'full',
+                loadChildren: () => import('@vendure/admin-ui/dashboard').then(m => m.DashboardModule),
+            },
+            {
+                path: 'catalog',
+                loadChildren: () => import('@vendure/admin-ui/catalog').then(m => m.CatalogModule),
+            },
+            {
+                path: 'customer',
+                loadChildren: () => import('@vendure/admin-ui/customer').then(m => m.CustomerModule),
+            },
+            {
+                path: 'orders',
+                loadChildren: () => import('@vendure/admin-ui/order').then(m => m.OrderModule),
+            },
+            {
+                path: 'marketing',
+                loadChildren: () => import('@vendure/admin-ui/marketing').then(m => m.MarketingModule),
+            },
+            {
+                path: 'settings',
+                loadChildren: () => import('@vendure/admin-ui/settings').then(m => m.SettingsModule),
+            },
+            {
+                path: 'system',
+                loadChildren: () => import('@vendure/admin-ui/system').then(m => m.SystemModule),
+            },
+        ],
+    },
+];