@equinor/echo-framework 0.21.6 → 0.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.21.6",
+  "version": "0.22.0",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.12.0 < 0.13.0",

package/src/index.d.ts

@@ -25,7 +25,6 @@ export * from './lib/feature/measuringPoint/index';
 export * from './lib/feature/measuringPoint/types/measuringPoint';
 export * from './lib/feature/openItemsIn3d';
 export { createEcho3dInternalLink } from './lib/feature/openItemsIn3d/logic/createEcho3dInternalLink';
-export { OpenIn3dSelectedItemsMenu } from './lib/feature/openItemsIn3d/OpenIn3dSelectedItemsMenu';
 export { WorkOrderContent } from './lib/feature/workOrder/WorkOrderContent';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useCloseActiveTopMenuAtBreakPoint } from './lib/hooks/useCloseActiveTopMenuAtBreakPoint';

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

@@ -59,7 +59,15 @@ export declare const globalSelectionApi: Readonly<{
          */
         listById: (args: {
             groupId: import("dist/libs/echo-utils/src").Guid;
-            categoryId?: GlobalSelectionCategoryId;
+            categoryId? /**
+             * Removes all items by their IDs, from all groups, from the state.
+             *
+             * If the given item ids are in more than one group, then a confirmation dialog will be shown to confirm the action.
+             *
+             * @param {Object} args - The arguments object.
+             * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - The array of item IDs to remove.
+             * @returns {void}
+             */: GlobalSelectionCategoryId;
         }) => void;
     }>;
     add: Readonly<{
@@ -98,9 +106,8 @@ export declare const globalSelectionApi: Readonly<{
          *
          */
         addItems: (args: {
-            groupId?: import("dist/libs/echo-utils/src").Guid;
             itemIds: GlobalSelectionTypes.ItemId[];
-        }) => void;
+        } & import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddByLabel) => void;
     }>;
     search: {
         /**

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

@@ -20,7 +20,7 @@ export declare const initialEquipmentList: GlobalSelectionTypes.EquipmentList;
  *
  * For accessing and using global selection features, use the globalSelectionApi from echo-framework.
  */
-export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<GlobalSelectionStore>, "setState"> & {
+export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<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;
@@ -32,6 +32,16 @@ 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

@@ -0,0 +1,8 @@
+import { PersistOptions } from 'zustand/middleware';
+import { GlobalSelectionStore } from './globalSelectionStore.types';
+declare function loadAndPopulateStoreMetadata(store: GlobalSelectionStore): Promise<void>;
+export declare const globalSelectionRepository: {
+    loadAndPopulateStoreMetadata: typeof loadAndPopulateStoreMetadata;
+    persistOptions: PersistOptions<GlobalSelectionStore, GlobalSelectionStore>;
+};
+export {};

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

@@ -21,17 +21,21 @@ type GlobalSelectionList<T extends GlobalSelectionItemType> = {
 export type GlobalSelectionObject = {
     [K in GlobalSelectionItemType]: GlobalSelectionList<K>;
 };
+export interface GlobalSelectionStoreData {
+    lists: GlobalSelectionObject;
+}
 export type SelectionItemSystemStatus = 'isLoading' | 'notFound' | 'loadedSuccessfully';
+export interface GlobalSelectionMetaData {
+    color: string;
+    isHiddenByUser: boolean;
+    errorStatus?: string;
+    systemStatus: SelectionItemSystemStatus;
+}
 type GlobalSelectionGenericItem<T extends GlobalSelectionItemType> = {
     id: GlobalSelectionTypes.ItemId;
     type: T;
     data: GlobalSelectionTypes.ItemTypeToDataMap[T];
-    metaData: {
-        color: string;
-        isHiddenByUser: boolean;
-        errorStatus?: string;
-        systemStatus: SelectionItemSystemStatus;
-    };
+    metaData: GlobalSelectionMetaData;
 };
 type EquipmentGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.Equipment>;
 type WorkOrderGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.WorkOrder>;
@@ -41,8 +45,7 @@ interface ItemErrorStatusUpdates {
     itemId: GlobalSelectionTypes.ItemId;
     errorStatus: string;
 }
-export interface GlobalSelectionStore {
-    lists: GlobalSelectionObject;
+export interface GlobalSelectionStore extends GlobalSelectionStoreData {
     addWorkOrdersToSelection: (args: {
         workOrderIds: GlobalSelectionTypes.WorkOrderId[];
     }) => Promise<GlobalSelectionAddItemResult<ResultArray<WorkOrderData>[]>>;
@@ -56,6 +59,10 @@ export interface GlobalSelectionStore {
         itemIds: Readonly<Readonly<GlobalSelectionTypes.ItemId>>[];
         isVisible: boolean;
     }) => void;
+    setItemMetaData: (args: ReadonlyArray<{
+        itemId: GlobalSelectionTypes.ItemId;
+        metaData: Partial<GlobalSelectionMetaData>;
+    }>) => void;
     resetItemErrorStatuses: () => void;
     resetState: () => void;
     setErrorStatusForItems: (args: {

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

@@ -1,15 +1,14 @@
 import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+import { SelectionBase } from '../selectionTree.store.types';
+export type AddByLabel = SelectionBase | {
+    label?: undefined;
+    subLabel?: undefined;
+};
 export type AddItemArgs<ItemIdType extends GlobalSelectionTypes.ItemId> = {
     itemIds: Readonly<ItemIdType[]>;
     replaceItems?: boolean;
     getActionResult?: boolean;
-} & ({
-    label: string;
-    subLabel: string;
-} | {
-    label?: undefined;
-    subLabel?: undefined;
-});
+} & AddByLabel;
 export type AddItemsResponse<FetchResponseType> = {
     fetchResults: FetchResponseType;
     actionResult: SelectionTreeActionResult;

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<import("zustand").StoreApi<SelectionTreeStore>, "setState"> & {
+export declare const useSelectionTreeStore: import("zustand").UseBoundStore<Omit<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,6 +11,16 @@ 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

@@ -0,0 +1,8 @@
+import { PersistOptions } from 'zustand/middleware';
+import { SelectionTreeStore } from './selectionTree.store.types';
+declare function loadAndPopulateStore(store: SelectionTreeStore): Promise<void>;
+export declare const selectionTreeRepository: {
+    loadAndPopulateStore: typeof loadAndPopulateStore;
+    persistOptions: PersistOptions<SelectionTreeStore, SelectionTreeStore>;
+};
+export {};

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

@@ -1,7 +1,7 @@
 import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
 import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionItemType, GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
-import { AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
+import { AddByLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
 export type SelectionItemTypeToItemIdMap = {
     [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
     [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
@@ -21,18 +21,31 @@ export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     id: SelectionItemTypeToItemIdMap[T];
     type: T;
 };
-interface SelectionBase {
+export interface SelectionBase {
     label: string;
-    subLabel?: string;
+    subLabel: string;
 }
-export interface SelectionCategory extends SelectionBase {
+export interface SelectionCategory {
     id: GlobalSelectionCategoryId;
+    label: string;
     items: Map<GlobalSelectionTypes.ItemIdString, SelectionTreeItem<GlobalSelectionItemType>>;
 }
+export interface PersistedSelectionCategory {
+    id: GlobalSelectionCategoryId;
+    label: string;
+    items: SelectionTreeItem<GlobalSelectionItemType>[];
+}
 export interface SelectionGroup extends SelectionBase {
     id: Guid;
     categories: SelectionCategory[];
 }
+export interface PersistedSelectionGroup extends SelectionBase {
+    id: Guid;
+    categories: PersistedSelectionCategory[];
+}
+export interface SelectionTreeData {
+    groups: SelectionGroup[];
+}
 export interface SelectionTreeStore {
     groups: SelectionGroup[];
     addTags: <T extends boolean | undefined = undefined>(args: AddItemArgs<GlobalSelectionTypes.TagId> & {
@@ -40,9 +53,8 @@ export interface SelectionTreeStore {
     }) => Promise<AddTagsReturnType<T>>;
     addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => void;
     addItems: (args: {
-        groupId?: Guid;
         itemIds: GlobalSelectionTypes.ItemId[];
-    }) => void;
+    } & AddByLabel) => void;
     createGroup: (args: {
         label: string;
         subLabel: string;
@@ -75,4 +87,3 @@ export declare namespace SelectionTreeTypes {
     type ActionResult = SelectionTreeActionResult;
 }
 export type AddTagsReturnType<T extends boolean | undefined = undefined> = T extends true ? AddItemsResponse<ResultArray<TagSummaryDto>[]> : ResultArray<TagSummaryDto>[];
-export {};

package/src/lib/feature/legend/legendStrategies/legendCollections.d.ts

@@ -1,4 +1,4 @@
 import { LegendStrategy } from '../types/legendStrategy.type';
 import { LegendState } from '../types/legendType';
-export declare function injectLegendStrategy(strategy: LegendStrategy, properties: Partial<LegendState>): void;
+export declare function injectLegendStrategy(strategy: LegendStrategy, initialValues: Partial<LegendState>): void;
 export declare function getLegendStrategy(strategyTypeName: string): LegendStrategy;

package/src/lib/feature/legend/logic/hiddenLegendChips.logic.d.ts

@@ -0,0 +1,6 @@
+import { Badge, Marker } from '../types/legendMarkerBadge.type';
+import { LegendId } from '../types/legendType';
+export declare function isHiddenMarker(marker: Marker, hiddenMarkers: ReadonlyArray<string>): boolean;
+export declare function setHiddenMarker(marker: Marker, isHidden: boolean, legendId: LegendId): void;
+export declare function isHiddenBadge(badge: Badge, hiddenBadges: ReadonlyArray<string>): boolean;
+export declare function setHiddenBadge(badge: Badge, isHidden: boolean, legendId: LegendId): void;

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

@@ -1,4 +1,3 @@
 export { tagIdPlantIdToPlantTagPairs } from './logic/convertToPlantTagPairs';
 export type { Plant3dInfo, PlantAndTagForOpenIn3d } from './logic/openItemsIn3d.utils';
-export { OpenIn3dSelectedItemsMenu } from './OpenIn3dSelectedItemsMenu';
 export { OpenItemsIn3dDialog } from './openItemsIn3dDialog';

package/src/lib/feature/openItemsIn3d/OpenIn3dSelectedItemsMenu.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-interface OpenIn3dSelectedItemsMenuProps {
-    onOpenIn3dButtonClick: () => void;
-    children?: React.ReactNode;
-    disabled?: boolean;
-}
-export declare const OpenIn3dSelectedItemsMenu: React.FC<OpenIn3dSelectedItemsMenuProps>;
-export {};

package/src/lib/feature/openItemsIn3d/openIn3dMenu.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-interface OpenIn3dMenuProps {
-    onOpenIn3dButtonClick: () => void;
-    disabled: boolean;
-}
-export declare const OpenIn3dMenu: React.FC<OpenIn3dMenuProps>;
-export {};