@fluid-topics/ft-viewer 2.1.19 → 2.1.21

package/build/ud/components/ft-viewer-feedback.js

@@ -0,0 +1,6 @@
+import { FtBaseFeedback } from "@fluid-topics/ft-reader-feedback/build/ft-base-feedback";
+import { generateFeedbackStyles } from "@fluid-topics/ft-reader-feedback/build/ft-base-feedback.styles";
+import { FtViewerFeedbackCssVariables } from "./ft-ud-viewer-feedback.styles";
+export class FtViewerFeedback extends FtBaseFeedback {
+}
+FtViewerFeedback.styles = generateFeedbackStyles(FtViewerFeedbackCssVariables);

package/build/ud/components/registration.d.ts

@@ -11,6 +11,7 @@ export interface FtUdViewerComponentInterface extends FtViewerComponent {
     viewerStateManager?: FtUdViewerStateManager;
     neededUdvRequests: FtUdViewerResourceRequests[];
     service?: FtUdViewerService;
+    setUdvStateManager(stateManager: FtUdViewerStateManager): void;
 }
 export type FtUdViewerComponentType<T extends Constructor<FtLitElementRedux>> = T & Constructor<FtUdViewerComponentInterface>;
 export declare const toFtUdViewerComponent: <T extends Constructor<FtLitElementRedux>>(c: T) => FtUdViewerComponentType<T>;

package/build/ud/components/registration.js

@@ -30,6 +30,17 @@ export const toFtUdViewerComponent = applyMixinOnce(Symbol("toFtUdViewerComponen
                 (_c = this.viewerStateManager) === null || _c === void 0 ? void 0 : _c.registerComponent(this, this.neededUdvRequests);
             }
         }
