@fluid-topics/ft-reader-feedback 1.3.12 → 1.3.13

package/build/ft-reader-map-feedback.d.ts

@@ -6,9 +6,11 @@ import { FeedbackI18nProperties, FtReaderFeedback } from "./ft-reader-feedback";
 import { FtMap, FtPublicationRatingSummary, FtReaderFeedbackConfiguration, FtSession } from "@fluid-topics/public-api";
 import { FtIconVariants } from "@fluid-topics/ft-icon";
 import { FeedbackMailLinkBuilder } from "./utils/mail";
+import { GuestLocalStorage } from "@fluid-topics/ft-app-context";
 import { SendFeedbackEvent } from "./utils/events";
 declare const FtReaderMapFeedback_base: typeof FtReaderComponent & import("@fluid-topics/ft-wc-utils").Constructor<import("@fluid-topics/ft-i18n").FtLitElementWithI18nInterface>;
 export declare class FtReaderMapFeedback extends FtReaderMapFeedback_base implements FtReaderFeedbackProperties {
+    private readonly guestStorage;
     static elementDefinitions: ElementDefinitionsMap;
     session?: FtSession;
     map?: FtMap;
@@ -28,10 +30,14 @@ export declare class FtReaderMapFeedback extends FtReaderMapFeedback_base implem
     feedbackLinkBuilder: FeedbackMailLinkBuilder;
     mailSubject: string;
     i18nProperties: FeedbackI18nProperties;
-    constructor();
+    private static storedRatingIfAuthenticated;
+    constructor(guestStorage?: GuestLocalStorage<FtPublicationRatingSummary>);
     protected render(): import("lit-html").TemplateResult<1>;
     protected willUpdate(props: PropertyValues): void;
     connectedCallback(): void;
+    disconnectedCallback(): void;
+    private readonly loadGuestRating;
+    private readonly guestRatingKey;
     protected fetchRatingSummary(): Promise<void>;
     protected sendRatingDebouncer: Debouncer;
     protected rate(ratingEvent: CustomEvent<number | undefined>): void;

package/build/ft-reader-map-feedback.js

@@ -12,15 +12,16 @@ import { FtReaderFeedback } from "./ft-reader-feedback";
 import { FtRatingType } from "@fluid-topics/public-api";
 import { FtIconVariants } from "@fluid-topics/ft-icon";
 import { FeedbackMailLinkBuilder } from "./utils/mail";
-import { ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { ftAppInfoStore, GuestLocalStorage } from "@fluid-topics/ft-app-context";
 import { server } from "./utils/ServerMessages";
 import { feedback } from "./utils/IntegratedFeedbackComponentMessages";
 import { i18n, withI18n } from "@fluid-topics/ft-i18n";
 import { defaultDesignerMessages, designer } from "./utils/InDesignerFeedbackComponentMessages";
 import { OpenMapFeedbackDrawerEvent, SendMailerMapFeedbackEvent } from "./utils/events";
 class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
-    constructor() {
+    constructor(guestStorage = new GuestLocalStorage()) {
         super();
+        this.guestStorage = guestStorage;
         this.editorMode = false;
         this.hideTitle = false;
         this.withMoreOptionsButton = false;
@@ -38,6 +39,16 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
             dichotomousRatingSectionTitle: feedback.properties.mapDichotomousRatingSectionTitle(),
             feedbackSectionTitle: feedback.properties.mapFeedbackSectionTitle(),
         };
+        this.loadGuestRating = () => {
+            const guestRating = this.guestStorage.get(this.guestRatingKey());
+            if (guestRating) {
+                this.ratingSummary = guestRating;
+            }
+        };
+        this.guestRatingKey = () => {
+            var _a;
+            return "ft-reader-map-feedback-guest-rating-" + ((_a = this.map) === null || _a === void 0 ? void 0 : _a.id);
+        };
         this.sendRatingDebouncer = new Debouncer(500);
         this.addStore(ftAppInfoStore);
     }
@@ -60,9 +71,9 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
                 .filledDislikeIcon=${this.filledDislikeIcon}
                 .feedbackMailLinkBuilder=${(feedbackMessage) => this.feedbackLinkBuilder.build(feedbackMessage)}
                 @rate=${this.rate}
-                @send-feedback=${this.sendFeedback}
-                @mailer-feedback=${this.onMailerFeedbackSent}
-                @open-more-options=${this.openMoreOptions}
+                @send-feedback="${this.sendFeedback}"
+                @mailer-feedback="${this.onMailerFeedbackSent}"
+                @open-more-options="${this.openMoreOptions}"
             ></ft-reader-feedback>
         `;
     }
@@ -75,12 +86,20 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
         if (props.has("editorMode") && this.editorMode) {
             this.addI18nContext(designer, defaultDesignerMessages);
         }
-        if (["map", "configuration", "user", "mailSubject"].some(p => props.has(p)) && this.map && this.configuration) {
+        if (["map", "configuration", "user", "mailSubject"].some((p) => props.has(p)) && this.map && this.configuration) {
             this.feedbackLinkBuilder.update(this.mailSubject, (_c = (_b = this.service) === null || _b === void 0 ? void 0 : _b.getLink()) !== null && _c !== void 0 ? _c : "", this.map.metadata, this.configuration, ((_e = (_d = this.session) === null || _d === void 0 ? void 0 : _d.profile) === null || _e === void 0 ? void 0 : _e.userId) != null);
         }
+        if (["session", "map"].some((p) => props.has(p)) && this.session && this.map) {
+            this.loadGuestRating();
+        }
     }
     connectedCallback() {
         super.connectedCallback();
+        this.guestStorage.addStoreListener(this.guestRatingKey, this.loadGuestRating);
+    }
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.guestStorage.clearStoreListeners();
     }
     // Used in GWT
     async fetchRatingSummary() {
@@ -94,9 +113,10 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
                 rating: ratingEvent.detail == null ? undefined : {
                     type: this.ratingSummary.type,
                     value: ratingEvent.detail,
-                    date: new Date()
-                }
+                    date: new Date(),
+                },
             };
+            this.guestStorage.store(this.guestRatingKey(), this.ratingSummary);
             this.sendRatingDebouncer.run(() => this.sendRating(ratingEvent.detail));
         }
     }
@@ -114,7 +134,7 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
             catch {
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "error",
-                    message: feedback.messages.ratingFailure()
+                    message: feedback.messages.ratingFailure(),
                 }));
             }
             await ((_d = this.stateManager) === null || _d === void 0 ? void 0 : _d.fetchMapRating());
@@ -122,7 +142,7 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
         else if (this.editorMode) {
             this.dispatchEvent(new FtNotificationEvent({
                 type: "info",
-                message: designer.messages.feedbackAndRatingDisabledInEditor()
+                message: designer.messages.feedbackAndRatingDisabledInEditor(),
             }));
         }
     }
@@ -133,13 +153,13 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
                 await ((_a = this.service) === null || _a === void 0 ? void 0 : _a.sendMapFeedback(ratingEvent.detail.message, ratingEvent.detail.from));
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "info",
-                    message: feedback.messages.feedbackSuccess()
+                    message: feedback.messages.feedbackSuccess(),
                 }));
             }
             else {
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "info",
-                    message: designer.messages.feedbackAndRatingDisabledInEditor()
+                    message: designer.messages.feedbackAndRatingDisabledInEditor(),
                 }));
             }
             this.readerFeedback.clearFeedbackInput();
@@ -147,7 +167,7 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
         catch {
             this.dispatchEvent(new FtNotificationEvent({
                 type: "error",
-                message: feedback.messages.feedbackFailure()
+                message: feedback.messages.feedbackFailure(),
             }));
         }
     }
@@ -161,12 +181,19 @@ class FtReaderMapFeedback extends withI18n(FtReaderComponent) {
             mapTitle: this.map.title,
             mapMetadata: ((_a = this.map) === null || _a === void 0 ? void 0 : _a.metadata) || [],
             ratingType: ((_b = this.ratingSummary) === null || _b === void 0 ? void 0 : _b.type) || FtRatingType.NO_RATING,
-            ratingValue: (_c = this.ratingSummary) === null || _c === void 0 ? void 0 : _c.rating
+            ratingValue: (_c = this.ratingSummary) === null || _c === void 0 ? void 0 : _c.rating,
         }));
     }
 }
 FtReaderMapFeedback.elementDefinitions = {
-    "ft-reader-feedback": FtReaderFeedback
+    "ft-reader-feedback": FtReaderFeedback,
+};
+FtReaderMapFeedback.storedRatingIfAuthenticated = (state, self) => {
+    var _a, _b;
+    if ((_a = self.session) === null || _a === void 0 ? void 0 : _a.sessionAuthenticated) {
+        return state.mapRating;
+    }
+    return (_b = self.ratingSummary) !== null && _b !== void 0 ? _b : state.mapRating;
 };
 __decorate([
     redux({ store: ftAppInfoStore.name })
@@ -180,13 +207,13 @@ __decorate([
 __decorate([
     redux({
         store: "reader",
-        selector: (state) => { var _a; return (_a = state.configuration) === null || _a === void 0 ? void 0 : _a.feedback; }
+        selector: (state) => { var _a; return (_a = state.configuration) === null || _a === void 0 ? void 0 : _a.feedback; },
     })
 ], FtReaderMapFeedback.prototype, "configuration", void 0);
 __decorate([
     redux({
         store: "reader",
-        selector: (state) => state.mapRating
+        selector: FtReaderMapFeedback.storedRatingIfAuthenticated,
     })
 ], FtReaderMapFeedback.prototype, "ratingSummary", void 0);
 __decorate([

package/build/ft-reader-topic-feedback.d.ts

@@ -3,14 +3,15 @@ import { Debouncer, ElementDefinitionsMap } from "@fluid-topics/ft-wc-utils";
 import { FtReaderFeedbackProperties } from "./ft-reader-feedback.properties";
 import { FeedbackI18nProperties, FtReaderFeedback } from "./ft-reader-feedback";
 import { FtReaderTopicComponent } from "@fluid-topics/ft-reader-topic-context/build/registration";
-import type { FtMap, FtSession } from "@fluid-topics/public-api";
-import { FtReaderFeedbackConfiguration } from "@fluid-topics/public-api";
+import { FtMap, FtReaderFeedbackConfiguration, FtSession } from "@fluid-topics/public-api";
 import { FtTopicRatingSummary } from "@fluid-topics/ft-reader-context/build/store/model";
 import { FtIconVariants } from "@fluid-topics/ft-icon";
 import { FeedbackMailLinkBuilder } from "./utils/mail";
+import { GuestLocalStorage } from "@fluid-topics/ft-app-context";
 import { SendFeedbackEvent } from "./utils/events";
 declare const FtReaderTopicFeedback_base: typeof FtReaderTopicComponent & import("@fluid-topics/ft-wc-utils").Constructor<import("@fluid-topics/ft-i18n").FtLitElementWithI18nInterface>;
 export declare class FtReaderTopicFeedback extends FtReaderTopicFeedback_base implements FtReaderFeedbackProperties {
+    private readonly guestStorage;
     static elementDefinitions: ElementDefinitionsMap;
     session?: FtSession;
     map?: FtMap;
@@ -30,10 +31,14 @@ export declare class FtReaderTopicFeedback extends FtReaderTopicFeedback_base im
     feedbackLinkBuilder: FeedbackMailLinkBuilder;
     mailSubject: string;
     i18nProperties: FeedbackI18nProperties;
-    constructor();
+    private static storedRatingIfAuthenticated;
+    constructor(guestStorage?: GuestLocalStorage<FtTopicRatingSummary>);
     protected render(): import("lit-html").TemplateResult<1>;
     protected willUpdate(props: PropertyValues): void;
     connectedCallback(): void;
+    disconnectedCallback(): void;
+    private readonly loadGuestRating;
+    private readonly guestRatingKey;
     protected fetchRatingSummary(): Promise<void>;
     protected sendRatingDebouncer: Debouncer;
     protected rate(ratingEvent: CustomEvent<number | undefined>): void;

package/build/ft-reader-topic-feedback.js

@@ -12,15 +12,16 @@ import { FtReaderTopicComponent } from "@fluid-topics/ft-reader-topic-context/bu
 import { FtRatingType } from "@fluid-topics/public-api";
 import { FtIconVariants } from "@fluid-topics/ft-icon";
 import { FeedbackMailLinkBuilder } from "./utils/mail";
-import { ftAppInfoStore } from "@fluid-topics/ft-app-context";
+import { ftAppInfoStore, GuestLocalStorage } from "@fluid-topics/ft-app-context";
 import { feedback } from "./utils/IntegratedFeedbackComponentMessages";
 import { server } from "./utils/ServerMessages";
 import { i18n, withI18n } from "@fluid-topics/ft-i18n";
 import { defaultDesignerMessages, designer } from "./utils/InDesignerFeedbackComponentMessages";
 import { OpenTopicFeedbackDrawerEvent, SendMailerTopicFeedbackEvent } from "./utils/events";
 class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
-    constructor() {
+    constructor(guestStorage = new GuestLocalStorage()) {
         super();
+        this.guestStorage = guestStorage;
         this.editorMode = false;
         this.hideTitle = false;
         this.withMoreOptionsButton = false;
@@ -38,6 +39,16 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
             dichotomousRatingSectionTitle: feedback.properties.topicDichotomousRatingSectionTitle(),
             feedbackSectionTitle: feedback.properties.topicFeedbackSectionTitle(),
         };
+        this.loadGuestRating = () => {
+            const guestRating = this.guestStorage.get(this.guestRatingKey());
+            if (guestRating) {
+                this.ratingSummary = guestRating;
+            }
+        };
+        this.guestRatingKey = () => {
+            var _a;
+            return "ft-reader-topic-feedback-guest-rating-" + ((_a = this.tocNode) === null || _a === void 0 ? void 0 : _a.tocId);
+        };
         this.sendRatingDebouncer = new Debouncer(500);
         this.addStore(ftAppInfoStore);
     }
@@ -61,27 +72,35 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
                 .filledDislikeIcon=${this.filledDislikeIcon}
                 .feedbackMailLinkBuilder=${(feedbackMessage) => this.feedbackLinkBuilder.build(feedbackMessage)}
                 @rate=${this.rate}
-                @send-feedback=${this.sendFeedback}
-                @mailer-feedback=${this.onMailerFeedbackSent}
-                @open-more-options=${this.openMoreOptions}
+                @send-feedback="${this.sendFeedback}"
+                @mailer-feedback="${this.onMailerFeedbackSent}"
+                @open-more-options="${this.openMoreOptions}"
             ></ft-reader-feedback>
         `;
     }
     willUpdate(props) {
         var _a, _b, _c, _d, _e;
         super.willUpdate(props);
-        if (["tocNode", "user"].some(p => props.has(p)) && this.tocNode) {
+        if (["tocNode", "user"].some((p) => props.has(p)) && this.tocNode) {
             (_a = this.stateManager) === null || _a === void 0 ? void 0 : _a.fetchTopicRating(this.tocNode.tocId);
         }
         if (props.has("editorMode") && this.editorMode) {
             this.addI18nContext(designer, defaultDesignerMessages);
         }
-        if (["map", "tocNode", "configuration", "user", "mailSubject"].some(p => props.has(p)) && this.map && this.tocNode && this.configuration) {
+        if (["map", "tocNode", "configuration", "user", "mailSubject"].some((p) => props.has(p)) && this.map && this.tocNode && this.configuration) {
             this.feedbackLinkBuilder.update(this.mailSubject, (_c = (_b = this.service) === null || _b === void 0 ? void 0 : _b.getLink(this.tocNode.tocId)) !== null && _c !== void 0 ? _c : "", this.map.metadata, this.configuration, ((_e = (_d = this.session) === null || _d === void 0 ? void 0 : _d.profile) === null || _e === void 0 ? void 0 : _e.userId) != null);
         }
+        if (["session", "tocNode"].some((p) => props.has(p)) && this.session && this.tocNode) {
+            this.loadGuestRating();
+        }
     }
     connectedCallback() {
         super.connectedCallback();
+        this.guestStorage.addStoreListener(this.guestRatingKey, this.loadGuestRating);
+    }
+    disconnectedCallback() {
+        super.disconnectedCallback();
+        this.guestStorage.clearStoreListeners();
     }
     // Used in GWT
     async fetchRatingSummary() {
@@ -96,9 +115,10 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
                     tocId: this.tocNode.tocId,
                     type: this.ratingSummary.type,
                     value: ratingEvent.detail,
-                    date: new Date()
-                }
+                    date: new Date(),
+                },
             };
+            this.guestStorage.store(this.guestRatingKey(), this.ratingSummary);
             this.sendRatingDebouncer.run(() => this.sendRating(ratingEvent.detail));
         }
     }
