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

package/build/ft-reader-context.d.ts

@@ -1,12 +1,14 @@
 import { PropertyValues } from "lit";
-import { FtLitElementRedux, FtRegistrationContext } from "@fluid-topics/ft-wc-utils";
+import { ElementDefinitionsMap, FtLitElementRedux, FtRegistrationContext } from "@fluid-topics/ft-wc-utils";
 import { FtReaderComponentInterface } from "./registration";
 import { FtReaderStateManager } from "./store/FtReaderStateManager";
 import { FtReaderPage, FtReaderScrollTarget, FtReaderTocNode } from "./store/model";
-import type { FtMap, FtSession } from "@fluid-topics/public-api";
+import { FtMap, FtMetadataFilter, FtSession } from "@fluid-topics/public-api";
 import { FtReaderContextProperties } from "./ft-reader-context.properties";
 import type { FtReaderService } from "./store/utils/FtReaderService";
+import { FtSearchContext } from "@fluid-topics/ft-search-context";
 export declare class FtReaderContext extends FtLitElementRedux implements FtReaderContextProperties, FtRegistrationContext<FtReaderComponentInterface> {
+    static elementDefinitions: ElementDefinitionsMap;
     static styles: import("lit").CSSResult;
     baseUrl?: string;
     session?: FtSession;
@@ -15,6 +17,7 @@ export declare class FtReaderContext extends FtLitElementRedux implements FtRead
     section?: string;
     topicPivot?: string;
     searchInDocumentQuery?: string;
+    metadataFilters: Array<FtMetadataFilter>;
     page?: number;
     map?: FtMap;
     toc?: FtReaderTocNode[];
@@ -22,11 +25,13 @@ export declare class FtReaderContext extends FtLitElementRedux implements FtRead
     currentPage?: FtReaderPage;
     scrollTarget?: FtReaderScrollTarget;
     readerServiceProvider?: () => Promise<FtReaderService>;
+    tocFilteringContext?: FtSearchContext;
     constructor();
     protected render(): import("lit-html").TemplateResult<1>;
     private importStyleIfNeeded;
     private _stateManager?;
     get stateManager(): FtReaderStateManager;
+    private get filters();
     connectedCallback(): void;
     disconnectedCallback(): void;
     updateConfiguration: () => void;

package/build/ft-reader-context.js

@@ -5,12 +5,13 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { html, nothing, } from "lit";
-import { property } from "lit/decorators.js";
-import { Debouncer, FtLitElementRedux, numberProperty, randomId, redux, } from "@fluid-topics/ft-wc-utils";
+import { property, query, } from "lit/decorators.js";
+import { Debouncer, FtLitElementRedux, jsonPropertyConverter, numberProperty, randomId, redux, } from "@fluid-topics/ft-wc-utils";
 import { FtReaderStateManager } from "./store/FtReaderStateManager";
 import { styles } from "./ft-reader-context.styles";
 import { AuthenticationChangeEvent, ftAppInfoStore, userAssetsActions, } from "@fluid-topics/ft-app-context";
 import { ForbiddenErrorEvent, LoadErrorEvent, MapLoadedEvent, NavigationDoneEvent, NotFoundErrorEvent, TopicRelativeNotFoundEvent, UnauthorizedErrorEvent, VisibleTopicsChangeEvent, } from "./models";
+import { FtSearchContext } from "@fluid-topics/ft-search-context";
 class FluidTopicsReaderServiceImpl {
     constructor(stateManager) {
         this.stateManager = stateManager;
@@ -22,6 +23,7 @@ class FluidTopicsReaderServiceImpl {
 export class FtReaderContext extends FtLitElementRedux {
     constructor() {
         super();
+        this.metadataFilters = [];
         this.visibleTopics = [];
         this.updateConfiguration = () => {
             this.stateManager.reloadConfiguration();
@@ -34,7 +36,18 @@ export class FtReaderContext extends FtLitElementRedux {
     render() {
         return html `
             ${this.importStyleIfNeeded()}
-            <slot @register-ft-reader-component=${this.registerComponent}></slot>
+            <ft-toc-filtering-search-context
+                registrationId="reader-toc-filtering"
+                .filters=${this.filters}
+                @ft-search-request-change=${(e) => {
+            var _a;
+            if (e.target === this.tocFilteringContext) {
+                this.stateManager.setFilters((_a = e.detail.metadataFilters.filter((m) => m.key != "ft:publicationId")) !== null && _a !== void 0 ? _a : []);
+            }
+        }} }
+            >
+                <slot @register-ft-reader-component=${this.registerComponent}></slot>
+            </ft-toc-filtering-search-context>
         `;
     }
     importStyleIfNeeded() {
@@ -57,6 +70,18 @@ export class FtReaderContext extends FtLitElementRedux {
         }
         return this._stateManager;
     }
+    get filters() {
+        return [
+            {
+                key: "ft:publicationId",
+                valueFilter: {
+                    negative: false,
+                    values: [this.mapId],
+                },
+            },
+            ...this.metadataFilters,
+        ];
+    }
     connectedCallback() {
         super.connectedCallback();
         this.stateManager.setMapId(this.mapId);
@@ -77,6 +102,7 @@ export class FtReaderContext extends FtLitElementRedux {
         ftAppInfoStore.addEventListener(AuthenticationChangeEvent.eventName, this.updateConfiguration);
     }
     update(props) {
+        var _a;
         super.update(props);
         if (props.has("readerServiceProvider") && this.readerServiceProvider) {
             this.stateManager.initService(this.readerServiceProvider);
@@ -88,12 +114,22 @@ export class FtReaderContext extends FtLitElementRedux {
         if (props.has("searchInDocumentQuery") && this.searchInDocumentQuery != null) {
             this.stateManager.setSearchInDocumentQuery(this.searchInDocumentQuery);
         }
-        if (["tocId", "section", "page", "mapId", "topicPivot"].some((p) => props.has(p)) && this.mapId) {
-            this.navigateToTarget();
+        // metadataFilters is never set to undefined, props.get("metadatFilters") is only undefined at the 1st lit lifecycle, for the [] default value init - we do not want to take it as a filter change
+        const filtersChanged = props.has("metadataFilters") && props.get("metadataFilters") != undefined;
+        if (filtersChanged) {
+            this.stateManager.setFilters((_a = this.metadataFilters) !== null && _a !== void 0 ? _a : []);
         }
+        // reload() re-navigates to the current target once the filtered data is loaded,
+        // so it must not race with a direct navigateToTarget() call from this same update.
         if (props.has("session")) {
             this.reload();
         }
+        else if (filtersChanged) {
+            this.stateManager.reloadFromFilter(this.section, this.page);
+        }
+        else if (["tocId", "section", "page", "mapId", "topicPivot"].some((p) => props.has(p)) && this.mapId) {
+            this.navigateToTarget();
+        }
     }
     contentAvailableCallback(props) {
         var _a, _b;
@@ -194,6 +230,9 @@ export class FtReaderContext extends FtLitElementRedux {
         });
     }
 }
+FtReaderContext.elementDefinitions = {
+    "ft-toc-filtering-search-context": FtSearchContext,
+};
 // language=CSS
 FtReaderContext.styles = styles;
 __decorate([
@@ -217,6 +256,9 @@ __decorate([
 __decorate([
     property()
 ], FtReaderContext.prototype, "searchInDocumentQuery", void 0);
+__decorate([
+    redux({ store: "reader", converter: jsonPropertyConverter([]), attribute: true })
+], FtReaderContext.prototype, "metadataFilters", void 0);
 __decorate([
     numberProperty({ min: 1 })
 ], FtReaderContext.prototype, "page", void 0);
@@ -238,3 +280,6 @@ __decorate([
 __decorate([
     property({ attribute: false })
 ], FtReaderContext.prototype, "readerServiceProvider", void 0);
+__decorate([
+    query("ft-toc-filtering-search-context")
+], FtReaderContext.prototype, "tocFilteringContext", void 0);