@smartbit4all/ng-client 3.0.6 → 3.0.7

package/lib/session/dev-tool/smart-dev-tool-dialog/smart-dev-tool-dialog.service.d.ts

@@ -2,7 +2,7 @@ import { MatDialog } from '@angular/material/dialog';
 import { Router } from '@angular/router';
 import { Subject } from 'rxjs';
 import { SmartDevToolDescriptor, SmartDevToolService } from '../smart-dev-tool.service';
-import { SmartdialogService } from '../../../../projects';
+import { SmartdialogService } from '../../../smart-dialog/projects';
 import * as i0 from "@angular/core";
 export declare class SmartDevToolDialogService extends SmartdialogService {
     service: SmartDevToolService;

package/lib/smart-grid/api/grid-api/api/grid.service.d.ts

@@ -11,7 +11,7 @@ export declare class GridService {
     defaultHeaders: HttpHeaders;
     configuration: Configuration;
     encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
     private addToHttpParams;
     private addToHttpParamsRecursive;
     /**

package/lib/smart-grid/api/grid-api/configuration.d.ts

@@ -1,4 +1,5 @@
 import { HttpParameterCodec } from '@angular/common/http';
+import { Param } from './param';
 export interface ConfigurationParameters {
     /**
      *  @deprecated Since 5.0. Use credentials instead
@@ -14,7 +15,18 @@ export interface ConfigurationParameters {
     accessToken?: string | (() => string);
     basePath?: string;
     withCredentials?: boolean;
+    /**
+     * Takes care of encoding query- and form-parameters.
+     */
     encoder?: HttpParameterCodec;
+    /**
+     * Override the default method for encoding path parameters in various
+     * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
+     * <p>
+     * See {@link README.md} for more details
+     * </p>
+     */
+    encodeParam?: (param: Param) => string;
     /**
      * The keys are the names in the securitySchemes section of the OpenAPI
      * document. They should map to the value used for authentication
@@ -39,7 +51,18 @@ export declare class Configuration {
     accessToken?: string | (() => string);
     basePath?: string;
     withCredentials?: boolean;
+    /**
+     * Takes care of encoding query- and form-parameters.
+     */
     encoder?: HttpParameterCodec;
+    /**
+     * Encoding of various path parameter
+     * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
+     * <p>
+     * See {@link README.md} for more details
+     * </p>
+     */
+    encodeParam: (param: Param) => string;
     /**
      * The keys are the names in the securitySchemes section of the OpenAPI
      * document. They should map to the value used for authentication
@@ -77,4 +100,5 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
     lookupCredential(key: string): string | undefined;
+    private defaultEncodeParam;
 }

package/lib/smart-grid/api/grid-api/index.d.ts

@@ -3,3 +3,4 @@ export * from './model/models';
 export * from './variables';
 export * from './configuration';
 export * from './api.module';
+export * from './param';

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

@@ -23,6 +23,7 @@ export interface GridViewDescriptor {
     selectionMode?: GridSelectionMode;
     selectionType?: GridSelectionType;
     preserveSelectionOnPageChange?: boolean;
+    showEditColumns?: boolean;
 }
 export declare namespace GridViewDescriptor {
     type KindEnum = 'TABLE' | 'EXPANDABLECARDS1';

package/lib/smart-grid/api/grid-api/param.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Standard parameter styles defined by OpenAPI spec
+ */
+export declare type StandardParamStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+/**
+ * The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user.
+ */
+export declare type ParamStyle = StandardParamStyle | string;
+/**
+ * Standard parameter locations defined by OpenAPI spec
+ */
+export declare type ParamLocation = 'query' | 'header' | 'path' | 'cookie';
+/**
+ * Standard types as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
+ */
+export declare type StandardDataType = "integer" | "number" | "boolean" | "string" | "object" | "array";
+/**
+ * Standard {@link DataType}s plus your own types/classes.
+ */
+export declare type DataType = StandardDataType | string;
+/**
+ * Standard formats as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
+ */
+export declare type StandardDataFormat = "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password";
+export declare type DataFormat = StandardDataFormat | string;
+/**
+ * The parameter to encode.
+ */
+export interface Param {
+    name: string;
+    value: unknown;
+    in: ParamLocation;
+    style: ParamStyle;
+    explode: boolean;
+    dataType: DataType;
+    dataFormat: DataFormat | undefined;
+}

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

@@ -12,6 +12,8 @@ import * as i0 from "@angular/core";
 export declare class SmartGridComponent implements AfterViewInit, OnDestroy, OnChanges {
     private service;
     private cfService;
+    private readonly defaultPageSize;
+    private readonly defaultPageSizeOptions;
     private _destroy$;
     smartGrid?: SmartGrid;
     uuid: string;

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

@@ -9,8 +9,6 @@ export declare class SmartGridService extends SmartdialogService {
     private api;
     gridModelChanged: Subject<void>;
     gridModel: GridModel;
-    pageSize?: number;
-    length?: number;
     constructor(api: GridService, dialog: MatDialog, router: Router);
     load(uuid: string, gridIdentifier: string): Promise<void>;
     setPage(uuid: string, gridIdentifier: string, offset: string, limit: string): Promise<void>;
@@ -21,6 +19,7 @@ export declare class SmartGridService extends SmartdialogService {
     update(uuid: string, identifier: string, updateData: GridUpdateData): Promise<void>;
     closeDialog(): Promise<void>;
     handleAfterClosed(): void;
+    private updateGrid;
     static ɵfac: i0.ɵɵFactoryDeclaration<SmartGridService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SmartGridService>;
 }

package/lib/view-context/projects.d.ts

@@ -1,13 +1,13 @@
-export * from "./smart-view-context.service";
-export * from "./smart-view-context.model";
-export * from "./smart-view-context.module";
-export * from "./smart-view-redirect/smart-view-redirect";
-export * from "./api/index";
-export * from "./smart-ui-action/ui-action-toolbar.component";
-export * from "./smart-ui-action/ui-action.service";
-export * from "./smart-ui-action/ui-action.model";
-export * from "./smart-ui-action/ui-action.descriptor.service";
-export * from "./smart-ui-action/dialogs/ui-action-confirm-dialog/ui-action-confirm-dialog.service";
-export * from "./smart-ui-action/dialogs/ui-action-confirm-dialog/ui-action-confirm-dialog.component";
-export * from "./smart-ui-action/dialogs/ui-action-input-dialog/ui-action-input-dialog.service";
-export * from "./smart-ui-action/dialogs/ui-action-input-dialog/ui-action-input-dialog.component";
+export * from './smart-view-context.service';
+export * from './smart-view-context.model';
+export * from './smart-view-context.module';
+export * from './smart-view-redirect/smart-view-redirect';
+export * from './api/index';
+export * from './smart-ui-action/ui-action-toolbar.component';
+export * from './smart-ui-action/ui-action.service';
+export * from './smart-ui-action/ui-action.model';
+export * from './smart-ui-action/ui-action.descriptor.service';
+export * from './smart-ui-action/dialogs/ui-action-confirm-dialog/ui-action-confirm-dialog.service';
+export * from './smart-ui-action/dialogs/ui-action-confirm-dialog/ui-action-confirm-dialog.component';
+export * from './smart-ui-action/dialogs/ui-action-input-dialog/ui-action-input-dialog.service';
+export * from './smart-ui-action/dialogs/ui-action-input-dialog/ui-action-input-dialog.component';

package/lib/view-context/smart-view-context-error-dialog/smart-view-context-error-dialog.service.d.ts

@@ -1,9 +1,9 @@
 import { MatDialog, MatDialogRef } from '@angular/material/dialog';
 import { Router } from '@angular/router';
-import { SmartdialogService } from '../../../projects';
 import { ViewApiError } from '../api';
 import { SmartViewContextApiError } from '../smart-view-context.model';
 import { SmartViewContextService } from '../smart-view-context.service';
+import { SmartdialogService } from '../../smart-dialog/projects';
 import * as i0 from "@angular/core";
 export declare class SmartViewContextErrorDialogService extends SmartdialogService {
     private viewContext;

package/lib/view-context/smart-view-context.service.d.ts

@@ -1,4 +1,4 @@
-import { OnDestroy } from '@angular/core';
+import { InjectionToken, Injector, OnDestroy } from '@angular/core';
 import { Subject } from 'rxjs';
 import { SmartSessionService } from '../session/smart-session.service';
 import { ComponentModel, DataChange, MessageData, MessageResult, UiActionDescriptor, UiActionRequest, ViewConstraint, ViewContextChange, ViewContextData, ViewContextUpdate, ViewData, ViewService } from './api';
@@ -10,12 +10,14 @@ import * as i0 from "@angular/core";
 export declare const SmartViewContextErrorDialogButtonLabel = "SmartViewContextErrorDialogButtonLabel";
 export declare const SmartViewContextErrorDialogTitle = "SmartViewContextErrorDialogTitle";
 export declare const SmartViewContextErrorDialogMessage = "SmartViewContextErrorDialogMessage";
+export declare const DIALOG_DISABLE_CLOSE: InjectionToken<boolean>;
 export declare class SmartViewContextService implements OnDestroy {
     private view;
     private session;
     private navigation;
     private dialog;
     private apiQueueService;
+    private inject;
     private tabIdName;
     private tabIdhttpHeaderName;
     messageDialogname: string | undefined;
@@ -39,7 +41,7 @@ export declare class SmartViewContextService implements OnDestroy {
     get translateService(): SmartTranslateService | undefined;
     private _translateService?;
     translateServiceChanged: Subject<void>;
-    constructor(view: ViewService, session: SmartSessionService, navigation: SmartNavigationService, dialog: SmartdialogService, apiQueueService: ApiQueueService);
+    constructor(view: ViewService, session: SmartSessionService, navigation: SmartNavigationService, dialog: SmartdialogService, apiQueueService: ApiQueueService, inject: Injector);
     ngOnDestroy(): void;
     follow(uuid: string, detectChange: SmartSubject<any>): void;
     unfollow(uuid: string): void;

package/package.json

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

package/src/lib/smart-grid/api/grid-api/README.md

@@ -1,203 +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 { }
-```
+## @
+
+### 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