@equinor/echo-framework 0.20.15 → 0.20.17

package/package.json

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

package/src/index.d.ts

@@ -1,25 +1,29 @@
-import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
+import { getLegendStatusColor } from './lib/feature/legacyLegend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
 export * from './lib/components';
 export { PrepviewButton } from './lib/components/prepviewButton/prepviewButton';
+export { useFetchPlantInfo } from './lib/components/requestAccess/hooks/fetchPlantInfo';
 export { RequestProCoSysAccess } from './lib/components/requestAccess/RequestProCoSysAccess';
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
-export { useFetchPlantInfo } from './lib/components/requestAccess/hooks/fetchPlantInfo';
 export { WorkOrderListItem } from './lib/components/workOrderListItem';
 export * from './lib/coreApplication';
 export { fetchEquipmentFromApi } from './lib/feature/equipment/api/api-equipmentWithMeasuringPoints';
 export * from './lib/feature/equipment/index';
 export * from './lib/feature/globalSelection';
-export type { GlobalSelectionItem, OptimizedWorkOrderDto } from './lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types';
+export type { OptimizedWorkOrderDto } from './lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types';
 export { PanTo3DButton } from './lib/feature/globalSelection/panToEcho3d/panTo3DButton';
-export * from './lib/feature/legend/index';
+export { useAllItemsHiddenByUser } from './lib/feature/globalSelection/selectionMenu/hooks/useAllItemsHiddenByUser';
+export { useSelectionMenuLists } from './lib/feature/globalSelection/selectionMenu/hooks/useSelectionMenuLists';
+export { SelectionMenuDefaultListIds } from './lib/feature/globalSelection/selectionMenu/selectionMenuStore/selectionMenu.store';
+export type { SelectionMenuList } from './lib/feature/globalSelection/selectionMenu/selectionMenuStore/selectionMenu.store.types';
+export * from './lib/feature/legacyLegend/index';
 export { getLatestMeasurementDate, sortMeasuringPointsByMeasurementDate } from './lib/feature/measuringPoint/components/measuringPoints.utils';
 export * from './lib/feature/measuringPoint/index';
 export * from './lib/feature/measuringPoint/types/measuringPoint';
 export * from './lib/feature/openItemsIn3d';
