@zohodesk/library-platform 1.1.2 → 1.1.3-exp.1

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

@@ -1,3 +1,5 @@
+/* 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 HeadersTranslator from "./translators/HeadersTranslator";
@@ -8,6 +10,7 @@ import { TableListConstants } from "../../../../cc/table-list";
 import { ResizerStateTranslator } from "./translators/ResizerStateTranslator";
 import { calculateFieldWidths } from "./utils/calculateFieldWidths";
 import DefaultClientActions from "./utils/DefaultClientActions";
+import SelectionTranslator from "./SelectionTranslator";
 const EMPTY_OBJECT = {};
 const EMPTY_ARRAY = [];
 
@@ -27,11 +30,13 @@ export default class TableTranslator {
     } = properties;
     const {
       localStorage: localStorageBehaviour,
-      columnResizer
+      columnResizer,
+      keyboardControls
     } = behaviours;
     const {
       resizeConfig,
-      preferences
+      preferences,
+      keyboardControlsConfig
     } = properties;
     context['servicePrefix'] = 'supportapi/zd'; // FIX: servicePrefix defaultValue should be available from properties
 
@@ -46,6 +51,10 @@ export default class TableTranslator {
       sortBy
     } = fallbackToDefault(zlist, {}); // FIX: zlist should be available by default
 
+    const {
+      focussedIndex
+    } = fallbackToDefault(keyboardControls, {}); // FIX: KeyboardControls should be available by default
+
     const {
       records,
       isFetching: isRecordsFetching
@@ -93,23 +102,30 @@ export default class TableTranslator {
     return {
       properties,
       behaviours,
-      selection: behaviours === null || behaviours === void 0 ? void 0 : behaviours.selection,
-      sortBy,
-      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: componentMapping.emptyState || '',
-      data
+      viewModel: {
+        selection: SelectionTranslator(state),
+        focussedRow: focussedIndex,
+        sortBy,
+        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
+        },
+        keyboardControlsConfig,
+        isLoading,
+        emptyStateUiType: componentMapping.emptyState || '',
+        data: fields.length ? data : {
+          headers: EMPTY_ARRAY,
+          rows: EMPTY_ARRAY
+        }
+      }
     };
   }
 

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

@@ -2,16 +2,38 @@ import EmptyViewModel from "./EmptyViewModel";
 import * as FieldTranslators from "./fields";
 import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
 
-function ColumnTranslator(fieldModel, record, fieldComponentMapping, fieldActions) {
+//hacking temp url construction for lookup
+function getLookupUrlConstructions(_ref) {
+  var _field$lookup, _field$lookup$module;
+
+  let {
+    field,
+    value,
+    context
+  } = _ref;
+  let {
+    orgName,
+    departmentName
+  } = context;
+  let lookupModuleName = field === null || field === void 0 ? void 0 : (_field$lookup = field.lookup) === null || _field$lookup === void 0 ? void 0 : (_field$lookup$module = _field$lookup.module) === null || _field$lookup$module === void 0 ? void 0 : _field$lookup$module.apiName;
+  return `/agent/${orgName}/${departmentName}/${lookupModuleName}/details/${value.id}`;
+}
+
+function ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context) {
   var _record$cf;
 
-  const field = { ...fieldModel
-  };
   const {
     isCustomField,
     name,
     type
   } = field;
+  let fieldToUiValue;
+  const fieldEntry = fieldComponentMapping[name];
+
+  if (typeof fieldEntry == 'string') {
+    console.warn(`The string format for componentMapping will soon be deprecated. Please update to the new JSON format. REF : ${JSON.stringify(fieldEntry)}`);
+  }
+
   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,
@@ -33,9 +55,46 @@ function ColumnTranslator(fieldModel, record, fieldComponentMapping, fieldAction
     return EmptyViewModel();
   }
 
+  if (field.type == "LookUp") {
+    value.url = getLookupUrlConstructions({
+      field,
+      value,
+      context
+    });
+  }
+
+  let finalValue = value;
+
+  if (fieldToUiValue !== undefined) {
+    finalValue = fieldToUiValue;
+  }
+
+  if (fieldEntry && typeof fieldEntry === 'object') {
+    let data = {
+      actions,
+      ...fieldTranslator(field, finalValue, {
+        recordId: record.id
+      })
+    };
+    data.value = fieldEntry.fieldToUIComponentTranslator({
+      field,
+      record,
+      context
+    });
+    data.type = fieldEntry.UIComponentName;
+    console.log(data, "====>>> custom field modal");
+    return data;
+  }
+
+  console.log({
+    actions,
+    ...fieldTranslator(field, finalValue, {
+      recordId: record.id
+    })
+  }, "====>>> normal pre-defined field modal");
   return {
     actions,
-    ...fieldTranslator(field, value, {
+    ...fieldTranslator(field, finalValue, {
       recordId: record.id
     })
   };

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

@@ -1,6 +1,7 @@
 import ColumnAlignmentTranslator from "./ColumnAlignmentTranslator";
 import ClientActionsTranslator from "../../../../client-actions/translators/client-actions-translator";
 import { SortOrder } from "../../../../zlist/domain/entities/interfaces/Properties";
+import { i18NProviderUtils } from '@zohodesk/i18n';
 
 function HeaderTranslator(field, actions, context, modifiedWidths, sortBy) {
   const {
@@ -37,9 +38,11 @@ function translateSortBy(id, sortBy) {
 
   if (sortBy.id === id) {
     if (sortBy.order === SortOrder.ASC) {
-      newSortBy.tooltip = 'Click to Sort Descending';
+      // 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 = 'Click to Sort Ascending';
+      newSortBy.tooltip = i18NProviderUtils.getI18NValue("support.localization.tooltip.ascending");
     } else if (newSortBy.order === SortOrder.NONE) {
       newSortBy.tooltip = 'Click to Sort';
     }

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

@@ -1,3 +1,4 @@
+import { i18NProviderUtils } from '@zohodesk/i18n';
 const defaultResizerUiState = {
   isEnabled: false,
   isCurrentlyResizing: false,
@@ -66,16 +67,19 @@ function tooltipI18nHandler(_ref2) {
 
   if (width === maxWidth) {
     // return `Max width (${width}px) reached`;
-    return `Max Limit Reached ${width}`;
+    let i18nMax = i18NProviderUtils.getI18NValue('support.ticket.list.table.max.width', width);
+    return i18nMax;
   }
 
   if (width === minWidth) {
     // return `Min width (${width}px) reached`;
-    return `Min Limit Reached ${width}`;
+    let i18nMin = i18NProviderUtils.getI18NValue('support.ticket.list.table.min.width', width);
+    return i18nMin;
   } // return `Width: ${width}px`;
 
 
-  return `Width - ${width}px`;
+  let i18nWid = i18NProviderUtils.getI18NValue('support.ticket.list.table.width', width);
+  return i18nWid;
 }
 
 function calculateExtraSpaceWidth(_ref3) {

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

@@ -15,7 +15,7 @@ export default function RowTranslator(_ref) {
   });
   return {
     id: record.id,
-    columns: fields.map(field => ColumnTranslator(field, record, fieldComponentMapping, fieldActions)),
+    columns: fields.map(field => ColumnTranslator(field, record, fieldComponentMapping, fieldActions, context)),
     rowActionLocation: {
       type: rowActionsUiType,
       actions

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

@@ -8,19 +8,19 @@ const LookUpFieldTranslator = (field, value, appendToActionPayload) => {
   } = field;
   const {
     id,
-    firstName,
-    lastName,
-    photoURL = ''
+    name: nameValue,
+    photoURL,
+    url
   } = value;
-  const lookupName = `${firstName} ${lastName}`;
   return LookupFieldModel({
     uiType: uiType || FieldTypes.LookUpField,
     appendToActionPayload,
     name,
     value: {
       id,
-      name: lookupName,
-      photoURL
+      name: nameValue,
+      photoURL,
+      url
     }
   });
 };

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

@@ -1,8 +1,18 @@
+/* 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).toObject();
+    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() {
@@ -37,16 +47,78 @@ class DefaultClientActions {
       },
       location: 'header_actions',
       id: '4000000080009',
-      modules: ['MODULE'],
-      name: 'SortBy Action',
-      component: 'SmartTable',
-      modifiedTime: '2024-11-21T06:11:59.000Z',
-      createdTime: '2024-11-21T06:11:59.000Z'
+      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'
+    });
   }
 
 }

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/input/GetContextUseCaseInput.js

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

package/es/platform/zlist/applications/interfaces/input/UpdateMultipleRecordUseCaseInput.js

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

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

@@ -1,7 +1,10 @@
+import { RECORD_LOCAL_MULTIPLE_DELETE } from "../../../../bc/zrecord/Constants";
 import AbstractUseCase from "./AbstractUseCase";
 
 class DeleteMultipleRecordUseCase extends AbstractUseCase {
   execute(input) {
+    var _input$callback;
+
     const {
       dispatch,
       recordIds
@@ -10,8 +13,26 @@ class DeleteMultipleRecordUseCase extends AbstractUseCase {
       repository
     } = this.dependencies;
     const list = repository.getList();
-    const action = list.getDeleteMultipleRecordAction(recordIds);
-    dispatch(action);
+
+    if (input.shouldFetch) {
+      const action = list.getDeleteMultipleRecordAction(recordIds);
+      dispatch(action);
+    } else {
+      dispatch({
+        type: RECORD_LOCAL_MULTIPLE_DELETE,
+        payload: {
+          recordIds
+        }
+      });
+    }
+
+    (_input$callback = input.callback) === null || _input$callback === void 0 ? void 0 : _input$callback.call(input, {
+      data: recordIds.map(id => ({
+        id,
+        Success: true,
+        error: null
+      }))
+    });
   }
 
 }

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

@@ -2,6 +2,8 @@ import AbstractUseCase from "./AbstractUseCase";
 
 class DeleteSingleRecordUseCase extends AbstractUseCase {
   execute(input) {
+    var _input$callback;
+
     const {
       dispatch,
       recordId
@@ -12,6 +14,13 @@ class DeleteSingleRecordUseCase extends AbstractUseCase {
     const list = repository.getList();
     const action = list.getDeleteSingleRecordAction(recordId);
     dispatch(action);
+    (_input$callback = input.callback) === null || _input$callback === void 0 ? void 0 : _input$callback.call(input, {
+      data: [{
+        id: recordId,
+        Success: true,
+        error: null
+      }]
+    });
   }
 
 }

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/GetContextUseCase.js

@@ -0,0 +1,18 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetContextUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      variableName,
+      callback
+    } = input;
+    const {
+      repository
+    } = this.dependencies;
+    const list = repository.getList();
+    callback === null || callback === void 0 ? void 0 : callback(list.getContext(variableName));
+  }
+
+}
+
+export default GetContextUseCase;

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/RecordUpdateUseCase.js

@@ -2,6 +2,8 @@ import AbstractUseCase from "./AbstractUseCase";
 
 class RecordUpdateUseCase extends AbstractUseCase {
   execute(input) {
+    var _input$callback;
+
     const {
       dispatch,
       recordId,
@@ -13,6 +15,13 @@ class RecordUpdateUseCase extends AbstractUseCase {
     const list = repository.getList();
     const action = list.getUpdateRecordFetchActions(recordId, record);
     dispatch(action);
+    (_input$callback = input.callback) === null || _input$callback === void 0 ? void 0 : _input$callback.call(input, {
+      data: [{
+        id: recordId,
+        Success: true,
+        error: null
+      }]
+    });
   }
 
 }

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

@@ -0,0 +1,34 @@
+import { RECORD_LOCAL_UPDATE } from "../../../../bc/zrecord/Constants";
+import AbstractUseCase from "./AbstractUseCase";
+import { ZLIST_RECORD_UPDATE } from "../../../../bc/zlist/Constants";
+
+class UpdateMultipleRecordUseCase extends AbstractUseCase {
+  execute(input) {
+    var _input$callback;
+
+    const {
+      dispatch,
+      recordsMap,
+      shouldFetch
+    } = input;
+    recordsMap.forEach(record => {
+      dispatch({
+        type: shouldFetch ? ZLIST_RECORD_UPDATE : RECORD_LOCAL_UPDATE,
+        payload: {
+          recordId: record.id,
+          record: record
+        }
+      });
+    });
+    (_input$callback = input.callback) === null || _input$callback === void 0 ? void 0 : _input$callback.call(input, {
+      results: recordsMap.map(record => ({
+        id: record.id,
+        Success: true,
+        error: null
+      }))
+    });
+  }
+
+}
+
+export default UpdateMultipleRecordUseCase;

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

@@ -6,16 +6,18 @@ 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()
+      sortBy: this.sortBy.toObject(),
+      errorRecordFailed: this.errorRecordFailed
     };
   }
 
@@ -35,6 +37,18 @@ class List {
     return metaData && metaData['SMART_TABLE#SORTED'];
   }
 
+  getContext(variableName) {
+    const context = this.context;
+    const query = this.query;
+    const computedContext = { ...context,
+      departmentId: query.departmentId,
+      viewId: query.viewId,
+      moduleName: query.moduleName
+    };
+    delete computedContext['servicePrefix'];
+    return variableName ? computedContext === null || computedContext === void 0 ? void 0 : computedContext[variableName] : computedContext;
+  }
+
   createApiProps() {
     const {
       query,
@@ -207,12 +221,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,

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

@@ -8,7 +8,7 @@ import { ZLIST_DELETE_RECORD, ZLIST_DELETE_RECORDS, ZLIST_FETCH_MORE, ZLIST_RECO
 import FetchMoreController from "../adapters/controllers/FetchMoreController";
 import SortController from "../adapters/controllers/SortController";
 import FieldChangeController from "../adapters/controllers/FieldChangeController";
-import LifeCycleAction from "../../../cc/architecture/LifeCycleActionEnum";
+import LifeCycleEvents from "../../../cc/component/LifeCycleEventsEnum";
 import SortBy from "../adapters/gateways/SortBy";
 import DeleteMultipleRecordController from "../adapters/controllers/DeleteMultipleRecordController";
 import RecordUpdateController from "../adapters/controllers/RecordUpdateController";
@@ -31,8 +31,8 @@ export default class ActionHandlersFactory {
       presenter
     });
     return {
-      [LifeCycleAction.MOUNT]: new MountController(service).handle,
-      [LifeCycleAction.UPDATE_PROPERTIES]: new PropertiesChangeController(service).handle,
+      [LifeCycleEvents.MOUNT]: new MountController(service).handle,
+      [LifeCycleEvents.UPDATE_PROPERTIES]: new PropertiesChangeController(service).handle,
       [ZLIST_FETCH_MORE]: new FetchMoreController(service).handle,
       [ZLIST_RECORD_UPDATE]: new RecordUpdateController(service).handle,
       [ZLIST_DELETE_RECORD]: new DeleteSingleRecordController(service).handle,

package/es/platform/zrecord/applications/interfaces/input/GetMultipleRecordUsecaseInputModel.js

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

package/es/platform/zrecord/applications/interfaces/input/GetSingleRecordUseCaseInputModel.js

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

package/es/platform/zrecord/applications/usecases/GetMultipleRecordUseCase.js

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+// GetSingleRecordUseCase
+export default class GetMultipleRecordUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const recordManager = repository.getRecordsManagerEntity();
+    const records = recordManager.getRecords();
+    callback === null || callback === void 0 ? void 0 : callback(records);
+  }
+
+}