@opengeoweb/store 5.2.1 → 6.0.0

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

@@ -0,0 +1,144 @@
+import type { CoreAppStore } from '../types';
+import type { UIStoreType, UIType } from './types';
+export declare const getUiStore: (store: CoreAppStore) => 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: CoreAppStore, dialogType: string) => 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: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: UIType) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ *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: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => string) & import("reselect").OutputSelectorFields<(args_0: UIType) => string, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ *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: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => number) & import("reselect").OutputSelectorFields<(args_0: number) => number, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ *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: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getDialogSource: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => import("./types").Source) & import("reselect").OutputSelectorFields<(args_0: UIType) => import("./types").Source, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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: (store: CoreAppStore) => string;
+export declare const getDialogIsLoading: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: UIType) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getDialogError: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => string) & import("reselect").OutputSelectorFields<(args_0: UIType) => string, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getDialogFocused: ((state: {
+    syncronizationGroupStore?: import("../generic/synchronizationGroups/types").SynchronizationGroupState | undefined;
+    ui?: UIStoreType | undefined;
+    webmap?: import("../mapStore/types").WebMapState | undefined;
+    services?: import("../mapStore/types").ServiceState | undefined;
+    layers?: import("../mapStore/types").LayerState | undefined;
+    layerSelect?: import("../layerSelect/types").LayerSelectStoreType | undefined;
+}, params_0: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: UIType) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,78 @@
+import { MapActionOrigin } from '../mapStore/map/enums';
+declare type LegendDialogType = string;
+declare type GetFeatureInfoDialogType = string;
+export declare enum DialogTypes {
+    LayerInfo = "layerInfo",
+    SyncGroups = "syncGroups",
+    TimeSeriesSelect = "timeSeriesSelect",
+    TimeSeriesManager = "timeSeriesManager",
+    KeywordFilter = "keywordFilter",
+    DimensionSelectEnsembleMember = "dimensionSelect-ensemble_member",
+    DimensionSelectElevation = "dimensionSelect-elevation",
+    LayerManager = "layerManager",
+    LayerSelect = "layerSelect",
+    DrawingTool = "drawingTool",
+    DockedLayerManager = "dockedLayerManager",
+    DockedDrawingTool = "dockedDrawingTool",
+    AreaManager = "areaManager"
+}
+export declare type DialogType = DialogTypes | LegendDialogType | GetFeatureInfoDialogType;
+export declare type Source = 'app' | 'module';
+export interface UIType {
+    type: DialogType;
+    activeMapId: string;
+    isOpen: boolean;
+    source?: Source;
+    isLoading?: boolean;
+    error?: string;
+    focused?: boolean;
+}
+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?: MapActionOrigin.map;
+}
+export interface UIRegisterDialogPayload {
+    type: DialogType;
+    mapId?: string;
+    setOpen?: boolean;
+    source?: Source;
+}
+export interface UIUnRegisterDialogPayload {
+    type: DialogType;
+}
+export interface UIToggleDialogPayload {
+    type: DialogType;
+    setOpen: boolean;
+    origin?: MapActionOrigin.map;
+    mapId?: 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 UISetDialogFocusedPayload {
+    type: DialogType;
+    focused: boolean;
+}
+export {};

package/src/store/utils.d.ts

@@ -0,0 +1,8 @@
+import { ServiceScope } from './mapStore/types';
+export declare const selectorMemoizationOptions: {
+    memoizeOptions: {
+        maxSize: number;
+        resultEqualityCheck: (value: any, other: any) => boolean;
+    };
+};
+export declare const isUserAddedService: (scope: ServiceScope) => boolean;