@fluid-topics/ft-search-context 2.0.16 → 2.0.17

package/build/store/FtSearchStateManager.d.ts

@@ -18,6 +18,7 @@ export declare class FtSearchStateManager extends FtStateManager {
     constructor(store: FtReduxStore<FtSearchPageState, FtSearchPageStateReducers>, service?: FtSearchService);
     onNewNeededRequest: (neededRequest: string) => void;
     initService(): Promise<boolean>;
+    private updateSearchRequest;
     setQuery(query: string): void;
     setContentLocale(contentLocale?: string): string | undefined;
     forceContentLocale(contentLocale?: string): void;
@@ -25,11 +26,11 @@ export declare class FtSearchStateManager extends FtStateManager {
     setPageNumber(pageNumber: number): void;
     get sortOptions(): import("@fluid-topics/public-api").FtSearchSortOption[];
     setSort(sort: FtSearchSortCriterion[]): void;
-    setSortId(sortId?: string): string | undefined;
+    setSortId(sortId?: string, automaticallyChangedByConfiguraiton?: boolean): string | undefined;
     setFilters(filters: FtMetadataFilter[]): void;
-    setClusterSortCriterion(criterions: FtPublicClusterSortCriterion[]): void;
+    setClusterSortCriterion(clusterSortCriterions: FtPublicClusterSortCriterion[]): void;
     setSearchInDocumentTitlesOnly(searchInDocumentTitleOnly: boolean): void;
-    setKeywordMatch(matchAllKeywords?: FtSearchKeywordMatch): void;
+    setKeywordMatch(keywordMatch?: FtSearchKeywordMatch): void;
     setVirtualField(virtualField: FtVirtualField): void;
     get searchInDocumentTitlesOnly(): boolean;
     get keywordMatch(): boolean;
@@ -48,7 +49,7 @@ export declare class FtSearchStateManager extends FtStateManager {
     setLiveQuery(query: string): void;
     setRequest(request: FtSearchRequest): void;
     setScope(scope: FtSearchScope): void;
-    setOtherQueryParams(params: Record<string, string>): void;
+    setOtherQueryParams(otherQueryParams: Record<string, string>): void;
     setIgnoreEmptyQuery(ignoreEmptyQuery: boolean): void;
     setOpenExternalDocumentInNewTab(openExternalDocumentInNewTab: boolean): void;
     setCanUpdateUiLocale(canUpdateUiLocale: boolean): void;

package/build/store/FtSearchStateManager.js

@@ -1,5 +1,5 @@
 import { FtSearchStateResourceRequest, } from "./model";
-import { cancelable, CanceledPromiseError, Debouncer, FtStateManager, watch, } from "@fluid-topics/ft-wc-utils";
+import { cancelable, CanceledPromiseError, Debouncer, deepCopy, FtStateManager, minmax, watch, } from "@fluid-topics/ft-wc-utils";
 import { createSearchPageStore, } from "./redux";
 import { FtSearchKeywordMatch, FtSearchScope, FtVirtualField, } from "@fluid-topics/public-api";
 import { FtSearchService } from "./utils/FtSearchService";
@@ -67,10 +67,20 @@ export class FtSearchStateManager extends FtStateManager {
         });
         return this.launchSearch();
     }
+    updateSearchRequest(partialRequest, resetPaging = false) {
+        const request = deepCopy(this.store.getState().request);
+        delete request.changedByConfiguration;
+        this.store.actions.setRequest({
+            ...request,
+            paging: {
+                perPage: request.paging.perPage,
+                page: resetPaging ? 1 : request.paging.page,
+            },
+            ...partialRequest,
+        });
+    }
     setQuery(query) {
-        this.store.actions.setRequestQuery(query);
-        this.store.actions.liveQuery(query);
-        this.store.actions.setPageNumber(1);
+        this.updateSearchRequest({ query }, true);
     }
     setContentLocale(contentLocale) {
         var _a, _b;
@@ -83,9 +93,7 @@ export class FtSearchStateManager extends FtStateManager {
                     contentLocale = isKnown(previousContentLocale) ? previousContentLocale : locales[0].lang;
                 }
             }
-            this.store.actions.setRequestContentLocale(contentLocale);
-            this.store.actions.setPageNumber(1);
-            this.store.actions.setRequestFilters([]);
+            this.updateSearchRequest({ contentLocale, metadataFilters: [] }, true);
             if (this.canUpdateUiLocale && ((_b = ftAppStateManager.localesConfiguration) === null || _b === void 0 ? void 0 : _b.searchLanguageSetsUiLanguage) && contentLocale) {
                 ftAppStateManager.requestUiLocaleUpdate(contentLocale);
             }
@@ -93,58 +101,64 @@ export class FtSearchStateManager extends FtStateManager {
         return contentLocale;
     }
     forceContentLocale(contentLocale) {
-        this.store.actions.setRequestContentLocale(contentLocale);
+        this.updateSearchRequest({ contentLocale });
     }
     setPageSize(pageSize) {
-        this.store.actions.setPageSize(pageSize);
+        const request = this.store.getState().request;
+        this.updateSearchRequest({
+            paging: {
+                ...request.paging,
+                perPage: isNaN(pageSize) ? 20 : minmax(1, pageSize, 1000),
+            },
+        });
     }
     setPageNumber(pageNumber) {
-        this.store.actions.setPageNumber(pageNumber);
+        const request = this.store.getState().request;
+        this.updateSearchRequest({
+            paging: {
+                ...request.paging,
+                page: isNaN(pageNumber) ? 1 : Math.max(1, pageNumber),
+            },
+        });
     }
     get sortOptions() {
         var _a, _b;
         return (_b = (_a = this.store.getState().configuration) === null || _a === void 0 ? void 0 : _a.sortOptions) !== null && _b !== void 0 ? _b : [];
     }
     setSort(sort) {
-        this.store.actions.setRequestSort(sort);
-        this.store.actions.setPageNumber(1);
+        this.updateSearchRequest({ sort }, true);
     }
-    setSortId(sortId) {
+    setSortId(sortId, automaticallyChangedByConfiguraiton = false) {
         var _a;
-        this.store.actions.setPageNumber(1);
+        const changedByConfiguration = automaticallyChangedByConfiguraiton ? { changedByConfiguration: true } : {};
         if (sortId == undefined || this.sortOptions.length == 0) {
-            this.store.actions.setRequestSortId(sortId);
+            this.updateSearchRequest({ sortId: sortId, ...changedByConfiguration }, true);
             return sortId;
         }
         const selectedSort = (_a = this.sortOptions.find((option) => option.id == sortId)) !== null && _a !== void 0 ? _a : this.sortOptions[0];
-        this.store.actions.setRequestSortId(selectedSort.id);
+        this.updateSearchRequest({ sortId: selectedSort.id, ...changedByConfiguration }, true);
         return selectedSort.id;
     }
     setFilters(filters) {
         const cleanFilters = filters.filter((f) => !f.valueFilter || f.valueFilter.values.length > 0);
-        this.store.actions.setRequestFilters(cleanFilters);
-        this.store.actions.setPageNumber(1);
+        this.updateSearchRequest({ metadataFilters: cleanFilters }, true);
     }
-    setClusterSortCriterion(criterions) {
-        this.store.actions.setRequestClusterSortCriterion(criterions);
+    setClusterSortCriterion(clusterSortCriterions) {
+        this.updateSearchRequest({ clusterSortCriterions });
     }
     setSearchInDocumentTitlesOnly(searchInDocumentTitleOnly) {
         if (searchInDocumentTitleOnly) {
-            this.store.actions.setRequestVirtualField(FtVirtualField.TITLE_ONLY);
-            this.store.actions.setRequestScope(FtSearchScope.DOCUMENTS);
+            this.updateSearchRequest({ virtualField: FtVirtualField.TITLE_ONLY, scope: FtSearchScope.DOCUMENTS }, true);
         }
         else {
-            this.store.actions.setRequestVirtualField(FtVirtualField.EVERYWHERE);
-            this.store.actions.setRequestScope(FtSearchScope.DEFAULT);
+            this.updateSearchRequest({ virtualField: FtVirtualField.EVERYWHERE, scope: FtSearchScope.DEFAULT }, true);
         }
-        this.store.actions.setPageNumber(1);
     }
-    setKeywordMatch(matchAllKeywords) {
-        this.store.actions.setKeywordMatch(matchAllKeywords);
-        this.store.actions.setPageNumber(1);
+    setKeywordMatch(keywordMatch) {
+        this.updateSearchRequest({ keywordMatch }, true);
     }
     setVirtualField(virtualField) {
-        this.store.actions.setRequestVirtualField(virtualField);
+        this.updateSearchRequest({ virtualField }, true);
     }
     get searchInDocumentTitlesOnly() {
         return searchInDocumentTitlesOnlySelector(this.store.getState());
@@ -179,8 +193,8 @@ export class FtSearchStateManager extends FtStateManager {
     }
     set facetIds(ids) {
         const uniqIds = [...new Set(ids)];
-        const facetsConf = uniqIds.map((id) => ({ id: id }));
-        this.store.actions.setRequestFacets(facetsConf);
+        const facets = uniqIds.map((id) => ({ id: id }));
+        this.updateSearchRequest({ facets });
     }
     /** @deprecated */
     setFilter(key, values) {
@@ -253,18 +267,16 @@ export class FtSearchStateManager extends FtStateManager {
         this.store.actions.liveQuery(query);
     }
     setRequest(request) {
-        this.store.actions.setRequest({
+        this.updateSearchRequest({
             ...request,
             facets: this.store.getState().request.facets,
-        });
-        this.store.actions.liveQuery(request.query);
-        this.store.actions.setPageNumber(1);
+        }, true);
     }
     setScope(scope) {
-        this.store.actions.setRequestScope(scope);
+        this.updateSearchRequest({ scope });
     }
-    setOtherQueryParams(params) {
-        this.store.actions.setOtherQueryParams(params);
+    setOtherQueryParams(otherQueryParams) {
+        this.updateSearchRequest({ otherQueryParams });
     }
     setIgnoreEmptyQuery(ignoreEmptyQuery) {
         this.ignoreEmptyQuery = ignoreEmptyQuery;

package/build/store/redux.d.ts

@@ -3,35 +3,9 @@ import { FtSearchPageState } from "./model";
 import { FtReduxStore } from "@fluid-topics/ft-wc-utils";
 declare const searchPageStateReducers: {
     setRequest: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]>) => void;
-    setRequestQuery: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["query"]>) => void;
-    setRequestContentLocale: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["contentLocale"]>) => void;
-    setPageSize: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["paging"]["perPage"]>) => void;
-    setPageNumber: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["paging"]["page"]>) => void;
-    setRequestSort: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["sort"]>) => void;
-    setRequestSortId: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["sortId"]>) => void;
-    setRequestFilters: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["metadataFilters"]>) => void;
-    setRequestFacets: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["facets"]>) => void;
-    setRequestVirtualField: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["virtualField"]>) => void;
-    setRequestScope: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["scope"]>) => void;
-    setOtherQueryParams: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["otherQueryParams"]>) => void;
-    setRequestClusterSortCriterion: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["clusterSortCriterions"]>) => void;
-    setKeywordMatch: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["keywordMatch"]>) => void;
 };
 export type FtSearchPageStateReducers = typeof searchPageStateReducers;
 export declare const createSearchPageStore: (id: string) => FtReduxStore<FtSearchPageState, {
     setRequest: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]>) => void;
