@geogirafe/lib-geoportal 1.2.0-dev.2872463389 → 1.2.0-dev.2889263072

package/tools/tests/mockcontext.js

@@ -1,42 +1,6 @@
-// SPDX-License-Identifier: Apache-2.0
-import ApplicationLifeCycleManager from '../app/lifecyclemanager';
-import AuthManager from '../auth/authmanager';
-import DragManager from '../../components/treeview/tools/dragmanager';
-import PluginManager from '../auth/pluginmanager';
-import ConfigManager from '../configuration/configmanager';
 import GirafeConfig from '../configuration/girafeconfig';
-import ErrorManager from '../error/errormanager';
-import I18nManager from '../i18n/i18nmanager';
-import LayerManager from '../layers/layermanager';
-import SnapManager from '../layers/snapmanager';
-import LocalFileManager from '../localfile/localfilemanager';
-import LogManager from '../logging/logmanager';
-import OfflineManager from '../offline/offlinemanager';
-import OgcApiFeaturesManager from '../ogcapi/ogcapifeaturesmanager';
-import OrderingManager from '../ordering/orderingmanager';
-import SessionManager from '../share/sessionmanager';
-import ShareManager from '../share/sharemanager';
-import StateSerializer from '../share/stateserializer';
-import ComponentManager from '../state/componentManager';
-import MapManager from '../state/mapManager';
-import StateManager from '../state/statemanager';
-import UserInteractionManager from '../state/userInteractionManager';
-import CustomThemesManager from '../themes/customthemesmanager';
-import ThemesHelper from '../themes/themeshelper';
-import ThemesManager from '../themes/themesmanager';
-import UserLayerManager from '../themes/userlayermanager';
-import PermalinkManager from '../url/permalinkmanager';
-import UrlManager from '../url/urlmanager';
-import UserDataManager from '../userdata/userdatamanager';
-import WfsManager from '../wfs/wfsmanager';
-import WmsManager from '../wms/wmsmanager';
-import WmtsManager from '../wmts/wmtsmanager';
-import SelectionManager from '../selection/selectionmanager';
 import { MockConfig } from './mockconfig';
