@equinor/echo-framework 0.26.11 → 1.1.0

package/package.json

@@ -1,31 +1,31 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.26.11",
+  "version": "1.1.0",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-components": ">= 0.26.10 < 0.27.0",
-    "@equinor/echo-core": ">= 0.26.9 < 0.27.0",
-    "@equinor/echo-search": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-utils": ">= 0.26.11 < 0.27.0",
+    "@equinor/echo-base": ">= 1.0.0 < 2.0.0",
+    "@equinor/echo-components": ">= 1.0.0 < 2.0.0",
+    "@equinor/echo-core": ">= 1.0.0 < 2.0.0",
+    "@equinor/echo-search": ">= 1.0.0 < 2.0.0",
+    "@equinor/echo-utils": ">= 1.1.0 < 2.0.0",
     "@equinor/eds-core-react": "0.43.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",
     "react-dom": ">= 17.0.2",
     "@tanstack/react-query": ">= 5.14.2 < 6",
-    "@microsoft/signalr": "8.0.7",
+    "@microsoft/signalr": "9.0.6",
     "classnames": "2.5.1",
     "history": "5.3.0",
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
     "zustand": ">= 4.4.7 < 5",
     "immer": "10.1.1",
-    "ag-charts-enterprise": "12.0.2"
+    "ag-charts-enterprise": "12.1.2"
   },
   "dependencies": {
-    "dexie": "4.0.11",
+    "dexie": "4.2.0",
     "mark.js": "8.11.1",
-    "ag-charts-community": "12.0.2",
-    "ag-charts-react": "12.0.2"
+    "ag-charts-community": "12.1.2",
+    "ag-charts-react": "12.1.2"
   },
   "main": "./index.cjs.js",
   "type": "commonjs",

package/src/index.d.ts

@@ -12,6 +12,7 @@ export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAcces
 export { WorkOrderListItem } from './lib/components/workOrderListItem';
 export type { WorkOrderListItemData } from './lib/components/workOrderListItem/types/types';
 export * from './lib/coreApplication';
+export { ReturnToExternalAppButton } from './lib/feature/echoView/ReturnToExternalAppButton';
 export { fetchEquipmentFromApi } from './lib/feature/equipment/api/api-equipmentWithMeasuringPoints';
 export * from './lib/feature/equipment/index';
 export * from './lib/feature/globalSelection';
@@ -20,6 +21,7 @@ export { PanTo3DButton } from './lib/feature/globalSelection/panToEcho3d/panTo3D
 export { useGlobalSelectionColorsSortedByFrequency } from './lib/feature/globalSelection/selectionMenu/hooks/useGlobalSelectionColorsSortedByFrequency';
 export { useIsAllIGlobalSelectionItemsHidden } from './lib/feature/globalSelection/selectionMenu/hooks/useIsAllIGlobalSelectionItemsHidden';
 export { GlobalSelectionCategoryId } from './lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.types';
+export { useSelectionTreeAutoSave } from './lib/feature/globalSelection/selectionMenu/selectionTreeStore/useSelectionTreeAutoSave';
 export * from './lib/feature/legacyLegend/index';
 export { PositionalLegendMarkers } from './lib/feature/legend/components/pdfMarkers/PositionalLegendMarkers';
 export { PopoverLoading } from './lib/feature/legend/components/pdfMarkers/subComponents/components/PopoverLoading';

package/src/lib/components/prepview/notification/details/DetailsNotification.d.ts

@@ -3,5 +3,5 @@ export interface Props {
     details: NotificationDetails;
     isLoading?: boolean;
 }
-declare function DetailsNotification({ details }: Props): JSX.Element;
+declare function DetailsNotification({ details }: Readonly<Props>): JSX.Element;
 export { DetailsNotification };

package/src/lib/feature/echoView/ReturnToExternalAppButton.d.ts

