@zohodesk/library-platform 1.1.1 → 1.1.2-exp.0

package/es/platform/zlist/adapters/presenters/translators/fields/MultiSelectFieldTranslator.js

@@ -1,24 +1,44 @@
 import FieldTypes from "../../../../../../cc/fields/field/Types";
 import MultiListFieldModel from "../../../../../../cc/fields/multi-select/Model";
+import ColouredMultiListFieldModel from "../../../../../../cc/fields/coloured-multi-select/Model";
 
 const MultiSelectFieldTranslator = (field, value, appendToActionPayload) => {
   const {
     uiType,
-    name
+    name,
+    subType,
+    pickListValues
   } = field;
-  const updatedValue = value.split(';').map(item => {
-    if (item === '') {
-      return '-None-';
-    }
+  const updatedValue = value.split(';').map(item => item === '' ? '-None-' : item);
+
+  if (['colored', 'ColorCoded'].includes(subType)) {
+    return ColouredMultiSelectFieldTranslator(field, updatedValue, appendToActionPayload);
+  }
 
-    return item;
-  });
   return MultiListFieldModel({
     uiType: uiType || FieldTypes.MultiSelectField,
     appendToActionPayload,
     name,
+    options: pickListValues,
     value: updatedValue
   });
 };
 
-export default MultiSelectFieldTranslator;
+export default MultiSelectFieldTranslator;
+
+const ColouredMultiSelectFieldTranslator = (field, value, appendToActionPayload) => {
+  const {
+    uiType,
+    name,
+    pickListValues
+  } = field;
+  return ColouredMultiListFieldModel({
+    uiType: uiType || FieldTypes.ColouredMultiSelectField,
+    appendToActionPayload,
+    name,
+    options: pickListValues.map(option => ({ ...option,
+      colorCode: option.colorCode || ''
+    })),
+    value
+  });
+};

package/es/platform/zlist/adapters/presenters/translators/fields/PickListFieldTranslator.js

@@ -1,17 +1,43 @@
 import FieldTypes from "../../../../../../cc/fields/field/Types";
 import PickListFieldModel from "../../../../../../cc/fields/pick-list/Model";
+import ColouredPickListFieldModel from "../../../../../../cc/fields/coloured-pick-list/Model";
 
 const PickListFieldTranslator = (field, value, appendToActionPayload) => {
   const {
     uiType,
-    name
+    name,
+    pickListValues,
+    subType
   } = field;
+
+  if (['colored', 'ColorCoded'].includes(subType)) {
+    return ColouredPickListFieldTranslator(field, value, appendToActionPayload);
+  }
+
   return PickListFieldModel({
     uiType: uiType || FieldTypes.PickListField,
     appendToActionPayload,
+    options: pickListValues,
     name,
     value
   });
 };
 
-export default PickListFieldTranslator;
+export default PickListFieldTranslator;
+
+const ColouredPickListFieldTranslator = (field, value, appendToActionPayload) => {
+  const {
+    uiType,
+    name,
+    pickListValues
+  } = field;
+  return ColouredPickListFieldModel({
+    uiType: uiType || FieldTypes.ColouredPickListField,
+    appendToActionPayload,
+    options: pickListValues.map(option => ({ ...option,
+      colorCode: option.colorCode || ''
+    })),
+    name,
+    value
+  });
+};

package/es/platform/zlist/adapters/presenters/translators/fields/index.js

@@ -13,7 +13,8 @@ export { default as Date } from "./DateFieldTranslator";
 export { default as DateTime } from "./DateTimeFieldTranslator";
 export { default as Picklist } from "./PickListFieldTranslator";
 export { default as Multiselect } from "./MultiSelectFieldTranslator";
-export { default as LookUp } from "./LookUpFieldTranslator"; // // Field Name is to be similar to the API response
+export { default as LookUp } from "./LookUpFieldTranslator";
+export { default as Formula } from "./FormulaFieldTranslator"; // // Field Name is to be similar to the API response
 // class FieldTranslator {
 //   static translate(field, value) {
 //     const { type } = field;

