@fluid-topics/ft-reader-context 2.0.14 → 2.0.15

package/build/index.d.ts

@@ -6,4 +6,5 @@ export * from "./store/model";
 export * from "./store/utils/FtReaderConverter";
 export * from "./store/utils/FtReaderService";
 export * from "./store/utils/FtOfficialReaderService";
+export * from "./utils";
 import "./define";

package/build/index.js

@@ -6,4 +6,5 @@ export * from "./store/model";
 export * from "./store/utils/FtReaderConverter";
 export * from "./store/utils/FtReaderService";
 export * from "./store/utils/FtOfficialReaderService";
+export * from "./utils";
 import "./define";

package/build/store/FtReaderStateManager.d.ts

@@ -57,6 +57,7 @@ export declare class FtReaderStateManager {
     getTocNode(tocId: string): Promise<FtReaderTocNode>;
     getPage(targetPageNumber: number): Promise<FtReaderPage>;
     onMapAttachmentsUpdate(): void;
+    getRelativeDocumentUrlForLocale(uiLocale: string): Promise<string | undefined>;
     private sendDocumentOnDemandTranslateEvent;
     private parseLanguageToAnalyticsFormat;
 }

package/build/store/FtReaderStateManager.js

@@ -1,9 +1,10 @@
-import { FtReaderStoreEvents } from "./model";
-import { CanceledPromiseError, ClusteringHelper, Debouncer, waitFor, waitUntil } from "@fluid-topics/ft-wc-utils";
-import { createReaderStore } from "./redux";
+import { FtReaderStoreEvents, } from "./model";
+import { accessResultUrl, CanceledPromiseError, ClusteringHelper, Debouncer, waitFor, waitUntil, } from "@fluid-topics/ft-wc-utils";
+import { createReaderStore, } from "./redux";
 import { FtOfficialReaderService } from "./utils/FtOfficialReaderService";
-import { ftAppInfoStore, FtAnalyticsEventsService, } from "@fluid-topics/ft-app-context";
+import { FtAnalyticsEventsService, ftAppInfoStore, } from "@fluid-topics/ft-app-context";
 import { FtAnalyticsTranslationOrigin, } from "@fluid-topics/public-api";
