@equinor/echo-framework 0.21.4 → 0.21.6

package/package.json

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

package/src/lib/coreApplication/EchoContent.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 interface CorePanelsProps {
     children: React.ReactNode;
     Legend: React.FC | null | undefined;
+    isOnboardingCompleted: boolean;
 }
 export declare const EchoContent: React.FC<CorePanelsProps>;
 export {};

package/src/lib/feature/globalSelection/globalSelectionStore/actions/addItemsToSelection.action.d.ts

@@ -1,5 +1,4 @@
 import { ResultArray } from '@equinor/echo-search';
-import { WritableDraft } from 'immer';
 import { StoreApi } from 'zustand';
 import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionStore, GlobalSelectionTypes } from '../globalSelectionStore.types';
 type FetchFunction<T, U> = (itemIds: Readonly<U[]>) => Promise<ResultArray<T>[]>;
@@ -9,7 +8,7 @@ type ItemIdTypeMap = {
     [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
     [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
 };
-type SetFunction = (set: (state: WritableDraft<GlobalSelectionStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void;
+type SetFunction = (set: (state: GlobalSelectionStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 export declare function addItemsToSelection<T extends GlobalSelectionItemType>(set: SetFunction, get: StoreApi<GlobalSelectionStore>['getState'], args: {
     itemIds: ItemIdTypeMap[T][];
 }, itemType: T, fetchFunction: FetchFunction<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>, nullItemGenerator: NullItemGenerator<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>): Promise<{

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

@@ -1,8 +1,7 @@
-import { WritableDraft } from 'immer';
 import { GlobalSelectionStore, GlobalSelectionTypes } from './globalSelectionStore.types';
-export declare const initialWorkOrderList: WritableDraft<GlobalSelectionTypes.WorkOrderList>;
-export declare const initialTagList: WritableDraft<GlobalSelectionTypes.TagList>;
-export declare const initialEquipmentList: WritableDraft<GlobalSelectionTypes.EquipmentList>;
+export declare const initialWorkOrderList: GlobalSelectionTypes.WorkOrderList;
+export declare const initialTagList: GlobalSelectionTypes.TagList;
+export declare const initialEquipmentList: GlobalSelectionTypes.EquipmentList;
 /**
  * The single source of truth for items stored in Global Selection.
  * Each item is stored here once, does not store item grouping in any way.
@@ -34,7 +33,7 @@ export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Om
         } | undefined): () => void;
     };
 }, "setState"> & {
-    setState(nextStateOrUpdater: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: WritableDraft<GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
+    setState(nextStateOrUpdater: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: import("immer").WritableDraft<GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;
     } | undefined): void;
 }>;

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

@@ -1,13 +1,11 @@
 import { ResultArray, TagSummaryDto, WorkOrderData } from '@equinor/echo-search';
+import { Brand } from '@equinor/echo-utils';
 import { Equipment } from '../../equipment';
 export declare enum GlobalSelectionItemType {
     WorkOrder = "WorkOrder",
     Tag = "Tag",
     Equipment = "Equipment"
 }
-export type DeepWritable<T> = {
-    -readonly [P in keyof T]: DeepWritable<T[P]>;
-};
 type GlobalSelectionTagDto = TagSummaryDto;
 type GlobalSelectionWorkOrderDto = WorkOrderData;
 export interface GlobalSelectionItemTypeToDataMap {
@@ -18,8 +16,7 @@ export interface GlobalSelectionItemTypeToDataMap {
 type GlobalSelectionList<T extends GlobalSelectionItemType> = {
     label: string;
     type: T;
-    items: GlobalSelectionTypes.GenericItem<T>[];
-    itemsBeingLoaded: GlobalSelectionTypes.ItemId[];
+    items: Map<GlobalSelectionTypes.ItemIdString, GlobalSelectionTypes.GenericItem<T>>;
 };
 export type GlobalSelectionObject = {
     [K in GlobalSelectionItemType]: GlobalSelectionList<K>;
@@ -78,6 +75,7 @@ export declare namespace GlobalSelectionTypes {
     type EquipmentId = Pick<Equipment, 'equipmentId'>;
     type TagId = Pick<TagSummaryDto, 'tagNo' | 'instCode'>;
     type ItemId = WorkOrderId | EquipmentId | TagId;
+    type ItemIdString = Brand<string, 'ItemIdString'>;
     type TagDto = GlobalSelectionTagDto;
     type WorkOrderDto = GlobalSelectionWorkOrderDto;
     type EquipmentItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;

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

@@ -29,7 +29,7 @@ declare function mapToId(item: GlobalSelectionTypes.WorkOrderId): GlobalSelectio
 declare function mapToId(item: GlobalSelectionTypes.EquipmentId): GlobalSelectionTypes.EquipmentId;
 declare function mapToId(item: GlobalSelectionTypes.TagId): GlobalSelectionTypes.TagId;
 declare function mapToId(item: GlobalSelectionTypes.ItemId): GlobalSelectionTypes.ItemId;
-declare function itemIdToString(itemId: GlobalSelectionTypes.ItemId): string;
+declare function itemIdToString(itemId: GlobalSelectionTypes.ItemId): GlobalSelectionTypes.ItemIdString;
 export declare function mapIdToItemType(itemId: GlobalSelectionTypes.ItemId): GlobalSelectionItemType;
 /**
  * A utility object that provides various functions for handling global selections.

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

@@ -1,6 +1,5 @@
-import { WritableDraft } from 'immer';
 import { PlantAndTagForOpenIn3d } from '../../openItemsIn3d/logic/openItemsIn3d.utils';
-import { DeepWritable, GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemSystemStatus } from './globalSelectionStore.types';
+import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemSystemStatus } from './globalSelectionStore.types';
 /**
  * Converts global selection items to plant tag pairs.
  *
@@ -18,11 +17,11 @@ export declare function toGlobalSelectionItem<T extends GlobalSelectionTypes.Ite
 export declare function toGlobalSelectionItems<T extends GlobalSelectionTypes.ItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K, systemStatus: SelectionItemSystemStatus): GlobalSelectionTypes.GenericItem<K>[];
 export declare function finalizeLoadStateByItemType<T extends GlobalSelectionItemType>(args: {
     itemType: GlobalSelectionItemType;
-    state: WritableDraft<GlobalSelectionTypes.Store>;
-    itemDataToStore: DeepWritable<GlobalSelectionTypes.ItemTypeToDataMap[T]>[];
+    state: GlobalSelectionTypes.Store;
+    itemDataToStore: GlobalSelectionTypes.ItemTypeToDataMap[T][];
 }): void;
 export declare function setNotFoundStatusByItemIds(args: {
     itemType: GlobalSelectionItemType;
-    state: WritableDraft<GlobalSelectionTypes.Store>;
+    state: GlobalSelectionTypes.Store;
     notFoundItemIds: GlobalSelectionTypes.ItemId[];
 }): void;

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionByItemId.d.ts

@@ -0,0 +1,2 @@
+import { GlobalSelectionItemType, GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
+export declare function useGlobalSelectionByItemId<T extends GlobalSelectionItemType>(itemType: T, itemId: GlobalSelectionTypes.ItemId): GlobalSelectionTypes.GenericItem<T> | undefined;

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionLists.d.ts

@@ -1,19 +1,8 @@
 /**
  * Hook for returning all lists stored in the global selection.
  */
-export declare function useGlobalSelectionLists(): ({
+export declare function useGlobalSelectionLists(): {
     label: string;
-    type: import("..").GlobalSelectionItemType.WorkOrder;
-    items: import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.WorkOrder>[];
-    itemsBeingLoaded: import("..").GlobalSelectionTypes.ItemId[];
-} | {
-    label: string;
-    type: import("..").GlobalSelectionItemType.Tag;
-    items: import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.Tag>[];
-    itemsBeingLoaded: import("..").GlobalSelectionTypes.ItemId[];
-} | {
-    label: string;
-    type: import("..").GlobalSelectionItemType.Equipment;
-    items: import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.Equipment>[];
-    itemsBeingLoaded: import("..").GlobalSelectionTypes.ItemId[];
-})[];
+    type: import("..").GlobalSelectionItemType;
+    items: (import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.WorkOrder> | import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.Tag> | import("..").GlobalSelectionTypes.GenericItem<import("..").GlobalSelectionItemType.Equipment>)[];
+}[];

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

@@ -3,6 +3,7 @@ export { globalSelectionApi } from './globalSelection.api';
 export * from './globalSelectionStore/globalSelectionStore.types';
 export { globalSelectionUtils } from './globalSelectionStore/globalSelectionStore.utils';
 export { convertGlobalSelectionItemsToPlantTagPairs } from './globalSelectionStore/globalSelectionStoreHelpers';
+export { useGlobalSelectionByItemId } from './hooks/useGlobalSelectionByItemId';
 export { useGlobalSelectionItems } from './hooks/useGlobalSelectionItems';
 export { useGlobalSelectionItemsByType } from './hooks/useGlobalSelectionItemsByType';
 export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';

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

@@ -1,5 +1,5 @@
 import { Guid } from '@equinor/echo-utils';
-interface useIsAllIGlobalSelectionItemsHiddenArgs {
+interface UseIsAllIGlobalSelectionItemsHiddenArgs {
     groupId: Guid;
     categoryId?: string;
 }
@@ -15,5 +15,5 @@ interface useIsAllIGlobalSelectionItemsHiddenArgs {
  *
  * The hook returns `true` if all items in the list are hidden by the user, and `false` otherwise.
  */
-export declare const useIsAllIGlobalSelectionItemsHidden: (args: useIsAllIGlobalSelectionItemsHiddenArgs) => boolean;
+export declare const useIsAllIGlobalSelectionItemsHidden: (args: UseIsAllIGlobalSelectionItemsHiddenArgs) => boolean;
 export {};

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

@@ -1,10 +1,9 @@
 import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
-import { WritableDraft } from 'immer';
 import { StoreApi } from 'zustand';
 import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { SelectionTreeStore } from '../selectionTree.store.types';
 import { AddItemArgs, AddItemsResponse } from './selectionTree.action.types';
-type SetFunction = (set: (state: WritableDraft<SelectionTreeStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void;
+type SetFunction = (set: (state: SelectionTreeStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 export declare function addTagsAction(set: SetFunction, get: StoreApi<SelectionTreeStore>['getState'], args: AddItemArgs<GlobalSelectionTypes.TagId> & {
     getActionResult: true;
 }): Promise<AddItemsResponse<ResultArray<TagSummaryDto>[]>>;

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

@@ -1,6 +1,6 @@
 import { WorkOrderData } from '@equinor/echo-search';
 import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
-export declare const addWorkOrdersAction: (set: (set: (state: import("immer").WritableDraft<import("../selectionTree.store.types").SelectionTreeStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void, get: import("zustand").StoreApi<import("../selectionTree.store.types").SelectionTreeStore>["getState"], args: import("./selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<import("@equinor/echo-search").ResultArray<unknown>[]> | {
+export declare const addWorkOrdersAction: (set: (set: (state: import("../selectionTree.store.types").SelectionTreeStore) => void, shouldReplace?: boolean | undefined, action?: string) => void, get: import("zustand").StoreApi<import("../selectionTree.store.types").SelectionTreeStore>["getState"], args: import("./selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<import("@equinor/echo-search").ResultArray<unknown>[]> | {
     fetchResults: import("@equinor/echo-search").ResultArray<WorkOrderData>[][];
     actionResult: string;
 }>;

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/actions/createAddItemsFactory.d.ts

@@ -1,10 +1,9 @@
 import { ResultArray } from '@equinor/echo-search';
-import { WritableDraft } from 'immer';
 import { StoreApi } from 'zustand';
 import { GlobalSelectionAddItemResult, GlobalSelectionItemType, GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { GlobalSelectionCategoryId, SelectionTreeStore } from '../selectionTree.store.types';
 import { AddItemArgs, AddItemsResponse } from './selectionTree.action.types';
-type SetFunction = (set: (state: WritableDraft<SelectionTreeStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void;
+type SetFunction = (set: (state: SelectionTreeStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 export declare function addItemsActionFactory<G_ItemId extends GlobalSelectionTypes.ItemId, G_ResponseData>(args: {
     addItemToGlobalSelection: (uniqueNewItems: G_ItemId[]) => Promise<GlobalSelectionAddItemResult<ResultArray<G_ResponseData>[]>>;
     itemType: GlobalSelectionItemType;

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

@@ -1,7 +1,6 @@
-import { WritableDraft } from 'immer';
 import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { SelectionTreeStore } from '../selectionTree.store.types';
-type SetFunction = (set: (state: WritableDraft<SelectionTreeStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void;
+type SetFunction = (set: (state: SelectionTreeStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 /**
  * Removes all items by their IDs, from all groups, from the state.
  *

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

@@ -17,7 +17,7 @@ export declare enum SelectionMenuDefaultListIds {
     TagList = "DEFAULT_TAG_LIST_ID",
     WorkOrderList = "DEFAULT_WORK_ORDER_LIST_ID"
 }
-type SelectionItem<T extends GlobalSelectionItemType> = {
+export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     id: SelectionItemTypeToItemIdMap[T];
     type: T;
 };
@@ -27,7 +27,7 @@ interface SelectionBase {
 }
 export interface SelectionCategory extends SelectionBase {
     id: GlobalSelectionCategoryId;
-    items: SelectionItem<GlobalSelectionItemType>[];
+    items: Map<GlobalSelectionTypes.ItemIdString, SelectionTreeItem<GlobalSelectionItemType>>;
 }
 export interface SelectionGroup extends SelectionBase {
     id: Guid;

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

@@ -1,5 +1,4 @@
 import { Guid } from '@equinor/echo-utils';
-import { WritableDraft } from 'immer';
 import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
 import { GlobalSelectionCategoryId, SelectionTreeTypes } from './selectionTree.store.types';
 /**
@@ -81,11 +80,11 @@ export declare function areItemsTheSameInGroup<ItemType extends GlobalSelectionT
 /**
  * Removes an empty group from the list of groups, except if it's the local (default) selection.
  *
- * @param {WritableDraft<SelectionTreeTypes.Group[]>} allGroups - The list of all groups.
+ * @param {SelectionTreeTypes.Group[]} allGroups - The list of all groups.
  * @param {SelectionTreeTypes.Group} targetGroup - The group to check and potentially remove.
  * @returns {void}
  */
-export declare function removeGroupIfEmpty(allGroups: WritableDraft<SelectionTreeTypes.Group[]>, targetGroup: SelectionTreeTypes.Group): void;
+export declare function removeGroupIfEmpty(allGroups: SelectionTreeTypes.Group[], targetGroup: SelectionTreeTypes.Group): void;
 /**
  * Removes items from the global selection if they are not present in the tree store anymore.
  *