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

package/es/platform/components/form-connected/adapters/resources/SmartFormResources.js

@@ -16,22 +16,24 @@ import SubmitUseCase from "../../../../zform/applications/usecases/SubmitUseCase
 import { AbstractResource } from "../../../../sdk/application/interfaces/gateways/AbstractResource";
 import { SdkContracts } from "../../../../../cc/form-connected/SdkContract"; // hack
 
-import { validations as defaultFieldValidations } from "../../../../../library/behaviours/field-validation/frameworks/utils/FormBasicValidationAdaptor";
+import ValidateFieldUseCase from "../../../../zform/applications/usecases/ValidateFieldUseCase";
+import SetFieldErrorMessageUseCase from "../../../../zform/applications/usecases/SetFieldErrorMessageUseCase";
+import FocusFieldUseCase from "../../../../zform/applications/usecases/FocusFieldUseCase";
+import InsertValidationRuleUseCase from "../../../../zform/applications/usecases/InsertValidationRuleSuccessUseCase";
+import GetFieldErrorMessageUseCase from "../../../../zform/applications/usecases/GetFieldErrorMessageUseCase";
 export class SmartFormResources extends AbstractResource {
   initialize() {}
 
   destroy() {}
 
   createUseCase(dependencies, UseCaseClass) {
-    var _usecase$updateDepend, _usecase$updateDepend2;
-
     const {
       state,
       updateState
     } = this.dependencies;
     const usecase = new UseCaseClass(dependencies);
-    (_usecase$updateDepend = usecase.updateDependencies) === null || _usecase$updateDepend === void 0 ? void 0 : _usecase$updateDepend.call(usecase, state, updateState);
-    (_usecase$updateDepend2 = usecase.updateDependency) === null || _usecase$updateDepend2 === void 0 ? void 0 : _usecase$updateDepend2.call(usecase, state, updateState);
+    usecase.updateDependencies?.(state, updateState);
+    usecase.updateDependency?.(state, updateState);
     return usecase;
   } // private getFormDependencies(): ZFormUseCaseDependencies {
   //     const dependencies: ZFormUseCaseDependencies = {
@@ -48,8 +50,7 @@ export class SmartFormResources extends AbstractResource {
     const dependencies = {
       repository: new ZFormRepository(),
       presenter: new ZFormPresenter(),
-      validator: new ZFormValidator(defaultFieldValidations),
-      // Hack Need to pass customValidators
+      validator: new ZFormValidator(),
       layoutRuleApplier: new ZFormLayoutRuleApplier()
     };
     return dependencies;
@@ -176,13 +177,13 @@ export class SmartFormResources extends AbstractResource {
   }
 
   getFieldValue(fieldName) {
+    this.validateInput('getFieldValue', {
+      fieldName
+    }, SdkContracts.getFieldValueInputMeta);
     const {
       getData,
       setData
     } = this.createCallback();
-    this.validateInput('getFieldValue', {
-      fieldName
-    }, SdkContracts.getFieldValueInputMeta);
     const {
       dispatch
     } = this.dependencies;
@@ -196,6 +197,85 @@ export class SmartFormResources extends AbstractResource {
     return getData();
   }
 
+  validateField(fieldName, eventName) {
+    this.validateInput('validateField', {
+      fieldName,
+      eventName
+    }, SdkContracts.validateFieldInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, ValidateFieldUseCase);
+    usecase.execute({
+      fieldName,
+      dispatch
+    });
+  }
+
+  insertValidationRule(index, validationRule) {
+    this.validateInput('insertValidationRule', {
+      index,
+      validationRule
+    }, SdkContracts.insertValidationRuleInputMeta);
+    InsertValidationRuleUseCase;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, InsertValidationRuleUseCase);
+    usecase.execute({
+      index,
+      validationRule
+    });
+  }
+
+  getFieldErrorMessage(fieldName) {
+    this.validateInput('getFieldErrorMessage', {
+      fieldName
+    }, SdkContracts.getFieldErrorMessageInputMeta);
+    const {
+      getData,
+      setData
+    } = this.createCallback();
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, GetFieldErrorMessageUseCase);
+    usecase.execute({
+      fieldName,
+      callback: setData,
+      dispatch
+    });
+    return getData();
+  }
+
+  setFieldErrorMessage(fieldName, errorMessage) {
+    this.validateInput('setFieldErrorMessage', {
+      fieldName,
+      errorMessage
+    }, SdkContracts.setFieldErrorMessageInputMeta);
+    const {
+      dispatch
+    } = this.dependencies;
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, SetFieldErrorMessageUseCase);
+    usecase.execute({
+      fieldApiName: fieldName,
+      errorMessage,
+      dispatch
+    });
+  }
+
+  focusField(fieldName) {
+    this.validateInput('focusField', {
+      fieldName
+    }, SdkContracts.focusFieldInputMeta);
+    const dependencies = this.getFormDependencies();
+    const usecase = this.createUseCase(dependencies, FocusFieldUseCase);
+    usecase.execute({
+      fieldName
+    });
+  }
+
   submit() {
     const {
       dispatch

package/es/platform/components/form-connected/frameworks/EventHandlersFactory.js

@@ -1,12 +1,14 @@
 import SmartFormConstants from "../../../../cc/form-connected/Constants";
 import FormSdkFactory from "./FormSdkFactory";
 import FormConstants from "../../../../cc/form/Constants";
-import { ZFORM_FIELD_VALUE_CHANGED } from "../../../../bc/zform/Symbol";
-import { platformSDK } from "../../../sdk/frameworks/Sdk";
+import { ZFORM_FIELD_BLURRED, ZFORM_FIELD_VALUE_CHANGED, ZFORM_SUBMIT_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE } from "../../../../bc/zform/Symbol";
+import { platformSDK_old } from "../../../sdk/frameworks/Sdk";
 const {
   SMART_FORM_FIELD_FOCUSED,
   SMART_FORM_FIELD_BLURRED,
-  SMART_FORM_FIELD_VALUE_CHANGED
+  SMART_FORM_FIELD_VALUE_CHANGED,
+  SMART_FORM_SUBMIT_SUCCESS,
+  SMART_FORM_SUBMIT_FAILURE
 } = SmartFormConstants; // function createHandlerWithSdk(handler) {
 //   return input => {
 //     const { state, dispatch } = input;
@@ -21,7 +23,7 @@ function createHandlerWithSdk(handler) {
     } = input;
     const instanceName = state.properties.instanceName;
     handler({ ...input,
-      platformSDK
+      platformSDK: platformSDK_old
     }, FormSdkFactory.create({
       instanceName
     }));
@@ -36,62 +38,32 @@ export default class EventHandlersFactory {
     }));
   }
 
