@smartbit4all/ng-client 1.0.29 → 1.1.0

package/lib/smart-client/smart-component-api-client.d.ts

@@ -1,9 +1,10 @@
 import { Injector } from '@angular/core';
-import { GridOptions, SmartGrid } from '@smartbit4all/grid';
+import { GridOptions, SmartGrid, SmartGridComponent } from '@smartbit4all/grid';
+import { SmarttreeGenericService } from '@smartbit4all/tree';
 import { Subject } from 'rxjs';
 import { ComponentModel, SmartViewContextService, UiAction, UiActionAdditionalParams, UiActionDescriptorService, UiActionModel, UiActionRequest, UiActionService, UiActionSpecificDemandResponse, UseUiAction } from '../view-context/projects';
 import { SmartAuthenticationServiceInterface } from './smart-authentication.service';
-import { SmarttreeGenericService } from '@smartbit4all/tree';
+import { SmartForm, SmartformComponent } from '@smartbit4all/form';
 export declare abstract class SmartComponentApiClient<T> implements UseUiAction {
     protected inject: Injector;
     protected auth: SmartAuthenticationServiceInterface;
@@ -30,6 +31,8 @@ export declare abstract class SmartComponentApiClient<T> implements UseUiAction
     private _smartTreeService?;
     get smartTreeService(): SmarttreeGenericService | undefined;
     set smartTreeService(smartTreeService: SmarttreeGenericService | undefined);
+    widgets: WidgetMap<SmartGridComponent | SmarttreeGenericService | undefined>;
+    formWidgets: WidgetMap<SmartformComponent | undefined>;
     constructor(inject: Injector, auth: SmartAuthenticationServiceInterface, pageName: string);
     _ngOnInit(): void;
     _ngOnDestroy(): void;
@@ -42,7 +45,25 @@ export declare abstract class SmartComponentApiClient<T> implements UseUiAction
     getModel(): T | undefined;
     performUiActionRequest(uiActionRequest: UiActionRequest, widgetId?: string, nodeId?: string): Promise<any>;
     handleSpecificDemandsAsynchronously(uiAction: UiAction, uiActionRequest: UiActionRequest): Promise<UiActionSpecificDemandResponse>;
-    addGrid(smartGrid: SmartGrid, options: GridOptions, useAsDefaultGrid?: boolean): SmartGrid;
+    addGrid(smartGrid: SmartGrid, options: GridOptions, useAsDefaultGrid?: boolean, componentReference?: SmartGridComponent): SmartGrid;
+    addForm(smartFormId: string, smartForm: SmartForm, componentReference?: SmartformComponent): SmartForm;
     setUpDefaultTree(treeId: string): void;
     createTreeService(treeId: string): SmarttreeGenericService;
+    private handleChanges;
+    private handleChangeWidgets;
+    private setValueDeeply;
+    private handleDataChange;
+    private handleLayoutChange;
+    private handleValueSetChange;
+    private handleActionChange;
+    private handleConstraintChange;
+}
+export declare class WidgetMap<T> {
+    private _widgets;
+    get widgets(): Map<string, T>;
+    set widgets(widgets: Map<string, T>);
+    addWidget(key: string, reference: T, isForm?: boolean): void;
+    removeWidget(key: string): void;
+    clearWidgets(): void;
+    get(key: string): T | undefined;
 }

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

@@ -1,6 +1,7 @@
 import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { ComponentModel } from '../model/componentModel';
+import { DataChange } from '../model/dataChange';
 import { MessageResult } from '../model/messageResult';
 import { UiActionRequest } from '../model/uiActionRequest';
 import { ViewConstraint } from '../model/viewConstraint';
@@ -35,6 +36,25 @@ export declare class ViewService {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
     }): Observable<HttpEvent<ViewContextData>>;
+    /**
+     * Notification of a data change event..
+     * @param uuid
+     * @param dataChange
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    dataChanged(uuid: string, dataChange: DataChange, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+    }): Observable<ViewContextChange>;
+    dataChanged(uuid: string, dataChange: DataChange, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+    }): Observable<HttpResponse<ViewContextChange>>;
+    dataChanged(uuid: string, dataChange: DataChange, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+    }): Observable<HttpEvent<ViewContextChange>>;
     /**
      * @param uuid
      * @param item

package/lib/view-context/api/model/componentModel.d.ts

@@ -28,10 +28,4 @@ export interface ComponentModel {
     valueSets?: {
         [key: string]: ValueSet;
     };
-    /**
-     * Complex widgets with corresponding initial model.
-     */
-    widgetModels: {
-        [key: string]: object;
-    };
 }

package/lib/view-context/api/model/componentModelChange.d.ts

@@ -16,4 +16,14 @@ export interface ComponentModelChange {
     uuid: string;
     path: string;
     value?: object;
+    /**
+     * Changed values, in a key-value map. Refers to different parts of ComponentModel, for example  data changes are prefixed with \'data.\', layout changes with \'layouts.\', etc.
+     */
+    changes: {
+        [key: string]: any;
+    };
+    /**
+     * List of changed widgets (widgetIds).
+     */
+    changedWidgets?: Array<string>;
 }