package/es/platform/zlist/adapters/presenters/translators/interfaces/ModifiedFieldWidths.js

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

package/es/platform/zlist/adapters/presenters/translators/interfaces/PreferencesProperties.js

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

package/es/platform/zlist/adapters/presenters/translators/interfaces/State.js

@@ -1 +1,2 @@
-export {};
+import { BehaviourState as ColumnChooserBehaviourState } from "../../../../../column-chooser/applications/interfaces/output/BehaviourState";
+export { ColumnChooserBehaviourState };

package/es/platform/zlist/adapters/presenters/utils/DefaultClientActions.js

@@ -0,0 +1,126 @@
+/* eslint-disable max-lines-per-function */
+import ClientAction from "../../../../client-actions/behaviour/zclient-actions/domain/entities/ClientAction";
+import { TableListConstants } from "../../../../../cc/table-list";
+import { CheckboxConstants } from "../../../../../cc/checkbox";
+const CHECKBOX_TOGGLED = CheckboxConstants.CHECKBOX_TOGGLED;
+const TABLE_LIST_TOGGLE_ALL_SELECTION = TableListConstants.TABLE_LIST_TOGGLE_ALL_SELECTION;
+
+class DefaultClientActions {
+  static constructAction(clientAction) {
+    return new ClientAction({ ...clientAction,
+      modules: ['MODULE'],
+      component: 'SmartTable',
+      modifiedTime: '2024-11-21T06:11:59.000Z',
+      createdTime: '2024-11-21T06:11:59.000Z'
+    }).toObject();
+  }
+
+  static constructSortAction() {
+    return this.constructAction({
+      uiComponentMapping: {
+        component: 'TableColumnSort',
+        name: 'SortBy',
+        propertiesValueMapping: {
+          value: '{{@context.field.sort.order}}',
+          ascendingLabel: 'Ascending',
+          descendingLabel: 'Descending'
+        },
+        eventMappings: [{
+          payloadValueMapping: {
+            id: '{{@context.field.id}}',
+            name: '{{@context.field.name}}',
+            order: `{{@payload.value}}`
+          },
+          sourceEvent: 'SORT#CLICKED',
+          targetEvent: 'SMART_TABLE#SORT',
+          id: '4000000080005'
+        }],
+        id: '4000000080003'
+      },
+      conditions: {
+        fields: [{
+          fieldName: 'field.isSortable',
+          condition: '=',
+          value: ['true']
+        }],
+        pattern: '1'
+      },
+      location: 'header_actions',
+      id: '4000000080009',
+      name: 'SortBy Action'
+    });
+  }
+
+  static createSortActions(fields, clientActions) {
+    return [...clientActions, this.constructSortAction()];
+  } // TODO: maxLimit: 15,
+  // TODO: saveLabel: 'Save',
+  // TODO: cancelLabel: 'Cancel',
+  // TODO: searchPlaceholder: 'Search',
+  // TODO: iconTooltip: 'Column Chooser',
+  // TODO: heading: 'Select & Reorder Column',
+  // TODO: infoText: 'Info Content',
+  // TODO: emptySearchMessage: 'No Results',
+  // TODO: maxLimitMessage: "You've reached the limit of 15 columns."
+
+
+  static createColumnChooserAction(_ref) {
+    let {
+      options,
+      searchString,
+      hasSearch,
+      errorMessage
+    } = _ref;
+    return this.constructAction({
+      uiComponentMapping: {
+        component: 'TableColumnChooser',
+        name: 'ColumnChooser',
+        propertiesValueMapping: {
+          options,
+          searchString,
+          hasSearch,
+          errorMessage
+        },
+        eventMappings: [],
+        id: '4000000080013'
+      },
+      conditions: {
+        fields: [],
+        pattern: '1'
+      },
+      location: 'non_field_header_actions',
+      id: '4000000080019',
+      name: 'ColumnChooser Action'
+    });
+  }
+
+  static createSelectAllAction() {
+    let isChecked = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    return this.constructAction({
+      uiComponentMapping: {
+        component: 'TableSelectAll',
+        name: 'SelectAll',
+        propertiesValueMapping: {
+          checked: isChecked
+        },
+        eventMappings: [{
+          payloadValueMapping: {},
+          sourceEvent: CHECKBOX_TOGGLED,
+          targetEvent: TABLE_LIST_TOGGLE_ALL_SELECTION,
+          id: '4000000080025'
+        }],
+        id: '4000000080023'
+      },
+      conditions: {
+        fields: [],
+        pattern: '1'
+      },
+      location: 'non_field_header_actions',
+      id: '4000000080029',
+      name: 'SelectAll Action'
+    });
+  }
+
+}
+
+export default DefaultClientActions;

