@cadence-development/cadence-admin-schematics v0.0.1

Cadence Admin Schematics

Instalation

NPM instalatioin

npm install @cadence-development/cadence-admin-schematics --save-dev

Local instalation from Git repository

Clone code from repository

git clone https://github.com/Cadence-Development/schematics-cadence-admin.git

Move to 'CadenceAdmin' Angular project directory and link previously cloned schematics repository

npm link ..\..\..\schematics-cadence-admin

Where ..\..\..\schematics-cadence-admin is relative path from 'CadenceAdmin' Angular client application directory to cloned https://github.com/Cadence-Development/schematics-cadence-admin.git schematics repository.

Code Generation

Filter

To generate FilterComponent based component and all auxiliary code execute following command:

ng generate @cadence-development/cadence-admin-schematics:filter feature/schematics-test/test-entity-list-filter

Where feature/schematics-test/ is path to module where your component should be generated and test-entity-list-filter is name of generated component.

Pagination List

To genarate PaginationListComponent based component and all auxiliary code execute following command:

ng generate @cadence-development/cadence-admin-schematics:pagination-list feature/schematics-test/test-entity-list --args-type=GetTermWithPaginationArgs --list-item-type=TermListItemAdminModel --filter-type=TermListFilterModel --sorting-member=TermText

Pagination List Arguments

• --args-type: TArgs - GET HTTP method arguments type
• --list-item-type: TListItem - Type of displaying list item
• --filter-type: TFilter - Type of filter model generated by Filter command

This is ComponentStore generated store for explain arguments meaning

export class TestEntityListComponentStore extends ListWithFilterComponentStore<
  GetTermWithPaginationArgs /* TArgs */ ,
  TermListFilterModel /* TFilter */,
  TermListItemAdminModel /* TListItem */,
  TestEntityListState /* will be generated automatically */
> {
    ...
}

• --sorting-member: Default sorting property of list-item-type

This is generated store model

export const TEST_ENTITY_LIST_STATE: TestEntityListState = {
  _internal: CREATE_LIST_WITH_FILTER_COMPONENT_INTERNAL_STATE('TermText' /* <-- sorting-member */),
  foo: 'bar'
};

Edit

To genarate EditFormComponent based component and all auxiliary code execute following command:

ng generate @cadence-development/cadence-admin-schematics:edit feature/schematics-test/test-entity-edit --get-args-type=GetSeminarARSForEditAdminArgs --get-data-type=SeminarARSForEditAdminModel --post-args-type=EditSeminarARSAdminArgs --post-result-type=EditSeminarARSResultAdminModel

Edit Arguments

• --get-args-type: TGetArgs - GET HTTP method arguments model
• --get-data-type: TGetData - GET HTTP method return model
• --post-args-type: TPostArgs - POST HTTP method arguments model
• --post-result-type: TPostResult - POST HTTP method return model

This is generated edit store

export class TestEntityEditComponentStore extends EditFormComponentStore<
  GetSeminarARSForEditAdminArgs /* TGetArgs */,
  SeminarARSForEditAdminModel /* TGetData */,
  TestEntityEditFormModel /* generated by command */,
  EditSeminarARSAdminArgs /* TPostArgs */,
  EditSeminarARSResultAdminModel /* TPostResult */,
  TestEntityEditState /* generated by command */
> {
  ...
}