@zohodesk/library-platform 1.1.10 → 1.1.11

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

@@ -1,15 +1,32 @@
+import ClientActionsTranslator from "../../../../../client-actions/translators/client-actions-translator";
+
 const PickListFieldTranslator = _ref => {
   let {
     field,
     type,
     uiConfig,
-    fieldPreModified
+    fieldPreModified,
+    fieldOptionActions,
+    instanceName,
+    moduleName
   } = _ref;
   const fieldModified = { ...fieldPreModified,
     id: field.id,
     label: field.i18NLabel,
     options: field.pickListValues.map(picklistValue => {
+      const optionActions = {};
+      Object.entries(fieldOptionActions).forEach(_ref2 => {
+        let [key, value] = _ref2;
+        const {
+          value: _omit,
+          ...fieldWithoutValue
+        } = field;
+        optionActions[key] = ClientActionsTranslator.transform(value, instanceName, moduleName, { ...picklistValue,
+          ...fieldWithoutValue
+        });
+      });
       return {
+        optionActions: optionActions.fieldOptionRightActions,
         value: picklistValue.value,
         label: picklistValue.value
       };

package/es/platform/zform/adapters/presenter/translators/interfaces/ClientActions.js

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

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

@@ -43,7 +43,9 @@ function getDefaultFormAction(_ref) {
       name: isSubmit ? 'Submit Button' : 'Cancel Button',
       component: 'Button',
       propertiesValueMapping: {
-        text: isSubmit ? i18NProviderUtils.getI18NValue('crm.button.submit') : i18NProviderUtils.getI18NValue('support.label.cancel'),
+        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: [{

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/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/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/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, ZFORM_LOOKUP_FIELD_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) {
@@ -96,13 +96,13 @@ class MyFormSuccessUseCase extends AbstractUseCase {
       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())
@@ -110,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'
             }
           }
         }

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

@@ -1,20 +1,21 @@
 import AbstractUseCase from "./AbstractUseCase";
-import { ZFORM_DEPENDENCY_MAPPINGS_SUCCESS, ZFORM_LAYOUT_RULES_SUCCESS, ZFORM_MY_FORM_SUCCESS } from "../../../../bc/zform/Symbol";
+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 as DATA_BROKER_SUCCESS, DATA_SOURCE_NO_CONTENT as DATA_BROKER_NO_CONTENT } from "../../../../bc/zdata-source/Symbols";
+import { DATA_SOURCE_SUCCESS, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../../bc/zdata-source/Symbols";
 
 class MyLayoutSuccessUseCase extends AbstractUseCase {
   execute(input) {
     const {
       disableValidationRule,
-      disableLayoutRule
+      disableLayoutRule,
+      disableDependencyMapping
     } = input;
     let {
       dispatch,
       layouts,
       orgName
     } = input;
-    let layoutObject = layouts.find(layout => layout.isDefaultLayout == true); // dispatch({type:ZFORM_MY_FORM_REQUEST,payload:{isFetching:true}}) 
+    let layoutObject = layouts.length == 1 ? layouts[0] : layouts.find(layout => layout.isDefaultLayout == true); // dispatch({type:ZFORM_MY_FORM_REQUEST,payload:{isFetching:true}})
 
     const zformEntity = this.dependencies.repository.getFormEntity();
     zformEntity.setLayoutId(layoutObject?.id);
@@ -24,73 +25,96 @@ class MyLayoutSuccessUseCase extends AbstractUseCase {
     dispatch({
       type: DATA_BROKER_EXECUTE,
       payload: {
-        actionName: "fetchMyForm",
+        actionName: "getMyForm",
         props: context
       },
       metaData: {
-        actionName: "fetchMyForm",
+        actionName: "getMyForm",
         //hack
-        [DATA_BROKER_NO_CONTENT]: {
+        [DATA_SOURCE_NO_CONTENT]: {
           type: ZFORM_MY_FORM_SUCCESS,
           metaData: {
-            actionName: "fetchMyForm"
+            actionName: "getMyForm"
           }
         },
         //hack
-        [DATA_BROKER_SUCCESS]: {
+        [DATA_SOURCE_FAILURE]: {
+          type: ZFORM_API_FAILURE,
+          metaData: {
+            actionName: 'getMyForm'
+          }
+        },
+        [DATA_SOURCE_SUCCESS]: {
           type: ZFORM_MY_FORM_SUCCESS,
           metaData: {
-            actionName: "fetchMyForm"
+            actionName: "getMyForm"
           }
         }
       }
     });
-    dispatch({
-      type: DATA_BROKER_EXECUTE,
-      payload: {
-        actionName: "fetchDependencyMappings",
-        props: context
-      },
-      metaData: {
-        actionName: "fetchDependencyMappings",
-        //hack
-        [DATA_BROKER_SUCCESS]: {
-          type: ZFORM_DEPENDENCY_MAPPINGS_SUCCESS,
-          metaData: {
-            actionName: "fetchDependencyMappings"
-          }
+
+    if (!disableDependencyMapping) {
+      dispatch({
+        type: DATA_BROKER_EXECUTE,
+        payload: {
+          actionName: "getDependencyMappings",
+          props: context
         },
-        [DATA_BROKER_NO_CONTENT]: {
-          type: ZFORM_DEPENDENCY_MAPPINGS_SUCCESS,
-          metaData: {
-            actionName: "fetchDependencyMappings"
+        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: "fetchLayoutRules",
+          actionName: "getLayoutRules",
           props: { ...context,
             activeRulesOnly: true
           }
         },
         metaData: {
-          actionName: "fetchLayoutRules",
+          actionName: "getLayoutRules",
           //hack
-          [DATA_BROKER_NO_CONTENT]: {
+          [DATA_SOURCE_NO_CONTENT]: {
             type: ZFORM_LAYOUT_RULES_SUCCESS,
             metaData: {
-              actionName: "fetchLayoutRules"
+              actionName: "getLayoutRules"
+            }
+          },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'getLayoutRules'
             }
           },
-          [DATA_BROKER_SUCCESS]: {
+          [DATA_SOURCE_SUCCESS]: {
             type: ZFORM_LAYOUT_RULES_SUCCESS,
             metaData: {
-              actionName: "fetchLayoutRules"
+              actionName: "getLayoutRules"
             }
           }
         }

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

@@ -5,7 +5,8 @@ import { ZFORM_ERROR, ZFORM_VALIDATION_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE
 class SubmitValidationCompletedUseCase extends AbstractUseCase {
   execute(params) {
     const {
-      dispatch
+      dispatch,
+      disableCreateRecord
     } = params;
     const {
       repository,
@@ -23,6 +24,8 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
 
     if (isFormHasError) {
       const errorMessages = zFormEntity.getVisibleFieldsErrorMessages();
+      zFormEntity.setSubmitFetching(false);
+      presenter.updateFormResponse(zFormEntity.toObject());
       dispatch({
         type: ZFORM_SUBMIT_VALIDATION_FAILURE,
         payload: {
@@ -47,13 +50,16 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
           record
         }
       });
-      dispatch({
-        type: CREATE_RECORD,
-        payload: {
-          record,
-          moduleName
-        }
-      });
+
+      if (!disableCreateRecord) {
+        dispatch({
+          type: CREATE_RECORD,
+          payload: {
+            record,
+            moduleName
+          }
+        });
+      }
     }
   }
 

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

@@ -1,3 +1,6 @@
+import { ErrorCodes } from "../../../cc/component/ErrorStructure";
+import { ZFormApiActionName } from "../../../bc/zform/Constants";
+import { ZHttpErrorCode } from "../../../bc/zhttp/Errors";
 export default class ZForm {
   /*hack*/
 
@@ -23,6 +26,7 @@ export default class ZForm {
       isMyFormFetching,
       isDependencyFetching,
       isLayoutRulesFetching,
+      isSubmitFetching,
       isValidationRulesFetching
       /*hack end*/
 
@@ -47,6 +51,7 @@ export default class ZForm {
     this.isDependencyFetching = isDependencyFetching;
     this.isLayoutRulesFetching = isLayoutRulesFetching;
     this.isValidationRulesFetching = isValidationRulesFetching;
+    this.isSubmitFetching = isSubmitFetching;
     /*hack end*/
   }
 
@@ -124,6 +129,70 @@ export default class ZForm {
     this.isValidationRulesFetching = isValidationRulesFetching;
   }
 
+  setSubmitFetching(isSubmitFetching) {
+    this.isSubmitFetching = isSubmitFetching;
+  }
+
+  stopLoadingAndDecideIsBreaking(actionName) {
+    let isBreaking = false; // Set error state based on the failed action
+
+    switch (actionName) {
+      case ZFormApiActionName.getMyForm:
+        this.setMyFormFetching(false);
+        isBreaking = true;
+        break;
+
+      case ZFormApiActionName.getMyLayouts:
+        // this.setMyLayoutsFetching(false);
+        // isBreaking = true;
+        break;
+
+      case ZFormApiActionName.getValidationRules:
+        // isBreaking = true;
+        this.setValidationRulesFetching(false);
+        break;
+
+      case ZFormApiActionName.getLayoutRules:
+        // isBreaking = true;
+        this.setLayoutRulesFetching(false);
+        break;
+
+      case ZFormApiActionName.getDependencyMappings:
+        // isBreaking = true;
+        this.setDependencyFetching(false);
+        break;
+
+      default:
+        break;
+    }
+
+    return isBreaking;
+  }
+
+  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,
+      errorDetails: {
+        isBreaking,
+        originalError: error,
+        actionName
+      }
+    };
+  }
+
   getSectionId(_ref2) {
     let {
       fieldName,
@@ -342,8 +411,6 @@ export default class ZForm {
         formData: this.getFormData()
       });
       this.applyLayoutRulesResult(sectionResult, fieldResult);
-    } else {
-      console.log('Layout rules are fetching or my form is fetching');
     }
   }
 
@@ -365,7 +432,7 @@ export default class ZForm {
     let visited = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : new Set();
 
     if (visited.has(parentId)) {
-      console.warn(`Loop detected at field ${parentId}, skipping...`);
+      __DEVELOPMENT__ && console.warn(`Loop detected at field ${parentId}, skipping...`);
       return;
     }
 
@@ -377,7 +444,7 @@ export default class ZForm {
       let childField = fields.find(f => f.getId() === childId || f.getApiName() === childId);
 
       if (!childField) {
-        console.warn(`Child field not found for id/apiName: ${childId}`);
+        __DEVELOPMENT__ && console.warn(`Child field not found for id/apiName: ${childId}`);
         return;
       }
 
@@ -580,6 +647,7 @@ export default class ZForm {
       isMyFormFetching: this.isMyFormFetching,
       isDependencyFetching: this.isDependencyFetching,
       isLayoutRulesFetching: this.isLayoutRulesFetching,
+      isSubmitFetching: this.isSubmitFetching,
       isValidationRulesFetching: this.isValidationRulesFetching
       /*hack end*/