@opengeoweb/store 19.0.0 → 19.1.1

package/dist/src/store/ui/selectors.d.ts

@@ -0,0 +1,234 @@
+import type { TypedUseSelectorHook } from 'react-redux';
+import type { CoreAppStore } from '../types';
+import type { DialogType, UIModuleState, UIStoreType, UIType } from './types';
+export declare const useAppSelector: TypedUseSelectorHook<CoreAppStore>;
+export declare const getUiStore: (store: UIModuleState) => UIStoreType;
+/**
+ * Gets the active map Id and wether a dialog is open or closed
+ *
+ * Example: getDialogDetailsByType(store, 'legend')
+ * @param {object} store store object from which the ui state wll be extracted
+ * @param {string} dialogType type of the dialog
+ * @returns {array} [string, boolean] first element gives the active map id, second element whether the dialog is open
+ */
+export declare const getDialogDetailsByType: (store: UIModuleState, dialogType: DialogType) => UIType;
+/**
+ * For a given ui component: gets wether the dialog is open or closed
+ *
+ * @param {object} store store object from which the ui state wll be extracted
+ * @param {string} dialogType type of the dialog
+ * @returns {boolean} returnType: boolean
+ */
+export declare const getisDialogOpen: ((state: UIModuleState, dialogType: DialogType) => boolean) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType) => boolean;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType) => boolean) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => boolean;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ *For a given ui component: gets the active map Id
+ *
+ * @param {object} store store object from which the ui state wll be extracted
+ * @param {string} dialogType type of the dialog
+ * @returns {string} returnType: string - the active map id
+ */
+export declare const getDialogMapId: ((state: UIModuleState, dialogType: DialogType) => string) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType) => string;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType) => string) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ *For a given ui component: gets the order of visible dialog
+ *
+ * @param {object} store store object from which the ui state wll be extracted
+ * @param {DialogType} dialogType type of the dialog
+ * @returns {number} the higher the order number the higher the zIndex
+ */
+export declare const getDialogOrder: (store: UIModuleState, dialogType: DialogType) => number;
+/**
+ *For a given ui component: returns if ordered on top
+ *
+ * @param {object} store store object from which the ui state wll be extracted
+ * @param {DialogType} dialogType type of the dialog
+ * @returns {boolean}
+ */
+export declare const getDialogIsOrderedOnTop: (store: UIModuleState, dialogType: DialogType) => boolean;
+export declare const getDialogSource: ((state: UIModuleState, dialogType: DialogType) => import("@opengeoweb/shared").Source) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType) => import("@opengeoweb/shared").Source;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType) => import("@opengeoweb/shared").Source) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => import("@opengeoweb/shared").Source;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ * Get the active window that should receive keyboard shortcuts
+ *
+ * Example: getActiveWindowId(store)
+ * @param {object} store store object from which the window state will be extracted
+ * @returns {string} active window id
+ */
+export declare const getActiveWindowId: ((state: UIModuleState) => string) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIStoreType) => string;
+    memoizedResultFunc: ((resultFuncArgs_0: UIStoreType) => string) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string;
+    dependencies: [(store: UIModuleState) => UIStoreType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ * Gets the panelId of which the dialog is opened from
+ *
+ * Example: getSourcePanelId(store, 'publicWarnings')
+ * @param {object} store store object from which the panelId state will be extracted
+ * @returns {string} the dialog type
+ */
+export declare const getSourcePanelId: ((state: UIModuleState, dialogType: DialogType) => string) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType | undefined) => string;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType | undefined) => string) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType | undefined];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ * Gets if this is the active window
+ *
+ * Example: getIsActiveWindowId(store, viewId)
+ * @param {object} store store object from which the window state will be extracted
+ * @returns {string} active window id
+ */
+export declare const getIsActiveWindowId: ((state: UIModuleState, viewId: string) => boolean) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIStoreType, resultFuncArgs_1: string) => boolean;
+    memoizedResultFunc: ((resultFuncArgs_0: UIStoreType, resultFuncArgs_1: string) => boolean) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => boolean;
+    dependencies: [(store: UIModuleState) => UIStoreType, (_store: UIModuleState, viewId: string) => string];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+export declare const getDialogIsLoading: ((state: UIModuleState, dialogType: DialogType) => boolean) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType) => boolean;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType) => boolean) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => boolean;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+export declare const getDialogError: ((state: UIModuleState, dialogType: DialogType) => string) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: UIType) => string;
+    memoizedResultFunc: ((resultFuncArgs_0: UIType) => string) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string;
+    dependencies: [(store: UIModuleState, dialogType: DialogType) => UIType];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+export declare const getUiDialogsByActiveMapId: (store: UIModuleState, mapId: string) => UIType[];

package/dist/src/store/ui/types.d.ts

