@zohodesk/library-platform 1.1.12 → 1.1.13

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

@@ -4,13 +4,13 @@ class ListFactory {
   static createList(input) {
     const {
       limit,
-      sortBy,
+      sortConfig,
       query,
       context,
       errorState,
       isReOrderLoading
     } = input;
-    return new List(limit, sortBy, query, context, isReOrderLoading, errorState);
+    return new List(limit, sortConfig, query, context, isReOrderLoading, errorState);
   }
 
 }

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class GetSortConfigUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      callback
+    } = input;
+    const {
+      repository
+    } = this.dependencies;
+    const list = repository.getList();
+    callback?.(list.getSortConfig());
+  }
+
+}
+
+export default GetSortConfigUseCase;

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

@@ -36,7 +36,7 @@ class RecordSuccessCallbackUsecase extends AbstractUseCase {
     }
 
     if (list.isAcknowledgeBySortBy(metaData)) {
-      list.setSortBy(metaData);
+      list.setSortConfig(metaData);
       presenter.updateView(list.toObject());
     }
   }

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

@@ -0,0 +1,17 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class RefreshRecordsRequestedUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      dispatch
+    } = input;
+    const {
+      repository
+    } = this.dependencies;
+    const list = repository.getList();
+    dispatch(list.createRecordsRefetchAction());
+  }
+
+}
+
+export default RefreshRecordsRequestedUseCase;

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

@@ -0,0 +1,26 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { SMART_TABLE_SORTED } from "../../../../cc/table-connected/constants/Events";
+
+class SetSortConfigUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      sortConfig,
+      dispatch
+    } = input;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const list = repository.getList();
+    list.setSortConfig(sortConfig);
+    presenter.updateView(list.toObject());
+    dispatch(list.createRecordsRefetchAction());
+    dispatch({
+      type: SMART_TABLE_SORTED,
+      payload: sortConfig
+    });
+  }
+
+}
+
+export default SetSortConfigUseCase;

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

@@ -1,10 +1,10 @@
-import { SmartTableConstants } from "../../../../cc/table-connected";
 import AbstractUseCase from "./AbstractUseCase";
