@zohodesk/library-platform 1.1.12 → 1.2.0

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

@@ -1,4 +1,4 @@
-import { CREATE_RECORD } from "../../../../bc/zrecord/Constants";
+import { CREATE_RECORD, UPDATE_RECORD } from "../../../../bc/zrecord/Constants";
 import AbstractUseCase from "./AbstractUseCase";
 import { ZFORM_ERROR, ZFORM_VALIDATION_SUCCESS, ZFORM_SUBMIT_VALIDATION_FAILURE } from "../../../../bc/zform/Symbol";
 
@@ -43,6 +43,7 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
       const moduleName = zFormEntity.getModuleName();
       const record = zFormEntity.getVisibleFieldsAsRecord();
       const visibleFieldsData = zFormEntity.getVisibleFieldsData();
+      const isEditMode = zFormEntity.isEditMode();
       dispatch({
         type: ZFORM_VALIDATION_SUCCESS,
         payload: {
@@ -52,13 +53,25 @@ class SubmitValidationCompletedUseCase extends AbstractUseCase {
       });
 
       if (!disableCreateRecord) {
-        dispatch({
-          type: CREATE_RECORD,
-          payload: {
-            record,
-            moduleName
-          }
-        });
+        if (isEditMode) {
+          const recordId = zFormEntity.getRecordId();
+          dispatch({
+            type: UPDATE_RECORD,
+            payload: {
+              record,
+              moduleName,
+              recordId
+            }
+          });
+        } else {
+          dispatch({
+            type: CREATE_RECORD,
+            payload: {
+              record,
+              moduleName
+            }
+          });
+        }
       }
     }
   }

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

@@ -79,18 +79,20 @@ export default class ZField {
     return defaultValue;
   }
 