@@ -0,0 +1,6 @@
+/**
+ * When an user has entered the application through an echo view from another application,
+ * this button enables them to return to said application with the correct selectionId as
+ * an url parameter.
+ */
+export declare const ReturnToExternalAppButton: () => import("react/jsx-runtime").JSX.Element | undefined;

package/src/lib/feature/globalSelection/globalSelection.api.d.ts

@@ -111,7 +111,7 @@ export declare const globalSelectionApi: Readonly<{
         addItems: (args: {
             itemIds: GlobalSelectionTypes.ItemId[];
             groupId?: import("@equinor/echo-utils").Guid;
-        } & import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddByGroupIdAndLabel) => void;
+        } & import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddByGroupIdAndLabel) => Promise<void>;
     }>;
     search: {
         /**

package/src/lib/feature/globalSelection/globalSelection.internal.d.ts

@@ -1,8 +1,12 @@
+import { Guid } from '@equinor/echo-utils';
+import { deleteSelectionId, fetchUserSelectionIds } from './selectionMenu/selectionTreeStore/api/selectionTree.api';
 /**
  * Internal that should only be used by echopedia
  */
 export declare const globalSelectionInternal: Readonly<{
     loadFromApi: typeof loadFromApi;
+    deleteSelectionId: typeof deleteSelectionId;
+    fetchUserSelectionIds: typeof fetchUserSelectionIds;
 }>;
-declare function loadFromApi(idToLoad: string): Promise<void>;
+declare function loadFromApi(idToLoad: Guid): Promise<void>;
 export {};

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionSaveState.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Loading state that tells if saving to api is enabled
+ */
+export declare function isGlobalSelectionSaveEnabled(): boolean;
+/**
+ * Loading state that tells if saving to api is enabled
+ * Always set this in a `try / finally`, to avoid infinite loading state
+ */
+export declare function setGlobalSelectionSaveEnabled(isEnabled: boolean): void;

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.d.ts

@@ -21,7 +21,7 @@ export declare const initialMeasuringPointList: GlobalSelectionTypes.MeasuringPo
  *
  * For accessing and using global selection features, use the globalSelectionApi from echo-framework.
  */
-export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<Omit<import("zustand").StoreApi<GlobalSelectionStore>, "setState"> & {
+export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<GlobalSelectionStore>, "setState"> & {
     setState<A extends string | {
         type: string;
     }>(partial: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: GlobalSelectionStore) => GlobalSelectionStore | Partial<GlobalSelectionStore>), replace?: boolean | undefined, action?: A | undefined): void;
@@ -33,16 +33,6 @@ export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Om
             fireImmediately?: boolean;
         } | undefined): () => void;
     };