+import { addPivotQueryParam } from "../utils";
 export class FtReaderStateManager {
     static build(id, serviceProvider) {
         return new FtReaderStateManager(createReaderStore(id.trim() || "context"), serviceProvider !== null && serviceProvider !== void 0 ? serviceProvider : FtOfficialReaderService.build);
@@ -149,19 +150,15 @@ export class FtReaderStateManager {
         (_a = this.service) === null || _a === void 0 ? void 0 : _a.clearConfiguration();
         return this.loadConfiguration();
     }
-    fetchRelatives() {
+    async fetchRelatives() {
         var _a, _b;
         const relativeMetadataValues = (_a = this.store.getState().map) === null || _a === void 0 ? void 0 : _a.metadata.filter((metadata) => { var _a; return metadata.key == ((_a = this.store.getState().configuration) === null || _a === void 0 ? void 0 : _a.relativePivotMetadata); }).flatMap((metadata) => metadata.values);
         if (relativeMetadataValues !== undefined && relativeMetadataValues.length > 0) {
-            (_b = this.service) === null || _b === void 0 ? void 0 : _b.getRelativesForDocument(this.store.getState().configuration.relativePivotMetadata, relativeMetadataValues).then((searchResults) => {
-                const relatives = searchResults.results.flatMap((result) => result.entries);
-                this.store.actions.relatives(relatives);
-                this.updateClusteringHelper();
-            });
-        }
-        else {
-            this.updateClusteringHelper();
+            const searchResults = await ((_b = this.service) === null || _b === void 0 ? void 0 : _b.getRelativesForDocument(this.store.getState().configuration.relativePivotMetadata, relativeMetadataValues));
+            const relatives = searchResults === null || searchResults === void 0 ? void 0 : searchResults.results.flatMap((result) => result.entries);
+            this.store.actions.relatives(relatives);
         }
+        this.updateClusteringHelper();
     }
     updateClusteringHelper() {
         this.clusteringHelper = this.createClusteringHelper();
@@ -291,6 +288,23 @@ export class FtReaderStateManager {
         (_a = this.service) === null || _a === void 0 ? void 0 : _a.clearMapAttachments();
         this.store.dispatchEvent(new Event(FtReaderStoreEvents.mapAttachmentsUpdate));
     }
+    async getRelativeDocumentUrlForLocale(uiLocale) {
+        var _a, _b, _c;
+        if (this.store.getState().relatives == undefined) {
+            await this.fetchRelatives();
+        }
+        const maybeRelativeResultMap = ClusteringHelper.findResultWithMetadataValue((_a = this.store.getState().relatives) !== null && _a !== void 0 ? _a : [], "ft:locale", uiLocale);
+        let targetUrl = accessResultUrl(maybeRelativeResultMap);
+        if (targetUrl) {
+            const currentTocId = this.store.getState().visibleTopics[0];
+            const metadataKey = (_b = this.store.getState().configuration) === null || _b === void 0 ? void 0 : _b.relativeTopicPivotMetadata;
+            if (metadataKey && currentTocId) {
+                const maybePivot = await ((_c = this.service) === null || _c === void 0 ? void 0 : _c.getTopicMetadataValue(currentTocId, metadataKey));
+                targetUrl = addPivotQueryParam(targetUrl, maybePivot);
+            }
+        }
+        return targetUrl;
+    }
     sendDocumentOnDemandTranslateEvent(destinationLanguage) {
         const { editorMode, apiIntegrationIdentifier, apiIntegrationAppVersion } = ftAppInfoStore.getState();
         const state = this.store.getState();

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

@@ -1,4 +1,4 @@
-import type { FluidTopicsApi, FtMap, FtMapAttachment, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, FtTopic, FtTranslationContent, FtTranslationSettings } from "@fluid-topics/public-api";
+import type { FluidTopicsApi, FtMap, FtMapAttachment, FtMetadata, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, 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";
@@ -49,6 +49,7 @@ export declare abstract class FtReaderService extends FtServiceWithCache {
     getTopicInfo(tocNode: FtTocNode): Promise<FtTopic>;
     getTopicContent(tocNode: FtTocNode): Promise<string>;
     getTranslatedTopicContent(tocNode: FtTocNode, translationInput: FtTranslationSettings): Promise<FtTranslationContent>;
+    getTopicMetadataValue(tocId: string, metadataKey: string): Promise<FtMetadata | undefined>;
     getAttachments(): Promise<Array<FtMapAttachment>>;
     clearMapAttachments(): void;
     getRelativesForDocument(metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;

package/build/store/utils/FtReaderService.js

@@ -103,6 +103,14 @@ export class FtReaderService extends FtServiceWithCache {
     getTranslatedTopicContent(tocNode, translationInput) {
         return this.cache.get(this.makeCacheKey("translated-topic-content-" + tocNode.tocId, translationInput), () => this.fetchTranslatedTopicHTMLContent(tocNode, translationInput));
     }
+    async getTopicMetadataValue(tocId, metadataKey) {
+        const tocNode = this.getTocNodeNow(tocId);
+        if (!tocNode) {
+            return undefined;
+        }
+        const topicInfo = await this.getTopicInfo(tocNode);
+        return topicInfo === null || topicInfo === void 0 ? void 0 : topicInfo.metadata.find((metadata) => metadata.key == metadataKey);
+    }
     getAttachments() {
         return this.cache.get("map-attachments", () => this.fetchAttachments());
     }

package/build/utils.d.ts

@@ -0,0 +1,2 @@
+import { FtMetadata } from "@fluid-topics/public-api";
+export declare function addPivotQueryParam(url: string, metadata?: FtMetadata): string;

package/build/utils.js

@@ -0,0 +1,8 @@
+const TOPIC_PIVOT_QUERY_PARAM_KEY = "topicPivot";
+export function addPivotQueryParam(url, metadata) {
+    const updated = new URL(url);
+    metadata === null || metadata === void 0 ? void 0 : metadata.values.forEach((v) => {
+        updated.searchParams.append(TOPIC_PIVOT_QUERY_PARAM_KEY, v);
+    });
+    return updated.href;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-reader-context",
-    "version": "2.0.14",
+    "version": "2.0.15",
     "description": "Context block for integrated reader components",
     "keywords": [
         "Lit"
@@ -19,13 +19,13 @@
         "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
     },
     "dependencies": {
-        "@fluid-topics/ft-app-context": "2.0.14",
-        "@fluid-topics/ft-wc-utils": "2.0.14",
+        "@fluid-topics/ft-app-context": "2.0.15",
+        "@fluid-topics/ft-wc-utils": "2.0.15",
         "@reduxjs/toolkit": "^1.6.2",
         "lit": "3.1.0"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.119"
+        "@fluid-topics/public-api": "1.0.120"
     },
-    "gitHead": "4c50289bffd5b4b58542856830adc1399b93a70f"
+    "gitHead": "4ccf89e835f22f2689fc0fe3f97c46671debe98d"
 }