@@ -116,7 +136,7 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
             catch {
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "error",
-                    message: feedback.messages.ratingFailure()
+                    message: feedback.messages.ratingFailure(),
                 }));
             }
             await ((_d = this.stateManager) === null || _d === void 0 ? void 0 : _d.fetchTopicRating(this.tocNode.tocId));
@@ -124,7 +144,7 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
         else if (this.editorMode) {
             this.dispatchEvent(new FtNotificationEvent({
                 type: "info",
-                message: designer.messages.feedbackAndRatingDisabledInEditor()
+                message: designer.messages.feedbackAndRatingDisabledInEditor(),
             }));
         }
     }
@@ -135,21 +155,21 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
                 await ((_a = this.service) === null || _a === void 0 ? void 0 : _a.sendTopicFeedback(this.tocNode.tocId, ratingEvent.detail.message, ratingEvent.detail.from));
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "info",
-                    message: feedback.messages.feedbackSuccess()
+                    message: feedback.messages.feedbackSuccess(),
                 }));
                 this.readerFeedback.clearFeedbackInput();
             }
             else if (this.editorMode) {
                 this.dispatchEvent(new FtNotificationEvent({
                     type: "info",
-                    message: designer.messages.feedbackAndRatingDisabledInEditor()
+                    message: designer.messages.feedbackAndRatingDisabledInEditor(),
                 }));
             }
         }
         catch {
             this.dispatchEvent(new FtNotificationEvent({
                 type: "error",
-                message: feedback.messages.feedbackFailure()
+                message: feedback.messages.feedbackFailure(),
             }));
         }
     }
