@zohodesk/library-platform 1.1.9 → 1.1.10

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

@@ -1,3 +1,4 @@
+import { i18NProviderUtils } from '@zohodesk/i18n';
 export default function DefaultFormClientActions(props) {
   const {
     submitConfig,
@@ -6,22 +7,22 @@ export default function DefaultFormClientActions(props) {
   } = props;
   const finalClientActions = [];
 
-  if (submitConfig !== null && submitConfig !== void 0 && submitConfig.isEnabled) {
+  if (submitConfig?.isEnabled) {
     finalClientActions.push(getDefaultFormAction({
-      type: "submit",
+      type: 'submit',
       ...submitConfig
     }));
   }
 
-  if (cancelConfig !== null && cancelConfig !== void 0 && cancelConfig.isEnabled) {
+  if (cancelConfig?.isEnabled) {
     finalClientActions.push(getDefaultFormAction({
-      type: "cancel",
+      type: 'cancel',
       ...cancelConfig
     }));
-  }
+  } // finalClientActions.push(getDefaultFieldInfoAction());
+  // finalClientActions.push(getDefaultFieldEphiAction());
+
 
-  finalClientActions.push(getDefaultFieldInfoAction());
-  finalClientActions.push(getDefaultFieldEphiAction());
   return [...finalClientActions, ...clientActions];
 }
 
@@ -31,99 +32,106 @@ function getDefaultFormAction(_ref) {
     text,
     isEnabled
   } = _ref;
-  const isSubmit = type === "submit";
+  const isSubmit = type === 'submit';
   return {
-    id: isSubmit ? "4000000080010" : "4000000080013",
-    name: "FORM ACTION",
-    component: "form",
-    location: "footer_left_actions",
+    id: isSubmit ? '4000000080010' : '4000000080013',
+    name: 'FORM ACTION',
+    component: 'form',
+    location: 'footer_left_actions',
     uiComponentMapping: {
-      id: isSubmit ? "4000000080011" : "4000000080014",
-      name: isSubmit ? "Submit Button" : "Cancel Button",
-      component: "Button",
+      id: isSubmit ? '4000000080011' : '4000000080014',
+      name: isSubmit ? 'Submit Button' : 'Cancel Button',
+      component: 'Button',
       propertiesValueMapping: {
-        text: text || (isSubmit ? "Submit" : "Cancel"),
-        palette: isSubmit ? "primaryFilled" : "secondary"
+        text: isSubmit ? i18NProviderUtils.getI18NValue('crm.button.submit') : i18NProviderUtils.getI18NValue('support.label.cancel'),
+        palette: isSubmit ? 'primaryFilled' : 'secondary'
       },
       eventMappings: [{
-        id: isSubmit ? "4000000080012" : "4000000080015",
-        sourceEvent: "BUTTON#CLICKED",
-        targetEvent: isSubmit ? "SMART_FORM#SUBMIT_CLICKED" : "SMART_FORM#CANCEL_CLICKED",
+        id: isSubmit ? '4000000080012' : '4000000080015',
+        sourceEvent: 'BUTTON#CLICKED',
+        targetEvent: isSubmit ? 'SMART_FORM#SUBMIT_CLICKED' : 'SMART_FORM#CANCEL_CLICKED',
         payloadValueMapping: {}
       }]
     },
-    modules: ["static_module"],
+    modules: ['static_module'],
     conditions: {
       fields: [],
-      pattern: ""
+      pattern: ''
     }
   };
 }
 
-function getDefaultFieldInfoAction() {
+export function getDefaultFieldInfoActionTemplate(props) {
+  const {
+    label,
+    fieldName
+  } = props;
   return {
-    "uiComponentMapping": {
-      "component": "ActionIcon",
-      "name": "Info Icon",
-      "id": "4000000081003",
-      "propertiesValueMapping": {
-        "hoverVariant": "primary",
-        "icon": "ZD-information",
-        "label": "Default Info Icon"
+    uiComponentMapping: {
+      component: 'ActionIcon',
+      name: 'Info Icon',
+      id: '4000000081003',
+      propertiesValueMapping: {
+        hoverVariant: 'default',
+        icon: 'ZD-GN-info',
+        hasPadding: false,
+        label: label || 'Default Info Icon'
       },
-      "eventMappings": [{
-        "payloadValueMapping": {},
-        "id": "4000000081005"
+      eventMappings: [{
+        payloadValueMapping: {},
+        id: '4000000081005'
       }]
     },
-    "conditions": {
-      "fields": [{
-        "fieldName": "{{@context.apiName}}",
-        "condition": "in",
-        "value": ["gadget_name", "gadget_description", "cf_total_qa_issues", "cf_is_pm_reviewed_1", "cf_related_gadget", "priority", "cf_tested_by", "cf_security_dri", "cf_git_merge_request_url", "release_deadline", "cf_tentative_eta", "cf_mutation_coverage", "cf_support_phone", "cf_test_coverage_score", "cf_budget_allocation", "cf_brand_owner", "cf_brand_launch_date", "cf_marketing_channel"]
+    conditions: {
+      fields: [{
+        fieldName: '{{@context.apiName}}',
+        condition: 'is',
+        value: [fieldName]
       }],
-      "pattern": "1"
+      pattern: '1'
     },
-    "modifiedTime": "2024-11-21T06:11:59.000Z",
-    "component": "form",
-    "name": "FORM ACTION",
-    "createdTime": "2024-11-21T06:11:59.000Z",
-    "location": "field_label_actions",
-    "id": "4000000081009",
-    "modules": ["static_module"]
+    modifiedTime: '2024-11-21T06:11:59.000Z',
+    component: 'form',
+    name: 'FORM ACTION',
+    createdTime: '2024-11-21T06:11:59.000Z',
+    location: 'field_label_actions',
+    id: '4000000081009',
+    modules: ['static_module']
   };
 }
-
-function getDefaultFieldEphiAction() {
+export function getDefaultFieldEphiActionTemplate(props) {
+  const {
+    fieldName
+  } = props;
   return {
-    "uiComponentMapping": {
-      "component": "HighlightedValue",
-      "name": "EPHI Tag",
-      "id": "4000000082003",
-      "propertiesValueMapping": {
-        "text": "ePHI",
-        "color": "green",
-        "tooltip": "ePHI is individually identifiable protected health information sent or stored electronically."
+    uiComponentMapping: {
+      component: 'HighlightedValue',
+      name: 'EPHI Tag',
+      id: '4000000082003',
+      propertiesValueMapping: {
+        text: 'ePHI',
+        color: 'green',
+        tooltip: 'ePHI is individually identifiable protected health information sent or stored electronically.'
       },
-      "eventMappings": [{
-        "payloadValueMapping": {},
-        "id": "4000000082005"
+      eventMappings: [{
+        payloadValueMapping: {},
+        id: '4000000082005'
       }]
     },
-    "conditions": {
-      "fields": [{
-        "fieldName": "{{@context.apiName}}",
-        "condition": "in",
-        "value": ["gadget_name", "cf_total_qa_issues", "cf_security_dri", "cf_git_merge_request_url", "cf_mutation_coverage", "cf_support_phone", "cf_test_coverage_score", "cf_brand_owner"]
+    conditions: {
+      fields: [{
+        fieldName: '{{@context.apiName}}',
+        condition: 'is',
+        value: [fieldName]
       }],
-      "pattern": "1"
+      pattern: '1'
     },
-    "modifiedTime": "2024-11-21T06:11:59.000Z",
-    "component": "form",
-    "name": "FORM ACTION",
-    "createdTime": "2024-11-21T06:11:59.000Z",
-    "location": "field_label_actions",
-    "id": "4000000082009",
-    "modules": ["static_module"]
+    modifiedTime: '2024-11-21T06:11:59.000Z',
+    component: 'form',
+    name: 'FORM ACTION',
+    createdTime: '2024-11-21T06:11:59.000Z',
+    location: 'field_label_actions',
+    id: '4000000082009',
+    modules: ['static_module']
   };
 }

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

@@ -0,0 +1,11 @@
+import ZSEC from '@zoho/SecurityJS';
+const currentZSEC = ZSEC['7.2.4'];
+const {
+  HTMLPurifier
+} = currentZSEC;
+export default function sanitizeHtmlString(_ref) {
+  let {
+    htmlString
+  } = _ref;
+  return HTMLPurifier.sanitize(htmlString);
+}

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

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

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

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

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

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

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

@@ -15,7 +15,7 @@ class GetFieldValueUseCase extends AbstractUseCase {
     let fieldValue = zformEntitiy.getFieldValue(fieldName);
     let zform = zformEntitiy.toObject();
     presenter.updateFormResponse(zform);
-    callback === null || callback === void 0 ? void 0 : callback(fieldValue);
+    callback?.(fieldValue);
   }
 
 }

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

@@ -0,0 +1,35 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetIsFieldValueChangedUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      callback,
+      dispatch
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zformEntitiy = repository.getFormEntity();
+    let allFields = zformEntitiy.getAllFields();
+    const isFieldValueChanged = allFields.some(field => {
+      const value = field.getValue();
+      const defaultValue = field.getDefaultValue();
+      const isEmpty = value === null || value === '';
+
+      if (field.getType() === "Boolean") {
+        return value !== defaultValue; // simple compare
+      }
+
+      const cond1 = defaultValue && value !== defaultValue;
+      const cond2 = !defaultValue && !isEmpty;
+      return cond1 || cond2;
+    });
+    let zform = zformEntitiy.toObject();
+    presenter.updateFormResponse(zform);
+    callback?.(isFieldValueChanged);
+  }
+
+}
+
+export default GetIsFieldValueChangedUseCase;

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

@@ -0,0 +1,33 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class LookUpFieldSuccessUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      repository,
+      presenter,
+      layoutRuleApplier
+    } = this.dependencies;
+    const {
+      dispatch,
+      fieldMetadataResponse
+    } = input;
+    const {
+      data
+    } = fieldMetadataResponse;
+    const zFormEntity = this.dependencies.repository.getFormEntity();
+    data.forEach(fieldValue => {
+      zFormEntity.updateFieldProperties(fieldValue.apiName, fieldValue);
+    });
+    let zform = zFormEntity.toObject();
+    presenter.updateFormResponse(zform);
+  }
+
+  getSelectedFieldLookup = (currentData, LookupField) => currentData.apiName === LookupField;
+}
+
+function hasMatchingApiName(listA, listB) {
+  const apiNamesB = new Set(listB.map(item => item.apiName));
+  return listA.some(item => apiNamesB.has(item.apiName));
+}
+
+export default LookUpFieldSuccessUseCase;

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

@@ -3,7 +3,7 @@ import ZSection from "../../domain/ZSection";
 import ZField from "../../domain/ZField";
 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 { ZFORM_VALIDATION_RULES_FAILURE, ZFORM_VALIDATION_RULES_SUCCESS } from "../../../../bc/zform/Symbol";
+import { ZFORM_VALIDATION_RULES_FAILURE, ZFORM_VALIDATION_RULES_SUCCESS, ZFORM_LOOKUP_FIELD_SUCCESS } from "../../../../bc/zform/Symbol";
 
 class MyFormSuccessUseCase extends AbstractUseCase {
   execute(input) {
@@ -24,6 +24,7 @@ class MyFormSuccessUseCase extends AbstractUseCase {
     const context = { ...zFormEntity.getContext(),
       layoutId: zFormEntity.getLayoutId()
     };
+    const lookupFields = sections.flatMap(section => section.fields.filter(field => field.type === 'LookUp'));
     const sectionEntities = sections.map(section => {
       const fields = section.fields.map(field => {
         const entity = new ZField(field);
@@ -57,6 +58,39 @@ class MyFormSuccessUseCase extends AbstractUseCase {
       });
     });
 
+    if (lookupFields.length > 0) {
+      dispatch({
+        type: DATA_SOURCE_EXECUTE,
+        payload: {
+          actionName: 'fetchLookupFields',
+          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_SUCCESS]: {
+            type: ZFORM_LOOKUP_FIELD_SUCCESS,
+            metaData: {
+              actionName: 'fetchLookupFields'
+            }
+          }
+        }
+      });
+    }
+
     if (!disableValidationRule) {
       presenter.updateFormResponse(zFormEntity.toObject());
       dispatch({

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

@@ -17,7 +17,7 @@ class MyLayoutSuccessUseCase extends AbstractUseCase {
     let layoutObject = layouts.find(layout => layout.isDefaultLayout == true); // dispatch({type:ZFORM_MY_FORM_REQUEST,payload:{isFetching:true}}) 
 
     const zformEntity = this.dependencies.repository.getFormEntity();
-    zformEntity.setLayoutId(layoutObject === null || layoutObject === void 0 ? void 0 : layoutObject.id);
+    zformEntity.setLayoutId(layoutObject?.id);
     const context = { ...zformEntity.getContext(),
       layoutId: zformEntity.getLayoutId()
     };

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

@@ -0,0 +1,33 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { ZFORM_ERROR, ZFORM_SUBMIT_SUCCESS } from "../../../../bc/zform/Symbol";
+
+class ValidateErrorMessageUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      dispatch
+    } = input;
+    const zformEntitiy = this.dependencies.repository.getFormEntity();
+
+    if (zformEntitiy.hasError()) {
+      let errorMessages = zformEntitiy.getVisibleFieldsErrorMessages();
+      dispatch({
+        type: ZFORM_ERROR,
+        payload: {
+          message: "Form has error",
+          errorMessages: errorMessages
+        }
+      });
+    } else {
+      let visibleFieldsData = zformEntitiy.getVisibleFieldsData();
+      dispatch({
+        type: ZFORM_SUBMIT_SUCCESS,
+        payload: {
+          formData: visibleFieldsData
+        }
+      });
+    }
+  }
+
+}
+
+export default ValidateErrorMessageUseCase;

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

@@ -0,0 +1,56 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { VALIDATE_FIELD } from "../../../../bc/field-validation/Constants";
+import { ZFORM_VALIDATION_ERROR } from "../../../../bc/zform/Symbol";
+
+class ValidateFieldRequestUseCase extends AbstractUseCase {
+  execute(input) {
+    let {
+      fieldName,
+      dispatch
+    } = input;
+    let zformEntitiy = this.dependencies.repository.getFormEntity();
+    let fieldEntity = zformEntitiy.getFieldByApiName(fieldName);
+
+    if (fieldEntity) {
+      let field = fieldEntity.toObject();
+      dispatch({
+        type: VALIDATE_FIELD,
+        payload: {
+          field: { ...field,
+            required: field.isMandatory
+          },
+          value: field.value
+        }
+      });
+      zformEntitiy.executeValidateRuleOnField(fieldName, _ref => {
+        let {
+          validationRules,
+          formData
+        } = _ref;
+        const zform = zformEntitiy.toObject();
+        return this.dependencies.validator.validateAsync({
+          validationRules,
+          formData,
+          myForm: zform
+        }).then(res => {
+          if (res) {
+            dispatch({
+              type: ZFORM_VALIDATION_ERROR,
+              payload: res
+            });
+          }
+
+          return true; //hack ts error
+        });
+      }).finally(() => {
+        dispatch({
+          type: "ZFORM#VALIDATE_SUBMIT_FIELD_HAS_ERROR_MESSAGE",
+          payload: zformEntitiy.toObject()
+        });
+      });
+    }
+  }
+
+}
+
+export default ValidateFieldRequestUseCase;

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

@@ -1,5 +1,3 @@
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 export default class ZDependencyMapping {
   constructor(_ref) {
     let {
@@ -11,21 +9,6 @@ export default class ZDependencyMapping {
       parent,
       child
     } = _ref;
-
-    _defineProperty(this, "parentId", void 0);
-
-    _defineProperty(this, "childId", void 0);
-
-    _defineProperty(this, "mappings", void 0);
-
-    _defineProperty(this, "layoutId", void 0);
-
-    _defineProperty(this, "id", void 0);
-
-    _defineProperty(this, "parent", void 0);
-
-    _defineProperty(this, "child", void 0);
-
     this.parentId = parentId;
     this.childId = childId;
     this.mappings = mappings;

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

@@ -1,5 +1,3 @@
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 export default class ZField {
   constructor(_ref) {
     let {
@@ -25,57 +23,9 @@ export default class ZField {
       toolTipType,
       defaultValue,
       isPHI,
-      subType
+      subType,
+      lookup
     } = _ref;
-
-    _defineProperty(this, "displayLabel", void 0);
-
-    _defineProperty(this, "apiName", void 0);
-
-    _defineProperty(this, "isCustomField", void 0);
-
-    _defineProperty(this, "i18NLabel", void 0);
-
-    _defineProperty(this, "isSystemMandatory", void 0);
-
-    _defineProperty(this, "type", void 0);
-
-    _defineProperty(this, "isReadOnly", void 0);
-
-    _defineProperty(this, "name", void 0);
-
-    _defineProperty(this, "isEncryptedField", void 0);
-
-    _defineProperty(this, "id", void 0);
-
-    _defineProperty(this, "isRemovable", void 0);
-
-    _defineProperty(this, "maxLength", void 0);
-
-    _defineProperty(this, "isMandatory", void 0);
-
-    _defineProperty(this, "value", void 0);
-
-    _defineProperty(this, "errorMessage", void 0);
-
-    _defineProperty(this, "isVisible", void 0);
-
-    _defineProperty(this, "decimalPlaces", void 0);
-
-    _defineProperty(this, "pickListValues", void 0);
-
-    _defineProperty(this, "defaultPickListValues", void 0);
-
-    _defineProperty(this, "subType", void 0);
-
-    _defineProperty(this, "toolTip", void 0);
-
-    _defineProperty(this, "toolTipType", void 0);
-
-    _defineProperty(this, "defaultValue", void 0);
-
-    _defineProperty(this, "isPHI", void 0);
-
     this.displayLabel = displayLabel;
     this.apiName = apiName;
     this.isCustomField = isCustomField;
@@ -99,7 +49,8 @@ export default class ZField {
     this.toolTip = toolTip;
     this.toolTipType = toolTipType;
     this.defaultValue = defaultValue;
-    this.isPHI = isPHI; // if(value===undefined){
+    this.isPHI = isPHI;
+    this.lookup = lookup; // if(value===undefined){
     //     this.setDefaultValue()
     // }
   }
@@ -109,8 +60,8 @@ export default class ZField {
       return false;
     }
 
-    if (typeof defaultValue === "string") {
-      return defaultValue === "true" ? true : false;
+    if (typeof defaultValue === 'string') {
+      return defaultValue === 'true' ? true : false;
     }
 
     return defaultValue;
@@ -121,8 +72,8 @@ export default class ZField {
       return [];
     }
 
-    if (typeof defaultValue === "string") {
-      return defaultValue.split(";");
+    if (typeof defaultValue === 'string') {
+      return defaultValue.split(';');
     }
 
     return defaultValue;
@@ -157,7 +108,7 @@ export default class ZField {
 
   setValue(value) {
     if (this.value !== value) {
-      this.errorMessage = ""; // Reset error message when value changes
+      this.errorMessage = ''; // Reset error message when value changes
     }
 
     this.value = value;
@@ -167,6 +118,10 @@ export default class ZField {
     return this.value;
   }
 
+  getDefaultValue() {
+    return this.defaultValue;
+  }
+
   getErrorMessage() {
     return this.errorMessage;
   }
@@ -188,6 +143,7 @@ export default class ZField {
     this.defaultPickListValues = fieldProperties.defaultPickListValues !== undefined ? fieldProperties.defaultPickListValues : this.defaultPickListValues;
     this.toolTip = fieldProperties.toolTip !== undefined ? fieldProperties.toolTip : this.toolTip;
     this.decimalPlaces = fieldProperties.decimalPlaces !== undefined ? fieldProperties.decimalPlaces : this.decimalPlaces;
+    this.lookup = fieldProperties.lookup !== undefined ? fieldProperties.lookup : this.lookup;
   }
 
   setErrorMessage(errorMessage) {
@@ -241,7 +197,8 @@ export default class ZField {
       toolTipType: this.toolTipType,
       defaultValue: this.defaultValue,
       isPHI: this.isPHI,
-      subType: this.subType
+      subType: this.subType,
+      lookup: this.lookup
     };
   }