kwikid-forms 0.7.0 → 0.8.0

package/lib/builder/builder-form-editor/builder.form-editor.constants.d.ts

@@ -43,6 +43,8 @@ export declare const OPTIONS: {
         };
         file: {};
         capture: {};
+        record: {};
+        mic: {};
     };
     validators: {
         required: boolean[];
@@ -77,10 +79,16 @@ export declare const FIELD_PROPERTIES_CONFIG: {
     };
     text: {
         case: string;
+        description: string;
+        speechToText: boolean;
+        textToSpeech: boolean;
         readOnly: boolean;
         placeholder: string;
     };
     textarea: {
+        description: string;
+        speechToText: boolean;
+        textToSpeech: boolean;
         readOnly: boolean;
         placeholder: string;
     };
@@ -145,6 +153,7 @@ export declare const FIELD_PROPERTIES_CONFIG: {
         placeholder: string;
     };
     select: {
+        description: string;
         readOnly: boolean;
         placeholder: string;
     };
@@ -181,6 +190,16 @@ export declare const FIELD_PROPERTIES_CONFIG: {
         readOnly: boolean;
         placeholder: string;
     };
+    masked: {
+        maskChar: string;
+        maskCount: number;
+        maskDirection: string;
+        maxLength: any;
+        pattern: string;
+        storeMaskValue: boolean;
+        readOnly: boolean;
+        placeholder: string;
+    };
     image: {
         altText: string;
         html: {
@@ -223,6 +242,22 @@ export declare const FIELD_PROPERTIES_CONFIG: {
         readOnly: boolean;
         placeholder: string;
     };
+    mic: {
+        buttonText: string;
+        icon: string;
+        isUpload: boolean;
+        minRecordingTimeInSeconds: number;
+        maxRecordingTimeInSeconds: number;
+        mimeType: string;
+        accept: string;
+        showMediaFiles: boolean;
+        uploadFileToServer: boolean;
+        preview: {
+            show: boolean;
+        };
+        readOnly: boolean;
+        placeholder: string;
+    };
     capture: {
         containerStyles: string;
         buttonText: string;
@@ -304,6 +339,9 @@ export declare const FIELD_CONFIG: {
         type: string;
         properties: {
             case: string;
+            description: string;
+            speechToText: boolean;
+            textToSpeech: boolean;
             readOnly: boolean;
             placeholder: string;
         };
@@ -346,6 +384,9 @@ export declare const FIELD_CONFIG: {
     textarea: {
         type: string;
         properties: {
+            description: string;
+            speechToText: boolean;
+            textToSpeech: boolean;
             readOnly: boolean;
             placeholder: string;
         };
@@ -531,6 +572,7 @@ export declare const FIELD_CONFIG: {
     select: {
         type: string;
         properties: {
+            description: string;
             readOnly: boolean;
             placeholder: string;
         };
@@ -685,6 +727,33 @@ export declare const FIELD_CONFIG: {
             max: number;
         };
     };
+    masked: {
+        type: string;
+        properties: {
+            maskChar: string;
+            maskCount: number;
+            maskDirection: string;
+            maxLength: any;
+            pattern: string;
+            storeMaskValue: boolean;
+            readOnly: boolean;
+            placeholder: string;
+        };
+        key: string;
+        label: string;
+        disabled: boolean;
+        validators: {
+            required: boolean;
+            minLength: number;
+            maxLength: number;
+            pattern: {
+                key: string;
+                pattern: string;
+            };
+            min: number;
+            max: number;
+        };
+    };
     image: {
         type: string;
         properties: {
@@ -854,6 +923,39 @@ export declare const FIELD_CONFIG: {
             max: number;
         };
     };
+    mic: {
+        type: string;
+        properties: {
+            buttonText: string;
+            icon: string;
+            isUpload: boolean;
+            minRecordingTimeInSeconds: number;
+            maxRecordingTimeInSeconds: number;
+            mimeType: string;
+            accept: string;
+            showMediaFiles: boolean;
+            uploadFileToServer: boolean;
+            preview: {
+                show: boolean;
+            };
+            readOnly: boolean;
+            placeholder: string;
+        };
+        key: string;
+        label: string;
+        disabled: boolean;
+        validators: {
+            required: boolean;
+            minLength: number;
+            maxLength: number;
+            pattern: {
+                key: string;
+                pattern: string;
+            };
+            min: number;
+            max: number;
+        };
+    };
 };
 export declare const NOFIELD_CONFIG: {
     required: boolean;

package/lib/renderer/config-converter/config-converter.constants.d.ts

@@ -16,6 +16,10 @@ export declare const FIELD_PROPERTIES: {
         containerStyles: string;
         postfix: string;
         prefix: string;
+        description: string;
+        isShowLabelOutside: boolean;
+        speechToText: boolean;
+        textToSpeech: boolean;
     };
     currency: {
         containerStyles: string;
@@ -23,6 +27,15 @@ export declare const FIELD_PROPERTIES: {
         prefix: string;
         currencyType: string;
     };
+    masked: {
+        containerStyles: string;
+        maskChar: string;
+        maskCount: number;
+        maskDirection: string;
+        maxLength: any;
+        pattern: string;
+        storeMaskValue: boolean;
+    };
     email: {
         case: string;
         containerStyles: string;
@@ -69,7 +82,10 @@ export declare const FIELD_PROPERTIES: {
     };
     textarea: {
         containerStyles: string;
+        description: string;
         isShowLabelOutside: boolean;
+        speechToText: boolean;
+        textToSpeech: boolean;
     };
     title: {
         containerStyles: string;
@@ -208,6 +224,21 @@ export declare const FIELD_PROPERTIES: {
             };
         };
     };
+    mic: {
+        containerStyles: string;
+        buttonText: string;
+        icon: string;
+        isUpload: boolean;
+        minRecordingTimeInSeconds: number;
+        maxRecordingTimeInSeconds: number;
+        mimeType: string;
+        accept: string;
+        showMediaFiles: boolean;
+        uploadFileToServer: boolean;
+        preview: {
+            show: boolean;
+        };
+    };
     record: {
         containerStyles: string;
         buttonText: string;
@@ -243,12 +274,14 @@ export declare const FIELD_PROPERTIES: {
     };
     select: {
         containerStyles: string;
+        description: string;
         isShowLabelOutside: boolean;
         searchable: boolean;
     };
     "dropdown-with-search": {
         searchable: boolean;
         containerStyles: string;
+        description: string;
         isShowLabelOutside: boolean;
     };
     "star-rating": {

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

@@ -55,7 +55,7 @@ export declare enum EActionKey {
     ALERT_SHOW = "ALERT_SHOW",
     SET_HTML = "SET_HTML"
 }
-export declare type TActionKey = EActionKey.SET_VALUE | EActionKey.SET_FIELD_DEFAULT_VALUE | EActionKey.SET_API_STATUS | EActionKey.SET_API_HEADER_VALUE | EActionKey.SET_API_HEADER_VALIDITY | EActionKey.SET_API_BODY_VALUE | EActionKey.SET_API_BODY_VALIDITY | EActionKey.SET_FIELD_VALIDITY | EActionKey.FIELD_API_TIMER_MESSAGE_SHOW | EActionKey.FIELD_API_TIMER_MESSAGE_HIDE | 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.FIELD_GROUP_SHOW_API_LOADER | EActionKey.FIELD_GROUP_HIDE_API_LOADER | EActionKey.FIELD_SHOW_API_LOADER | EActionKey.FIELD_HIDE_API_LOADER | 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.STOP_WAITING | EActionKey.NOTIFICATION_ERROR_SHOW | EActionKey.NOTIFICATION_ERROR_HIDE | EActionKey.DIALOG_SHOW | EActionKey.DIALOG_HIDE | EActionKey.RESUME_TASK_EXECUTION | EActionKey.STOP_TASK_EXECUTION | EActionKey.REDIRECT_TO_URL | EActionKey.SAVE_FORM | EActionKey.ALERT_SHOW | EActionKey.SET_HTML;
+export declare type TActionKey = EActionKey.SET_VALUE | EActionKey.SET_FIELD_DEFAULT_VALUE | EActionKey.SET_API_STATUS | EActionKey.SET_API_HEADER_VALUE | EActionKey.SET_API_HEADER_VALIDITY | EActionKey.SET_API_BODY_VALUE | EActionKey.SET_API_BODY_VALIDITY | EActionKey.SET_FIELD_VALIDITY | EActionKey.FIELD_API_TIMER_MESSAGE_SHOW | EActionKey.FIELD_API_TIMER_MESSAGE_HIDE | 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.FIELD_GROUP_SHOW_API_LOADER | EActionKey.FIELD_GROUP_HIDE_API_LOADER | EActionKey.FIELD_SHOW_API_LOADER | EActionKey.FIELD_HIDE_API_LOADER | EActionKey.HANDLE_CONNECTED_ELEMENTS | EActionKey.CUSTOM | EActionKey.FIELD_GROUP_SHOW | EActionKey.FIELD_GROUP_HIDE | EActionKey.FIELD_GROUP_ENABLE | EActionKey.FIELD_GROUP_DISABLE | EActionKey.FIELD_GROUP_RESET | 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.STOP_WAITING | EActionKey.NOTIFICATION_ERROR_SHOW | EActionKey.NOTIFICATION_ERROR_HIDE | EActionKey.DIALOG_SHOW | EActionKey.DIALOG_HIDE | EActionKey.RESUME_TASK_EXECUTION | EActionKey.STOP_TASK_EXECUTION | EActionKey.REDIRECT_TO_URL | EActionKey.SAVE_FORM | EActionKey.ALERT_SHOW | EActionKey.SET_HTML;
 export declare type TActionSetValue = TAction & {
     key: EActionKey.SET_VALUE;
     props: {
@@ -97,7 +97,13 @@ export declare type IFieldErrorHide = TAction & {
     key: EActionKey.FIELD_ERROR_HIDE;
     props: {
         fieldKey: string;
-        message: TMessage;
+        message?: TMessage;
+    };
+};
+export declare type TActionFieldGroupReset = TAction & {
+    key: EActionKey.FIELD_GROUP_RESET;
+    props: {
+        groupKey: string;
     };
 };
 export declare type TActionFieldShow = TAction & {

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

@@ -29,12 +29,14 @@ export declare enum EFieldType {
     EMAIL = "email",
     CAPTURE = "capture",
     RECORD = "record",
+    MIC = "mic",
     STAR_RATING = "star-rating",
     LIVE_LOCATION = "live-location",
     DATA_HOLDER = "data-holder",
-    CURRENCY = "currency"
+    CURRENCY = "currency",
+    MASKED = "masked"
 }
-export declare type TFieldType = EFieldType.HTML | EFieldType.TITLE | EFieldType.BUTTON | EFieldType.TEXT | EFieldType.TEXTAREA | EFieldType.CHECKBOX | EFieldType.NUMBER | EFieldType.DATE | EFieldType.TIME | EFieldType.PREVIEW_IMAGE | EFieldType.PHONE | EFieldType.RADIO | EFieldType.DROPDOWN_WITH_SEARCH | EFieldType.SELECT | EFieldType.API | EFieldType.API_CALL | EFieldType.OTP | EFieldType.AADHAAR_NUMBER | EFieldType.SLIDER | EFieldType.FILE | EFieldType.PASSWORD | EFieldType.EMAIL | EFieldType.CAPTURE | EFieldType.RECORD | EFieldType.STAR_RATING | EFieldType.LIVE_LOCATION | EFieldType.DATA_HOLDER | EFieldType.CURRENCY;
+export declare type TFieldType = EFieldType.HTML | EFieldType.TITLE | EFieldType.BUTTON | EFieldType.TEXT | EFieldType.TEXTAREA | EFieldType.CHECKBOX | EFieldType.NUMBER | EFieldType.DATE | EFieldType.TIME | EFieldType.PREVIEW_IMAGE | EFieldType.PHONE | EFieldType.RADIO | EFieldType.DROPDOWN_WITH_SEARCH | EFieldType.SELECT | EFieldType.API | EFieldType.API_CALL | EFieldType.OTP | EFieldType.AADHAAR_NUMBER | EFieldType.SLIDER | EFieldType.FILE | EFieldType.PASSWORD | EFieldType.EMAIL | EFieldType.CAPTURE | EFieldType.RECORD | EFieldType.MIC | EFieldType.STAR_RATING | EFieldType.LIVE_LOCATION | EFieldType.DATA_HOLDER | EFieldType.CURRENCY | EFieldType.MASKED;
 export declare type TFieldSelectOption = {
     title: string;
     value: string;
@@ -67,6 +69,9 @@ export declare type TFieldTextProperties = {
     case: string;
     placeholder: string;
     readOnly: string;
+    description: string;
+    speechToText: boolean;
+    textToSpeech: boolean;
 };
 export declare type TFieldCurrencyProperties = {
     containerStyles: string;
@@ -74,6 +79,17 @@ export declare type TFieldCurrencyProperties = {
     placeholder: string;
     readOnly: string;
 };
+export declare type TFieldMaskedProperties = {
+    containerStyles: string;
+    maskChar: string;
+    maskCount: number;
+    maskDirection: string;
+    maxLength: number | null;
+    pattern: string;
+    placeholder: string;
+    readOnly: string;
+    storeMaskValue: boolean;
+};
 export declare type TFieldEmailProperties = {
     case: string;
     domains: Array<string>;
@@ -90,6 +106,9 @@ export declare type TFieldTextareaProperties = {
     isShowLabelOutside: boolean;
     placeholder: string;
     readOnly: string;
+    description: string;
+    speechToText: boolean;
+    textToSpeech: boolean;
 };
 export declare type TFieldCheckboxProperties = {
     contentAlign: string;
@@ -160,6 +179,7 @@ export declare type TFieldSelectProperties = {
     isShowLabelOutside: boolean;
     placeholder: string;
     readOnly: boolean;
+    description: string;
 };
 export declare type TFieldApiCallProperties = {};
 export declare type TFieldDataHolderProperties = {};
@@ -262,6 +282,21 @@ export declare type TFieldRecordProperties = {
         };
     };
 };
+export declare type TFieldMicProperties = {
+    accept: string;
+    containerStyles: string;
+    buttonText: string;
+    icon: string;
+    isUpload: boolean;
+    minRecordingTimeInSeconds: number;
+    maxRecordingTimeInSeconds: number;
+    mimeType: string;
+    showMediaFiles: boolean;
+    uploadFileToServer: boolean;
+    preview: {
+        show: boolean;
+    };
+};
 export declare type TFieldStarRatingProperties = {
     color: string;
     icon: string;
@@ -281,7 +316,7 @@ export declare type TFieldLiveLocationProperties = {
     styles: string;
     shape: string;
 };
-export declare type TFieldProperties = TFieldTextProperties | TFieldCurrencyProperties | TFieldEmailProperties | TFieldPasswordProperties | TFieldTextareaProperties | TFieldCheckboxProperties | TFieldNumberProperties | TFieldDateProperties | TFieldPhoneProperties | TFieldPreviewImageProperties | TFieldSliderProperties | TFieldRadioProperties | TFieldSelectProperties | TFieldApiCallProperties | TFieldOtpProperties | TFieldAadhaarNumberProperties | TFieldCaptureProperties | TFieldRecordProperties | TFieldStarRatingProperties | TFieldLiveLocationProperties;
+export declare type TFieldProperties = TFieldTextProperties | TFieldCurrencyProperties | TFieldEmailProperties | TFieldPasswordProperties | TFieldTextareaProperties | TFieldCheckboxProperties | TFieldNumberProperties | TFieldDateProperties | TFieldPhoneProperties | TFieldPreviewImageProperties | TFieldSliderProperties | TFieldRadioProperties | TFieldSelectProperties | TFieldApiCallProperties | TFieldOtpProperties | TFieldAadhaarNumberProperties | TFieldCaptureProperties | TFieldRecordProperties | TFieldMicProperties | TFieldStarRatingProperties | TFieldLiveLocationProperties;
 export declare type TField = {
     label: string;
     type: TFieldType;
@@ -366,6 +401,9 @@ export declare type TFieldPreviewImage = TField & {
 export declare type TFieldCapture = TField & {
     properties: TFieldCaptureProperties;
 };
+export declare type TFieldMic = TField & {
+    properties: TFieldMicProperties;
+};
 export declare type TFieldStarRating = TField & {
     properties: TFieldStarRatingProperties;
 };

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

@@ -175,7 +175,7 @@ export declare class KwikIDFormViewComponent implements OnInit, OnChanges, OnDes
     fieldShowApiLoader(fieldKey: string): void;
     setHtml(fieldKey: string, message: TMessage): void;
     fieldErrorShow(fieldKey: string, message: TMessage): void;
-    fieldErrorHide(fieldKey: string, message: TMessage): void;
+    fieldErrorHide(fieldKey: string, message?: TMessage): void;
     fieldMessageShow(fieldKey: string, message: TMessage): void;
     fieldMessageHide(fieldKey: string, message: TMessage): void;
     fieldApiTimerMessageShow(fieldKey: string, timer: TApiTimer): Promise<void>;

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

@@ -13,6 +13,6 @@ import * as i11 from "kwikui";
 import * as i12 from "kwikid-camera";
 export declare class KwikIDFormViewModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<KwikIDFormViewModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormViewModule, [typeof i1.KwikIDFormViewComponent, typeof i2.StyleSanitizerPipe, typeof i3.TimerPipe, typeof i4.FilterImageUrlOrBase64FromObjectPipe, typeof i5.FilterVideoUrlOrBase64FromObjectPipe], [typeof i6.CommonModule, typeof i7.FormsModule, typeof i7.ReactiveFormsModule, typeof i8.TuiLabelModule, typeof i9.TuiPushModule, typeof i8.TuiSvgModule, typeof i10.TuiPreviewModule, typeof i8.TuiButtonModule, typeof i10.TuiPreviewActionModule, typeof i8.TuiDialogModule, typeof i11.KwikUIPipeModule, typeof i11.KwikUIModule, typeof i12.KwikIDCameraModule, typeof i12.KwikUIInputCameraModule, typeof i11.KwikUIInputEmailModule], [typeof i1.KwikIDFormViewComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<KwikIDFormViewModule, [typeof i1.KwikIDFormViewComponent, typeof i2.StyleSanitizerPipe, typeof i3.TimerPipe, typeof i4.FilterImageUrlOrBase64FromObjectPipe, typeof i5.FilterVideoUrlOrBase64FromObjectPipe], [typeof i6.CommonModule, typeof i7.FormsModule, typeof i7.ReactiveFormsModule, typeof i8.TuiLabelModule, typeof i9.TuiPushModule, typeof i8.TuiSvgModule, typeof i10.TuiPreviewModule, typeof i8.TuiButtonModule, typeof i10.TuiPreviewActionModule, typeof i8.TuiDialogModule, typeof i11.KwikUIPipeModule, typeof i11.KwikUIModule, typeof i12.KwikIDCameraModule, typeof i12.KwikUIInputCameraModule, typeof i11.KwikUIInputEmailModule, typeof i11.KwikUIInputMaskedModule, typeof i11.KwikUIInputMicModule], [typeof i1.KwikIDFormViewComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<KwikIDFormViewModule>;
 }

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

@@ -0,0 +1,25 @@
+import { TApiEndpoint } from "../definitions/form-view.apis.definition";
+/**
+ * Collects each endpoint's response.value under its apiKey.
+ * Used by API_CALL_MULTIPLE_END so form storage keeps
+ * { nsdl: {...}, dedupe: {...} } instead of a blank control value.
+ */
+export declare const collectMultipleApiCallResponses: (endpoints?: TApiEndpoint[]) => Record<string, any>;
+/**
+ * Writes the aggregated multi-API result onto the live formData object.
+ * Mutates in place so in-flight Action/Source objects that share this
+ * FORM_DATA reference still see the stored object after later SET_VALUE.
+ */
+export declare const applyMultipleApiCallResponsesToFormData: (formData: Record<string, any>, fieldKey: string, responses: Record<string, any>, actionObject?: {
+    FORM_DATA?: Record<string, any>;
+}) => Record<string, any>;
+/**
+ * API-call buttons keep "" on the FormControl. When saving, prefer the
+ * object already stored on this.formData (keyed by each apiKey).
+ */
+export declare const resolveFormFieldValueForSave: (fieldType: string, controlValue: any, storedValue: any) => any;
+/**
+ * SET_VALUE later in a multi-API chain can hold a stale FORM_DATA snapshot
+ * where the api-call field is still "". Do not let that wipe a stored object.
+ */
+export declare const syncFormDataPreservingApiObjects: (currentFormData: Record<string, any>, incomingFormData: Record<string, any>) => Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kwikid-forms",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "KwikID's JSON Configuration based Forms Renderer and Builder",
   "author": {
     "name": "Baiju Dodhia"
@@ -28,8 +28,8 @@
     "axios": "^1.6.8",
     "jsonpath": "^1.1.1",
     "kwikid-camera": "0.0.24",
-    "kwikid-toolkit": "^0.2.18",
-    "kwikui": "^0.3.31",
+    "kwikid-toolkit": "^0.2.25",
+    "kwikui": "^1.0.0",
     "lodash": "^4.17.21",
     "tslib": "^2.2.0"
   },