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

package/tools/layers/snapmanager.d.ts

@@ -4,7 +4,7 @@ declare class SnapManager extends GirafeSingleton {
     private inactiveSnapLayers;
     private get olMap();
     private get state();
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private mapInteractionsChanged;
     private activateSnappingForAllLayers;
     private deactivateSnappingForAllLayers;

package/tools/layers/snapmanager.js

@@ -13,7 +13,7 @@ class SnapManager extends GirafeSingleton {
     get state() {
         return this.context.stateManager.state;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         this.context.stateManager.subscribe(/layers\.layersList\..*\.activeState/, (_oldActive, _newActive, layer) => {
             this.layerUpdated(layer);
         });

package/tools/localfile/localfilemanager.d.ts

@@ -13,7 +13,7 @@ declare class LocalFileManager extends GirafeSingleton {
     private activeLayers;
     private readonly featureLayerMap;
     constructor(context: IGirafeContext);
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private registerEvents;
     private createInteraction;
     loadLocalFile(localFile: File): Promise<void>;

package/tools/localfile/localfilemanager.js

@@ -25,7 +25,7 @@ class LocalFileManager extends GirafeSingleton {
         this.map = this.context.mapManager.getMap();
         this.name = `localFileManager`;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         this.registerEvents();
         // Add drag n drop interaction to add local files
         const dragAndDropInteraction = this.createInteraction();

package/tools/logging/defaultconsole.d.ts

@@ -0,0 +1,8 @@
+export default class DefaultConsole {
+    static readonly debug: typeof console.debug;
+    static readonly log: typeof console.log;
+    static readonly info: typeof console.info;
+    static readonly warn: typeof console.warn;
+    static readonly error: typeof console.error;
+    static readonly assert: typeof console.assert;
+}

package/tools/logging/defaultconsole.js

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: Apache-2.0
+export default class DefaultConsole {
+    static debug = console.debug;
+    static log = console.log;
+    static info = console.info;
+    static warn = console.warn;
+    static error = console.error;
+    static assert = console.assert;
+}

package/tools/logging/logmanager.d.ts

@@ -1,12 +1,6 @@
 import GirafeSingleton from '../../base/GirafeSingleton.js';
 export default class LogManager extends GirafeSingleton {
-    private readonly defaultDebug;
-    private readonly defaultLog;
-    private readonly defaultInfo;
-    private readonly defaultWarn;
-    private readonly defaultError;
-    private readonly defaultAssert;
-    initLogging(): void;
+    initializeSingleton(): Promise<void>;
     /**
      * Write log to output if the current loglevel is debug, info, warn or error
      * @returns true if the log was written, false instead

package/tools/logging/logmanager.js

@@ -1,13 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 import GirafeSingleton from '../../base/GirafeSingleton.js';
+import DefaultConsole from './defaultconsole.js';
 export default class LogManager extends GirafeSingleton {
-    defaultDebug = console.debug;
-    defaultLog = console.log;
-    defaultInfo = console.info;
-    defaultWarn = console.warn;
-    defaultError = console.error;
-    defaultAssert = console.assert;
-    initLogging() {
+    async initializeSingleton() {
         console.debug = this.debug.bind(this);
         console.log = this.log.bind(this);
         console.info = this.info.bind(this);
@@ -21,7 +16,7 @@ export default class LogManager extends GirafeSingleton {
      */
     debug(message, ...optionalParams) {
         if (this.context.configManager.Config.general.logLevel === 'debug') {
-            this.defaultDebug(message, ...optionalParams);
+            DefaultConsole.debug(message, ...optionalParams);
             return true;
         }
         return false;
@@ -33,7 +28,7 @@ export default class LogManager extends GirafeSingleton {
     log(message, ...optionalParams) {
         if (this.context.configManager.Config.general.logLevel === 'debug' ||
             this.context.configManager.Config.general.logLevel === 'info') {
-            this.defaultLog(message, ...optionalParams);
+            DefaultConsole.log(message, ...optionalParams);
             return true;
         }
         return false;
@@ -45,7 +40,7 @@ export default class LogManager extends GirafeSingleton {
     info(message, ...optionalParams) {
         if (this.context.configManager.Config.general.logLevel === 'debug' ||
             this.context.configManager.Config.general.logLevel === 'info') {
-            this.defaultInfo(message, ...optionalParams);
+            DefaultConsole.info(message, ...optionalParams);
             return true;
         }
         return false;
@@ -58,7 +53,7 @@ export default class LogManager extends GirafeSingleton {
         if (this.context.configManager.Config.general.logLevel === 'debug' ||
             this.context.configManager.Config.general.logLevel === 'info' ||
             this.context.configManager.Config.general.logLevel === 'warn') {
-            this.defaultWarn(message, ...optionalParams);
+            DefaultConsole.warn(message, ...optionalParams);
             return true;
         }
         return false;
@@ -68,7 +63,7 @@ export default class LogManager extends GirafeSingleton {
      * @returns true if the log was written, false instead
      */
     error(message, ...optionalParams) {
-        this.defaultError(message, ...optionalParams);
+        DefaultConsole.error(message, ...optionalParams);
         return true;
     }
     /**
@@ -77,7 +72,7 @@ export default class LogManager extends GirafeSingleton {
      */
     assert(condition, ...optionalParams) {
         // assert has the same log level as error
-        this.defaultAssert(condition, ...optionalParams);
+        DefaultConsole.assert(condition, ...optionalParams);
         return !condition;
     }
 }

package/tools/main.d.ts

@@ -9,10 +9,11 @@ export { default as GMFManager } from './auth/gmfmanager.js';
 export { default as OpenIdConnectManager } from './auth/openidconnectmanager.js';
 export { default as PluginManager } from './auth/pluginmanager.js';
 export { default as ConfigManager } from './configuration/configmanager.js';
-export type { HighlightMode } from './configuration/girafeconfig.js';
+export type { HighlightMode, UserDataConfig } from './configuration/girafeconfig.js';
 export { default as GirafeConfig } from './configuration/girafeconfig.js';
 export { defaultNewsSanitizeConfig, defaultPermalinkSanitizeConfig, defaultQuerySanitizeConfig } from './configuration/sanitizeconfig-defaults.js';
 export { default as GirafeContext } from './context/context.js';
+export { default as ContextInitializationHelper } from './context/contexthelper.js';
 export type { default as IGirafeContext } from './context/icontext.js';
 export type { DrawingShape, ArrowStyle, ArrowPosition, LineStroke, MeasureInformation, SerializedFeature } from './drawing/drawingFeature.js';
 export { default as DrawingFeature } from './drawing/drawingFeature.js';
@@ -40,6 +41,7 @@ export { default as SnapManager } from './layers/snapmanager.js';
 export type { WMSLegendURLOptions } from './legendhelper.js';
 export { default as LegendHelper } from './legendhelper.js';
 export { default as LocalFileManager } from './localfile/localfilemanager.js';
+export { default as DefaultConsole } from './logging/defaultconsole.js';
 export { default as LogManager } from './logging/logmanager.js';
 export { default as OfflineManager } from './offline/offlinemanager.js';
 export { DEMO_LAYERS } from './ogcapi/demolayers.js';

package/tools/main.js

@@ -12,6 +12,7 @@ export { default as ConfigManager } from './configuration/configmanager.js';
 export { default as GirafeConfig } from './configuration/girafeconfig.js';
 export { defaultNewsSanitizeConfig, defaultPermalinkSanitizeConfig, defaultQuerySanitizeConfig } from './configuration/sanitizeconfig-defaults.js';
 export { default as GirafeContext } from './context/context.js';
+export { default as ContextInitializationHelper } from './context/contexthelper.js';
 export { default as DrawingFeature } from './drawing/drawingFeature.js';
 export { default as DrawingSerializer } from './drawing/drawingSerializer.js';
 export { default as DrawingState } from './drawing/drawingState.js';
@@ -33,6 +34,7 @@ export { default as SimpleMaskManager } from './layers/simplemaskmanager.js';
 export { default as SnapManager } from './layers/snapmanager.js';
 export { default as LegendHelper } from './legendhelper.js';
 export { default as LocalFileManager } from './localfile/localfilemanager.js';
+export { default as DefaultConsole } from './logging/defaultconsole.js';
 export { default as LogManager } from './logging/logmanager.js';
 export { default as OfflineManager } from './offline/offlinemanager.js';
 export { DEMO_LAYERS } from './ogcapi/demolayers.js';

package/tools/offline/offlinemanager.d.ts

@@ -15,19 +15,19 @@ declare class OfflineManager extends GirafeSingleton {
     private readonly tilesStoreName;
     private readonly bboxStoreName;
     private readonly vectorLayer;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     initializeOfflineState(isOffline: boolean): void;
     private registerEvents;
     /** Exports all the WMTS tiles for the layers in parameter and store them to local cache */
     exportWMTSTiles(bbox: Extent, wmtsLayers: LayerWmts[], progressCallback?: CallableFunction): Promise<void>;
-    upgradeIndexedDb(database: IDBDatabase): void;
+    private upgradeIndexedDb;
     /** The offline manager works with a ServiceWorker in charge of intercepting
      * the fetch requests and read the data from the local cache if the application
      * is offline. This method defines the servicework object to use.
      * Without this, the offline mode won't work.
      */
     setServiceWorker(sw: ServiceWorker | null, storeVersion: number, dbCacheName: string): Promise<void>;
-    switchOffline(): void;
+    switchOffline(): Promise<void>;
     private getAllTileUrls;
     private getTileUrlsForWmtsLayer;
     private fetchAndSaveTiles;

package/tools/offline/offlinemanager.js

@@ -35,7 +35,7 @@ class OfflineManager extends GirafeSingleton {
             })
         })
     });
-    initializeSingleton() {
+    async initializeSingleton() {
         this.map.addLayer(this.vectorLayer);
     }
     initializeOfflineState(isOffline) {
@@ -50,7 +50,7 @@ class OfflineManager extends GirafeSingleton {
             this.state.isOffline = false;
         });
         this.context.stateManager.subscribe('isOffline', () => {
-            this.switchOffline();
+            void this.switchOffline();
         });
     }
     /** Exports all the WMTS tiles for the layers in parameter and store them to local cache */
@@ -90,9 +90,9 @@ class OfflineManager extends GirafeSingleton {
             tilesStoreName: this.tilesStoreName
         });
     }
-    switchOffline() {
+    async switchOffline() {
         if (this.context.stateManager.state.isOffline) {
-            this.displayBoundBoxes();
+            await this.displayBoundBoxes();
         }
         else if (this.vectorLayer) {
             this.vectorLayer.setSource(null);
@@ -231,11 +231,11 @@ class OfflineManager extends GirafeSingleton {
         });
     }
     async clearTileStore() {
-        this.clearStore(this.tilesStoreName);
+        await this.clearStore(this.tilesStoreName);
     }
     async clearBBoxStore() {
         this.vectorLayer.setSource(null);
-        this.clearStore(this.bboxStoreName);
+        await this.clearStore(this.bboxStoreName);
     }
     async saveBoundingBox(bbox) {
         const database = await this.database();

package/tools/ogcapi/ogcapifeaturesmanager.d.ts

@@ -13,7 +13,7 @@ import { OgcApiClientOptions } from './ogcapiclient.js';
 export default class OgcApiFeaturesManager extends VendorSpecificOgcServerManager<OgcApiFeaturesClient, OgcApiClientOptions> {
     protected get state(): import("../main.js").State;
     getClientId(ogcServer: ServerOgc): string;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     getSchema(layer: OapifLayer): Promise<OgcApiFeaturesSchema>;
     getItems(layer: OapifLayer, crs?: string, bbox?: number[], limit?: number): Promise<Feature<Geometry>[]>;
     getItem(layer: OapifLayer, featureId: string): Promise<Feature<Geometry> | undefined>;

package/tools/ogcapi/ogcapifeaturesmanager.js

@@ -14,7 +14,7 @@ export default class OgcApiFeaturesManager extends VendorSpecificOgcServerManage
     getClientId(ogcServer) {
         return ogcServer.urlOapif ?? '';
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         // Register the clients
         this.registerClientClass('default', OgcApiFeaturesClient);
         this.registerClientClass('georama', OgcApiFeaturesClientGeorama);

package/tools/onboarding/onboardingmanager.js

@@ -8,7 +8,7 @@ export default class OnBoardingManager extends GirafeSingleton {
     }
     STORAGE_PATH = 'onboardingTourAlreadyDone';
     async restart() {
-        this.context.userDataManager.saveUserData(this.STORAGE_PATH, 'false');
+        await this.context.userDataManager.saveUserData(this.STORAGE_PATH, 'false');
         return this.start();
     }
     async start() {
@@ -17,13 +17,13 @@ export default class OnBoardingManager extends GirafeSingleton {
             return;
         }
         await this.context.i18nManager.ensureTranslationLoaded();
-        const tourAlreadyDone = this.context.userDataManager.getUserData(this.STORAGE_PATH) || 'false';
+        const tourAlreadyDone = (await this.context.userDataManager.getUserData(this.STORAGE_PATH)) || 'false';
         if (tourAlreadyDone !== 'true') {
             const onboardingDriver = driver({
                 popoverClass: 'girafe-onboarding-theme',
                 showProgress: true,
-                onDestroyed: (_element, _step, _options) => {
-                    this.context.userDataManager.saveUserData(this.STORAGE_PATH, 'true');
+                onDestroyed: async (_element, _step, _options) => {
+                    await this.context.userDataManager.saveUserData(this.STORAGE_PATH, 'true');
                 },
                 nextBtnText: this.context.i18nManager.getTranslation('onboarding-next-button-text'),
                 prevBtnText: this.context.i18nManager.getTranslation('onboarding-previous-button-text'),

package/tools/ordering/orderingmanager.d.ts

@@ -4,7 +4,7 @@ export default class OrderingManager extends GirafeSingleton {
     private timeoutId?;
     private isReordering;
     private get state();
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private registerEvents;
     private onLayerListChanged;
     /**

package/tools/ordering/orderingmanager.js

@@ -9,7 +9,7 @@ export default class OrderingManager extends GirafeSingleton {
     get state() {
         return this.context.stateManager.state;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         this.registerEvents();
     }
     registerEvents() {

package/tools/resizewindow.js

@@ -108,12 +108,12 @@ export default class ResizeWindow {
         this.width = dimension.width;
         this.height = dimension.height;
         const css = getComputedStyle(this.host);
-        this.minHeight = parseInt(css.minHeight) || 0;
-        this.maxHeight = parseInt(css.maxHeight) || Infinity;
-        this.minWidth = parseInt(css.minWidth) || 0;
-        this.maxWidth = parseInt(css.maxWidth) || Infinity;
-        this.top = parseInt(css.top) || 0;
-        this.left = parseInt(css.left) || 0;
+        this.minHeight = Number.parseInt(css.minHeight) || 0;
+        this.maxHeight = Number.parseInt(css.maxHeight) || Infinity;
+        this.minWidth = Number.parseInt(css.minWidth) || 0;
+        this.maxWidth = Number.parseInt(css.maxWidth) || Infinity;
+        this.top = Number.parseInt(css.top) || 0;
+        this.left = Number.parseInt(css.left) || 0;
         // Call a function whenever the cursor moves.
         document.onmousemove = (dragEvent) => this.resize(dragEvent, direction);
         // Detach events.

package/tools/search/abstractsearchclient.d.ts

@@ -26,7 +26,7 @@ declare abstract class AbstractSearchClient extends GirafeSingleton {
         [x: string]: any;
     }>>;
     protected constructor(context: IGirafeContext, config: BaseSearchClientConfig);
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     protected get mapProjection(): import("ol/proj.js").Projection;
     /**
      * Sanitize the url by removing placeholders that are wrongfully interpreted as URL fragments by the URL parser.

package/tools/search/abstractsearchclient.js

@@ -25,8 +25,8 @@ class AbstractSearchClient extends GirafeSingleton {
         this.url = this.sanitizeUrl(config.url);
         this.resultSrid = config.resultSrid;
     }
-    initializeSingleton() {
-        super.initializeSingleton();
+    async initializeSingleton() {
+        await super.initializeSingleton();
     }
     get mapProjection() {
         return this.context.mapManager.getMap().getView().getProjection();

package/tools/search/searchmanager.d.ts

@@ -18,7 +18,7 @@ declare class SearchManager extends GirafeSingleton {
     private defaultMaxExtent?;
     readonly minSearchTermLength = 3;
     constructor(context: IGirafeContext);
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     protected createClient(providerConfig: SearchProviderConfig): void;
     /**
      * Returns available search categories per provider.

package/tools/search/searchmanager.js

@@ -16,8 +16,8 @@ class SearchManager extends GirafeSingleton {
     constructor(context) {
         super(context);
     }
-    initializeSingleton() {
-        super.initializeSingleton();
+    async initializeSingleton() {
+        await super.initializeSingleton();
         for (const providerConfig of this.context.configManager.Config.search?.providers ?? []) {
             this.createClient(providerConfig);
         }

package/tools/selection/selectionmanager.d.ts

@@ -8,7 +8,7 @@ import GirafeSingleton from '../../base/GirafeSingleton.js';
  */
 export default class SelectionManager extends GirafeSingleton {
     private get state();
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     /**
      * Selects all the features of the queryable layers that are inside the given extent.
      * Layers selectable today are WMS, WMTS (with wms layer) and Local files.

package/tools/selection/selectionmanager.js

@@ -13,7 +13,7 @@ export default class SelectionManager extends GirafeSingleton {
     get state() {
         return this.context.stateManager.state;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         this.context.stateManager.subscribe('selection.selectionParameters', (_, newParams) => {
             // The querying is asynchronous and nobody awaits it here,
             // so a failing request must not end up in an unhandled rejection.

package/tools/share/sessionmanager.d.ts

@@ -2,7 +2,7 @@ import GirafeSingleton from '../../base/GirafeSingleton.js';
 import ISessionManager from './isessionmanager.js';
 declare class SessionManager extends GirafeSingleton implements ISessionManager {
     private readonly sessionHash;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     beginSession(): void;
     saveStateToSession(): void;
     hasState(): boolean;

package/tools/share/sessionmanager.js

@@ -2,7 +2,7 @@
 import GirafeSingleton from '../../base/GirafeSingleton.js';
 class SessionManager extends GirafeSingleton {
     sessionHash = 'session';
-    initializeSingleton() {
+    async initializeSingleton() {
         window.addEventListener('pagehide', () => this.saveStateToSession());
     }
     beginSession() {

package/tools/share/sharemanager.d.ts

@@ -3,7 +3,7 @@ import { IUrlShortener } from './iurlshortener.js';
 declare class ShareManager extends GirafeSingleton {
     private urlShortener?;
     get UrlShortener(): IUrlShortener | undefined;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     getStateToShare(): string;
     hasSharedState(): boolean;
     private getStateFromUrl;

package/tools/share/sharemanager.js

@@ -7,7 +7,7 @@ class ShareManager extends GirafeSingleton {
     get UrlShortener() {
         return this.urlShortener;
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         const share = this.context.configManager.Config.share;
         if (share) {
             switch (share.service) {

package/tools/share/stateserializer.d.ts

@@ -2,7 +2,7 @@ import GirafeSingleton from '../../base/GirafeSingleton.js';
 import { Constructor, IBrainSerializer } from '../state/brain/serialize.js';
 declare class StateSerializer extends GirafeSingleton {
     private readonly brainSerializer;
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     addSerializer(type: Constructor<object>, serializerData: IBrainSerializer<object>): void;
     getSerializedState(): string;
     deserializeAndSetState(compressedState: string): boolean;

package/tools/share/stateserializer.js

@@ -17,7 +17,7 @@ import LayoutState from '../state/layout.js';
 import LayoutSerializer from './serializers/layoutserializer.js';
 class StateSerializer extends GirafeSingleton {
     brainSerializer = new BrainSerializer();
-    initializeSingleton() {
+    async initializeSingleton() {
         this.addSerializer((Array), new ActiveBasemapsSerializer(this.context));
         this.addSerializer(MapPosition, new MapPositionSerializer(this.context));
         this.addSerializer(LayersConfig, new LayersConfigSerializer(this.context));

package/tools/state/statemanager.d.ts

@@ -8,7 +8,7 @@ declare class StateManager extends GirafeSingleton {
     get state(): State;
     private readonly callbacks;
     constructor(context: IGirafeContext);
-    initializeSingleton(): void;
+    initializeSingleton(): Promise<void>;
     private setDefaultValues;
     private setDefaultLayout;
     /**

package/tools/state/statemanager.js

@@ -18,7 +18,7 @@ class StateManager extends GirafeSingleton {
             this.onChange(path, oldValue, newValue, parents);
         });
     }
-    initializeSingleton() {
+    async initializeSingleton() {
         this.setDefaultValues();
     }
     setDefaultValues() {

package/tools/tests/mockconfig.d.ts

@@ -1,3 +1,4 @@
+import { UserDataConfig } from '../configuration/girafeconfig';
 export declare const MockConfig: {
     general: {
         locale: string;
@@ -58,9 +59,7 @@ export declare const MockConfig: {
     lidar: {
         url: string;
     };
-    userdata: {
-        source: string;
-    };
+    userdata: UserDataConfig;
     crs: {
         code: string;
         definition: string;

package/tools/tests/mockconfig.js

@@ -1,4 +1,3 @@
-// SPDX-License-Identifier: Apache-2.0
 export const MockConfig = {
     general: {
         locale: 'en-US',

package/tools/tests/mockcontext.d.ts

@@ -46,8 +46,8 @@ export default class MockGirafeContext implements IGirafeContext {
     readonly themesManager: ThemesManager;
     readonly themesHelper: ThemesHelper;
     readonly permalinkManager: PermalinkManager;
-    readonly urlManager: UrlManager;
     readonly dragManager: DragManager;
+    readonly urlManager: UrlManager;
     readonly layerManager: LayerManager;
     readonly sessionManager: SessionManager;
     readonly stateSerializer: StateSerializer;
@@ -72,6 +72,18 @@ export default class MockGirafeContext implements IGirafeContext {
     readonly themeFavoritesManager: ThemeFavoritesManager;
     readonly searchManager: SearchManager;
     readonly feedbackManager: FeedbackManager;
+    private readonly contextHelper;
     constructor();
     initialize(): Promise<void>;
+    /** 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)
+     */
+    protected userDataManagerHook(): Promise<void>;
+    protected configManagerHook(): Promise<void>;
+    protected i18nManagerHook(): Promise<void>;
 }