@zohodesk/library-platform 1.1.8 → 1.1.9

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

@@ -2,28 +2,25 @@ const URLFieldTranslator = _ref => {
   let {
     field,
     type,
-    ePHIFields
+    fieldPreModified,
+    uiConfig
   } = _ref;
   const fieldModified = {
     type,
+    uiConfig,
     value: field.value || '',
     //state.behaviours.zform.values[field.apiName],
     name: field.apiName,
+    ...fieldPreModified,
     id: field.id,
     label: field.i18NLabel,
-    // toolTip: field.tooltip || '',
-    // toolTipType: field.toolTipType || '',
-    // placeholder: field.toolTip || '',
-    placeholder: field.toolTipType === "placeholder" ? field.toolTip : "",
+    // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
     readonly: field.isReadOnly,
     // visibility: field.isVisible,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''
-  }; // if (ePHIFields[field.type]) {
-  //     fieldModified.ePHI = true;
-  // }
-
+  };
   return fieldModified;
 };
 

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

@@ -1,3 +1,30 @@
+export default function DefaultFormClientActions(props) {
+  const {
+    submitConfig,
+    cancelConfig,
+    clientActions = []
+  } = props;
+  const finalClientActions = [];
+
+  if (submitConfig !== null && submitConfig !== void 0 && submitConfig.isEnabled) {
+    finalClientActions.push(getDefaultFormAction({
+      type: "submit",
+      ...submitConfig
+    }));
+  }
+
+  if (cancelConfig !== null && cancelConfig !== void 0 && cancelConfig.isEnabled) {
+    finalClientActions.push(getDefaultFormAction({
+      type: "cancel",
+      ...cancelConfig
+    }));
+  }
+
+  finalClientActions.push(getDefaultFieldInfoAction());
+  finalClientActions.push(getDefaultFieldEphiAction());
+  return [...finalClientActions, ...clientActions];
+}
+
 function getDefaultFormAction(_ref) {
   let {
     type,
@@ -33,27 +60,70 @@ function getDefaultFormAction(_ref) {
   };
 }
 
-export default function DefaultFormClientActions(props) {
-  const {
-    submitConfig,
-    cancelConfig,
-    clientActions = []
-  } = props;
-  const finalClientActions = [];
-
-  if (submitConfig !== null && submitConfig !== void 0 && submitConfig.isEnabled) {
-    finalClientActions.push(getDefaultFormAction({
-      type: "submit",
-      ...submitConfig
-    }));
-  }
-
-  if (cancelConfig !== null && cancelConfig !== void 0 && cancelConfig.isEnabled) {
-    finalClientActions.push(getDefaultFormAction({
-      type: "cancel",
-      ...cancelConfig
-    }));
-  }
+function getDefaultFieldInfoAction() {
+  return {
+    "uiComponentMapping": {
+      "component": "ActionIcon",
+      "name": "Info Icon",
+      "id": "4000000081003",
+      "propertiesValueMapping": {
+        "hoverVariant": "primary",
+        "icon": "ZD-information",
+        "label": "Default Info Icon"
+      },
+      "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"]
+      }],
+      "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"]
+  };
+}
 
-  return [...finalClientActions, ...clientActions];
+function getDefaultFieldEphiAction() {
+  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."
+      },
+      "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"]
+      }],
+      "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"]
+  };
 }

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

