orc-shared 5.10.1-dev.3 → 5.10.1-dev.4

package/dist/utils/ListHelper.js

@@ -6,7 +6,7 @@ var _immutable = _interopRequireDefault(require("immutable"));
 var _lodash = require("lodash");
 var _ListHelper;
 var _excluded = ["resetList", "scope", "filters", "sorting"],
-  _excluded2 = ["sorting", "filters", "scope", "page", "nextPageToLoad", "index", "list", "totalCount"];
+  _excluded2 = ["sorting", "filters", "scope", "page", "nextPageToLoad", "index", "list", "totalCount", "searchRequested"];
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 (function () {
   var enterModule = typeof reactHotLoaderGlobal !== 'undefined' ? reactHotLoaderGlobal.enterModule : undefined;
@@ -30,13 +30,16 @@ var __signature__ = typeof reactHotLoaderGlobal !== 'undefined' ? reactHotLoader
   return a;
 };
 var ListInfoPropertyName = exports.ListInfoPropertyName = "listInfo";
-var standardInfoKeys = ["scope", "page", "filters", "sorting", "totalCount", "nextPageToLoad", "index", "list"];
+var standardInfoKeys = ["scope", "page", "filters", "sorting", "totalCount", "nextPageToLoad", "index", "list", "searchRequested"];
 var ListReducerHelper = /*#__PURE__*/function () {
   function ListReducerHelper(groupPropertyName) {
     var _this = this;
     _defineProperty(this, "setNextPageToLoad", function (state, nextPageToLoad) {
       return state.setIn([_this.groupPropertyName, "nextPageToLoad"], nextPageToLoad);
     });
+    _defineProperty(this, "setSearchRequested", function (state, searchRequested) {
+      return state.setIn([_this.groupPropertyName, "searchRequested"], searchRequested);
+    });
     _defineProperty(this, "setResults", function (state, listInfo, forceReset) {
       if (forceReset === void 0) {
         forceReset = false;
@@ -79,6 +82,7 @@ var ListReducerHelper = /*#__PURE__*/function () {
         s.setIn([_this.groupPropertyName, "scope"], scope != null ? scope : null);
         s.setIn([_this.groupPropertyName, "filters"], _immutable.default.fromJS(filters != null ? filters : null));
         s.setIn([_this.groupPropertyName, "sorting"], _immutable.default.fromJS(sorting != null ? sorting : null));
+        s.setIn([_this.groupPropertyName, "searchRequested"], false);
         var otherKeys = Object.keys(others);
         s.get(_this.groupPropertyName).keySeq().forEach(function (key) {
           if (!standardInfoKeys.includes(key) && !otherKeys.includes(key)) {
@@ -109,7 +113,7 @@ var ListReducerHelper = /*#__PURE__*/function () {
       if (propertiesToKeep === void 0) {
         propertiesToKeep = {};
       }
-      var updatedState = state.setIn([_this.groupPropertyName, "nextPageToLoad"], 1).setIn([_this.groupPropertyName, "index"], _immutable.default.fromJS({})).setIn([_this.groupPropertyName, "list"], _immutable.default.fromJS([])).setIn([_this.groupPropertyName, "totalCount"], 0);
+      var updatedState = state.setIn([_this.groupPropertyName, "nextPageToLoad"], 1).setIn([_this.groupPropertyName, "searchRequested"], false).setIn([_this.groupPropertyName, "index"], _immutable.default.fromJS({})).setIn([_this.groupPropertyName, "list"], _immutable.default.fromJS([])).setIn([_this.groupPropertyName, "totalCount"], 0);
       if (!propertiesToKeep.filters) {
         updatedState = updatedState.setIn([_this.groupPropertyName, "filters"], null);
       }
@@ -145,7 +149,8 @@ var ListSelectorHelper = /*#__PURE__*/function () {
         currentPage: listInfo.get("page"),
         currentFilters: (_listInfo$get = listInfo.get("filters")) == null ? void 0 : _listInfo$get.toJS(),
         currentSorting: (_listInfo$get2 = listInfo.get("sorting")) == null ? void 0 : _listInfo$get2.toJS(),
-        totalCount: listInfo.get("totalCount")
+        totalCount: listInfo.get("totalCount"),
+        searchRequested: listInfo.get("searchRequested")
       };
       listInfo.mapKeys(function (key, value) {
         if (standardInfoKeys.includes(key)) {
@@ -165,6 +170,9 @@ var ListSelectorHelper = /*#__PURE__*/function () {
     _defineProperty(this, "getNextPageToLoad", function (state) {
       return state.getIn([_this2.groupPropertyName, "nextPageToLoad"]);
     });
+    _defineProperty(this, "getSearchRequested", function (state) {
+      return state.getIn([_this2.groupPropertyName, "searchRequested"]);
+    });
     this.groupPropertyName = groupPropertyName;
   }
   var _proto2 = ListSelectorHelper.prototype;
@@ -200,6 +208,7 @@ var ListHelper = /*#__PURE__*/function () {
         index = _ref4.index,
         list = _ref4.list,
         totalCount = _ref4.totalCount,
+        searchRequested = _ref4.searchRequested,
         additionalValues = _objectWithoutProperties(_ref4, _excluded2);
       return _defineProperty({}, _this3.groupPropertyName, _objectSpread({
         sorting: sorting != null ? sorting : null,
@@ -209,7 +218,8 @@ var ListHelper = /*#__PURE__*/function () {
         nextPageToLoad: nextPageToLoad != null ? nextPageToLoad : 1,
         index: index != null ? index : {},
         list: list != null ? list : [],
-        totalCount: totalCount != null ? totalCount : 0
+        totalCount: totalCount != null ? totalCount : 0,
+        searchRequested: searchRequested != null ? searchRequested : false
       }, additionalValues));
     });
     this.groupPropertyName = groupPropertyName;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "orc-shared",
-	"version": "5.10.1-dev.3",
+	"version": "5.10.1-dev.4",
 	"description": "Shared code for Orckestra applications",
 	"main": "./src/index.js",
 	"exports": {

package/src/utils/ListHelper.js

@@ -3,7 +3,17 @@ import { isObject } from "lodash";
 
 export const ListInfoPropertyName = "listInfo";
 
-const standardInfoKeys = ["scope", "page", "filters", "sorting", "totalCount", "nextPageToLoad", "index", "list"];
+const standardInfoKeys = [
+	"scope",
+	"page",
+	"filters",
+	"sorting",
+	"totalCount",
+	"nextPageToLoad",
+	"index",
+	"list",
+	"searchRequested",
+];
 
 class ListReducerHelper {
 	constructor(groupPropertyName) {
@@ -14,6 +24,10 @@ class ListReducerHelper {
 		return state.setIn([this.groupPropertyName, "nextPageToLoad"], nextPageToLoad);
 	};
 
+	setSearchRequested = (state, searchRequested) => {
+		return state.setIn([this.groupPropertyName, "searchRequested"], searchRequested);
+	};
+
 	setResults = (state, listInfo, forceReset = false) => {
 		return state.withMutations(s => {
 			const page = s.getIn([this.groupPropertyName, "nextPageToLoad"]);
@@ -51,6 +65,7 @@ class ListReducerHelper {
 			s.setIn([this.groupPropertyName, "scope"], scope ?? null);
 			s.setIn([this.groupPropertyName, "filters"], Immutable.fromJS(filters ?? null));
 			s.setIn([this.groupPropertyName, "sorting"], Immutable.fromJS(sorting ?? null));
+			s.setIn([this.groupPropertyName, "searchRequested"], false);
 
 			const otherKeys = Object.keys(others);
 
@@ -90,6 +105,7 @@ class ListReducerHelper {
 	resetListInfo = (state, propertiesToKeep = {}) => {
 		let updatedState = state
 			.setIn([this.groupPropertyName, "nextPageToLoad"], 1)
+			.setIn([this.groupPropertyName, "searchRequested"], false)
 			.setIn([this.groupPropertyName, "index"], Immutable.fromJS({}))
 			.setIn([this.groupPropertyName, "list"], Immutable.fromJS([]))
 			.setIn([this.groupPropertyName, "totalCount"], 0);
@@ -128,6 +144,7 @@ class ListSelectorHelper {
 			currentFilters: listInfo.get("filters")?.toJS(),
 			currentSorting: listInfo.get("sorting")?.toJS(),
 			totalCount: listInfo.get("totalCount"),
+			searchRequested: listInfo.get("searchRequested"),
 		};
 
 		listInfo.mapKeys((key, value) => {
@@ -152,6 +169,10 @@ class ListSelectorHelper {
 	getNextPageToLoad = state => {
 		return state.getIn([this.groupPropertyName, "nextPageToLoad"]);
 	};
+
+	getSearchRequested = state => {
+		return state.getIn([this.groupPropertyName, "searchRequested"]);
+	};
 }
 
 class ListHelper {
@@ -182,6 +203,7 @@ class ListHelper {
 		index,
 		list,
 		totalCount,
+		searchRequested,
 		...additionalValues
 	} = {}) => {
 		return {
@@ -194,6 +216,7 @@ class ListHelper {
 				index: index ?? {},
 				list: list ?? [],
 				totalCount: totalCount ?? 0,
+				searchRequested: searchRequested ?? false,
 				...additionalValues,
 			},
 		};

package/src/utils/ListHelper.test.js

@@ -14,6 +14,7 @@ describe("createInitialListInfo", () => {
 				index: {},
 				list: [],
 				totalCount: 0,
+				searchRequested: false,
 			},
 		});
 	});
@@ -33,6 +34,7 @@ describe("createInitialListInfo", () => {
 				index: {},
 				list: [],
 				totalCount: 0,
+				searchRequested: false,
 				prop1: 123,
 				prop2: { subprop: "a" },
 			},
@@ -49,6 +51,7 @@ describe("createInitialListInfo", () => {
 			index: { c: 1 },
 			list: [1, 2, 3],
 			totalCount: 10,
+			searchRequested: false,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		});
@@ -62,6 +65,7 @@ describe("createInitialListInfo", () => {
 				index: { c: 1 },
 				list: [1, 2, 3],
 				totalCount: 10,
+				searchRequested: false,
 				prop1: 123,
 				prop2: { subprop: "a" },
 			},
@@ -82,6 +86,7 @@ describe("createListInfoFrom", () => {
 				index: {},
 				list: [],
 				totalCount: 0,
+				searchRequested: false,
 			},
 		});
 	});
@@ -101,6 +106,7 @@ describe("createListInfoFrom", () => {
 				index: {},
 				list: [],
 				totalCount: 0,
+				searchRequested: false,
 				prop1: 123,
 				prop2: { subprop: "a" },
 			},
@@ -117,6 +123,7 @@ describe("createListInfoFrom", () => {
 			index: { c: 1 },
 			list: [1, 2, 3],
 			totalCount: 10,
+			searchRequested: false,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		});
@@ -130,6 +137,7 @@ describe("createListInfoFrom", () => {
 				index: { c: 1 },
 				list: [1, 2, 3],
 				totalCount: 10,
+				searchRequested: false,
 				prop1: 123,
 				prop2: { subprop: "a" },
 			},
@@ -148,6 +156,7 @@ describe("ListSelectorHelper", () => {
 			index: { c: 1 },
 			list: [1, 2, 3],
 			totalCount: 10,
+			searchRequested: true,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		}),
@@ -168,6 +177,11 @@ describe("ListSelectorHelper", () => {
 		expect(value, "to equal", Immutable.fromJS({ c: 1 }));
 	});
 
+	it("getSearchRequested", () => {
+		const value = ListHelper.selector.getSearchRequested(initialState);
+		expect(value, "to equal", true);
+	});
+
 	it("getCurrentInfo", () => {
 		const value = ListHelper.selector.getCurrentInfo(initialState);
 		expect(value, "to equal", {
@@ -176,6 +190,7 @@ describe("ListSelectorHelper", () => {
 			currentScope: "canada",
 			currentPage: 1,
 			totalCount: 10,
+			searchRequested: true,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		});
@@ -191,6 +206,7 @@ describe("ListSelectorHelper", () => {
 			currentScope: "canada",
 			currentPage: 1,
 			totalCount: 10,
+			searchRequested: true,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		});
@@ -204,6 +220,7 @@ describe("ListSelectorHelper", () => {
 			currentScope: undefined,
 			currentPage: undefined,
 			totalCount: undefined,
+			searchRequested: undefined,
 		});
 	});
 });
@@ -219,6 +236,7 @@ describe("ListReducerHelper", () => {
 			index: { c: 1 },
 			list: [1, 2, 3],
 			totalCount: 10,
+			searchRequested: false,
 			prop1: 123,
 			prop2: { subprop: "a" },
 		}),
@@ -239,6 +257,30 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
+					prop1: 123,
+					prop2: { subprop: "a" },
+				}),
+			),
+		);
+	});
+
+	it("setSearchRequested", () => {
+		const newState = ListHelper.reducer.setSearchRequested(initialState, true);
+		expect(
+			newState,
+			"to equal",
+			Immutable.fromJS(
+				ListHelper.createListInfoFrom({
+					sorting: { a: 1 },
+					filters: { b: 1 },
+					scope: "canada",
+					page: 1,
+					nextPageToLoad: 2,
+					index: { c: 1 },
+					list: [1, 2, 3],
+					totalCount: 10,
+					searchRequested: true,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -269,6 +311,7 @@ describe("ListReducerHelper", () => {
 					index: { d: 1 },
 					list: [4, 5, 6],
 					totalCount: 222,
+					searchRequested: undefined,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -300,6 +343,7 @@ describe("ListReducerHelper", () => {
 					index: {},
 					list: [4, 5, 6],
 					totalCount: 222,
+					searchRequested: undefined,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -327,6 +371,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1, d: 1 },
 					list: [1, 2, 3, 4, 5, 6],
 					totalCount: 222,
+					searchRequested: undefined,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -354,6 +399,7 @@ describe("ListReducerHelper", () => {
 					index: { d: 1 },
 					list: [4, 5, 6],
 					totalCount: 222,
+					searchRequested: undefined,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -384,6 +430,7 @@ describe("ListReducerHelper", () => {
 					index: {},
 					list: [],
 					totalCount: 0,
+					searchRequested: false,
 					prop1: 456,
 					prop2: { subprop: "b" },
 				}),
@@ -414,6 +461,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 456,
 					prop2: { subprop: "b" },
 				}),
@@ -444,6 +492,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 456,
 					prop3: 789,
 				}),
@@ -472,6 +521,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 				}),
 			),
 		);
@@ -500,6 +550,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 456,
 					prop2: { subprop: "b" },
 				}),
@@ -522,6 +573,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 				}),
 			),
 		);
@@ -542,6 +594,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1, d: 888 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -564,6 +617,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3, 888],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -586,6 +640,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 888 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -608,6 +663,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -630,6 +686,7 @@ describe("ListReducerHelper", () => {
 					index: {},
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -652,6 +709,7 @@ describe("ListReducerHelper", () => {
 					index: { c: 1 },
 					list: [1, 2, 3],
 					totalCount: 10,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -674,6 +732,7 @@ describe("ListReducerHelper", () => {
 					index: {},
 					list: [],
 					totalCount: 0,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),
@@ -701,6 +760,7 @@ describe("ListReducerHelper", () => {
 					index: {},
 					list: [],
 					totalCount: 0,
+					searchRequested: false,
 					prop1: 123,
 					prop2: { subprop: "a" },
 				}),