@zohodesk/library-platform 1.1.12-exp.1 → 1.1.12-exp.2

package/es/platform/zform/adapters/gateway/FormRepository.js

@@ -25,7 +25,8 @@ class FormRepository {
       validationRules = [],
       sections = [],
       layoutRules = [],
-      dependencyMappings = []
+      dependencyMappings = [],
+      layoutId
     } = zform;
     let validationRuleEntities = validationRules.map(rule => {
       return new ZValidationRule(rule);
@@ -59,6 +60,7 @@ class FormRepository {
       dependencyMappings: dependencyMappingsEntities,
       layoutRules: layoutRulesEntities,
       context,
+      layoutId: layoutId,
       isMyFormFetching: zform.isMyFormFetching,
       isDependencyFetching: zform.isDependencyFetching,
       isLayoutRulesFetching: zform.isLayoutRulesFetching,

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

@@ -5,20 +5,21 @@ const LookUpFieldTranslator = _ref => {
     fieldPreModified,
     uiConfig
   } = _ref;
-  const fieldModified = {
-    type,
-    uiConfig,
-    value: field.value || '',
-    //state.behaviours.zform.values[field.apiName],
-    name: field.apiName,
-    ...fieldPreModified,
+  const fieldModified = { ...fieldPreModified,
+    uiConfig: uiConfig,
+    type: type,
+    fieldType: field.type,
+    value: field.value,
+    name: field.name,
     id: field.id,
     label: field.i18NLabel,
-    required: field.isMandatory,
-    readonly: field.isReadOnly,
-    // visibility: field.isVisible,
+    apiName: field.apiName,
+    errorMessage: field.errorMessage,
     isVisible: field.isVisible,
-    errorMessage: field.errorMessage || '',
+    readonly: field.isReadOnly,
+    required: field.isMandatory,
+    isCustomField: field.isCustomField,
+    maxLength: field.maxLength,
     lookup: field.lookup
   };
   return fieldModified;

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

@@ -21,8 +21,9 @@ class MyFormSuccessUseCase extends AbstractUseCase {
       sections
     } = myForm;
     const zFormEntity = repository.getFormEntity();
+    const layoutId = zFormEntity.getLayoutId();
     const context = { ...zFormEntity.getContext(),
-      layoutId: zFormEntity.getLayoutId()
+      layoutId: layoutId
     };
     const lookupFields = sections.flatMap(section => section.fields.filter(field => field.type === 'LookUp'));
     const sectionEntities = sections.map(section => {
@@ -63,24 +64,22 @@ class MyFormSuccessUseCase extends AbstractUseCase {
         type: DATA_SOURCE_EXECUTE,
         payload: {
           actionName: 'fetchLookupFields',
-          props: { ...context
-          }
+          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_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'fetchLookupFields'
+            }
+          },
           [DATA_SOURCE_SUCCESS]: {
             type: ZFORM_LOOKUP_FIELD_SUCCESS,
             metaData: {

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

@@ -21,6 +21,7 @@ export default class ZForm {
       dependencyMappings,
       context,
       focusedFieldName,
+      layoutId,
 
       /*hack*/
       isMyFormFetching,
@@ -45,6 +46,7 @@ export default class ZForm {
     this.dependencyMappings = dependencyMappings;
     this.context = context;
     this.focusedFieldName = focusedFieldName || null;
+    this.layoutId = layoutId;
     /*hack*/
 
     this.isMyFormFetching = isMyFormFetching;

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,7 @@ 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";
 const EMPTY_OBJECT = {};
 const EMPTY_ARRAY = [];
 
@@ -58,11 +59,10 @@ 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
@@ -123,22 +123,9 @@ export default class TableTranslator {
     const textOverflowData = {
       isEnabled: textOverflowConfig.isEnabled,
       mode: textOverflow.mode
-    }; // ComponentMapping support
-
-    zfield.componentMapping && zfield.componentMapping.length && zfield.componentMapping.forEach(fieldVariation => {
-      const {
-        fieldName,
-        uiType,
-        translator
-      } = fieldVariation;
-      const field = fields.find(f => f.name === fieldName);
-
-      if (field) {
-        field.uiType = uiType;
-      }
-    });
-    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, zfield.componentMapping && [...zfield.componentMapping] || []); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
+    };
+    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths, sortConfig, 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);
     // const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator(), actionTranslator.getTranslator()];
 
     const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator()];
@@ -153,7 +140,10 @@ export default class TableTranslator {
         isError,
         selection: SelectionTranslator(state),
         focussedRow: focussedIndex,
-        sortBy,
+        sortBy: sortConfig ? {
+          name: sortConfig.fieldName,
+          order: sortConfig.order === SortModelOrder.ASC ? SortedBy.Ascending : sortConfig.order === SortModelOrder.DES ? SortedBy.Descending : SortedBy.None
+        } : {},
         rowCursor,
         resizerState: ResizerStateTranslator({
           columnResizer: columnResizer,

package/es/platform/zlist/adapters/presenters/translators/ColumnTranslator.js

@@ -1,9 +1,23 @@
 import EmptyViewModel from "./EmptyViewModel";
 import * as FieldTranslators from "./fields";
 import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
-import { isValidFieldVariation } from "./FieldVariations";
 
-function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context, preferences, instanceName, moduleName, textOverflowConfig, nameFieldsConfig, recordReadStatusConfig, componentMapping) {
+//hacking temp url construction for lookup
+function getLookupUrlConstructions(_ref) {
+  let {
+    field,
+    value,
+    context
+  } = _ref;
+  let {
+    orgName,
+    departmentName
+  } = context;
+  let lookupModuleName = field?.lookup?.module?.apiName;
+  return `/agent/${orgName}/${departmentName}/${lookupModuleName}/details/${value.id}`;
+}
+
+function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context, preferences, instanceName, textOverflowConfig, moduleName, nameFieldsConfig, recordReadStatusConfig) {
   const {
     isCustomField,
     name,
@@ -18,6 +32,7 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     __DEVELOPMENT__ && console.warn(`The string format for componentMapping will soon be deprecated. Please update to the new JSON format. REF : ${JSON.stringify(fieldEntry)}`);
   }
 
+  let tempValue = undefined;
   let value = isCustomField ? record.cf?.[name] : record[name];
   const actions = ClientActionsTranslator.transform(fieldActions, instanceName, moduleName, {
     field,
@@ -28,12 +43,8 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     return EmptyViewModel(name);
   }
 
-  if (field.uiType && !isValidFieldVariation(type, field.uiType)) {
-    __DEVELOPMENT__ && console.warn(`The uiType ${field.uiType} is not a valid variation for field type ${type}. Ignoring the uiType.`);
-  }
-
-  if (typeof fieldEntry === 'string') {
-    field.uiType = fieldEntry;
+  if (fieldComponentMapping[name]) {
+    field.uiType = fieldComponentMapping[name];
   }
 
   let nameFieldTypes = ['Text'];
@@ -47,9 +58,22 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     return EmptyViewModel(name);
   }
 
+  if (field.type == "LookUp") {
+    // temp fix for when lookup field don't have value !object
+    tempValue = typeof value !== 'object' ? {
+      name: value,
+      id: value
+    } : value;
+    tempValue.url = getLookupUrlConstructions({
+      field,
+      value,
+      context
+    });
+  }
+
   const translatorArgs = {
     field,
-    value,
+    value: tempValue ? tempValue : value,
     appendToActionPayload: {
       recordId: record.id
     },
@@ -72,51 +96,31 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     ...fieldTranslator(translatorArgs)
   };
 
-  if (componentMapping && componentMapping.translator) {
-    return { ...viewModel,
-      ...componentMapping.translator({
-        viewModel,
+  if (fieldEntry && typeof fieldEntry === 'object') {
+    viewModel.type = fieldEntry.UIComponentName;
+
+    if (fieldEntry.fieldToUIComponentTranslator) {
+      viewModel.value = fieldEntry.fieldToUIComponentTranslator({
         field,
         record,
-        context,
-        preferences
-      })
-    };
-  } else {
-    //will be deprecated soon
-    if (fieldEntry && typeof fieldEntry === 'object') {
-      viewModel.type = fieldEntry.UIComponentName;
-
-      if (fieldEntry.fieldToUIComponentTranslator) {
-        viewModel.value = fieldEntry.fieldToUIComponentTranslator({
-          field,
-          record,
-          context
-        });
-      }
-
-      if (fieldEntry.translator) {
-        const newViewModel = fieldEntry.translator({
-          viewModel: viewModel,
-          field,
-          record,
-          context,
-          preferences
-        });
-        return { ...newViewModel,
-          type: fieldEntry.UIComponentName ? fieldEntry.UIComponentName : field.uiType,
-          appendToActionPayload: {
-            recordId: record.id,
-            ...newViewModel.appendToActionPayload
-          }
-        };
-      }
-
-      ;
+        context
+      });
+    }
+
+    if (fieldEntry.translator) {
+      const newViewModel = fieldEntry.translator({
+        viewModel,
+        field,
+        context
+      });
+      newViewModel.type = fieldEntry.UIComponentName;
+      return newViewModel;
     }
 
     return viewModel;
   }
+
+  return viewModel;
 }
 
 export default ColumnTranslator;

package/es/platform/zlist/adapters/presenters/translators/Header.js

@@ -1,9 +1,10 @@
 import { Alignment } from "../../../../../cc/table-list/data-types/Header";
 import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
-import { SortOrder } from "../../../../zlist/domain/entities/interfaces/Properties";
+import { SortModelOrder } from "../../../../zlist/domain/entities/interfaces/Properties";
 import { i18NProviderUtils } from '@zohodesk/i18n';
+import { SortOrder } from "../../../../../bc/zlist/Types";
 
-function HeaderTranslator(field, actions, context, modifiedWidths, sortBy, records, instanceName, moduleName) {
+function HeaderTranslator(field, actions, context, modifiedWidths, sortConfig, records, instanceName, moduleName) {
   const {
     id,
     name,
@@ -11,7 +12,7 @@ function HeaderTranslator(field, actions, context, modifiedWidths, sortBy, recor
     isSortable
   } = field;
   const newField = { ...field,
-    sort: translateSortBy(field.id, sortBy)
+    sort: translateSortBy(field.name, sortConfig)
   };
   const transformedActions = ClientActionsTranslator.transform(actions, instanceName, moduleName, { ...context,
     field: newField,
@@ -30,26 +31,33 @@ function HeaderTranslator(field, actions, context, modifiedWidths, sortBy, recor
 }
 
 export default HeaderTranslator;
+const defaultSortBy = {
+  name: '',
+  order: SortModelOrder.NONE,
+  // FIX: i18n key
+  tooltip: 'Click to Sort'
+};
 
-function translateSortBy(id, sortBy) {
-  const newSortBy = { ...sortBy,
-    tooltip: ''
-  };
+function translateSortBy(name, sortConfig) {
+  if (!sortConfig || !name || !sortConfig.fieldName) {
+    return defaultSortBy;
+  }
+
+  if (sortConfig.order === SortOrder.ASC) {
+    return {
+      name: sortConfig.fieldName,
+      order: SortModelOrder.ASC,
+      tooltip: i18NProviderUtils.getI18NValue('support.localization.tooltip.descending')
+    };
+  }
 
-  if (sortBy.id === id) {
-    if (sortBy.order === SortOrder.ASC) {
-      // newSortBy.tooltip = 'Click to Sort Descending';
-      newSortBy.tooltip = i18NProviderUtils.getI18NValue("support.localization.tooltip.descending");
-    } else if (newSortBy.order === SortOrder.DES) {
-      // newSortBy.tooltip = 'Click to Sort Ascending';
-      newSortBy.tooltip = i18NProviderUtils.getI18NValue("support.localization.tooltip.ascending");
-    } else if (newSortBy.order === SortOrder.NONE) {
-      newSortBy.tooltip = 'Click to Sort';
-    }
-  } else {
-    newSortBy.order = SortOrder.NONE;
-    newSortBy.tooltip = 'Click to Sort';
+  if (sortConfig.order === SortOrder.DES) {
+    return {
+      name: sortConfig.fieldName,
+      order: SortModelOrder.DES,
+      tooltip: i18NProviderUtils.getI18NValue('support.localization.tooltip.ascending')
+    };
   }
 
-  return newSortBy;
+  return defaultSortBy;
 }

package/es/platform/zlist/adapters/presenters/translators/HeadersTranslator.js

@@ -1,11 +1,11 @@
 import HeaderTranslator from "./Header";
 export default class HeadersTranslator {
-  constructor(fields, actions, context, modifiedWidths, sortBy, records, instanceName, moduleName) {
+  constructor(fields, actions, context, modifiedWidths, sortConfig, records, instanceName, moduleName) {
     this.fields = fields;
     this.actions = actions;
     this.context = context;
     this.modifiedWidths = modifiedWidths;
-    this.sortBy = sortBy;
+    this.sortConfig = sortConfig;
     this.records = records;
     this.instanceName = instanceName;
     this.moduleName = moduleName;
@@ -17,7 +17,7 @@ export default class HeadersTranslator {
       return [];
     }
 
-    return this.fields.map(field => HeaderTranslator(field, this.actions, this.context, this.modifiedWidths, this.sortBy, this.records, this.instanceName, this.moduleName));
+    return this.fields.map(field => HeaderTranslator(field, this.actions, this.context, this.modifiedWidths, this.sortConfig, this.records, this.instanceName, this.moduleName));
   }
 
   pipe(viewModel) {

package/es/platform/zlist/adapters/presenters/translators/Row.js

@@ -14,15 +14,14 @@ export default function RowTranslator(_ref) {
     textOverflowConfig,
     moduleName,
     nameFieldsConfig,
-    recordReadStatusConfig,
-    componentMapping
+    recordReadStatusConfig
   } = _ref;
   const actions = ClientActionsTranslator.transform(rowActions, instanceName, moduleName, { ...context,
     record
   });
   return {
     id: record.id,
-    columns: fields.map(field => ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context, preferences, instanceName, textOverflowConfig, moduleName, nameFieldsConfig, recordReadStatusConfig, componentMapping.find(item => item.fieldName === field.name))),
+    columns: fields.map(field => ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context, preferences, instanceName, textOverflowConfig, moduleName, nameFieldsConfig, recordReadStatusConfig)),
     rowActionLocation: {
       type: rowActionsUiType,
       actions

package/es/platform/zlist/adapters/presenters/translators/RowsTranslator.js

@@ -1,6 +1,6 @@
 import RowTranslator from "./Row";
 export default class RowsTranslator {
-  constructor(records, fields, rowActions, context, preferences, fieldComponentMapping, rowActionsUiType, fieldActions, instanceName, textOverflowConfig, moduleName, nameFieldsConfig, recordReadStatusConfig, componentMapping) {
+  constructor(records, fields, rowActions, context, preferences, fieldComponentMapping, rowActionsUiType, fieldActions, instanceName, textOverflowConfig, moduleName, nameFieldsConfig, recordReadStatusConfig) {
     this.records = records;
     this.fields = fields;
     this.rowActions = rowActions;
@@ -14,7 +14,6 @@ export default class RowsTranslator {
     this.moduleName = moduleName;
     this.nameFieldsConfig = nameFieldsConfig;
     this.recordReadStatusConfig = recordReadStatusConfig;
-    this.componentMapping = componentMapping;
     this.pipe = this.pipe.bind(this);
   }
 
@@ -24,7 +23,6 @@ export default class RowsTranslator {
     }
 
     return this.records.map(record => RowTranslator({
-      componentMapping: this.componentMapping,
       record,
       fields: this.fields,
       fieldComponentMapping: this.fieldComponentMapping,