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

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

@@ -0,0 +1,51 @@
+const getSingleRecord = {
+  name: 'records',
+  api: '/{{servicePrefix}}/{{orgName}}/api/v1/{{moduleName}}/{{recordId}}',
+  parameters: `{}`,
+  // parameters: `{ "include": "{{include}}" }`,
+  type: 'GET',
+  transformer: data => data,
+  properties: {
+    servicePrefix: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    orgName: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    // include: {
+    //   required: false,
+    //   typeMetadata: {
+    //     schema: {
+    //       type: 'string'
+    //     }
+    //   }
+    // },
+    moduleName: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    },
+    recordId: {
+      required: true,
+      typeMetadata: {
+        schema: {
+          type: 'string'
+        }
+      }
+    }
+  }
+};
+export default getSingleRecord;

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

@@ -21,6 +21,7 @@ import fetchLookupFields from "./http-template/fetchLookupFields";
 import getClientScripts from "./http-template/getClientScripts";
 import markAsRead from "./http-template/markAsRead";
 import markAsUnRead from "./http-template/markAsUnRead";
+import getComponentMapping from "./http-template/getComponentMapping";
 let dataSource = {
   httpTemplates: {
     [RecordApiActionName.GET_RECORDS]: getRecords,
@@ -42,7 +43,8 @@ let dataSource = {
     [ZFormApiActionName.getLayoutRules]: getLayoutRules,
     [ZFormApiActionName.getDependencyMappings]: getDependencyMappings,
     [ZFormApiActionName.getValidationRules]: getValidationRules,
-    [ZFormApiActionName.fetchLookupFields]: fetchLookupFields
+    [ZFormApiActionName.fetchLookupFields]: fetchLookupFields,
+    getComponentMapping
   }
 };
 export default dataSource; // let ticketsRecordSerice = createRecord(tickets, () => {});

package/es/platform/zfield/applications/usecases/FetchSuccessUseCase.js

@@ -1,4 +1,6 @@
+import { DATA_SOURCE_EXECUTE } from "../../../../bc/zdata-source/Constants";
 import AbstractUseCase from "./AbstractUseCase";
+import { DATA_SOURCE_FAILURE, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_SUCCESS } from "../../../../bc/zdata-source/Symbols";
 
 class FetchSuccessUseCase extends AbstractUseCase {
   execute(input) {
@@ -16,6 +18,11 @@ class FetchSuccessUseCase extends AbstractUseCase {
     } = metaData;
     const fieldManager = repository.getFieldManager();
 
+    if (String(apiName) === 'getComponentMapping') {
+      fieldManager.setFields(fields, apiName);
+      presenter.updateFields(fieldManager.toObject());
+    }
+
     if (!fieldManager.isFieldFetching(metaData)) {
       return;
     }
@@ -23,6 +30,32 @@ class FetchSuccessUseCase extends AbstractUseCase {
     fieldManager.setFields(fields, apiName);
     fieldManager.stopFetching(apiName);
     presenter.updateFields(fieldManager.toObject());
+    dispatch({
+      type: DATA_SOURCE_EXECUTE,
+      payload: {
+        props: {},
+        actionName: 'getComponentMapping'
+      },
+      metaData: {
+        actionName: 'getComponentMapping',
+        [DATA_SOURCE_SUCCESS]: {
+          metaData: {
+            apiName: 'getComponentMapping'
+          }
+        },
+        [DATA_SOURCE_NO_CONTENT]: {
+          metaData: {
+            apiName: 'getComponentMapping'
+          }
+        },
+        [DATA_SOURCE_FAILURE]: {
+          metaData: {
+            apiName: 'getComponentMapping',
+            actionName: 'getComponentMapping'
+          }
+        }
+      }
+    });
     dispatch(fieldManager.createSuccessAction(fields, metaData));
   }
 

package/es/platform/zfield/domain/entities/fields-manager/FieldsManager.js

@@ -5,10 +5,12 @@ import { DATA_SOURCE_FAILURE, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_SUCCESS } from
 
 class FieldManager {
   constructor(fields, selectedFields, isFieldsFetching, isSelectedFieldsFetching) {
+    let componentMapping = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     this.fields = fields;
     this.selectedFields = selectedFields;
     this.isFieldsFetching = isFieldsFetching;
     this.isSelectedFieldsFetching = isSelectedFieldsFetching;
+    this.componentMapping = componentMapping;
   }
 
   createSuccessAction(fields, metaData) {
@@ -98,11 +100,14 @@ class FieldManager {
       this.selectedFields = data;
     } else if (apiName === FieldApiName.UPDATE_SELECTED_FIELDS) {
       this.selectedFields = data;
+    } else if (apiName === 'getComponentMapping') {
+      this.componentMapping = data;
     }
   }
 
   toObject() {
     return {
+      componentMapping: this.componentMapping,
       fields: this.fields,
       selectedFields: this.selectedFields,
       isFieldsFetching: this.isFieldsFetching,

package/es/platform/zform/adapters/controllers/GetInitialRecordSuccessController.js

@@ -0,0 +1,31 @@
+import AbstractController from "./AbstractController";
+
+class GetInitialRecordSuccessController extends AbstractController {
+  handle(event) {
+    const {
+      getInitialRecordSuccessUseCase
+    } = this.service;
+    let {
+      state,
+      updateState,
+      action,
+      dispatch
+    } = event;
+    const {
+      disableValidationRule,
+      disableLayoutRule,
+      disableDependencyMapping
+    } = state.properties;
+    getInitialRecordSuccessUseCase.updateDependency(state, updateState);
+    getInitialRecordSuccessUseCase.execute({
+      dispatch,
+      record: action.payload.response,
+      disableValidationRule,
+      disableLayoutRule,
+      disableDependencyMapping
+    });
+  }
+
+}
+
+export default GetInitialRecordSuccessController;

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

@@ -25,8 +25,7 @@ class FormRepository {
       validationRules = [],
       sections = [],
       layoutRules = [],
-      dependencyMappings = [],
-      layoutId
+      dependencyMappings = []
     } = zform;
     let validationRuleEntities = validationRules.map(rule => {
       return new ZValidationRule(rule);
@@ -60,7 +59,6 @@ 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,21 +5,20 @@ const LookUpFieldTranslator = _ref => {
     fieldPreModified,
     uiConfig
   } = _ref;
-  const fieldModified = { ...fieldPreModified,
-    uiConfig: uiConfig,
-    type: type,
-    fieldType: field.type,
-    value: field.value,
-    name: field.name,
+  const fieldModified = {
+    type,
+    uiConfig,
+    value: field.value || '',
+    //state.behaviours.zform.values[field.apiName],
+    name: field.apiName,
+    ...fieldPreModified,
     id: field.id,
     label: field.i18NLabel,
-    apiName: field.apiName,
-    errorMessage: field.errorMessage,
-    isVisible: field.isVisible,
-    readonly: field.isReadOnly,
     required: field.isMandatory,
-    isCustomField: field.isCustomField,
-    maxLength: field.maxLength,
+    readonly: field.isReadOnly,
+    // visibility: field.isVisible,
+    isVisible: field.isVisible,
+    errorMessage: field.errorMessage || '',
     lookup: field.lookup
   };
   return fieldModified;

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

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

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

@@ -0,0 +1,132 @@
+import AbstractUseCase from "./AbstractUseCase";
+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, DATA_SOURCE_NO_CONTENT, DATA_SOURCE_FAILURE } from "../../../../bc/zdata-source/Symbols";
+
+class GetInitialRecordSuccessUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      disableValidationRule,
+      disableLayoutRule,
+      disableDependencyMapping
+    } = input;
+    const {
+      dispatch,
+      record
+    } = input;
+    const zformEntity = this.dependencies.repository.getFormEntity();
+    zformEntity.setInitialRecord(record);
+    const context = { ...zformEntity.getContext(),
+      layoutId: zformEntity.getLayoutId()
+    };
+    dispatch({
+      type: DATA_BROKER_EXECUTE,
+      payload: {
+        actionName: "getMyForm",
+        props: context
+      },
+      metaData: {
+        actionName: "getMyForm",
+        //hack
+        initialRecordData: record,
+        // Store record data here for later use
+        [DATA_SOURCE_NO_CONTENT]: {
+          type: ZFORM_MY_FORM_SUCCESS,
+          metaData: {
+            actionName: "getMyForm",
+            initialRecordData: record
+          }
+        },
+        //hack
+        [DATA_SOURCE_FAILURE]: {
+          type: ZFORM_API_FAILURE,
+          metaData: {
+            actionName: 'getMyForm'
+          }
+        },
+        [DATA_SOURCE_SUCCESS]: {
+          type: ZFORM_MY_FORM_SUCCESS,
+          metaData: {
+            actionName: "getMyForm",
+            initialRecordData: record
+          }
+        }
+      }
+    });
+
+    if (!disableDependencyMapping) {
+      dispatch({
+        type: DATA_BROKER_EXECUTE,
+        payload: {
+          actionName: "getDependencyMappings",
+          props: context
+        },
+        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: "getLayoutRules",
+          props: { ...context,
+            activeRulesOnly: true
+          }
+        },
+        metaData: {
+          actionName: "getLayoutRules",
+          //hack
+          [DATA_SOURCE_NO_CONTENT]: {
+            type: ZFORM_LAYOUT_RULES_SUCCESS,
+            metaData: {
+              actionName: "getLayoutRules"
+            }
+          },
+          [DATA_SOURCE_FAILURE]: {
+            type: ZFORM_API_FAILURE,
+            metaData: {
+              actionName: 'getLayoutRules'
+            }
+          },
+          [DATA_SOURCE_SUCCESS]: {
+            type: ZFORM_LAYOUT_RULES_SUCCESS,
+            metaData: {
+              actionName: "getLayoutRules"
+            }
+          }
+        }
+      });
+    } else {
+      zformEntity.setLayoutRulesFetching(false);
+    }
+
+    this.dependencies.presenter.updateFormResponse(zformEntity.toObject());
+  }
+
+}
+
+export default GetInitialRecordSuccessUseCase;

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

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

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

@@ -21,7 +21,6 @@ export default class ZForm {
       dependencyMappings,
       context,
       focusedFieldName,
-      layoutId,
 
       /*hack*/
       isMyFormFetching,
@@ -46,7 +45,6 @@ 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/presenters/TableTranslator.js

@@ -35,7 +35,8 @@ export default class TableTranslator {
       localStorage: localStorageBehaviour,
       columnResizer,
       keyboardControls,
-      textOverflow
+      textOverflow,
+      floatPagination
     } = behaviours;
     const {
       resizeConfig,
@@ -43,7 +44,8 @@ export default class TableTranslator {
       keyboardControlsConfig,
       nameFieldsConfig,
       textOverflowConfig,
-      recordReadStatusConfig
+      recordReadStatusConfig,
+      floatPaginationConfig
     } = properties;
     const {
       modules
@@ -82,7 +84,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 +124,37 @@ export default class TableTranslator {
     const textOverflowData = {
       isEnabled: textOverflowConfig.isEnabled,
       mode: textOverflow.mode
-    };
+    }; // 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(recordsForDisplay, fields, rowActions, context, preferences, fieldComponentMapping, rowActionsUiType, fieldActions, instanceName, textOverflowData, moduleName, nameFieldsConfig, recordReadStatusConfig); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
+    const rowsTranslator = new RowsTranslator(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()];
@@ -158,9 +187,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

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

@@ -1,23 +1,23 @@
 import EmptyViewModel from "./EmptyViewModel";
 import * as FieldTranslators from "./fields";
 import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
+import { isValidFieldVariation } from "./FieldVariations";
 
-//hacking temp url construction for lookup
-function getLookupUrlConstructions(_ref) {
+function ColumnTranslator(_ref) {
   let {
     field,
-    value,
-    context
+    record,
+    fieldComponentMapping,
+    fieldActions,
+    context,
+    preferences,
+    instanceName,
+    moduleName,
+    textOverflowConfig,
+    nameFieldsConfig,
+    recordReadStatusConfig,
+    componentMapping
   } = _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,
@@ -32,7 +32,6 @@ 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,
@@ -43,8 +42,12 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     return EmptyViewModel(name);
   }
 
-  if (fieldComponentMapping[name]) {
-    field.uiType = fieldComponentMapping[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;
   }
 
   let nameFieldTypes = ['Text'];
@@ -58,22 +61,9 @@ 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: tempValue ? tempValue : value,
+    value,
     appendToActionPayload: {
       recordId: record.id
     },
@@ -96,31 +86,49 @@ function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, co
     ...fieldTranslator(translatorArgs)
   };
 
-  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({
+  if (componentMapping && componentMapping.translator) {
+    return { ...viewModel,
+      ...componentMapping.translator({
         viewModel,
         field,
-        context
-      });
-      newViewModel.type = fieldEntry.UIComponentName;
-      return newViewModel;
+        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
+          }
+        };
+      }
     }
 
     return viewModel;
   }
-
-  return viewModel;
 }
 
 export default ColumnTranslator;