kwikid-forms 0.3.7 → 0.3.8

package/lib/renderer/form-view/definitions/form-view.actions.definition.d.ts

@@ -20,9 +20,22 @@ export declare enum EActionKey {
     FIELD_GROUP_DISABLE = "FIELD_GROUP_DISABLE",
     SET_DROPDOWN_OPTIONS = "SET_DROPDOWN_OPTIONS",
     API_CALL = "API_CALL",
-    API_CALL_END = "API_CALL_END"
+    API_CALL_MULTIPLE = "API_CALL_MULTIPLE",
+    API_CALL_MULTIPLE_END = "API_CALL_MULTIPLE_END",
+    TASK_API_CALL = "TASK_API_CALL",
+    TASK_API_CALL_MULTIPLE = "TASK_API_CALL_MULTIPLE",
+    TASK_API_CALL_MULTIPLE_END = "TASK_API_CALL_MULTIPLE_END",
+    PREVIEW_DIALOG_SHOW = "PREVIEW_DIALOG_SHOW",
+    POPUP_FORM_SHOW = "POPUP_FORM_SHOW",
+    MOVE_AHEAD = "MOVE_AHEAD",
+    NOTIFICATION_ERROR_SHOW = "NOTIFICATION_ERROR_SHOW",
+    NOTIFICATION_ERROR_HIDE = "NOTIFICATION_ERROR_HIDE",
+    DIALOG_SHOW = "DIALOG_SHOW",
+    DIALOG_HIDE = "DIALOG_HIDE",
+    RESUME_TASK_EXECUTION = "RESUME_TASK_EXECUTION",
+    STOP_TASK_EXECUTION = "STOP_TASK_EXECUTION"
 }
