@zohodesk/library-platform 1.1.9 → 1.1.10-exp.2

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,108 @@ 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"
+        isDisabled: '{{@context.isSubmitFetching}}',
+        status: isSubmit ? '{{@context.submitStatus}}' : 'none',
+        text: text ? 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/ApiFailureInputModel.js

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

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

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

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

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

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/usecases/ApiFailureUseCase.js

@@ -0,0 +1,30 @@
+import { ACA_ERROR_OCCURRED } from "../../../../cc/component/ErrorStructure";
+import AbstractUseCase from "./AbstractUseCase";
+
+class ApiFailureUseCase extends AbstractUseCase {
+  execute(params) {
+    const {
+      error,
+      metaData,
+      dispatch
+    } = params;
+    const {
+      actionName
+    } = metaData;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    const isBreaking = zFormEntity.stopLoadingAndDecideIsBreaking(actionName);
+    const errorStructure = zFormEntity.constructApiErrorEvent(error, actionName, isBreaking);
+    presenter.updateFormResponse(zFormEntity.toObject());
+    dispatch({
+      type: ACA_ERROR_OCCURRED,
+      payload: errorStructure
+    });
+  }
+
+}
+
+export default ApiFailureUseCase;

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

@@ -0,0 +1,25 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { ZFORM_SUBMIT_FAILURE } from "../../../../bc/zform/Symbol";
+
+class CreateRecordFailedUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      dispatch,
+      payload
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    zFormEntity.setSubmitFetching(false);
+    presenter.updateFormResponse(zFormEntity.toObject());
+    dispatch({
+      type: ZFORM_SUBMIT_FAILURE,
+      payload: payload
+    });
+  }
+
+}
+
+export default CreateRecordFailedUseCase;

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

@@ -0,0 +1,25 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { ZFORM_SUBMIT_SUCCESS } from "../../../../bc/zform/Symbol";
+
+class CreateRecordSuccessUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      dispatch,
+      payload
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const zFormEntity = repository.getFormEntity();
+    zFormEntity.setSubmitFetching(false);
+    presenter.updateFormResponse(zFormEntity.toObject());
+    dispatch({
+      type: ZFORM_SUBMIT_SUCCESS,
+      payload: payload
+    });
+  }
+
+}
+
+export default CreateRecordSuccessUseCase;

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

@@ -8,12 +8,15 @@ class FormSubmitUseCase extends AbstractUseCase {
     } = input;
     const {
       repository,
-      validator
+      validator,
+      presenter
     } = this.dependencies;
     const zFormEntity = repository.getFormEntity();
     const validationRules = zFormEntity.getValidateRules();
     const myForm = zFormEntity.toObject();
     const formData = zFormEntity.getFormData();
+    zFormEntity.setSubmitFetching(true);
+    presenter.updateFormResponse(zFormEntity.toObject());
     validator.validateAsync({
       validationRules,
       formData,

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

@@ -1,53 +1,81 @@
 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 { ZFORM_API_FAILURE, 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";
 
 class InitializeUseCase extends AbstractUseCase {
   execute(input) {
     let {
-      dispatch
+      dispatch,
+      disableGetClientActions
     } = input;
     const zformEntity = this.dependencies.repository.getFormEntity();
     const context = zformEntity.getContext();
+
+    if (!disableGetClientActions) {
+      dispatch({
+        type: CLIENTACTION_BEHAVIOUR_EXECUTE,
+        payload: {
+          actionName: 'getClientActions',
+          props: {
+            modules: 'static_module',
+            components: 'smart_form',
+            limit: '1',
+            from: '12',
+            servicePrefix: 'supportapi/zd',
+            orgName: 'my_org'
+          },
+          apiName: 'clientActions'
+        }
+      });
+      dispatch({
+        type: CLIENTSCRIPT_FETCH,
+        payload: {
+          actionName: 'getClientScripts',
+          props: {
+            modules: 'static_module',
+            components: 'smart_form',
+            limit: '1',
+            from: '12',
+            servicePrefix: 'supportapi/zd',
+            orgName: 'my_org'
+          },
+          apiName: 'clientScripts'
+        }
+      });
+    }
+
     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,
+      type: DATA_SOURCE_EXECUTE,
       payload: {
-        actionName: "fetchMyLayouts",
+        actionName: ZFormApiActionName.getMyLayouts,
         props: { ...context,
           from: 1,
           limit: 50
         }
       },
       metaData: {
-        actionName: "fetchMyLayouts",
+        actionName: ZFormApiActionName.getMyLayouts,
         //hack
-        [DATA_BROKER_NO_CONTENT]: {
+        [DATA_SOURCE_NO_CONTENT]: {
           type: ZFORM_MY_LAYOUTS_SUCCESS,
           metaData: {
-            actionName: "fetchMyLayouts"
+            actionName: ZFormApiActionName.getMyLayouts
+          }
+        },
+        [DATA_SOURCE_FAILURE]: {
+          type: ZFORM_API_FAILURE,
+          metaData: {
+            actionName: ZFormApiActionName.getMyLayouts
           }
         },
-        [DATA_BROKER_SUCCESS]: {
+        [DATA_SOURCE_SUCCESS]: {
           type: ZFORM_MY_LAYOUTS_SUCCESS,
           metaData: {
-            actionName: "fetchMyLayouts"
+            actionName: ZFormApiActionName.getMyLayouts
           }
         }
       }

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_API_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,18 +58,51 @@ 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({
         type: DATA_SOURCE_EXECUTE,
         payload: {
-          actionName: 'fetchValidationRules',
+          actionName: 'getValidationRules',
           props: { ...context,
             activeRulesOnly: true
           }
         },
         metaData: {
-          actionName: 'fetchValidationRules',
+          actionName: 'getValidationRules',
           //hack
           transformerArg: {
             fields: zFormEntity.getAllFields().map(f => f.toObject())
@@ -76,19 +110,19 @@ class MyFormSuccessUseCase extends AbstractUseCase {
           [DATA_SOURCE_NO_CONTENT]: {
             type: ZFORM_VALIDATION_RULES_SUCCESS,
             metaData: {
-              actionName: 'fetchValidationRules'
+              actionName: 'getValidationRules'
             }
           },
           [DATA_SOURCE_FAILURE]: {
-            type: ZFORM_VALIDATION_RULES_FAILURE,
+            type: ZFORM_API_FAILURE,
             metaData: {
-              actionName: 'fetchValidationRules'
+              actionName: 'getValidationRules'
             }
           },
           [DATA_SOURCE_SUCCESS]: {
             type: ZFORM_VALIDATION_RULES_SUCCESS,
             metaData: {
-              actionName: 'fetchValidationRules'
+              actionName: 'getValidationRules'
             }
           }
         }