@fluid-topics/ft-search-context 1.3.15 → 1.3.17

package/build/store/FtSearchStateManager.d.ts

@@ -24,7 +24,9 @@ export declare class FtSearchStateManager {
     forceContentLocale(contentLocale?: string): void;
     setPageSize(pageSize: number): void;
     setPageNumber(pageNumber: number): void;
+    get sortOptions(): import("@fluid-topics/public-api").FtSearchSortOption[];
     setSort(sort: FtSearchSortCriterion[]): void;
+    setSortId(sortId?: string): string | undefined;
     setFilters(filters: FtMetadataFilter[]): void;
     setClusterSortCriterion(criterions: FtPublicClusterSortCriterion[]): void;
     setSearchInDocumentTitlesOnly(searchInDocumentTitleOnly: boolean): void;

package/build/store/FtSearchStateManager.js

@@ -27,7 +27,7 @@ export class FtSearchStateManager {
         this.buildSearchRequest = (state) => {
             return {
                 ...state.request,
-                facets: this.facetIds.map(id => ({ id })),
+                facets: this.facetIds.map((id) => ({ id })),
             };
         };
         this.suggestDebouncer = new Debouncer(300);
@@ -35,10 +35,12 @@ export class FtSearchStateManager {
             return this.suggestDebouncer.run(() => this.fetchSuggestData(request !== null && request !== void 0 ? request : this.buildSuggestRequest(this.store.getState())));
         };
         this.buildSuggestRequest = (state) => {
+            var _a;
             return {
                 input: state.liveQuery,
                 metadataFilters: state.request.metadataFilters,
-                sort: state.request.sort,
+                sort: (_a = state.request.sort) !== null && _a !== void 0 ? _a : [],
+                sortId: state.request.sortId,
                 contentLocale: state.request.contentLocale,
                 scope: state.request.scope,
             };
@@ -54,6 +56,7 @@ export class FtSearchStateManager {
     }
     async initService() {
         this.updateLocales();
+        this.service.getConfiguration().then((conf) => this.store.actions.configuration(conf));
         return this.launchSearch();
     }
     setQuery(query) {
@@ -63,11 +66,11 @@ export class FtSearchStateManager {
     }
     setContentLocale(contentLocale) {
         var _a;
-        let locales = (_a = this.store.getState().locales) !== null && _a !== void 0 ? _a : [];
-        let previousContentLocale = this.store.getState().request.contentLocale;
+        const locales = (_a = this.store.getState().locales) !== null && _a !== void 0 ? _a : [];
+        const previousContentLocale = this.store.getState().request.contentLocale;
         if (contentLocale != previousContentLocale) {
             if (locales.length > 0) {
-                const isKnown = (locale) => locales.some(l => l.lang == locale);
+                const isKnown = (locale) => locales.some((l) => l.lang == locale);
                 if (!isKnown(contentLocale)) {
                     contentLocale = isKnown(previousContentLocale) ? previousContentLocale : locales[0].lang;
                 }
@@ -87,12 +90,27 @@ export class FtSearchStateManager {
     setPageNumber(pageNumber) {
         this.store.actions.setPageNumber(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);
     }
+    setSortId(sortId) {
+        var _a;
+        this.store.actions.setPageNumber(1);
+        if (sortId == undefined || this.sortOptions.length == 0) {
+            this.store.actions.setRequestSortId(sortId);
+            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);
+        return selectedSort.id;
+    }
     setFilters(filters) {
-        const cleanFilters = filters.filter(f => !f.valueFilter || f.valueFilter.values.length > 0);
+        const cleanFilters = filters.filter((f) => !f.valueFilter || f.valueFilter.values.length > 0);
         this.store.actions.setRequestFilters(cleanFilters);
         this.store.actions.setPageNumber(1);
     }
@@ -124,7 +142,7 @@ export class FtSearchStateManager {
         this.facetIds = [...this.facetIds, id];
     }
     replaceFacet(oldId, newId) {
-        let facetIds = this.facetIds.filter(id => id != oldId);
+        const facetIds = this.facetIds.filter((id) => id != oldId);
         if (newId) {
             facetIds.push(newId);
         }
@@ -135,14 +153,14 @@ export class FtSearchStateManager {
         const request = this.store.getState().request;
         return [
             ...new Set([
-                ...request.facets.map(f => f.id),
-                ...((_a = request.metadataFilters) !== null && _a !== void 0 ? _a : []).map(f => f.key),
-            ])
+                ...request.facets.map((f) => f.id),
+                ...((_a = request.metadataFilters) !== null && _a !== void 0 ? _a : []).map((f) => f.key),
+            ]),
         ];
     }
     set facetIds(ids) {
-        let uniqIds = [...new Set(ids)];
-        let facetsConf = uniqIds.map(id => ({ id: id }));
+        const uniqIds = [...new Set(ids)];
+        const facetsConf = uniqIds.map((id) => ({ id: id }));
         this.store.actions.setRequestFacets(facetsConf);
     }
     /** @deprecated */
@@ -150,65 +168,65 @@ export class FtSearchStateManager {
         this.setValueFilter(key, values);
     }
     setValueFilter(key, values) {
-        let existingFilters = this.store.getState().request.metadataFilters;
-        let newFilter = {
+        const existingFilters = this.store.getState().request.metadataFilters;
+        const newFilter = {
             key: key,
             valueFilter: {
                 values: values,
                 negative: false,
             },
         };
-        let filters = [
-            ...existingFilters.filter(f => !f.valueFilter),
-            ...existingFilters.filter(f => f.valueFilter && f.key !== newFilter.key),
-            newFilter
+        const filters = [
+            ...existingFilters.filter((f) => !f.valueFilter),
+            ...existingFilters.filter((f) => f.valueFilter && f.key !== newFilter.key),
+            newFilter,
         ];
         this.setFilters(filters);
     }
     setDateFilter(key, dateType) {
-        let existingFilters = this.store.getState().request.metadataFilters;
-        let newFilter = {
+        const existingFilters = this.store.getState().request.metadataFilters;
+        const newFilter = {
             key: key,
             dateFilter: {
-                type: dateType
+                type: dateType,
             },
         };
-        let filters = [
-            ...existingFilters.filter(f => !f.dateFilter),
-            ...existingFilters.filter(f => f.dateFilter && f.key !== newFilter.key),
-            newFilter
+        const filters = [
+            ...existingFilters.filter((f) => !f.dateFilter),
+            ...existingFilters.filter((f) => f.dateFilter && f.key !== newFilter.key),
+            newFilter,
         ];
         this.setFilters(filters);
     }
     removeDateFilter(key) {
-        let existingFilters = this.store.getState().request.metadataFilters;
+        const existingFilters = this.store.getState().request.metadataFilters;
         const filters = [
-            ...existingFilters.filter(f => !f.dateFilter),
-            ...existingFilters.filter(f => f.dateFilter && f.key !== key),
+            ...existingFilters.filter((f) => !f.dateFilter),
+            ...existingFilters.filter((f) => f.dateFilter && f.key !== key),
         ];
         this.setFilters(filters);
     }
     setRangeFilter(key, from, to) {
-        let existingFilters = this.store.getState().request.metadataFilters;
-        let newFilter = {
+        const existingFilters = this.store.getState().request.metadataFilters;
+        const newFilter = {
             key: key,
             rangeFilter: {
                 from: from,
-                to: to
+                to: to,
             },
         };
-        let filters = [
-            ...existingFilters.filter(f => !f.rangeFilter),
-            ...existingFilters.filter(f => f.rangeFilter && f.key !== newFilter.key),
-            newFilter
+        const filters = [
+            ...existingFilters.filter((f) => !f.rangeFilter),
+            ...existingFilters.filter((f) => f.rangeFilter && f.key !== newFilter.key),
+            newFilter,
         ];
         this.setFilters(filters);
     }
     removeRangeFilter(key) {
-        let existingFilters = this.store.getState().request.metadataFilters;
+        const existingFilters = this.store.getState().request.metadataFilters;
         const filters = [
-            ...existingFilters.filter(f => !f.rangeFilter),
-            ...existingFilters.filter(f => f.rangeFilter && f.key !== key),
+            ...existingFilters.filter((f) => !f.rangeFilter),
+            ...existingFilters.filter((f) => f.rangeFilter && f.key !== key),
         ];
         this.setFilters(filters);
     }
@@ -218,7 +236,7 @@ export class FtSearchStateManager {
     setRequest(request) {
         this.store.actions.setRequest({
             ...request,
-            facets: this.store.getState().request.facets
+            facets: this.store.getState().request.facets,
         });
         this.store.actions.liveQuery(request.query);
         this.store.actions.setPageNumber(1);
@@ -245,19 +263,21 @@ export class FtSearchStateManager {
             this.store.actions.paging(undefined);
             if (this.ignoreEmptyQuery && request.query.length == 0) {
                 this.store.actions.results(undefined);
+                this.store.actions.announcements(undefined);
                 this.store.actions.facets(undefined);
                 this.store.actions.spellcheck(undefined);
             }
             else {
                 this.cancelableSearch = cancelable(this.service.launchSearch(request));
                 const results = await this.cancelableSearch;
+                this.store.actions.announcements(results.announcements);
                 if (results.paging.currentPage <= 1) {
                     this.store.actions.results(results.results);
                     this.store.actions.facets(results.facets);
                     this.store.actions.spellcheck(results.spellcheck);
                 }
                 else {
-                    let newResults = ((_b = this.store.getState().results) !== null && _b !== void 0 ? _b : []).concat(results.results);
+                    const newResults = ((_b = this.store.getState().results) !== null && _b !== void 0 ? _b : []).concat(results.results);
                     this.store.actions.results(newResults);
                     // Focus on first new result
                     this.store.commands.clear(/^focus-result-/);
@@ -278,7 +298,7 @@ export class FtSearchStateManager {
         try {
             (_a = this.cancelableSuggest) === null || _a === void 0 ? void 0 : _a.cancel();
             this.cancelableSuggest = cancelable(this.service.launchSuggest(request));
-            let results = await this.cancelableSuggest;
+            const results = await this.cancelableSuggest;
             this.store.actions.suggestResults(results.suggestions);
         }
         catch (e) {
@@ -293,6 +313,7 @@ export class FtSearchStateManager {
     clearResults() {
         this.store.actions.paging(undefined);
         this.store.actions.results(undefined);
+        this.store.actions.announcements(undefined);
         this.store.actions.facets(undefined);
         this.store.actions.spellcheck(undefined);
     }

package/build/store/model.d.ts

@@ -1,9 +1,11 @@
-import { FtSearchFacet, FtSearchLocale, FtSearchResultCluster, FtSearchResultsPageInfo, FtSpellcheck, FtSuggestResult } from "@fluid-topics/public-api";
+import { FtSearchConfiguration, FtSearchFacet, FtSearchLocale, FtSearchResultAnnouncement, FtSearchResultCluster, FtSearchResultsPageInfo, FtSpellcheck, FtSuggestResult } from "@fluid-topics/public-api";
 import { EnrichedFtSearchRequest } from "@fluid-topics/ft-wc-utils";
 export interface FtSearchPageState {
+    configuration: FtSearchConfiguration | undefined;
     locales: Array<FtSearchLocale> | undefined;
     request: EnrichedFtSearchRequest;
     results: Array<FtSearchResultCluster> | undefined;
+    announcements: Array<FtSearchResultAnnouncement> | undefined;
     facets: Array<FtSearchFacet> | undefined;
     paging: FtSearchResultsPageInfo | undefined;
     spellcheck: FtSpellcheck | undefined;

package/build/store/redux.d.ts

@@ -8,6 +8,7 @@ declare const searchPageStateReducers: {
     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;
@@ -23,6 +24,7 @@ export declare const createSearchPageStore: (id: string) => FtReduxStore<FtSearc
     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;

package/build/store/redux.js

@@ -20,6 +20,9 @@ const searchPageStateReducers = {
     setRequestSort: (state, action) => {
         state.request.sort = action.payload;
     },
+    setRequestSortId: (state, action) => {
+        state.request.sortId = action.payload;
+    },
     setRequestFilters: (state, action) => {
         state.request.metadataFilters = action.payload;
     },
@@ -49,6 +52,7 @@ export const createSearchPageStore = (id) => FtReduxStore.get({
             metadataFilters: [],
             facets: [],
             sort: [],
+            sortId: undefined,
             paging: {
                 page: 1,
                 perPage: 20,
@@ -60,7 +64,9 @@ export const createSearchPageStore = (id) => FtReduxStore.get({
         spellcheck: undefined,
         locales: [],
         results: undefined,
-        suggestResults: undefined
+        announcements: undefined,
+        suggestResults: undefined,
+        configuration: undefined,
     },
-    reducers: searchPageStateReducers
+    reducers: searchPageStateReducers,
 });

package/build/store/utils/FtSearchService.d.ts

@@ -1,9 +1,10 @@
-import { type FluidTopicsApi, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSuggestRequest, FtSuggestResults } from "@fluid-topics/public-api";
+import { type FluidTopicsApi, FtSearchConfiguration, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSuggestRequest, FtSuggestResults } from "@fluid-topics/public-api";
 import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
 export declare class FtSearchService extends FtServiceWithCache {
     constructor(overrideApi?: FluidTopicsApi);
     launchSearch(request: FtSearchRequest): Promise<FtSearchResults>;
     launchSuggest(request: FtSuggestRequest): Promise<FtSuggestResults>;
     getAvailableSearchLocales(): Promise<FtSearchLocales>;
+    getConfiguration(): Promise<FtSearchConfiguration>;
     private sortFilters;
 }

package/build/store/utils/FtSearchService.js

@@ -2,6 +2,7 @@ import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
 export class FtSearchService extends FtServiceWithCache {
     constructor(overrideApi) {
         super(true, overrideApi);
+        this.cache.registerFinal("search-configuration", async () => (await this.awaitApi).getSearchConfiguration());
     }
     async launchSearch(request) {
         const sortedRequest = {
@@ -14,21 +15,24 @@ export class FtSearchService extends FtServiceWithCache {
     async launchSuggest(request) {
         const sortedRequest = {
             ...request,
-            metadataFilters: this.sortFilters(request.metadataFilters)
+            metadataFilters: this.sortFilters(request.metadataFilters),
         };
         return this.cache.get("suggest-" + this.hash(sortedRequest), async () => (await this.awaitApi).getSuggestions(request), 2 * 60 * 1000);
     }
     async getAvailableSearchLocales() {
         return this.cache.get("available-locales", async () => (await this.awaitApi).getAvailableSearchLocales());
     }
+    async getConfiguration() {
+        return this.cache.get("search-configuration");
+    }
     sortFilters(filters) {
         return filters
-            .map(f => f.valueFilter == null ? f : {
+            .map((f) => f.valueFilter == null ? f : {
             ...f,
             valueFilter: {
                 ...f.valueFilter,
-                values: [...f.valueFilter.values].sort((a, b) => a.localeCompare(b))
-            }
+                values: [...f.valueFilter.values].sort((a, b) => a.localeCompare(b)),
+            },
         })
             .sort((a, b) => a.key.localeCompare(b.key));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-search-context",
-  "version": "1.3.15",
+  "version": "1.3.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": "1.3.15",
-    "@fluid-topics/ft-wc-utils": "1.3.15",
+    "@fluid-topics/ft-app-context": "1.3.17",
+    "@fluid-topics/ft-wc-utils": "1.3.17",
     "lit": "3.1.0"
   },
   "devDependencies": {
-    "@fluid-topics/public-api": "1.0.100"
+    "@fluid-topics/public-api": "1.0.102"
   },
-  "gitHead": "5aa2861244264a93f9ce941c3541191eb22a4650"
+  "gitHead": "ca55c7b44d386d960ceb68323361ce0ab3aefaa8"
 }