package/es/platform/zlist/adapters/presenters/utils/calculateFieldWidths.js

@@ -0,0 +1,34 @@
+import ColumnSizeTranslator from "../translators/ColumnSizeTranslator";
+export function calculateFieldWidths(fields, modifiedFieldWidths, preferences) {
+  const modifiedWidths = {};
+
+  if (!fields) {
+    return modifiedWidths;
+  }
+
+  function decideWidth(width, fieldName, type) {
+    var _preferences$fields, _preferences$fields$f;
+
+    if (width !== undefined && width !== null) {
+      return width;
+    }
+
+    const initialWidth = (_preferences$fields = preferences.fields) === null || _preferences$fields === void 0 ? void 0 : (_preferences$fields$f = _preferences$fields[fieldName]) === null || _preferences$fields$f === void 0 ? void 0 : _preferences$fields$f.initialWidth;
+
+    if (initialWidth !== undefined && initialWidth !== null) {
+      return initialWidth;
+    }
+
+    return ColumnSizeTranslator(type);
+  }
+
+  fields.forEach(field => {
+    const {
+      name,
+      type
+    } = field;
+    const width = modifiedFieldWidths[name];
+    modifiedWidths[name] = decideWidth(width, name, type);
+  });
+  return modifiedWidths;
+}

package/es/platform/zlist/applications/entities-factory/ListFactory.js

@@ -6,9 +6,10 @@ class ListFactory {
       limit,
       sortBy,
       query,
-      context
+      context,
+      errorRecordFailed
     } = input;
-    return new List(limit, sortBy, query, context);
+    return new List(limit, sortBy, query, context, errorRecordFailed);
   }
 
 }

package/es/platform/zlist/applications/interfaces/output/IPresenter.js

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

package/es/platform/zlist/applications/usecases/AbstractUseCase.js

@@ -4,11 +4,13 @@ class AbstractUseCase {
     this.execute = this.execute.bind(this);
   }
 
-  updateDependency(state) {
+  updateDependency(state, updateState) {
     const {
-      repository
+      repository,
+      presenter
     } = this.dependencies;
     repository.init(state);
+    presenter.updateDependencies(state, updateState);
   }
 
 }

package/es/platform/zlist/applications/usecases/FetchMoreUseCase.js

@@ -9,7 +9,10 @@ class FetchMoreUseCase extends AbstractUseCase {
       repository
     } = this.dependencies;
     const list = repository.getList();
-    dispatch(list.createMoreRecordFetchAction());
+
+    if (!list.getErrorRecordFailed()) {
+      dispatch(list.createMoreRecordFetchAction());
+    }
   }
 
 }

package/es/platform/zlist/applications/usecases/RecordExecuteFailedUseCase.js

@@ -8,10 +8,12 @@ class RecordExecuteFailedUseCase extends AbstractUseCase {
       payload
     } = input;
     const {
-      repository
+      repository,
+      presenter
     } = this.dependencies;
     const list = repository.getList();
     const actions = list.getRecordExecuteFailedActions(payload, metaData);