@@ -168,12 +188,20 @@ class FtReaderTopicFeedback extends withI18n(FtReaderTopicComponent) {
             mapMetadata: ((_c = this.map) === null || _c === void 0 ? void 0 : _c.metadata) || [],
             breadcrumb: ((_e = (_d = this.stateManager) === null || _d === void 0 ? void 0 : _d.service) === null || _e === void 0 ? void 0 : _e.buildBreadcrumb(this.tocNode.tocId)) || [],
             ratingType: (((_f = this.tocNode) === null || _f === void 0 ? void 0 : _f.hasRating) ? (_g = this.ratingSummary) === null || _g === void 0 ? void 0 : _g.type : FtRatingType.NO_RATING) || FtRatingType.NO_RATING,
-            ratingValue: (_h = this.ratingSummary) === null || _h === void 0 ? void 0 : _h.rating
+            ratingValue: (_h = this.ratingSummary) === null || _h === void 0 ? void 0 : _h.rating,
         }));
     }
 }
 FtReaderTopicFeedback.elementDefinitions = {
-    "ft-reader-feedback": FtReaderFeedback
+    "ft-reader-feedback": FtReaderFeedback,
+};
+FtReaderTopicFeedback.storedRatingIfAuthenticated = (state, self) => {
+    var _a, _b, _c, _d;
+    const storedRating = state.topicsRating[(_b = (_a = self.tocNode) === null || _a === void 0 ? void 0 : _a.tocId) !== null && _b !== void 0 ? _b : ""];
+    if ((_c = self.session) === null || _c === void 0 ? void 0 : _c.sessionAuthenticated) {
+        return storedRating;
+    }
+    return (_d = self.ratingSummary) !== null && _d !== void 0 ? _d : storedRating;
 };
 __decorate([
     redux({ store: ftAppInfoStore.name })
@@ -187,13 +215,13 @@ __decorate([
 __decorate([
     redux({
         store: "reader",
-        selector: (state) => { var _a; return (_a = state.configuration) === null || _a === void 0 ? void 0 : _a.feedback; }
+        selector: (state) => { var _a; return (_a = state.configuration) === null || _a === void 0 ? void 0 : _a.feedback; },
     })
 ], FtReaderTopicFeedback.prototype, "configuration", void 0);
 __decorate([
     redux({
         store: "reader",
-        selector: (state, self) => { var _a, _b; return state.topicsRating[(_b = (_a = self.tocNode) === null || _a === void 0 ? void 0 : _a.tocId) !== null && _b !== void 0 ? _b : '']; }
+        selector: FtReaderTopicFeedback.storedRatingIfAuthenticated,
     })
 ], FtReaderTopicFeedback.prototype, "ratingSummary", void 0);
 __decorate([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-topics/ft-reader-feedback",
-  "version": "1.3.12",
+  "version": "1.3.13",
   "description": "Feedback forms for a map and its topics in an integrated reader",
   "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.3.12",
-    "@fluid-topics/ft-reader-context": "1.3.12",
-    "@fluid-topics/ft-wc-utils": "1.3.12",
+    "@fluid-topics/ft-app-context": "1.3.13",
+    "@fluid-topics/ft-reader-context": "1.3.13",
+    "@fluid-topics/ft-wc-utils": "1.3.13",
     "lit": "3.1.0"
   },
   "devDependencies": {
     "@fluid-topics/public-api": "1.0.100"
   },
-  "gitHead": "c0422158795c14ed01e51d1dc4d948e9b87fd328"
+  "gitHead": "3f7e281a9fee6f1df464e79064f917e1feec3253"
 }