@fluid-topics/ft-reader-context 1.0.53 → 1.0.55

package/build/models.js

@@ -0,0 +1,30 @@
+export class MapLoadedEvent extends CustomEvent {
+    constructor(map, toc) {
+        super("ft-reader-map-loaded", { detail: { map, toc } });
+    }
+}
+export class VisibleTopicsChangeEvent extends CustomEvent {
+    constructor(map, visibleTopics) {
+        super("ft-reader-visible-topics-change", { detail: { visibleTopics } });
+    }
+}
+export class NavigationDoneEvent extends CustomEvent {
+    constructor(data) {
+        super("ft-reader-navigation-done", { detail: data });
+    }
+}
+export class LoadErrorEvent extends CustomEvent {
+    constructor(e) {
+        super("ft-reader-load-error", { detail: e });
+    }
+}
+export class NotFoundErrorEvent extends Event {
+    constructor() {
+        super("ft-reader-map-not-found");
+    }
+}
+export class UnauthorizedErrorEvent extends Event {
+    constructor() {
+        super("ft-reader-map-unauthorized");
+    }
+}

package/build/store/FtReaderStateManager.d.ts

@@ -1,14 +1,14 @@
 import { FtReaderState } from "./model";
 import { FtReduxStore } from "@fluid-topics/ft-wc-utils";
 import { FtReaderStateReducers } from "./redux";