+import { SMART_TABLE_SORTED } from "../../../../cc/table-connected/constants/Events";
 
 class SortUseCase extends AbstractUseCase {
   execute(input) {
     const {
-      sortBy,
+      sortConfig,
       dispatch
     } = input;
     const {
@@ -12,13 +12,13 @@ class SortUseCase extends AbstractUseCase {
       presenter
     } = this.dependencies;
     const list = repository.getList();
-    list.setSortBy(sortBy);
+    list.setSortConfig(sortConfig);
+    presenter.updateView(list.toObject());
     dispatch(list.createRecordsRefetchAction());
     dispatch({
-      type: SmartTableConstants.Events.SORTED,
-      payload: sortBy
+      type: SMART_TABLE_SORTED,
+      payload: sortConfig
     });
-    presenter.updateView(list.toObject());
   }
 
 }

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

@@ -3,13 +3,13 @@ import { FIELD_EXECUTE, FIELD_REFETCH } from "../../../../bc/zfield/Constants";
 import { CLIENTACTION_BEHAVIOUR_EXECUTE } from "../../../client-actions/bc/zclient-actions/Constants";
 import { CLIENT_ACTION_TABLE_LIST_COMPONENT_NAME, ZLIST_RECORD_DELETE_SUCCEEDED, ZLIST_RECORD_UPDATE_SUCCEEDED } from "../../../../bc/zlist/Constants";
 import { SmartTableConstants } from "../../../../cc/table-connected";
-import SortBy from "./SortBy";
 import { CLIENTSCRIPT_FETCH } from "../../../client-scripts/bc/zclient-scripts-fetch/Constants";
+import { SortOrder, stringToSortConfig } from "../../../../bc/zlist/Types";
 
 class List {
-  constructor(limit, sortBy, query, context, isReOrderLoading, errorState) {
+  constructor(limit, sortConfig, query, context, isReOrderLoading, errorState) {
     this.limit = limit;
-    this.sortBy = sortBy;
+    this.sortConfig = sortConfig;
     this.query = query;
     this.context = context;
     this.isReOrderLoading = isReOrderLoading;
@@ -19,7 +19,7 @@ class List {
   toObject() {
     return {
       limit: this.limit,
-      sortBy: this.sortBy.toObject(),
+      sortConfig: this.sortConfig,
       isReOrderLoading: this.isReOrderLoading,
       errorState: this.errorState.toObject()
     };
@@ -37,16 +37,12 @@ class List {
     this.isReOrderLoading = false;
   }
 
-  setSortBy(sortBy) {
-    this.sortBy = new SortBy(sortBy.id, sortBy.name, sortBy.order);
+  getSortConfig() {
+    return this.sortConfig;
   }
 
-  toggleSortBy() {
-    const {
-      id,
-      name
-    } = this.sortBy;
-    this.sortBy.doSorting(id, name);
+  setSortConfig(sortConfig) {
+    this.sortConfig = sortConfig;
   }
 
   isAcknowledgeBySortBy(metaData) {
@@ -65,16 +61,32 @@ class List {
     return variableName ? computedContext?.[variableName] : computedContext;
   }
 
+  getSortByQueryString() {
+    const {
+      fieldName,
+      order
+    } = this.sortConfig;
+
+    if (order === SortOrder.DES) {
+      return `-${fieldName}`;
+    }
+
+    if (order === SortOrder.ASC) {
+      return fieldName;
+    }
+
+    return '';
+  }
+
   createApiProps() {
     const {
       query,
       limit,
-      sortBy,
       context
     } = this;
     return {
       limit,
-      sortBy: sortBy.toQueryString(),
+      sortBy: this.getSortByQueryString(),
       ...query,
       ...context
     };
@@ -111,7 +123,7 @@ class List {
     } = currentProperties;
 
     if (prevSortBy !== sortBy) {
-      return [this.createRecordsRefetchAction()];
+      this.setSortConfig(stringToSortConfig(sortBy));
     }
 
     if (preDepartmentId !== currentDepartmentId) {
@@ -127,6 +139,10 @@ class List {
       // TODO: this.createSelectedFieldsRefetchAction()
     }
 
+    if (prevSortBy !== sortBy) {
+      return [this.createRecordsRefetchAction()];
+    }
+
     return [];
   }
 
@@ -357,7 +373,7 @@ class List {
     const props = this.createApiProps();
     const metaData = triggerer === 'sortBy' && {
       ['SMART_TABLE#SORTED']: {
-        sortBy: this.sortBy.toObject()
+        sortBy: this.sortConfig
       }
     };
     return {

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

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

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

@@ -9,13 +9,12 @@ import FetchMoreController from "../adapters/controllers/FetchMoreController";
 import SortController from "../adapters/controllers/SortController";
 import FieldChangeController from "../adapters/controllers/FieldChangeController";
 import LifeCycleEvents from "../../../cc/component/LifeCycleEventsEnum";
-import SortBy from "../adapters/gateways/SortBy";
 import DeleteMultipleRecordController from "../adapters/controllers/DeleteMultipleRecordController";
 import RecordUpdateController from "../adapters/controllers/RecordUpdateController";
 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, RECORD_EXECUTE_SUCCESS_CALLBACK } from "../../../bc/zrecord/Constants";
+import { RECORD_EXECUTE_FAILED, RECORD_EXECUTE_SUCCEEDED, RECORD_EXECUTE_SUCCESS_CALLBACK, REFRESH_RECORDS_REQUESTED } from "../../../bc/zrecord/Constants";
 import UpdateSuccessController from "../adapters/controllers/UpdateSuccessController";
 import DeleteSuccessController from "../adapters/controllers/DeleteSuccessController";
 import Presenter from "../adapters/presenters/Presenters";
@@ -26,14 +25,13 @@ import { FIELD_FETCH_FAILURE } from "../../../bc/zfield/Constants";
 import FieldExecuteFailedController from "../adapters/controllers/FieldExecuteFailedController";
 import { CLIENTACTION_EXECUTE_FAILED } from "../../client-actions/bc/zclient-actions/Constants";
 import ResolutionBasedLimitController from "../adapters/controllers/ResolutionBasedLimitController";
+import RefreshRecordsRequestedController from "../adapters/controllers/RefreshRecordsRequestedController";
 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,
       presenter
     });
     return {
@@ -57,6 +55,7 @@ export default class ActionHandlersFactory {
       [ZLIST_RECORD_DELETE_SUCCEEDED]: new DeleteSuccessController(service).handle,
       // ({ dispatch, action }) => dispatch({ type: 'SMART_TABLE#RECORD_DELETED', payload: { id: action.payload.id } })
       [ZLIST_RECORD_REORDER]: new ReOrderController(service).handle,
+      [REFRESH_RECORDS_REQUESTED]: new RefreshRecordsRequestedController(service).handle,
       [ZLIST_RECORD_REORDER_FAILED]: new ReOrderFailedController(service).handle
     };
   }

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

@@ -1,22 +1,24 @@
 import Properties from "../../../bc/zlist/Properties";
 import EventHandlersFactory from "./EventHandlersFactory";
+import { stringToSortConfig } from "../../../bc/zlist/Types";
 export default class ZListBehaviourFactory {
   static create() {
     return {
       name: 'zlist',
-      setInitialState: () => ({
-        sortBy: {
-          id: '',
-          name: '',
-          order: 'none'
-        },
-        isReOrderLoading: false,
-        errorState: {
-          canErrorPage: false,
-          shouldClearRecords: false,
-          hasFetchingFailedInMoreRecords: false
-        }
-      }),
+      setInitialState: _ref => {
+        let {
+          properties
+        } = _ref;
+        return {
+          sortConfig: stringToSortConfig(properties.sortBy),
+          isReOrderLoading: false,
+          errorState: {
+            canErrorPage: false,
+            shouldClearRecords: false,
+            hasFetchingFailedInMoreRecords: false
+          }
+        };
+      },
       eventHandlers: EventHandlersFactory.create(),
       properties: Properties
     };

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

@@ -0,0 +1,28 @@
+export default class FilterRecordLocalController {
+  constructor(service) {
+    this.service = service;
+  }
+
+  handle = event => {
+    const {
+      state,
+      updateState,
+      action
+    } = event;
+    const {
+      payload
+    } = action;
+    const {
+      filterConfig,
+      isLocalSearchEnabled
+    } = payload;
+    const {
+      filterRecordUseCase
+    } = this.service;
+    filterRecordUseCase.updateDependency(state, updateState);
+    filterRecordUseCase.execute({
+      filterConfig,
+      isLocalSearchEnabled
+    });
+  };
+}

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

@@ -1,4 +1,5 @@
 import RecordsManagerFactory from "../../applications/entities-factory/RecordsManagerFactory";
+import { Filter } from "../../domain/entities/Filter";
 export default class Repository {
   init(state) {
     this.state = state;
@@ -11,13 +12,15 @@ export default class Repository {
     const {
       records = [],
       hasMore,
-      isFetching
+      isFetching,
+      filter
     } = zrecord;
+    const filterEntity = new Filter(filter.config, filter.condition, filter.queryString);
     const recordManager = RecordsManagerFactory.create({
       data: records,
       hasMore,
       isFetching
-    });
+    }, filterEntity);
     return recordManager;
   }
 

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

@@ -14,6 +14,7 @@ import FetchStateStopUseCase from "../../applications/usecases/FetchStateStopUse
 import CreateRecordUseCase from "../../applications/usecases/CreateRecordUseCase";
 import MarkAsReadUseCase from "../../applications/usecases/MarkAsReadUseCase";
 import MarkAsUnReadUseCase from "../../applications/usecases/MarkAsUnReadUseCase";
+import FilterRecordUseCase from "../../applications/usecases/FilterRecordUseCase";
 export default class Service {
   constructor(dependencies) {
     this.initializeUseCase = new InitializeUseCase(dependencies);
@@ -32,6 +33,7 @@ export default class Service {
     this.createRecordUseCase = new CreateRecordUseCase(dependencies);
     this.markAsReadUseCase = new MarkAsReadUseCase(dependencies);
     this.markAsUnReadUseCase = new MarkAsUnReadUseCase(dependencies);
+    this.filterRecordUseCase = new FilterRecordUseCase(dependencies);
   }
 
 }

package/es/platform/zrecord/applications/entities-factory/RecordsManagerFactory.js

@@ -1,9 +1,9 @@
 import RecordsManager from "../../domain/entities/RecordsManager";
 import Records from "../../domain/entities/Records";
 export default class RecordsManagerFactory {
-  static create(recordsModel) {
+  static create(recordsModel, filter) {
     const records = new Records(recordsModel);
-    const recordManager = new RecordsManager(records);
+    const recordManager = new RecordsManager(records, filter);
     return recordManager;
   }
 

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,24 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { REFRESH_RECORDS_REQUESTED } from "../../../../bc/zrecord/Constants";
+import { initialFilterConfig } from "../../../../bc/zrecord/Types";
+export default class ClearAllFiltersUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      dispatch
+    } = _ref;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const recordManager = repository.getRecordsManagerEntity();
+    recordManager.setFilterConfig(initialFilterConfig);
+    presenter.updateRecord(recordManager.toObject());
+    dispatch({
+      type: REFRESH_RECORDS_REQUESTED,
+      metaData: {
+        filterConfig: initialFilterConfig
+      }
+    });
+  }
+
+}

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

@@ -0,0 +1,21 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class FilterRecordUseCase extends AbstractUseCase {
+  execute(input) {
+    const {
+      presenter,
+      repository
+    } = this.dependencies;
+    const {
+      filterConfig,
+      isLocalSearchEnabled
+    } = input;
+    const recordManager = repository.getRecordsManagerEntity();
+    recordManager.setFilterConfig(filterConfig);
+    recordManager.setIsLocalSearchEnabled(isLocalSearchEnabled);
+    presenter.updateRecord(recordManager.toObject());
+  }
+
+}
+
+export default FilterRecordUseCase;

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

@@ -0,0 +1,15 @@
+import AbstractUseCase from "./AbstractUseCase";
+export default class GetFilterConditionUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const recordManager = repository.getRecordsManagerEntity();
+    const filterCondition = recordManager.getFilterCondition();
+    callback?.(filterCondition);
+  }
+
+}

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

@@ -0,0 +1,15 @@
+import AbstractUseCase from "./AbstractUseCase";
+export default class GetFilterConfigUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      callback
+    } = _ref;
+    const {
+      repository
+    } = this.dependencies;
+    const recordManager = repository.getRecordsManagerEntity();
+    const filterConfig = recordManager.getFilterConfig();
+    callback?.(filterConfig);
+  }
+
+}

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

@@ -0,0 +1,14 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { REFRESH_RECORDS_REQUESTED } from "../../../../bc/zrecord/Constants";
+export default class RefreshRecordsUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      dispatch
+    } = _ref;
+    dispatch({
+      type: REFRESH_RECORDS_REQUESTED,
+      metaData: {}
+    });
+  }
+
+}

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

@@ -0,0 +1,29 @@
+import AbstractUseCase from "./AbstractUseCase";
+import { RECORD_LOCAL_FILTER, REFRESH_RECORDS_REQUESTED } from "../../../../bc/zrecord/Constants";
+export default class SetFilterUseCase extends AbstractUseCase {
+  execute(_ref) {
+    let {
+      filterConfig,
+      dispatch,
+      shouldFetch
+    } = _ref;
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const recordManager = repository.getRecordsManagerEntity();
+    recordManager.setFilterConfig(filterConfig);
+    presenter.updateRecord(recordManager.toObject());
+    dispatch({
+      type: shouldFetch ? REFRESH_RECORDS_REQUESTED : RECORD_LOCAL_FILTER,
+      payload: {
+        filterConfig,
+        isLocalSearchEnabled: !shouldFetch
+      },
+      metaData: {
+        filterConfig
+      }
+    });
+  }
+
+}