@equinor/echo-framework 0.20.11 → 0.20.12

package/package.json

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

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

@@ -1,18 +1,18 @@
-import { GlobalSelectionStore } from './globalSelectionStore.types';
-export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<GlobalSelectionStore>, "setState"> & {
+import { GlobalSelectionTypes } from './globalSelectionStore.types';
+export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<import("./globalSelectionStore.types").GlobalSelectionStore>, "setState"> & {
     setState<A extends string | {
         type: string;
-    }>(partial: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: GlobalSelectionStore) => GlobalSelectionStore | Partial<GlobalSelectionStore>), replace?: boolean | undefined, action?: A | undefined): void;
+    }>(partial: import("./globalSelectionStore.types").GlobalSelectionStore | Partial<import("./globalSelectionStore.types").GlobalSelectionStore> | ((state: import("./globalSelectionStore.types").GlobalSelectionStore) => import("./globalSelectionStore.types").GlobalSelectionStore | Partial<import("./globalSelectionStore.types").GlobalSelectionStore>), replace?: boolean | undefined, action?: A | undefined): void;
 }, "subscribe"> & {
     subscribe: {
-        (listener: (selectedState: GlobalSelectionStore, previousSelectedState: GlobalSelectionStore) => void): () => void;
-        <U>(selector: (state: GlobalSelectionStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+        (listener: (selectedState: import("./globalSelectionStore.types").GlobalSelectionStore, previousSelectedState: import("./globalSelectionStore.types").GlobalSelectionStore) => void): () => void;
+        <U>(selector: (state: import("./globalSelectionStore.types").GlobalSelectionStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
             equalityFn?: ((a: U, b: U) => boolean) | undefined;
             fireImmediately?: boolean;
         } | undefined): () => void;
     };
 }, "setState"> & {
-    setState(nextStateOrUpdater: GlobalSelectionStore | Partial<GlobalSelectionStore> | ((state: import("immer").WritableDraft<GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
+    setState(nextStateOrUpdater: import("./globalSelectionStore.types").GlobalSelectionStore | Partial<import("./globalSelectionStore.types").GlobalSelectionStore> | ((state: import("immer").WritableDraft<import("./globalSelectionStore.types").GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;
     } | undefined): void;
 }>;
@@ -25,4 +25,4 @@ export declare function useIsGlobalSelectionListLoading(listKey: string): boolea
 /**
  * Get a snapshot of the current global selection store state.
  */
-export declare function getGlobalSelectionStoreState(): GlobalSelectionStore;
+export declare function getGlobalSelectionStoreState(): GlobalSelectionTypes.Store;

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

@@ -5,81 +5,133 @@ export declare enum GlobalSelectionItemType {
     Tag = "Tag",
     Equipment = "Equipment"
 }
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export interface GlobalSelectionItemTypeToDataMap {
     WorkOrder: OptimizedWorkOrderDto;
     Tag: TagSummaryDto;
     Equipment: Equipment;
 }
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export type GlobalSelectionList<T extends GlobalSelectionItemType> = {
     label: string;
     key: string;
     type: T;
-    items: GlobalSelectionGenericItem<T>[];
-    itemsBeingLoaded: string[];
+    items: GlobalSelectionTypes.GenericItem<T>[];
+    itemsBeingLoaded: GlobalSelectionTypes.ItemId[];
 };
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export type GlobalSelectionGenericItem<T extends GlobalSelectionItemType> = {
-    id: string;
+    id: GlobalSelectionTypes.ItemId;
     type: T;
-    data: GlobalSelectionItemTypeToDataMap[T];
+    data: GlobalSelectionTypes.ItemTypeToDataMap[T];
     metaData: {
         color: string;
         isHiddenByUser: boolean;
         errorStatus?: string;
     };
 };
-export type EquipmentGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
-export type WorkOrderGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.WorkOrder>;
-export type TagGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
+export type EquipmentGlobalSelectionListItem = GlobalSelectionTypes.GenericItem<GlobalSelectionItemType.Equipment>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
+export type WorkOrderGlobalSelectionListItem = GlobalSelectionTypes.GenericItem<GlobalSelectionItemType.WorkOrder>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
+export type TagGlobalSelectionListItem = GlobalSelectionTypes.GenericItem<GlobalSelectionItemType.Tag>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public namespace, GlobalSelectionTypes.SelectionItem type instead.
+ */
 export type GlobalSelectionItem = WorkOrderGlobalSelectionListItem | TagGlobalSelectionListItem | EquipmentGlobalSelectionListItem;
-type EquipmentGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.Equipment>;
-export type WorkOrderGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.WorkOrder>;
-export type TagGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.Tag>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
+type EquipmentGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.Equipment>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
+export type WorkOrderGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.WorkOrder>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
+export type TagGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.Tag>;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export type GlobalSelectionListUnion = WorkOrderGlobalSelectionList | TagGlobalSelectionList | EquipmentGlobalSelectionList;
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export interface ItemErrorStatusUpdates {
-    itemId: string;
+    itemId: GlobalSelectionTypes.ItemId;
     errorStatus: string;
 }
+/**
+ * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ */
 export interface GlobalSelectionStore {
-    lists: GlobalSelectionListUnion[];
+    lists: GlobalSelectionTypes.ListUnion[];
     addWorkOrdersToSelection: (args: {
         workOrders: Readonly<OptimizedWorkOrderDto[]>;
     }) => void;
-    addTagToSelection: (args: {
-        tagId: string;
-    }) => Promise<ResultValue<TagSummaryDto>>;
+    addTagToSelection: (args: GlobalSelectionTypes.TagId) => Promise<ResultValue<TagSummaryDto>>;
     addTagsToSelection: (args: {
         tags: Readonly<TagSummaryDto[]>;
     }) => void;
-    removeItemFromSelection: (args: {
-        itemId: string;
-    }) => void;
+    removeItemFromSelection: (itemId: Readonly<GlobalSelectionTypes.ItemId>) => void;
     setVisibilityList: (args: {
         listKey: string;
         isVisible: boolean;
     }) => void;
     setVisibility: (args: {
-        itemId: string;
+        itemId: Readonly<GlobalSelectionTypes.ItemId>;
         isVisible: boolean;
     }) => void;
     /**
      *@deprecated This method is deprecated. Use `removeErrorStatusForItems` instead.
      */
     resetItemNotFoundStates: () => void;
+    resetItemErrorStatuses: () => void;
     resetState: () => void;
     setErrorStatusForItems: (args: {
-        itemErrorStatuses: ItemErrorStatusUpdates[];
+        itemErrorStatuses: GlobalSelectionTypes.ItemErrorStatusUpdate[];
     }) => void;
     removeErrorStatusForItems: (args: {
-        itemIds: string[];
+        itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
     }) => void;
     /**
      *@deprecated This method is deprecated. Use `setStatusForItems` instead.
      */
     setNotFoundItems: (args: {
-        itemIds: string[];
+        itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
     }) => void;
 }
-export type OptimizedWorkOrderDto = {
+export declare namespace GlobalSelectionTypes {
+    type WorkOrderId = Pick<OptimizedWorkOrderDto, 'workOrderId'>;
+    type EquipmentId = Pick<Equipment, 'equipmentId'>;
+    type TagId = Pick<TagSummaryDto, 'tagNo' | 'instCode'>;
+    type ItemId = WorkOrderId | EquipmentId | TagId;
+    type EquipmentItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
+    type WorkOrderItem = GlobalSelectionGenericItem<GlobalSelectionItemType.WorkOrder>;
+    type TagItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
+    type List<T extends GlobalSelectionItemType> = GlobalSelectionList<T>;
+    type SelectionItem = EquipmentItem | WorkOrderItem | TagItem;
+    type GenericItem<T extends GlobalSelectionItemType> = GlobalSelectionGenericItem<T>;
+    type Store = GlobalSelectionStore;
+    type ItemErrorStatusUpdate = ItemErrorStatusUpdates;
+    type WorkOrderList = WorkOrderGlobalSelectionList;
+    type TagList = TagGlobalSelectionList;
+    type EquipmentList = EquipmentGlobalSelectionList;
+    type ListUnion = GlobalSelectionListUnion;
+    type ItemTypeToDataMap = GlobalSelectionItemTypeToDataMap;
+}
+export interface OptimizedWorkOrderDto {
     workOrderId: string;
     tagId: string | undefined;
     tagPlantId: string;
@@ -109,5 +161,5 @@ export type OptimizedWorkOrderDto = {
     _links: {
         related: string;
     };
-};
+}
 export {};

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

@@ -1,6 +1,30 @@
-import { PlantAndTagForOpenIn3d } from '../../openItemsIn3d/logic/openItemsIn3d.utils';
-import { GlobalSelectionGenericItem, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionListUnion, GlobalSelectionStore } from './globalSelectionStore.types';
-export declare function toGlobalSelectionItem<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(item: T, type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>;
-export declare function toGlobalSelectionItems<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>[];
-export declare function findGlobalSelectionListByKey(state: GlobalSelectionStore, key: string): GlobalSelectionListUnion | undefined;
-export declare function convertGlobalSelectionItemsToPlantTagPairs(): Promise<PlantAndTagForOpenIn3d[]>;
+import { GlobalSelectionItemType, GlobalSelectionTypes } from './globalSelectionStore.types';
+export declare function toGlobalSelectionItem<T extends GlobalSelectionTypes.ItemTypeToDataMap[K], K extends GlobalSelectionItemType>(item: T, type: K): GlobalSelectionTypes.GenericItem<K>;
+export declare function toGlobalSelectionItems<T extends GlobalSelectionTypes.ItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K): GlobalSelectionTypes.GenericItem<K>[];
+export declare function findGlobalSelectionListByKey(state: GlobalSelectionTypes.Store, key: string): GlobalSelectionTypes.ListUnion | undefined;
+declare function idsEqual(itemA: GlobalSelectionTypes.ItemId, itemB: GlobalSelectionTypes.ItemId): boolean;
+declare function isWorkOrderId(itemId: GlobalSelectionTypes.ItemId): itemId is GlobalSelectionTypes.WorkOrderId;
+declare function isEquipmentId(itemId: GlobalSelectionTypes.ItemId): itemId is GlobalSelectionTypes.EquipmentId;
+declare function isTagId(itemId: GlobalSelectionTypes.ItemId): itemId is GlobalSelectionTypes.TagId;
+declare function mapToId(item: GlobalSelectionTypes.ItemId): GlobalSelectionTypes.ItemId;
+declare function itemIdToString(itemId: Record<string, string | number>): string;
+/**
+ * A utility object that provides various functions for handling global selections.
+ *
+ * @namespace globalSelectionUtils
+ * @property {Function} isWorkOrderId - Checks if the passed object is a global selection WorkOrderID.
+ * @property {Function} isEquipmentId - Checks if the passed object is a global selection EquipmentID.
+ * @property {Function} isTagId - Checks if the passed object is a global selection TagID.
+ * @property {Function} idsEqual - Compares two global selection item IDs for equality.
+ * @property {Function} mapToId - Maps an object to its global selection item ID.
+ * @property {Function} itemIdToString - Converts a global selection item id object to a string, each value is concatenated by a '-'
+ */
+export declare const globalSelectionUtils: Readonly<{
+    isWorkOrderId: typeof isWorkOrderId;
+    isEquipmentId: typeof isEquipmentId;
+    isTagId: typeof isTagId;
+    idsEqual: typeof idsEqual;
+    mapToId: typeof mapToId;
+    itemIdToString: typeof itemIdToString;
+}>;
+export {};

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

@@ -1,10 +1,14 @@
-declare function allWorkOrders(): import("./globalSelectionStore.types").OptimizedWorkOrderDto[];
-declare function allTags(): import("dist/libs/echo-search/src").TagSummaryDto[];
-declare function allEquipments(): import("../../equipment").Equipment[];
-export declare const globalSelectionStoreHelpers: {
-    allTags: typeof allTags;
-    allEquipments: typeof allEquipments;
-    allWorkOrders: typeof allWorkOrders;
-    snapshot: () => import("./globalSelectionStore.types").GlobalSelectionStore;
-};
-export {};
+import { PlantAndTagForOpenIn3d } from '../../openItemsIn3d/logic/openItemsIn3d.utils';
+/**
+ * Converts global selection items to plant tag pairs.
+ *
+ * This function processes different types of global selection items (Tag, WorkOrder, Equipment)
+ * and converts them into an array of `PlantAndTagForOpenIn3d` objects. It ensures that all
+ * enum cases are handled by using a switch statement and the `assertUnreachable` function.
+ *
+ * The resulting array is then filtered to remove duplicates based on the combination of
+ * `instCode`, `pdmsPlantCode`, and `tagNo`.
+ *
+ * @returns {Promise<PlantAndTagForOpenIn3d[]>} A promise that resolves to an array of plant tag pairs.
+ */
+export declare function convertGlobalSelectionItemsToPlantTagPairs(): Promise<PlantAndTagForOpenIn3d[]>;

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

@@ -1,2 +1,2 @@
-import { GlobalSelectionItem } from '../globalSelectionStore/globalSelectionStore.types';
-export declare const useGlobalSelectionItems: () => GlobalSelectionItem[];
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
+export declare const useGlobalSelectionItems: () => GlobalSelectionTypes.SelectionItem[];

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

@@ -1,6 +1,6 @@
-import { TagGlobalSelectionListItem } from '../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 /**
  * Returns with the stored Tags from the global selection store
  * @returns {TagGlobalSelectionListItem[]} Array of Tags with some global selection meta data.
  */
-export declare function useGlobalSelectionTags(): TagGlobalSelectionListItem[];
+export declare function useGlobalSelectionTags(): GlobalSelectionTypes.TagItem[];

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

@@ -1,6 +1,6 @@
-import { WorkOrderGlobalSelectionListItem } from '../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 /**
  * Returns with the stored Work Orders from the global selection store
- * @returns {WorkOrderGlobalSelectionListItem[]} Array of Work Orders
+ * @returns {GlobalSelectionTypes.WorkOrderItem[]} Array of Work Orders
  */
-export declare function useGlobalSelectionWorkOrders(): WorkOrderGlobalSelectionListItem[];
+export declare function useGlobalSelectionWorkOrders(): GlobalSelectionTypes.WorkOrderItem[];

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

@@ -1,8 +1,9 @@
-export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
 export { getGlobalSelectionStoreState, useGlobalSelectionStore } from './globalSelectionStore/globalSelectionStore';
 export * from './globalSelectionStore/globalSelectionStore.types';
-export { convertGlobalSelectionItemsToPlantTagPairs } from './globalSelectionStore/globalSelectionStore.utils';
+export { globalSelectionUtils } from './globalSelectionStore/globalSelectionStore.utils';
+export { convertGlobalSelectionItemsToPlantTagPairs } from './globalSelectionStore/globalSelectionStoreHelpers';
 export { useGlobalSelectionItems } from './hooks/useGlobalSelectionItems';
 export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
 export { useGlobalSelectionTags } from './hooks/useGlobalSelectionTags';
 export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';
+export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';

package/src/lib/feature/globalSelection/panToEcho3d/panTo3DButton.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
-import { GlobalSelectionItem } from '../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 interface PanTo3DButtonProps {
-    item: GlobalSelectionItem;
+    item: GlobalSelectionTypes.SelectionItem;
 }
 export declare const PanTo3DButton: React.FC<PanTo3DButtonProps>;
 export {};

package/src/lib/feature/globalSelection/panToEcho3d/usePanTo3DWeb.d.ts

@@ -1,4 +1,4 @@
-import { GlobalSelectionItem } from '../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 export declare const usePanTo3dWeb: () => {
-    panTo3D: (item: GlobalSelectionItem) => Promise<void>;
+    panTo3D: (item: GlobalSelectionTypes.SelectionItem) => Promise<void>;
 };

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

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

package/src/lib/feature/openItemsIn3d/logic/convertToPlantTagPairs.d.ts

@@ -1,10 +1,10 @@
 import { PlantAndTagForOpenIn3d } from './openItemsIn3d.utils';
-export interface WorkOrderTag {
+export interface TagIdPlantId {
     tagPlantId: string | undefined;
     tagId: string | undefined;
 }
-export declare function tagToPlantTagPairs(selectedWorkOrders: {
+export declare function tagToPlantTagPairs(selectedWorkOrders: ReadonlyArray<{
     tagNo: string;
     instCode: string;
-}[]): Promise<PlantAndTagForOpenIn3d[]>;
-export declare function workOrdersToPlantTagPairs(selectedWorkOrders: WorkOrderTag[]): Promise<PlantAndTagForOpenIn3d[]>;
+}>): Promise<PlantAndTagForOpenIn3d[]>;
+export declare function tagIdPlantIdToPlantTagPairs(items: ReadonlyArray<TagIdPlantId>): Promise<PlantAndTagForOpenIn3d[]>;