package/lib/view-context/api/model/dataChange.d.ts

@@ -0,0 +1,27 @@
+/**
+ * View API
+ * View API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: info@it4all.hu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DataChangeKind } from './dataChangeKind';
+export interface DataChange {
+    kind?: DataChangeKind;
+    /**
+     * Source of the event, typically the key of the widget.
+     */
+    source?: string;
+    /**
+     * Changed values, in a key-value map.
+     */
+    values?: {
+        [key: string]: any;
+    };
+}
+export declare namespace DataChange {
+}

package/lib/view-context/api/model/dataChangeEvent.d.ts

@@ -0,0 +1,33 @@
+/**
+ * View API
+ * View API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: info@it4all.hu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DataChangeKind } from './dataChangeKind';
+export interface DataChangeEvent {
+    kind?: DataChangeKind;
+    /**
+     * Source of the event, typically the key of the widget.
+     */
+    source?: string;
+    /**
+     * Values before changed, in a key-value map.
+     */
+    oldValues?: {
+        [key: string]: any;
+    };
+    /**
+     * Values before changed, in a key-value map.
+     */
+    newValues?: {
+        [key: string]: any;
+    };
+}
+export declare namespace DataChangeEvent {
+}

package/lib/view-context/api/model/dataChangeKind.d.ts

@@ -0,0 +1,20 @@
+/**
+ * View API
+ * View API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: info@it4all.hu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Defines the kind of the source of this event..
+ */
+export declare type DataChangeKind = 'WIDGET' | 'SELECTION' | 'LOOKUP';
+export declare const DataChangeKind: {
+    Widget: DataChangeKind;
+    Selection: DataChangeKind;
+    Lookup: DataChangeKind;
+};

package/lib/view-context/api/model/models.d.ts

@@ -2,6 +2,9 @@ export * from './closeResult';
 export * from './componentConstraint';
 export * from './componentModel';
 export * from './componentModelChange';
+export * from './dataChange';
+export * from './dataChangeEvent';
+export * from './dataChangeKind';
 export * from './messageData';
 export * from './messageOption';
 export * from './messageOptionType';
@@ -27,6 +30,7 @@ export * from './viewContextChange';
 export * from './viewContextData';
 export * from './viewContextUpdate';
 export * from './viewData';
+export * from './viewEventHandler';
 export * from './viewState';
 export * from './viewStateUpdate';
 export * from './viewType';

package/lib/view-context/api/model/view.d.ts

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ViewEventHandler } from './viewEventHandler';
+import { SmartLayoutDefinition } from '@smartbit4all/form';
 import { ViewState } from './viewState';
 import { UiAction } from './uiAction';
 import { ValueSet } from './valueSet';
@@ -22,9 +24,18 @@ export interface View {
     viewName: string;
     objectUri?: string;
     branchUri?: string;
+    /**
+     * The incoming parameters of the view. If we restart the given view with the same model then this parameters remain.
+     */
     parameters: {
         [key: string]: any;
     };
+    /**
+     * The variable to store while the page is opened. It will be cleared if we open it again.
+     */
+    variables: {
+        [key: string]: any;
+    };
     state: ViewState;
     type: ViewType;
     containerUuid?: string;
@@ -35,13 +46,23 @@ export interface View {
         [key: string]: string;
     };
     actions: Array<UiAction>;
+    eventHandlers: Array<ViewEventHandler>;
     widgetModels: {
         [key: string]: object;
     };
-    valueSets?: {
+    valueSets: {
         [key: string]: ValueSet;
     };
     keepModelOnImplicitClose?: boolean;
+    callbacks: {
+        [key: string]: object;
+    };
+    /**
+     * The layouts defined in the view. This named layouts can be used by the UI to render
+     */
+    layouts: {
+        [key: string]: SmartLayoutDefinition;
+    };
 }
 export declare namespace View {
 }

package/lib/view-context/api/model/viewEventHandler.d.ts

@@ -0,0 +1,30 @@
+/**
+ * View API
+ * View API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: info@it4all.hu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An event handler is a special callback function to call when the given event is occurred. So the event handler can be an action as is or can be fired on a before or after event
+ */
+export interface ViewEventHandler {
+    /**
+     * The event handler path defines the location of the event. We can use regular expressions to fine tune the event definition. In this way we can add before event handler for all the actions we have. The actions will have a predefined path. The path of the normal actions is the action code itself.
+     */
+    path?: Array<string>;
+    viewEventType?: ViewEventHandler.ViewEventTypeEnum;
+    invocationRequestDefinition?: any;
+}
+export declare namespace ViewEventHandler {
+    type ViewEventTypeEnum = 'before' | 'instead' | 'after';
+    const ViewEventTypeEnum: {
+        Before: ViewEventTypeEnum;
+        Instead: ViewEventTypeEnum;
+        After: ViewEventTypeEnum;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartbit4all/ng-client",
-  "version": "1.0.29",
+  "version": "1.1.0",
   "schematics": "./schematics/collection.json",
   "peerDependencies": {
     "@angular/common": "^13.2.0",