-import { FtReaderService } from "./utils/FtReaderService";
+import type { FtReaderService } from "./utils/FtReaderService";
 export declare class FtReaderStateManager {
     store: FtReduxStore<FtReaderState, FtReaderStateReducers>;
-    static build(id: string): FtReaderStateManager;
+    static build(id: string, serviceProvider?: () => Promise<FtReaderService>): FtReaderStateManager;
     service?: FtReaderService;
     errorHandler?: (e: Error) => void;
     constructor(store: FtReduxStore<FtReaderState, FtReaderStateReducers>, serviceProvider: () => Promise<FtReaderService>);
-    private initService;
+    initService(serviceProvider: () => Promise<FtReaderService>): Promise<void>;
     setMapId(mapId?: string): Promise<void>;
     setVisibleTopics(tocIds: string[]): void;
     awaitService(): Promise<FtReaderService>;

package/build/store/FtReaderStateManager.js

@@ -1,9 +1,9 @@
 import { CanceledPromiseError, Debouncer, delay } from "@fluid-topics/ft-wc-utils";
 import { createReaderStore } from "./redux";
-import { FtReaderService } from "./utils/FtReaderService";
+import { FtOfficialReaderService } from "./utils/FtOfficialReaderService";
 export class FtReaderStateManager {
-    static build(id) {
-        return new FtReaderStateManager(createReaderStore(id.trim() || "context"), FtReaderService.build);
+    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;

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

@@ -0,0 +1,18 @@
+import type { FtMap, FtPaginatedToc, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtTocNode, FtTopic } from "@fluid-topics/public-api";
+import { FtReaderFeatures, FtReaderService } from "./FtReaderService";
+export declare class FtOfficialReaderService extends FtReaderService {
+    static build(mapId?: string): Promise<FtOfficialReaderService>;
+    protected fetchMap(mapId: string): Promise<FtMap>;
+    protected fetchMapRating(mapId: string): Promise<FtRatingSummary>;
+    protected fetchPages(mapId: string): Promise<FtPaginatedToc>;
+    protected fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
+    protected fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
+    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): Promise<void>;
+    protected makeUnrateMapRequest(): Promise<void>;
+    protected makeUnrateTopicRequest(tocId: string): Promise<void>;
+    protected getReaderLinkPrefix(): string;
+    isFeatureAccessible(feature: FtReaderFeatures): boolean;
+}

package/build/store/utils/FtOfficialReaderService.js

@@ -0,0 +1,48 @@
+import { CacheRegistry } from "@fluid-topics/ft-wc-utils";
+import { FtReaderConverter } from "./FtReaderConverter";
+import { FtReaderService } from "./FtReaderService";
+import { FluidTopicsApiProvider } from "@fluid-topics/ft-app-context";
+export class FtOfficialReaderService extends FtReaderService {
+    static async build(mapId) {
+        return new FtOfficialReaderService(new FtReaderConverter(), await FluidTopicsApiProvider.await(), new CacheRegistry(), mapId);
+    }
+    fetchMap(mapId) {
+        return this.api.getMap(mapId);
+    }
+    fetchMapRating(mapId) {
+        return this.api.getMapRating(mapId);
+    }
+    fetchPages(mapId) {
+        return this.api.getPages(mapId);
+    }
+    fetchTopicHTMLContent(tocNode) {
+        return this.api.getTopicHTMLContent(this.mapId, tocNode.contentId, "DESIGNED_READER");
+    }
+    fetchTopicMetadata(tocNode) {
+        return this.api.getTopic(this.mapId, tocNode.contentId);
+    }
+    makeMapFeedbackRequest(message, from) {
+        return this.api.sendMapFeedback(this.mapId, message, from);
+    }
+    makeRateMapRequest(type, value) {
+        return this.api.rateMap(this.mapId, type, value);
+    }
+    makeRateTopicRequest(tocId, type, value) {
+        return this.api.rateTopic(this.mapId, tocId, type, value);
+    }
+    makeTopicFeedbackRequest(tocId, message, from) {
+        return this.api.sendTopicFeedback(this.mapId, tocId, message, from);
+    }
+    makeUnrateMapRequest() {
+        return this.api.unrateMap(this.mapId);
+    }
+    makeUnrateTopicRequest(tocId) {
+        return this.api.unrateTopic(this.mapId, tocId);
+    }
+    getReaderLinkPrefix() {
+        return "r/";
+    }
+    isFeatureAccessible(feature) {
+        return true;
+    }
+}

package/build/store/utils/FtReaderConverter.js

@@ -51,6 +51,7 @@ class EnrichedTocBuilder {
                 contentId: node.contentId,
                 title: node.title,
                 hasRating: node.hasRating,
+                origin: node.origin,
                 prettyUrl,
                 depth,
                 parentTocId: parentTocId,
@@ -88,7 +89,7 @@ class EnrichedTocBuilder {
             number: this.pages.length + 1,
             title: (_a = node.title) !== null && _a !== void 0 ? _a : "",
             rootTocId: (_b = node.tocId) !== null && _b !== void 0 ? _b : "root",
-            toc: ((_c = node.pageToc) !== null && _c !== void 0 ? _c : []).map(n => this.nodeByTocId[n.tocId]),
+            toc: ((_c = node.pageToc) !== null && _c !== void 0 ? _c : []).map((n) => this.nodeByTocId[n.tocId]),
             topics: [],
             hiddenTopics: [],
             breadcrumb: parentTocId ? this.buildBreadcrumb(this.nodeByTocId[parentTocId]) : []

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

@@ -1,12 +1,32 @@
-import type { FluidTopicsApi, FtMap, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtTopic } from "@fluid-topics/public-api";
+import type { FluidTopicsApi, FtMap, FtPaginatedToc, FtPaginationConfiguration, FtPublicationRatingSummary, FtRatingSummary, FtRatingType, FtRatingTypeKeys, FtReaderConfiguration, FtTocNode, FtTopic } from "@fluid-topics/public-api";
 import { CacheRegistry } from "@fluid-topics/ft-wc-utils";
 import { FtPagesTocNode, FtReaderNavigationData, FtReaderPage, FtReaderTocNode, FtTopicRatingSummary } from "../model";
 import { EnrichedToc, FtReaderConverter } from "./FtReaderConverter";
-export declare class FtReaderService {
-    private converter;
-    private api;
-    private cache;
-    static build(mapId?: string): Promise<FtReaderService>;
+import { FtReaderBreadcrumb } from "../../models";
+export declare enum FtReaderFeatures {
+    FEEDBACK = "FEEDBACK",
+    RATING = "RATING",
+    PRINT = "PRINT",
+    BOOKMARK = "BOOKMARK",
+    COLLECTIONS = "COLLECTIONS"
+}
+export declare abstract class FtReaderService {
+    protected converter: FtReaderConverter;
+    protected api: FluidTopicsApi;
+    protected cache: CacheRegistry;
+    protected abstract fetchMap(mapId: string): Promise<FtMap>;
+    protected abstract fetchPages(mapId: string): Promise<FtPaginatedToc>;
+    protected abstract fetchMapRating(mapId: string): Promise<FtRatingSummary>;
+    protected abstract fetchTopicMetadata(tocNode: FtTocNode): Promise<FtTopic>;
+    protected abstract fetchTopicHTMLContent(tocNode: FtTocNode): Promise<string>;
+    protected abstract makeRateMapRequest(type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
+    protected abstract makeUnrateMapRequest(): Promise<void>;
+    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): Promise<void>;
+    protected abstract getReaderLinkPrefix(): string;
+    abstract isFeatureAccessible(feature: FtReaderFeatures): boolean;
     private _mapId;
     get mapId(): string;
     set mapId(value: string | undefined);
@@ -25,8 +45,8 @@ export declare class FtReaderService {
     getTocNodeNow(tocId: string): FtReaderTocNode | undefined;
     getPage(number: number): Promise<FtReaderPage>;
     getPageByTocId(tocId: string): Promise<FtReaderPage>;
-    getTopicInfo(contentId: string): Promise<FtTopic>;
-    getTopicContent(contentId: string): Promise<string>;
+    getTopicInfo(tocNode: FtTocNode): Promise<FtTopic>;
+    getTopicContent(tocNode: FtTocNode): Promise<string>;
     getLink(tocId?: string, pageNumber?: number, section?: string): string;
     getNavigationData(tocId?: string, pageNumber?: number, section?: string): FtReaderNavigationData;
     getAccurateNavigationData(tocId?: string, pageNumber?: number, section?: string): Promise<FtReaderNavigationData>;
@@ -42,4 +62,5 @@ export declare class FtReaderService {
     sendTopicFeedback(tocId: string, message: string, from?: string): Promise<void>;
     fontsStylesheet(): string;
     themeStylesheet(): string;
+    buildBreadcrumb(tocId: string): Array<FtReaderBreadcrumb>;
 }

package/build/store/utils/FtReaderService.js

@@ -1,10 +1,14 @@
-import { CacheRegistry } from "@fluid-topics/ft-wc-utils";
-import { FtReaderConverter } from "./FtReaderConverter";
-import { FluidTopicsApiProvider, ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { userHasRole } from "@fluid-topics/public-api";
+import { ftAppInfoStore } from "@fluid-topics/ft-app-context";
+export var FtReaderFeatures;
+(function (FtReaderFeatures) {
+    FtReaderFeatures["FEEDBACK"] = "FEEDBACK";
+    FtReaderFeatures["RATING"] = "RATING";
+    FtReaderFeatures["PRINT"] = "PRINT";
+    FtReaderFeatures["BOOKMARK"] = "BOOKMARK";
+    FtReaderFeatures["COLLECTIONS"] = "COLLECTIONS";
+})(FtReaderFeatures || (FtReaderFeatures = {}));
 export class FtReaderService {
-    static async build(mapId) {
-        return new FtReaderService(new FtReaderConverter(), await FluidTopicsApiProvider.await(), new CacheRegistry(), mapId);
-    }
     get mapId() {
         return this._mapId;
     }
@@ -26,12 +30,12 @@ export class FtReaderService {
     }
     initCache() {
         this.cache.registerFinal("configuration", () => this.api.getReaderConfiguration());
-        this.cache.register("map", () => this.withMapId(mapId => this.api.getMap(mapId)));
-        this.cache.register("enrichedToc", () => this.withMapId(mapId => this.api.getPages(mapId).then(toc => this.converter.convertPaginatedToc(toc))));
+        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(toc))));
         this.cache.register("ratingSummary", () => {
-            var _a;
-            const userHaveRatingRole = (_a = ftAppInfoStore.getState().session) === null || _a === void 0 ? void 0 : _a.profile.roles.includes("RATING_USER");
-            return userHaveRatingRole ? this.withMapId(mapId => this.api.getMapRating(mapId)) : Promise.resolve();
+            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");
+            return userHaveRatingRole ? this.withMapId(mapId => this.fetchMapRating(mapId)) : Promise.resolve();
         });
     }
     clear() {
@@ -77,15 +81,15 @@ export class FtReaderService {
         const enrichedToc = await this.getEnrichedToc();
         return enrichedToc.pageByTocId[tocId] || enrichedToc.pages[0];
     }
-    getTopicInfo(contentId) {
-        return this.cache.get("topic-" + contentId, () => this.api.getTopic(this.mapId, contentId));
+    getTopicInfo(tocNode) {
+        return this.cache.get("topic-" + tocNode.tocId, () => this.fetchTopicMetadata(tocNode));
     }
-    getTopicContent(contentId) {
-        return this.cache.get("topic-content-" + contentId, () => this.api.getTopicHTMLContent(this.mapId, contentId, "DESIGNED_READER"));
+    getTopicContent(tocNode) {
+        return this.cache.get("topic-content-" + tocNode.tocId, () => this.fetchTopicHTMLContent(tocNode));
     }
     getLink(tocId, pageNumber, section) {
         const navigationData = this.getNavigationData(tocId, pageNumber, section);
-        const path = "r/" + (navigationData.prettyUrl ? navigationData.prettyUrl : `${navigationData.mapId}/${navigationData.tocId}`);
+        const path = this.getReaderLinkPrefix() + (navigationData.prettyUrl ? navigationData.prettyUrl : `${navigationData.mapId}/${navigationData.tocId}`);
         const url = new URL(path, this.api.tenantBaseUrl);
         if (navigationData.page != null) {
             url.searchParams.set("page", `${navigationData.page}`);
@@ -135,19 +139,19 @@ export class FtReaderService {
         });
     }
     rateMap(type, value) {
-        return this.api.rateMap(this.mapId, type, value).then(() => this.clearRatingIfNecessary());
+        return this.makeRateMapRequest(type, value).then(() => this.clearRatingIfNecessary());
     }
     unrateMap() {
-        return this.api.unrateMap(this.mapId).then(() => this.clearRatingIfNecessary());
+        return this.makeUnrateMapRequest().then(() => this.clearRatingIfNecessary());
     }
     sendMapFeedback(message, from) {
-        return this.api.sendMapFeedback(this.mapId, message, from);
+        return this.makeMapFeedbackRequest(message, from);
     }
     rateTopic(tocId, type, value) {
-        return this.api.rateTopic(this.mapId, tocId, type, value).then(() => this.clearRatingIfNecessary());
+        return this.makeRateTopicRequest(tocId, type, value).then(() => this.clearRatingIfNecessary());
     }
     unrateTopic(tocId) {
-        return this.api.unrateTopic(this.mapId, tocId).then(() => this.clearRatingIfNecessary());
+        return this.makeUnrateTopicRequest(tocId).then(() => this.clearRatingIfNecessary());
     }
     async clearRatingIfNecessary() {
         const session = ftAppInfoStore.getState().session;
@@ -156,7 +160,7 @@ export class FtReaderService {
         }
     }
     sendTopicFeedback(tocId, message, from) {
-        return this.api.sendTopicFeedback(this.mapId, tocId, message, from);
+        return this.makeTopicFeedbackRequest(tocId, message, from);
     }
     fontsStylesheet() {
         return this.api.makeAbsolute(this.api.endpoints.stylesheets.fonts);
@@ -164,4 +168,14 @@ export class FtReaderService {
     themeStylesheet() {
         return this.api.makeAbsolute(this.api.endpoints.stylesheets.theme);
     }
+    buildBreadcrumb(tocId) {
+        let target = this.getTocNodeNow(tocId);
+        let breadcrumb = [{ tocId: target.tocId, title: target.title }];
+        let parent = this.getTocNodeNow(target.parentTocId);
+        while (parent) {
+            breadcrumb.unshift({ tocId: parent.tocId, title: parent.title });
+            parent = this.getTocNodeNow(parent.parentTocId);
+        }
+        return breadcrumb;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-reader-context",
-  "version": "1.0.53",
+  "version": "1.0.55",
   "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.0.53",
-    "@fluid-topics/ft-wc-utils": "1.0.53",
+    "@fluid-topics/ft-app-context": "1.0.55",
+    "@fluid-topics/ft-wc-utils": "1.0.55",
     "@reduxjs/toolkit": "^1.6.2",
     "lit": "2.7.2"
   },
   "devDependencies": {
-    "@fluid-topics/public-api": "1.0.44"
+    "@fluid-topics/public-api": "1.0.45"
   },
-  "gitHead": "adfef35652b764d792d22aeef90c706676636803"
+  "gitHead": "4eca32ed1fec3fd25b6d76b26895a6318cfa8ca2"
 }