+        setUdvStateManager(stateManager) {
+            this.clearStateManager();
+            this.viewerStateManager = stateManager;
+            this.addStore(stateManager.store, "viewer");
+        }
+        clearStateManager() {
+            if (this.viewerStateManager) {
+                this.removeStore("viewer");
+                this.viewerStateManager = undefined;
+            }
+        }
         registerToUdvStateManager(stateManager) {
             if (stateManager) {
                 stateManager.registerComponent(this, this.neededUdvRequests);

package/build/ud/ft-ud-viewer-context.d.ts

@@ -10,4 +10,5 @@ export declare class FtUdViewerContext extends FtLitElementRedux implements FtUd
     private initStateManager;
     connectedCallback(): void;
     onAuthenticationChange(): void;
+    private reactToUiLocaleChanged;
 }

package/build/ud/ft-ud-viewer-context.js

@@ -10,8 +10,8 @@ import { provide } from "@lit/context";
 import { FtLitElementRedux, randomId, reduxEventListener, } from "@fluid-topics/ft-wc-utils";
 import { FtUdViewerStateManager } from "./model/FtUdViewerStateManager";
 import { udViewerStateManagerContext } from "./components/registration";
-import { AuthenticationChangeEvent, ftAppInfoStore, } from "@fluid-topics/ft-app-context";
-import { FtViewerLoadedEvent } from "../common";
+import { AuthenticationChangeEvent, ftAppInfoStore, ftAppStateManager, UiLocaleChangedEvent, } from "@fluid-topics/ft-app-context";
+import { FtViewerLoadedEvent, } from "../common";
 export class FtUdViewerContext extends FtLitElementRedux {
     constructor() {
         super(...arguments);
@@ -41,6 +41,19 @@ export class FtUdViewerContext extends FtLitElementRedux {
     onAuthenticationChange() {
         this.viewerStateManager.reload();
     }
+    async reactToUiLocaleChanged(e) {
+        var _a;
+        if ((_a = ftAppInfoStore.getState().localesConfiguration) === null || _a === void 0 ? void 0 : _a.uiLanguageSetsReaderLanguage) {
+            ftAppStateManager === null || ftAppStateManager === void 0 ? void 0 : ftAppStateManager.stopReloadDebouncer();
+            const targetUrl = await this.viewerStateManager.getRelativeDocumentUrlForLocale(e.detail.uiLocale);
+            if (targetUrl) {
+                window.location.assign(targetUrl); // This call will also refresh the page
+            }
+            else {
+                window.location.reload(); // Need to reload to affect UI locale
+            }
+        }
+    }
 }
 __decorate([
     property()
@@ -51,3 +64,6 @@ __decorate([
 __decorate([
     reduxEventListener({ eventName: AuthenticationChangeEvent.eventName })
 ], FtUdViewerContext.prototype, "onAuthenticationChange", null);
+__decorate([
+    reduxEventListener({ store: ftAppInfoStore.name, eventName: UiLocaleChangedEvent.eventName })
+], FtUdViewerContext.prototype, "reactToUiLocaleChanged", null);

package/build/ud/ft-ud-viewer.messages.d.ts

@@ -1,6 +1,7 @@
 import { DefaultI18nMessages, I18nMessageContext, I18nMessages } from "@fluid-topics/ft-i18n";
 export interface FtUdViewerMessages extends I18nMessages {
     download(label: string): string;
+    itemWithNoValueForSwitchToRelatives(): string;
 }
 export declare const udViewerContext: I18nMessageContext<FtUdViewerMessages>;
 export declare const defaultViewerMessages: DefaultI18nMessages<FtUdViewerMessages>;

package/build/ud/ft-ud-viewer.messages.js

@@ -2,4 +2,5 @@ import { I18nMessageContext, } from "@fluid-topics/ft-i18n";
 export const udViewerContext = I18nMessageContext.build("designedUdViewer");
 export const defaultViewerMessages = {
     download: "Download {0}",
+    itemWithNoValueForSwitchToRelatives: "No value",
 };

package/build/ud/index.d.ts

@@ -8,3 +8,7 @@ export * from "./components/ft-ud-viewer-filename";
 export * from "./components/ft-ud-viewer-title";
 export * from "./components/ft-ud-viewer-mime-type-icon";
 export * from "./components/ft-ud-viewer-attachments";
+export * from "./components/ft-ud-viewer-feedback";
+export * from "./components/ft-ud-viewer-feedback.styles";
+export * from "./components/ft-ud-viewer-metadata.properties";
+export * from "./components/ft-ud-viewer-metadata";

package/build/ud/index.js

@@ -8,3 +8,7 @@ export * from "./components/ft-ud-viewer-filename";
 export * from "./components/ft-ud-viewer-title";
 export * from "./components/ft-ud-viewer-mime-type-icon";
 export * from "./components/ft-ud-viewer-attachments";
+export * from "./components/ft-ud-viewer-feedback";
+export * from "./components/ft-ud-viewer-feedback.styles";
+export * from "./components/ft-ud-viewer-metadata.properties";
+export * from "./components/ft-ud-viewer-metadata";

package/build/ud/model/FtUdViewerService.d.ts

@@ -1,12 +1,19 @@
 import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
-import { FtPublicationRatingSummary, FtRatingType } from "@fluid-topics/public-api";
+import { FtPublicationRatingSummary, FtRatingType, FtRatingTypeKeys, FtViewerConfiguration, FtSearchResults } from "@fluid-topics/public-api";
+import { FtViewerFeatureAccessData, FtViewerFeatures } from "./ft-ud-viewer.models";
 export declare class FtUdViewerService extends FtServiceWithCache {
     getDocument(documentId: string): Promise<import("@fluid-topics/public-api").FtUnstructuredDocument>;
     getAttachments(documentId: string): Promise<import("@fluid-topics/public-api").FtDocumentAttachment[]>;
     getAttachmentDownloadLink(documentId: string, id: string): string;
     makeAbsolute(endpoint: string): string;
+    awaitMakeAbsolute(endpoint: string): Promise<string>;
     getDocumentRating(documentId: string): Promise<FtPublicationRatingSummary | undefined>;
-    rateDocument(documentId: string, type: FtRatingType, value: number): Promise<void>;
+    rateDocument(documentId: string, type: FtRatingType | FtRatingTypeKeys, value: number): Promise<void>;
     unrateDocument(documentId: string): Promise<void>;
-    sendDocumentFeedback(documentId: string, message: string): Promise<void>;
+    sendDocumentFeedback(documentId: string, message: string, from?: string): Promise<void>;
+    isFeatureAccessible(feature: FtViewerFeatures, { session }: FtViewerFeatureAccessData): boolean;
+    getConfiguration(): Promise<FtViewerConfiguration>;
+    clearConfiguration(): void;
+    private fetchRelativesForDocument;
+    getRelativesForDocument(metadataPivotKey: string, metadataPivotValues: string[]): Promise<FtSearchResults>;
 }

package/build/ud/model/FtUdViewerService.js

@@ -1,4 +1,6 @@
 import { FtServiceWithCache } from "@fluid-topics/ft-app-context";
+import { FtUserRole, userHasRole, } from "@fluid-topics/public-api";
+import { FtViewerFeatures, } from "./ft-ud-viewer.models";
 export class FtUdViewerService extends FtServiceWithCache {
     getDocument(documentId) {
         return this.cache.get(documentId, () => this.api.getUnstructuredDocument(documentId));
@@ -12,13 +14,57 @@ export class FtUdViewerService extends FtServiceWithCache {
     makeAbsolute(endpoint) {
         return this.api.makeAbsolute(endpoint);
     }
+    async awaitMakeAbsolute(endpoint) {
+        return (await this.awaitApi).makeAbsolute(endpoint);
+    }
     async getDocumentRating(documentId) {
-        return undefined;
+        return (await this.api.getDocumentRating(documentId)).publication;
     }
     async rateDocument(documentId, type, value) {
+        return this.api.rateDocument(documentId, type, value);
     }
     async unrateDocument(documentId) {
+        return this.api.unrateDocument(documentId);
+    }
+    async sendDocumentFeedback(documentId, message, from) {
+        return this.api.sendDocumentFeedback(documentId, message, from);
+    }
+    isFeatureAccessible(feature, { session }) {
+        switch (feature) {
+            case FtViewerFeatures.FEEDBACK:
+                return userHasRole(session !== null && session !== void 0 ? session : [], FtUserRole.FEEDBACK_USER);
+            case FtViewerFeatures.RATING:
+                return userHasRole(session !== null && session !== void 0 ? session : [], FtUserRole.RATING_USER);
+            default:
+                return false;
+        }
+    }
+    getConfiguration() {
+        return this.cache.get("configuration", () => this.api.getViewerConfiguration());
+    }
+    clearConfiguration() {
+        this.cache.clear("configuration");
+    }
+    fetchRelativesForDocument(metadataPivotKey, metadataPivotValues) {
+        const request = {
+            query: "",
+            paging: { page: 1, perPage: -1 },
+            scope: "DOCUMENTS",
+            metadataFilters: [
+                {
+                    key: metadataPivotKey,
+                    valueFilter: {
+                        negative: false,
+                        values: metadataPivotValues,
+                    },
+                },
+            ],
+            sort: [],
+            facets: [],
+        };
+        return this.api.search(request);
     }
-    async sendDocumentFeedback(documentId, message) {
+    getRelativesForDocument(metadataPivotKey, metadataPivotValues) {
+        return this.cache.get("document-relatives-" + metadataPivotKey + "-" + metadataPivotValues.join("-"), () => this.fetchRelativesForDocument(metadataPivotKey, metadataPivotValues));
     }
 }

package/build/ud/model/FtUdViewerStateManager.d.ts

@@ -1,13 +1,28 @@
 import { FtViewerReduxStore } from "../../common/model/FtViewerReduxStore";
 import { FtViewerStateManager } from "../../common/model/FtViewerStateManager";
 import { FtUdViewerService } from "./FtUdViewerService";
+import { ClusteringHelper } from "@fluid-topics/ft-wc-utils";
 export declare class FtUdViewerStateManager extends FtViewerStateManager {
     store: FtViewerReduxStore;
     service: FtUdViewerService;
+    private clusteringHelperProvider?;
     static build(viewerId: string): FtUdViewerStateManager;
-    constructor(store: FtViewerReduxStore, service: FtUdViewerService);
+    metadataForSwitchToRelatives: Set<string>;
+    clusteringHelper?: ClusteringHelper;
+    constructor(store: FtViewerReduxStore, service: FtUdViewerService, clusteringHelperProvider?: (() => ClusteringHelper) | undefined);
     load(): Promise<import("../..").FtViewerState>;
+    fetchMapRating(): Promise<void>;
     clear(): void;
     reload(): Promise<import("../..").FtViewerState>;
     setDocumentId(documentId: string | undefined): Promise<import("../..").FtViewerState>;
+    loadConfiguration(): Promise<{
+        payload: import("@fluid-topics/public-api").FtViewerConfiguration | undefined;
+        type: `${string}/configuration`;
+    }>;
+    private fetchRelatives;
+    private updateClusteringHelper;
+    private createClusteringHelper;
+    registerMetadataForSwitchToRelatives(id: string): void;
+    unregisterMetadataForSwitchToRelatives(id: string): void;
+    getRelativeDocumentUrlForLocale(uiLocale: string): Promise<string | undefined>;
 }

package/build/ud/model/FtUdViewerStateManager.js

@@ -3,22 +3,29 @@ import { createViewerStore, } from "../../common/model/FtViewerReduxStore";
 import { FtViewerStateManager } from "../../common/model/FtViewerStateManager";
 import { FtUdViewerService } from "./FtUdViewerService";
 import { FtAssetHolderType } from "@fluid-topics/public-api";
-import { FluidTopicsApiProvider } from "@fluid-topics/ft-app-context";
+import { ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { accessResultId, accessResultUrl, ClusteringHelper } from "@fluid-topics/ft-wc-utils";
+import { FtUdViewerStoreEvents } from "./ft-ud-viewer.models";
 export class FtUdViewerStateManager extends FtViewerStateManager {
     static build(viewerId) {
         return new FtUdViewerStateManager(createViewerStore(viewerId), new FtUdViewerService());
     }
-    constructor(store, service) {
+    constructor(store, service, clusteringHelperProvider) {
         super(store);
         this.store = store;
         this.service = service;
+        this.clusteringHelperProvider = clusteringHelperProvider;
+        this.metadataForSwitchToRelatives = new Set();
         store.actions.origin(FtViewerFileOrigin.UNSTRUCTURED_DOCUMENT);
     }
     async load() {
         var _a, _b;
         const { documentId } = this.store.getState();
         if (documentId) {
-            const document = await this.service.getDocument(documentId);
+            const [document] = await Promise.all([
+                this.service.getDocument(documentId),
+                this.loadConfiguration(),
+            ]);
             this.store.actions.unstructuredDocument(document);
             this.store.actions.document({
                 type: FtAssetHolderType.UNSTRUCTURED_DOCUMENT,
@@ -28,7 +35,7 @@ export class FtUdViewerStateManager extends FtViewerStateManager {
                 metadata: document.metadata,
                 portalUrl: document.viewerUrl,
             });
-            const api = await FluidTopicsApiProvider.await();
+            const contentUrl = await this.service.awaitMakeAbsolute(document.contentApiEndpoint);
             this.store.actions.descriptor({
                 id: document.id,
                 portalUrl: document.viewerUrl,
@@ -39,21 +46,88 @@ export class FtUdViewerStateManager extends FtViewerStateManager {
                 mimeType: document.mimeType,
                 size: 0,
                 viewableInCurrentBrowser: document.viewableInCurrentBrowser,
-                contentUrl: api.makeAbsolute(document.contentApiEndpoint),
+                contentUrl,
             });
             this.store.actions.watermark(document.watermark);
+            this.fetchMapRating();
+            if (this.metadataForSwitchToRelatives.size > 0) {
+                this.fetchRelatives();
+            }
         }
         return this.store.getState();
     }
+    async fetchMapRating() {
+        var _a;
+        const { documentId } = this.store.getState();
+        if (documentId) {
+            this.store.actions.documentRating(await ((_a = this.service) === null || _a === void 0 ? void 0 : _a.getDocumentRating(documentId)));
+        }
+    }
     clear() {
         this.store.clearKeeping("documentId", "origin");
     }
     reload() {
+        var _a;
         this.clear();
+        (_a = this.service) === null || _a === void 0 ? void 0 : _a.clearConfiguration();
         return this.load();
     }
     setDocumentId(documentId) {
         this.store.actions.documentId(documentId);
         return this.reload();
     }
+    async loadConfiguration() {
+        var _a;
+        return (_a = this.service) === null || _a === void 0 ? void 0 : _a.getConfiguration().then((conf) => this.store.actions.configuration(conf));
+    }
+    async fetchRelatives() {
+        var _a, _b;
+        const relativeMetadataValues = (_a = this.store.getState().document) === 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) {
+            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();
+        if (this.clusteringHelper) {
+            this.store.dispatchEvent(new Event(FtUdViewerStoreEvents.clusteringHelperCreated));
+        }
+    }
+    createClusteringHelper() {
+        var _a, _b;
+        if (this.clusteringHelperProvider) {
+            return this.clusteringHelperProvider();
+        }
+        const relatives = this.store.getState().relatives;
+        if (relatives) {
+            const selectedResult = relatives.find((relative) => accessResultId(relative) == this.store.getState().documentId);
+            const metadataDescriptors = (_b = (_a = ftAppInfoStore.getState().metadataConfiguration) === null || _a === void 0 ? void 0 : _a.descriptors) !== null && _b !== void 0 ? _b : [];
+            return new ClusteringHelper(relatives, selectedResult, this.metadataForSwitchToRelatives, metadataDescriptors);
+        }
+        return undefined;
+    }
+    registerMetadataForSwitchToRelatives(id) {
+        this.metadataForSwitchToRelatives.add(id);
+        if (this.store.getState().relatives == undefined) {
+            this.fetchRelatives();
+        }
+        else {
+            this.updateClusteringHelper();
+        }
+    }
+    unregisterMetadataForSwitchToRelatives(id) {
+        this.metadataForSwitchToRelatives.delete(id);
+        this.updateClusteringHelper();
+    }
+    async getRelativeDocumentUrlForLocale(uiLocale) {
+        var _a;
+        if (this.store.getState().relatives == undefined) {
+            await this.fetchRelatives();
+        }
+        const maybeRelativeResult = ClusteringHelper.findResultWithMetadataValue((_a = this.store.getState().relatives) !== null && _a !== void 0 ? _a : [], "ft:locale", uiLocale);
+        return accessResultUrl(maybeRelativeResult);
+    }
 }

package/build/ud/model/ft-ud-viewer.models.d.ts

@@ -1,6 +1,16 @@
+import { FtSession } from "@fluid-topics/public-api";
 export declare enum FtUdViewerResourceRequests {
     RATING = "RATING"
 }
 export declare enum FtUdViewerStoreEvents {
-    udAttachmentsUpdate = "ud-attachments-update"
+    udAttachmentsUpdate = "ud-attachments-update",
+    udRatingUpdate = "ud-rating-update",
+    clusteringHelperCreated = "clustering-helper-created"
+}
+export declare enum FtViewerFeatures {
+    FEEDBACK = "FEEDBACK",
+    RATING = "RATING"
+}
+export interface FtViewerFeatureAccessData {
+    session?: FtSession;
 }

package/build/ud/model/ft-ud-viewer.models.js

@@ -5,4 +5,11 @@ export var FtUdViewerResourceRequests;
 export var FtUdViewerStoreEvents;
 (function (FtUdViewerStoreEvents) {
     FtUdViewerStoreEvents["udAttachmentsUpdate"] = "ud-attachments-update";
+    FtUdViewerStoreEvents["udRatingUpdate"] = "ud-rating-update";
+    FtUdViewerStoreEvents["clusteringHelperCreated"] = "clustering-helper-created";
 })(FtUdViewerStoreEvents || (FtUdViewerStoreEvents = {}));
+export var FtViewerFeatures;
+(function (FtViewerFeatures) {
+    FtViewerFeatures["FEEDBACK"] = "FEEDBACK";
+    FtViewerFeatures["RATING"] = "RATING";
+})(FtViewerFeatures || (FtViewerFeatures = {}));

package/build/utils/events.d.ts

@@ -0,0 +1,14 @@
+import { FtPublicationRating, FtRatingTypeKeys } from "@fluid-topics/public-api";
+interface OpenUdFeedbackDrawerEventDetail {
+    documentId: string;
+    documentTitle: string;
+    ratingType: FtRatingTypeKeys;
+    ratingValue: FtPublicationRating | undefined;
+}
+export declare class OpenUdFeedbackDrawerEvent extends CustomEvent<OpenUdFeedbackDrawerEventDetail> {
+    constructor(detail: OpenUdFeedbackDrawerEventDetail);
+}
+export declare class SendMailerUdFeedbackEvent extends CustomEvent<any> {
+    constructor();
+}
+export {};

package/build/utils/events.js

@@ -0,0 +1,17 @@
+export class OpenUdFeedbackDrawerEvent extends CustomEvent {
+    constructor(detail) {
+        super("ft-ud-viewer-feedback", {
+            composed: true,
+            bubbles: true,
+            detail,
+        });
+    }
+}
+export class SendMailerUdFeedbackEvent extends CustomEvent {
+    constructor() {
+        super("ft-viewer-mailer-ud-feedback", {
+            composed: true,
+            bubbles: true,
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-viewer",
-    "version": "2.1.19",
+    "version": "2.1.21",
     "description": "File viewer components",
     "keywords": [
         "Lit"
@@ -19,16 +19,18 @@
         "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
     },
     "dependencies": {
-        "@fluid-topics/ft-content-watermark": "2.1.19",
-        "@fluid-topics/ft-i18n": "2.1.19",
-        "@fluid-topics/ft-reader-attachments": "2.1.19",
-        "@fluid-topics/ft-wc-utils": "2.1.19",
-        "@fluid-topics/public-api": "1.0.133",
+        "@fluid-topics/ft-content-watermark": "2.1.21",
+        "@fluid-topics/ft-i18n": "2.1.21",
+        "@fluid-topics/ft-reader-attachments": "2.1.21",
+        "@fluid-topics/ft-reader-feedback": "2.1.21",
+        "@fluid-topics/ft-search-result-context": "2.1.21",
+        "@fluid-topics/ft-wc-utils": "2.1.21",
+        "@fluid-topics/public-api": "1.0.136",
         "@lit/context": "1.1.6",
         "lit": "3.1.0"
     },
     "devDependencies": {
-        "@fluid-topics/ft-wc-test-utils": "2.1.19"
+        "@fluid-topics/ft-wc-test-utils": "2.1.21"
     },
-    "gitHead": "c2c202986d05fbee1378d8dbb74fa609e89260ec"
+    "gitHead": "a0f619df74c0665183d73df09e75b1eddc2a2a1f"
 }