@@ -0,0 +1,98 @@
+import type { Source } from '@opengeoweb/shared';
+type WithSuffix<T extends string> = T | `${T}-${string}`;
+type DrawingToolDialogType = WithSuffix<DialogTypes.DrawingTool>;
+type LegendDialogDialogType = WithSuffix<DialogTypes.Legend>;
+type LayerManagerDialogType = WithSuffix<DialogTypes.LayerManager>;
+type LayerSelectDialogType = WithSuffix<DialogTypes.LayerSelect>;
+type DockedLayerManagerDialogType = WithSuffix<DialogTypes.DockedLayerManager>;
+type GetFeatureInfoDialogType = WithSuffix<DialogTypes.Getfeatureinfo>;
+type KeywordFilterDialogType = WithSuffix<DialogTypes.KeywordFilter>;
+type SearchDialogDialogType = WithSuffix<DialogTypes.Search>;
+export declare enum DialogTypes {
+    LayerInfo = "layerInfo",
+    SyncGroups = "syncGroups",
+    TimeSeriesSelect = "timeSeriesSelect",
+    TimeSeriesManager = "timeSeriesManager",
+    TimeSeriesInfo = "timeSeriesInfo",
+    TimeSeriesLocationInfo = "timeSeriesLocationInfo",
+    KeywordFilter = "keywordFilter",
+    DimensionSelectEnsembleMember = "dimensionSelect-ensemble_member",
+    DimensionSelectElevation = "dimensionSelect-elevation",
+    LayerManager = "layerManager",
+    LayerSelect = "layerSelect",
+    Legend = "legend",
+    DrawingTool = "drawingTool",
+    DockedLayerManager = "dockedLayerManager",
+    ObjectManager = "objectManager",
+    PublicWarnings = "publicWarnings",
+    Search = "search",
+    AreaObjectLoader = "areaObjectLoader",
+    DataExplorer = "dataExplorer",
+    DataExplorerInfo = "dataExplorerInfo",
+    SelectedFeatures = "selectedFeatures",
+    SoundingsSources = "soundingsSources",
+    SoundingsLocations = "soundingsLocations",
+    SoundingsManager = "soundingsManager",
+    SoundingsProfileData = "soundingsProfileData",
+    TimeseriesLocations = "timeseriesLocations",
+    Getfeatureinfo = "getfeatureinfo"
+}
+export type DialogType = DialogTypes | LegendDialogDialogType | LayerManagerDialogType | LayerSelectDialogType | DockedLayerManagerDialogType | GetFeatureInfoDialogType | KeywordFilterDialogType | SearchDialogDialogType | DrawingToolDialogType;
+export type { Source };
+export interface UIType {
+    type: DialogType;
+    activeMapId: string;
+    isOpen: boolean;
+    source?: Source;
+    isLoading?: boolean;
+    error?: string;
+    sourcePanelId?: string;
+}
+export interface UIStoreType {
+    order: DialogType[];
+    dialogs: Partial<Record<DialogType, UIType>>;
+    activeWindowId?: string;
+}
+export interface UIModuleState {
+    ui?: UIStoreType;
+}
+export interface SetActiveMapIdForDialogPayload {
+    type: DialogType;
+    mapId: string;
+    setOpen?: boolean;
+    source?: Source;
+    origin?: string;
+}
+export interface UIRegisterDialogPayload {
+    type: DialogType;
+    mapId?: string;
+    setOpen?: boolean;
+    source?: Source;
+}
+export interface UIUnRegisterDialogPayload {
+    type: DialogType;
+}
+export interface UIToggleDialogPayload {
+    type: DialogType;
+    setOpen: boolean;
+    origin?: string;
+    mapId?: string;
+    sourcePanelId?: string;
+}
+export interface UIOrderDialogPayload {
+    type: DialogType;
+}
+export interface SetActiveWindowIdPayload {
+    activeWindowId: string;
+}
+export interface UIToggleIsLoadingPayload {
+    type: DialogType;
+    isLoading: boolean;
+}
+export interface UISetErrorPayload {
+    type: DialogType;
+    error: string;
+}
+export interface UIToggleShowSentryRecordButton {
+    type: DialogType;
+}

package/dist/src/store/ui/useSetupDialog.d.ts

@@ -0,0 +1,11 @@
+import type { uiTypes } from '.';
+export interface SetupDialogReturnValue {
+    setDialogOrder: () => void;
+    dialogOrder: number;
+    onCloseDialog: () => void;
+    uiSource: uiTypes.Source;
+    isDialogOpen: boolean;
+    uiIsLoading: boolean;
+    uiError: string;
+}
+export declare const useSetupDialog: (dialogType: uiTypes.DialogType, source?: uiTypes.Source) => SetupDialogReturnValue;

package/dist/src/store/unifyReducerMaps.d.ts

@@ -0,0 +1,3 @@
+import type { Action, Reducer } from '@reduxjs/toolkit';
+export type ReducerMap = Record<string, Reducer<any, Action<string>>>;
+export declare const unifyReducerMaps: (reducerMaps: ReducerMap[]) => ReducerMap;

package/dist/src/store/utils.d.ts

@@ -0,0 +1,6 @@
+export declare const selectorMemoizationOptions: {
+    memoizeOptions: {
+        maxSize: number;
+        resultEqualityCheck: (value: any, other: any) => boolean;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/store",
-  "version": "19.0.0",
+  "version": "19.1.1",
   "description": "GeoWeb Store library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -32,13 +32,14 @@
     "ol": "^10.4.0",
     "@turf/turf": "^7.2.0",
     "@types/geojson": "^7946.0.14",
-    "react-router": "^7.15.0"
+    "react-router": "^7.15.1"
   },
   "peerDependencies": {
     "react": "19"
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]