@zohodesk/library-platform 1.0.1 → 1.0.2-exp.1.1

package/es/platform/zhttp/frameworks/ZHttpBehaviourFactory.js

@@ -1,9 +1,10 @@
+import Properties from "../../../bc/zhttp/Properties";
 import ActionsHandlersFactory from "./ActionsHandlerFactory";
 export default class ZHttpBehaviourFactory {
   static create() {
     const behaviour = {
       name: 'zhttp',
-      properties: {},
+      properties: Properties,
       setInitialState: () => ({}),
       eventHandlers: ActionsHandlersFactory.create(window.fetch.bind(window))
     };

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

@@ -0,0 +1,25 @@
+import AbstractController from "./AbstractController";
+
+class DeleteSuccessController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      dispatch,
+      action
+    } = event;
+    const {
+      recordId
+    } = action.payload;
+    const {
+      deleteSuccessUseCase
+    } = this.service;
+    deleteSuccessUseCase.updateDependency(state);
+    deleteSuccessUseCase.execute({
+      dispatch,
+      recordId
+    });
+  }
+
+}
+
+export default DeleteSuccessController;

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

@@ -0,0 +1,25 @@
+import AbstractController from "./AbstractController";
+
+class UpdateSuccessController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      dispatch,
+      action
+    } = event;
+    const {
+      recordId
+    } = action.payload;
+    const {
+      updateSuccessUseCase
+    } = this.service;
+    updateSuccessUseCase.updateDependency(state);
+    updateSuccessUseCase.execute({
+      dispatch,
+      recordId
+    });
+  }
+
+}
+
+export default UpdateSuccessController;

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