@@ -7,9 +7,11 @@ class AbstractUseCase {
   updateDependency(state, updateState) {
     const {
       repository,
-      presenter
+      presenter,
+      validator
     } = this.dependencies;
     repository.init(state);
+    validator.init(state);
     presenter.updateDependencies(state, updateState);
   }
 

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

@@ -0,0 +1,39 @@
+import { ValidationEvents } from "../../domain/interfaces/IZForm";
+import AbstractUseCase from "./AbstractUseCase";
+import { ZFORM_FIELD_BLURRED, ZFORM_VALIDATE_FIELD_REQUEST } from "../../../../bc/zform/Symbol";
+
+class FieldBlurUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      fieldName,
+      dispatch
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    const sectionId = zFormEntity.getSectionId({
+      fieldName
+    });
+    zFormEntity.setFocusedFieldName('');
+    presenter.updateFormResponse(zFormEntity.toObject());
+    dispatch({
+      type: ZFORM_VALIDATE_FIELD_REQUEST,
+      payload: {
+        fieldName,
+        eventName: ValidationEvents.blur
+      }
+    });
+    dispatch({
+      type: ZFORM_FIELD_BLURRED,
+      payload: {
+        sectionId,
+        fieldName
+      }
+    });
+  }
+
+}
+
+export default FieldBlurUseCase;

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

