@acorex/platform-generator 20.3.0-next.9 → 20.4.1

package/src/generators/app-module/files/src/app/modules/root/mock.data.ts.template

@@ -1,50 +1,26 @@
+//#region ----   Imports   ----
+
 import { AXPDataGenerator } from '@acorex/platform/core';
 
-export const USERS = Array.from({ length: 20 }).map((_, i) => {
+//#endregion
+
+//#region ----   Sample Mock Data   ----
+
+/**
+ * Mock data for Sample entity (20 items)
+ * Used by the mock service for testing and development
+ */
+export const SAMPLE_DATA = Array.from({ length: 20 }).map((_, i) => {
   const firstName = AXPDataGenerator.firstName();
   const lastName = AXPDataGenerator.lastName();
   return {
     id: AXPDataGenerator.uuid(),
     firstname: firstName,
     lastname: lastName,
-    phone: AXPDataGenerator.phone(),
     email: AXPDataGenerator.email(firstName, lastName),
+    phone: AXPDataGenerator.phone(),
     address: AXPDataGenerator.address(),
   };
 });
 
-export interface SampleEntity {
-  id: string;
-  name: string;
-  description: string;
-  isActive: boolean;
-  createdDate: Date;
-  category: string;
-}
-
-export const sampleData: SampleEntity[] = [
-  {
-    id: '1',
-    name: 'Sample Item 1',
-    description: 'This is a sample item for testing',
-    isActive: true,
-    createdDate: new Date(2024, 0, 15),
-    category: 'Category A'
-  },
-  {
-    id: '2',
-    name: 'Sample Item 2',
-    description: 'Another sample item with different data',
-    isActive: false,
-    createdDate: new Date(2024, 1, 20),
-    category: 'Category B'
-  },
-  {
-    id: '3',
-    name: 'Sample Item 3',
-    description: 'Third sample item for demonstration',
-    isActive: true,
-    createdDate: new Date(2024, 2, 5),
-    category: 'Category A'
-  }
-];
+//#endregion

package/src/generators/app-module/files/src/app/modules/root/permission-definition.provider.ts.template

@@ -0,0 +1,51 @@
+//#region ----   Imports   ----
+
+import { AXTranslationService } from '@acorex/core/translation';
+import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex/platform/auth';
+import { Injector } from '@angular/core';
+import { <%= className %>ModulePermissionsKeys } from './permission.keys';
+
+//#endregion
+
+//#region ----   Permission Definition Provider   ----
+
+export class <%= className %>ModulePermissionDefinitionProvider implements AXPPermissionDefinitionProvider {
+  
+  //#region ----   Services   ----
+
+  private readonly translateService = this.injector.get(AXTranslationService);
+
+  //#endregion
+
+  //#region ----   Constructor   ----
+
+  constructor(private injector: Injector) {}
+
+  //#endregion
+
+  //#region ----   Define Method   ----
+
+  async define(context: AXPPermissionDefinitionProviderContext): Promise<void> {
+    const trans = async (key: string) =>
+      await this.translateService.translateAsync(`permissions.<%= name %>-module.${key}`, {
+        scope: '<%= name %>-module',
+      });
+
+    const keys = <%= className %>ModulePermissionsKeys;
+
+    context
+      .addGroup(keys.Module.Management, await trans('manage.title'))
+      //
+      .addPermission(keys.Sample.Management, await trans('sample.manage.title'))
+      .addChild(keys.Sample.View, await trans('sample.view.title'))
+      .addChild(keys.Sample.Edit, await trans('sample.edit.title'))
+      .addChild(keys.Sample.Delete, await trans('sample.delete.title'))
+      .addChild(keys.Sample.Create, await trans('sample.create.title'))
+      .endPermission();
+  }
+
+  //#endregion
+}
+
+//#endregion
+

package/src/generators/app-module/files/src/app/modules/root/permission.keys.ts.template

@@ -0,0 +1,17 @@
+//#region ----   Permission Keys   ----
+
+export const <%= className %>ModulePermissionsKeys = {
+  Module: {
+    Management: '<%= name %>-module:manage',
+  },
+  Sample: {
+    Management: '<%= name %>-module:sample:manage',
+    View: '<%= name %>-module:sample:view',
+    Edit: '<%= name %>-module:sample:edit',
+    Delete: '<%= name %>-module:sample:delete',
+    Create: '<%= name %>-module:sample:create',
+  },
+};
+
+//#endregion
+

package/src/generators/app-module/files/src/app/modules/root/root.module.ts.template

@@ -1,9 +1,17 @@
-import { AXPAuthGuard } from '@acorex/platform/auth';
-import { AXPWidgetRegistryService } from '@acorex/platform/layout/builder';
+//#region ----   Imports   ----
+
+import { AXPAuthGuard, AXP_PERMISSION_DEFINITION_PROVIDER } from '@acorex/platform/auth';
+import { AXPWidgetRegistryService } from '@acorex/platform/layout/widget-core';
 import { AXPRootLayoutComponent } from '@acorex/platform/themes/default';
 import { CommonModule } from '@angular/common';
-import { inject, NgModule } from '@angular/core';
+import { inject, Injector, NgModule } from '@angular/core';
 import { RouterModule, Routes } from '@angular/router';
+import { AXP_MENU_PROVIDER, AXP_SEARCH_PROVIDER } from '@acorex/platform/common';
+import { AXMSampleEntityModule } from './sample/sample.module';
+import { <%= className %>ModuleMenuProvider } from './menu.provider';
+import { <%= className %>ModuleSearchCommandProvider } from './search-command.provider';
+
+//#endregion
 
 const routes: Routes = [
   {
@@ -15,25 +23,46 @@ const routes: Routes = [
         path: 'home',
         loadComponent: () => import('./home/home.page').then((c) => c.<%= className %>HomePage),
       },
-      {
-        canActivate: [AXPAuthGuard],
-        path: 'sample',
-        loadComponent: () => import('./sample/sample.component').then((c) => c.SampleComponent),
-      },
     ],
   },
 ];
 
+//#region ----   Module Definition   ----
+
 @NgModule({
   imports: [
     CommonModule,
-    RouterModule.forChild(routes)
+    RouterModule.forChild(routes),
+    //
+    AXMSampleEntityModule,
   ],
   exports: [RouterModule],
-  providers: [],
+  providers: [
+    {
+      provide: AXP_MENU_PROVIDER,
+      useClass: <%= className %>ModuleMenuProvider,
+      multi: true,
+    },
+    {
+      provide: AXP_PERMISSION_DEFINITION_PROVIDER,
+      useFactory: async () => {
+        const injector = inject(Injector);
+        const provider = (await import('./permission-definition.provider')).<%= className %>ModulePermissionDefinitionProvider;
+        return new provider(injector);
+      },
+      multi: true,
+    },
+    {
+      provide: AXP_SEARCH_PROVIDER,
+      useClass: <%= className %>ModuleSearchCommandProvider,
+      multi: true,
+    },
+  ],
   declarations: [],
 })
 export class <%= upperCase(name) %>RootModule {
   registry = inject(AXPWidgetRegistryService);
   extendedWidgets = [];
 }
+
+//#endregion

package/src/generators/app-module/files/src/app/modules/root/sample/index.ts.template

@@ -0,0 +1,9 @@
+//#region ----   Exports   ----
+
+export * from './sample.entity';
+export * from './sample.module';
+export * from './sample.service';
+export * from './sample.types';
+
+//#endregion
+

package/src/generators/app-module/files/src/app/modules/root/sample/sample.entity.ts.template

@@ -1,34 +1,68 @@
-import { AXPEntity, AXPEntityCommandScope, AXPEntityQueryType } from '@acorex/platform/common';
-import { AXPWidgetsCatalog } from '@acorex/platform/layout/builder';
+//#region ----   Imports   ----
+
+import { AXPEntity, AXPEntityQueryType, createAllQueryView } from '@acorex/platform/common';
+import { entityMasterCrudActions, entityMasterRecordActions } from '@acorex/platform/layout/entity';
+import { AXPWidgetsCatalog } from '@acorex/platform/layout/widget-core';
 import { Injector } from '@angular/core';
-import { AXMSampleModuleConst } from '../const';
+import { RootConfig } from '../const';
 import { AXMSampleEntityService } from './sample.service';
 
+//#endregion
+
+//#region ----   Sample Entity Factory   ----
+
+/**
+ * Factory function to create Sample entity definition
+ */
 export async function sampleFactory(injector: Injector): Promise<AXPEntity | null> {
+  
+  //#region ----   Services   ----
+  
   const dataService = injector.get(AXMSampleEntityService);
+  
+  //#endregion
 
-  const moduleName = AXMSampleModuleConst.moduleName;
+  //#region ----   Entity Definition   ----
+
+  const i18n = RootConfig.config.i18n;
 
   const entityDef: AXPEntity = {
-    module: moduleName,
-    name: AXMSampleModuleConst.categoryEntity,
-    source: '',
-    title: 'Sample Entity',
+    module: RootConfig.module.name,
+    name: RootConfig.entities.sample.name,
+    title: RootConfig.entities.sample.title,
+    icon: RootConfig.entities.sample.icon,
+    
     formats: {
-      individual: 'Sample',
-      plural: 'Samples',
+      individual: `@${i18n}:sample.individual-title`,
+      plural: `@${i18n}:sample.plural-title`,
+      displayName: '{{firstname}} {{lastname}}',
+      searchResult: {
+        title: '{{firstname}} {{lastname}}',
+        description: RootConfig.module.title,
+      },
     },
+    
+    plugins: [
+      { name: 'history' },
+      { name: 'lock' },
+      { name: 'compare' },
+      { name: 'archive' },
+      { name: 'extra-properties' },
+    ],
+    
     relatedEntities: [],
+    
     groups: [
       {
-        id: 'personal',
-        title: 'Personal',
+        id: 'personal-info',
+        title: `@${i18n}:sample.groups.personal-info`,
       },
       {
-        id: 'address',
-        title: 'Address',
+        id: 'contact-info',
+        title: `@${i18n}:sample.groups.contact-info`,
       },
     ],
+    
     properties: [
       {
         name: 'id',
@@ -38,15 +72,13 @@ export async function sampleFactory(injector: Injector): Promise<AXPEntity | nul
           hidden: true,
           nullable: false,
           readonly: true,
-          unique: {
-            enabled: true,
-          },
+          unique: { enabled: true },
         },
       },
       {
         name: 'firstname',
-        title: 'First Name',
-        groupId: 'personal',
+        title: `@${i18n}:sample.properties.firstname`,
+        groupId: 'personal-info',
         schema: {
           dataType: 'string',
           interface: {
@@ -55,24 +87,20 @@ export async function sampleFactory(injector: Injector): Promise<AXPEntity | nul
         },
         options: {
           filter: {
-            inline: {
-              enabled: true,
-            },
-          },
-          sort: {
-            enabled: true,
+            inline: { enabled: true },
+            advance: { enabled: true },
           },
+          sort: { enabled: true },
         },
         validations: [
-          {
-            rule: 'required',
-          },
+          { rule: 'required' },
+          { rule: 'minLength', options: { value: 2 } },
         ],
       },
       {
         name: 'lastname',
-        title: 'Last Name',
-        groupId: 'personal',
+        title: `@${i18n}:sample.properties.lastname`,
+        groupId: 'personal-info',
         schema: {
           dataType: 'string',
           interface: {
@@ -81,73 +109,94 @@ export async function sampleFactory(injector: Injector): Promise<AXPEntity | nul
         },
         options: {
           filter: {
-            inline: {
-              enabled: true,
-            },
-          },
-          sort: {
-            enabled: true,
+            inline: { enabled: true },
+            advance: { enabled: true },
           },
+          sort: { enabled: true },
         },
         validations: [
-          {
-            rule: 'required',
+          { rule: 'required' },
+          { rule: 'minLength', options: { value: 2 } },
+        ],
+      },
+      {
+        name: 'email',
+        title: `@${i18n}:sample.properties.email`,
+        groupId: 'contact-info',
+        schema: {
+          dataType: 'string',
+          interface: {
+            type: AXPWidgetsCatalog.text,
+          },
+        },
+        options: {
+          filter: {
+            inline: { enabled: true },
+            advance: { enabled: true },
           },
+          sort: { enabled: true },
+        },
+        validations: [
+          { rule: 'required' },
+          { rule: 'email' },
         ],
       },
       {
-        name: 'address',
-        title: 'Address',
-        groupId: 'address',
+        name: 'phone',
+        title: `@${i18n}:sample.properties.phone`,
+        groupId: 'contact-info',
         schema: {
           dataType: 'string',
           interface: {
             type: AXPWidgetsCatalog.text,
+          },
+        },
+        options: {
+          filter: {
+            inline: { enabled: true },
+            advance: { enabled: true },
+          },
+        },
+      },
+      {
+        name: 'address',
+        title: `@${i18n}:sample.properties.address`,
+        groupId: 'contact-info',
+        schema: {
+          dataType: 'string',
+          interface: {
+            type: AXPWidgetsCatalog.largeText,
             options: {
-              multiple: false,
-              hasLabel: false,
+              rows: 3,
             },
           },
         },
       },
     ],
-    columns: [{ name: 'firstname' }, { name: 'lastname' }, { name: 'address' }],
+    columns: [
+      { name: 'firstname' },
+      { name: 'lastname' },
+      { name: 'email' },
+      { name: 'phone' },
+    ],
+    
     commands: {
       create: {
-        execute: async (data: any) => {
-          console.log('CREATE', data);
-          const res = await dataService.insertOne(data);
-          return { id: res };
-        },
+        execute: async (data: any) => ({ id: await dataService.insertOne(data) }),
       },
       delete: {
-        execute: async (id: any) => {
-          console.log('DELETE', id);
-          return await dataService.deleteOne(id);
-        },
+        execute: async (id: any) => await dataService.deleteOne(id),
       },
       update: {
-        execute: async (data: any) => {
-          console.log('UPDATE', data);
-          return new Promise((resolve) => {
-            setTimeout(async () => {
-              await dataService.updateOne(data.id, data);
-              resolve(data);
-            }, 1000);
-          });
-        },
+        execute: async (data: any) => await dataService.updateOne(data.id, data),
       },
     },
+    
     queries: {
       byKey: {
         execute: async (id: string) => {
-          console.log('users=>byKey', id);
-          return new Promise((resolve) => {
-            setTimeout(async () => {
-              const entity = await dataService.getOne(id);
-              resolve(entity);
-            }, 500);
-          });
+          const item = await dataService.getOne(id);
+          return item;
         },
         type: AXPEntityQueryType.Single,
       },
@@ -162,184 +211,56 @@ export async function sampleFactory(injector: Injector): Promise<AXPEntity | nul
       master: {
         create: {
           sections: [
-            {
-              id: 'personal',
-            },
-            {
-              id: 'address',
-            },
+            { id: 'personal-info' },
+            { id: 'contact-info' },
           ],
           properties: [
-            {
-              name: 'firstname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'lastname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'address',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 12,
-                  },
-                },
-              },
-            },
+            { name: 'firstname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'lastname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'email', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'phone', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'address', layout: { positions: { lg: { colSpan: 12 } } } },
           ],
         },
         update: {
           sections: [
-            {
-              id: 'personal',
-            },
-            {
-              id: 'address',
-            },
+            { id: 'personal-info' },
+            { id: 'contact-info' },
           ],
           properties: [
-            {
-              name: 'firstname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'lastname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'address',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 12,
-                  },
-                },
-              },
-            },
+            { name: 'firstname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'lastname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'email', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'phone', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'address', layout: { positions: { lg: { colSpan: 12 } } } },
           ],
         },
         single: {
           title: '{{firstname}} {{lastname}}',
           sections: [
-            {
-              id: 'personal',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 12,
-                  },
-                },
-              },
-            },
-            {
-              id: 'address',
-            },
+            { id: 'personal-info', layout: { positions: { lg: { colSpan: 12 } } } },
+            { id: 'contact-info', layout: { positions: { lg: { colSpan: 12 } } } },
           ],
           properties: [
-            {
-              name: 'firstname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'lastname',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 6,
-                  },
-                },
-              },
-            },
-            {
-              name: 'address',
-              layout: {
-                positions: {
-                  lg: {
-                    colSpan: 12,
-                  },
-                },
-              },
-            },
+            { name: 'firstname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'lastname', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'email', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'phone', layout: { positions: { lg: { colSpan: 6 } } } },
+            { name: 'address', layout: { positions: { lg: { colSpan: 12 } } } },
           ],
