@zohodesk/library-platform 1.1.13 → 1.2.0

package/es/platform/zform/adapters/presenter/translators/fields/LookUpFieldTranslator.js

@@ -6,19 +6,23 @@ const LookUpFieldTranslator = _ref => {
     uiConfig
   } = _ref;
   const fieldModified = {
-    type,
-    uiConfig,
-    value: field.value || '',
+    // Need to check if value is an object or string (ID)
+    value: field.value ? field.value instanceof Object ? field.value.id : field.value : '',
     //state.behaviours.zform.values[field.apiName],
     name: field.apiName,
     ...fieldPreModified,
+    uiConfig: uiConfig,
+    type: type,
+    fieldType: field.type,
     id: field.id,
     label: field.i18NLabel,
-    required: field.isMandatory,
-    readonly: field.isReadOnly,
-    // visibility: field.isVisible,
+    apiName: field.apiName,
+    errorMessage: field.errorMessage,
     isVisible: field.isVisible,
-    errorMessage: field.errorMessage || '',
+    readonly: field.isReadOnly,
+    required: field.isMandatory,
+    isCustomField: field.isCustomField,
+    maxLength: field.maxLength,
     lookup: field.lookup
   };
   return fieldModified;

package/es/platform/zform/adapters/presenter/translators/fields/NumberFieldTranslator.js

@@ -16,6 +16,7 @@ const NumberFieldTranslator = _ref => {
     label: field.i18NLabel,
     // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
+    maxLength: field.maxLength,
     readonly: field.isReadOnly,
     // visibility: field.isVisible,
     isVisible: field.isVisible,

package/es/platform/zform/adapters/presenter/translators/fields/PhoneFieldTranslator.js

@@ -16,6 +16,7 @@ const PhoneFieldTranslator = _ref => {
     label: field.i18NLabel,
     // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
+    maxLength: field.maxLength,
     readonly: field.isReadOnly,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''

package/es/platform/zform/adapters/presenter/translators/fields/TextAreaFieldTranslator.js

@@ -16,6 +16,7 @@ const TextAreaFieldTranslator = _ref => {
     label: field.i18NLabel,
     required: field.isMandatory,
     readonly: field.isReadOnly,
+    maxLength: field.maxLength,
     // visibility: field.isVisible,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''

package/es/platform/zform/adapters/presenter/translators/fields/TextFieldTranslator.js

@@ -17,6 +17,7 @@ const TextFieldTranslator = _ref => {
     // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
     readonly: field.isReadOnly,
+    maxLength: field.maxLength,
     // visibility: field.isVisible,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''

package/es/platform/zform/adapters/presenter/translators/fields/URLFieldTranslator.js

@@ -16,6 +16,7 @@ const URLFieldTranslator = _ref => {
     label: field.i18NLabel,
     // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
+    maxLength: field.maxLength,
     readonly: field.isReadOnly,
     // visibility: field.isVisible,
     isVisible: field.isVisible,

package/es/platform/zform/adapters/presenter/utils/sanitizeHtmlString.js

@@ -1,5 +1,5 @@
-import ZSEC from '@zoho/SecurityJS';
-const currentZSEC = ZSEC['7.2.4'];
+import ZWAF from '@zoho/SecurityJS';
+const currentZSEC = ZWAF['7.4.2'];
 const {
   HTMLPurifier
 } = currentZSEC;

package/es/platform/zform/applications/interfaces/input/GetInitialRecordSuccessUseCaseInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/platform/zform/applications/usecases/GetInitialRecordSuccessUseCase.js

@@ -0,0 +1,132 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { ZFORM_API_FAILURE, ZFORM_DEPENDENCY_MAPPINGS_SUCCESS, ZFORM_LAYOUT_RULES_SUCCESS, ZFORM_MY_FORM_SUCCESS } from "../../../../bc/zform/Symbol";
+import { DATA_SOURCE_EXECUTE as DATA_BROKER_EXECUTE } from "../../../../bc/zdata-source/Constants";
+import { DATA_SOURCE_SUCCESS, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../../bc/zdata-source/Symbols";
+
+class GetInitialRecordSuccessUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      disableValidationRule,
+      disableLayoutRule,
+      disableDependencyMapping
+    } = input;
+    const {
+      dispatch,
+      record
+    } = input;
+    const zformEntity = this.dependencies.repository.getFormEntity();
+    zformEntity.setInitialRecord(record);
+    const context = { ...zformEntity.getContext(),
+      layoutId: zformEntity.getLayoutId()
+    };
+    dispatch({
+      type: DATA_BROKER_EXECUTE,
+      payload: {
+        actionName: "getMyForm",
+        props: context
+      },
+      metaData: {
+        actionName: "getMyForm",
+        //hack
+        initialRecordData: record,
+        // Store record data here for later use
+        [DATA_SOURCE_NO_CONTENT]: {
+          type: ZFORM_MY_FORM_SUCCESS,
+          metaData: {
+            actionName: "getMyForm",
+            initialRecordData: record
+          }
+        },
+        //hack
+        [DATA_SOURCE_FAILURE]: {
+          type: ZFORM_API_FAILURE,
+          metaData: {
+            actionName: 'getMyForm'
+          }
+        },
+        [DATA_SOURCE_SUCCESS]: {
+          type: ZFORM_MY_FORM_SUCCESS,
+          metaData: {
+            actionName: "getMyForm",
+            initialRecordData: record
+          }
+        }
+      }
+    });
+
+    if (!disableDependencyMapping) {
+      dispatch({
+        type: DATA_BROKER_EXECUTE,
+        payload: {
+          actionName: "getDependencyMappings",
+          props: context
+        },
+        metaData: {
+          actionName: "getDependencyMappings",
+          //hack
+          [DATA_SOURCE_SUCCESS]: {
+            type: ZFORM_DEPENDENCY_MAPPINGS_SUCCESS,
+            metaData: {
+              actionName: "getDependencyMappings"
+            }
+          },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'getDependencyMappings'
+            }
+          },
+          [DATA_SOURCE_NO_CONTENT]: {
+            type: ZFORM_DEPENDENCY_MAPPINGS_SUCCESS,
+            metaData: {
+              actionName: "getDependencyMappings"
+            }
+          }
+        }
+      });
+    } else {
+      zformEntity.setDependencyFetching(false);
+    }
+
+    if (!disableLayoutRule) {
+      dispatch({
+        type: DATA_BROKER_EXECUTE,
+        payload: {
+          actionName: "getLayoutRules",
+          props: { ...context,
+            activeRulesOnly: true
+          }
+        },
+        metaData: {
+          actionName: "getLayoutRules",
+          //hack
+          [DATA_SOURCE_NO_CONTENT]: {
+            type: ZFORM_LAYOUT_RULES_SUCCESS,
+            metaData: {
+              actionName: "getLayoutRules"
+            }
+          },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'getLayoutRules'
+            }
+          },
+          [DATA_SOURCE_SUCCESS]: {
+            type: ZFORM_LAYOUT_RULES_SUCCESS,
+            metaData: {
+              actionName: "getLayoutRules"
+            }
+          }
+        }
+      });
+    } else {
+      zformEntity.setLayoutRulesFetching(false);
+    }
+
+    this.dependencies.presenter.updateFormResponse(zformEntity.toObject());
+  }
+
+}
+
+export default GetInitialRecordSuccessUseCase;