@@ -3,17 +3,19 @@ import { ZFORM_FIELD_VALUE_CHANGED } from "../../../../bc/zform/Symbol";
 
 class FieldValueChangeRequestUseCase extends AbstractUseCase {
   execute(input) {
-    let {
+    const {
       sectionId,
       fieldName,
       newValue,
       dispatch
     } = input;
-    let {
+    const {
+      repository,
+      presenter,
       layoutRuleApplier
     } = this.dependencies;
-    let zformEntitiy = this.dependencies.repository.getFormEntity();
-    zformEntitiy.setFieldValue(fieldName, newValue, _ref => {
+    const zFormEntity = repository.getFormEntity();
+    zFormEntity.setFieldValue(fieldName, newValue, _ref => {
       let {
         layoutRules,
         formData
@@ -21,17 +23,11 @@ class FieldValueChangeRequestUseCase extends AbstractUseCase {
       return layoutRuleApplier.applyRules({
         layoutRules,
         formData,
-        myForm: zformEntitiy.toObject()
+        myForm: zFormEntity.toObject()
       });
     });
-    let zform = zformEntitiy.toObject(); // let {fieldResult,sectionResult}=this.dependencies.layoutRuleApplier.applyRules({
-    //   layoutRules,
-    //   formData:zformEntitiy.getFormData(),
-    //   myForm:zform});
-    // zformEntitiy.applyLayoutRulesResult(sectionResult,fieldResult)
-    // zform=zformEntitiy.toObject();
-
-    this.dependencies.presenter.updateFormResponse(zform);
+    const zForm = zFormEntity.toObject();
+    presenter.updateFormResponse(zForm);
     dispatch({
       type: ZFORM_FIELD_VALUE_CHANGED,
       payload: {

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

@@ -0,0 +1,19 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class FocusFieldUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      fieldName
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    zFormEntity.setFocusedFieldName(fieldName);
+    presenter.updateFormResponse(zFormEntity.toObject());
+  }
+
+}
+
+export default FocusFieldUseCase;

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

@@ -1,51 +1,32 @@
 import AbstractUseCase from "./AbstractUseCase";
-import { ZFORM_VALIDATION_ERROR } from "../../../../bc/zform/Symbol";
-import { VALIDATE_FIELDS } from "../../../../bc/field-validation/Constants";
+import { ZFORM_SUBMIT_VALIDATION_COMPLETED, ZFORM_VALIDATION_RULES_EXECUTION_RESULT } from "../../../../bc/zform/Symbol";
 
 class FormSubmitUseCase extends AbstractUseCase {
   execute(input) {
     const {
       dispatch
     } = input;
-    const zformEntitiy = this.dependencies.repository.getFormEntity();
-    const fieldEntities = zformEntitiy.getAllFields();
-    const fields = fieldEntities.map(fieldEntity => {
-      let field = fieldEntity.toObject();
-      return { ...field,
-        required: field.isMandatory,
-        value: field.value
-      };
-    });
-    dispatch({
-      type: VALIDATE_FIELDS,
-      payload: {
-        fields
-      }
-    });
-    zformEntitiy.executeValidateRule(_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
+    const {
+      repository,
+      validator
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    const validationRules = zFormEntity.getValidateRules();
+    const myForm = zFormEntity.toObject();
+    const formData = zFormEntity.getFormData();
+    validator.validateAsync({
+      validationRules,
+      formData,
+      myForm
+    }).then(res => {
+      dispatch({
+        type: ZFORM_VALIDATION_RULES_EXECUTION_RESULT,
+        payload: res
       });
     }).finally(() => {
       dispatch({
-        type: "ZFORM#VALIDATE_SUBMIT_FIELD_HAS_ERROR_MESSAGE",
-        payload: zformEntitiy.toObject()
+        type: ZFORM_SUBMIT_VALIDATION_COMPLETED,
+        payload: {}
       });
     });
   }

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

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetFieldErrorMessageUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      fieldName,
+      callback
+    } = input;
+    const zFormEntity = this.dependencies.repository.getFormEntity();
+    const errorMessage = zFormEntity.getFieldErrorMessage(fieldName);
+    callback(errorMessage);
+  }
+
+}
+
+export default GetFieldErrorMessageUseCase;

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

@@ -0,0 +1,22 @@
+import ZValidationRule from "../../domain/ZValidationRule";
+import AbstractUseCase from "./AbstractUseCase";
+
+class InsertValidationRuleUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      index,
+      validationRule
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    const validationRuleEntity = new ZValidationRule(validationRule);
+    zFormEntity.insertValidationRuleAtPosition(validationRuleEntity, index);
+    presenter.updateFormResponse(zFormEntity.toObject());
+  }
+
+}
+
+export default InsertValidationRuleUseCase;

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

@@ -1,31 +1,42 @@
 import AbstractUseCase from "./AbstractUseCase";
 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";
 
 class MyFormSuccessUseCase extends AbstractUseCase {
   execute(input) {
-    let {
+    const {
       dispatch,
-      myForm
+      myForm,
+      disableValidationRule
     } = input;
-    let {
+    const {
+      repository,
+      presenter,
+      layoutRuleApplier
+    } = this.dependencies;
+    const {
       sections
     } = myForm;
-    let zformEntitiy = this.dependencies.repository.getFormEntity();
-    let layoutRuleApplier = this.dependencies.layoutRuleApplier;
-    let sectionEntities = sections.map(section => {
-      let fields = section.fields.map(field => {
+    const zFormEntity = repository.getFormEntity();
+    const context = { ...zFormEntity.getContext(),
+      layoutId: zFormEntity.getLayoutId()
+    };
+    const sectionEntities = sections.map(section => {
+      const fields = section.fields.map(field => {
         const entity = new ZField(field);
         entity.decideDefaultValue();
         return entity;
       });
-      let sectionWithFields = { ...section,
+      const sectionWithFields = { ...section,
         fields
       };
       return new ZSection(sectionWithFields);
     });
-    zformEntitiy.setSections(sectionEntities);
-    zformEntitiy.setFormProperties({
+    zFormEntity.setSections(sectionEntities);
+    zFormEntity.setFormProperties({
       modifiedTime: myForm.modifiedTime,
       isStandardLayout: myForm.isStandardLayout,
       hasLogo: myForm.hasLogo,
@@ -42,11 +53,50 @@ class MyFormSuccessUseCase extends AbstractUseCase {
       return layoutRuleApplier.applyRules({
         layoutRules,
         formData,
-        myForm: zformEntitiy.toObject()
+        myForm: zFormEntity.toObject()
       });
     });
-    let zform = zformEntitiy.toObject();
-    this.dependencies.presenter.updateFormResponse(zform);
+
+    if (!disableValidationRule) {
+      presenter.updateFormResponse(zFormEntity.toObject());
+      dispatch({
+        type: DATA_SOURCE_EXECUTE,
+        payload: {
+          actionName: 'fetchValidationRules',
+          props: { ...context,
+            activeRulesOnly: true
+          }
+        },
+        metaData: {
+          actionName: 'fetchValidationRules',
+          //hack
+          transformerArg: {
+            fields: zFormEntity.getAllFields().map(f => f.toObject())
+          },
+          [DATA_SOURCE_NO_CONTENT]: {
+            type: ZFORM_VALIDATION_RULES_SUCCESS,
+            metaData: {
+              actionName: 'fetchValidationRules'
+            }
+          },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_VALIDATION_RULES_FAILURE,
+            metaData: {
+              actionName: 'fetchValidationRules'
+            }
+          },
+          [DATA_SOURCE_SUCCESS]: {
+            type: ZFORM_VALIDATION_RULES_SUCCESS,
+            metaData: {
+              actionName: 'fetchValidationRules'
+            }
+          }
+        }
+      });
+    } else {
+      zFormEntity.setValidationRulesFetching(false);
+      presenter.updateFormResponse(zFormEntity.toObject());
+    }
   }
 
 }

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

@@ -1,5 +1,5 @@
 import AbstractUseCase from "./AbstractUseCase";
-import { ZFORM_DEPENDENCY_MAPPINGS_SUCCESS, ZFORM_LAYOUT_RULES_SUCCESS, ZFORM_MY_FORM_SUCCESS, ZFORM_VALIDATION_RULES_SUCCESS } from "../../../../bc/zform/Symbol";
+import { 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 as DATA_BROKER_SUCCESS, DATA_SOURCE_NO_CONTENT as DATA_BROKER_NO_CONTENT } from "../../../../bc/zdata-source/Symbols";
 
@@ -17,8 +17,9 @@ 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);
     const context = { ...zformEntity.getContext(),
-      layoutId: layoutObject === null || layoutObject === void 0 ? void 0 : layoutObject.id
+      layoutId: zformEntity.getLayoutId()
     };
     dispatch({
       type: DATA_BROKER_EXECUTE,
@@ -68,36 +69,6 @@ class MyLayoutSuccessUseCase extends AbstractUseCase {
       }
     });
 
-    if (!disableValidationRule) {
-      dispatch({
-        type: DATA_BROKER_EXECUTE,
-        payload: {
-          actionName: "fetchValidationRules",
-          props: { ...context,
-            activeRulesOnly: true
-          }
-        },
-        metaData: {
-          actionName: "fetchDependencyMappings",
-          //hack
-          [DATA_BROKER_NO_CONTENT]: {
-            type: ZFORM_VALIDATION_RULES_SUCCESS,
-            metaData: {
-              actionName: "fetchValidationRules"
-            }
-          },
-          [DATA_BROKER_SUCCESS]: {
-            type: ZFORM_VALIDATION_RULES_SUCCESS,
-            metaData: {
-              actionName: "fetchValidationRules"
-            }
-          }
-        }
-      });
-    } else {
-      zformEntity.setValidationRulesFetching(false);
-    }
-
     if (!disableLayoutRule) {
       dispatch({
         type: DATA_BROKER_EXECUTE,
@@ -108,7 +79,7 @@ class MyLayoutSuccessUseCase extends AbstractUseCase {
           }
         },
         metaData: {
-          actionName: "fetchDependencyMappings",
+          actionName: "fetchLayoutRules",
           //hack
           [DATA_BROKER_NO_CONTENT]: {
             type: ZFORM_LAYOUT_RULES_SUCCESS,

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

@@ -6,10 +6,10 @@ class SetFieldErrorMessageUseCase extends AbstractUseCase {
       fieldApiName,
       errorMessage
     } = input;
-    const zformEntity = this.dependencies.repository.getFormEntity();
-    zformEntity.setFieldErrorMessage(fieldApiName, errorMessage);
-    const zform = zformEntity.toObject();
-    this.dependencies.presenter.updateFormResponse(zform);
+    const zFormEntity = this.dependencies.repository.getFormEntity();
+    zFormEntity.setFieldErrorMessage(fieldApiName, errorMessage);
+    const zForm = zFormEntity.toObject();
+    this.dependencies.presenter.updateFormResponse(zForm);
   }
 
 }

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

@@ -3,33 +3,16 @@ import { ZFORM_FIELD_VALUE_CHANGE_REQUEST } from "../../../../bc/zform/Symbol";
 
 class SetFieldValueUseCase extends AbstractUseCase {
   execute(input) {
-    let {
+    const {
       fieldName,
       newValue,
       dispatch
-    } = input; // let { layoutRuleApplier } = this.dependencies
-
-    let zformEntitiy = this.dependencies.repository.getFormEntity(); // zformEntitiy.setFieldValue(fieldName, newValue, ({ layoutRules, formData }) => {
-    //   return layoutRuleApplier.applyRules({
-    //     layoutRules,
-    //     formData,
-    //     myForm: zformEntitiy.toObject()
-    //   })
-    // });
-    // let zform = zformEntitiy.toObject();
-    // // let { fieldResult, sectionResult } = this.dependencies.layoutRuleApplier.applyRules({
-    // //   layoutRules,
-    // //   formData: zformEntitiy.getFormData(),
-    // //   myForm: zform
-    // // });
-    // // zformEntitiy.applyLayoutRulesResult(sectionResult, fieldResult)
-    // // zform = zformEntitiy.toObject();
-    // this.dependencies.presenter.updateFormResponse(zform);
-
+    } = input;
+    const zFormEntity = this.dependencies.repository.getFormEntity();
     dispatch({
       type: ZFORM_FIELD_VALUE_CHANGE_REQUEST,
       payload: {
-        sectionId: zformEntitiy.getSectionId({
+        sectionId: zFormEntity.getSectionId({
           fieldName
         }),
         fieldName,

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

@@ -3,39 +3,17 @@ import { ZFORM_FIELD_VALUE_CHANGE_REQUEST } from "../../../../bc/zform/Symbol";
 
 class SetFieldsValuesUseCase extends AbstractUseCase {
   execute(input) {
-    let {
+    const {
       fieldsValuesObj,
       dispatch
-    } = input; // let { layoutRuleApplier } = this.dependencies
-
-    let zformEntitiy = this.dependencies.repository.getFormEntity(); // zformEntitiy.setFieldValue(fieldName, newValue, ({ layoutRules, formData }) => {
-    //   return layoutRuleApplier.applyRules({
-    //     layoutRules,
-    //     formData,
-    //     myForm: zformEntitiy.toObject()
-    //   })
-    // });
-    // let zform = zformEntitiy.toObject();
-    // // let { fieldResult, sectionResult } = this.dependencies.layoutRuleApplier.applyRules({
-    // //   layoutRules,
-    // //   formData: zformEntitiy.getFormData(),
-    // //   myForm: zform
-    // // });
-    // // zformEntitiy.applyLayoutRulesResult(sectionResult, fieldResult)
-    // // zform = zformEntitiy.toObject();
-    // this.dependencies.presenter.updateFormResponse(zform);
-    // dispatch({
-    //   type: ZFORM_FIELD_VALUE_CHANGE_REQUEST,
-    //   payload: { sectionId: zformEntitiy.getSectionId(sectionName), fieldName: '', value: "" },
-    //   metaData: {}
-    // });
-
+    } = input;
+    const zFormEntity = this.dependencies.repository.getFormEntity();
     Object.entries(fieldsValuesObj).forEach(_ref => {
       let [fieldName, value] = _ref;
       dispatch({
         type: ZFORM_FIELD_VALUE_CHANGE_REQUEST,
         payload: {
-          sectionId: zformEntitiy.getSectionId({
+          sectionId: zFormEntity.getSectionId({
             fieldName
           }),
           fieldName,