-export declare type TActionKey = EActionKey.SET_VALUE | EActionKey.SET_FIELD_DEFAULT_VALUE | EActionKey.FIELD_MESSAGE_SHOW | EActionKey.FIELD_MESSAGES_HIDE | EActionKey.FIELD_ERROR_SHOW | EActionKey.FIELD_ERROR_HIDE | EActionKey.FIELD_SHOW | EActionKey.FIELD_HIDE | EActionKey.FIELD_ENABLE | EActionKey.FIELD_DISABLE | EActionKey.FIELD_RESET | EActionKey.HANDLE_CONNECTED_ELEMENTS | EActionKey.CUSTOM | EActionKey.FIELD_GROUP_SHOW | EActionKey.FIELD_GROUP_HIDE | EActionKey.FIELD_GROUP_ENABLE | EActionKey.FIELD_GROUP_DISABLE | EActionKey.API_CALL | EActionKey.API_CALL_END;
+export declare type TActionKey = EActionKey.SET_VALUE | EActionKey.SET_FIELD_DEFAULT_VALUE | EActionKey.FIELD_MESSAGE_SHOW | EActionKey.FIELD_MESSAGES_HIDE | EActionKey.FIELD_ERROR_SHOW | EActionKey.FIELD_ERROR_HIDE | EActionKey.FIELD_SHOW | EActionKey.FIELD_HIDE | EActionKey.FIELD_ENABLE | EActionKey.FIELD_DISABLE | EActionKey.FIELD_RESET | EActionKey.HANDLE_CONNECTED_ELEMENTS | EActionKey.CUSTOM | EActionKey.FIELD_GROUP_SHOW | EActionKey.FIELD_GROUP_HIDE | EActionKey.FIELD_GROUP_ENABLE | EActionKey.FIELD_GROUP_DISABLE | EActionKey.API_CALL | EActionKey.API_CALL_MULTIPLE | EActionKey.API_CALL_MULTIPLE_END | EActionKey.TASK_API_CALL | EActionKey.TASK_API_CALL_MULTIPLE | EActionKey.TASK_API_CALL_MULTIPLE_END | EActionKey.SET_DROPDOWN_OPTIONS | EActionKey.PREVIEW_DIALOG_SHOW | EActionKey.POPUP_FORM_SHOW | EActionKey.MOVE_AHEAD | EActionKey.NOTIFICATION_ERROR_SHOW | EActionKey.NOTIFICATION_ERROR_HIDE | EActionKey.DIALOG_SHOW | EActionKey.DIALOG_HIDE | EActionKey.RESUME_TASK_EXECUTION | EActionKey.STOP_TASK_EXECUTION;
 export declare type TActionSetValue = TAction & {
     key: EActionKey.SET_VALUE;
     props: {
@@ -116,3 +129,16 @@ export declare type TActionApiCallsDone = TAction & {
         fieldKey: string;
     };
 };
+export declare type TActionPreviewDialogShow = TAction & {
+    key: EActionKey.PREVIEW_DIALOG_SHOW;
+    props: {
+        html?: {
+            before?: string;
+            after?: string;
+        };
+        iframe?: {
+            src: string;
+            title?: string;
+        };
+    };
+};

package/lib/renderer/form-view/definitions/form-view.commons.definition.d.ts

@@ -9,3 +9,8 @@ export declare type TMessage = {
     message: string;
     type: TMessageType;
 };
+export declare enum EFormViewGoBackMode {
+    DIRECT = "DIRECT",
+    TABBED = "TABBED"
+}
+export declare type TFormViewGoBackMode = EFormViewGoBackMode.DIRECT | EFormViewGoBackMode.TABBED;

package/lib/renderer/form-view/form-view.component.d.ts

@@ -1,27 +1,40 @@
-import { AfterViewInit, EventEmitter, OnInit, SimpleChanges } from "@angular/core";
+import { AfterViewInit, ChangeDetectorRef, EventEmitter, OnInit, SimpleChanges, TemplateRef } from "@angular/core";
 import { FormGroup } from "@angular/forms";
-import { TuiAlertService } from "@taiga-ui/core";
+import { TuiPreviewDialogService } from "@taiga-ui/addon-preview";
+import { TuiAlertService, TuiDialogContext, TuiDialogService } from "@taiga-ui/core";
 import { TuiPushService } from "@taiga-ui/kit";
 import { TAction } from "kwikid-toolkit";
-import { TMessage } from "./definitions/form-view.commons.definition";
+import { TFormViewGoBackMode, TMessage } from "./definitions/form-view.commons.definition";
 import { TFieldApiCall, TFieldTitle } from "./definitions/form-view.fields.definition";
 import { KwikIDFormViewService } from "./form-view.service";
 import * as i0 from "@angular/core";
 export declare class KwikIDFormViewComponent implements OnInit, AfterViewInit {
+    private cd;
+    private formViewService;
     protected readonly push: TuiPushService;
     protected readonly alert: TuiAlertService;
-    private formViewService;
+    private readonly previewDialogService;
+    private readonly dialogs;
+    readonly preview: TemplateRef<TuiDialogContext<void>>;
     formConfig: any;
     formData: any;
     isMobileView: boolean;
     allFormsData: any;
+    popupFormCallback: any;
+    onClickGoBack: EventEmitter<any>;
     onClickViewForms: EventEmitter<any>;
     onClickSaveForm: EventEmitter<any>;
     onClickApiCall: EventEmitter<any>;
+    onActionShowPopupForm: EventEmitter<any>;
     fieldGroups: any;
     formFields: any[];
     previousFormData: any;
+    previewProperties: any;
     loading: boolean;
+    backButton: {
+        disabled: boolean;
+        showLoader: boolean;
+    };
     viewFormsButton: {
         disabled: boolean;
         showLoader: boolean;
@@ -30,8 +43,13 @@ export declare class KwikIDFormViewComponent implements OnInit, AfterViewInit {
         disabled: boolean;
         showLoader: boolean;
     };
+    stopTaskExecution: boolean;
+    waitingForChanges: boolean;
+    popupFormConfig: any;
+    popupFormData: any;
+    tasksData: any;
     formGroup: FormGroup;
-    constructor(push: TuiPushService, alert: TuiAlertService, formViewService: KwikIDFormViewService);
+    constructor(cd: ChangeDetectorRef, formViewService: KwikIDFormViewService, push: TuiPushService, alert: TuiAlertService, previewDialogService: TuiPreviewDialogService, dialogs: TuiDialogService);
     ngOnInit(): void;
     ngAfterViewInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
@@ -46,10 +64,16 @@ export declare class KwikIDFormViewComponent implements OnInit, AfterViewInit {
     handleConnectedElements(e: any, eventType: string): Promise<void>;
     handleGetKeyValue(e: any): void;
     handleOnClickResetFormFields(e: any, field: TFieldTitle): Promise<void>;
-    handleApiCall(field: TFieldApiCall, api: any): Promise<{
+    handleFieldApiCall(field: TFieldApiCall, api: any): Promise<{
         field: TFieldApiCall;
         api: any;
     }>;
+    handleTaskApiCall(api: any): Promise<{
+        api: any;
+    }>;
+    handleApiCall(api: any, object: any): Promise<any>;
+    showApiLoader(): void;
+    hideApiLoader(): void;
     handleOnClickApiCall(e: any): Promise<void>;
     /**
      * Method to optimize the DOM update by Angular for using *ngFor on large no. of items.
@@ -58,6 +82,7 @@ export declare class KwikIDFormViewComponent implements OnInit, AfterViewInit {
      * @returns string
      */
     getUniqueIdentifier(index: number, item: any): string;
+    handleOnClickGoBack(e: any, mode: TFormViewGoBackMode): void;
     handleOnClickViewForms(e: any): void;
     handleOnClickSaveForm(e: any): Promise<void>;
     showErrorNotification: boolean;
@@ -75,13 +100,26 @@ export declare class KwikIDFormViewComponent implements OnInit, AfterViewInit {
     fieldErrorHide(fieldKey: string, message: TMessage): void;
     fieldMessageShow(fieldKey: string, message: TMessage): void;
     fieldMessageHide(fieldKey: string, message: TMessage): void;
+    setValue(action: TAction, object: any): Promise<void>;
+    setFieldDefaultValue(action: TAction, object: any): Promise<void>;
+    setDropdownOptions(action: TAction, object: any): Promise<void>;
+    fieldMultipleApiCalls(action: TAction, object: any): Promise<void>;
+    fieldMultipleApiCallsEnd(action: TAction, object: any): Promise<void>;
+    taskApiCall(action: TAction, object: any): Promise<void>;
+    taskMultipleApiCalls(action: TAction, object: any): Promise<void>;
+    taskMultipleApiCallsEnd(action: TAction, object: any): Promise<void>;
+    dialogRef: any;
+    dialogShow(options: any): void;
+    dialogHide(): void;
     patchFieldControlValue(key: string, value: any): void;
     patchFormGroup(formData: any): void;
     isFieldValid(fieldKey: string): boolean;
     isFieldEnabled(fieldKey: string): boolean;
     getFormGroupRawValues(): any;
+    showPreview(previewProperties: any): void;
+    showPopupForm(popupFormKey: string): void;
     takeActionOnFieldGroup(action: TAction, object: any): Promise<void>;
     takeAction(action: TAction, object: any): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<KwikIDFormViewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<KwikIDFormViewComponent, "kwikid-form-view", never, { "formConfig": "formConfig"; "formData": "formData"; "isMobileView": "isMobileView"; "allFormsData": "allFormsData"; }, { "onClickViewForms": "onClickViewForms"; "onClickSaveForm": "onClickSaveForm"; "onClickApiCall": "onClickApiCall"; }, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<KwikIDFormViewComponent, "kwikid-form-view", never, { "formConfig": "formConfig"; "formData": "formData"; "isMobileView": "isMobileView"; "allFormsData": "allFormsData"; "popupFormCallback": "popupFormCallback"; }, { "onClickGoBack": "onClickGoBack"; "onClickViewForms": "onClickViewForms"; "onClickSaveForm": "onClickSaveForm"; "onClickApiCall": "onClickApiCall"; "onActionShowPopupForm": "onActionShowPopupForm"; }, never, never>;
 }

package/lib/renderer/form-view/form-view.module.d.ts

@@ -1,13 +1,15 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./form-view.component";
 import * as i2 from "./pipes/safe-html.pipe";
-import * as i3 from "@angular/common";
-import * as i4 from "@angular/forms";
-import * as i5 from "@taiga-ui/core";
-import * as i6 from "@taiga-ui/kit";
-import * as i7 from "kwikui";
+import * as i3 from "./pipes/safe-url.pipe";
+import * as i4 from "@angular/common";
+import * as i5 from "@angular/forms";
+import * as i6 from "@taiga-ui/core";
+import * as i7 from "@taiga-ui/kit";
+import * as i8 from "@taiga-ui/addon-preview";
+import * as i9 from "kwikui";
 export declare class KwikIDFormViewModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<KwikIDFormViewModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormViewModule, [typeof i1.KwikIDFormViewComponent, typeof i2.SafeHtmlPipe], [typeof i3.CommonModule, typeof i4.FormsModule, typeof i4.ReactiveFormsModule, typeof i5.TuiLabelModule, typeof i6.TuiPushModule, typeof i5.TuiSvgModule, typeof i7.KwikUIModule], [typeof i1.KwikIDFormViewComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormViewModule, [typeof i1.KwikIDFormViewComponent, typeof i2.SafeHtmlPipe, typeof i3.SafeUrlPipe], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i5.ReactiveFormsModule, typeof i6.TuiLabelModule, typeof i7.TuiPushModule, typeof i6.TuiSvgModule, typeof i8.TuiPreviewModule, typeof i6.TuiButtonModule, typeof i8.TuiPreviewActionModule, typeof i6.TuiDialogModule, typeof i9.KwikUIModule], [typeof i1.KwikIDFormViewComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<KwikIDFormViewModule>;
 }

package/lib/renderer/form-view/helpers/form-view.tasks.helper.d.ts

@@ -0,0 +1,7 @@
+export declare class Tasks {
+    private _object;
+    private _task;
+    private _takeAction;
+    constructor(task: any, object: any, takeAction: Function);
+    execute(): Promise<void>;
+}

package/lib/renderer/form-view/pipes/safe-url.pipe.d.ts

@@ -0,0 +1,15 @@
+import { PipeTransform } from "@angular/core";
+import { DomSanitizer } from "@angular/platform-browser";
+import * as i0 from "@angular/core";
+/**
+ * Generated class for the SafeUrlPipe pipe.
+ *
+ * See https://angular.io/api/core/Pipe for more info on Angular Pipes.
+ */
+export declare class SafeUrlPipe implements PipeTransform {
+    private sanitizer;
+    constructor(sanitizer: DomSanitizer);
+    transform(url: string): import("@angular/platform-browser").SafeResourceUrl;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SafeUrlPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SafeUrlPipe, "safeUrl">;
+}

package/lib/renderer/renderer.component.d.ts

@@ -1,12 +1,18 @@
-import { ChangeDetectorRef, ElementRef, EventEmitter, OnChanges, OnInit, SimpleChanges } from "@angular/core";
+import { ChangeDetectorRef, ElementRef, EventEmitter, OnChanges, OnInit, SimpleChanges, TemplateRef } from "@angular/core";
+import { TuiPreviewDialogService } from "@taiga-ui/addon-preview";
+import { TuiDialogContext } from "@taiga-ui/core";
 import * as i0 from "@angular/core";
 export declare class KwikIDFormsRendererComponent implements OnInit, OnChanges {
     private hostElement;
     private cdr;
+    private readonly previewDialogService;
     windowResizeWatcher(): void;
+    readonly preview: TemplateRef<TuiDialogContext<void>>;
+    private previewDialogRef;
     stepConfig: any;
     userConfig: any;
     formsData: any;
+    activeFormData: any;
     apiCallResponse: any;
     onClickSubmit: EventEmitter<any>;
     getFormData: EventEmitter<any>;
@@ -15,16 +21,21 @@ export declare class KwikIDFormsRendererComponent implements OnInit, OnChanges {
     loader: boolean;
     showErrorNotification: boolean;
     toggleErrorNotification(show: any): void;
+    activePopupFormData: any;
+    popupFormCallback: any;
     activeFormConfig: any;
     activeFormFields: any[];
     allFormsData: any;
+    allFormsSubmitted: boolean;
     formsList: any[];
     formsListCompleted: string[];
     isMobileView: boolean;
+    previewProperties: any;
+    popupFormConfig: any;
     showForm: boolean;
     showFormFields: boolean;
     showFormSections: boolean;
-    constructor(hostElement: ElementRef, cdr: ChangeDetectorRef);
+    constructor(hostElement: ElementRef, cdr: ChangeDetectorRef, previewDialogService: TuiPreviewDialogService);
     ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
     fetchFormConfig(url: string): Promise<any>;
@@ -57,6 +68,7 @@ export declare class KwikIDFormsRendererComponent implements OnInit, OnChanges {
     checkIfFormsStatusCompleted(formsList: any, formsListCompleted: string[]): any;
     findActiveFormConfig(formsList: any[]): any;
     updateFormsList(): Promise<void>;
+    showPreview(previewProperties: any): void;
     formHide(formKey: string): void;
     formShow(formKey: string): void;
     takeAction(action: any, object: any): Promise<void>;
@@ -74,16 +86,33 @@ export declare class KwikIDFormsRendererComponent implements OnInit, OnChanges {
      * @param e any
      */
     handleOnClickApiCall(e: any): void;
+    handleOnActionShowPopupForm(e: any): void;
     /**
      * FormView - Listens to event of getting the Active Form's Data when the Form is Saved and emits (read as passes) the same event to the library consumer.
      * @param e any
      */
-    handleOnClickSaveForm(e: any): void;
+    handleOnClickSaveForm(e: any, eventType: "FORM" | "POPUP_FORM"): void;
     /**
      * FormView - Listens to event of showing the Forms List in Mobile View.
      * @param e any
      */
     handleOnClickViewForms(e: any): void;
+    /**
+     * Handles the event of going back to the previous form directly or by tabbing, without showing the form list in mobile view.
+     *
+     * Prerequisite: The current form can never be locked; it should either be in an editable or completed state.
+     *
+     * Logic:
+     * 1. For DIRECT mode, find the config of the previous form starting from the first form, such that the previous form is editable and its sequence number is one less than the current active form's sequence number.
+     *    If no previous form is found or all forms have been completed, show the form list.
+     * 2. For TABBED mode, find the config of the previous form in the list, such that the previous form's sequence number is less than the current active form's sequence number and the form is editable.
+     *    If no previous form is found, show the form list.
+     *
+     * @param {Object} e - The event object containing the mode to go back in.
+     * @param {string} e.mode - The mode of going back: DIRECT or TABBED.
+     * @returns {void}
+     */
+    handleOnClickGoBack(e: any): void;
     /**
      * FormList - Listens to event of submitting all the forms and moving out of the library and also handles the validation of all the forms.
      * @param e any
@@ -94,5 +123,5 @@ export declare class KwikIDFormsRendererComponent implements OnInit, OnChanges {
      */
     handleResize(formsList: any[]): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<KwikIDFormsRendererComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<KwikIDFormsRendererComponent, "kwikid-forms-renderer", never, { "stepConfig": "stepConfig"; "userConfig": "userConfig"; "formsData": "formsData"; "apiCallResponse": "apiCallResponse"; }, { "onClickSubmit": "onClickSubmit"; "getFormData": "getFormData"; "onClickApiCall": "onClickApiCall"; }, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<KwikIDFormsRendererComponent, "kwikid-forms-renderer", never, { "stepConfig": "stepConfig"; "userConfig": "userConfig"; "formsData": "formsData"; "activeFormData": "activeFormData"; "apiCallResponse": "apiCallResponse"; }, { "onClickSubmit": "onClickSubmit"; "getFormData": "getFormData"; "onClickApiCall": "onClickApiCall"; }, never, never>;
 }

package/lib/renderer/renderer.module.d.ts

@@ -7,8 +7,9 @@ import * as i5 from "./forms-list/forms-list.module";
 import * as i6 from "kwikui";
 import * as i7 from "@taiga-ui/core";
 import * as i8 from "@taiga-ui/kit";
+import * as i9 from "@taiga-ui/addon-preview";
 export declare class KwikIDFormRendererModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<KwikIDFormRendererModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormRendererModule, [typeof i1.KwikIDFormsRendererComponent], [typeof i2.CommonModule, typeof i3.HttpClientModule, typeof i4.KwikIDFormViewModule, typeof i5.KwikIDFormsListModule, typeof i6.KwikUIModule, typeof i7.TuiLoaderModule, typeof i8.TuiPushModule, typeof i7.TuiSvgModule], [typeof i1.KwikIDFormsRendererComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormRendererModule, [typeof i1.KwikIDFormsRendererComponent], [typeof i2.CommonModule, typeof i3.HttpClientModule, typeof i4.KwikIDFormViewModule, typeof i5.KwikIDFormsListModule, typeof i6.KwikUIModule, typeof i7.TuiLoaderModule, typeof i8.TuiPushModule, typeof i9.TuiPreviewActionModule, typeof i9.TuiPreviewModule, typeof i7.TuiButtonModule, typeof i9.TuiPreviewActionModule, typeof i7.TuiSvgModule], [typeof i1.KwikIDFormsRendererComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<KwikIDFormRendererModule>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kwikid-forms",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "Kwik.ID's JSON based Forms Builder and Renderer.",
   "author": {
     "name": "Baiju Dodhia"
@@ -34,7 +34,7 @@
   "dependencies": {
     "jsonpath": "^1.1.1",
     "kwikid-toolkit": "^0.1.1",
-    "kwikui": "^0.2.24",
+    "kwikui": "^0.2.25",
     "lodash": "^4.17.21",
     "tslib": "^2.2.0"
   },