-import OnBoardingManager from '../onboarding/onboardingmanager';
-import ThemeFavoritesManager from '../themes/themefavoritesmanager';
-import SearchManager from '../search/searchmanager';
-import FeedbackManager from '../feedback/feedbackmanager';
+import ContextInitializationHelper from '../context/contexthelper';
 export default class MockGirafeContext {
     userDataManager;
     configManager;
@@ -48,8 +12,8 @@ export default class MockGirafeContext {
     themesManager;
     themesHelper;
     permalinkManager;
-    urlManager;
     dragManager;
+    urlManager;
     layerManager;
     sessionManager;
     stateSerializer;
@@ -74,88 +38,39 @@ export default class MockGirafeContext {
     themeFavoritesManager;
     searchManager;
     feedbackManager;
+    contextHelper = new ContextInitializationHelper();
     constructor() {
-        this.componentManager = new ComponentManager(this);
-        this.userDataManager = new UserDataManager(this);
-        this.configManager = new ConfigManager(this);
-        this.logManager = new LogManager(this);
-        this.stateManager = new StateManager(this);
-        this.orderingManager = new OrderingManager(this);
-        this.applicationLifeCycleManager = new ApplicationLifeCycleManager(this);
-        this.mapManager = new MapManager(this);
-        this.offlineManager = new OfflineManager(this);
-        this.snapManager = new SnapManager(this);
-        this.authManager = new AuthManager(this);
-        this.pluginManager = new PluginManager(this);
-        this.i18nManager = new I18nManager(this);
-        this.userInteractionManager = new UserInteractionManager(this);
-        this.dragManager = new DragManager(this);
-        this.urlManager = new UrlManager(this);
-        this.permalinkManager = new PermalinkManager(this);
-        this.layerManager = new LayerManager(this);
-        this.userLayerManager = new UserLayerManager(this);
-        this.themesHelper = new ThemesHelper(this);
-        this.stateSerializer = new StateSerializer(this);
-        this.sessionManager = new SessionManager(this);
-        this.shareManager = new ShareManager(this);
-        this.wfsManager = new WfsManager(this);
-        this.errorManager = new ErrorManager(this);
-        this.customThemesManager = new CustomThemesManager(this);
-        this.themesManager = new ThemesManager(this);
-        this.wmsManager = new WmsManager(this);
-        this.wmtsManager = new WmtsManager(this);
-        this.selectionManager = new SelectionManager(this);
-        this.localFileManager = new LocalFileManager(this);
-        this.ogcApiFeaturesManager = new OgcApiFeaturesManager(this);
-        this.onBoardingManager = new OnBoardingManager(this);
-        this.themeFavoritesManager = new ThemeFavoritesManager(this);
-        this.searchManager = new SearchManager(this);
-        this.feedbackManager = new FeedbackManager(this);
+        this.contextHelper.constructContext(this);
     }
     async initialize() {
-        // NOTE: This initialization order is important, because some singleton will need other ones!
-        this.componentManager.initializeSingleton();
-        this.userDataManager.initializeSingleton();
-        this.userDataManager.setSource(MockConfig.userdata.source);
-        this.userDataManager.deleteAllUserData();
+        await this.contextHelper.initializeContext(this);
+    }
+    /** The context can contains hook methods that will be called after each manager initialization.
+     * The hook method must be named with the property name + the "Hook" suffix.
+     * The hook method must be async and will be awaited
+     * For example, the methods themesManagerHook() will be called immediately after
+     * the call of themesManager.initializeSingleton().
+     * This allows specific initialization methods when defining custom contexts
+     * (for example for the apiContext, the mockContext, or any customContext)
+     */
+    async userDataManagerHook() {
+        await this.userDataManager.initializeSingleton();
+        this.userDataManager.initializeFromConfig(MockConfig.userdata);
+        await this.userDataManager.deleteAllUserData();
+    }
+    async configManagerHook() {
+        // Do not call the initializeSingleton methode
+        // But set hardcoded mock config
         // @ts-ignore
         this.configManager['config'] = new GirafeConfig(MockConfig);
         // @ts-ignore
         this.configManager['defaultConfig'] = new GirafeConfig(MockConfig);
-        this.logManager.initializeSingleton();
-        this.stateManager.initializeSingleton();
-        this.orderingManager.initializeSingleton();
-        this.applicationLifeCycleManager.initializeSingleton();
-        this.mapManager.initializeSingleton();
-        this.offlineManager.initializeSingleton();
-        this.snapManager.initializeSingleton();
-        this.authManager.initializeSingleton();
-        this.pluginManager.initializeSingleton();
-        this.i18nManager.initializeSingleton();
+    }
+    async i18nManagerHook() {
+        // Do not load translation files
+        // Bu set hardcoded mock translations
+        await this.i18nManager.initializeSingleton();
         // @ts-expect-error: private property
         this.i18nManager.translations = { fr: { a: 'translated_a', b: 'translated_b' } };
-        this.userInteractionManager.initializeSingleton();
-        this.dragManager.initializeSingleton();
-        this.urlManager.initializeSingleton();
-        this.permalinkManager.initializeSingleton();
-        this.layerManager.initializeSingleton();
-        this.userLayerManager.initializeSingleton();
-        this.themesHelper.initializeSingleton();
-        this.stateSerializer.initializeSingleton();
-        this.sessionManager.initializeSingleton();
-        this.shareManager.initializeSingleton();
-        this.wfsManager.initializeSingleton();
-        this.errorManager.initializeSingleton();
-        this.customThemesManager.initializeSingleton();
-        this.themesManager.initializeSingleton();
-        this.wmsManager.initializeSingleton();
-        this.wmtsManager.initializeSingleton();
-        this.localFileManager.initializeSingleton();
-        this.selectionManager.initializeSingleton();
-        this.ogcApiFeaturesManager.initializeSingleton();
-        this.onBoardingManager.initializeSingleton();
-        this.themeFavoritesManager.initializeSingleton();
-        this.searchManager.initializeSingleton();
-        this.feedbackManager.initializeSingleton();
     }
 }

package/tools/tests/mockhelper.d.ts

@@ -1,6 +1,6 @@
 import IGirafeContext from '../context/icontext';
 declare class MockHelper {
-    static startMocking(): IGirafeContext;
-    static stopMocking(context: IGirafeContext): void;
+    static startMocking(): Promise<IGirafeContext>;
+    static stopMocking(context: IGirafeContext): Promise<void>;
 }
 export default MockHelper;

package/tools/tests/mockhelper.js

@@ -3,21 +3,20 @@ import proj4 from 'proj4';
 import { register } from 'ol/proj/proj4';
 import MockGirafeContext from './mockcontext';
 import { MockConfig } from './mockconfig';
-import { noop } from '../utils/async';
 class MockHelper {
-    static startMocking() {
+    static async startMocking() {
         const context = new MockGirafeContext();
-        context.initialize().then(noop);
+        await context.initialize();
         for (const crs of MockConfig.crs) {
             proj4.defs(crs.code, crs.definition);
         }
         register(proj4);
         return context;
     }
-    static stopMocking(context) {
+    static async stopMocking(context) {
+        await context.userDataManager.deleteAllUserData();
         // @ts-ignore
         context.configManager.config = null;
-        context.userDataManager.deleteAllUserData();
     }
 }
 export default MockHelper;

package/tools/themes/customthemesmanager.d.ts

@@ -5,10 +5,10 @@ declare class CustomThemesManager extends GirafeSingleton {
     customThemes: CustomTheme[];
     private readonly storagePath;
     private readonly serializer;
-    addTheme(themeName: string, layersList: BaseLayer[]): void;
+    addTheme(themeName: string, layersList: BaseLayer[]): Promise<void>;
     private manageActiveStateForClonedObject;
-    deleteTheme(theme: CustomTheme): void;
+    deleteTheme(theme: CustomTheme): Promise<void>;
     private saveCustomThemes;
-    loadCustomThemes(): void;
+    loadCustomThemes(): Promise<void>;
 }
 export default CustomThemesManager;

package/tools/themes/customthemesmanager.js

@@ -9,7 +9,7 @@ class CustomThemesManager extends GirafeSingleton {
     customThemes = [];
     storagePath = 'customThemes';
     serializer = new CustomLayersSerializer(this.context);
-    addTheme(themeName, layersList) {
+    async addTheme(themeName, layersList) {
         const theme = new CustomTheme(themeName);
         for (const layerBase of layersList) {
             const layer = layerBase.clone();
@@ -17,7 +17,7 @@ class CustomThemesManager extends GirafeSingleton {
             theme.layers.push(layer);
         }
         this.customThemes.push(theme);
-        this.saveCustomThemes();
+        await this.saveCustomThemes();
     }
     manageActiveStateForClonedObject(layer) {
         /** Manage the current active state and default active state
@@ -35,25 +35,25 @@ class CustomThemesManager extends GirafeSingleton {
             }
         }
     }
-    deleteTheme(theme) {
-        const index = this.customThemes.findIndex((item) => item === theme);
+    async deleteTheme(theme) {
+        const index = this.customThemes.indexOf(theme);
         if (index >= 0) {
             this.customThemes.splice(index, 1);
-            this.saveCustomThemes();
+            await this.saveCustomThemes();
         }
         else {
             throw new Error('The custom theme to be removed cannot be found in the list of custom themes');
         }
     }
-    saveCustomThemes() {
+    async saveCustomThemes() {
         const serializedObject = {};
         for (const customTheme of this.customThemes) {
             serializedObject[customTheme.name] = this.serializer.customThemeSerialize(customTheme);
         }
-        this.context.userDataManager.saveUserData(this.storagePath, serializedObject);
+        await this.context.userDataManager.saveUserData(this.storagePath, serializedObject);
     }
-    loadCustomThemes() {
-        const customThemes = this.context.userDataManager.getUserData(this.storagePath);
+    async loadCustomThemes() {
+        const customThemes = (await this.context.userDataManager.getUserData(this.storagePath));
         if (customThemes) {
             for (const customThemeName of Object.keys(customThemes)) {
                 try {

package/tools/themes/themefavoritesmanager.d.ts

@@ -4,13 +4,13 @@ import ThemeLayer from '../../models/layers/themelayer.js';
 declare class ThemeFavoritesManager extends GirafeSingleton {
     private themeFavorites;
     private readonly storagePath;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private saveThemeFavorites;
     private loadThemeFavorites;
-    addThemeToFavorites(theme: ThemeLayer | CustomTheme): void;
-    removeThemeFromFavorites(theme: ThemeLayer | CustomTheme): void;
-    addOrRemoveThemeFromFavorites(theme: ThemeLayer | CustomTheme): void;
-    clearThemeFavorites(): void;
+    addThemeToFavorites(theme: ThemeLayer | CustomTheme): Promise<void>;
+    removeThemeFromFavorites(theme: ThemeLayer | CustomTheme): Promise<void>;
+    addOrRemoveThemeFromFavorites(theme: ThemeLayer | CustomTheme): Promise<void>;
+    clearThemeFavorites(): Promise<void>;
     isThemeInFavorites(theme: ThemeLayer | CustomTheme): boolean;
     getThemeFavorites(): Array<number | string>;
 }

package/tools/themes/themefavoritesmanager.js

@@ -4,45 +4,45 @@ import ThemeLayer from '../../models/layers/themelayer.js';
 class ThemeFavoritesManager extends GirafeSingleton {
     themeFavorites = [];
     storagePath = 'themeFavorites';
-    initializeSingleton() {
-        super.initializeSingleton();
-        this.loadThemeFavorites();
+    async initializeSingleton() {
+        await super.initializeSingleton();
+        await this.loadThemeFavorites();
     }
-    saveThemeFavorites() {
+    async saveThemeFavorites() {
         const serializedThemeFavorites = JSON.stringify(this.themeFavorites);
-        this.context.userDataManager.saveUserData(this.storagePath, serializedThemeFavorites);
+        await this.context.userDataManager.saveUserData(this.storagePath, serializedThemeFavorites);
     }
-    loadThemeFavorites() {
-        const serializedThemeFavorites = this.context.userDataManager.getUserData(this.storagePath);
+    async loadThemeFavorites() {
+        const serializedThemeFavorites = (await this.context.userDataManager.getUserData(this.storagePath));
         if (serializedThemeFavorites) {
             this.themeFavorites = JSON.parse(serializedThemeFavorites);
         }
     }
-    addThemeToFavorites(theme) {
+    async addThemeToFavorites(theme) {
         this.themeFavorites.push(theme instanceof ThemeLayer ? theme.id : theme.name);
-        this.saveThemeFavorites();
+        await this.saveThemeFavorites();
     }
-    removeThemeFromFavorites(theme) {
+    async removeThemeFromFavorites(theme) {
         const index = this.themeFavorites.findIndex((themeIdOrName) => theme instanceof ThemeLayer ? themeIdOrName === theme.id : themeIdOrName === theme.name);
         if (index >= 0) {
             this.themeFavorites.splice(index, 1);
-            this.saveThemeFavorites();
+            await this.saveThemeFavorites();
         }
         else {
             throw new Error('The theme to be removed cannot be found in the list of favorites');
         }
     }
-    addOrRemoveThemeFromFavorites(theme) {
+    async addOrRemoveThemeFromFavorites(theme) {
         if (this.isThemeInFavorites(theme)) {
-            this.removeThemeFromFavorites(theme);
+            await this.removeThemeFromFavorites(theme);
         }
         else {
-            this.addThemeToFavorites(theme);
+            await this.addThemeToFavorites(theme);
         }
     }
-    clearThemeFavorites() {
+    async clearThemeFavorites() {
         this.themeFavorites = [];
-        this.saveThemeFavorites();
+        await this.saveThemeFavorites();
     }
     isThemeInFavorites(theme) {
         return this.themeFavorites.includes(theme instanceof ThemeLayer ? theme.id : theme.name);

package/tools/themes/themeshelper.d.ts

@@ -9,7 +9,7 @@ export type LayerTreeChanges = {
     activatedLayers: BaseLayer[];
 };
 export default class ThemesHelper extends GirafeSingleton {
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private get state();
     findBaseLayerById(layerId: LayerId): BaseLayer;
     findBaseLayerRecursiveById(layers: BaseLayer[], layerId: LayerId): BaseLayer | null;

package/tools/themes/themeshelper.js

@@ -10,7 +10,7 @@ import WfsFilterCondition, { isWfsOperator } from '../wfs/wfsfiltercondition.js'
 import { KNOWN_FUNCTIONALITIES } from '../functionalities.js';
 import WfsFilter from '../wfs/wfsfilter.js';
 export default class ThemesHelper extends GirafeSingleton {
-    initializeSingleton() {
+    async initializeSingleton() {
         this.context.stateManager.subscribe('themes.lastSelectedTheme', (_oldTheme, newTheme) => this.onSelectedThemeChanged(newTheme));
     }
     get state() {

package/tools/themes/themesmanager.d.ts

@@ -4,7 +4,7 @@ declare class ThemesManager extends GirafeSingleton {
         u: string;
     };
     private get state();
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private initialize;
     private restoreState;
     private addBasemapFromUrl;

package/tools/themes/themesmanager.js

@@ -25,7 +25,7 @@ class ThemesManager extends GirafeSingleton {
     get state() {
         return this.context.stateManager.state;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         // We have to wait the authentication to be able to load the themes with the right user-rights
         this.context.stateManager.subscribe('application.isReadyToLoadThemes', async () => {
             if (this.state.application.isReadyToLoadThemes) {
@@ -104,7 +104,7 @@ class ThemesManager extends GirafeSingleton {
         const themesAndFunctionalities = await this.prepareThemes(content['themes']);
         this.state.themes._allThemes = themesAndFunctionalities.themes;
         this.state.themes._allFunctionalities = themesAndFunctionalities.themesFunctionalities;
-        this.context.customThemesManager.loadCustomThemes();
+        await this.context.customThemesManager.loadCustomThemes();
         this.state.themes.isLoaded = true;
         if (this.context.configManager.Config.themes.showErrorsOnStart) {
             // Display themes errors only if configured so.

package/tools/time/layertimeformatter.js

@@ -152,7 +152,7 @@ class LayerTimeFormatter {
         return temporalFilter;
     }
     isValidDateString(dateString) {
-        return !isNaN(Date.parse(dateString));
+        return !Number.isNaN(Date.parse(dateString));
     }
     isWithinRange(date) {
         return date >= this.minValue && date <= this.maxValue;

package/tools/url/permalinkmanager.d.ts

@@ -5,7 +5,7 @@ export default class PermalinkManager extends GirafeSingleton {
     private readonly urlParamKeys;
     private readonly urlParamKeysWithPrefix;
     private params;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private get state();
     private getPermalinkParamsFromUrl;
     private removePermalinkParamsFromUrl;

package/tools/url/permalinkmanager.js

@@ -26,7 +26,7 @@ export default class PermalinkManager extends GirafeSingleton {
     ];
     urlParamKeysWithPrefix = ['wfs_'];
     params = {};
-    initializeSingleton() {
+    async initializeSingleton() {
         this.getPermalinkParamsFromUrl();
         this.removePermalinkParamsFromUrl();
         this.setStateFromParams();

package/tools/userdata/userdatamanager.d.ts

@@ -1,4 +1,5 @@
 import GirafeSingleton from '../../base/GirafeSingleton.js';
+import { UserDataConfig } from '../configuration/girafeconfig.js';
 /**
  * Manages user data storage and retrieval across different storage sources.
  * The class supports localStorage and server as storage options (server-side implementation currently not available).
@@ -7,51 +8,29 @@ import GirafeSingleton from '../../base/GirafeSingleton.js';
  */
 declare class UserDataManager extends GirafeSingleton {
     private readonly storageKey;
-    private source?;
-    private readonly WARNING_UNKNOWN_SOURCE;
-    private readonly WARNING_NOT_IMPLEMENTED;
-    setSource(source: string): void;
+    private config;
+    private allowSaveUserPreferences;
+    initializeFromConfig(config: UserDataConfig): void;
+    private userData?;
+    private userDataPromise?;
     /**
      * Retrieves a specific part of the user data defined by the storage path.
      * @param storagePath path in the user data object to the requested value.
-     * @param forceLocalStorage if true, reads user data from the local storage, ignoring the source.
      * @returns the partial user data object.
      */
-    getUserData(storagePath: string, forceLocalStorage?: boolean): unknown;
-    /**
-     * Saves user data to a specific path in the storage.
-     * @param storagePath path in the user data object where the value is saved to.
-     * @param newValue user data value to save.
-     * @param forceLocalStorage if true, saves user data to the local storage, ignoring the source.
-     */
-    saveUserData(storagePath: string, newValue: unknown, forceLocalStorage?: boolean): void;
-    /**
-     * Delete a specific part of the user data defined by the storage path.
-     * @param storagePath path in the user data object that will be deleted.
-     * @param forceLocalStorage if true, deletes user data in the local storage, ignoring the source.
-     */
-    deleteUserData(storagePath: string, forceLocalStorage?: boolean): void;
-    /**
-     * Deletes all user data in storage.
-     * @param forceLocalStorage Force deletion from local storage regardless of the currently set data source.
-     */
-    deleteAllUserData(forceLocalStorage?: boolean): void;
-    /**
-     * Helper: Load data from the user data storage.
-     * @param forceLocalStorage forces loading data from local storage, independent of the specified source.
-     * @returns the full user data object in the storage.
-     */
+    getUserData(storagePath: string): Promise<unknown>;
+    getFromLocalStorage(storagePath: string): any;
+    private extractValue;
     private load;
-    /**
-     * Helper: Save user data to storage.
-     * @param fullUserDataObject full user data object that is saved.
-     * @param forceLocalStorage forces saving data to local storage, independent of the specified source.
-     * @private
-     */
+    private loadFromLocalStorage;
+    private loadFromServer;
+    saveUserData(storagePath: string, newValue: unknown): Promise<void>;
+    saveToLocalStorage(storagePath: string, newValue: unknown): void;
     private save;
-    /**
-     * Helper: Determines if a particular operation should use the local browser storage.
-     */
-    private isInLocalStorage;
+    private writeToLocalStorage;
+    private writeToServer;
+    deleteUserData(storagePath: string): Promise<void>;
+    deleteAllUserData(): Promise<void>;
+    private deleteFromServer;
 }
 export default UserDataManager;