@acorex/platform-generator 20.3.0-next.8 → 20.4.0

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

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

@@ -1,9 +1,15 @@
+//#region ----   Imports   ----
+
 import { NgModule } from '@angular/core';
-import {
-  AXMSampleEntityService,
-  AXMSampleEntityServiceImpl
-} from './sample.service';
+import { AXMSampleEntityService, AXMSampleEntityServiceImpl } from './sample.service';
+
+//#endregion
 
+//#region ----   Sample Entity Module   ----
+
+/**
+ * Sample entity module - provides entity service
+ */
 @NgModule({
   imports: [],
   exports: [],
@@ -15,4 +21,6 @@ import {
     },
   ],
 })
-export class AXMSampleEntityModule {}
+export class AXMSampleEntityModule {}
+
+//#endregion

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

@@ -1,18 +1,38 @@
+//#region ----   Imports   ----
+
 import { AXMEntityCrudServiceImpl } from '@acorex/platform/layout/entity';
 import { Injectable } from '@angular/core';
-import { AXMSampleModuleConst } from '../const';
-import { AXMSampleEntityModel } from './sample.types';
-import { AXMSampleCreateEntityModel } from './sample.types';
+import { RootConfig } from '../const';
+import {
+  AXMSampleCreateDto,
+  AXMSampleDetailDto,
+  AXMSampleListItemDto,
+  AXMSampleUpdateDto,
+} from './sample.types';
+
+//#endregion
 
+//#region ----   Sample Entity Service   ----
+
+/**
+ * Abstract service for Sample entity CRUD operations
+ */
 export abstract class AXMSampleEntityService extends AXMEntityCrudServiceImpl<
   string,
-  AXMSampleEntityModel,
-  AXMSampleCreateEntityModel
+  AXMSampleDetailDto,
+  AXMSampleListItemDto,
+  AXMSampleCreateDto,
+  AXMSampleUpdateDto
 > {}
 
+/**
+ * Implementation of Sample entity service
+ */
 @Injectable()
 export class AXMSampleEntityServiceImpl extends AXMSampleEntityService {
   constructor() {
-    super(`${AXMSampleModuleConst.moduleName}.${AXMSampleModuleConst.categoryEntity}`);  
+    super(`${RootConfig.module.name}.${RootConfig.entities.sample.name}`);
   }
 }
+
+//#endregion

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

@@ -1,15 +1,53 @@
+//#region ----   Imports   ----
+
 import { AXPEntityModel } from '@acorex/platform/layout/entity';
 
-export interface AXMSampleEntityModel extends AXPEntityModel<string> {
-   firstname?: string;
-    lastname?: string;
-    phone?: string;
-    email?: string;
-    address?: string;
+//#endregion
+
+//#region ----   Sample Entity Types   ----
+
+/**
+ * Sample entity detail model
+ */
+export interface AXMSampleDetailDto extends AXPEntityModel<string> {
+  firstname?: string;
+  lastname?: string;
+  email?: string;
+  phone?: string;
+  address?: string;
 }
-export interface AXMSampleCreateEntityModel extends AXPEntityModel<string> {
-   firstname?: string;
-    lastname?: string;
-    phone?: string;
-    email?: string;
+
+/**
+ * Sample entity list item model
+ */
+export interface AXMSampleListItemDto extends AXPEntityModel<string> {
+  firstname?: string;
+  lastname?: string;
+  email?: string;
+  phone?: string;
 }
+
+/**
+ * Sample entity create model
+ */
+export interface AXMSampleCreateDto {
+  firstname?: string;
+  lastname?: string;
+  email?: string;
+  phone?: string;
+  address?: string;
+}
+
+/**
+ * Sample entity update model
+ */
+export interface AXMSampleUpdateDto {
+  id: string;
+  firstname?: string;
+  lastname?: string;
+  email?: string;
+  phone?: string;
+  address?: string;
+}
+
+//#endregion

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

@@ -0,0 +1,37 @@
+//#region ----   Imports   ----
+
+import { AXPSearchCommandProvider, AXPSearchResult } from '@acorex/platform/common';
+import { RootConfig } from './const';
+
+//#endregion
+
+//#region ----   Search Command Provider   ----
+
+/**
+ * Search command provider for <%= className %> module
+ * Provides search commands for global search
+ */
+export class <%= className %>ModuleSearchCommandProvider extends AXPSearchCommandProvider {
+  
+  //#region ----   Commands   ----
+
+  commands: AXPSearchResult[] = [
+    {
+      group: 'command',
+      title: 'New Sample',
+      icon: RootConfig.entities.sample.icon,
+      description: 'Create a new sample record',
+      command: {
+        name: 'create-entity',
+        options: {
+          entity: `${RootConfig.module.name}.${RootConfig.entities.sample.name}`,
+        },
+      },
+    },
+  ];
+
+  //#endregion
+}
+
+//#endregion
+