@zohodesk/library-platform 1.1.7 → 1.1.8-alpha.1

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

@@ -2,28 +2,25 @@ const PercentageFieldTranslator = _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/translators/fields/PhoneFieldTranslator.js

@@ -2,27 +2,24 @@ const PhoneFieldTranslator = _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,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''
-  }; // if (ePHIFields[field.type]) {
-  //     fieldModified.ePHI = true;
-  // }
-
+  };
   return fieldModified;
 };
 

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

@@ -1,9 +1,11 @@
 const PickListFieldTranslator = _ref => {
   let {
     field,
-    type
+    type,
+    uiConfig,
+    fieldPreModified
   } = _ref;
-  return {
+  const fieldModified = { ...fieldPreModified,
     id: field.id,
     label: field.i18NLabel,
     options: field.pickListValues.map(picklistValue => {
@@ -13,17 +15,18 @@ const PickListFieldTranslator = _ref => {
       };
     }),
     type,
+    uiConfig,
     subType: field.subType.toLowerCase(),
     value: field.value,
     //state.behaviours.zform.values[field.apiName],
     name: field.apiName,
-    // placeholder: field.i18NLabel,//field.placeholder,
     required: field.isMandatory,
     readonly: field.isReadOnly,
     // visibility: field.isVisible,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''
   };
+  return fieldModified;
 };
 
 export default PickListFieldTranslator;

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

@@ -2,28 +2,24 @@ const TextAreaFieldTranslator = _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 : "",
     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/translators/fields/TextFieldTranslator.js

@@ -1,27 +1,27 @@
 const TextFieldTranslator = _ref => {
   let {
+    field,
     type,
-    field
+    fieldPreModified,
+    uiConfig
   } = _ref;
-  return {
+  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: false,
-    //field.ePHI,
+    // ePHI: field.isPHI, //field.ePHI,
     required: field.isMandatory,
     readonly: field.isReadOnly,
     // visibility: field.isVisible,
     isVisible: field.isVisible,
     errorMessage: field.errorMessage || ''
   };
+  return fieldModified;
 };
 
 export default TextFieldTranslator;

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

@@ -0,0 +1,130 @@
+import { i18NProviderUtils } from '@zohodesk/i18n';
+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,
+    text,
+    isEnabled
+  } = _ref;
+  const isSubmit = type === 'submit';
+  return {
+    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',
+      propertiesValueMapping: {
+        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',
+        payloadValueMapping: {}
+      }]
+    },
+    modules: ['static_module'],
+    conditions: {
+      fields: [],
+      pattern: ''
+    }
+  };
+}
+
+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']
+  };
+}
+
+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/InitializeUseCase.js

@@ -2,6 +2,7 @@ import AbstractUseCase from "./AbstractUseCase";
 import { ZFORM_MY_LAYOUTS_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";
+import { CLIENTACTION_BEHAVIOUR_EXECUTE } from "../../../client-actions/bc/zclient-actions/Constants";
 
 class InitializeUseCase extends AbstractUseCase {
   execute(input) {
@@ -10,6 +11,21 @@ class InitializeUseCase extends AbstractUseCase {
     } = input;
     const zformEntity = this.dependencies.repository.getFormEntity();
     const context = zformEntity.getContext();
+    dispatch({
+      type: CLIENTACTION_BEHAVIOUR_EXECUTE,
+      payload: {
+        actionName: 'getClientActions',
+        props: {
+          moduleName: 'static_module',
+          component: 'smart_form',
+          limit: '1',
+          from: '12',
+          servicePrefix: 'zform',
+          orgName: 'orgName'
+        },
+        apiName: 'clientActions'
+      }
+    });
     dispatch({
       type: DATA_BROKER_EXECUTE,
       payload: {

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/LookupFieldSuccessUseCase.js

@@ -0,0 +1,40 @@
+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; }
+
+import AbstractUseCase from "./AbstractUseCase";
+
+class LookUpFieldSuccessUseCase extends AbstractUseCase {
+  constructor() {
+    super(...arguments);
+
+    _defineProperty(this, "getSelectedFieldLookup", (currentData, LookupField) => currentData.apiName === LookupField);
+  }
+
+  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);
+  }
+
+}
+
+function hasMatchingApiName(listA, listB) {
+  const apiNamesB = new Set(listB.map(item => item.apiName));
+  return listA.some(item => apiNamesB.has(item.apiName));
+}
+
+export default LookUpFieldSuccessUseCase;