-    setRequestQuery: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["query"]>) => void;
-    setRequestContentLocale: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["contentLocale"]>) => void;
-    setPageSize: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["paging"]["perPage"]>) => void;
-    setPageNumber: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["paging"]["page"]>) => void;
-    setRequestSort: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["sort"]>) => void;
-    setRequestSortId: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["sortId"]>) => void;
-    setRequestFilters: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["metadataFilters"]>) => void;
-    setRequestFacets: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["facets"]>) => void;
-    setRequestVirtualField: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["virtualField"]>) => void;
-    setRequestScope: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["scope"]>) => void;
-    setOtherQueryParams: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["otherQueryParams"]>) => void;
-    setRequestClusterSortCriterion: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["clusterSortCriterions"]>) => void;
-    setKeywordMatch: (state: FtSearchPageState, action: PayloadAction<FtSearchPageState["request"]["keywordMatch"]>) => void;
 }, import("redux").AnyAction>;
 export {};

package/build/store/redux.js

@@ -1,50 +1,8 @@
-import { FtReduxStore, minmax } from "@fluid-topics/ft-wc-utils";
+import { FtReduxStore } from "@fluid-topics/ft-wc-utils";
 const searchPageStateReducers = {
     setRequest: (state, action) => {
         state.request = action.payload;
     },
-    setRequestQuery: (state, action) => {
-        state.request.query = action.payload;
-    },
-    setRequestContentLocale: (state, action) => {
-        state.request.contentLocale = action.payload;
-    },
-    setPageSize: (state, action) => {
-        var _a;
-        const perPage = +((_a = action.payload) !== null && _a !== void 0 ? _a : 20);
-        state.request.paging.perPage = isNaN(perPage) ? 20 : minmax(1, perPage, 1000);
-    },
-    setPageNumber: (state, action) => {
-        state.request.paging.page = isNaN(action.payload) ? 1 : Math.max(1, action.payload);
-    },
-    setRequestSort: (state, action) => {
-        state.request.sort = action.payload;
-    },
-    setRequestSortId: (state, action) => {
-        state.request.sortId = action.payload;
-    },
-    setRequestFilters: (state, action) => {
-        state.request.metadataFilters = action.payload;
-    },
-    setRequestFacets: (state, action) => {
-        state.request.facets = action.payload;
-    },
-    setRequestVirtualField: (state, action) => {
-        state.request.virtualField = action.payload;
-    },
-    setRequestScope: (state, action) => {
-        state.request.scope = action.payload;
-    },
-    setOtherQueryParams: (state, action) => {
-        state.request.otherQueryParams = action.payload;
-    },
-    setRequestClusterSortCriterion: (state, action) => {
-        var _a;
-        state.request.clusterSortCriterions = (_a = action.payload) !== null && _a !== void 0 ? _a : [];
-    },
-    setKeywordMatch: (state, action) => {
-        state.request.keywordMatch = action.payload;
-    },
 };
 export const createSearchPageStore = (id) => FtReduxStore.get({
     name: "ft-search-" + id,

package/build/utils.d.ts

@@ -1,5 +1,6 @@
 import { FtSearchRequest, FtSearchResultClusterEntry, FtSearchResultsPageInfo, FtSpellcheck } from "@fluid-topics/public-api";
 import { FtSearchResultsChangeEventDetail } from "./store/model";
+import { EnrichedFtSearchRequest } from "@fluid-topics/ft-wc-utils";
 export declare class SearchResultClickEvent extends CustomEvent<{
     result: FtSearchResultClusterEntry;
     rank: number;
@@ -15,7 +16,7 @@ export declare class SearchResultOpenContextMenuEvent extends CustomEvent<{
 export declare class LoadErrorEvent extends CustomEvent<Error> {
     constructor(e: Error);
 }
-export declare class SearchRequestChangeEvent extends CustomEvent<FtSearchRequest> {
+export declare class SearchRequestChangeEvent extends CustomEvent<EnrichedFtSearchRequest> {
     constructor(request: FtSearchRequest);
 }
 export declare class SearchResultsChangeEvent extends CustomEvent<FtSearchResultsChangeEventDetail> {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-search-context",
-    "version": "2.0.16",
+    "version": "2.0.17",
     "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.0.16",
-        "@fluid-topics/ft-wc-utils": "2.0.16",
+        "@fluid-topics/ft-app-context": "2.0.17",
+        "@fluid-topics/ft-wc-utils": "2.0.17",
         "lit": "3.1.0"
     },
     "devDependencies": {
         "@fluid-topics/public-api": "1.0.120"
     },
-    "gitHead": "a972b95acf70b2bfab648ae99cec9d9cbe77c86f"
+    "gitHead": "630c12bb34a3f0df02b112fc182bbbb97025d959"
 }