@fluid-topics/ft-search-context 2.2.6 → 2.2.8

package/build/store/FtSearchStateManager.d.ts

@@ -1,5 +1,5 @@
 import { FtSearchPageState } from "./model";
-import { FtReduxStore, FtStateManager, ReduxWatcher } from "@fluid-topics/ft-wc-utils";
+import { FtReduxStore, FtStateManager } from "@fluid-topics/ft-wc-utils";
 import { FtSearchPageStateReducers } from "./redux";
 import { FtDateFilterTypeKeys, FtMetadataFilter, FtPublicClusterSortCriterion, FtSearchKeywordMatch, FtSearchRequest, FtSearchScope, FtSearchSortCriterion, FtSuggestRequest, FtVirtualField } from "@fluid-topics/public-api";
 import { FtSearchService } from "./utils/FtSearchService";
@@ -13,14 +13,16 @@ export declare class FtSearchStateManager extends FtStateManager {
     ignoreEmptyQuery: boolean;
     canUpdateUiLocale: boolean;
     openExternalDocumentInNewTab: boolean;
-    protected readonly searchWatcher: ReduxWatcher<FtSearchPageState, FtSearchRequest>;
-    protected readonly suggestWatcher: ReduxWatcher<FtSearchPageState, FtSuggestRequest>;
+    applyStickyFilters: boolean;
+    private readonly searchWatcher;
+    private readonly suggestWatcher;
+    private readonly stickyFiltersIdWatcher;
+    private readonly history;
     constructor(store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>, service?: FtSearchService);
     onNewNeededRequest: (neededRequest: string) => void;
     initService(): Promise<boolean>;
     addListeners(): void;
     removeListeners(): void;
-    private get recentQueriesStorageKey();
     private get taruqaConfigStorageKey();
     private onStorageEvent;
     private updateSearchRequest;
@@ -58,11 +60,10 @@ export declare class FtSearchStateManager extends FtStateManager {
     setIgnoreEmptyQuery(ignoreEmptyQuery: boolean): void;
     setOpenExternalDocumentInNewTab(openExternalDocumentInNewTab: boolean): void;
     setCanUpdateUiLocale(canUpdateUiLocale: boolean): void;
+    setApplyStickyFilters(applyStickyFilters: boolean): void;
     private loadTaruqaTemplate;
-    private loadRecentQueries;
     addRecentQuery(query: string): void;
     removeRecentQuery(query: string): void;
-    private setRecentQueries;
     private localesDebouncer;
     updateLocales(): Promise<boolean>;
     private searchDebouncer;

package/build/store/FtSearchStateManager.js

@@ -1,5 +1,5 @@
 import { FtSearchStateResourceRequest, } from "./model";
-import { cancelable, CanceledPromiseError, Debouncer, deepCopy, FtStateManager, minmax, watch, } from "@fluid-topics/ft-wc-utils";
+import { cancelable, CanceledPromiseError, Debouncer, deepCopy, FtStateManager, minmax, ReduxWatcher, QueryHistoryStorage, } from "@fluid-topics/ft-wc-utils";
 import { createSearchPageStore, } from "./redux";
 import { FtSearchKeywordMatch, FtSearchScope, FtUserRole, FtVirtualField, userHasRole, } from "@fluid-topics/public-api";
 import { FtSearchService } from "./utils/FtSearchService";
@@ -8,7 +8,6 @@ import { AuthenticationChangeEvent, ftAppInfoStore, ftAppStateManager, } from "@
 export const searchInDocumentTitlesOnlySelector = (s) => s.request.virtualField === FtVirtualField.TITLE_ONLY
     && s.request.scope === FtSearchScope.DOCUMENTS;
 export const keywordMatchSelector = (s) => s.request.keywordMatch == FtSearchKeywordMatch.MANDATORY;
-const maxRecentQueries = 20;
 export class FtSearchStateManager extends FtStateManager {
     static build(id, service) {
         return new FtSearchStateManager(createSearchPageStore(id.trim() || "context"), service);
@@ -19,17 +18,16 @@ export class FtSearchStateManager extends FtStateManager {
         this.ignoreEmptyQuery = false;
         this.canUpdateUiLocale = false;
         this.openExternalDocumentInNewTab = false;
+        this.applyStickyFilters = false;
+        this.history = new QueryHistoryStorage(this.store.actions.recentQueries);
         this.onNewNeededRequest = (neededRequest) => {
             if (neededRequest == FtSearchStateResourceRequest.CLUSTERED_SEARCH) {
-                this.launchSearch(this.buildSearchRequest(this.store.getState()));
+                this.launchSearch();
             }
         };
         this.onStorageEvent = (e) => {
             // detect changes from any context
-            if (e.key === this.recentQueriesStorageKey) {
-                this.loadRecentQueries();
-            }
-            else if (e.key === this.taruqaConfigStorageKey) {
+            if (e.key === this.taruqaConfigStorageKey) {
                 this.loadTaruqaTemplate();
             }
         };
@@ -45,28 +43,31 @@ export class FtSearchStateManager extends FtStateManager {
         this.localesDebouncer = new Debouncer(10);
         this.searchDebouncer = new Debouncer(100);
         this.launchSearch = (request) => {
-            return this.searchDebouncer.run(() => this.fetchSearchData(request !== null && request !== void 0 ? request : this.buildSearchRequest(this.store.getState())));
+            return this.searchDebouncer.run(() => this.fetchSearchData(request !== null && request !== void 0 ? request : this.buildSearchRequest()));
         };
-        this.buildSearchRequest = (state) => {
+        this.buildSearchRequest = (searchState = this.store.getState()) => {
+            var _a;
             return {
-                ...state.request,
+                ...searchState.request,
                 facets: this.facetIds.map((id) => ({ id })),
+                stickyFiltersId: this.applyStickyFilters ? (_a = ftAppInfoStore.getState().stickyFilters) === null || _a === void 0 ? void 0 : _a.id : undefined,
             };
         };
         this.suggestDebouncer = new Debouncer(1000);
         this.launchSuggest = (request) => {
-            return this.suggestDebouncer.run(() => this.fetchSuggestData(request !== null && request !== void 0 ? request : this.buildSuggestRequest(this.store.getState())));
+            return this.suggestDebouncer.run(() => this.fetchSuggestData(request !== null && request !== void 0 ? request : this.buildSuggestRequest()));
         };
-        this.buildSuggestRequest = (state) => {
-            var _a;
+        this.buildSuggestRequest = (searchState = this.store.getState()) => {
+            var _a, _b;
             return {
-                input: state.liveQuery,
-                metadataFilters: state.request.metadataFilters,
-                sort: (_a = state.request.sort) !== null && _a !== void 0 ? _a : [],
-                sortId: state.request.sortId,
-                contentLocale: state.request.contentLocale,
-                scope: state.request.scope,
-                keywordMatch: state.request.keywordMatch,
+                input: searchState.liveQuery,
+                metadataFilters: searchState.request.metadataFilters,
+                sort: (_a = searchState.request.sort) !== null && _a !== void 0 ? _a : [],
+                sortId: searchState.request.sortId,
+                contentLocale: searchState.request.contentLocale,
+                scope: searchState.request.scope,
+                keywordMatch: searchState.request.keywordMatch,
+                stickyFiltersId: this.applyStickyFilters ? (_b = ftAppInfoStore.getState().stickyFilters) === null || _b === void 0 ? void 0 : _b.id : undefined,
             };
         };
         this.service = service !== null && service !== void 0 ? service : new FtSearchService();
@@ -75,8 +76,14 @@ export class FtSearchStateManager extends FtStateManager {
                 this.updateLocales();
             }
         });
-        this.searchWatcher = watch(store, this.buildSearchRequest, this.launchSearch);
-        this.suggestWatcher = watch(store, this.buildSuggestRequest, this.launchSuggest);
+        this.searchWatcher = new ReduxWatcher(store, this.buildSearchRequest, this.launchSearch);
+        this.suggestWatcher = new ReduxWatcher(store, this.buildSuggestRequest, this.launchSuggest);
+        this.stickyFiltersIdWatcher = new ReduxWatcher(ftAppInfoStore, (store) => { var _a; return (_a = store.stickyFilters) === null || _a === void 0 ? void 0 : _a.id; }, () => {
+            if (this.applyStickyFilters) {
+                this.launchSearch();
+                this.launchSuggest();
+            }
+        });
     }
     async initService() {
         this.updateLocales();
@@ -84,20 +91,24 @@ export class FtSearchStateManager extends FtStateManager {
             this.store.actions.configuration(conf);
             this.setSortId(this.store.getState().request.sortId);
         });
-        this.loadRecentQueries();
         this.loadTaruqaTemplate();
         return this.launchSearch();
     }
     addListeners() {
         window.addEventListener("storage", this.onStorageEvent);
         ftAppInfoStore.addEventListener(AuthenticationChangeEvent.eventName, this.loadTaruqaTemplate);
+        this.searchWatcher.watch();
+        this.suggestWatcher.watch();
+        this.stickyFiltersIdWatcher.watch();
+        this.history.enable(ftAppInfoStore.getState().tenantId + "-ft-recent-queries");
     }
     removeListeners() {
         window.removeEventListener("storage", this.onStorageEvent);
         ftAppInfoStore.removeEventListener(AuthenticationChangeEvent.eventName, this.loadTaruqaTemplate);
-    }
-    get recentQueriesStorageKey() {
-        return ftAppInfoStore.getState().tenantId + "-ft-recent-queries";
+        this.searchWatcher.stop();
+        this.suggestWatcher.stop();
+        this.stickyFiltersIdWatcher.stop();
+        this.history.disable();
     }
     get taruqaConfigStorageKey() {
         return ftAppInfoStore.getState().tenantId + "-taruqa-experiment-conf";
@@ -324,38 +335,16 @@ export class FtSearchStateManager extends FtStateManager {
     setCanUpdateUiLocale(canUpdateUiLocale) {
         this.canUpdateUiLocale = canUpdateUiLocale;
     }
-    loadRecentQueries() {
-        var _a;
-        this.store.actions.recentQueries(JSON.parse((_a = window.localStorage.getItem(this.recentQueriesStorageKey)) !== null && _a !== void 0 ? _a : "[]"));
+    setApplyStickyFilters(applyStickyFilters) {
+        this.applyStickyFilters = applyStickyFilters;
+        this.launchSearch();
+        this.launchSuggest();
     }
     addRecentQuery(query) {
-        query = query.trim();
-        if (query.length === 0) {
-            return;
-        }
-        const normalizedQuery = query.toLowerCase();
-        const newValue = this.store.getState().recentQueries.filter((q) => q.toLowerCase() !== normalizedQuery).slice(0, maxRecentQueries - 1);
-        newValue.unshift(query);
-        this.setRecentQueries(newValue);
+        this.history.addRecentQuery(query);
     }
     removeRecentQuery(query) {
-        const normalizedQuery = query.trim().toLowerCase();
-        const original = this.store.getState().recentQueries;
-        const otherQueries = original.filter((q) => q.toLowerCase() !== normalizedQuery);
-        if (original.length !== otherQueries.length) {
-            this.setRecentQueries(otherQueries);
-        }
-    }
-    setRecentQueries(queries) {
-        const newValue = JSON.stringify(queries);
-        window.localStorage.setItem(this.recentQueriesStorageKey, newValue);
-        // notify all contexts
-        window.dispatchEvent(new StorageEvent("storage", {
-            key: this.recentQueriesStorageKey,
-            newValue,
-            storageArea: window.localStorage,
-            url: window.location.href,
-        }));
+        this.history.removeRecentQuery(query);
     }
     updateLocales() {
         return this.localesDebouncer.run(async () => this.store.actions.locales((await this.service.getAvailableSearchLocales()).contentLocales));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-search-context",
-    "version": "2.2.6",
+    "version": "2.2.8",
     "description": "Context block for integrated search components",
     "keywords": [
         "Lit"
@@ -19,12 +19,12 @@
         "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
     },
     "dependencies": {
-        "@fluid-topics/ft-app-context": "2.2.6",
-        "@fluid-topics/ft-wc-utils": "2.2.6",
+        "@fluid-topics/ft-app-context": "2.2.8",
+        "@fluid-topics/ft-wc-utils": "2.2.8",
         "lit": "3.3.3"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.139"
+        "@fluid-topics/public-api": "1.0.140"
     },
-    "gitHead": "f482cb39331ccd1668b13e3debc0b652310aadc2"
+    "gitHead": "ab4f238ee886c127d570b5c97eaff3c945ad2561"
 }