@fluid-topics/ft-reader-context 2.2.17 → 2.2.19

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,9 +31,10 @@ 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;
+            var _a;
+            var _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");
             return userHaveRatingRole ? this.withMapId((mapId) => this.fetchMapRating(mapId)) : Promise.resolve();
         });
@@ -33,8 +42,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 +60,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 +81,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 +141,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 +154,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 +181,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) {
@@ -174,13 +199,10 @@ export class FtReaderService extends FtServiceWithCache {
         return this.getRatingSummary().then((rm) => rm === null || rm === void 0 ? void 0 : rm.publication);
     }
     getTopicRating(tocId) {
-        return this.getRatingSummary().then((rm) => {
-            var _a;
-            return rm ? {
-                type: rm.topics.type,
-                rating: (_a = rm.topics) === null || _a === void 0 ? void 0 : _a.ratings.find((t) => t.tocId === tocId),
-            } : undefined;
-        });
+        return this.getRatingSummary().then((rm) => { var _a; return rm ? {
+            type: rm.topics.type,
+            rating: (_a = rm.topics) === null || _a === void 0 ? void 0 : _a.ratings.find((t) => t.tocId === tocId),
+        } : undefined; });
     }
     rateMap(type, value) {
         return this.makeRateMapRequest(type, value).then(() => this.clearRatingIfNecessary());
@@ -214,6 +236,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.17",
+    "version": "2.2.19",
     "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.17",
-        "@fluid-topics/ft-wc-utils": "2.2.17",
+        "@fluid-topics/ft-app-context": "2.2.19",
+        "@fluid-topics/ft-wc-utils": "2.2.19",
         "lit": "3.3.3"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.142"
+        "@fluid-topics/public-api": "1.0.143"
     },
-    "gitHead": "36907c574a4cfc29bc07e86865cdb5b7e19d3d03"
+    "gitHead": "1ae520afe5e3697dee3c95ba254b53a8f7850594"
 }