@smartbit4all/ng-client 3.1.58 → 3.1.60

package/lib/smart-grid/api/grid-api/model/gridRow.d.ts

@@ -23,4 +23,16 @@ export interface GridRow {
     icons: {
         [key: string]: ImageResource;
     };
+    /**
+     * If the grid can be hierarchical then the parent contains the identifiers of the parent row.
+     */
+    parent?: string;
+    /**
+     * If the grid can be hierarchical then the children list contains the identifiers of the children rows. The rows are not necessarily included in the page but the client can ask for this. The children is not required to see if it is empty or not set.
+     */
+    children?: Array<string>;
+    /**
+     * If the grid can be hierarchical then this property shows this row\'s level. It\'s not necessary to fill this value on the server side, client will calculate it.
+     */
+    level?: number;
 }

package/lib/smart-grid/api/grid-api/model/gridViewDescriptor.d.ts

@@ -19,6 +19,9 @@ export interface GridViewDescriptor {
     label?: string;
     icon?: string;
     kind?: GridViewDescriptor.KindEnum;
+    /**
+     * In the table the columns are the columns of the table. In the tree the columns can be used to append the title of a tree node.
+     */
     columns: Array<GridColumnMeta>;
     selectionMode?: GridSelectionMode;
     selectionType?: GridSelectionType;
@@ -26,9 +29,10 @@ export interface GridViewDescriptor {
     showEditColumns?: boolean;
 }
 export declare namespace GridViewDescriptor {
-    type KindEnum = 'TABLE' | 'EXPANDABLECARDS1';
+    type KindEnum = 'TABLE' | 'EXPANDABLECARDS1' | 'TREE';
     const KindEnum: {
         Table: KindEnum;
         Expandablecards1: KindEnum;
+        Tree: KindEnum;
     };
 }

package/lib/smart-grid/models/model.d.ts

@@ -53,7 +53,8 @@ export declare enum GridUiActionType {
 export declare enum SmartLayoutDef {
     TABLE = "TABLE",
     EXPANDABLE = "EXPANDABLE",
-    CARD = "CARD"
+    CARD = "CARD",
+    TREE = "TREE"
 }
 export declare enum SmartGridButtonType {
     ICON = "ICON",

package/lib/smart-grid/smart-grid.component.d.ts

@@ -9,6 +9,8 @@ import { SmartGridService } from './smart-grid.service';
 import { ExpandableSection } from '../smart-expandable-section/projects';
 import { ComponentFactoryService } from '../component-factory-service/projects';
 import { MatDialog } from '@angular/material/dialog';
+import { FlatTreeControl } from '@angular/cdk/tree';
+import { MatTreeFlatDataSource, MatTreeFlattener } from '@angular/material/tree';
 import * as i0 from "@angular/core";
 export declare class SmartGridComponent implements AfterViewInit, OnDestroy, OnChanges {
     private service;
@@ -35,6 +37,10 @@ export declare class SmartGridComponent implements AfterViewInit, OnDestroy, OnC
     uiActionDescriptors: Map<string, any>;
     afterViewInitExecuted: boolean;
     isBlocked: boolean;
+    treeControl?: FlatTreeControl<GridRow>;
+    treeFlattener?: MatTreeFlattener<GridRow, GridRow>;
+    treeDataSource?: MatTreeFlatDataSource<GridRow, GridRow>;
+    treeChecklistSelection?: SelectionModel<GridRow>;
     constructor(service: SmartGridService, cfService: ComponentFactoryService, dialog: MatDialog);
     ngOnChanges(changes: SimpleChanges): void;
     ngOnDestroy(): void;
@@ -55,6 +61,22 @@ export declare class SmartGridComponent implements AfterViewInit, OnDestroy, OnC
     expandAsync(rowIndex: number): Promise<any>;
     private renderExpandableSections;
     private renderCards;
+    private renderTree;
+    getLevel: (node: GridRow) => number;
+    isExpandable: (node: GridRow) => boolean;
+    getChildren: (node: GridRow) => GridRow[];
+    hasChild: (_: number, _nodeData: GridRow) => boolean;
+    transformer: (row: GridRow, level: number) => GridRow;
+    getTreeItem(row: GridRow): string;
+    /** Toggle the treeNode selection. Select/deselect all the descendants node */
+    treeNodeSelectionToggle(node: GridRow): void;
+    checkAllParentsSelection(node: GridRow): void;
+    checkParentNodeSelection(node: GridRow): void;
+    getParentNode(node: GridRow): GridRow | null;
+    /** Whether all the descendants of the node are selected. */
+    descendantsAllSelected(node: GridRow): boolean;
+    /** Whether part of the descendants are selected */
+    descendantsPartiallySelected(node: GridRow): boolean;
     private constructHeader;
     onChangePage(event: PageEvent): Promise<void>;
     private execute;
@@ -64,6 +86,8 @@ export declare class SmartGridComponent implements AfterViewInit, OnDestroy, OnC
     onDoubleClick(gridRow: GridRow): void;
     private handleOnClick;
     private onSelect;
+    private onSelectInternal;
+    private onSelectList;
     private onSelectAll;
     editColumns(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SmartGridComponent, never>;

package/lib/smart-grid/smart-grid.module.d.ts

@@ -9,12 +9,14 @@ import * as i7 from "../smart-table/smarttable.module";
 import * as i8 from "@angular/material/icon";
 import * as i9 from "@angular/material/button";
 import * as i10 from "@angular/material/paginator";
-import * as i11 from "../smart-expandable-section/smart-expandable-section.module";
-import * as i12 from "@angular/cdk/drag-drop";
-import * as i13 from "../smart-form/smartform.module";
-import * as i14 from "@angular/material/select";
+import * as i11 from "@angular/material/tree";
+import * as i12 from "@angular/material/checkbox";
+import * as i13 from "../smart-expandable-section/smart-expandable-section.module";
+import * as i14 from "@angular/cdk/drag-drop";
+import * as i15 from "../smart-form/smartform.module";
+import * as i16 from "@angular/material/select";
 export declare class SmartGridModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SmartGridModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SmartGridModule, [typeof i1.SmartGridComponent, typeof i2.SmartGridCardComponent, typeof i3.ExpandableGridComponent, typeof i4.TableLayoutDefinerComponent], [typeof i5.BrowserModule, typeof i6.SmartIconModule, typeof i7.SmarttableModule, typeof i8.MatIconModule, typeof i9.MatButtonModule, typeof i10.MatPaginatorModule, typeof i11.SmartExpandableSectionModule, typeof i12.DragDropModule, typeof i13.SmartformModule, typeof i14.MatSelectModule], [typeof i1.SmartGridComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SmartGridModule, [typeof i1.SmartGridComponent, typeof i2.SmartGridCardComponent, typeof i3.ExpandableGridComponent, typeof i4.TableLayoutDefinerComponent], [typeof i5.BrowserModule, typeof i6.SmartIconModule, typeof i7.SmarttableModule, typeof i8.MatIconModule, typeof i9.MatButtonModule, typeof i10.MatPaginatorModule, typeof i11.MatTreeModule, typeof i12.MatCheckboxModule, typeof i13.SmartExpandableSectionModule, typeof i14.DragDropModule, typeof i15.SmartformModule, typeof i16.MatSelectModule], [typeof i1.SmartGridComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SmartGridModule>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbit4all/ng-client",
-  "version": "3.1.58",
+  "version": "3.1.60",
   "peerDependencies": {
     "@angular/animations": "^13.3.9",
     "@angular/common": "^13.2.0",

package/src/lib/smart-filter-editor/api/README.md

@@ -1,226 +1,226 @@
-## @
-
-### Building
-
-To install the required dependencies and to build the typescript sources run:
-```
-npm install
-npm run build
-```
-
-### publishing
-
-First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!)
-
-### consuming
-
-Navigate to the folder of your consuming project and run one of next commands.
-
-_published:_
-
-```
-npm install @ --save
-```
-
-_without publishing (not recommended):_
-
-```
-npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
-```
-
-_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
-
-_using `npm link`:_
-
-In PATH_TO_GENERATED_PACKAGE/dist:
-```
-npm link
-```
-
-In your project:
-```
-npm link 
-```
-
-__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
-Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.
-Published packages are not effected by this issue.
-
-
-#### General usage
-
-In your Angular project:
-
-
-```
-// without configuring providers
-import { ApiModule } from '';
-import { HttpClientModule } from '@angular/common/http';
-
-@NgModule({
-    imports: [
-        ApiModule,
-        // make sure to import the HttpClientModule in the AppModule only,
-        // see https://github.com/angular/angular/issues/20575
-        HttpClientModule
-    ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers
-import { ApiModule, Configuration, ConfigurationParameters } from '';
-
-export function apiConfigFactory (): Configuration {
-  const params: ConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new Configuration(params);
-}
-
-@NgModule({
-    imports: [ ApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers with an authentication service that manages your access tokens
-import { ApiModule, Configuration } from '';
-
-@NgModule({
-    imports: [ ApiModule ],
-    declarations: [ AppComponent ],
-    providers: [
-      {
-        provide: Configuration,
-        useFactory: (authService: AuthService) => new Configuration(
-          {
-            basePath: environment.apiUrl,
-            accessToken: authService.getAccessToken.bind(authService)
-          }
-        ),
-        deps: [AuthService],
-        multi: false
-      }
-    ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-import { DefaultApi } from '';
-
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
-```
-
-Note: The ApiModule is restricted to being instantiated once app wide.
-This is to ensure that all services are treated as singletons.
-
-#### Using multiple OpenAPI files / APIs / ApiModules
-In order to use multiple `ApiModules` generated from different OpenAPI files,
-you can create an alias name when importing the modules
-in order to avoid naming conflicts:
-```
-import { ApiModule } from 'my-api-path';
-import { ApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
-
-@NgModule({
-  imports: [
-    ApiModule,
-    OtherApiModule,
-    // make sure to import the HttpClientModule in the AppModule only,
-    // see https://github.com/angular/angular/issues/20575
-    HttpClientModule
-  ]
-})
-export class AppModule {
-
-}
-```
-
-
-### Set service base path
-If different than the generated base path, during app bootstrap, you can provide the base path to your service.
-
-```
-import { BASE_PATH } from '';
-
-bootstrap(AppComponent, [
-    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
-]);
-```
-or
-
-```
-import { BASE_PATH } from '';
-
-@NgModule({
-    imports: [],
-    declarations: [ AppComponent ],
-    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-
-#### Using @angular/cli
-First extend your `src/environments/*.ts` files by adding the corresponding base path:
-
-```
-export const environment = {
-  production: false,
-  API_BASE_PATH: 'http://127.0.0.1:8080'
-};
-```
-
-In the src/app/app.module.ts:
-```
-import { BASE_PATH } from '';
-import { environment } from '../environments/environment';
-
-@NgModule({
-  declarations: [
-    AppComponent
-  ],
-  imports: [ ],
-  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
-  bootstrap: [ AppComponent ]
-})
-export class AppModule { }
-```
-
-### Customizing path parameter encoding
-
-Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
-and Dates for format 'date-time' are encoded correctly.
-
-Other styles (e.g. "matrix") are not that easy to encode
-and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).
-
-To implement your own parameter encoding (or call another library),
-pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object
-(see [General Usage](#general-usage) above).
-
-Example value for use in your Configuration-Provider:
-```typescript
-new Configuration({
-    encodeParam: (param: Param) => myFancyParamEncoder(param),
-})
-```
-
-[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
-[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
-[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander
+## @
+
+### Building
+
+To install the required dependencies and to build the typescript sources run:
+```
+npm install
+npm run build
+```
+
+### publishing
+
+First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!)
+
+### consuming
+
+Navigate to the folder of your consuming project and run one of next commands.
+
+_published:_
+
+```
+npm install @ --save
+```
+
+_without publishing (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
+```
+
+_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
+
+_using `npm link`:_
+
+In PATH_TO_GENERATED_PACKAGE/dist:
+```
+npm link
+```
+
+In your project:
+```
+npm link 
+```
+
+__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
+Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.
+Published packages are not effected by this issue.
+
+
+#### General usage
+
+In your Angular project:
+
+
+```
+// without configuring providers
+import { ApiModule } from '';
+import { HttpClientModule } from '@angular/common/http';
+
+@NgModule({
+    imports: [
+        ApiModule,
+        // make sure to import the HttpClientModule in the AppModule only,
+        // see https://github.com/angular/angular/issues/20575
+        HttpClientModule
+    ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+// configuring providers
+import { ApiModule, Configuration, ConfigurationParameters } from '';
+
+export function apiConfigFactory (): Configuration {
+  const params: ConfigurationParameters = {
+    // set configuration parameters here.
+  }
+  return new Configuration(params);
+}
+
+@NgModule({
+    imports: [ ApiModule.forRoot(apiConfigFactory) ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+// configuring providers with an authentication service that manages your access tokens
+import { ApiModule, Configuration } from '';
+
+@NgModule({
+    imports: [ ApiModule ],
+    declarations: [ AppComponent ],
+    providers: [
+      {
+        provide: Configuration,
+        useFactory: (authService: AuthService) => new Configuration(
+          {
+            basePath: environment.apiUrl,
+            accessToken: authService.getAccessToken.bind(authService)
+          }
+        ),
+        deps: [AuthService],
+        multi: false
+      }
+    ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+import { DefaultApi } from '';
+
+export class AppComponent {
+    constructor(private apiGateway: DefaultApi) { }
+}
+```
+
+Note: The ApiModule is restricted to being instantiated once app wide.
+This is to ensure that all services are treated as singletons.
+
+#### Using multiple OpenAPI files / APIs / ApiModules
+In order to use multiple `ApiModules` generated from different OpenAPI files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
+```
+import { ApiModule } from 'my-api-path';
+import { ApiModule as OtherApiModule } from 'my-other-api-path';
+import { HttpClientModule } from '@angular/common/http';
+
+@NgModule({
+  imports: [
+    ApiModule,
+    OtherApiModule,
+    // make sure to import the HttpClientModule in the AppModule only,
+    // see https://github.com/angular/angular/issues/20575
+    HttpClientModule
+  ]
+})
+export class AppModule {
+
+}
+```
+
+
+### Set service base path
+If different than the generated base path, during app bootstrap, you can provide the base path to your service.
+
+```
+import { BASE_PATH } from '';
+
+bootstrap(AppComponent, [
+    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
+]);
+```
+or
+
+```
+import { BASE_PATH } from '';
+
+@NgModule({
+    imports: [],
+    declarations: [ AppComponent ],
+    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+
+#### Using @angular/cli
+First extend your `src/environments/*.ts` files by adding the corresponding base path:
+
+```
+export const environment = {
+  production: false,
+  API_BASE_PATH: 'http://127.0.0.1:8080'
+};
+```
+
+In the src/app/app.module.ts:
+```
+import { BASE_PATH } from '';
+import { environment } from '../environments/environment';
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [ ],
+  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
+  bootstrap: [ AppComponent ]
+})
+export class AppModule { }
+```
+
+### Customizing path parameter encoding
+
+Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
+and Dates for format 'date-time' are encoded correctly.
+
+Other styles (e.g. "matrix") are not that easy to encode
+and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).
+
+To implement your own parameter encoding (or call another library),
+pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object
+(see [General Usage](#general-usage) above).
+
+Example value for use in your Configuration-Provider:
+```typescript
+new Configuration({
+    encodeParam: (param: Param) => myFancyParamEncoder(param),
+})
+```
+
+[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
+[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
+[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander