feat(srcgen): Change "web-grid" to "web-entity" and update template for rucken@2.0.0

Author: EndyKaufman

src/bin/app.ts

@@ -112,8 +112,8 @@ export class App {
                 await (new MakeTsListCommand(_.merge(this.program, command, dummy))).process();
             });
         this.program
-            .command('grid')
-            .option('-t, --template [name]', 'template folder name or path', 'web-grid')
+            .command('entity')
+            .option('-t, --template [name]', 'template folder name or path', 'web-entity')
             .option('-n, --entity-name [name]', 'entity name')
             .option('-p, --pk-field [name]', 'primary key name', 'id')
             .option('-f, --fields [names]', 'fields of entity', '\'name\',\'title\',\'createdAt\',\'updatedAt\'')
@@ -124,7 +124,7 @@ export class App {
             .option('-pf, --platform-folder [path]', 'platform library path')
             .description('scaffold model, service, grid, lookup input, modal for edit row in grid, modal for select items from grid with items')
             .action(async (dummy, command) => {
-                await (new GeneratorCommand(_.merge(this.program, command, dummy))).processGrid();
+                await (new GeneratorCommand(_.merge(this.program, command, dummy))).processEntity();
             });
         this.program
             .command('page')

src/commands/generator.command.ts

@@ -1,5 +1,5 @@
 import { FrameGenerator } from '../generators/frame';
-import { GridGenerator } from '../generators/grid';
+import { EntityGenerator } from '../generators/entity';
 import { PageGenerator } from '../generators/page';
 import { PageAndFrameGenerator } from '../generators/page-and-frame';
 import { BaseCommand } from './base.command';
@@ -9,9 +9,9 @@ export class GeneratorCommand extends BaseCommand {
     constructor(public options: any) {
         super(options);
     }
-    async processGrid() {
+    async processEntity() {
         this.log('generator').info('Run generator for ' + this.rootFolder);
-        const gen = new GridGenerator(this.rootFolder);
+        const gen = new EntityGenerator(this.rootFolder);
         gen.debug = this.debug;
         const result = false;
         return await new Promise<boolean>((resolve: any) =>

src/generators/grid.ts src/generators/entity.tssrc/generators/grid.ts renamed to src/generators/entity.ts

@@ -6,9 +6,9 @@ import { Base } from '../lib/base';
 import { Project } from '../lib/project';
 
 
-export class GridGenerator extends Base {
+export class EntityGenerator extends Base {
 
-    name = 'grid';
+    name = 'entity';
 
     constructor(public rootFolder?: string) {
         super(null, rootFolder);
@@ -53,7 +53,7 @@ export class GridGenerator extends Base {
             (customOptions && customOptions.project.libsConfigs[1] && customOptions &&
                 customOptions.project.libsConfigs[1].localPath) ?
                 customOptions && customOptions.project.libsConfigs[1].localPath : 'web';
-        let template: string = 'web-grid';
+        let template: string = 'web-entity';
         let pkField: string = 'id';
         let fields: string[] = [
             'name',
@@ -111,7 +111,7 @@ export class GridGenerator extends Base {
                     'coreFolder': coreFolder,
                     'platformFolder': platformFolder
                 },
-                'grid': {
+                'entity': {
                     'list': {
                         'name': {
                             'kebab': _.kebabCase(inflection.pluralize(entityName)),
@@ -151,7 +151,7 @@ export class GridGenerator extends Base {
         );
         return await this.srcgen(
             rootFolder,
-            'generatorGrid',
+            'generatorEntity',
             template,
             options,
             rootFolder

srcgen/web-entity/%libs.coreFolder%/src/shared/configs/%grid.name.kebab%.config.ts

@@ -0,0 +1,36 @@
+import { Injectable } from '@angular/core';
+import { plainToClass } from 'class-transformer';
+import { IRestProviderOptions, PaginationMeta, ProviderActionEnum } from 'ngx-repository';
+import { <%=entity.name.camel%> } from '../models/<%=entity.name.kebab%>';
+
+@Injectable()
+export class <%=entity.list.name.camel%>Config implements IRestProviderOptions<Permission> {
+  name = '<%=entity.name.snake%>';
+  pluralName = '<%=entity.list.name.snake%>';
+  autoload = true;
+  paginationMeta = {
+    perPage: 5
+  };
+  actionOptions = {
+    responseData: (data: any, action: ProviderActionEnum) => {
+      if (action === ProviderActionEnum.Delete) {
+        return true;
+      } else {
+        if (action === ProviderActionEnum.LoadAll) {
+          return plainToClass(<%=entity.name.camel%>, data.body.<%=entity.list.name.lower.camel%>);
+        } else {
+          return plainToClass(<%=entity.name.camel%>, data.body.<%=entity.name.lower.camel%>);
+        }
+      }
+    },
+    responsePaginationMeta: (data: any, action: ProviderActionEnum): PaginationMeta => {
+      return { totalResults: data.body.meta.totalResults, perPage: undefined };
+    }
+  };
+  restOptions = {
+    limitQueryParam: 'per_page',
+    pageQueryParam: 'cur_page',
+    searchTextQueryParam: 'q'
+  };
+  constructor() { }
+}

srcgen/web-entity/%libs.coreFolder%/src/shared/models/%grid.name.kebab%.ts

@@ -0,0 +1,15 @@
+import { IModel } from 'ngx-repository';
+import { translate } from '@rucken/core';
+
+export class <%=entity.name.camel%> extends IModel {
+  static strings: any = {
+    <%=entity.table.pk.name %>: translate('<%=_.upperFirst(entity.table.pk.name)%>'),
+    <%for (var i = 0; i < entity.table.fields.names.length; i++) {%>    <%=entity.table.fields.names[i] + ': translate(\'' + _.upperFirst(entity.table.fields.names[i]) + '\'),\n' %><%}%>
+  };
+
+<%=entity.table.pk.name %>: <%=entity.table.pk.name === 'id' ? 'number' : 'string' %>;
+<%for (var i = 0; i < entity.table.fields.names.length; i++) { if (entity.table.fields.dates.indexOf(entity.table.fields.names[i]) === -1) {%>  <%=entity.table.fields.names[i] + ': string;\n' %><%}else {%>  <%=entity.table.fields.names[i] + ': Date;\n' %><%}}%>
+  toString() {
+    return this.title;
+  }
+}

srcgen/web-entity/%libs.platformFolder%/src/components/entities/%grid.name.kebab%/%grid.list.name.kebab%-grid-modal/%grid.list.name.kebab%-grid-modal.component.html

@@ -0,0 +1,5 @@
+<entity-grid-modal [title]="title" [yesTitle]="yesTitle" [readonly]="readonly" [disabled]="!(grid?.selected?.length>0)" [noTitle]="noTitle"
+  (yes)="onYesClick()" (no)="onNoClick()" [processing]="processing">
+  <<%=entity.list.name.kebab%>-grid [apiUrl]="apiUrl" #grid>
+  </<%=entity.list.name.kebab%>-grid>
+</entity-grid-modal>

srcgen/web-entity/%libs.platformFolder%/src/components/entities/%grid.name.kebab%/%grid.list.name.kebab%-grid-modal/%grid.list.name.kebab%-grid-modal.component.ts

@@ -0,0 +1,23 @@
+import { Component, Input, ViewChild } from '@angular/core';
+import { <%=entity.name.camel%> } from '<%=libs.core%>';
+import { BsModalRef } from 'ngx-bootstrap/modal';
+import { BaseEntityListModalComponent } from '@rucken/core';
+import { <%=entity.list.name.camel%>GridComponent } from '../<%=entity.list.name.kebab%>-grid/<%=entity.list.name.kebab%>-grid.component';
+
+@Component({
+  selector: '<%=entity.list.name.kebab%>-grid-modal',
+  templateUrl: './<%=entity.list.name.kebab%>-grid-modal.component.html'
+})
+export class <%=entity.list.name.camel%>GridModalComponent extends BaseEntityListModalComponent<<%=entity.name.camel%>> {
+
+  @ViewChild('grid')
+  grid: <%=entity.list.name.camel%>GridComponent;
+  @Input()
+  apiUrl?: string;
+
+  constructor(
+    protected bsModalRef: BsModalRef
+  ) {
+    super(bsModalRef);
+  }
+}

srcgen/web-entity/%libs.platformFolder%/src/components/entities/%grid.name.kebab%/%grid.list.name.kebab%-grid-modal/%grid.list.name.kebab%-grid-modal.module.ts

@@ -0,0 +1,35 @@
+import { CommonModule } from '@angular/common';
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { FormsModule, ReactiveFormsModule } from '@angular/forms';
+import { TranslateModule } from '@ngx-translate/core';
+import { EntityGridModalModule } from '@rucken/core';
+import { <%=entity.list.name.camel%>GridModule } from '../<%=entity.list.name.kebab%>-grid/<%=entity.list.name.kebab%>-grid.module';
+import { <%=entity.list.name.camel%>GridModalComponent } from './<%=entity.list.name.kebab%>-grid-modal.component';
+
+@NgModule({
+  imports: [
+    CommonModule,
+    ReactiveFormsModule,
+    FormsModule,
+    TranslateModule.forChild(),
+    EntityGridModalModule,
+    <%=entity.list.name.camel%>GridModule
+  ],
+  declarations: [
+    <%=entity.list.name.camel%>GridModalComponent
+  ],
+  entryComponents: [
+    <%=entity.list.name.camel%>GridModalComponent
+  ],
+  exports: [
+    <%=entity.list.name.camel%>GridModalComponent
+  ]
+})
+export class <%=entity.list.name.camel%>GridModalModule {
+  static forRoot(): ModuleWithProviders {
+    return {
+      ngModule: <%=entity.list.name.camel%>GridModalModule,
+      providers: []
+    };
+  }
+}

srcgen/web-entity/%libs.platformFolder%/src/components/entities/%grid.name.kebab%/%grid.list.name.kebab%-grid/%grid.list.name.kebab%-grid.component.html

@@ -0,0 +1,6 @@
+<entity-grid title="<%=entity.list.name.caption%>" [items]="repository.items$ | async" [(selected)]="selected"
+  [columns]="['<%=entity.table.fields.names.join('\',\'')%>', 'action']" [readonly]="readonly" [strings]="strings" (create)="onCreateClick()" (update)="onUpdateClick($event)"
+  (delete)="onDeleteClick($event)" (view)="onViewClick($event)" (search)="onChangeFilter({searchText:$event})" (changeOrder)="onChangeFilter({sort:$event})"
+  [paginationMeta]="repository.paginationMeta$ | async" [enableCreate]="'add_<%=entity.name.kebab%>' | perm | async" [enableUpdate]="'change_<%=entity.name.kebab%>' | perm | async"
+  [enableDelete]="'delete_<%=entity.name.kebab%>' | perm | async" (changePage)="onChangePage($event)" [processing]="processing">
+</entity-grid>

srcgen/web-entity/%libs.platformFolder%/src/components/entities/%grid.name.kebab%/%grid.list.name.kebab%-grid/%grid.list.name.kebab%-grid.component.ts

@@ -0,0 +1,92 @@
+import { Component, OnInit } from '@angular/core';
+import { TranslateService } from '@ngx-translate/core';
+import { ErrorsExtractor, translate } from '@rucken/core';
+import { <%=entity.name.camel%>, <%=entity.list.name.camel%>Config } from '<%=libs.core%>';
+import { BsModalRef, BsModalService } from 'ngx-bootstrap/modal';
+import { DynamicRepository, PaginationMeta } from 'ngx-repository';
+import { BaseEntityListComponent } from '@rucken/core';
+import { <%=entity.name.camel%>ModalComponent } from '../<%=entity.name.kebab%>-modal/<%=entity.name.kebab%>-modal.component';
+
+
+@Component({
+  selector: '<%=entity.list.name.kebab%>-grid',
+  templateUrl: './<%=entity.list.name.kebab%>-grid.component.html'
+})
+export class <%=entity.list.name.camel%>GridComponent extends BaseEntityListComponent<<%=entity.name.camel%>> implements OnInit {
+
+  public paginationMeta: PaginationMeta;
+  constructor(
+    public modalService: BsModalService,
+    protected errorsExtractor: ErrorsExtractor,
+    protected translateService: TranslateService,
+    protected dynamicRepository: DynamicRepository,
+    protected <%=entity.list.name.lower.camel%>Config: <%=entity.list.name.camel%>Config
+  ) {
+    super(
+      dynamicRepository.fork<<%=entity.name.camel%>>(<%=entity.name.camel%>),
+      modalService,
+      <%=entity.name.camel%>
+    );
+  }
+  ngOnInit() {
+    if (!this.mockedItems) {
+      this.repository.useRest({
+        apiUrl: this.apiUrl,
+        ...this.<%=entity.list.name.lower.camel%>Config
+      });
+    }
+    if (this.mockedItems) {
+      this.repository.useMock({
+        items: this.mockedItems,
+        ...this.<%=entity.list.name.lower.camel%>Config
+      });
+    }
+  }
+  createDeleteModal(item: <%=entity.name.camel%>): BsModalRef {
+    return this.modalService.show(<%=entity.name.camel%>ModalComponent, {
+      class: 'modal-md',
+      initialState: {
+        title: this.strings.deleteTitle,
+        message: this.strings.deleteMessage,
+        yesTitle: translate('Delete'),
+        data: item,
+        apiUrl: this.apiUrl
+      }
+    });
+  }
+  createCreateModal(): BsModalRef {
+    const item = new <%=entity.name.camel%>();
+    return this.modalService.show(<%=entity.name.camel%>ModalComponent, {
+      class: 'modal-md',
+      initialState: {
+        title: this.strings.createTitle,
+        yesTitle: translate('Create'),
+        data: item,
+        apiUrl: this.apiUrl
+      }
+    });
+  }
+  createUpdateModal(item?: <%=entity.name.camel%>): BsModalRef {
+    return this.modalService.show(<%=entity.name.camel%>ModalComponent, {
+      class: 'modal-md',
+      initialState: {
+        title: this.strings.updateTitle,
+        yesTitle: translate('Save'),
+        data: item,
+        apiUrl: this.apiUrl
+      }
+    });
+  }
+  createViewModal(item?: <%=entity.name.camel%>): BsModalRef {
+    return this.modalService.show(<%=entity.name.camel%>ModalComponent, {
+      class: 'modal-md',
+      initialState: {
+        title: this.strings.viewTitle,
+        noTitle: translate('Close'),
+        readonly: true,
+        data: item,
+        apiUrl: this.apiUrl
+      }
+    });
+  }
+}