+  static createEventMappedHandler(eventName) {
+    return _ref => {
+      let {
+        action,
+        dispatch
+      } = _ref;
+      dispatch({
+        type: eventName,
+        payload: action.payload
+      });
+    };
+  }
+
+  static getEventMappedHandlers() {
+    return {
+      [FormConstants.FORM_FIELD_FOCUSED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_FOCUSED),
+      [ZFORM_FIELD_BLURRED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_BLURRED),
+      [ZFORM_SUBMIT_SUCCESS]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_SUBMIT_SUCCESS),
+      [ZFORM_SUBMIT_VALIDATION_FAILURE]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_SUBMIT_FAILURE),
+      [ZFORM_FIELD_VALUE_CHANGED]: EventHandlersFactory.createEventMappedHandler(SMART_FORM_FIELD_VALUE_CHANGED)
+    };
+  }
+
   static create(eventHandlers) {
     const wrapped = EventHandlersFactory.createWrapped(eventHandlers);
-    return {
-      [FormConstants.FORM_FIELD_FOCUSED]: _ref => {
-        let {
-          action,
-          dispatch
-        } = _ref;
-        const {
-          sectionId,
-          fieldName
-        } = action.payload;
-        dispatch({
-          type: SMART_FORM_FIELD_FOCUSED,
-          payload: {
-            sectionId,
-            fieldName
-          }
-        });
-      },
-      [FormConstants.FORM_FIELD_BLURRED]: _ref2 => {
-        let {
-          action,
-          dispatch
-        } = _ref2;
-        const {
-          sectionId,
-          fieldName
-        } = action.payload;
-        dispatch({
-          type: SMART_FORM_FIELD_BLURRED,
-          payload: {
-            sectionId,
-            fieldName
-          }
-        });
-      },
-      [ZFORM_FIELD_VALUE_CHANGED]: _ref3 => {
-        let {
-          action,
-          dispatch
-        } = _ref3;
-        const {
-          sectionId,
-          fieldName,
-          value
-        } = action.payload;
-        dispatch({
-          type: SMART_FORM_FIELD_VALUE_CHANGED,
-          payload: {
-            sectionId,
-            fieldName,
-            value
-          }
-        });
-      },
+    return { ...EventHandlersFactory.getEventMappedHandlers(),
       ...wrapped
     };
   }

package/es/platform/components/form-connected/frameworks/FormConnectedFactory.js

@@ -7,7 +7,6 @@ import defaultDataSource from "../../../data-source";
 import DataBrokerBehaviourFactory from "../../../zdata-source/frameworks/DataBrokerBehaviourFactory";
 import FormTranslator from "../../../zform/adapters/presenter/FormTranslator";
 import ZFormBehaviourFactory from "../../../zform/frameworks/ui/ZFormBehaviourFactory";
-import FieldValidationBehaviourFactory from "../../../../library/behaviours/field-validation/frameworks/ui/FieldValidationBehaviourFactory";
 import EventHandlersfactory from "./EventHandlersFactory";
 import SdkBehaviourFactory from "../../../sdk-behaviour/frameworks/SdkBehaviourFactory";
 import ResourceNamesEnum from "../../../../bc/sdk/ResourceNamesEnum";
@@ -23,7 +22,7 @@ function combineDataSourceWithDefault(dataSource) {
   return { ...defaultDataSource,
     ...dataSource,
     httpTemplates: { ...defaultDataSource.httpTemplates,
-      ...(dataSource === null || dataSource === void 0 ? void 0 : dataSource.httpTemplates)
+      ...dataSource?.httpTemplates
     }
   };
 }
@@ -32,7 +31,6 @@ export default class FormConnectedFactory {
   static create(_ref) {
     let {
       name,
-      customValidators,
       dataSource,
       eventHandlers = {},
       View = FormConnectedView
@@ -48,9 +46,7 @@ export default class FormConnectedFactory {
       transformState: FormTranslator.transformState,
       behaviours: [SdkBehaviourFactory.create([ResourceNamesEnum.SMART_FORM]), ClientActionsBehaviourFactory.create({
         getClientActions: _dataSource.httpTemplates.getClientActions
-      }), ZHttpBehaviourFactory.create(), DataBrokerBehaviourFactory.create(), RecordBehaviourFactory.create(_dataSource.httpTemplates), FieldValidationBehaviourFactory.create(), ZFormBehaviourFactory.create({
-        customValidators
-      })]
+      }), ZHttpBehaviourFactory.create(), DataBrokerBehaviourFactory.create(), RecordBehaviourFactory.create(_dataSource.httpTemplates), ZFormBehaviourFactory.create()]
     });
   }
 

