@fluid-topics/ft-reader-context 2.2.16 → 2.2.18

package/build/store/FtReaderStateManager.d.ts

@@ -3,7 +3,7 @@ import { ClusteringHelper, Optional } from "@fluid-topics/ft-wc-utils";
 import { FtReaderReduxStore } from "./redux";
 import type { FtReaderService } from "./utils/FtReaderService";
 import { FtAnalyticsEventsService } from "@fluid-topics/ft-app-context";
-import { FtTranslationLocale, FtTranslationSettings } from "@fluid-topics/public-api";
+import { FtMetadataFilter, FtTranslationLocale, FtTranslationSettings } from "@fluid-topics/public-api";
 export declare class FtReaderStateManager {
     store: FtReaderReduxStore;
     private clusteringHelperProvider?;
@@ -20,8 +20,10 @@ export declare class FtReaderStateManager {
     setMapId(mapId?: string): Promise<void>;
     setRenderedTopics(tocIds: string[]): void;
     setVisibleTopics(tocIds: string[]): void;
+    setFilters(filters: FtMetadataFilter[]): Promise<void>;
     awaitService(): Promise<FtReaderService>;
     navigateToTopic(tocId?: string, section?: string, pageNumber?: number): Promise<void>;
+    private resolvePage;
     private resolveValidNonRootTocId;
     navigateToPage(pageNumber: number): Promise<void>;
     scrollDone(): void;
@@ -29,6 +31,9 @@ export declare class FtReaderStateManager {
     load(): Promise<void>;
     clear(): void;
     reload(): Promise<void>;
+    clearFromFilter(): void;
+    reloadFromFilter(section?: string, page?: number): Promise<void>;
+    private fetchDataFromFilter;
     private fetchData;
     private loadConfiguration;
     reloadConfiguration(): Promise<{

package/build/store/FtReaderStateManager.js

@@ -1,5 +1,5 @@
-import { FtReaderStoreEvents, } from "./model";
-import { accessResultUrl, CanceledPromiseError, ClusteringHelper, Debouncer, waitFor, waitUntil, } from "@fluid-topics/ft-wc-utils";
+import { FtReaderStoreEvents, FtRequestedTopicFilteredEvent, } from "./model";
+import { accessResultUrl, CanceledPromiseError, ClusteringHelper, Debouncer, deepEqual, 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";
@@ -23,7 +23,9 @@ export class FtReaderStateManager {
     }
     async initService(serviceProvider) {
         this.service = await serviceProvider();
-        this.service.mapId = this.store.getState().mapId;
+        const { mapId, metadataFilters } = this.store.getState();
+        this.service.mapId = mapId;
+        this.service.metadataFilters = metadataFilters;
         return this.reload();
     }
     async setMapId(mapId) {
@@ -41,15 +43,20 @@ export class FtReaderStateManager {
     setVisibleTopics(tocIds) {
         this.store.actions.visibleTopics(tocIds);
     }
+    async setFilters(filters) {
+        if (!deepEqual(filters, this.store.getState().metadataFilters)) {
+            this.store.actions.metadataFilters(filters);
+            if (this.service) {
+                this.service.metadataFilters = filters;
+            }
+        }
+    }
     async awaitService() {
         return waitFor(() => this.service);
     }
     async navigateToTopic(tocId, section, pageNumber) {
         await this.loaded();
-        const service = await this.awaitService();
-        const page = await (pageNumber != null
-            ? service.getPage(pageNumber, this.getTranslationSettings())
-            : service.getPageByTocId(tocId !== null && tocId !== void 0 ? tocId : "root", this.getTranslationSettings()));
+        const page = await this.resolvePage(tocId, pageNumber);
         this.store.actions.currentPage(page);
         const nonRootTocId = this.resolveValidNonRootTocId(tocId, page);
         this.store.actions.scrollTarget({ tocId: nonRootTocId, section });
@@ -62,16 +69,43 @@ export class FtReaderStateManager {
             this.store.commands.add({ type: `focus-topic-${tocId}` });
         }
     }
+    async resolvePage(tocId, pageNumber) {
+        var _a, _b;
+        const service = await this.awaitService();
+        if (pageNumber) {
+            return service.getPage(pageNumber, this.getTranslationSettings());
+        }
+        if (!tocId) {
+            return service.getPageByTocId("root", this.getTranslationSettings());
+        }
+        const maybeFilteredTopic = this.store.getState().filteredTocNodes[tocId];
+        const nodeIsInToc = ((_a = this.service) === null || _a === void 0 ? void 0 : _a.getTocNodeNow(tocId)) != null;
+        if (maybeFilteredTopic && maybeFilteredTopic.reason !== "ACCESS_RIGHTS_FILTER" && !nodeIsInToc) {
+            return service.getPageByTocId((_b = maybeFilteredTopic.closestParent) !== null && _b !== void 0 ? _b : "root", this.getTranslationSettings());
+        }
+        return service.getPageByTocId(tocId, this.getTranslationSettings());
+    }
     resolveValidNonRootTocId(tocId, page) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         const nonRootTocId = (_a = (tocId === "root" ? undefined : tocId)) !== null && _a !== void 0 ? _a : page.rootTocId;
         if (!page.topics.includes(nonRootTocId)) {
             if (tocId != "root" && !page.hiddenTopics.includes(nonRootTocId)) {
                 // The redirection is expected when tocId = root or when landing from an "only in toc" topic, don't send the event.
                 // Pass the requested tocId as event detail so consumers can probe access rights.
-                this.store.dispatchEvent(new CustomEvent(FtReaderStoreEvents.requestedTopicNotFound, { detail: { tocId: nonRootTocId } }));
+                const maybeFilteredTopic = this.store.getState().filteredTocNodes[nonRootTocId];
+                if (maybeFilteredTopic) {
+                    this.store.dispatchEvent(new FtRequestedTopicFilteredEvent(maybeFilteredTopic));
+                    const nodeIsInToc = ((_b = this.service) === null || _b === void 0 ? void 0 : _b.getTocNodeNow(maybeFilteredTopic.tocId)) != null;
+                    if (maybeFilteredTopic.reason === "ACCESS_RIGHTS_FILTER" || nodeIsInToc) {
+                        return maybeFilteredTopic.tocId;
+                    }
+                    else {
+                        return (_c = maybeFilteredTopic.closestParent) !== null && _c !== void 0 ? _c : "root";
+                    }
+                }
+                this.store.dispatchEvent(new CustomEvent(FtReaderStoreEvents.requestedTopicNotFound));
             }
-            return (_c = (_b = page.topics[0]) !== null && _b !== void 0 ? _b : page.hiddenTopics[0]) !== null && _c !== void 0 ? _c : "root";
+            return (_e = (_d = page.topics[0]) !== null && _d !== void 0 ? _d : page.hiddenTopics[0]) !== null && _e !== void 0 ? _e : "root";
         }
         return nonRootTocId;
     }
@@ -87,7 +121,7 @@ export class FtReaderStateManager {
     async load() {
         var _a;
         if (((_a = this.service) === null || _a === void 0 ? void 0 : _a.mapId) && this.store.getState().map == null) {
-            await this.loadDebouncer.run(() => this.fetchData(this.getTranslationSettings()));
+            await this.loadDebouncer.run(() => this.fetchData());
         }
     }
     clear() {
@@ -117,25 +151,55 @@ export class FtReaderStateManager {
         this.clear();
         return this.load();
     }
-    async fetchData(translationSettings) {
-        var _a, _b, _c, _d, _e;
+    clearFromFilter() {
+        this._loaded = false;
+        this.store.actions.toc(undefined);
+        this.store.actions.pagesToc(undefined);
+    }
+    async reloadFromFilter(section, page) {
+        var _a, _b, _c;
+        this.clearFromFilter();
+        const { scrollTarget, visibleTopics, currentPage } = this.store.getState();
+        const tocId = (_c = (_b = (_a = scrollTarget === null || scrollTarget === void 0 ? void 0 : scrollTarget.tocId) !== null && _a !== void 0 ? _a : visibleTopics === null || visibleTopics === void 0 ? void 0 : visibleTopics[0]) !== null && _b !== void 0 ? _b : currentPage === null || currentPage === void 0 ? void 0 : currentPage.rootTocId) !== null && _c !== void 0 ? _c : "root";
+        await this.fetchDataFromFilter();
+        this.navigateToTopic(tocId, section, page);
+    }
+    async fetchDataFromFilter() {
+        var _a, _b, _c, _d;
+        const translationSettings = this.getTranslationSettings();
         try {
-            if (translationSettings) {
-                this.setTranslationLoading(true);
-            }
-            const handleTranslationError = (e) => {
+            await Promise.all([
+                (_a = this.service) === null || _a === void 0 ? void 0 : _a.getToc(translationSettings).then((toc) => this.store.actions.toc(toc)),
+                (_b = this.service) === null || _b === void 0 ? void 0 : _b.getPagesToc(translationSettings).then((pagesToc) => this.store.actions.pagesToc(pagesToc)),
+                (_c = this.service) === null || _c === void 0 ? void 0 : _c.getFilteredTocNodes(translationSettings).then((filteredTocNodes) => this.store.actions.filteredTocNodes(filteredTocNodes)),
+            ]);
+            this._loaded = true;
+        }
+        catch (e) {
+            if (!(e instanceof CanceledPromiseError)) {
                 if (translationSettings) {
                     this.setTranslationError(true);
                 }
+                (_d = this.errorHandler) === null || _d === void 0 ? void 0 : _d.call(this, e);
                 throw e;
-            };
+            }
+        }
+    }
+    async fetchData() {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const translationSettings = this.getTranslationSettings();
+        try {
+            if (translationSettings) {
+                this.setTranslationLoading(true);
+            }
             await Promise.all([
                 this.loadConfiguration(),
-                (_a = this.service) === null || _a === void 0 ? void 0 : _a.getMap(translationSettings).then((map) => this.store.actions.map(map)).catch(handleTranslationError),
-                (_b = this.service) === null || _b === void 0 ? void 0 : _b.getToc(translationSettings).then((toc) => this.store.actions.toc(toc)).catch(handleTranslationError),
-                (_c = this.service) === null || _c === void 0 ? void 0 : _c.getPagesToc(translationSettings).then((pagesToc) => this.store.actions.pagesToc(pagesToc)).catch(handleTranslationError),
-                (_d = this.service) === null || _d === void 0 ? void 0 : _d.getPaginationConfiguration().then((conf) => this.store.actions.paginationConfiguration(conf)).catch(handleTranslationError),
-                (_e = this.service) === null || _e === void 0 ? void 0 : _e.getTranslationError(translationSettings).then((translationError) => this.setTranslationError(translationError)),
+                (_a = this.service) === null || _a === void 0 ? void 0 : _a.getMap(translationSettings).then((map) => this.store.actions.map(map)),
+                (_b = this.service) === null || _b === void 0 ? void 0 : _b.getToc(translationSettings).then((toc) => this.store.actions.toc(toc)),
+                (_c = this.service) === null || _c === void 0 ? void 0 : _c.getPagesToc(translationSettings).then((pagesToc) => this.store.actions.pagesToc(pagesToc)),
+                (_d = this.service) === null || _d === void 0 ? void 0 : _d.getPaginationConfiguration().then((conf) => this.store.actions.paginationConfiguration(conf)),
+                (_e = this.service) === null || _e === void 0 ? void 0 : _e.getFilteredTocNodes(translationSettings).then((filteredTocNodes) => this.store.actions.filteredTocNodes(filteredTocNodes)),
+                (_f = this.service) === null || _f === void 0 ? void 0 : _f.getTranslationError(translationSettings).then((translationError) => this.setTranslationError(translationError)),
             ]);
             if (this.metadataForSwitchToRelatives.size > 0) {
                 this.fetchRelatives();
@@ -146,8 +210,12 @@ export class FtReaderStateManager {
             }
         }
         catch (e) {
-            if (this.errorHandler && !(e instanceof CanceledPromiseError)) {
-                this.errorHandler(e);
+            if (!(e instanceof CanceledPromiseError)) {
+                if (translationSettings) {
+                    this.setTranslationError(true);
+                }
+                (_g = this.errorHandler) === null || _g === void 0 ? void 0 : _g.call(this, e);
+                throw e;
             }
         }
     }
@@ -214,11 +282,11 @@ export class FtReaderStateManager {
         if (destinationLanguage) {
             this.sendDocumentOnDemandTranslateEvent(destinationLanguage);
         }
-        await this.loadDebouncer.run(() => this.fetchData(this.getTranslationSettings()));
+        await this.loadDebouncer.run(() => this.fetchData());
     }
     async setTranslationSourceLanguage(sourceLanguage) {
         this.store.actions.setTranslationSourceLanguage(sourceLanguage);
-        await this.loadDebouncer.run(() => this.fetchData(this.getTranslationSettings()));
+        await this.loadDebouncer.run(() => this.fetchData());
     }
     async setTranslationProfileId(profileId) {
         this.store.actions.setTranslationProfileId(profileId);
@@ -265,7 +333,8 @@ export class FtReaderStateManager {
         this.metadataForSwitchToRelatives.delete(id);
         this.updateClusteringHelper();
     }
-    getAccurateNavigationData(tocId, currentPage, oldScrollTarget) {
+    async getAccurateNavigationData(tocId, currentPage, oldScrollTarget) {
+        await this.awaitService();
         return this.service.getAccurateNavigationData(tocId, currentPage === null || currentPage === void 0 ? void 0 : currentPage.number, oldScrollTarget === null || oldScrollTarget === void 0 ? void 0 : oldScrollTarget.section, this.getTranslationSettings());
     }
     buildBreadcrumb(tocId) {

package/build/store/model.d.ts

@@ -1,10 +1,14 @@
-import { FtMap, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtSearchResultClusterEntry, FtSession, FtTocNode, FtTopic, FtTopicRating, FtTranslationLocale } from "@fluid-topics/public-api";
+import { FtMap, FtMetadataFilter, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtSearchResultClusterEntry, FtSession, FtTocNode, FtTocNodeFiltered, FtTopic, FtTopicRating, FtTranslationLocale } from "@fluid-topics/public-api";
 import { Optional } from "@fluid-topics/ft-wc-utils";
 export declare enum FtReaderStoreEvents {
     clusteringHelperCreated = "clustering-helper-created",
     mapAttachmentsUpdate = "map-attachments-update",
     visibleTopicChange = "visible-topic-change",
-    requestedTopicNotFound = "requested-topic-not-found"
+    requestedTopicNotFound = "requested-topic-not-found",
+    requestedTopicFiltered = "requested-topic-filtered"
+}
+export declare class FtRequestedTopicFilteredEvent extends CustomEvent<FtTocNodeFiltered> {
+    constructor(filteredNode: FtTocNodeFiltered);
 }
 export interface FtPagesTocNode {
     depth: number;
@@ -44,6 +48,7 @@ export interface FtReaderState {
     toc: Optional<Array<FtReaderTocNode>>;
     pagesToc: Optional<Array<FtPagesTocNode>>;
     paginationConfiguration: Optional<FtPaginationConfiguration>;
+    filteredTocNodes: Record<string, FtTocNodeFiltered>;
     currentPage: Optional<FtReaderPage>;
     scrollTarget: Optional<FtReaderScrollTarget>;
     renderedTopics: string[];
@@ -63,6 +68,7 @@ export interface FtReaderState {
         isError: boolean;
     };
     linkPreviewDialogId: Optional<string>;
+    metadataFilters: Array<FtMetadataFilter>;
 }
 export interface FtReaderNavigationData {
     mapId: string;
@@ -73,6 +79,7 @@ export interface FtReaderNavigationData {
     page?: number;
     prettyUrl?: string;
     prettyUrlDuplicated: boolean;
+    metadataFilters?: Array<FtMetadataFilter>;
 }
 export interface FtTopicRatingSummary {
     rating?: FtTopicRating;

package/build/store/model.js

@@ -4,7 +4,13 @@ export var FtReaderStoreEvents;
     FtReaderStoreEvents["mapAttachmentsUpdate"] = "map-attachments-update";
     FtReaderStoreEvents["visibleTopicChange"] = "visible-topic-change";
     FtReaderStoreEvents["requestedTopicNotFound"] = "requested-topic-not-found";
+    FtReaderStoreEvents["requestedTopicFiltered"] = "requested-topic-filtered";
 })(FtReaderStoreEvents || (FtReaderStoreEvents = {}));
+export class FtRequestedTopicFilteredEvent extends CustomEvent {
+    constructor(filteredNode) {
+        super(FtReaderStoreEvents.requestedTopicFiltered, { detail: filteredNode });
+    }
+}
 export var FtReaderFeatures;
 (function (FtReaderFeatures) {
     FtReaderFeatures["FEEDBACK"] = "FEEDBACK";

package/build/store/redux.js

@@ -30,6 +30,7 @@ export const createReaderStore = (id) => FtReduxStore.get({
         map: undefined,
         toc: undefined,
         pagesToc: undefined,
+        filteredTocNodes: {},
         paginationConfiguration: undefined,
         currentPage: undefined,
         scrollTarget: undefined,
@@ -46,6 +47,7 @@ export const createReaderStore = (id) => FtReduxStore.get({
             isError: false,
         },
         linkPreviewDialogId: undefined,
+        metadataFilters: [],
     },
     reducers: readerStoreStateReducers,
 });

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

@@ -1,4 +1,4 @@
-import type { FtMap, FtMapAttachment, FtPaginatedToc, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtSearchResults, FtTocNode, FtTopic, FtTranslationContent, FtTranslationSettings } from "@fluid-topics/public-api";
+import type { FtMap, FtMapAttachment, FtMetadataFilter, FtPaginatedToc, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtSearchResults, FtTocNode, FtTopic, FtTranslationContent, FtTranslationSettings } from "@fluid-topics/public-api";
 import { FtReaderService } from "./FtReaderService";
 import { FtReaderFeatures } from "../model";
 export declare class FtOfficialReaderService extends FtReaderService {
@@ -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, translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
+    protected fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
     protected fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
     protected fetchTranslatedTopicHTMLContent(tocNode: FtTocNode, translationSettings: FtTranslationSettings): Promise<FtTranslationContent>;
     protected fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;

package/build/store/utils/FtOfficialReaderService.js

@@ -16,9 +16,11 @@ export class FtOfficialReaderService extends FtReaderService {
     fetchMapRating(mapId) {
         return this.api.getMapRating(mapId);
     }
-    async fetchPages(mapId, translationSettings) {
+    async fetchPages(mapId, metadataFilters, translationSettings) {
         await this.getMap(translationSettings);
-        return this.api.getPages(mapId, this.fingerprint, translationSettings);
+        return (metadataFilters === null || metadataFilters === void 0 ? void 0 : metadataFilters.length)
+            ? this.api.getFilteredPages(mapId, translationSettings, metadataFilters)
+            : this.api.getPages(mapId, this.fingerprint, translationSettings);
     }
     fetchTopicHTMLContent(tocNode) {
         return this.api.getTopicHTMLContent(this.mapId, tocNode.contentId, "DESIGNED_READER", this.fingerprint);

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

@@ -1,4 +1,4 @@
-import { FtPaginatedToc, FtPaginationConfiguration } from "@fluid-topics/public-api";
+import { FtPaginatedToc, FtPaginationConfiguration, FtTocNodeFiltered } from "@fluid-topics/public-api";
 import { FtPagesTocNode, FtReaderPage, FtReaderTocNode } from "../model";
 export type EnrichedToc = {
     paginationConfiguration: FtPaginationConfiguration;
@@ -10,6 +10,7 @@ export type EnrichedToc = {
     pages: Array<FtReaderPage>;
     pageByTocId: Record<string, FtReaderPage>;
     translationError: boolean;
+    filteredTocNodes: Record<string, FtTocNodeFiltered>;
 };
 export declare class FtReaderConverter {
     convertPaginatedToc(mapId: string, paginatedToc: FtPaginatedToc): EnrichedToc;

package/build/store/utils/FtReaderConverter.js

@@ -19,6 +19,7 @@ class EnrichedTocBuilder {
             pages: this.pages,
             pageByTocId: this.pageByTocId,
             translationError: this.paginatedToc.translationError,
+            filteredTocNodes: this.paginatedToc.filteredTocNodes,
         };
     }
     extractPagesToc(nodes, depth, parentTocId) {

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

@@ -1,4 +1,4 @@
-import type { FluidTopicsApi, FtMap, FtMapAttachment, FtMetadata, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, FtTopic, FtTranslationContent, FtTranslationSettings } from "@fluid-topics/public-api";
+import type { FluidTopicsApi, FtMap, FtMapAttachment, FtMetadata, FtMetadataFilter, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, FtTocNodeFiltered, FtTopic, FtTranslationContent, FtTranslationSettings } from "@fluid-topics/public-api";
 import { FtRatingType, FtSearchResults } from "@fluid-topics/public-api";
 import { FtPagesTocNode, FtReaderFeatureAccessData, FtReaderFeatures, FtReaderNavigationData, FtReaderPage, FtReaderTocNode, FtTopicRatingSummary } from "../model";
 import { FtReaderConverter } from "./FtReaderConverter";
@@ -7,7 +7,7 @@ import { FtReaderBreadcrumb } from "../../models";
 export declare abstract class FtReaderService extends FtServiceWithCache {
     protected converter: FtReaderConverter;
     protected abstract fetchMap(mapId: string, translationSettings?: FtTranslationSettings): Promise<FtMap>;
-    protected abstract fetchPages(mapId: string, translationSettings?: FtTranslationSettings): Promise<FtPaginatedToc>;
+    protected abstract fetchPages(mapId: string, metadataFilters?: FtMetadataFilter[], 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>;
@@ -24,9 +24,12 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     protected abstract getReaderLinkPrefix(): string;
     protected abstract isFeatureAvailable(feature: FtReaderFeatures): boolean;
     private _mapId;
+    private _metadataFilters;
+    get metadataFilters(): FtMetadataFilter[];
+    set metadataFilters(value: FtMetadataFilter[] | undefined);
     get mapId(): string;
     set mapId(value: string | undefined);
-    constructor(converter: FtReaderConverter, overrideApi?: FluidTopicsApi, mapId?: string);
+    constructor(converter: FtReaderConverter, overrideApi?: FluidTopicsApi, mapId?: string, metadataFilters?: FtMetadataFilter[]);
     private withMapId;
     private initCache;
     clear(): void;
@@ -41,6 +44,7 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     getToc(translationSettings?: FtTranslationSettings): Promise<Array<FtReaderTocNode>>;
     getPagesToc(translationSettings?: FtTranslationSettings): Promise<Array<FtPagesTocNode>>;
     getTranslationError(translationSettings?: FtTranslationSettings): Promise<boolean>;
+    getFilteredTocNodes(translationSettings?: FtTranslationSettings): Promise<Record<string, FtTocNodeFiltered>>;
     getTocNode(tocId: string, translationSettings?: FtTranslationSettings): Promise<FtReaderTocNode>;
     getTocNodeNow(tocId: string, translationInput?: FtTranslationSettings): FtReaderTocNode | undefined;
     getTocNodeNowByUrl(prettyUrlOrMapIdTocId: string, translationInput?: FtTranslationSettings): FtReaderTocNode | undefined;
@@ -55,7 +59,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): string;
+    getLink(tocId?: string, pageNumber?: number, section?: string, withMetadataFilter?: boolean): 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>;
     private getRatingSummary;

package/build/store/utils/FtReaderService.js

@@ -1,7 +1,14 @@
 import { FtUserRole, userHasRole, } from "@fluid-topics/public-api";
 import { FtReaderFeatures, } from "../model";
 import { ftAppInfoStore, FtServiceWithCache, } from "@fluid-topics/ft-app-context";
+import { SearchPlaceConverter, SearchPlaceQueryParams, } from "@fluid-topics/ft-wc-utils";
 export class FtReaderService extends FtServiceWithCache {
+    get metadataFilters() {
+        return this._metadataFilters;
+    }
+    set metadataFilters(value) {
+        this._metadataFilters = value;
+    }
     get mapId() {
         return this._mapId;
     }
@@ -11,10 +18,11 @@ export class FtReaderService extends FtServiceWithCache {
         }
         this._mapId = value;
     }
-    constructor(converter, overrideApi, mapId) {
+    constructor(converter, overrideApi, mapId, metadataFilters) {
         super(false, overrideApi);
         this.converter = converter;
         this._mapId = mapId;
+        this._metadataFilters = metadataFilters;
         this.initCache();
     }
     async withMapId(provider) {
@@ -23,7 +31,7 @@ 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("enrichedToc", () => this.withMapId((mapId) => this.fetchPages(mapId).then((toc) => this.converter.convertPaginatedToc(mapId, toc))));
+        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("ratingSummary", () => {
             var _a, _b;
             const userHaveRatingRole = userHasRole((_b = (_a = ftAppInfoStore.getState().session) === null || _a === void 0 ? void 0 : _a.profile.roles) !== null && _b !== void 0 ? _b : [], "RATING_USER");
@@ -33,8 +41,10 @@ export class FtReaderService extends FtServiceWithCache {
     clear() {
         this.cache.clearMatching((key) => key !== "configuration");
     }
-    makeCacheKey(base, translationSettings) {
-        return base + (translationSettings ? "-destinationLanguage-" + (translationSettings === null || translationSettings === void 0 ? void 0 : translationSettings.destinationLanguage) : "");
+    makeCacheKey(base, translationSettings, metadataFilters) {
+        return base
+            + (translationSettings ? "-destinationLanguage-" + (translationSettings === null || translationSettings === void 0 ? void 0 : translationSettings.destinationLanguage) : "")
+            + (!metadataFilters || metadataFilters.length == 0 ? "" : "-metadataFilters-" + this.hash(metadataFilters));
     }
     getMap(translationSettings) {
         return this.cache.get(this.makeCacheKey("map", translationSettings), () => this.fetchMap(this.mapId, translationSettings));
@@ -49,10 +59,10 @@ export class FtReaderService extends FtServiceWithCache {
         this.cache.clear("configuration");
     }
     getEnrichedToc(translationSettings) {
-        return this.cache.get(this.makeCacheKey("enrichedToc", translationSettings), () => this.fetchPages(this.mapId, translationSettings).then((toc) => this.converter.convertPaginatedToc(this.mapId, toc)));
+        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)));
     }
     getEnrichedTocNow(translationSettings) {
-        return this.cache.getNow(this.makeCacheKey("enrichedToc", translationSettings));
+        return this.cache.getNow(this.makeCacheKey("enrichedToc", translationSettings, this.metadataFilters));
     }
     async getPaginationConfiguration() {
         const enrichedToc = await this.getEnrichedToc();
@@ -70,6 +80,10 @@ export class FtReaderService extends FtServiceWithCache {
         const enrichedToc = await this.getEnrichedToc(translationSettings);
         return enrichedToc.translationError;
     }
+    async getFilteredTocNodes(translationSettings) {
+        const enrichedToc = await this.getEnrichedToc(translationSettings);
+        return enrichedToc.filteredTocNodes;
+    }
     async getTocNode(tocId, translationSettings) {
         const enrichedToc = await this.getEnrichedToc(translationSettings);
         return enrichedToc.nodeByTocId[tocId];
@@ -126,7 +140,7 @@ 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) {
+    getLink(tocId, pageNumber, section, withMetadataFilter) {
         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);
@@ -139,8 +153,17 @@ export class FtReaderService extends FtServiceWithCache {
         if (navigationData.section != null) {
             url.searchParams.set("section", navigationData.section);
         }
+        if (withMetadataFilter && navigationData.metadataFilters) {
+            const serializeFilters = SearchPlaceConverter.serializeValueFilters(navigationData.metadataFilters);
+            if (serializeFilters) {
+                url.searchParams.set(SearchPlaceQueryParams.VALUE_FILTERS, serializeFilters);
+            }
+        }
         return url.href;
     }
+    getLinkWithFilter(tocId, pageNumber, section) {
+        return this.getLink(tocId, pageNumber, section, true);
+    }
     getNavigationData(tocId, pageNumber, section, translationInput) {
         var _a, _b;
         tocId = tocId || "root";
@@ -157,6 +180,7 @@ export class FtReaderService extends FtServiceWithCache {
             prettyUrl: prettyUrl != null ? prettyUrl.replace(/^r\//, "") : undefined,
             prettyUrlDuplicated: (_b = enrichedToc === null || enrichedToc === void 0 ? void 0 : enrichedToc.duplicatedPrettyUrls.has(prettyUrl !== null && prettyUrl !== void 0 ? prettyUrl : "")) !== null && _b !== void 0 ? _b : false,
             section: section,
+            metadataFilters: this.metadataFilters,
         };
     }
     async getAccurateNavigationData(tocId, pageNumber, section, translationInput) {
@@ -214,6 +238,9 @@ export class FtReaderService extends FtServiceWithCache {
     }
     buildBreadcrumb(tocId, translationInput) {
         const target = this.getTocNodeNow(tocId, translationInput);
+        if (!target) {
+            return [];
+        }
         const breadcrumb = [{ tocId: target.tocId, title: target.title, untranslatedTitle: target.untranslatedTitle }];
         let parent = this.getTocNodeNow(target.parentTocId, translationInput);
         while (parent) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-reader-context",
-    "version": "2.2.16",
+    "version": "2.2.18",
     "description": "Context block for integrated reader 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.16",
-        "@fluid-topics/ft-wc-utils": "2.2.16",
+        "@fluid-topics/ft-app-context": "2.2.18",
+        "@fluid-topics/ft-wc-utils": "2.2.18",
         "lit": "3.3.3"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.142"
+        "@fluid-topics/public-api": "1.0.143"
     },
-    "gitHead": "c461a5d4f16255f9dd084cb26b2f988702693e2f"
+    "gitHead": "0d86a22efcc09de35d3da8d470ae3f1d69f282bc"
 }