@fluid-topics/ft-reader-context 1.1.26 → 1.1.28

package/build/models.d.ts

@@ -37,3 +37,6 @@ export declare class NotFoundErrorEvent extends Event {
 export declare class UnauthorizedErrorEvent extends Event {
     constructor();
 }
+export declare class TopicRelativeNotFoundEvent extends Event {
+    constructor();
+}

package/build/models.js

@@ -28,3 +28,8 @@ export class UnauthorizedErrorEvent extends Event {
         super("ft-reader-map-unauthorized");
     }
 }
+export class TopicRelativeNotFoundEvent extends Event {
+    constructor() {
+        super("ft-reader-topic-relative-not-found", { bubbles: true, composed: true });
+    }
+}

package/build/store/FtReaderStateManager.d.ts

@@ -1,8 +1,12 @@
+import { ClusteringHelper } from "@fluid-topics/ft-wc-utils";
 import { FtReaderReduxStore } from "./redux";
 import type { FtReaderService } from "./utils/FtReaderService";
+import { FtMetadata } from "@fluid-topics/public-api";
 export declare class FtReaderStateManager {
     store: FtReaderReduxStore;
     static build(id: string, serviceProvider?: () => Promise<FtReaderService>): FtReaderStateManager;
+    metadataForSwitchToRelatives: Set<string>;
+    clusteringHelper?: ClusteringHelper;
     service?: FtReaderService;
     errorHandler?: (e: Error) => void;
     constructor(store: FtReaderReduxStore, serviceProvider: () => Promise<FtReaderService>);
@@ -19,5 +23,10 @@ export declare class FtReaderStateManager {
     clear(): void;
     reload(): Promise<void>;
     private fetchData;
+    private fetchRelatives;
+    private createClusteringHelper;
+    navigateToRelativeTopicIfFound(mapId?: string, topicPivotMetadataValue?: FtMetadata): Promise<void>;
     setSearchInDocumentQuery(query: string): void;
+    registerMetadataForSwitchToRelatives(id: string): void;
+    unregisterMetadataForSwitchToRelatives(id: string): void;
 }

package/build/store/FtReaderStateManager.js

@@ -1,12 +1,15 @@
-import { CanceledPromiseError, Debouncer, waitFor } from "@fluid-topics/ft-wc-utils";
+import { CanceledPromiseError, ClusteringHelper, Debouncer, waitFor } from "@fluid-topics/ft-wc-utils";
 import { createReaderStore } from "./redux";
 import { FtOfficialReaderService } from "./utils/FtOfficialReaderService";
+import { ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { TopicRelativeNotFoundEvent } from "../models";
 export class FtReaderStateManager {
     static build(id, serviceProvider) {
         return new FtReaderStateManager(createReaderStore(id.trim() || "context"), serviceProvider !== null && serviceProvider !== void 0 ? serviceProvider : FtOfficialReaderService.build);
     }
     constructor(store, serviceProvider) {
         this.store = store;
+        this.metadataForSwitchToRelatives = new Set();
         this.loadDebouncer = new Debouncer(10);
         this.initService(serviceProvider);
     }
@@ -69,7 +72,10 @@ export class FtReaderStateManager {
         this.store.actions.pagesToc(undefined);
         this.store.actions.currentPage(undefined);
         this.store.actions.searchInDocumentQuery("");
+        this.store.actions.relatives(undefined);
         (_a = this.service) === null || _a === void 0 ? void 0 : _a.clear();
+        this.metadataForSwitchToRelatives = new Set();
+        this.clusteringHelper = undefined;
     }
     reload() {
         this.clear();
@@ -84,7 +90,11 @@ export class FtReaderStateManager {
                 (_c = this.service) === null || _c === void 0 ? void 0 : _c.getToc().then(toc => this.store.actions.toc(toc)),
                 (_d = this.service) === null || _d === void 0 ? void 0 : _d.getPagesToc().then(pagesToc => this.store.actions.pagesToc(pagesToc)),
                 (_e = this.service) === null || _e === void 0 ? void 0 : _e.getPaginationConfiguration().then(conf => this.store.actions.paginationConfiguration(conf)),
-            ]);
+            ]).then(() => {
+                if (this.metadataForSwitchToRelatives.size > 0) {
+                    this.fetchRelatives();
+                }
+            });
         }
         catch (e) {
             if (this.errorHandler && !(e instanceof CanceledPromiseError)) {
@@ -92,7 +102,54 @@ export class FtReaderStateManager {
             }
         }
     }
