chore(table-state): add missing comment, fix test

libs/ngx-nuts-and-bolts/src/lib/utilities/table-state/table-state.spec.ts

@@ -205,10 +205,10 @@ describe('Table sate', () => {
 		};
 
 		await changeFilters(router, filters);
-		expect(callbacks.next.mock.calls[callbacks.next.mock.calls.length - 1][0]).not.toBe(null);
+		expect(callbacks.next.mock.calls[callbacks.next.mock.calls.length - 1][0]).toBe(null);
 	});
 
-	fit('should not set custom filter observable value to null if object filter is truthy', async () => {
+	it('should not set custom filter observable value to null if object filter is truthy', async () => {
 		const callbacks = mockSubscribeCallbacks();
 
 		createCustomFiltersObservable(route, router).subscribe(callbacks);
@@ -244,6 +244,19 @@ describe('Table sate', () => {
 
 		expect(navigationSpy).toHaveBeenCalledTimes(1);
 	});
+
+	it('should set scoped custom filter observable value to null if filter is empty', async () => {
+		const scopedFilters = 'scoped-filters';
+		const callbacks = mockSubscribeCallbacks();
+
+		createCustomFiltersObservable(route, router, scopedFilters).subscribe(callbacks);
+		expect(callbacks.next).toHaveBeenLastCalledWith(null);
+
+		const filters = {};
+
+		await changeFilters(router, filters, scopedFilters);
+		expect(callbacks.next).toHaveBeenLastCalledWith(null);
+	});
 });
 
 function mockSubscribeCallbacks() {

libs/ngx-nuts-and-bolts/src/lib/utilities/table-state/table-state.ts

@@ -96,7 +96,7 @@ export function createCustomFiltersObservable<TFilterValue extends Record<string
 			}
 
 			if (filters && isFilterEmpty(filters)) {
-				clearFilters(router);
+				clearFilters(router, queryParamsScope);
 				return null;
 			}
 
@@ -147,6 +147,7 @@ export function changeSort(router: Router, sort: ISortInfo): Promise<boolean> {
  * Creates query params and encodes them based on passed filter value.
  * @param {Router} router - Router instance used in component.
  * @param {TFilterValue} filterValue - Object containing properties used for filtering
+ * @param {string} queryParamsScope - String value representing your scoped queryParam
  */
 export function changeFilters<TFilterValue extends Record<string, unknown> | null = null>(
 	router: Router,
@@ -190,12 +191,19 @@ function isFilterEmpty<TFilterValue extends Record<string, unknown> | null = nul
 	return !filterHasSomeValue;
 }
 
-function clearFilters(router: Router): void {
+/**
+ *
+ * Creates query params and encodes them based on passed filter value.
+ * @param {Router} router - Router instance used in component.
+ * @param {string} queryParamsScope - String value representing your scoped queryParam
+ */
+
+function clearFilters(router: Router, queryParamsScope?: string): void {
 	router.navigate([], {
 		replaceUrl: true,
 		queryParamsHandling: 'merge',
 		queryParams: {
-			[TableQueryParam.CUSTOM_FILTERS]: null,
+			[queryParamsScope || TableQueryParam.CUSTOM_FILTERS]: null,
 		},
 	});
 }