-export { SelectedItemsMenu } from './lib/feature/openItemsIn3d/SelectedItemsMenu';
 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 { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
@@ -31,6 +35,9 @@ export { RegisteredComponentName } from './lib/services/componentRegistry/compon
 export * from './lib/services/dataLayerPanel';
 export * from './lib/services/eventHubActions';
 export * from './lib/services/leftPanelNavigation';
+export * from './lib/services/locationService/locationService';
+export { createSimpleStore } from './lib/services/stores/createSimpleStore';
+export * from './lib/services/userSetting';
 export * from './lib/types/api-echohub';
 export type { EchoHubPlant } from './lib/types/echoHubPlant';
 export * from './lib/types/eventTypes';

package/src/lib/components/formattedLongText/formattedLongText.d.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+interface FormattedLongTextProps {
+    readonly longText: string;
+}
+export declare const FormattedLongText: FC<FormattedLongTextProps>;
+export {};

package/src/lib/components/index.d.ts

@@ -6,7 +6,9 @@ export * from './echoLogo';
 export * from './errorBoundary';
 export * from './externalLinkButton/externalLinkButton';
 export * from './footer';
+export { FormattedLongText } from './formattedLongText/formattedLongText';
 export * from './fullScreenButtons';
+export * from './infoLabel';
 export * from './labelledValueGrid';
 export * from './lazyLoading';
 export * from './listItemAdditionalInfoRow/listItemAdditionalInfoRow';
@@ -24,6 +26,5 @@ export * from './spinner/spinner';
 export * from './tagNumber';
 export * from './tagSearchDropDown';
 export * from './toaster';
-export * from './infoLabel';
 export * from './verticalTabsSplitView';
 export { WorkOrderListItem } from './workOrderListItem';

package/src/lib/components/prepview/colors/ColorMapping.d.ts

@@ -30,7 +30,7 @@ export declare function convertToFailureImpactId(failureImpact: string): "X" | "
 /**
  * Used to set colorMap on Work order visuals such as ListItems
  */
-export declare function getWorkOrderColorMap(currentBadgeOption: WoBadgeType | undefined, isActive: boolean, requiredEndDateStatus?: string, basicFinishDateStatus?: string): ColorMap | undefined;
+export declare function getWorkOrderColorMap(currentBadgeOption: WoBadgeType | undefined, isActive: boolean, requiredEndDateStatus?: string, basicFinishDateStatus?: string, userStatus?: string): ColorMap | undefined;
 /**
  * Used to set colorMap on Equipment visuals such as ListItems
  */

package/src/lib/components/prepview/types/shared.d.ts

@@ -99,25 +99,47 @@ export type HistoricWorkOrderItem = {
     isActive: boolean;
     requiredEndDateTime?: Date;
     requiredEndDateStatus?: string;
-    maintenancePlanDate: Date;
-    planningPlant: string;
-    description: string;
-    workCenterId: string;
-    type: string;
-    activeStatusIds: string;
-    title: string;
-    operationId?: string;
-    mainWorkCenterId: string;
-    createdDateTime: Date;
-    changedDateTime: Date;
+    requiredEndDateStatusDescription?: string;
+    maintenancePlanDate?: Date;
+    planningPlant?: string;
+    planningPlantId?: string;
+    basicFinishDateTime?: Date;
+    basicFinishDateStatus?: string;
+    basicFinishDateStatusDescription?: string;
     earlyStartDate?: Date;
     earlyFinishDate?: Date;
-    basicFinishDateStatus?: string;
-    basicFinishDateTime?: Date;
+    createdDateTime: Date;
+    changedDateTime: Date;
+    description?: string;
+    title?: string;
+    workCenter?: string;
+    workCenterId?: string;
+    operationId?: string;
     sortField?: string;
     hasPrts?: boolean;
     recordTypeIds?: string[];
     hasB30Document?: boolean;
+    activeStatusIds?: string;
+    userStatus?: string;
+    tag?: {
+        functionalLocationId?: string;
+        tagId?: string;
+        plantId?: string;
+        categoryId?: string;
+        category?: string;
+        instCode?: string;
+    };
+    plannerGroupId?: string;
+    plantId?: string;
+    instCode?: string;
+    functionalLocationId?: string;
+    tagPlantId?: string;
+    tagId?: string;
+    tagCategory?: string;
+    tagCategoryId?: string;
+    mapLocationId?: string;
+    maintenancePlantId?: string;
+    maintenancePlant?: string;
 };
 export type PunchGroup = {
     type: string;

package/src/lib/components/prepview/types/workorder.d.ts

@@ -8,6 +8,7 @@ export type WorkOrderDetails = FetchStatus & {
     tagCategoryId: string;
     orderType: string;
     activeStatusIds: string;
+    userStatus: string;
     isActive: true;
     personResponsible: string;
     plannerGroupId: string;
@@ -84,9 +85,23 @@ export type WorkOrderEquipment = {
     maintenancePlantId: string;
     maintenancePlant: string;
     subseaPoolEquipmentGroup: string;
+    subseaPoolEquipmentGroupid: string;
     equipmentOnboard: boolean;
     mapLocation: MapLocationDto;
+    notificationStatus?: EquipmentStatus;
+    equipmentStatus?: EquipmentStatus;
+    certificateStatus?: EquipmentStatus;
 };
+export type EquipmentStatus = {
+    severity: EquipmentStatusSeverity;
+    label: string;
+};
+export declare enum EquipmentStatusSeverity {
+    Ok = "Ok",
+    Warning = "Warning",
+    Error = "Error",
+    Unknown = "Unknown"
+}
 export type MapLocationDto = {
     id?: string;
     position: Coordinates;

package/src/lib/components/prepview/workorder/pm15/equipment/equipmentHelper.d.ts

@@ -0,0 +1,18 @@
+import { ColorMap } from "@equinor/echo-components";
+import { EquipmentStatus } from "../../../types";
+/**
+ * EquipmentTitleRow determines if the primary row of the Equipment ListItem shall have icons or not
+ */
+interface EquipmentTitleRowProps {
+    equipmentId: string;
+    compact?: boolean;
+    notificationStatus?: EquipmentStatus;
+    equipmentStatus?: EquipmentStatus;
+    certificateStatus?: EquipmentStatus;
+}
+export declare function EquipmentTitleRow({ equipmentId, compact, notificationStatus, equipmentStatus, certificateStatus, }: EquipmentTitleRowProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Used to display the visual for equipment items
+ */
+export declare function displayEquipmentVisual(colorMap?: ColorMap, compact?: boolean): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -1,4 +1,3 @@
 import React from 'react';
-export declare const EchoTopBar: React.FC;
 declare const _default: React.NamedExoticComponent<{}>;
 export default _default;

package/src/lib/feature/equipment/components/equipmentItemInfo/equipmentItemInfo.d.ts

@@ -3,6 +3,7 @@ import { Equipment } from '../../types/equipment';
 interface EquipmentItemInfoProps {
     equipment: Equipment;
     tagNo: string;
+    plantNo: string;
 }
 export declare const EquipmentItemInfo: React.FC<EquipmentItemInfoProps>;
 export {};

package/src/lib/feature/equipment/components/equipmentTabs/MeasuringPointsForEquipmentItem.d.ts

@@ -1,8 +1,9 @@
-export interface MeasuringPointsPanelProps {
+interface MeasuringPointsPanelProps {
     equipmentId: string;
-    onLoadUpdate?: (args: {
+    onLoadUpdate: (status: {
         isLoading: boolean;
         numberOfItemsLoaded?: number;
     }) => void;
 }
 export declare const MeasuringPointsForEquipmentItem: React.FC<MeasuringPointsPanelProps>;
+export {};

package/src/lib/feature/equipment/components/equipmentTabs/MeasuringPointsForEquipmentItemList.d.ts

@@ -0,0 +1,6 @@
+import { MeasuringPointDto } from '../../../measuringPoint';
+interface MeasuringPointListProps {
+    items: MeasuringPointDto[];
+}
+export declare const MeasuringPointsForEquipmentItemList: React.FC<MeasuringPointListProps>;
+export {};

package/src/lib/feature/equipment/components/equipmentTabs/equipmentTabs.d.ts

@@ -1,6 +1,8 @@
 import { Equipment } from '../../types/equipment';
-export interface EquipmentTabsProps {
+interface EquipmentTabsProps {
     equipment: Equipment;
     tagNo: string;
+    plantNo: string;
 }
 export declare const EquipmentTabs: React.FC<EquipmentTabsProps>;
+export {};

package/src/lib/feature/equipment/hooks/useEquipmentWithMeasuringPoints.d.ts

@@ -3,7 +3,7 @@ export declare function useEquipmentWithoutMeasuringPoints(equipmentId: string):
     status: 'error' | 'success' | 'pending';
     equipmentWithMeasuringPoints: EquipmentWithMeasuringPoints[];
 };
-export declare function useEquipmentWithMeasuringPoints(equipmentId: string): {
+export declare function useEquipmentWithMeasuringPoints(equipmentId: string, isEnabledMeasuringPoints: boolean): {
     status: 'error' | 'success' | 'pending';
     equipmentWithMeasuringPoints: EquipmentWithMeasuringPoints[];
 };

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

@@ -0,0 +1,199 @@
+import { ResultValue, TagSummaryDto } from '@equinor/echo-search';
+import { GlobalSelectionTypes } from './globalSelectionStore/globalSelectionStore.types';
+/**
+ * A frozen object that provides various API methods for managing global selections.
+ *
+ * @constant
+ * @namespace globalSelectionApi
+ *
+ * @property {Function} removeItemsByListId - Removes items by their list ID.
+ *
+ * @property {Object} add - Contains methods for adding items.
+ * @property {Function} add.tags - Adds tags to the selection.
+ * @property {Function} add.workOrders - Adds work orders to the selection.
+ *
+ * @property {Object} search - Contains methods for searching items.
+ * @property {Function} search.isItemIdInList - Checks if an item ID is in the list.
+ * @property {Function} search.isItemIdInTheSelection - Checks if an item ID is in the selection.
+ * @property {Function} search.findListById - Finds a selection list by its ID.
+ *
+ * @property {Object} visibility - Contains methods for setting visibility.
+ * @property {Function} visibility.setByItemIds - Sets visibility by item IDs.
+ * @property {Function} visibility.setByListId - Sets visibility by list ID.
+ *
+ * @property {Object} errorStatus - Contains methods for managing error statuses.
+ * @property {Function} errorStatus.setByItemIds - Sets error status for items by their IDs.
+ * @property {Function} errorStatus.removeByItemIds - Removes error status for items by their IDs.
+ * @property {Function} errorStatus.reset - Resets item error statuses.
+ */
+export declare const globalSelectionApi: Readonly<{
+    /**
+     * Removes items from a specified list in the selection menu panel by their IDs.
+     *
+     * @param {Object} args - The arguments for removing items.
+     * @param {string} args.listId - The ID of the list from which the items should be removed.
+     * @param {Readonly<GlobalSelectionTypes.ItemId[]>} args.itemIds - An array of item IDs representing the items to be removed.
+     *
+     * @example
+     * removeItemsByListId({ listId: '789', itemIds: ['item1', 'item2'] });
+     */
+    removeItemsByListId: (args: {
+        listId: string;
+        itemIds: GlobalSelectionTypes.ItemId[];
+    }) => void;
+    add: Readonly<{
+        /**
+         * Adds tags to a specified list in the selection menu panel.
+         *
+         * @param {Object} args - The arguments for adding tags.
+         * @param {string} args.listId - Optional - The ID of the list to which the tags should be added. If not provided, the default tag list ID is used.
+         * @param {Readonly<Readonly<TagSummaryDto>[]>} args.items - An array of TagSummaryDto objects representing the tags to be added.
+         *
+         * @example
+         * addTags({ listId: '123', items: [{ id: 'tag1', name: 'Tag 1' }, { id: 'tag2', name: 'Tag 2' }] });
+         */
+        tags: (args: {
+            listId?: string;
+            itemIds: Readonly<GlobalSelectionTypes.TagId[]>;
+        }) => Promise<import("@equinor/echo-search").ResultArray<TagSummaryDto>[]>;
+        /**
+         * Adds work orders to a specified list in the selection menu panel.
+         *
+         * @param {Object} args - The arguments for adding work orders.
+         * @param {string} args.listId - Optional. The ID of the list to which the work orders should be added. If not provided, the default work order list ID is used.
+         * @param {Readonly<Readonly<OptimizedWorkOrderDto>[]>} args.items - An array of OptimizedWorkOrderDto objects representing the work orders to be added.
+         *
+         * @example
+         * addWorkOrders({ listId: '456', items: [{ id: 'wo1', name: 'Work Order 1' }, { id: 'wo2', name: 'Work Order 2' }] });
+         */
+        workOrders: (args: {
+            listId?: string;
+            items: Readonly<Readonly<import("./globalSelectionStore/globalSelectionStore.types").OptimizedWorkOrderDto>[]>;
+        }) => void;
+    }>;
+    search: Readonly<{
+        /**
+         * Checks if a given item ID is present in a specified list.
+         *
+         * @param args - An object containing the item ID and the list ID.
+         * @param {GlobalSelectionTypes.ItemId} args.itemId - The ID of the item to check for.
+         * @param {string} args.listId - The ID of the list to search within.
+         * @returns {boolean} A boolean indicating whether the item ID is found in the list.
+         */
+        isItemIdInList: (args: {
+            itemId: GlobalSelectionTypes.ItemId;
+            listId: string;
+        }) => boolean;
+        /**
+         * Checks if a given item ID is present in the selection lists.
+         *
+         * @param args - An object containing the item ID to check.
+         * @param {GlobalSelectionTypes.ItemId} args.itemId - The item ID to check for presence in the selection lists.
+         * @returns {boolean} A boolean indicating whether the item ID is present in the selection lists.
+         */
+        isItemIdInTheSelection: (args: {
+            itemId: GlobalSelectionTypes.ItemId;
+        }) => boolean;
+        /**
+         * Finds a selection list by its ID from a given list of selection menu lists.
+         * If the list is not found at the top level, it searches within the sublists of each top-level list.
+         *
+         * @param args - The arguments object.
+         * @param {string} args.listId - The ID of the selection list to find.
+         * @returns {SelectionMenuList | undefined} The selection menu list with the specified ID, or `undefined` if not found.
+         */
+        findListById: (listId: string) => import("./selectionMenu/selectionMenuStore/selectionMenu.store.types").SelectionMenuList | undefined;
+    }>;
+    visibility: Readonly<{
+        setByItemIds: (args: {
+            itemIds: Readonly<Readonly<GlobalSelectionTypes.ItemId>>[];
+            isVisible: boolean;
+        }) => void;
+        /**
+         * Sets the visibility of items in a specified list in the selection menu store.
+         *
+         * @param {Object} args - The arguments for setting visibility.
+         * @param {string} args.listId - The ID of the list for which the visibility should be set.
+         * @param {boolean} args.isVisible - The visibility state to set for the items in the list.
+         *
+         * @example
+         * setVisibilityByListId({ listId: '123', isVisible: true });
+         */
+        setByListId: (args: {
+            listId: string;
+            isVisible: boolean;
+        }) => void;
+    }>;
+    errorStatus: Readonly<{
+        /**
+         * Sets the error status for specific items in the selection menu panel.
+         *
+         * @param {Object} args - The arguments for setting error statuses.
+         * @param {Readonly<GlobalSelectionTypes.ItemErrorStatusUpdate[]>} args.itemErrorStatuses - An array of objects representing the item IDs and their corresponding error statuses to be updated.
+         *
+         * @example
+         * setByItemIds({ itemErrorStatuses: [
+         *  { itemId: { workOrderId: 'wo1' }, errorStatus: 'error' },
+         *  { itemId: { tagNo: 'tag1', instCode: 'JAB' }, errorStatus: 'warning' }
+         * ] });
+         */
+        setByItemIds: (args: {
+            itemErrorStatuses: GlobalSelectionTypes.ItemErrorStatusUpdate[];
+        }) => void;
+        /**
+         * Removes the error status for specific items in the selection menu panel.
+         *
+         * @param {Object} args - The arguments for removing error statuses.
+         * @param {Readonly<GlobalSelectionTypes.ItemId[]>} args.itemIds - An array of item IDs representing the items for which the error statuses should be removed.
+         *
+         * @example
+         * removeByItemIds({
+         *    itemIds: [
+         *      { workOrderId: 'wo1' },
+         *      { workOrderId: 'wo2' }
+         *    ]
+         * });
+         */
+        removeByItemIds: (args: {
+            itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
+        }) => void;
+        /**
+         * Resets the error statuses for all items in the selection menu panel.
+         */
+        reset: () => void;
+    }>;
+    /**
+     * Removes all items from the selection menu panel.
+     */
+    clearSelection: () => void;
+}>;
+interface UseGlobalSelectionStore {
+    addTagToSelection: (tagId: GlobalSelectionTypes.TagId) => Promise<ResultValue<TagSummaryDto>>;
+    removeItemFromSelection: (tagId: GlobalSelectionTypes.TagId) => void;
+}
+interface GlobalSelectionState {
+    resetItemErrorStatuses: typeof globalSelectionApi.errorStatus.reset;
+    setErrorStatusForItems: typeof globalSelectionApi.errorStatus.setByItemIds;
+}
+interface UseGlobalSelectionStoreFunction extends UseGlobalSelectionStore {
+    (): UseGlobalSelectionStore;
+    getState: () => GlobalSelectionState;
+}
+/**
+ * @deprecated Do not use this! Will be removed soon.
+ * Only made for 3D team to maintain some legacy API they are using.
+ * Please use globalSelectionApi instead (find the new functions to call below)
+ *
+ * Old --> New
+ * ---------------------------------------------
+ * addTagToSelection() --> globalSelectionApi.add.tags()
+ *       - Now returns with ResultArray instead of Result: Promise<ResultArray<TagSummaryDto>[]>
+ * removeItemFromSelection() --> globalSelectionApi.removeItemsByListId()
+ *       - Now a listId is required as well.
+ *       - Use SelectionMenuDefaultListIds.TagList from echo-framework for removing item from the default tag list.
+ *
+ * resetItemErrorStatuses() --> globalSelectionApi.errorStatus.reset()
+ * setErrorStatusForItems() --> globalSelectionApi.errorStatus.setByItemIds()
+ */
+export declare const useGlobalSelectionStore: UseGlobalSelectionStoreFunction;
+export {};

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

@@ -1,4 +1,26 @@
-import { GlobalSelectionTypes } from './globalSelectionStore.types';
+import { WritableDraft } from 'immer';
+import { GlobalSelectionItemType, 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>;
+/**
+ * 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.
+ * If you're interested in the item hierarchy, tree structure, use `useSelectionMenuStore` zustand store.
+ *
+ * With this said, this store is charge of:
+ *   - storing items by type
+ *   - controlling meta data used in the ui for each item, like:
+ *       - visibility
+ *       - color
+ *       - error statuses
+ *       - etc.
+ *
+ * You shouldn't use this store directly in any code.
+ * If you want to add, and remove items, use `useSelectionMenuStore` zustand store.
+ *
+ * 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<import("./globalSelectionStore.types").GlobalSelectionStore>, "setState"> & {
     setState<A extends string | {
         type: string;
@@ -12,17 +34,22 @@ export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Om
         } | undefined): () => void;
     };
 }, "setState"> & {
-    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 | {
+    setState(nextStateOrUpdater: import("./globalSelectionStore.types").GlobalSelectionStore | Partial<import("./globalSelectionStore.types").GlobalSelectionStore> | ((state: WritableDraft<import("./globalSelectionStore.types").GlobalSelectionStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;
     } | undefined): void;
 }>;
 /**
- * Determine if a given list has any items being loaded.
- * @param {string} listKey Global selection item list identifier
- * @returns {boolean}
+ * Determine if a given selection type has any items being loaded.
+ * @param {GlobalSelectionItemType} selectionType - A specific type from GlobalSelectionItemType for the list to check.
+ * @returns {boolean} - Returns true if there are any items being loaded in the specified selection type.
  */
-export declare function useIsGlobalSelectionListLoading(listKey: string): boolean;
+export declare function useIsGlobalSelectionListLoading<K extends GlobalSelectionItemType>(selectionType: K): boolean;
 /**
  * Get a snapshot of the current global selection store state.
+ *
+ * You shouldn't use this store directly in any code.
+ * If you want to add, and remove items, use `useSelectionMenuStore` zustand store.
+ *
+ * For accessing and using global selection features, use the globalSelectionApi from echo-framework.
  */
 export declare function getGlobalSelectionStoreState(): GlobalSelectionTypes.Store;

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

@@ -1,28 +1,24 @@
-import { ResultValue, TagSummaryDto } from '@equinor/echo-search';
+import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
 import { Equipment } from '../../equipment';
 export declare enum GlobalSelectionItemType {
     WorkOrder = "WorkOrder",
     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 {
+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> = {
+type GlobalSelectionList<T extends GlobalSelectionItemType> = {
     label: string;
-    key: string;
     type: T;
     items: GlobalSelectionTypes.GenericItem<T>[];
     itemsBeingLoaded: GlobalSelectionTypes.ItemId[];
 };
+export type GlobalSelectionObject = {
+    [K in GlobalSelectionItemType]: GlobalSelectionList<K>;
+};
 /**
  * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
  */
@@ -36,70 +32,29 @@ export type GlobalSelectionGenericItem<T extends GlobalSelectionItemType> = {
         errorStatus?: string;
     };
 };
-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;
-/**
- * @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 {
+type WorkOrderGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.WorkOrder>;
+type TagGlobalSelectionList = GlobalSelectionTypes.List<GlobalSelectionItemType.Tag>;
+type GlobalSelectionListUnion = WorkOrderGlobalSelectionList | TagGlobalSelectionList | EquipmentGlobalSelectionList;
+interface ItemErrorStatusUpdates {
     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: GlobalSelectionTypes.ListUnion[];
+    lists: GlobalSelectionObject;
     addWorkOrdersToSelection: (args: {
         workOrders: Readonly<OptimizedWorkOrderDto[]>;
     }) => void;
-    addTagToSelection: (args: GlobalSelectionTypes.TagId) => Promise<ResultValue<TagSummaryDto>>;
     addTagsToSelection: (args: {
-        tags: Readonly<TagSummaryDto[]>;
-    }) => void;
-    removeItemFromSelection: (itemId: Readonly<GlobalSelectionTypes.ItemId>) => void;
+        tagIds: Readonly<GlobalSelectionTypes.TagId[]>;
+    }) => Promise<ResultArray<TagSummaryDto>[]>;
     removeItemsFromSelection: (args: {
         itemIds: ReadonlyArray<GlobalSelectionTypes.ItemId>;
     }) => void;
-    setVisibilityList: (args: {
-        listKey: string;
+    setVisibilityByItemIds: (args: {
+        itemIds: Readonly<Readonly<GlobalSelectionTypes.ItemId>>[];
         isVisible: boolean;
     }) => void;
-    setVisibility: (args: {
-        itemId: Readonly<GlobalSelectionTypes.ItemId>;
-        isVisible: boolean;
-    }) => void;
-    /**
-     *@deprecated This method is deprecated. Use `removeErrorStatusForItems` instead.
-     */
-    resetItemNotFoundStates: () => void;
     resetItemErrorStatuses: () => void;
     resetState: () => void;
     setErrorStatusForItems: (args: {
@@ -108,12 +63,6 @@ export interface GlobalSelectionStore {
     removeErrorStatusForItems: (args: {
         itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
     }) => void;
-    /**
-     *@deprecated This method is deprecated. Use `setStatusForItems` instead.
-     */
-    setNotFoundItems: (args: {
-        itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
-    }) => void;
 }
 export declare namespace GlobalSelectionTypes {
     type WorkOrderId = Pick<OptimizedWorkOrderDto, 'workOrderId'>;
@@ -125,6 +74,7 @@ export declare namespace GlobalSelectionTypes {
     type TagItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
     type List<T extends GlobalSelectionItemType> = GlobalSelectionList<T>;
     type SelectionItem = EquipmentItem | WorkOrderItem | TagItem;
+    type SelectionItemList = EquipmentItem[] | WorkOrderItem[] | TagItem[];
     type GenericItem<T extends GlobalSelectionItemType> = GlobalSelectionGenericItem<T>;
     type Store = GlobalSelectionStore;
     type ItemErrorStatusUpdate = ItemErrorStatusUpdates;