+    fetchRelatives() {
+        var _a, _b, _c;
+        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((_c = this.store.getState().configuration) === null || _c === void 0 ? void 0 : _c.relativePivotMetadata, relativeMetadataValues).then((searchResults) => {
+                const relatives = searchResults.results.flatMap((result) => result.entries);
+                this.store.actions.relatives(relatives);
+                this.createClusteringHelper();
+            });
+        }
+    }
+    createClusteringHelper() {
+        var _a, _b;
+        if (this.store.getState().relatives) {
+            this.clusteringHelper = new ClusteringHelper(this.store.getState().relatives, this.store.getState().relatives.find((relative) => { var _a; return ((_a = relative.map) === null || _a === void 0 ? void 0 : _a.mapId) == this.store.getState().mapId; }), this.metadataForSwitchToRelatives, (_b = (_a = ftAppInfoStore.getState().metadataConfiguration) === null || _a === void 0 ? void 0 : _a.descriptors) !== null && _b !== void 0 ? _b : []);
+            this.store.eventBus.dispatchEvent(new CustomEvent("clustering-helper-created"));
+        }
+    }
+    async navigateToRelativeTopicIfFound(mapId, topicPivotMetadataValue) {
+        var _a, _b, _c;
+        if (mapId && topicPivotMetadataValue) {
+            const relativeTopicPivotMetadata = this.store.getState().configuration.relativeTopicPivotMetadata;
+            const service = await this.awaitService();
+            const searchResults = await service.getRelativesForTopicInMap(mapId, relativeTopicPivotMetadata, topicPivotMetadataValue.values);
+            await this.setMapId(mapId);
+            if ((_c = (_b = (_a = searchResults === null || searchResults === void 0 ? void 0 : searchResults.results) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.entries) === null || _c === void 0 ? void 0 : _c[0]) {
+                const targetTocId = searchResults.results[0].entries[0].topic.tocId;
+                await this.navigateToTopic(targetTocId);
+            }
+            else {
+                this.store.eventBus.dispatchEvent(new TopicRelativeNotFoundEvent());
+            }
+        }
+    }
     setSearchInDocumentQuery(query) {
         this.store.actions.searchInDocumentQuery(query);
     }
+    registerMetadataForSwitchToRelatives(id) {
+        this.metadataForSwitchToRelatives.add(id);
+        if (this.store.getState().relatives == undefined) {
+            this.fetchRelatives();
+        }
+        else {
+            this.createClusteringHelper();
+        }
+    }
+    unregisterMetadataForSwitchToRelatives(id) {
+        this.metadataForSwitchToRelatives.delete(id);
+        this.createClusteringHelper();
+    }
 }

package/build/store/model.d.ts

