@fluid-topics/ft-reader-context 2.2.37 → 2.2.38

package/build/store/FtReaderStateManager.d.ts

@@ -8,6 +8,7 @@ export declare class FtReaderStateManager {
     store: FtReaderReduxStore;
     private clusteringHelperProvider?;
     static build(id: string, serviceProvider?: () => Promise<FtReaderService>): FtReaderStateManager;
+    private readonly stickyFiltersIdWatcher;
     metadataForSwitchToRelatives: Set<string>;
     clusteringHelper?: ClusteringHelper;
     service?: FtReaderService;
@@ -17,9 +18,11 @@ export declare class FtReaderStateManager {
     loaded(): Promise<void>;
     constructor(store: FtReaderReduxStore, serviceProvider: () => Promise<FtReaderService>, clusteringHelperProvider?: (() => ClusteringHelper) | undefined, analyticsEventsService?: FtAnalyticsEventsService);
     initService(serviceProvider: () => Promise<FtReaderService>): Promise<void>;
+    removeListeners(): void;
     setMapId(mapId?: string): Promise<void>;
     setRenderedTopics(tocIds: string[]): void;
     setVisibleTopics(tocIds: string[]): void;
+    setApplyStickyFilters(apply: boolean): Promise<void>;
     setFilters(filters: FtMetadataFilter[]): Promise<void>;
     awaitService(): Promise<FtReaderService>;
     navigateToTopic(tocId?: string, section?: string, pageNumber?: number): Promise<void>;
@@ -32,6 +35,7 @@ export declare class FtReaderStateManager {
     clear(): void;
     reload(): Promise<void>;
     clearFromFilter(): void;
+    private reloadFromSticky;
     reloadFromFilter(section?: string, page?: number): Promise<void>;
     private fetchDataFromFilter;
     private fetchData;

package/build/store/FtReaderStateManager.js

@@ -1,5 +1,5 @@
 import { FtReaderStoreEvents, FtRequestedTopicFilteredEvent, } from "./model";
-import { accessResultUrl, CanceledPromiseError, ClusteringHelper, Debouncer, deepEqual, waitFor, waitUntil, } from "@fluid-topics/ft-wc-utils";
+import { accessResultUrl, CanceledPromiseError, ClusteringHelper, Debouncer, deepEqual, ReduxWatcher, waitFor, waitUntil, } from "@fluid-topics/ft-wc-utils";
 import { createReaderStore, } from "./redux";
 import { FtOfficialReaderService } from "./utils/FtOfficialReaderService";
 import { FtAnalyticsEventsService, ftAppInfoStore, } from "@fluid-topics/ft-app-context";
@@ -20,14 +20,20 @@ export class FtReaderStateManager {
         this.loadDebouncer = new Debouncer(10);
         this.analyticsEventsService = analyticsEventsService !== null && analyticsEventsService !== void 0 ? analyticsEventsService : new FtAnalyticsEventsService();
         this.initService(serviceProvider);
+        this.stickyFiltersIdWatcher = new ReduxWatcher(ftAppInfoStore, (store) => { var _a; return (_a = store.stickyFilters) === null || _a === void 0 ? void 0 : _a.id; }, () => this.reloadFromSticky());
     }
     async initService(serviceProvider) {
+        var _a;
         this.service = await serviceProvider();
-        const { mapId, metadataFilters } = this.store.getState();
+        const { mapId, metadataFilters, applyStickyFilters } = this.store.getState();
         this.service.mapId = mapId;
         this.service.metadataFilters = metadataFilters;
+        this.service.stickyFiltersId = applyStickyFilters ? (_a = ftAppInfoStore.getState().stickyFilters) === null || _a === void 0 ? void 0 : _a.id : undefined;
         return this.reload();
     }
+    removeListeners() {
+        this.stickyFiltersIdWatcher.stop();
+    }
     async setMapId(mapId) {
         if (mapId !== this.store.getState().mapId) {
             this.store.actions.mapId(mapId);
@@ -43,6 +49,18 @@ export class FtReaderStateManager {
     setVisibleTopics(tocIds) {
         this.store.actions.visibleTopics(tocIds);
     }
+    async setApplyStickyFilters(apply) {
+        if (apply) {
+            this.stickyFiltersIdWatcher.watch();
+        }
+        else {
+            this.stickyFiltersIdWatcher.stop();
+        }
+        if (apply != this.store.getState().applyStickyFilters) {
+            this.store.actions.applyStickyFilters(apply);
+            await this.reloadFromSticky();
+        }
+    }
     async setFilters(filters) {
         if (!deepEqual(filters, this.store.getState().metadataFilters)) {
             this.store.actions.metadataFilters(filters);
@@ -158,6 +176,15 @@ export class FtReaderStateManager {
         this.store.actions.toc(undefined);
         this.store.actions.pagesToc(undefined);
     }
+    async reloadFromSticky() {
+        var _a;
+        const { scrollTarget, applyStickyFilters, currentPage } = this.store.getState();
+        const newStickyFiltersId = applyStickyFilters ? (_a = ftAppInfoStore.getState().stickyFilters) === null || _a === void 0 ? void 0 : _a.id : undefined;
+        if (this.service && (this.service.stickyFiltersId != newStickyFiltersId)) {
+            this.service.stickyFiltersId = newStickyFiltersId;
+            await this.reloadFromFilter(scrollTarget === null || scrollTarget === void 0 ? void 0 : scrollTarget.section, currentPage === null || currentPage === void 0 ? void 0 : currentPage.number);
+        }
+    }
     async reloadFromFilter(section, page) {
         var _a, _b, _c;
         this.clearFromFilter();

package/build/store/model.d.ts

@@ -69,6 +69,7 @@ export interface FtReaderState {
     };
     linkPreviewDialogId: Optional<string>;
     metadataFilters: Array<FtMetadataFilter>;
+    applyStickyFilters: boolean;
 }
 export interface FtReaderNavigationData {
     mapId: string;

package/build/store/redux.js

@@ -48,6 +48,7 @@ export const createReaderStore = (id) => FtReduxStore.get({
         },
         linkPreviewDialogId: undefined,
         metadataFilters: [],
+        applyStickyFilters: false,
     },
     reducers: readerStoreStateReducers,
 });

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

@@ -7,7 +7,7 @@ export declare class FtOfficialReaderService extends FtReaderService {
     clear(): void;
     protected fetchMap(mapId: string, translationSettings?: FtTranslationSettings): Promise<FtMap>;
     protected fetchMapRating(mapId: string): Promise<FtRatingSummary>;
-    protected fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
+    protected fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], stickyFiltersId?: string, translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
     protected fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
     protected fetchTranslatedTopicHTMLContent(tocNode: FtTocNode, translationSettings: FtTranslationSettings): Promise<FtTranslationContent>;
     protected fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
@@ -17,7 +17,7 @@ export declare class FtOfficialReaderService extends FtReaderService {
     protected makeMapFeedbackRequest(message: string, from?: string): Promise<void>;
     protected makeRateMapRequest(type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
     protected makeRateTopicRequest(tocId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
-    protected makeTopicFeedbackRequest(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[]): Promise<void>;
+    protected makeTopicFeedbackRequest(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[], stickyFiltersId?: string): Promise<void>;
     protected makeUnrateMapRequest(): Promise<void>;
     protected makeUnrateTopicRequest(tocId: string): Promise<void>;
     protected getReaderLinkPrefix(): string;

package/build/store/utils/FtOfficialReaderService.js

@@ -16,10 +16,10 @@ export class FtOfficialReaderService extends FtReaderService {
     fetchMapRating(mapId) {
         return this.api.getMapRating(mapId);
     }
-    async fetchPages(mapId, metadataFilters, translationSettings) {
+    async fetchPages(mapId, metadataFilters, stickyFiltersId, translationSettings) {
         await this.getMap(translationSettings);
-        return (metadataFilters === null || metadataFilters === void 0 ? void 0 : metadataFilters.length)
-            ? this.api.getFilteredPages(mapId, translationSettings, metadataFilters)
+        return ((metadataFilters === null || metadataFilters === void 0 ? void 0 : metadataFilters.length) || stickyFiltersId)
+            ? this.api.getFilteredPages(mapId, translationSettings, metadataFilters, stickyFiltersId)
             : this.api.getPages(mapId, this.fingerprint, translationSettings);
     }
     fetchTopicHTMLContent(tocNode) {
@@ -88,8 +88,8 @@ export class FtOfficialReaderService extends FtReaderService {
     makeRateTopicRequest(tocId, type, value) {
         return this.api.rateTopic(this.mapId, tocId, type, value);
     }
-    makeTopicFeedbackRequest(tocId, message, from, metadataFilters) {
-        return this.api.sendTopicFeedback(this.mapId, tocId, message, from, metadataFilters);
+    makeTopicFeedbackRequest(tocId, message, from, metadataFilters, stickyFiltersId) {
+        return this.api.sendTopicFeedback(this.mapId, tocId, message, from, metadataFilters, stickyFiltersId);
     }
     makeUnrateMapRequest() {
         return this.api.unrateMap(this.mapId);

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

@@ -4,10 +4,17 @@ import { FtPagesTocNode, FtReaderFeatureAccessData, FtReaderFeatures, FtReaderNa
 import { FtReaderConverter } from "./FtReaderConverter";
 import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
 import { FtReaderBreadcrumb } from "../../models";
+export type ReaderLinkParameters = {
+    tocId?: string;
+    pageNumber?: number;
+    section?: string;
+    withMetadataFilter?: boolean;
+    withStickyFilters?: boolean;
+};
 export declare abstract class FtReaderService extends FtServiceWithCache {
     protected converter: FtReaderConverter;
     protected abstract fetchMap(mapId: string, translationSettings?: FtTranslationSettings): Promise<FtMap>;
-    protected abstract fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
+    protected abstract fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], stickyFilterId?: string, translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
     protected abstract fetchMapRating(mapId: string): Promise<FtRatingSummary>;
     protected abstract fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
     protected abstract fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
@@ -20,11 +27,12 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     protected abstract makeMapFeedbackRequest(message: string, from?: string): Promise<void>;
     protected abstract makeRateTopicRequest(tocId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
     protected abstract makeUnrateTopicRequest(tocId: string): Promise<void>;
-    protected abstract makeTopicFeedbackRequest(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[]): Promise<void>;
+    protected abstract makeTopicFeedbackRequest(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[], stickyFiltersId?: string): Promise<void>;
     protected abstract getReaderLinkPrefix(): string;
     protected abstract isFeatureAvailable(feature: FtReaderFeatures): boolean;
     private _mapId;
     private _metadataFilters;
+    stickyFiltersId?: string;
     get metadataFilters(): FtMetadataFilter[];
     set metadataFilters(value: FtMetadataFilter[] | undefined);
     get mapId(): string;
@@ -59,7 +67,8 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     getRelativesForDocument(metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
     getRelativesForTopicInMap(mapId: string, metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
     getAttachmentDownloadLink(id: string): string;
-    getLink(tocId?: string, pageNumber?: number, section?: string, withMetadataFilter?: boolean): string;
+    getLink(tocId?: string, pageNumber?: number, section?: string, withMetadataFilter?: boolean, withStickyFilters?: boolean): string;
+    getLink(linkParams: ReaderLinkParameters): string;
     getLinkWithFilter(tocId?: string, pageNumber?: number, section?: string): string;
     getNavigationData(tocId?: string, pageNumber?: number, section?: string, translationInput?: FtTranslationSettings): FtReaderNavigationData;
     getAccurateNavigationData(tocId?: string, pageNumber?: number, section?: string, translationInput?: FtTranslationSettings): Promise<FtReaderNavigationData>;
@@ -73,7 +82,7 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     rateTopic(tocId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
     unrateTopic(tocId: string): Promise<void>;
     private clearRatingIfNecessary;
-    sendTopicFeedback(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[]): Promise<void>;
+    sendTopicFeedback(tocId: string, message: string, from?: string, metadataFilters?: FtMetadataFilter[], stickyFiltersId?: string): Promise<void>;
     fontsStylesheet(): string;
     themeStylesheet(): string;
     buildBreadcrumb(tocId: string, translationInput?: FtTranslationSettings): Array<FtReaderBreadcrumb>;

package/build/store/utils/FtReaderService.js

@@ -31,7 +31,8 @@ export class FtReaderService extends FtServiceWithCache {
     initCache() {
         this.cache.register("configuration", () => this.api.getReaderConfiguration());
         this.cache.register("map", () => this.withMapId((mapId) => this.fetchMap(mapId)));
-        this.cache.register(this.makeCacheKey("enrichedToc", undefined, this.metadataFilters), () => this.withMapId((mapId) => this.fetchPages(mapId, this._metadataFilters).then((toc) => this.converter.convertPaginatedToc(mapId, toc))));
+        this.cache.register(this.makeCacheKey("enrichedToc", undefined, this.metadataFilters, this.stickyFiltersId), () => this.withMapId((mapId) => this.fetchPages(mapId, this._metadataFilters, this.stickyFiltersId)
+            .then((toc) => this.converter.convertPaginatedToc(mapId, toc))));
         this.cache.register("ratingSummary", () => {
             var _a;
             var _b;
@@ -42,10 +43,11 @@ export class FtReaderService extends FtServiceWithCache {
     clear() {
         this.cache.clearMatching((key) => key !== "configuration");
     }
-    makeCacheKey(base, translationSettings, metadataFilters) {
+    makeCacheKey(base, translationSettings, metadataFilters, stickyFiltersId) {
         return base
             + (translationSettings ? "-destinationLanguage-" + (translationSettings === null || translationSettings === void 0 ? void 0 : translationSettings.destinationLanguage) : "")
-            + (!metadataFilters || metadataFilters.length == 0 ? "" : "-metadataFilters-" + this.hash(metadataFilters));
+            + (!metadataFilters || metadataFilters.length == 0 ? "" : "-metadataFilters-" + this.hash(metadataFilters))
+            + (stickyFiltersId ? "-stickyFilters-" + stickyFiltersId : "");
     }
     getMap(translationSettings) {
         return this.cache.get(this.makeCacheKey("map", translationSettings), () => this.fetchMap(this.mapId, translationSettings));
@@ -60,10 +62,10 @@ export class FtReaderService extends FtServiceWithCache {
         this.cache.clear("configuration");
     }
     getEnrichedToc(translationSettings) {
-        return this.cache.get(this.makeCacheKey("enrichedToc", translationSettings, this.metadataFilters), () => this.fetchPages(this.mapId, this.metadataFilters, translationSettings).then((toc) => this.converter.convertPaginatedToc(this.mapId, toc)));
+        return this.cache.get(this.makeCacheKey("enrichedToc", translationSettings, this.metadataFilters, this.stickyFiltersId), () => this.fetchPages(this.mapId, this.metadataFilters, this.stickyFiltersId, translationSettings).then((toc) => this.converter.convertPaginatedToc(this.mapId, toc)));
     }
     getEnrichedTocNow(translationSettings) {
-        return this.cache.getNow(this.makeCacheKey("enrichedToc", translationSettings, this.metadataFilters));
+        return this.cache.getNow(this.makeCacheKey("enrichedToc", translationSettings, this.metadataFilters, this.stickyFiltersId));
     }
     async getPaginationConfiguration() {
         const enrichedToc = await this.getEnrichedToc();
@@ -142,7 +144,18 @@ export class FtReaderService extends FtServiceWithCache {
     getAttachmentDownloadLink(id) {
         return this.makeAbsolute(`${this.api.endpoints.khub.maps.mapId(this.mapId).attachments.attachmentId(id).content}?download=true&locationValue=reader`);
     }
-    getLink(tocId, pageNumber, section, withMetadataFilter) {
+    getLink(tocIdOrParams, pageNumber, section, withMetadataFilter, withStickyFilters) {
+        let tocId;
+        if (typeof tocIdOrParams === "object") {
+            tocId = tocIdOrParams.tocId;
+            pageNumber = tocIdOrParams.pageNumber;
+            section = tocIdOrParams.section;
+            withMetadataFilter = tocIdOrParams.withMetadataFilter;
+            withStickyFilters = tocIdOrParams.withStickyFilters;
+        }
+        else {
+            tocId = tocIdOrParams;
+        }
         const navigationData = this.getNavigationData(tocId, pageNumber, section);
         const path = this.getReaderLinkPrefix() + (navigationData.prettyUrl ? navigationData.prettyUrl : `${navigationData.mapId}/${navigationData.tocId}`);
         const url = new URL(path, this.api.tenantBaseUrl);
@@ -161,6 +174,9 @@ export class FtReaderService extends FtServiceWithCache {
                 url.searchParams.set(SearchPlaceQueryParams.VALUE_FILTERS, serializeFilters);
             }
         }
+        if (withStickyFilters && this.stickyFiltersId) {
+            url.searchParams.set(SearchPlaceQueryParams.STICKY_FILTER, this.stickyFiltersId);
+        }
         return url.href;
     }
     getLinkWithFilter(tocId, pageNumber, section) {
@@ -226,8 +242,8 @@ export class FtReaderService extends FtServiceWithCache {
             this.cache.clear("ratingSummary");
         }
     }
-    sendTopicFeedback(tocId, message, from, metadataFilters) {
-        return this.makeTopicFeedbackRequest(tocId, message, from, metadataFilters);
+    sendTopicFeedback(tocId, message, from, metadataFilters, stickyFiltersId) {
+        return this.makeTopicFeedbackRequest(tocId, message, from, metadataFilters, stickyFiltersId);
     }
     fontsStylesheet() {
         return this.api.makeAbsolute(this.api.endpoints.stylesheets.fonts);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-reader-context",
-    "version": "2.2.37",
+    "version": "2.2.38",
     "description": "Context block for integrated reader components",
     "keywords": [
         "Lit"
@@ -19,14 +19,14 @@
         "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
     },
     "dependencies": {
-        "@fluid-topics/ft-app-context": "2.2.37",
-        "@fluid-topics/ft-search-context": "2.2.37",
-        "@fluid-topics/ft-wc-utils": "2.2.37",
+        "@fluid-topics/ft-app-context": "2.2.38",
+        "@fluid-topics/ft-search-context": "2.2.38",
+        "@fluid-topics/ft-wc-utils": "2.2.38",
         "@reduxjs/toolkit": "2.13.0",
         "lit": "3.3.3"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.148"
+        "@fluid-topics/public-api": "1.0.149"
     },
-    "gitHead": "d63a6da53ab8005823b5ab9da20c144de93f45a8"
+    "gitHead": "e28bf4c90c0be695d1bea56d97aba4295e17ee7b"
 }