+    presenter.updateView(list.toObject());
     actions.forEach(action => {
       dispatch(action);
     });

package/es/platform/zlist/applications/usecases/RecordSuccessCallbackUsecase.js

@@ -0,0 +1,24 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class RecordSuccessCallbackUsecase extends AbstractUseCase {
+  execute(input) {
+    const {
+      dispatch,
+      payload,
+      metaData
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const list = repository.getList();
+
+    if (list.isAcknowledgeBySortBy(metaData)) {
+      list.setSortBy(metaData);
+      presenter.updateView(list.toObject());
+    }
+  }
+
+}
+
+export default RecordSuccessCallbackUsecase;

package/es/platform/zlist/applications/usecases/SortUseCase.js

@@ -1,3 +1,4 @@
+import { SmartTableConstants } from "../../../../cc/table-connected";
 import AbstractUseCase from "./AbstractUseCase";
 
 class SortUseCase extends AbstractUseCase {
@@ -8,11 +9,16 @@ class SortUseCase extends AbstractUseCase {
     } = input;
     const {
       repository,
-      sortBy: sortByGateway
+      presenter
     } = this.dependencies;
     const list = repository.getList();
-    const sortByQueryString = sortByGateway.toQueryString(sortBy);
-    dispatch(list.createSortByRefetchAction(sortByQueryString));
+    list.setSortBy(sortBy);
+    dispatch(list.createRecordsRefetchAction());
+    dispatch({
+      type: SmartTableConstants.Events.SORTED,
+      payload: sortBy
+    });
+    presenter.updateView(list.toObject());
   }
 
 }

package/es/platform/zlist/domain/entities/List.js

@@ -3,13 +3,38 @@ import { FIELD_EXECUTE, FIELD_REFETCH } from "../../../../bc/zfield/Constants";
 import { ZLIST_RECORD_DELETE_FAILED, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE_FAILED, ZLIST_RECORD_UPDATE_SUCCEEDED } from "../../../../bc/zlist/Constants";
 import { CLIENTACTION_BEHAVIOUR_EXECUTE } from "../../../client-actions/bc/zclient-actions/Constants";
 import { SmartTableConstants } from "../../../../cc/table-connected";