@@ -1,4 +1,4 @@
-import { FtMap, FtPaginationConfiguration, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtSession, FtTocNode, FtTopic, FtTopicRating } from "@fluid-topics/public-api";
+import { FtMap, FtPaginationConfiguration, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtSearchResultClusterEntry, FtSession, FtTocNode, FtTopic, FtTopicRating } from "@fluid-topics/public-api";
 import { Optional } from "@fluid-topics/ft-wc-utils";
 export interface FtPagesTocNode {
     depth: number;
@@ -38,6 +38,7 @@ export interface FtReaderState {
     visibleTopics: string[];
     configuration: Optional<FtReaderConfiguration>;
     searchInDocumentQuery: Optional<string>;
+    relatives: Optional<Array<FtSearchResultClusterEntry>>;
 }
 export interface FtReaderNavigationData {
     mapId: string;

package/build/store/redux.js

@@ -12,5 +12,6 @@ export const createReaderStore = (id) => FtReduxStore.get({
         scrollTarget: undefined,
         configuration: undefined,
         searchInDocumentQuery: undefined,
+        relatives: undefined,
     }
 });

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

@@ -1,4 +1,5 @@
 import type { FtMap, FtMapAttachment, FtPaginatedToc, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtTocNode, FtTopic } from "@fluid-topics/public-api";
+import { FtSearchResults } from "@fluid-topics/public-api";
 import { FtReaderService } from "./FtReaderService";
 import { FtReaderFeatures } from "../model";
 export declare class FtOfficialReaderService extends FtReaderService {
@@ -11,6 +12,8 @@ export declare class FtOfficialReaderService extends FtReaderService {
     protected fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
     protected fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
     protected fetchAttachments(): Promise<Array<FtMapAttachment>>;
+    protected fetchRelativesForDocument(metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
+    protected fetchRelativesForTopicInMap(mapId: string, metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
     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>;

package/build/store/utils/FtOfficialReaderService.js

@@ -31,6 +31,43 @@ export class FtOfficialReaderService extends FtReaderService {
     fetchAttachments() {
         return this.api.getMapAttachments(this.mapId).catch(() => []);
     }
+    fetchRelativesForDocument(metadataPivotKey, metadataPivotValues) {
+        return this.api.search({
+            query: "",
+            paging: { page: 1, perPage: -1 },
+            scope: "DOCUMENTS",
+            filters: [
+                {
+                    negative: false,
+                    values: metadataPivotValues,
+                    key: metadataPivotKey
+                }
+            ],
+            sort: [],
+            facets: []
+        });
+    }
+    fetchRelativesForTopicInMap(mapId, metadataPivotKey, metadataPivotValues) {
+        return this.api.search({
+            query: "",
+            paging: { page: 1, perPage: 1 },
+            scope: "ALL_TOPICS",
+            filters: [
+                {
+                    negative: false,
+                    values: metadataPivotValues,
+                    key: metadataPivotKey
+                },
+                {
+                    negative: false,
+                    values: [mapId],
+                    key: "ft:publicationId",
+                }
+            ],
+            sort: [],
+            facets: []
+        });
+    }
     makeMapFeedbackRequest(message, from) {
         return this.api.sendMapFeedback(this.mapId, message, from);
     }

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

@@ -1,5 +1,5 @@
 import type { FluidTopicsApi, FtMap, FtMapAttachment, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, FtTopic } from "@fluid-topics/public-api";
-import { FtRatingType } from "@fluid-topics/public-api";
+import { FtRatingType, FtSearchResults } from "@fluid-topics/public-api";
 import { CacheRegistry } from "@fluid-topics/ft-wc-utils";
 import { FtPagesTocNode, FtReaderFeatureAccessData, FtReaderFeatures, FtReaderNavigationData, FtReaderPage, FtReaderTocNode, FtTopicRatingSummary } from "../model";
 import { EnrichedToc, FtReaderConverter } from "./FtReaderConverter";
@@ -14,6 +14,8 @@ export declare abstract class FtReaderService {
     protected abstract fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
     protected abstract fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
     protected abstract fetchAttachments(): Promise<Array<FtMapAttachment>>;
+    protected abstract fetchRelativesForDocument(metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
+    protected abstract fetchRelativesForTopicInMap(mapId: string, metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
     protected abstract makeRateMapRequest(type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
     protected abstract makeUnrateMapRequest(): Promise<void>;
     protected abstract makeMapFeedbackRequest(message: string, from?: string): Promise<void>;
@@ -43,6 +45,8 @@ export declare abstract class FtReaderService {
     getTopicInfo(tocNode: FtTocNode): Promise<FtTopic>;
     getTopicContent(tocNode: FtTocNode): Promise<string>;
     getAttachments(): Promise<Array<FtMapAttachment>>;
+    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;
     getNavigationData(tocId?: string, pageNumber?: number, section?: string): FtReaderNavigationData;

package/build/store/utils/FtReaderService.js

@@ -83,6 +83,12 @@ export class FtReaderService {
     getAttachments() {
         return this.cache.get("map-attachments", () => this.fetchAttachments());
     }
+    getRelativesForDocument(metadataPivotKey, metadataPivotValues) {
+        return this.cache.get("document-relatives-" + metadataPivotKey + "-" + metadataPivotValues.join("-"), () => this.fetchRelativesForDocument(metadataPivotKey, metadataPivotValues));
+    }
+    getRelativesForTopicInMap(mapId, metadataPivotKey, metadataPivotValues) {
+        return this.cache.get("topic-relatives-" + [mapId, metadataPivotKey, ...metadataPivotValues].join("-"), () => this.fetchRelativesForTopicInMap(mapId, metadataPivotKey, metadataPivotValues));
+    }
     getAttachmentDownloadLink(id) {
         return this.makeAbsolute(`${this.api.endpoints.khub.maps.mapId(this.mapId).attachments.attachmentId(id).content}?download=true`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-reader-context",
-  "version": "1.1.26",
+  "version": "1.1.28",
   "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": "1.1.26",
-    "@fluid-topics/ft-wc-utils": "1.1.26",
+    "@fluid-topics/ft-app-context": "1.1.28",
+    "@fluid-topics/ft-wc-utils": "1.1.28",
     "@reduxjs/toolkit": "^1.6.2",
     "lit": "3.1.0"
   },
   "devDependencies": {
-    "@fluid-topics/public-api": "1.0.56"
+    "@fluid-topics/public-api": "1.0.57"
   },
-  "gitHead": "6734976f5a7f6b986917a085be0c38ca3ae562a0"
+  "gitHead": "8c1055ddd23e83efa3833f033a507aa1ab32fecc"
 }