@@ -1,6 +1,6 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import ListFactory from "../../usecases/entities-factory/ListFactory";
+import ListFactory from "../../applications/entities-factory/ListFactory";
 
 class Repository {
   constructor() {
@@ -13,20 +13,23 @@ class Repository {
 
   getList() {
     const {
-      limit,
       sortBy,
-      filter,
-      moduleName
+      departmentId,
+      viewId,
+      moduleName,
+      query,
+      context
     } = this.state.properties;
     const list = ListFactory.createList({
-      filter: { ...filter,
-        departmentId: filter.departmentId,
-        viewId: filter.viewId,
-        orgId: filter.orgId,
-        moduleName
+      context,
+      query: {
+        departmentId,
+        viewId,
+        moduleName,
+        ...query
       },
       sortBy,
-      limit
+      limit: 50
     });
     return list;
   }

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

@@ -1,15 +1,17 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import InitializeUseCase from "../../usecases/interactors/InitializeUseCase";
-import PropertiesChangeUseCase from "../../usecases/interactors/PropertiesChangeUseCase";
-import FetchMoreUseCase from "../../usecases/interactors/FetchMoreUseCase";
-import FieldChangeUseCase from "../../usecases/interactors/FieldChangeUseCase";
-import DeleteMultipleRecordUseCase from "../../usecases/interactors/DeleteMultipleRecordUseCase";
-import SortUseCase from "../../usecases/interactors/SortUseCase";
-import RecordUpdateUseCase from "../../usecases/interactors/RecordUpdateUseCase";
-import DeleteSingleRecordUseCase from "../../usecases/interactors/DeleteSingleRecordUseCase";
-import RecordExecuteSucceededUseCase from "../../usecases/interactors/RecordExecuteSucceededUseCase";
-import RecordExecuteFailedUseCase from "../../usecases/interactors/RecordExecuteFailedUseCase";
+import InitializeUseCase from "../../applications/usecases/InitializeUseCase";
+import PropertiesChangeUseCase from "../../applications/usecases/PropertiesChangeUseCase";
+import FetchMoreUseCase from "../../applications/usecases/FetchMoreUseCase";
+import FieldChangeUseCase from "../../applications/usecases/FieldChangeUseCase";
+import DeleteMultipleRecordUseCase from "../../applications/usecases/DeleteMultipleRecordUseCase";
+import SortUseCase from "../../applications/usecases/SortUseCase";
+import RecordUpdateUseCase from "../../applications/usecases/RecordUpdateUseCase";
+import DeleteSingleRecordUseCase from "../../applications/usecases/DeleteSingleRecordUseCase";
+import RecordExecuteSucceededUseCase from "../../applications/usecases/RecordExecuteSucceededUseCase";
+import RecordExecuteFailedUseCase from "../../applications/usecases/RecordExecuteFailedUseCase";
+import UpdateSuccessUseCase from "../../applications/usecases/UpdateSuccessUseCase";
+import DeleteSuccessUseCase from "../../applications/usecases/DeleteSuccessUseCase";
 
 class Service {
   constructor(dependencies) {
@@ -35,6 +37,10 @@ class Service {
 
     _defineProperty(this, "recordUpdateUseCase", void 0);
 
+    _defineProperty(this, "updateSuccessUseCase", void 0);
+
+    _defineProperty(this, "deleteSuccessUseCase", void 0);
+
     this.initializeUseCase = new InitializeUseCase(this.dependencies);
     this.propertiesChangeUseCase = new PropertiesChangeUseCase(this.dependencies);
     this.fetchMoreUseCase = new FetchMoreUseCase(this.dependencies);
@@ -45,6 +51,8 @@ class Service {
     this.recordExecuteSucceededUseCase = new RecordExecuteSucceededUseCase(this.dependencies);
     this.recordExecuteFailedUseCase = new RecordExecuteFailedUseCase(this.dependencies);
     this.recordUpdateUseCase = new RecordUpdateUseCase(this.dependencies);
+    this.updateSuccessUseCase = new UpdateSuccessUseCase(this.dependencies);
+    this.deleteSuccessUseCase = new DeleteSuccessUseCase(this.dependencies);
   }
 
 }

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

@@ -1,32 +1,56 @@
 /* eslint-disable max-lines-per-function */
+import { Width as ColumnWidth } from "../../../../cc/table-list/data-types/Header";
 import HeadersTranslator from "./translators/HeadersTranslator";
 import RowsTranslator from "./translators/RowsTranslator";
 import Pipeline from "./utils/Pipeline";
+import RowCursor from "../../../../cc/table-list/data-types/RowCursor";
+import { TableListConstants } from "../../../../cc/table-list";
+import { ResizerStateTranslator } from "./translators/ResizerStateTranslator";
+import { calculateFieldWidths } from "./utils/calculateFieldWidths";
+const EMPTY_OBJECT = {};
 
 const fallbackToDefault = (value, defaultValue) => [undefined, null].includes(value) ? defaultValue : value;
 
 export default class TableTranslator {
   static transformState(state) {
+    var _localStorageBehaviou, _localStorageBehaviou2;
+
     const {
       behaviours,
       properties
     } = state;
     const {
-      uiMapping,
-      rowActions,
-      pageContext
+      componentMapping,
+      context
     } = properties;
+    const {
+      localStorage: localStorageBehaviour,
+      columnResizer
+    } = behaviours;
+    const {
+      resizeConfig,
+      preferences
+    } = properties;
+    context['servicePrefix'] = 'supportapi/zd'; // FIX: servicePrefix defaultValue should be available from properties
+
     const {
       zrecord,
-      zfield
+      zfield,
+      zclientAction
     } = fallbackToDefault(behaviours, {}); // FIX: behaviours should be available by default
 
     const {
       records,
       isFetching: isRecordsFetching
-    } = fallbackToDefault(zrecord, {}); // FIX: zrecord should be available by default
+    } = fallbackToDefault(zrecord, {}); // FIX: zrecord should be available by defau
+
+    const {
+      clientActions,
+      isFetching: isClientActionsFetching
+    } = fallbackToDefault(zclientAction, {}); // FIX: zclientAction should be available by defaultlt
 
-    const fieldUiMapping = uiMapping.fields;
+    const fieldComponentMapping = componentMapping.fields;
+    const rowActionsUiType = componentMapping.rowActionsComponentName;
     const {
       fields: availableFields,
       selectedFields,
@@ -36,18 +60,63 @@ export default class TableTranslator {
 
     const isLoading = !!(isRecordsFetching || isAvailableFieldsFetching || isSelectedFieldsFetching);
     const fields = selectedFields === null || selectedFields === void 0 ? void 0 : selectedFields.map(selectedField => availableFields === null || availableFields === void 0 ? void 0 : availableFields.find(availableField => availableField.name === selectedField)).filter(f => f != undefined);
-    const headersTranslator = new HeadersTranslator(fields);
-    const rowsTranslator = new RowsTranslator(records, fields, rowActions, pageContext, fieldUiMapping);
-    const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator()]; // TODO: Implement ModuleTableModel, and move data and isLoading to tableViewModel Object
+    const {
+      headerActions,
+      fieldActions,
+      rowActions,
+      noLocation
+    } = mapClientActions(clientActions || []);
+    const isRowClickable = noLocation.some(action => action.uiComponentMapping.eventMappings.some(mapping => mapping.sourceEvent === TableListConstants.TABLE_LIST_ROW_CLICKED));
+    const rowCursor = isRowClickable ? RowCursor.Pointer : RowCursor.Default;
+    const {
+      moduleName,
+      viewId
+    } = properties; // TODO: move this to a separate file as selector
+
+    const localStorageFieldWidths = fallbackToDefault(localStorageBehaviour === null || localStorageBehaviour === void 0 ? void 0 : (_localStorageBehaviou = localStorageBehaviour[moduleName]) === null || _localStorageBehaviou === void 0 ? void 0 : (_localStorageBehaviou2 = _localStorageBehaviou[viewId]) === null || _localStorageBehaviou2 === void 0 ? void 0 : _localStorageBehaviou2.modifiedWidths, EMPTY_OBJECT);
+    const modifiedWidths = calculateFieldWidths(fields, localStorageFieldWidths, preferences);
+    const headersTranslator = new HeadersTranslator(fields, headerActions, context, modifiedWidths);
+    const rowsTranslator = new RowsTranslator(records, fields, rowActions, context, fieldComponentMapping, rowActionsUiType, fieldActions); // const actionTranslator = new ClientActionsTranslator(clientActions, records, fields, pageContext);
+    // const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator(), actionTranslator.getTranslator()];
+
+    const translators = [headersTranslator.getTranslator(), rowsTranslator.getTranslator()];
+    const data = Pipeline.run(translators, {}); // TODO: Implement ModuleTableModel, and move data and isLoading to tableViewModel Object
 
     return {
       properties,
       behaviours,
-      hasRowActions: Boolean(rowActions === null || rowActions === void 0 ? void 0 : rowActions.length),
+      selection: behaviours === null || behaviours === void 0 ? void 0 : behaviours.selection,
+      rowCursor,
+      resizerState: ResizerStateTranslator({
+        columnResizer: columnResizer,
+        resizeConfig: resizeConfig,
+        headerNames: selectedFields,
+        modifiedWidths
+      }),
+      rowActionsConfig: {
+        hasActions: Boolean(rowActions === null || rowActions === void 0 ? void 0 : rowActions.length),
+        // Boolean(newRowActions?.length),
+        columnWidth: ColumnWidth.XSmall
+      },
       isLoading,
-      emptyStateUiType: uiMapping.emptyState || '',
-      data: Pipeline.run(translators, {})
+      emptyStateUiType: componentMapping.emptyState || '',
+      data
     };
   }
 
+}
+
+function mapClientActions(clientActions) {
+  const allowedActingLocations = ['header_actions', 'field_actions', 'row_actions', null];
+  clientActions.forEach(action => {
+    if (!allowedActingLocations.includes(action.location)) {
+      console.warn('Client action without location:', action.location);
+    }
+  });
+  return {
+    headerActions: clientActions.filter(action => action.location && action.location === 'header_actions'),
+    fieldActions: clientActions.filter(action => action.location && action.location === 'field_actions'),
+    rowActions: clientActions.filter(action => action.location && action.location === 'row_actions'),
+    noLocation: clientActions.filter(action => !action.location)
+  };
 }

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

@@ -0,0 +1,11 @@
+import { Alignment } from "../../../../../cc/table-list/data-types/Header";
+
+function ColumnAlignmentTranslator(type) {
+  if (type === 'Boolean') {
+    return Alignment.Center;
+  } else {
+    return Alignment.Left;
+  }
+}
+
+export default ColumnAlignmentTranslator;

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

@@ -0,0 +1,23 @@
+import { Width } from "../../../../../cc/table-list/data-types/Header";
+const columnSizeMapping = {
+  Multiselect: Width.XXLarge,
+  Email: Width.XLarge,
+  Boolean: Width.Medium,
+  Number: Width.Medium,
+  Decimal: Width.Medium,
+  Currency: Width.Medium,
+  Date: Width.Medium,
+  Percent: Width.Medium
+};
+
+function ColumnSizeTranslator(type) {
+  const columnSize = columnSizeMapping[type];
+
+  if (columnSize) {
+    return columnSize;
+  }
+
+  return Width.Large;
+}
+
+export default ColumnSizeTranslator;

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

@@ -1,7 +1,8 @@
 import EmptyViewModel from "./EmptyViewModel";
 import * as FieldTranslators from "./fields";
+import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
 
-function ColumnTranslator(field, record, fieldUiMapping) {
+function ColumnTranslator(field, record, fieldComponentMapping, fieldActions) {
   var _record$cf;
 
   const {
@@ -10,25 +11,32 @@ function ColumnTranslator(field, record, fieldUiMapping) {
     type
   } = field;
   const value = isCustomField ? (_record$cf = record.cf) === null || _record$cf === void 0 ? void 0 : _record$cf[name] : record[name];
+  const actions = ClientActionsTranslator.transform(fieldActions, {
+    field,
+    record
+  });
 
   if (!value && value !== false) {
-    return EmptyViewModel(type);
+    return EmptyViewModel();
   }
 
-  if (fieldUiMapping[name]) {
-    field.uiType = fieldUiMapping[name];
+  if (fieldComponentMapping[name]) {
+    field.uiType = fieldComponentMapping[name];
   }
 
   const fieldTranslator = FieldTranslators[type];
 
   if (!fieldTranslator) {
     console.error(`Field type ${type} not supported`);
-    return EmptyViewModel(type);
+    return EmptyViewModel();
   }
 
-  return fieldTranslator(field, value, {
-    recordId: record.id
-  });
+  return {
+    actions,
+    ...fieldTranslator(field, value, {
+      recordId: record.id
+    })
+  };
 }
 
 export default ColumnTranslator;

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

@@ -1,6 +1,7 @@
-import { Alignment, Size } from "../../../../../cc/table-list/data-types/Header";
+import ColumnAlignmentTranslator from "./ColumnAlignmentTranslator";
+import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
 
-function HeaderTranslator(field) {
+function HeaderTranslator(field, actions, context, modifiedWidths) {
   const {
     id,
     name,
@@ -8,13 +9,18 @@ function HeaderTranslator(field) {
     isSortable,
     type
   } = field;
+  const transformedActions = ClientActionsTranslator.transform(actions, { ...context,
+    field
+  });
+  const width = modifiedWidths[name];
   return {
     id: id,
     name: name,
     text: displayLabel,
     sortable: isSortable,
-    alignment: type === 'Boolean' ? Alignment.Center : Alignment.Left,
-    size: Size.Large
+    alignment: ColumnAlignmentTranslator(type),
+    width,
+    actions: transformedActions
   };
 }
 

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

@@ -1,7 +1,10 @@
 import HeaderTranslator from "./Header";
 export default class HeadersTranslator {
-  constructor(fields) {
+  constructor(fields, actions, context, modifiedWidths) {
     this.fields = fields;
+    this.actions = actions;
+    this.context = context;
+    this.modifiedWidths = modifiedWidths;
     this.pipe = this.pipe.bind(this);
   }
 
@@ -10,7 +13,7 @@ export default class HeadersTranslator {
       return [];
     }
 
-    return this.fields.map(field => HeaderTranslator(field));
+    return this.fields.map(field => HeaderTranslator(field, this.actions, this.context, this.modifiedWidths));
   }
 
   pipe(viewModel) {

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

@@ -0,0 +1,98 @@
+const defaultResizerUiState = {
+  isEnabled: false,
+  isCurrentlyResizing: false,
+  currentlyResizingColumn: '',
+  extraWidth: 0,
+  initialPosition: 0,
+  resizedPosition: 0,
+  tooltip: ''
+};
+export function ResizerStateTranslator(_ref) {
+  let {
+    columnResizer,
+    resizeConfig,
+    headerNames,
+    modifiedWidths
+  } = _ref;
+  const {
+    isEnabled: isEnabled,
+    minWidth,
+    maxWidth
+  } = resizeConfig;
+
+  if (!columnResizer || !headerNames || headerNames.length === 0) {
+    return { ...defaultResizerUiState,
+      isEnabled
+    };
+  }
+
+  const {
+    isResizing,
+    allowedWidth,
+    columnName,
+    initialPosition,
+    resizedPosition
+  } = columnResizer.resizerState; // const extraWidth = allowedWidth - (resizedPosition - initialPosition);
+  // MUST: be calculated based on the columnName and modifiedWidths
+
+  const extraWidth = calculateExtraSpaceWidth({
+    headerNames,
+    modifiedWidths,
+    columnName,
+    maxWidth
+  });
+  const tooltip = tooltipI18nHandler({
+    minWidth,
+    maxWidth,
+    width: allowedWidth
+  });
+  return {
+    isEnabled,
+    isCurrentlyResizing: isResizing,
+    currentlyResizingColumn: columnName,
+    extraWidth,
+    initialPosition,
+    resizedPosition,
+    tooltip
+  };
+}
+
+function tooltipI18nHandler(_ref2) {
+  let {
+    minWidth,
+    maxWidth,
+    width
+  } = _ref2;
+
+  if (width === maxWidth) {
+    // return `Max width (${width}px) reached`;
+    return `Max Limit Reached ${width}`;
+  }
+
+  if (width === minWidth) {
+    // return `Min width (${width}px) reached`;
+    return `Min Limit Reached ${width}`;
+  } // return `Width: ${width}px`;
+
+
+  return `Width - ${width}px`;
+}
+
+function calculateExtraSpaceWidth(_ref3) {
+  let {
+    headerNames,
+    modifiedWidths,
+    columnName,
+    maxWidth
+  } = _ref3;
+  const index = headerNames.indexOf(columnName);
+
+  if (index === -1) {
+    return 0;
+  }
+
+  const resizableSpace = headerNames.slice(index + 1).reduce((resizableSpace, columnName) => {
+    return resizableSpace + modifiedWidths[columnName];
+  }, 0);
+  return Math.max(0, maxWidth - resizableSpace);
+}

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

@@ -1,16 +1,24 @@
 import ColumnTranslator from "./ColumnTranslator";
-import RowActionTranslator from "./RowActionTranslator";
+import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
 export default function RowTranslator(_ref) {
   let {
     record,
     fields,
-    fieldUiMapping,
+    fieldComponentMapping,
+    rowActionsUiType,
     rowActions,
-    pageContext
+    fieldActions,
+    context
   } = _ref;
+  const actions = ClientActionsTranslator.transform(rowActions, { ...context,
+    record
+  });
   return {
     id: record.id,
-    columns: fields.map(field => ColumnTranslator(field, record, fieldUiMapping)),
-    rowActions: rowActions.map(rowAction => RowActionTranslator(rowAction, record, pageContext))
+    columns: fields.map(field => ColumnTranslator(field, record, fieldComponentMapping, fieldActions)),
+    rowActionLocation: {
+      type: rowActionsUiType,
+      actions
+    }
   };
 }

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

@@ -1,25 +1,32 @@
-import TemplateHelpers from "../../../../zdata-broker/adapters/gateways/TemplateHelpers";
-export default function RowActionTranslator(rowAction, record, pageContext) {
+import TemplateHelpers from "../../../../zdata-source/adapters/gateways/TemplateHelpers";
+const templateHelpers = new TemplateHelpers();
+export default function RowActionTranslator(rowAction, record, context) {
+  const templateContext = {
+    orgName: context.orgName,
+    departmentName: context.departmentName,
+    moduleSanitatedName: context.moduleSanitatedName,
+    record,
+    moduleName: context.moduleName,
+    recordId: record.id
+  };
+  const properties = PropertiesTranslator(rowAction.properties, templateContext);
   return {
     type: rowAction.uiType,
-    eventMappings: EventMappingTranslator(rowAction.eventMapping, record, pageContext),
-    properties: rowAction.properties
+    eventMappings: EventMappingTranslator(rowAction.eventMapping, templateContext),
+    properties
   };
 }
-const templateHelpers = new TemplateHelpers();
 
-function EventMappingTranslator(eventMapping, record, pageContext) {
+function PropertiesTranslator(properties, templateContext) {
+  return templateHelpers.replaceTemplateVariablesInObject(properties, templateContext);
+}
+
+function EventMappingTranslator(eventMapping, templateContext) {
   return eventMapping.map(eventMapping => {
     return {
       action: eventMapping.action,
       eventType: eventMapping.eventType,
-      payload: JSON.parse(templateHelpers.replaceTemplateVariables(eventMapping.payloadMapping, {
-        orgName: pageContext.orgName,
-        departmentName: pageContext.departmentName,
-        moduleSanitatedName: pageContext.moduleSanitatedName,
-        moduleName: pageContext.moduleName,
-        recordId: record.id
-      }))
+      payload: JSON.parse(templateHelpers.replaceTemplateVariables(eventMapping.payloadMapping, templateContext))
     };
   });
 }

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

@@ -1,11 +1,13 @@
 import RowTranslator from "./Row";
 export default class RowsTranslator {
-  constructor(records, fields, rowActions, pageContext, fieldUiMapping) {
+  constructor(records, fields, rowActions, context, fieldComponentMapping, rowActionsUiType, fieldActions) {
     this.records = records;
     this.fields = fields;
     this.rowActions = rowActions;
-    this.pageContext = pageContext;
-    this.fieldUiMapping = fieldUiMapping;
+    this.context = context;
+    this.fieldComponentMapping = fieldComponentMapping;
+    this.rowActionsUiType = rowActionsUiType;
+    this.fieldActions = fieldActions;
     this.pipe = this.pipe.bind(this);
   }
 
@@ -17,9 +19,11 @@ export default class RowsTranslator {
     return this.records.map(record => RowTranslator({
       record,
       fields: this.fields,
-      fieldUiMapping: this.fieldUiMapping,
+      fieldComponentMapping: this.fieldComponentMapping,
+      rowActionsUiType: this.rowActionsUiType,
       rowActions: this.rowActions,
-      pageContext: this.pageContext
+      fieldActions: this.fieldActions,
+      context: this.context
     }));
   }