+import SortBy from "./SortBy";
 
 class List {
-  constructor(limit, sortBy, query, context) {
+  constructor(limit, sortBy, query, context, errorRecordFailed) {
     this.limit = limit;
     this.sortBy = sortBy;
     this.query = query;
     this.context = context;
+    this.errorRecordFailed = errorRecordFailed;
+  }
+
+  toObject() {
+    return {
+      sortBy: this.sortBy.toObject(),
+      errorRecordFailed: this.errorRecordFailed
+    };
+  }
+
+  setSortBy(sortBy) {
+    this.sortBy = new SortBy(sortBy.id, sortBy.name, sortBy.order);
+  }
+
+  toggleSortBy() {
+    const {
+      id,
+      name
+    } = this.sortBy;
+    this.sortBy.doSorting(id, name);
+  }
+
+  isAcknowledgeBySortBy(metaData) {
+    return metaData && metaData['SMART_TABLE#SORTED'];
   }
 
   createApiProps() {
@@ -21,17 +46,12 @@ class List {
     } = this;
     return {
       limit,
-      sortBy,
+      sortBy: sortBy.toQueryString(),
       ...query,
       ...context
     };
   }
 
-  createSortByRefetchAction(sortBy) {
-    this.sortBy = sortBy;
-    return this.createRecordsRefetchAction();
-  }
-
   getInitialMountFetchActions() {
     return [this.createRecordsFetchAction(), this.createAvailableFieldsFetchAction(), this.createSelectedFieldsFetchAction(), this.createClientActionsFetchAction()];
   }
@@ -189,12 +209,22 @@ class List {
     return actions;
   }
 
+  getErrorRecordFailed() {
+    return this.errorRecordFailed;
+  }
+
   getRecordExecuteFailedActions(payload, metaData) {
     const {
       actionName
     } = metaData;
     const actions = [];
 
+    if (actionName === RecordApiActionName.GET_RECORDS) {
+      if (metaData.isAppend) {
+        this.errorRecordFailed = true;
+      }
+    }
+
     if (actionName === RecordApiActionName.DELETE_RECORD) {
       const {
         recordId,
@@ -288,15 +318,21 @@ class List {
     };
   }
 
-  createRecordsRefetchAction() {
+  createRecordsRefetchAction(triggerer) {
     const props = this.createApiProps();
+    const metaData = triggerer === 'sortBy' && {
+      ['SMART_TABLE#SORTED']: {
+        sortBy: this.sortBy.toObject()
+      }
+    };
     return {
       type: RECORD_REFETCH,
       payload: {
         actionName: RecordApiActionName.GET_RECORDS,
         props,
         apiName: 'records'
-      }
+      },
+      metaData
     };
   }
 

package/es/platform/zlist/domain/entities/SortBy.js

@@ -0,0 +1,58 @@
+import { SortOrder } from "./interfaces/Properties";
+
+class SortBy {
+  constructor(id, name, order) {
+    this.id = id;
+    this.name = name;
+    this.order = order;
+  }
+
+  toObject() {
+    return {
+      id: this.id,
+      name: this.name,
+      order: this.order
+    };
+  }
+
+  toQueryString() {
+    const {
+      name,
+      order
+    } = this;
+    let sortQueryString = '';
+
+    if (order === SortOrder.DES) {
+      sortQueryString = `-${name}`;
+    } else if (order === SortOrder.ASC) {
+      sortQueryString = name;
+    }
+
+    return sortQueryString;
+  }
+
+  doSorting(id, name) {
+    if (this.id === id) {
+      this.toggleSort();
+    } else {
+      this.resetSortBy(id, name);
+    }
+  }
+
+  toggleSort() {
+    if (this.order === SortOrder.ASC) {
+      this.order = SortOrder.DES;
+    } else {
+      this.order = SortOrder.ASC;
+    }
+  }
+
+  resetSortBy(id, name) {
+    this.id = id;
+    this.name = name;
+    this.order = SortOrder.ASC;
+  }
+
+}
+
+export default SortBy;

package/es/platform/zlist/domain/entities/interfaces/ISortBy.js

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

package/es/platform/zlist/domain/entities/interfaces/ListModel.js

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

package/es/platform/zlist/domain/entities/interfaces/Properties.js

@@ -1 +1,6 @@
-export {};
+export let SortOrder = /*#__PURE__*/function (SortOrder) {
+  SortOrder["NONE"] = "none";
+  SortOrder["ASC"] = "ascending";
+  SortOrder["DES"] = "descending";
+  return SortOrder;
+}({});

package/es/platform/zlist/frameworks/EventHandlersFactory.js

@@ -4,7 +4,7 @@ import Service from "../adapters/gateways/Service";
 import Repository from "../adapters/gateways/Repository";
 import MountController from "../adapters/controllers/MountController";
 import PropertiesChangeController from "../adapters/controllers/PropertiesChangeController";
-import { ZLIST_DELETE_RECORD, ZLIST_DELETE_RECORDS, ZLIST_FETCH_MORE, ZLIST_FETCH_SORTED, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE, ZLIST_RECORD_UPDATE_SUCCEEDED } from "../../../bc/zlist/Constants";
+import { ZLIST_DELETE_RECORD, ZLIST_DELETE_RECORDS, ZLIST_FETCH_MORE, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE, ZLIST_RECORD_UPDATE_SUCCEEDED, ZLIST_SORT } from "../../../bc/zlist/Constants";
 import FetchMoreController from "../adapters/controllers/FetchMoreController";
 import SortController from "../adapters/controllers/SortController";
 import FieldChangeController from "../adapters/controllers/FieldChangeController";
@@ -15,16 +15,20 @@ import RecordUpdateController from "../adapters/controllers/RecordUpdateControll
 import DeleteSingleRecordController from "../adapters/controllers/DeleteSingleRecordController";
 import RecordExecuteFailedController from "../adapters/controllers/RecordExecuteFailedController";
 import RecordExecuteSucceededController from "../adapters/controllers/RecordExecuteSucceededController";
-import { RECORD_EXECUTE_FAILED, RECORD_EXECUTE_SUCCEEDED } from "../../../bc/zrecord/Constants";
+import { RECORD_EXECUTE_FAILED, RECORD_EXECUTE_SUCCEEDED, RECORD_EXECUTE_SUCCESS_CALLBACK } from "../../../bc/zrecord/Constants";
 import UpdateSuccessController from "../adapters/controllers/UpdateSuccessController";
 import DeleteSuccessController from "../adapters/controllers/DeleteSuccessController";
+import Presenter from "../adapters/presenters/Presenters";
+import RecordSuccessCallbackController from "../adapters/controllers/RecordSuccessCallbackController";
 export default class ActionHandlersFactory {
   static create() {
     const repository = new Repository();
+    const presenter = new Presenter();
     const sortByGateway = new SortBy();
     const service = new Service({
       repository,
-      sortBy: sortByGateway
+      sortBy: sortByGateway,
+      presenter
     });
     return {
       [LifeCycleAction.MOUNT]: new MountController(service).handle,
@@ -36,7 +40,8 @@ export default class ActionHandlersFactory {
       [TableListConstants.TABLE_LIST_FIELD_CHANGED]: new FieldChangeController(service).handle,
       [RECORD_EXECUTE_SUCCEEDED]: new RecordExecuteSucceededController(service).handle,
       [RECORD_EXECUTE_FAILED]: new RecordExecuteFailedController(service).handle,
-      [ZLIST_FETCH_SORTED]: new SortController(service).handle,
+      [ZLIST_SORT]: new SortController(service).handle,
+      [RECORD_EXECUTE_SUCCESS_CALLBACK]: new RecordSuccessCallbackController(service).handle,
       [ZLIST_RECORD_UPDATE_SUCCEEDED]: new UpdateSuccessController(service).handle,
       // ({ dispatch, action }) => dispatch({ type: 'SMART_TABLE#RECORD_UPDATED', payload: action.payload }),
       [ZLIST_RECORD_DELETE_SUCCEEDED]: new DeleteSuccessController(service).handle // ({ dispatch, action }) => dispatch({ type: 'SMART_TABLE#RECORD_DELETED', payload: { id: action.payload.id } })

package/es/platform/zlist/frameworks/ZListBehaviourFactory.js

@@ -4,7 +4,13 @@ export default class ZListBehaviourFactory {
   static create() {
     return {
       name: 'zlist',
-      setInitialState: () => ({}),
+      setInitialState: () => ({
+        sortBy: {
+          id: '',
+          name: '',
+          order: 'none'
+        }
+      }),
       eventHandlers: EventHandlersFactory.create(),
       properties: Properties
     };

package/es/platform/zrecord/adapters/controllers/ActionExecutorController.js

@@ -22,7 +22,8 @@ export default class ActionExecutorController extends AbstractController {
       dispatch,
       apiName,
       actionName,
-      props
+      props,
+      sourceMetaData: action.metaData
     });
   }
 

package/es/platform/zrecord/adapters/controllers/CreateRecordController.js

@@ -0,0 +1,28 @@
+import AbstractController from "./AbstractController";
+export default class CreateRecordController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      updateState,
+      action,
+      dispatch
+    } = event;
+    const {
+      payload
+    } = action;
+    const {
+      record,
+      moduleName
+    } = payload;
+    const {
+      createRecordUseCase
+    } = this.service;
+    createRecordUseCase.updateDependency(state, updateState);
+    createRecordUseCase.execute({
+      record,
+      moduleName,
+      dispatch
+    });
+  }
+
+}