package/es/platform/components/form-connected/frameworks/FormConnectedView.js

@@ -9,6 +9,7 @@ function View(_ref, ref) {
   const {
     isLoading,
     sections = [],
+    rightPanel,
     isHeaderEnabled,
     isFooterEnabled,
     headerLeftActions,
@@ -25,7 +26,8 @@ function View(_ref, ref) {
     headerLeftActions: headerLeftActions,
     headerRightActions: headerRightActions,
     footerLeftActions: footerLeftActions,
-    footerRightActions: footerRightActions
+    footerRightActions: footerRightActions,
+    rightPanel: rightPanel
   });
 }
 

package/es/platform/components/form-connected/frameworks/FormSdkFactory.js

@@ -1,5 +1,5 @@
 // /* eslint-disable max-lines-per-function */
-import { platformSDK } from "../../../sdk/frameworks/Sdk";
+import { platformSDK_old } from "../../../sdk/frameworks/Sdk";
 import ResourceNamesEnum from "../../../../bc/sdk/ResourceNamesEnum";
 export default class FormSdkFactory {
   static getFormSdks(smartForm) {
@@ -22,7 +22,7 @@ export default class FormSdkFactory {
     let {
       instanceName
     } = _ref;
-    const smartForm = platformSDK[ResourceNamesEnum.SMART_FORM](instanceName);
+    const smartForm = platformSDK_old[ResourceNamesEnum.SMART_FORM](instanceName);
     const formSdks = FormSdkFactory.getFormSdks(smartForm);
     return {
       zform: {

package/es/platform/components/table-connected/adapters/controllers/ResizeFinishController.js

@@ -13,8 +13,6 @@ export class ResizeFinishController extends AbstractController {
     } = event.action.payload;
 
     if (newWidth !== oldWidth) {
-      var _localStorage$moduleN, _localStorage$moduleN2, _localStorage$moduleN3;
-
       const {
         localStorage
       } = state.behaviours;
@@ -23,10 +21,10 @@ export class ResizeFinishController extends AbstractController {
         viewId
       } = state.properties; // TODO: move this to a separate file as selector
 
-      const modifiedWidths = localStorage === null || localStorage === void 0 ? void 0 : (_localStorage$moduleN = localStorage[moduleName]) === null || _localStorage$moduleN === void 0 ? void 0 : (_localStorage$moduleN2 = _localStorage$moduleN[viewId]) === null || _localStorage$moduleN2 === void 0 ? void 0 : _localStorage$moduleN2.modifiedWidths; // TODO: better to use a selector update method
+      const modifiedWidths = localStorage?.[moduleName]?.[viewId]?.modifiedWidths; // TODO: better to use a selector update method
 
-      const data = { ...(localStorage === null || localStorage === void 0 ? void 0 : localStorage[moduleName]),
-        [viewId]: { ...(localStorage === null || localStorage === void 0 ? void 0 : (_localStorage$moduleN3 = localStorage[moduleName]) === null || _localStorage$moduleN3 === void 0 ? void 0 : _localStorage$moduleN3[viewId]),
+      const data = { ...localStorage?.[moduleName],
+        [viewId]: { ...localStorage?.[moduleName]?.[viewId],
           modifiedWidths: { ...modifiedWidths,
             [columnName]: newWidth
           }

package/es/platform/components/table-connected/adapters/resources/SmartTableResource.js

@@ -48,15 +48,13 @@ export class SmartTableResource extends AbstractResource {
   }
 
   createUseCase(dependencies, UseCaseClass) {
-    var _usecase$updateDepend, _usecase$updateDepend2;
-
     const {
       state,
       updateState
     } = this.dependencies;
     const usecase = new UseCaseClass(dependencies);
-    (_usecase$updateDepend = usecase.updateDependency) === null || _usecase$updateDepend === void 0 ? void 0 : _usecase$updateDepend.call(usecase, state, updateState);
-    (_usecase$updateDepend2 = usecase.updateDependencies) === null || _usecase$updateDepend2 === void 0 ? void 0 : _usecase$updateDepend2.call(usecase, state, updateState);
+    usecase.updateDependency?.(state, updateState);
+    usecase.updateDependencies?.(state, updateState);
     return usecase;
   }
 

package/es/platform/components/table-connected/frameworks/EventHandlersFactory.js

@@ -14,7 +14,7 @@ import { ReOrderFinishController } from "../adapters/controllers/ReOrderFinishCo
 import ScrollController from "../adapters/controllers/ScrollController";
 import ColumnChooserUpdateController from "../adapters/controllers/ColumnChooserUpdateController";
 import ColumnChooserOpenedController from "../adapters/controllers/ColumnChooserOpenedController";
-import { platformSDK } from "../../../sdk/frameworks/Sdk";
+import { platformSDK_old } from "../../../sdk/frameworks/Sdk";
 import { SET_RECORDS_SUCCESS } from "../../../../bc/zrecord/Constants";
 import ErrorEventHandlersFactory from "./ErrorEventHandlersFactory";
 const {
@@ -32,7 +32,7 @@ function createHandlerWithSdk(handler) {
     } = input;
     const instanceName = state.properties.instanceName;
     handler({ ...input,
-      platformSDK
+      platformSDK: platformSDK_old
     }, ListSdkFactory.create({
       instanceName
     }));

package/es/platform/components/table-connected/frameworks/ListSdkFactory.js

@@ -1,5 +1,5 @@
 import ResourceNamesEnum from "../../../../bc/sdk/ResourceNamesEnum";
-import { platformSDK } from "../../../sdk/frameworks/Sdk";
+import { platformSDK_old } from "../../../sdk/frameworks/Sdk";
 export default class ListSdkFactory {
   static getRecordSdks(smartTable) {
     return {
@@ -33,7 +33,7 @@ export default class ListSdkFactory {
     let {
       instanceName
     } = _ref;
-    const smartTable = platformSDK[ResourceNamesEnum.SMART_TABLE](instanceName);
+    const smartTable = platformSDK_old[ResourceNamesEnum.SMART_TABLE](instanceName);
     const recordSdks = ListSdkFactory.getRecordSdks(smartTable);
     const selectionSdks = ListSdkFactory.getSelectionSdks(smartTable);
     return {

package/es/platform/components/table-connected/frameworks/TableConnectedFactory.js

@@ -33,7 +33,7 @@ function combineDataSourceWithDefault(dataSource) {
   return { ...defaultDataSource,
     ...dataSource,
     httpTemplates: { ...defaultDataSource.httpTemplates,
-      ...(dataSource === null || dataSource === void 0 ? void 0 : dataSource.httpTemplates)
+      ...dataSource?.httpTemplates
     }
   };
 }

package/es/platform/data-source/http-template/deleteRecords.js

@@ -1,6 +1,6 @@
 const deleteRecords = {
   name: 'records',
-  api: '/{{servicePrefix}}/{{orgName}}/api/v1/{{moduleName}}/moveToTrash',
+  api: '/{{servicePrefix}}/{{orgName}}/api/v1/records/deleteMany',
   parameters: `{}`,
   type: 'POST',
   transformer: data => data,

package/es/platform/data-source/http-template/fetchLookupFields.js

@@ -0,0 +1,24 @@
+const fetchLookupFields = {
+  name: 'fetchLookupFields',
+  api: '/{{servicePrefix}}/{{orgName}}/api/v1/layouts/{{layoutId}}/lookupFields',
+  parameters: `{}`,
+  type: 'GET',
+  transformer: data => data,
+  getResponse: async _ref => {
+    let {
+      params,
+      payload
+    } = _ref;
+  },
+  properties: {
+    layoutId: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    }
+  }
+};
+export default fetchLookupFields;

package/es/platform/data-source/http-template/fetchValidationRules.js

@@ -1,10 +1,11 @@
 // Assuming GetTemplate interface is similar to PatchTemplate
+import { transFormValidationRules } from "../utils/validation-rules/TransFormValidationRules";
 const fetchValidationRules = {
   name: 'fetchValidationRules',
   api: '/{{servicePrefix}}/{{orgName}}/api/v1/layouts/{{layoutId}}/validationRules',
   parameters: `{"activeRulesOnly":{{activeRulesOnly}}}`,
   type: 'GET',
-  transformer: data => data,
+  transformer: transFormValidationRules,
   properties: {
     layoutId: {
       required: true,

package/es/platform/data-source/http-template/moveToTrash.js

@@ -0,0 +1,28 @@
+const moveToTrash = {
+  name: 'records',
+  api: '/{{servicePrefix}}/{{orgName}}/api/v1/{{moduleName}}/moveToTrash',
+  parameters: `{}`,
+  type: 'POST',
+  transformer: data => data,
+  requestBody: '{ "recordIds": {{recordIds}} }',
+  // REVIEW: Is `entityIds` applicable to all modules? To be confirmed with backend team
+  properties: {
+    moduleName: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    recordIds: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'array'
+        }
+      }
+    }
+  }
+};
+export default moveToTrash;

package/es/platform/data-source/index.js

@@ -8,6 +8,7 @@ import getClientActions from "./http-template/getClientActions";
 import reOrderRecord from "./http-template/reOrderRecord";
 import { RecordApiActionName } from "../../bc/zrecord/Constants";
 import deleteRecord from "./http-template/deleteRecord";
+import moveToTrash from "./http-template/moveToTrash";
 import fetchMyLayouts from "./http-template/fetchMyFormLayout";
 import fetchMyForm from "./http-template/fetchMyForm";
 import fetchLayoutRules from "./http-template/fetchLayoutRules";
@@ -15,10 +16,12 @@ import fetchDependencyMappings from "./http-template/fetchDependencyMappings";
 import fetchValidationRules from "./http-template/fetchValidationRules";
 import createRecord from "./http-template/createRecord";
 import updateSelectedFields from "./http-template/updateSelectedFields";
+import fetchLookupFields from "./http-template/fetchLookupFields";
 let dataSource = {
   httpTemplates: {
     [RecordApiActionName.GET_RECORDS]: getRecords,
     [RecordApiActionName.UPDATE_RECORD]: updateRecord,
+    [RecordApiActionName.MOVE_TO_TRASH]: moveToTrash,
     [RecordApiActionName.DELETE_RECORDS]: deleteRecords,
     [RecordApiActionName.DELETE_RECORD]: deleteRecord,
     [RecordApiActionName.CREATE_RECORD]: createRecord,
@@ -31,7 +34,8 @@ let dataSource = {
     fetchMyForm,
     fetchLayoutRules,
     fetchDependencyMappings,
-    fetchValidationRules
+    fetchValidationRules,
+    fetchLookupFields
   }
 };
 export default dataSource; // let ticketsRecordSerice = createRecord(tickets, () => {});