@fluid-topics/ft-app-context 2.2.4 → 2.2.5

package/build/redux-stores/FtAppInfoStore.d.ts

@@ -1,5 +1,5 @@
 import { FtReduxStore, Optional } from "@fluid-topics/ft-wc-utils";
-import { FtLocalesConfiguration, FtMetadataConfiguration, FtPrivacyPolicyConfiguration, FtSearchLocale, FtSession, FtUserLocaleSummary } from "@fluid-topics/public-api";
+import { FtLocalesConfiguration, FtMetadataConfiguration, FtPrivacyPolicyConfiguration, FtSearchLocale, FtSession, FtStickyFiltersSummary, FtUserLocaleSummary } from "@fluid-topics/public-api";
 import { PayloadAction } from "@reduxjs/toolkit";
 export declare const FtAppInfoStoreName = "ft-app-info";
 export interface FtAppInfoState {
@@ -21,6 +21,7 @@ export interface FtAppInfoState {
     navigatorOnline: boolean;
     forcedOffline: boolean;
     authenticationRequired: boolean;
+    stickyFilters: Optional<FtStickyFiltersSummary>;
 }
 export declare class AuthenticationChangeEvent extends CustomEvent<Optional<FtSession>> {
     static eventName: string;

package/build/redux-stores/FtAppInfoStore.js

@@ -42,5 +42,6 @@ export const ftAppInfoStore = FtReduxStore.get({
         navigatorOnline: true,
         forcedOffline: false,
         authenticationRequired: false,
+        stickyFilters: undefined,
     },
 });

package/build/redux-stores/FtAppStateManager.d.ts

@@ -1,6 +1,6 @@
-import { Debouncer, FtReduxStore, FtStateManager } from "@fluid-topics/ft-wc-utils";
+import { Debouncer, FtReduxStore, FtStateManager, Optional } from "@fluid-topics/ft-wc-utils";
 import { FtAppInfoState, FtAppInfoStateReducers } from "./FtAppInfoStore";
-import { FluidTopicsApi, FtMetadataConfiguration, FtSession } from "@fluid-topics/public-api";
+import { FluidTopicsApi, FtMetadataConfiguration, FtSession, FtStickyFiltersSummary } from "@fluid-topics/public-api";
 import { UserLocaleService } from "../services/user/UserLocaleService";
 export declare class FtAppStateManager extends FtStateManager {
     readonly store: FtReduxStore<FtAppInfoState, FtAppInfoStateReducers>;
@@ -11,7 +11,8 @@ export declare class FtAppStateManager extends FtStateManager {
     userLocaleService: UserLocaleService;
     constructor(store: FtReduxStore<FtAppInfoState, FtAppInfoStateReducers>, apiProvider?: () => FluidTopicsApi | undefined);
     setWithManualResources(withManualResources: boolean): void;
-    initService(): Promise<void>;
+    addListeners(): void;
+    removeListeners(): void;
     updateIfNeeded(): Promise<void>;
     private cleanSessionDebouncer;
     private updateSession;
@@ -19,6 +20,7 @@ export declare class FtAppStateManager extends FtStateManager {
     updateLocalesConfiguration(): Promise<void>;
     updateAvailableContentLocales(): Promise<void>;
     private reloadConfiguration;
+    setStickyFilters(stickyFilters: Optional<FtStickyFiltersSummary>): void;
     setBaseUrl(baseUrl?: string): void;
     setTenantId(tenantId?: string): void;
     setApiIntegrationIdentifier(apiIntegrationIdentifier: string): void;

package/build/redux-stores/FtAppStateManager.js

@@ -14,6 +14,11 @@ export class FtAppStateManager extends FtStateManager {
         this.withManualResources = true;
         this.userLocaleService = new UserLocaleService();
         this.cleanSessionDebouncer = new Debouncer();
+        this.reloadConfiguration = () => {
+            var _a;
+            (_a = this.cache) === null || _a === void 0 ? void 0 : _a.clear("availableContentLocales");
+            this.updateAvailableContentLocales();
+        };
         this.reloadDebouncer = new Debouncer(500);
         this.apiProvider = apiProvider !== null && apiProvider !== void 0 ? apiProvider : (() => FluidTopicsApiProvider.get());
     }
@@ -21,9 +26,12 @@ export class FtAppStateManager extends FtStateManager {
         this.withManualResources = withManualResources;
         this.updateIfNeeded();
     }
-    async initService() {
+    addListeners() {
         this.store.addEventListener(AuthenticationChangeEvent.eventName, this.reloadConfiguration);
     }
+    removeListeners() {
+        this.store.removeEventListener(AuthenticationChangeEvent.eventName, this.reloadConfiguration);
+    }
     async updateIfNeeded() {
         if (this.apiProvider()) {
             if (!this.withManualResources) {
@@ -66,12 +74,8 @@ export class FtAppStateManager extends FtStateManager {
         const availableContentLocales = await this.cache.get("availableContentLocales", () => getOrDefaultIfMissingRequiredAuthentication(() => this.apiProvider().getAvailableSearchLocales(), { contentLocales: [] }));
         this.setAvailableContentLocales((_a = availableContentLocales.contentLocales) !== null && _a !== void 0 ? _a : []);
     }
-    reloadConfiguration() {
-        var _a;
-        (_a = this.cache) === null || _a === void 0 ? void 0 : _a.clear("availableContentLocales");
-        if (typeof this.updateAvailableContentLocales === "function") {
-            this.updateAvailableContentLocales();
-        }
+    setStickyFilters(stickyFilters) {
+        this.store.actions.stickyFilters(stickyFilters);
     }
     setBaseUrl(baseUrl) {
         this.store.actions.baseUrl(baseUrl);

package/build/services/history/HistoryService.d.ts

@@ -1,5 +1,5 @@
 import { WithEventBus } from "@fluid-topics/ft-wc-utils";
-import { HistoryChangeEvent, HistoryState, HistoryStateUpdate } from "./HistoryService.models";
+import { BeforeLocationChangeEvent, HistoryChangeEvent, HistoryState, HistoryStateUpdate } from "./HistoryService.models";
 import { HistorySessionStorage } from "./HistorySessionStorage";
 export declare class HistoryService extends WithEventBus {
     private history;
@@ -18,6 +18,8 @@ export declare class HistoryService extends WithEventBus {
     private initEventListeners;
     private initData;
     updateCurrentState(update?: HistoryStateUpdate): void;
+    addBeforeLocationChangeListener(listener: (event: BeforeLocationChangeEvent) => void): void;
+    removeBeforeLocationChangeListener(listener: (event: BeforeLocationChangeEvent) => void): void;
     addHistoryChangeListener(listener: (event: HistoryChangeEvent) => void): void;
     removeHistoryChangeListener(listener: (event: HistoryChangeEvent) => void): void;
     currentItem(): HistoryState;

package/build/services/history/HistoryService.js

@@ -1,5 +1,5 @@
 import { deepCopy, deepEqual, WithEventBus, } from "@fluid-topics/ft-wc-utils";
-import { HistoryChangeEvent, } from "./HistoryService.models";
+import { BeforeLocationChangeEvent, HistoryChangeEvent, } from "./HistoryService.models";
 import { historyStorage, } from "./HistorySessionStorage";
 export class HistoryService extends WithEventBus {
     static build() {
@@ -31,20 +31,22 @@ export class HistoryService extends WithEventBus {
         }
         this.historyStorage.set(this.currentIndex, this.currentState);
         if (!deepEqual(this.currentState, this.history.state)) {
-            this.realReplaceState.apply(this.history, [this.currentState, this.currentState.title, window.location.href]);
+            this.realReplaceState.apply(this.history, [this.currentState, this.currentState.title, this.windowLocation().href]);
         }
         setTimeout(() => this.dispatchEvent(new HistoryChangeEvent(this.currentItem())), 0);
     }
     installProxies() {
         const editStateProxy = (indexProvider) => (method, history, [data, title, url]) => {
+            const beforeEvent = new BeforeLocationChangeEvent(new URL(typeof url === "string" ? url : (url !== null && url !== void 0 ? url : this.windowLocation()).href, window.location.origin));
+            this.dispatchEvent(beforeEvent);
             const index = indexProvider();
             const state = {
                 ...(index === this.currentIndex ? this.currentState : undefined),
                 ...data,
                 index: index,
-                href: typeof url === "string" ? url : (url !== null && url !== void 0 ? url : this.windowLocation()).href,
+                href: beforeEvent.detail.nextLocation.href,
             };
-            method.apply(history, [state, title, url]);
+            method.apply(history, [state, title, state.href]);
             this.setCurrentState(state, true);
         };
         this.history.pushState = new Proxy(this.history.pushState, { apply: editStateProxy(() => this.currentIndex + 1) });
@@ -78,6 +80,12 @@ export class HistoryService extends WithEventBus {
         };
         this.setCurrentState(newState);
     }
+    addBeforeLocationChangeListener(listener) {
+        this.addEventListener(BeforeLocationChangeEvent.eventName, listener);
+    }
+    removeBeforeLocationChangeListener(listener) {
+        this.removeEventListener(BeforeLocationChangeEvent.eventName, listener);
+    }
     addHistoryChangeListener(listener) {
         this.addEventListener(HistoryChangeEvent.eventName, listener);
     }

package/build/services/history/HistoryService.models.d.ts

@@ -14,6 +14,17 @@ export interface HistoryStateUpdate {
     category?: string;
     [additionalInfo: string]: any;
 }
+export interface BeforeLocationChangeEventDetail {
+    nextLocation: URL;
+}
+/**
+ * Event fired when the location is changed by the application.
+ * This event is **deliberately** not fired when navigating through history.
+ */
+export declare class BeforeLocationChangeEvent extends CustomEvent<BeforeLocationChangeEventDetail> {
+    static eventName: string;
+    constructor(nextLocation: URL);
+}
 export declare class HistoryChangeEvent extends CustomEvent<{
     currentItem: HistoryState;
 }> {

package/build/services/history/HistoryService.models.js

@@ -1,3 +1,13 @@
+/**
+ * Event fired when the location is changed by the application.
+ * This event is **deliberately** not fired when navigating through history.
+ */
+export class BeforeLocationChangeEvent extends CustomEvent {
+    constructor(nextLocation) {
+        super(BeforeLocationChangeEvent.eventName, { detail: { nextLocation } });
+    }
+}
+BeforeLocationChangeEvent.eventName = "before-location-change";
 export class HistoryChangeEvent extends CustomEvent {
     constructor(currentItem) {
         super(HistoryChangeEvent.eventName, { detail: { currentItem } });

package/build/services/history/index.d.ts

@@ -11,6 +11,8 @@ declare global {
             backwardItemMatching: HistoryService["backwardItemMatching"];
             addHistoryChangeListener: HistoryService["addHistoryChangeListener"];
             removeHistoryChangeListener: HistoryService["removeHistoryChangeListener"];
+            addBeforeLocationChangeListener: HistoryService["addBeforeLocationChangeListener"];
+            removeBeforeLocationChangeListener: HistoryService["removeBeforeLocationChangeListener"];
         };
     }
 }

package/build/services/history/index.js

@@ -10,5 +10,7 @@ if (window.FluidTopicsInternalHistoryService == null) {
         backwardItemMatching: (predicate) => window.FluidTopicsInternalHistoryService.backwardItemMatching(predicate),
         addHistoryChangeListener: (listener) => window.FluidTopicsInternalHistoryService.addHistoryChangeListener(listener),
         removeHistoryChangeListener: (listener) => window.FluidTopicsInternalHistoryService.removeHistoryChangeListener(listener),
+        addBeforeLocationChangeListener: (listener) => window.FluidTopicsInternalHistoryService.addBeforeLocationChangeListener(listener),
+        removeBeforeLocationChangeListener: (listener) => window.FluidTopicsInternalHistoryService.removeBeforeLocationChangeListener(listener),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-app-context",
-    "version": "2.2.4",
+    "version": "2.2.5",
     "description": "Global application context for Fluid Topics integrations",
     "keywords": [
         "Lit"
@@ -19,12 +19,12 @@
         "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
     },
     "dependencies": {
-        "@fluid-topics/ft-wc-utils": "2.2.4",
+        "@fluid-topics/ft-wc-utils": "2.2.5",
         "@lit/context": "1.1.6",
         "lit": "3.3.3"
     },
     "devDependencies": {
-        "@fluid-topics/public-api": "1.0.137"
+        "@fluid-topics/public-api": "1.0.138"
     },
-    "gitHead": "2ac039d227e4c6f0630b0bfe10cac9a28d4cd41f"
+    "gitHead": "49802c8417d9eb8b329f8187f08c05af4d546c93"
 }