-}, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<GlobalSelectionStore, GlobalSelectionStore>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => Promise<void> | void;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: GlobalSelectionStore) => void) => () => void;
-        onFinishHydration: (fn: (state: GlobalSelectionStore) => void) => () => void;
-        getOptions: () => Partial<import("zustand/middleware").PersistOptions<GlobalSelectionStore, GlobalSelectionStore>>;
-    };
 }, "setState"> & {
     setState(nextStateOrUpdater: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: import("immer").WritableDraft<GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.repository.d.ts

@@ -1,11 +1,7 @@
-import { PersistOptions } from 'zustand/middleware';
-import { PersistedSelectionGroup } from '../selectionMenu/selectionTreeStore/selectionTree.store.types';
+import { ApiSelectionGroup } from '../selectionMenu/selectionTreeStore/selectionTree.api.types';
 import { GlobalSelectionStore } from './globalSelectionStore.types';
-declare function loadAndPopulateStoreMetadataFromDisk(store: GlobalSelectionStore): Promise<void>;
-declare function loadAndPopulateStoreMetadataFromApi(store: GlobalSelectionStore, data: PersistedSelectionGroup[]): Promise<void>;
+declare function loadAndPopulateStoreMetadataFromApi(store: GlobalSelectionStore, data: ApiSelectionGroup[]): Promise<void>;
 export declare const globalSelectionRepository: {
-    loadAndPopulateStoreMetadataFromDisk: typeof loadAndPopulateStoreMetadataFromDisk;
     loadAndPopulateStoreMetadataFromApi: typeof loadAndPopulateStoreMetadataFromApi;
-    persistOptions: PersistOptions<GlobalSelectionStore, GlobalSelectionStore>;
 };
 export {};

package/src/lib/feature/globalSelection/index.d.ts

@@ -8,6 +8,7 @@ export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
 export { useGlobalSelectionTags } from './hooks/useGlobalSelectionTags';
 export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';
 export { useSelectionCategoriesByGroupId } from './hooks/useSelectionCategoriesByGroupId';
+export { useCurrentSelectionId } from './selectionMenu/hooks/useCurrentSelectionId';
 export { useGlobalSelectionGroups } from './selectionMenu/hooks/useGlobalSelectionGroups';
 export { useMoveSelectionTreeItems } from './selectionMenu/hooks/useMoveSelectionTreeItems';
 export { loadEchoViewIdAndSelectionIdFromUrl } from '../../services/echoViewService/loadEchoViewIdAndSelectionIdFromUrl';

package/src/lib/feature/globalSelection/selectionLogOptions.d.ts

@@ -0,0 +1,5 @@
+export declare const SelectionLogOptions: Readonly<{
+    addItemsIsLogEnabled: false;
+    saveToApiIsLogEnabled: false;
+    loadFromApiIsLogEnabled: false;
+}>;

package/src/lib/feature/globalSelection/selectionMenu/hooks/useCurrentSelectionId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns current selection id that is active in the selection tree.
+ */
+export declare function useCurrentSelectionId(): import("@equinor/echo-utils").Guid | undefined;

package/src/lib/feature/globalSelection/selectionMenu/hooks/useGlobalSelectionColorsSortedByFrequency.d.ts

@@ -1,2 +1,10 @@
 import { SelectionTreeTypes } from '../selectionTreeStore/selectionTree.store.types';
+/**
+ * Returns a list of colors sorted by frequency from the given categories.
+ * This hook is optimized to only recalculate when the items in the global selection store
+ * that match the given categories change their colors.
+ *
+ * @param categories - The categories to get colors from
+ * @returns An array of colors sorted by frequency
+ */
 export declare function useGlobalSelectionColorsSortedByFrequency(categories: SelectionTreeTypes.Category[]): string[];

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/api/selectionTree.api.d.ts

@@ -1,7 +1,9 @@
-import { PersistedSelectionGroup } from '../selectionTree.store.types';
-export declare function fetchSelectionTreeById(id: string): Promise<PersistedSelectionTreeDto | undefined>;
-interface PersistedSelectionTreeDto {
-    readonly id: string;
-    readonly data: PersistedSelectionGroup[];
-}
-export {};
+import { Guid } from '@equinor/echo-utils';
+import { ApiSelectionTreeRoot } from '../selectionTree.api.types';
+import { SelectionGroup } from '../selectionTree.store.types';
+export declare function saveSelectionTreeToApi(id: string | undefined, data: {
+    data: SelectionGroup[];
+}): Promise<void>;
+export declare function fetchSelectionTreeById(id: string): Promise<ApiSelectionTreeRoot | undefined>;
+export declare function fetchUserSelectionIds(): Promise<Guid[]>;
+export declare function deleteSelectionId(id: string): Promise<void>;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/currentSelectionId.repository.d.ts

@@ -0,0 +1,10 @@
+import { Guid } from '@equinor/echo-utils';
+declare function setCurrentSelectionId(id: Guid): void;
+declare function getCurrentSelectionId(): Guid | undefined;
+declare function clearCurrentSelectionId(): void;
+export declare const currentSelectionIdRepository: Readonly<{
+    set: typeof setCurrentSelectionId;
+    get: typeof getCurrentSelectionId;
+    clear: typeof clearCurrentSelectionId;
+}>;
+export {};

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/legacyPersistedSelection.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file loads the old data saved to disk. New approach is to instead save and load it from the api.
+ *
+ * This file can be deleted after a few months, when we expect all the users to have migrated this old data.
+ *
+ * Keep the rest of the code private, so we easily can delete this
+ */
+export declare const legacyPersistedSelection: {
+    loadFromDisk: typeof loadLegacyDataFromDiskAndPopulateStore;
+    deleteFromDisk: typeof deleteFromDisk;
+};
+declare function deleteFromDisk(): Promise<void>;
+declare function loadLegacyDataFromDiskAndPopulateStore(): Promise<boolean>;
+export {};

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.api.types.d.ts

@@ -0,0 +1,29 @@
+import { Guid } from '@equinor/echo-utils';
+import { GlobalSelectionItemType, GlobalSelectionMetaData, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
+export type ApiSelectionTreeItemId = SelectionItemTypeToItemIdMap[GlobalSelectionItemType];
+export type ApiGlobalSelectionMetaData = Partial<Pick<GlobalSelectionMetaData, 'color' | 'isHiddenByUser'>>;
+export interface ApiSelectionTreeRoot {
+    id?: Guid;
+    data: ApiSelectionGroup[];
+    versionNo?: string;
+    /**
+     * Short is used by 3rd party apps, it should not be visible/selectable by user
+     * Long will show up in recent sessions in UI.
+     */
+    lifetime: 'Short' | 'Long';
+}
+export interface ApiSelectionGroup {
+    readonly groupId: Guid;
+    readonly label: string;
+    readonly subLabel: string;
+    readonly categories: ApiSelectionCategory[];
+}
+export interface ApiSelectionCategory {
+    readonly items: ApiSelectionTreeItem[];
+}
+export interface ApiSelectionTreeItem {
+    readonly type: GlobalSelectionItemType;
+    readonly id: ApiSelectionTreeItemId;
+    readonly metaData?: ApiGlobalSelectionMetaData;
+}
+export declare function cleanApiSelectionTreeRoot(root: ApiSelectionTreeRoot): ApiSelectionTreeRoot;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.d.ts

@@ -1,5 +1,5 @@
 import { SelectionTreeStore } from './selectionTree.store.types';
-export declare const useSelectionTreeStore: import("zustand").UseBoundStore<Omit<Omit<Omit<Omit<import("zustand").StoreApi<SelectionTreeStore>, "setState"> & {
+export declare const useSelectionTreeStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<SelectionTreeStore>, "setState"> & {
     setState<A extends string | {
         type: string;
     }>(partial: SelectionTreeStore | Partial<SelectionTreeStore> | ((state: SelectionTreeStore) => SelectionTreeStore | Partial<SelectionTreeStore>), replace?: boolean | undefined, action?: A | undefined): void;
@@ -11,16 +11,6 @@ export declare const useSelectionTreeStore: import("zustand").UseBoundStore<Omit
             fireImmediately?: boolean;
         } | undefined): () => void;
     };
-}, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<SelectionTreeStore, SelectionTreeStore>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => Promise<void> | void;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: SelectionTreeStore) => void) => () => void;
-        onFinishHydration: (fn: (state: SelectionTreeStore) => void) => () => void;
-        getOptions: () => Partial<import("zustand/middleware").PersistOptions<SelectionTreeStore, SelectionTreeStore>>;
-    };
 }, "setState"> & {
     setState(nextStateOrUpdater: SelectionTreeStore | Partial<SelectionTreeStore> | ((state: import("immer").WritableDraft<SelectionTreeStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.repository.d.ts

@@ -1,10 +1,5 @@
-import { PersistOptions } from 'zustand/middleware';
-import { SelectionTreeStore } from './selectionTree.store.types';
-declare function loadAndPopulateStoreFromDisk(store: SelectionTreeStore): Promise<void>;
-declare function loadAndPopulateStoreFromApi(store: SelectionTreeStore, idToLoad: string): Promise<void>;
+import { Guid } from '@equinor/echo-utils';
+export declare function loadAndPopulateStoreFromApi(idToLoad: Guid): Promise<void>;
 export declare const selectionTreeRepository: {
-    loadAndPopulateStoreFromDisk: typeof loadAndPopulateStoreFromDisk;
     loadAndPopulateStoreFromApi: typeof loadAndPopulateStoreFromApi;
-    persistOptions: PersistOptions<SelectionTreeStore, SelectionTreeStore>;
 };
-export {};

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.types.d.ts

@@ -1,5 +1,5 @@
 import { Guid } from '@equinor/echo-utils';
-import { GlobalSelectionItemType, GlobalSelectionTypes, PersistedGlobalSelectionMetaData, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
 import { AddByGroupIdAndLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
@@ -12,11 +12,6 @@ export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     readonly id: SelectionItemTypeToItemIdMap[T];
     readonly type: T;
 };
-export type PersistedSelectionTreeItem<T extends GlobalSelectionItemType> = {
-    readonly id: SelectionItemTypeToItemIdMap[T];
-    readonly type: T;
-    readonly metaData: PersistedGlobalSelectionMetaData;
-};
 export interface SelectionBase {
     readonly groupId: Guid;
     readonly label: string;
@@ -27,26 +22,19 @@ export interface SelectionCategory {
     readonly label: string;
     items: Map<GlobalSelectionTypes.ItemIdString, SelectionTreeItem<GlobalSelectionItemType>>;
 }
-export interface PersistedSelectionCategory {
-    readonly id: GlobalSelectionCategoryId;
-    readonly label: string;
-    readonly items: PersistedSelectionTreeItem<GlobalSelectionItemType>[];
-}
 export interface SelectionGroup extends SelectionBase {
     readonly categories: SelectionCategory[];
 }
-export interface PersistedSelectionGroup extends SelectionBase {
-    readonly categories: PersistedSelectionCategory[];
-}
 export interface SelectionTreeData {
+    currentSelectionId?: Guid;
     readonly groups: SelectionGroup[];
 }
-export interface SelectionTreeStore {
-    groups: SelectionGroup[];
+export interface SelectionTreeStore extends SelectionTreeData {
+    setCurrentSelectionId: (id: Guid) => void;
     addItems: (args: {
         itemIds: GlobalSelectionTypes.ItemId[];
         groupId?: Guid;
-    } & AddByGroupIdAndLabel) => void;
+    } & AddByGroupIdAndLabel) => Promise<void>;
     addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => AddTagsReturnType;
     addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => AddWorkOrdersReturnType;
     addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => AddEquipmentsReturnType;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/useSelectionTreeAutoSave.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Auto saves if the selection tree or global selection change by: Add/remove/rename items/groups, or metadata.color/isHiddenByUser
+ * Ignores saving if only data object changes, or metadata.error/status
+ */
+export declare function useSelectionTreeAutoSave(): void;

package/src/lib/feature/legend/components/pdfMarkers/subComponents/LegendColoredMarkerIcon.d.ts

@@ -1,3 +1,4 @@
+import { ItemMarkerSize } from '@equinor/echo-components';
 import React from 'react';
 import { LegendDataId, LegendId } from '../../../types/legendType';
 interface LegendColoredMarkerIconProps {
@@ -8,4 +9,5 @@ interface LegendColoredMarkerIconProps {
     onClick: () => void;
 }
 export declare const MemoizedLegendColoredMarkerIcon: React.NamedExoticComponent<LegendColoredMarkerIconProps>;
+export declare const MARKER_ICON_WIDTH = ItemMarkerSize.Default;
 export {};

package/src/lib/feature/legend/components/popover/LegendPopoverContent.logic.d.ts

@@ -1,5 +1,5 @@
-import { LegendChipProps } from "@equinor/echo-components";
-import { LegendState } from "../../types/legendType";
+import { LegendChipProps } from '@equinor/echo-components';
+import { LegendState } from '../../types/legendType';
 import { Marker } from './../../types/legendMarkerBadge.type';
 /**
  * Returns an array of visible LegendChipProps for the given markers and legend state.
@@ -13,7 +13,7 @@ import { Marker } from './../../types/legendMarkerBadge.type';
  * @param {ReadonlyArray<string>} [params.excludedLegendTitles] - Optional array of titles to exclude from the chips (case-insensitive).
  * @returns {LegendChipProps[]} The filtered and mapped array of LegendChipProps for rendering.
  */
-export declare function getVisibleLegendChips({ markers, legend, excludedLegendTitles, }: {
+export declare function getVisibleLegendChips({ markers, legend, excludedLegendTitles }: {
     markers: ReadonlyArray<Marker>;
     legend: LegendState;
     excludedLegendTitles?: ReadonlyArray<string>;

package/src/lib/feature/legend/index.d.ts

@@ -7,4 +7,4 @@ export type { LegendPopoverContentProps, LegendPopoverTertiaryLabels } from './c
 export { legendFacade } from './legendFacade';
 export type { Badge, Marker } from './types/legendMarkerBadge.type';
 export type { LegendStrategy } from './types/legendStrategy.type';
-export type { LegendId } from './types/legendType';
+export type { LegendId, LegendOptionConfig } from './types/legendType';

package/src/lib/feature/legend/legendStore.d.ts

@@ -21,6 +21,10 @@ export interface LegendStoreActions {
     getLegendById: (legendId: LegendId) => LegendState | undefined;
 }
 type LegendStore = LegendStoreData & LegendStoreActions;
+type PersistedLegendState = Omit<LegendState, 'isLoading' | 'hiddenMarkers' | 'hiddenBadges'>;
+type PersistedLegendStoreData = {
+    legends: Record<LegendId, PersistedLegendState>;
+};
 export declare const useLegendStore: import("zustand").UseBoundStore<Omit<Omit<Omit<Omit<import("zustand").StoreApi<LegendStore>, "setState"> & {
     setState<A extends string | {
         type: string;
@@ -35,13 +39,13 @@ export declare const useLegendStore: import("zustand").UseBoundStore<Omit<Omit<O
     };
 }, "persist"> & {
     persist: {
-        setOptions: (options: Partial<PersistOptions<LegendStore, LegendStore>>) => void;
+        setOptions: (options: Partial<PersistOptions<LegendStore, PersistedLegendStoreData>>) => void;
         clearStorage: () => void;
         rehydrate: () => Promise<void> | void;
         hasHydrated: () => boolean;
         onHydrate: (fn: (state: LegendStore) => void) => () => void;
         onFinishHydration: (fn: (state: LegendStore) => void) => () => void;
-        getOptions: () => Partial<PersistOptions<LegendStore, LegendStore>>;
+        getOptions: () => Partial<PersistOptions<LegendStore, PersistedLegendStoreData>>;
     };
 }, "setState"> & {
     setState(nextStateOrUpdater: LegendStore | Partial<LegendStore> | ((state: import("immer").WritableDraft<LegendStore>) => void), shouldReplace?: boolean | undefined, action?: string | {

package/src/lib/feature/legend/types/legendMarkerBadge.type.d.ts

@@ -2,9 +2,10 @@ export interface Marker {
     getTitle: () => string;
     getColor: () => string;
     getIcon: () => string;
+    getMarkerKey: () => string;
     badges: Badge[];
+    showAsPlainLabel?: boolean;
 }
-export declare function markerKey(marker: Marker): string;
 export interface Badge {
     getColor: () => string;
     getTitle: () => string;

package/src/lib/feature/legend/types/legendStrategy.type.d.ts

@@ -1,5 +1,5 @@
 import { Marker } from './legendMarkerBadge.type';
-import { LegendDataId, LegendId } from './legendType';
+import { LegendDataId, LegendId, LegendOptionConfig } from './legendType';
 /**
  * A general interface for the legend strategy. This enables us to automatically render all the legend ui parts: the ui with selectable options, the markers & the badges.
  * The specific implementation (like tagStrategy, equipmentStrategy, etc) will implement this, and inject it with legendFacade.injectLegendStrategy.
@@ -12,11 +12,11 @@ export interface LegendStrategy {
     /**
      * Marker options that is selectable by the user.
      */
-    markerOptions?: ReadonlyArray<string>;
+    markerOptions?: ReadonlyArray<LegendOptionConfig>;
     /**
      * Badge options that is selectable by the user.
      */
-    badgeOptions?: ReadonlyArray<string>;
+    badgeOptions?: ReadonlyArray<LegendOptionConfig>;
     /**
      * Returns ONE marker per itemId.
      */

package/src/lib/feature/legend/types/legendType.d.ts

@@ -15,12 +15,24 @@ export interface LegendState {
     isLoading: boolean;
     hiddenMarkers: string[];
     hiddenBadges: string[];
-    selectedMarkerOption: string;
-    selectedBadgeOption: string;
+    selectedMarkerOption: LegendOptionConfig;
+    selectedBadgeOption: LegendOptionConfig;
     isExpanded: boolean;
 }
 export type LegendTagId = GlobalSelectionTypes.TagId;
 export type LegendEquipmentId = GlobalSelectionTypes.EquipmentId;
 export type LegendWorkOrderId = GlobalSelectionTypes.WorkOrderId;
 export type LegendDataId = LegendTagId | LegendEquipmentId | LegendWorkOrderId;
+export interface LegendOptionConfig<T = string> {
+    propertyName: T;
+    /**
+     * The idea with this is to use it with general rules for strategies US.
+     * Indicates whether the propertyName corresponds to a field in an object structure.
+     * When true, propertyName refers to an actual field in a data object.
+     * When false, propertyName is just a string identifier not tied to object fields.
+     * Comment it in when it is needed.
+     */
+    displayName: string;
+    showChipsInViewportOnly?: boolean;
+}
 export {};

package/src/lib/services/echoViewService/echoView.type.d.ts

@@ -4,7 +4,7 @@ export interface EchoViewBaseItem {
 }
 export interface EchoView extends EchoViewBaseItem {
     readonly owner: string;
-    readonly selectionId: string | undefined;
+    readonly selectionId: Guid | undefined;
     readonly instCode: string | undefined;
     readonly tagNo: string | undefined;
     readonly search: string | undefined;
@@ -14,6 +14,12 @@ export interface EchoView extends EchoViewBaseItem {
     readonly ecmPdfInspectionTool: EchoViewEcmPdfInspectionToolConfig | undefined;
     readonly echo3D: Record<string, unknown> | undefined;
     readonly version: string;
+    readonly returnToApp: EchoViewReturnToApp | undefined;
+}
+export interface EchoViewReturnToApp {
+    readonly callbackUrl: string | undefined;
+    readonly returnButtonTextSuffix: string | undefined;
+    readonly returnButtonTextOverride: string | undefined;
 }
 export interface EchoViewSyncSettings {
     readonly enablePunches: boolean | undefined;

package/src/lib/services/echoViewService/echoViewService.d.ts

@@ -1,3 +1,4 @@
 import { EchoView } from './echoView.type';
 export declare function setEchoView(echoView: EchoView): void;
+export declare function clearEchoView(): void;
 export declare function echoViewService(): EchoView | undefined;