-          actions: [],
+          actions: [...entityMasterRecordActions()],
         },
         list: {
-          actions: [
-            {
-              title: 'Create New',
-              command: 'create-entity',
-              priority: 'primary',
-              type: 'create',
-              scope: AXPEntityCommandScope.TypeLevel,
-            },
-            {
-              title: 'Delete Items',
-              command: 'delete-entity',
-              priority: 'primary',
-              type: 'delete',
-              scope: AXPEntityCommandScope.Selected,
-            },
-            {
-              title: 'Details',
-              command: 'open-entity',
-              priority: 'secondary',
-              type: 'view',
-              scope: AXPEntityCommandScope.Individual,
-            },
-            {
-              title: 'Delete',
-              command: 'delete-entity',
-              priority: 'secondary',
-              type: 'delete',
-              scope: AXPEntityCommandScope.Individual,
-            },
-          ],
-          views: [
-            {
-              name: 'all',
-              title: 'All Items',
-              fixed: true,
-              columns: [],
-              conditions: [],
-              sorts: [{ name: 'firstname', dir: 'asc' }],
-            },
-          ],
+          actions: [...entityMasterCrudActions()],
+          views: [createAllQueryView({ sorts: [{ name: 'firstname', dir: 'asc' }] })],
         },
       },
     },
   };
 
+  //#endregion
+
   return entityDef;
 }
+
+//#endregion