-  decideDefaultValue() {
+  decideDefaultValue(_defaultValue) {
+    const defaultValue = _defaultValue !== undefined ? _defaultValue : this.defaultValue;
+
     switch (this.type) {
       case 'Boolean':
-        this.value = this.decideValueForBoolean(this.defaultValue);
+        this.value = this.decideValueForBoolean(defaultValue);
         break;
 
       case 'Multiselect':
-        this.value = this.decideValueForMultiselect(this.defaultValue);
+        this.value = this.decideValueForMultiselect(defaultValue);
         break;
 
       default:
-        this.value = this.defaultValue === undefined ? '' : this.defaultValue;
+        this.value = defaultValue === undefined ? '' : defaultValue;
     }
   }
 
@@ -184,7 +186,7 @@ export default class ZField {
       isEncryptedField: this.isEncryptedField,
       id: this.id,
       isRemovable: this.isRemovable,
-      maxLength: this.maxLength,
+      maxLength: Number(this.maxLength) > 0 ? Number(this.maxLength) : this.maxLength,
       isMandatory: this.isMandatory,
       value: this.value,
       errorMessage: this.errorMessage,

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

@@ -1,6 +1,7 @@
 import { ErrorCodes } from "../../../cc/component/ErrorStructure";
 import { ZFormApiActionName } from "../../../bc/zform/Constants";
-import { ZHttpErrorCode } from "../../../bc/zhttp/Errors";
+import { DATA_SOURCE_SUCCESS, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../bc/zdata-source/Symbols";
+import { RecordApiActionName } from "../../../bc/zrecord/Constants";
 export default class ZForm {
   /*hack*/
 
@@ -21,6 +22,10 @@ export default class ZForm {
       dependencyMappings,
       context,
       focusedFieldName,
+      layoutId,
+      mode,
+      recordId,
+      initialRecordData,
 
       /*hack*/
       isMyFormFetching,
@@ -45,6 +50,10 @@ export default class ZForm {
     this.dependencyMappings = dependencyMappings;
     this.context = context;
     this.focusedFieldName = focusedFieldName || null;
+    this.layoutId = layoutId;
+    this.initialRecordData = initialRecordData;
+    this.mode = mode;
+    this.recordId = recordId;
     /*hack*/
 
     this.isMyFormFetching = isMyFormFetching;
@@ -81,14 +90,64 @@ export default class ZForm {
       orgName,
       servicePrefix
     } = this.context;
-    return {
+    const recordId = this.getRecordId();
+    const formValues = this.getVisibleFieldsData();
+    const context = {
       module,
       departmentId: departmentId,
       orgName,
+      mode: this.mode,
+      formValues,
+      record: this.initialRecordData,
       ...this.context,
       servicePrefix: servicePrefix || 'supportapi/zd' // FIX: servicePrefix defaultValue should be available from properties
 
     };
+
+    if (recordId) {
+      context.recordId = recordId;
+    }
+
+    return context;
+  }
+
+  getRecordId() {
+    return this.recordId;
+  }
+
+  isEditMode() {
+    return this.mode === 'edit';
+  }
+
+  getDataSourceMetaData(_ref2) {
+    let {
+      actionName,
+      successEvent,
+      failureEvent,
+      extras
+    } = _ref2;
+    return {
+      actionName,
+      //hack
+      [DATA_SOURCE_NO_CONTENT]: {
+        type: successEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      },
+      [DATA_SOURCE_FAILURE]: {
+        type: failureEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      },
+      [DATA_SOURCE_SUCCESS]: {
+        type: successEvent,
+        metaData: { ...extras,
+          actionName
+        }
+      }
+    };
   }
 
   setFormProperties(properties, layoutRuleHelper) {
@@ -137,6 +196,10 @@ export default class ZForm {
     let isBreaking = false; // Set error state based on the failed action
 
     switch (actionName) {
+      case RecordApiActionName.GET_SINGLE_RECORD:
+        isBreaking = true;
+        break;
+
       case ZFormApiActionName.getMyForm:
         this.setMyFormFetching(false);
         isBreaking = true;
@@ -170,34 +233,23 @@ export default class ZForm {
   }
 
   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,
+      code: ErrorCodes.API_FAILED,
+      message: error.message,
       errorDetails: {
         isBreaking,
-        originalError: error,
-        actionName
+        message: 'Api call failed for action: ' + actionName,
+        actionName,
+        originalError: error
       }
     };
   }
 
-  getSectionId(_ref2) {
+  getSectionId(_ref3) {
     let {
       fieldName,
       sectionName
-    } = _ref2;
+    } = _ref3;
 
     if (sectionName) {
       for (let section of this.sections) {
@@ -482,6 +534,27 @@ export default class ZForm {
     }
   }
 
+  setInitialRecord(recordData) {
+    this.initialRecordData = recordData;
+    const layoutId = recordData.layout.id;
+    this.setLayoutId(layoutId); // if (recordData && recordData.data && recordData.data.length > 0) {
+    //   const record = recordData.data[0];
+    //   // Populate form fields with record data
+    //   Object.keys(record).forEach(fieldApiName => {
+    //     if (fieldApiName !== 'id') { // Skip ID field
+    //       const field = this.getFieldByApiName(fieldApiName);
+    //       if (field) {
+    //         field.setValue(record[fieldApiName]);
+    //       }
+    //     }
+    //   });
+    // }
+  }
+
+  getInitialRecord() {
+    return this.initialRecordData;
+  }
+
   getFieldErrorMessage(fieldApiName) {
     const field = this.getFieldByApiName(fieldApiName);
     return field ? field.getErrorMessage() : undefined;
@@ -627,6 +700,7 @@ export default class ZForm {
   }
 
   toObject() {
+    const formValues = this.getVisibleFieldsData();
     return {
       modifiedTime: this.modifiedTime,
       isStandardLayout: this.isStandardLayout,
@@ -642,8 +716,11 @@ export default class ZForm {
       dependencyMappings: this.dependencyMappings.map(dm => dm.toObject()),
       focusedFieldName: this.focusedFieldName,
       layoutId: this.layoutId,
+      mode: this.mode,
+      initialRecordData: this.initialRecordData,
 
       /*hack*/
+      formValues,
       isMyFormFetching: this.isMyFormFetching,
       isDependencyFetching: this.isDependencyFetching,
       isLayoutRulesFetching: this.isLayoutRulesFetching,

package/es/platform/zform/frameworks/ui/EventHandlerFactory.js

@@ -7,9 +7,10 @@ import FormPresenter from "../../adapters/presenter/FormPresenter";
 import Service from "../../adapters/gateway/Service";
 import LifeCycleEvents from "../../../../cc/component/LifeCycleEventsEnum";
 import InitializeController from "../../adapters/controllers/IntializeController";
-import { ZFORM_DEPENDENCY_MAPPINGS_REQUEST, ZFORM_DEPENDENCY_MAPPINGS_SUCCESS, ZFORM_FIELD_VALUE_CHANGE_REQUEST, ZFORM_MY_FORM_REQUEST, ZFORM_MY_FORM_SUCCESS, ZFORM_MY_LAYOUTS_SUCCESS, ZFORM_SET_FIELD_ERROR_MESSAGE, ZFORM_SUBMIT_VALIDATION_COMPLETED, ZFORM_API_FAILURE, ZFORM_VALIDATE_FIELD_REQUEST, ZFORM_VALIDATION_RULES_REQUEST, ZFORM_VALIDATION_RULES_SUCCESS, ZFORM_VALIDATION_RULES_EXECUTION_RESULT, ZFORM_LOOKUP_FIELD_SUCCESS } from "../../../../bc/zform/Symbol";
+import { ZFORM_DEPENDENCY_MAPPINGS_REQUEST, ZFORM_DEPENDENCY_MAPPINGS_SUCCESS, ZFORM_FIELD_VALUE_CHANGE_REQUEST, ZFORM_MY_FORM_REQUEST, ZFORM_MY_FORM_SUCCESS, ZFORM_MY_LAYOUTS_SUCCESS, ZFORM_SET_FIELD_ERROR_MESSAGE, ZFORM_SUBMIT_VALIDATION_COMPLETED, ZFORM_API_FAILURE, ZFORM_VALIDATE_FIELD_REQUEST, ZFORM_VALIDATION_RULES_REQUEST, ZFORM_VALIDATION_RULES_SUCCESS, ZFORM_VALIDATION_RULES_EXECUTION_RESULT, ZFORM_INITIAL_RECORD_SUCCESS, ZFORM_LOOKUP_FIELD_SUCCESS } from "../../../../bc/zform/Symbol";
 import LookupFieldController from "../../adapters/controllers/LookupFieldController";
 import MyLayoutSuccessController from "../../adapters/controllers/MyLayoutSuccessController";
+import GetInitialRecordSuccessController from "../../adapters/controllers/GetInitialRecordSuccessController";
 import MyFormSuccessController from "../../adapters/controllers/MyFromSuccessController";
 import DependenciesController from "../../adapters/controllers/DependenciesController";
 import DependenciesRequestController from "../../adapters/controllers/DependenciesRequestController";
@@ -48,6 +49,7 @@ class EventHandlersFactory {
     const createRecordFailedController = new CreateRecordFailedController(service);
     const initializeController = new InitializeController(service);
     const myLayoutSuccessController = new MyLayoutSuccessController(service);
+    const getInitialRecordSuccessController = new GetInitialRecordSuccessController(service);
     const myFormRequestController = new MyFormRequestController(service);
     const myFormSuccessController = new MyFormSuccessController(service);
     const dependenciesRequestController = new DependenciesRequestController(service);
@@ -68,6 +70,22 @@ class EventHandlersFactory {
     return {
       [LifeCycleEvents.MOUNT]: initializeController.handle,
       [ZFORM_MY_LAYOUTS_SUCCESS]: myLayoutSuccessController.handle,
+      [ZFORM_INITIAL_RECORD_SUCCESS]: getInitialRecordSuccessController.handle,
+      [LifeCycleEvents.ERROR_OCCURRED]: _ref => {
+        let {
+          action,
+          dispatch
+        } = _ref;
+        const {
+          metaData,
+          payload
+        } = action;
+        dispatch({
+          type: SmartFormConstants.SMART_FORM_ERROR_OCCURRED,
+          metaData,
+          payload
+        });
+      },
       [RECORD_EXECUTE_SUCCESS_CALLBACK]: createRecordSuccessController.handle,
       [RECORD_EXECUTE_FAIL_CALLBACK]: createRecordFailedController.handle,
       [ZFORM_MY_FORM_REQUEST]: myFormRequestController.handle,
@@ -84,11 +102,11 @@ class EventHandlersFactory {
       [ZFORM_VALIDATE_FIELD_REQUEST]: validateFieldRequestController.handle,
       [SmartFormConstants.SMART_FORM_SUBMIT_CLICKED]: formSubmitController.handle,
       [ZFORM_SUBMIT]: formSubmitController.handle,
-      [FormConstants.FORM_SUBMIT]: _ref => {
+      [FormConstants.FORM_SUBMIT]: _ref2 => {
         let {
           action,
           dispatch
-        } = _ref;
+        } = _ref2;
         const {
           metaData,
           payload
@@ -102,11 +120,11 @@ class EventHandlersFactory {
       [FormConstants.FORM_FIELD_BLURRED]: fieldBlurController.handle,
       [ZFORM_VALIDATION_RULES_EXECUTION_RESULT]: validationRulesExecutionResultController.handle,
       [ZFORM_SUBMIT_VALIDATION_COMPLETED]: submitValidationCompletedController.handle,
-      [FormConstants.FORM_FIELD_VALUE_CHANGE_REQUEST]: _ref2 => {
+      [FormConstants.FORM_FIELD_VALUE_CHANGE_REQUEST]: _ref3 => {
         let {
           action,
           dispatch
-        } = _ref2;
+        } = _ref3;
         const {
           sectionId,
           fieldName,

package/es/platform/zform/frameworks/ui/ZFormBehaviourFactory.js

@@ -10,6 +10,8 @@ class ZFormBehaviourFactory {
           properties
         } = _ref;
         return {
+          mode: properties.mode,
+          initialRecordData: null,
           isMyFormFetching: true,
           isDependencyFetching: true,
           isSubmitFetching: false,

package/es/platform/zlist/adapters/controllers/RefreshRecordsRequestedController.js

@@ -0,0 +1,21 @@
+import AbstractController from "./AbstractController";
+
+class RefreshRecordsRequestedController extends AbstractController {
+  handle(event) {
+    const {
+      refreshRecordsRequestedUseCase
+    } = this.service;
+    const {
+      state,
+      updateState,
+      dispatch
+    } = event;
+    refreshRecordsRequestedUseCase.updateDependency(state, updateState);
+    refreshRecordsRequestedUseCase.execute({
+      dispatch
+    });
+  }
+
+}
+
+export default RefreshRecordsRequestedController;

package/es/platform/zlist/adapters/controllers/SortController.js

@@ -11,10 +11,10 @@ class SortController extends AbstractController {
       action,
       dispatch
     } = event;
-    const sortBy = action.payload;
+    const sortConfig = action.payload;
     sortUseCase.updateDependency(state, updateState);
     sortUseCase.execute({
-      sortBy,
+      sortConfig,
       dispatch
     });
   }

package/es/platform/zlist/adapters/gateways/Repository.js

@@ -1,6 +1,5 @@
 import ListErrorState from "../../domain/entities/ListErrorState";
 import ListFactory from "../../applications/entities-factory/ListFactory";
-import SortBy from "../../domain/entities/SortBy";
 
 class Repository {
   init(state) {
@@ -18,11 +17,14 @@ class Repository {
       context
     } = this.state.behaviours.appContext;
     const {
-      sortBy,
+      zlist
+    } = this.state.behaviours;
+    const {
+      sortConfig,
       errorState,
       isReOrderLoading,
       limit
-    } = this.getZListState();
+    } = zlist;
     const list = ListFactory.createList({
       context,
       query: {
@@ -31,7 +33,7 @@ class Repository {
         moduleName,
         ...query
       },
-      sortBy: new SortBy(sortBy.id, sortBy.name, sortBy.order),
+      sortConfig,
       limit: limit,
       isReOrderLoading,
       errorState: new ListErrorState(errorState)
@@ -46,13 +48,6 @@ class Repository {
     return zrecord.records;
   }
 
-  getZListState() {
-    const {
-      zlist
-    } = this.state.behaviours;
-    return zlist;
-  }
-
 }
 
 export default Repository;

package/es/platform/zlist/adapters/gateways/Service.js

@@ -14,6 +14,7 @@ import RecordSuccessCallbackUsecase from "../../applications/usecases/RecordSucc
 import ReOrderUseCase from "../../applications/usecases/ReOrderUseCase";
 import ReOrderFailedUseCase from "../../applications/usecases/ReOrderFailedUseCase";
 import ResolutionBasedLimitUseCase from "../../applications/usecases/ResolutionBasedLimitUseCase";
+import RefreshRecordsRequestedUseCase from "../../applications/usecases/RefreshRecordsRequestedUseCase";
 
 class Service {
   constructor(dependencies) {
@@ -34,6 +35,7 @@ class Service {
     this.deleteSuccessUseCase = new DeleteSuccessUseCase(this.dependencies);
     this.reOrderUseCase = new ReOrderUseCase(this.dependencies);
     this.reOrderFailedUseCase = new ReOrderFailedUseCase(this.dependencies);
+    this.refreshRecordsRequestedUseCase = new RefreshRecordsRequestedUseCase(this.dependencies);
   }
 
 }

package/es/platform/zlist/adapters/presenters/TableTranslator.js

@@ -1,7 +1,7 @@
 /* eslint-disable @zohodesk/architecturerules/define-property-schema */
 
 /* eslint-disable max-lines-per-function */
-import { Width as ColumnWidth } from "../../../../cc/table-list/data-types/Header";
+import { Width as ColumnWidth, SortedBy } from "../../../../cc/table-list/data-types/Header";
 import HeadersTranslator from "./translators/HeadersTranslator";
 import RowsTranslator from "./translators/RowsTranslator";
 import Pipeline from "./utils/Pipeline";
@@ -11,6 +11,8 @@ import { ResizerStateTranslator } from "./translators/ResizerStateTranslator";
 import { calculateFieldWidths } from "./utils/calculateFieldWidths";
 import DefaultClientActions from "./utils/DefaultClientActions";
 import SelectionTranslator from "./SelectionTranslator";
+import { SortModelOrder } from "../../domain/entities/interfaces/Properties";
+import { SortOrder } from "../../../../bc/zlist/Types";
 const EMPTY_OBJECT = {};
 const EMPTY_ARRAY = [];
 
@@ -34,7 +36,8 @@ export default class TableTranslator {
       localStorage: localStorageBehaviour,
       columnResizer,
       keyboardControls,
-      textOverflow
+      textOverflow,
+      floatPagination
     } = behaviours;
     const {
       resizeConfig,
@@ -42,7 +45,8 @@ export default class TableTranslator {
       keyboardControlsConfig,
       nameFieldsConfig,
       textOverflowConfig,
-      recordReadStatusConfig
+      recordReadStatusConfig,
+      floatPaginationConfig
     } = properties;
     const {
       modules
@@ -58,18 +62,19 @@ export default class TableTranslator {
     } = fallbackToDefault(behaviours, {}); // FIX: behaviours should be available by default
 
     const {
-      sortBy,
+      sortConfig,
       errorState,
       isReOrderLoading
-    } = fallbackToDefault(zlist, {}); // FIX: zlist should be available by default
-
+    } = zlist;
     const {
       focussedIndex
     } = fallbackToDefault(keyboardControls, {}); // FIX: KeyboardControls should be available by default
 
     const {
       records,
-      isFetching: isRecordsFetching
+      isFetching: isRecordsFetching,
+      localRecords,
+      isLocalSearchEnabled
     } = fallbackToDefault(zrecord, {}); // FIX: zrecord should be available by defau
 
     const {
@@ -82,7 +87,6 @@ export default class TableTranslator {
       isFetching: isClientScriptsFetching
     } = fallbackToDefault(zclientScriptsEventMapping, {});
     const fieldComponentMapping = fallbackToDefault(componentMapping.fields, {});
-    const rowActionsUiType = componentMapping.rowActionsComponentName;
     const {
       shouldClearRecords: isRecordsShouldBeEmptied,
       canErrorPage: isError
@@ -123,9 +127,37 @@ export default class TableTranslator {
     const textOverflowData = {
       isEnabled: textOverflowConfig.isEnabled,
       mode: textOverflow.mode
-    };
-    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths, sortBy, records, instanceName, moduleName);
-    const rowsTranslator = new RowsTranslator(recordsForDisplay, fields, rowActions, context, preferences, fieldComponentMapping, rowActionsUiType, fieldActions, instanceName, textOverflowData, moduleName, nameFieldsConfig, recordReadStatusConfig); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
+    }; // ComponentMapping support
+
+    const componentMappingFromApi = Array.isArray(zfield.componentMapping) ? zfield.componentMapping : [];
+    let emptyStateUiType = componentMapping.emptyState || '';
+    let rowActionsUiType = componentMapping.rowActionsComponentName;
+    componentMappingFromApi.forEach(fieldVariation => {
+      const {
+        fieldName,
+        uiType,
+        translator,
+        contractType
+      } = fieldVariation;
+
+      if (contractType === 'EmptyState') {
+        emptyStateUiType = uiType;
+        return;
+      }
+
+      if (contractType === 'RowActionsMenu') {
+        rowActionsUiType = uiType;
+        return;
+      }
+
+      const field = fields.find(f => f.name === fieldName);
+
+      if (field) {
+        field.uiType = uiType;
+      }
+    });
+    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths, sortConfig, records, instanceName, moduleName);
+    const rowsTranslator = new RowsTranslator(isLocalSearchEnabled ? localRecords : recordsForDisplay, fields, rowActions, context, preferences, fieldComponentMapping, rowActionsUiType, fieldActions, instanceName, textOverflowData, moduleName, nameFieldsConfig, recordReadStatusConfig, Array.isArray(zfield.componentMapping) ? [...zfield.componentMapping] : []); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
     // const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator(), actionTranslator.getTranslator()];
 
     const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator()];
@@ -140,7 +172,10 @@ export default class TableTranslator {
         isError,
         selection: SelectionTranslator(state),
         focussedRow: focussedIndex,
-        sortBy,
+        sortBy: sortConfig ? {
+          name: sortConfig.fieldName,
+          order: sortConfig.order === SortModelOrder.ASC || sortConfig.order === SortOrder.ASC ? SortedBy.Ascending : sortConfig.order === SortModelOrder.DES || sortConfig.order === SortOrder.DES ? SortedBy.Descending : SortedBy.None
+        } : {},
         rowCursor,
         resizerState: ResizerStateTranslator({
           columnResizer: columnResizer,
@@ -155,9 +190,18 @@ export default class TableTranslator {
         },
         keyboardControlsConfig,
         textOverflowConfig: textOverflowData,
+        floatPaginationConfig: { ...floatPaginationConfig,
+          scrollCount: floatPagination.currentRecord,
+          totalCount: records?.length !== undefined ? records.length : 0,
+          scrollToUpTooltip: floatPagination.scrollToUpTooltip,
+          scrollToDownTooltip: floatPagination.scrollToDownTooltip,
+          isTopReached: false,
+          isBottomReached: floatPagination.currentRecord === records?.length,
+          isVisible: floatPagination.isVisible
+        },
         isLoading,
         isReOrderLoading,
-        emptyStateUiType: componentMapping.emptyState || '',
+        emptyStateUiType,
         data: fields.length ? data : {
           headers: EMPTY_ARRAY,
           rows: EMPTY_ARRAY