package/es/platform/zform/applications/usecases/InitializeUseCase.js

@@ -1,10 +1,11 @@
 import AbstractUseCase from "./AbstractUseCase";
-import { ZFORM_API_FAILURE, ZFORM_MY_LAYOUTS_SUCCESS } from "../../../../bc/zform/Symbol";
+import { ZFORM_API_FAILURE, ZFORM_INITIAL_RECORD_SUCCESS, ZFORM_MY_LAYOUTS_SUCCESS } from "../../../../bc/zform/Symbol";
 import { DATA_SOURCE_EXECUTE } from "../../../../bc/zdata-source/Constants";
-import { DATA_SOURCE_SUCCESS, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../../bc/zdata-source/Symbols";
 import { CLIENTACTION_BEHAVIOUR_EXECUTE } from "../../../client-actions/bc/zclient-actions/Constants";
 import { ZFormApiActionName } from "../../../../bc/zform/Constants";
 import { CLIENTSCRIPT_FETCH } from "../../../client-scripts/bc/zclient-scripts-fetch/Constants";
+import { RecordApiActionName } from "../../../../bc/zrecord/Constants";
+import { ACA_ERROR_OCCURRED, ErrorCodes } from "../../../../cc/component/ErrorStructure";
 
 class InitializeUseCase extends AbstractUseCase {
   execute(input) {
@@ -48,38 +49,61 @@ class InitializeUseCase extends AbstractUseCase {
       });
     }
 
-    dispatch({
-      type: DATA_SOURCE_EXECUTE,
-      payload: {
-        actionName: ZFormApiActionName.getMyLayouts,
-        props: { ...context,
-          from: 1,
-          limit: 50
-        }
-      },
-      metaData: {
-        actionName: ZFormApiActionName.getMyLayouts,
-        //hack
-        [DATA_SOURCE_NO_CONTENT]: {
-          type: ZFORM_MY_LAYOUTS_SUCCESS,
-          metaData: {
-            actionName: ZFormApiActionName.getMyLayouts
+    if (zformEntity.isEditMode()) {
+      const recordId = zformEntity.getRecordId();
+
+      if (!recordId) {
+        const errorStructure = {
+          code: ErrorCodes.PROPERTY_VALIDATION_FAILED,
+          message: 'Record ID is required for Edit Mode',
+          errorDetails: {
+            validationResults: [{
+              key: 'recordId',
+              errors: [{
+                message: 'Record ID is required for Edit Mode'
+              }],
+              value: recordId
+            }],
+            isBreaking: true
           }
+        };
+        dispatch({
+          type: ACA_ERROR_OCCURRED,
+          payload: errorStructure
+        });
+        return;
+      }
+
+      dispatch({
+        type: DATA_SOURCE_EXECUTE,
+        payload: {
+          actionName: RecordApiActionName.GET_SINGLE_RECORD,
+          props: context
         },
-        [DATA_SOURCE_FAILURE]: {
-          type: ZFORM_API_FAILURE,
-          metaData: {
-            actionName: ZFormApiActionName.getMyLayouts
+        metaData: zformEntity.getDataSourceMetaData({
+          actionName: RecordApiActionName.GET_SINGLE_RECORD,
+          successEvent: ZFORM_INITIAL_RECORD_SUCCESS,
+          failureEvent: ZFORM_API_FAILURE
+        })
+      });
+    } else {
+      dispatch({
+        type: DATA_SOURCE_EXECUTE,
+        payload: {
+          actionName: ZFormApiActionName.getMyLayouts,
+          props: { ...context,
+            from: 1,
+            limit: 50
           }
         },
-        [DATA_SOURCE_SUCCESS]: {
-          type: ZFORM_MY_LAYOUTS_SUCCESS,
-          metaData: {
-            actionName: ZFormApiActionName.getMyLayouts
-          }
-        }
-      }
-    });
+        metaData: zformEntity.getDataSourceMetaData({
+          actionName: ZFormApiActionName.getMyLayouts,
+          //hack
+          successEvent: ZFORM_MY_LAYOUTS_SUCCESS,
+          failureEvent: ZFORM_API_FAILURE
+        })
+      });
+    }
   }
 
 }

package/es/platform/zform/applications/usecases/LookupFieldSuccessUseCase.js

@@ -11,6 +11,11 @@ class LookUpFieldSuccessUseCase extends AbstractUseCase {
       dispatch,
       fieldMetadataResponse
     } = input;
+
+    if (!fieldMetadataResponse || !fieldMetadataResponse.data || fieldMetadataResponse.data.length === 0) {
+      return;
+    }
+
     const {
       data
     } = fieldMetadataResponse;

package/es/platform/zform/applications/usecases/MyFormSuccessUseCase.js

@@ -21,14 +21,17 @@ class MyFormSuccessUseCase extends AbstractUseCase {
       sections
     } = myForm;
     const zFormEntity = repository.getFormEntity();
+    const layoutId = zFormEntity.getLayoutId();
+    const initialRecord = zFormEntity.getInitialRecord();
     const context = { ...zFormEntity.getContext(),
-      layoutId: zFormEntity.getLayoutId()
+      layoutId: layoutId
     };
     const lookupFields = sections.flatMap(section => section.fields.filter(field => field.type === 'LookUp'));
     const sectionEntities = sections.map(section => {
       const fields = section.fields.map(field => {
+        const recordValue = initialRecord ? field.isCustomField ? initialRecord.cf[field.apiName] : initialRecord[field.apiName] : undefined;
         const entity = new ZField(field);
-        entity.decideDefaultValue();
+        entity.decideDefaultValue(recordValue);
         return entity;
       });
       const sectionWithFields = { ...section,
@@ -63,24 +66,22 @@ class MyFormSuccessUseCase extends AbstractUseCase {
         type: DATA_SOURCE_EXECUTE,
         payload: {
           actionName: 'fetchLookupFields',
-          props: { ...context
-          }
+          props: context
         },
         metaData: {
           actionName: 'fetchLookupFields',
-          //hack
           [DATA_SOURCE_NO_CONTENT]: {
             type: ZFORM_LOOKUP_FIELD_SUCCESS,
             metaData: {
               actionName: 'fetchLookupFields'
             }
           },
-          // [DATA_SOURCE_FAILURE]: {
-          //   type: ZFORM_LOOKUP_FIELD_SUCCESS,
-          //   metaData: {
-          //     actionName: 'fetchValidationRules'
-          //   }
-          // },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'fetchLookupFields'
+            }
+          },
           [DATA_SOURCE_SUCCESS]: {
             type: ZFORM_LOOKUP_FIELD_SUCCESS,
             metaData: {

package/es/platform/zform/applications/usecases/SubmitValidationCompletedUseCase.js

@@ -1,4 +1,4 @@
-import { CREATE_RECORD } from "../../../../bc/zrecord/Constants";
+import { CREATE_RECORD, UPDATE_RECORD } from "../../../../bc/zrecord/Constants";
 import AbstractUseCase from "./AbstractUseCase";
 import { ZFORM_ERROR, ZFORM_VALIDATION_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE } from "../../../../bc/zform/Symbol";
 
@@ -43,6 +43,7 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
       const moduleName = zFormEntity.getModuleName();
       const record = zFormEntity.getVisibleFieldsAsRecord();
       const visibleFieldsData = zFormEntity.getVisibleFieldsData();
+      const isEditMode = zFormEntity.isEditMode();
       dispatch({
         type: ZFORM_VALIDATION_SUCCESS,
         payload: {
@@ -52,13 +53,25 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
       });
 
       if (!disableCreateRecord) {
-        dispatch({
-          type: CREATE_RECORD,
-          payload: {
-            record,
-            moduleName
-          }
-        });
+        if (isEditMode) {
+          const recordId = zFormEntity.getRecordId();
+          dispatch({
+            type: UPDATE_RECORD,
+            payload: {
+              record,
+              moduleName,
+              recordId
+            }
+          });
+        } else {
+          dispatch({
+            type: CREATE_RECORD,
+            payload: {
+              record,
+              moduleName
+            }
+          });
+        }
       }
     }
   }

package/es/platform/zform/domain/ZField.js

@@ -79,18 +79,20 @@ export default class ZField {
     return defaultValue;
   }
 
-  decideDefaultValue() {
+  decideDefaultValue(_defaultValue) {
+    const defaultValue = _defaultValue !== undefined ? _defaultValue : this.defaultValue;
+
     switch (this.type) {
       case 'Boolean':
-        this.value = this.decideValueForBoolean(this.defaultValue);
+        this.value = this.decideValueForBoolean(defaultValue);
         break;
 
       case 'Multiselect':
-        this.value = this.decideValueForMultiselect(this.defaultValue);
+        this.value = this.decideValueForMultiselect(defaultValue);
         break;
 
       default:
-        this.value = this.defaultValue === undefined ? '' : this.defaultValue;
+        this.value = defaultValue === undefined ? '' : defaultValue;
     }
   }
 
@@ -184,7 +186,7 @@ export default class ZField {
       isEncryptedField: this.isEncryptedField,
       id: this.id,
       isRemovable: this.isRemovable,
-      maxLength: this.maxLength,
+      maxLength: Number(this.maxLength) > 0 ? Number(this.maxLength) : this.maxLength,
       isMandatory: this.isMandatory,
       value: this.value,
       errorMessage: this.errorMessage,

package/es/platform/zform/domain/ZForm.js

@@ -1,6 +1,7 @@
 import { ErrorCodes } from "../../../cc/component/ErrorStructure";
 import { ZFormApiActionName } from "../../../bc/zform/Constants";
-import { ZHttpErrorCode } from "../../../bc/zhttp/Errors";
+import { DATA_SOURCE_SUCCESS, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../bc/zdata-source/Symbols";
+import { RecordApiActionName } from "../../../bc/zrecord/Constants";
 export default class ZForm {
   /*hack*/
 
@@ -21,6 +22,10 @@ export default class ZForm {
       dependencyMappings,
       context,
       focusedFieldName,
+      layoutId,
+      mode,
+      recordId,
+      initialRecordData,
 
       /*hack*/
       isMyFormFetching,
@@ -45,6 +50,10 @@ export default class ZForm {
     this.dependencyMappings = dependencyMappings;
     this.context = context;
     this.focusedFieldName = focusedFieldName || null;
+    this.layoutId = layoutId;
+    this.initialRecordData = initialRecordData;
+    this.mode = mode;
+    this.recordId = recordId;
     /*hack*/
 
     this.isMyFormFetching = isMyFormFetching;
@@ -81,14 +90,64 @@ export default class ZForm {
       orgName,
       servicePrefix
     } = this.context;
-    return {
+    const recordId = this.getRecordId();
+    const formValues = this.getVisibleFieldsData();
+    const context = {
       module,
       departmentId: departmentId,
       orgName,
+      mode: this.mode,
+      formValues,
+      record: this.initialRecordData,
       ...this.context,
       servicePrefix: servicePrefix || 'supportapi/zd' // FIX: servicePrefix defaultValue should be available from properties
 
     };
+
+    if (recordId) {
+      context.recordId = recordId;
+    }
+
+    return context;
+  }
+
+  getRecordId() {
+    return this.recordId;
+  }
+
+  isEditMode() {
+    return this.mode === 'edit';
+  }
+
+  getDataSourceMetaData(_ref2) {
+    let {
+      actionName,
+      successEvent,
+      failureEvent,
+      extras
+    } = _ref2;
+    return {
+      actionName,
+      //hack
+      [DATA_SOURCE_NO_CONTENT]: {
+        type: successEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      },
+      [DATA_SOURCE_FAILURE]: {
+        type: failureEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      },
+      [DATA_SOURCE_SUCCESS]: {
+        type: successEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      }
+    };
   }
 
   setFormProperties(properties, layoutRuleHelper) {
@@ -137,6 +196,10 @@ export default class ZForm {
     let isBreaking = false; // Set error state based on the failed action
 
     switch (actionName) {
+      case RecordApiActionName.GET_SINGLE_RECORD:
+        isBreaking = true;
+        break;
+
       case ZFormApiActionName.getMyForm:
         this.setMyFormFetching(false);
         isBreaking = true;
@@ -170,34 +233,23 @@ export default class ZForm {
   }
 
   constructApiErrorEvent(error, actionName, isBreaking) {
-    if (error.code === ZHttpErrorCode.ApiError) {
-      return {
-        code: ErrorCodes.API_FAILED,
-        message: 'Api call failed for action: ' + actionName,
-        errorDetails: {
-          isBreaking,
-          originalError: error,
-          actionName
-        }
-      };
-    }
-
     return {
-      code: ErrorCodes.UNKNOWN_ERROR,
-      message: 'Api call failed for action: ' + actionName,
+      code: ErrorCodes.API_FAILED,
+      message: error.message,
       errorDetails: {
         isBreaking,
-        originalError: error,
-        actionName
+        message: 'Api call failed for action: ' + actionName,
+        actionName,
+        originalError: error
       }
     };
   }
 
-  getSectionId(_ref2) {
+  getSectionId(_ref3) {
     let {
       fieldName,
       sectionName
-    } = _ref2;
+    } = _ref3;
 
     if (sectionName) {
       for (let section of this.sections) {
@@ -482,6 +534,27 @@ export default class ZForm {
     }
   }
 
+  setInitialRecord(recordData) {
+    this.initialRecordData = recordData;
+    const layoutId = recordData.layout.id;
+    this.setLayoutId(layoutId); // if (recordData && recordData.data && recordData.data.length > 0) {
+    //   const record = recordData.data[0];
+    //   // Populate form fields with record data
+    //   Object.keys(record).forEach(fieldApiName => {
+    //     if (fieldApiName !== 'id') { // Skip ID field
+    //       const field = this.getFieldByApiName(fieldApiName);
+    //       if (field) {
+    //         field.setValue(record[fieldApiName]);
+    //       }
+    //     }
+    //   });
+    // }
+  }
+
+  getInitialRecord() {
+    return this.initialRecordData;
+  }
+
   getFieldErrorMessage(fieldApiName) {
     const field = this.getFieldByApiName(fieldApiName);
     return field ? field.getErrorMessage() : undefined;
@@ -627,6 +700,7 @@ export default class ZForm {
   }
 
   toObject() {
+    const formValues = this.getVisibleFieldsData();
     return {
       modifiedTime: this.modifiedTime,
       isStandardLayout: this.isStandardLayout,
@@ -642,8 +716,11 @@ export default class ZForm {
       dependencyMappings: this.dependencyMappings.map(dm => dm.toObject()),
       focusedFieldName: this.focusedFieldName,
       layoutId: this.layoutId,
+      mode: this.mode,
+      initialRecordData: this.initialRecordData,
 
       /*hack*/
+      formValues,
       isMyFormFetching: this.isMyFormFetching,
       isDependencyFetching: this.isDependencyFetching,
       isLayoutRulesFetching: this.isLayoutRulesFetching,