@equinor/echo-framework 0.23.3 → 0.23.4-beta-0

package/package.json

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

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

@@ -74,7 +74,7 @@ export declare const globalSelectionApi: Readonly<{
          * - 'ItemsUpdated': Existing items were replaced with new tags.
          * - 'ItemsAdded': New tags were added to the existing items.
          */
-        tags: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.TagId>) => Promise<import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemsResponse<import("dist/libs/echo-search/src").ResultArray<import("dist/libs/echo-search/src").TagSummaryDto>[]>>;
+        tags: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.TagId>) => import("./selectionMenu/selectionTreeStore/selectionTree.store.types").AddTagsReturnType;
         /**
          * Adds work orders to a specified list in the selection menu panel.
          *
@@ -82,8 +82,8 @@ export declare const globalSelectionApi: Readonly<{
          * @param {Guid} args.groupId - Optional. The ID of the list to which the work orders should be added. If not provided, it will be added to the "Local Selection".
          * @param {Readonly<Readonly<GlobalSelectionTypes.WorkOrderId>[]>} args.items - An array of WorkOrderId objects representing the work orders to be added.
          */
-        workOrders: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => Promise<import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemsResponse<import("dist/libs/echo-search/src").ResultArray<import("dist/libs/echo-search/src").WorkOrderData>[]>>;
-        equipments: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.EquipmentId>) => Promise<import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemsResponse<import("dist/libs/echo-search/src").ResultArray<import("dist/libs/echo-search/src").EquipmentData>[]>>;
+        workOrders: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => import("./selectionMenu/selectionTreeStore/selectionTree.store.types").AddWorkOrdersReturnType;
+        equipments: (args: import("./selectionMenu/selectionTreeStore/actions/selectionTree.action.types").AddItemArgs<GlobalSelectionTypes.EquipmentId>) => import("./selectionMenu/selectionTreeStore/selectionTree.store.types").AddEquipmentsReturnType;
         /**
          * Adds items to a specified list in the selection menu panel.
          *

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

@@ -1,20 +1,15 @@
 import { ResultArray } from '@equinor/echo-search';
 import { StoreApi } from 'zustand';
-import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionStore, GlobalSelectionTypes } from '../globalSelectionStore.types';
+import { GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionStore, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../globalSelectionStore.types';
 type FetchFunction<T, U> = (itemIds: Readonly<U[]>) => Promise<ResultArray<T>[]>;
 type NullItemGenerator<T, U> = (itemId: U) => T;
-type ItemIdTypeMap = {
-    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
-    [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
-    [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
-};
 type SetFunction = (set: (state: GlobalSelectionStore) => void, shouldReplace?: boolean | undefined, action?: string) => void;
 export declare function addItemsToSelectionFactory<T extends GlobalSelectionItemType>(args: {
     itemType: T;
-    fetchFunction: FetchFunction<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>;
-    nullItemGenerator: NullItemGenerator<GlobalSelectionItemTypeToDataMap[T], ItemIdTypeMap[T]>;
+    fetchFunction: FetchFunction<GlobalSelectionItemTypeToDataMap[T], SelectionItemTypeToItemIdMap[T]>;
+    nullItemGenerator: NullItemGenerator<GlobalSelectionItemTypeToDataMap[T], SelectionItemTypeToItemIdMap[T]>;
 }): (set: SetFunction, get: StoreApi<GlobalSelectionStore>["getState"], args: {
-    itemIds: ItemIdTypeMap[T][];
+    itemIds: SelectionItemTypeToItemIdMap[T][];
 }) => Promise<{
     fetchResult: ResultArray<GlobalSelectionItemTypeToDataMap[T]>[];
     actionResult: GlobalSelectionTypes.ActionResult;

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

@@ -9,11 +9,16 @@ export declare enum GlobalSelectionItemType {
 type GlobalSelectionTagDto = TagSummaryDto;
 type GlobalSelectionWorkOrderDto = WorkOrderData;
 type GlobalSelectionEquipmentDto = EquipmentData;
-export interface GlobalSelectionItemTypeToDataMap {
-    WorkOrder: GlobalSelectionWorkOrderDto;
-    Tag: GlobalSelectionTagDto;
-    Equipment: GlobalSelectionEquipmentDto;
-}
+export type GlobalSelectionItemTypeToDataMap = {
+    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionWorkOrderDto;
+    [GlobalSelectionItemType.Tag]: GlobalSelectionTagDto;
+    [GlobalSelectionItemType.Equipment]: GlobalSelectionEquipmentDto;
+};
+export type SelectionItemTypeToItemIdMap = {
+    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
+    [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
+    [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
+};
 type GlobalSelectionList<T extends GlobalSelectionItemType> = {
     label: string;
     type: T;

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

@@ -1,3 +1,2 @@
-import { EquipmentData } from '@equinor/echo-search';
-import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
-export declare const addEquipmentsAction: (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.EquipmentId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<import("@equinor/echo-search").ResultArray<EquipmentData>[]>>;
+import { GlobalSelectionItemType } from '../../../globalSelectionStore/globalSelectionStore.types';
+export declare const addEquipmentsAction: (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<import("../../../globalSelectionStore/globalSelectionStore.types").GlobalSelectionTypes.EquipmentId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<GlobalSelectionItemType.Equipment>>;

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

@@ -1,3 +1,2 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
-export declare const addTagsAction: (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.TagId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<import("@equinor/echo-search").ResultArray<TagSummaryDto>[]>>;
+import { GlobalSelectionItemType } from '../../../globalSelectionStore/globalSelectionStore.types';
+export declare const addTagsAction: (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<import("../../../globalSelectionStore/globalSelectionStore.types").GlobalSelectionTypes.TagId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<GlobalSelectionItemType.Tag>>;

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

@@ -1,3 +1,2 @@
-import { WorkOrderData } from '@equinor/echo-search';
-import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
-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<WorkOrderData>[]>>;
+import { GlobalSelectionItemType } from '../../../globalSelectionStore/globalSelectionStore.types';
+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<import("../../../globalSelectionStore/globalSelectionStore.types").GlobalSelectionTypes.WorkOrderId>) => Promise<import("./selectionTree.action.types").AddItemsResponse<GlobalSelectionItemType.WorkOrder>>;

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

@@ -1,13 +1,13 @@
 import { ResultArray } from '@equinor/echo-search';
 import { StoreApi } from 'zustand';
-import { GlobalSelectionAddItemResult, GlobalSelectionItemType, GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionAddItemResult, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, SelectionItemTypeToItemIdMap } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { GlobalSelectionCategoryId, SelectionTreeStore } from '../selectionTree.store.types';
 import { AddItemArgs, AddItemsResponse } from './selectionTree.action.types';
 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;
+export declare function addItemsActionFactory<G_ItemType extends GlobalSelectionItemType>(args: {
+    addItemToGlobalSelection: (uniqueNewItems: SelectionItemTypeToItemIdMap[G_ItemType][]) => Promise<GlobalSelectionAddItemResult<ResultArray<GlobalSelectionItemTypeToDataMap[G_ItemType]>[]>>;
+    itemType: G_ItemType;
     itemCategory: GlobalSelectionCategoryId;
     categoryOrderIndex: number;
-}): (set: SetFunction, get: StoreApi<SelectionTreeStore>["getState"], args: AddItemArgs<G_ItemId>) => Promise<AddItemsResponse<ResultArray<G_ResponseData>[]>>;
+}): (set: SetFunction, get: StoreApi<SelectionTreeStore>["getState"], args: AddItemArgs<SelectionItemTypeToItemIdMap[G_ItemType]>) => Promise<AddItemsResponse<G_ItemType>>;
 export {};

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

@@ -1,4 +1,5 @@
-import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+import { ResultArray } from '@equinor/echo-search';
+import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../../globalSelectionStore/globalSelectionStore.types';
 import { SelectionBase } from '../selectionTree.store.types';
 export type AddByLabel = SelectionBase | {
     label?: undefined;
@@ -9,9 +10,9 @@ export type AddItemArgs<ItemIdType extends GlobalSelectionTypes.ItemId> = {
     replaceItems?: boolean;
     getActionResult?: boolean;
 } & AddByLabel;
-export type AddItemsResponse<FetchResponseType> = {
-    fetchResults: FetchResponseType;
-    itemsAdded: Readonly<GlobalSelectionTypes.ItemId[]>;
+export type AddItemsResponse<T extends GlobalSelectionItemType> = {
+    fetchResults: ResultArray<SelectionItemTypeToItemIdMap[T]>[];
+    itemsAdded: Readonly<SelectionItemTypeToItemIdMap[T][]>;
     actionResult: SelectionTreeActionResult;
 };
 export type SelectionTreeActionResult = 'ItemsUpdated' | 'ItemsAdded' | 'NewGroupCreated' | 'NoChanges';

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

@@ -1,12 +1,6 @@
-import { EquipmentData, ResultArray, TagSummaryDto, WorkOrderData } from '@equinor/echo-search';
 import { Guid } from '@equinor/echo-utils';
-import { GlobalSelectionItemType, GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionItemType, GlobalSelectionTypes, SelectionItemTypeToItemIdMap } from '../../globalSelectionStore/globalSelectionStore.types';
 import { AddByLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
-export type SelectionItemTypeToItemIdMap = {
-    [GlobalSelectionItemType.Tag]: GlobalSelectionTypes.TagId;
-    [GlobalSelectionItemType.WorkOrder]: GlobalSelectionTypes.WorkOrderId;
-    [GlobalSelectionItemType.Equipment]: GlobalSelectionTypes.EquipmentId;
-};
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
     WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID",
@@ -47,9 +41,9 @@ export interface SelectionTreeStore {
     addItems: (args: {
         itemIds: GlobalSelectionTypes.ItemId[];
     } & AddByLabel) => void;
-    addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => Promise<AddItemsResponse<ResultArray<TagSummaryDto>[]>>;
-    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => Promise<AddItemsResponse<ResultArray<WorkOrderData>[]>>;
-    addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => Promise<AddItemsResponse<ResultArray<EquipmentData>[]>>;
+    addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => AddTagsReturnType;
+    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => AddWorkOrdersReturnType;
+    addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => AddEquipmentsReturnType;
     createGroup: (args: {
         label: string;
         subLabel: string;
@@ -81,3 +75,6 @@ export declare namespace SelectionTreeTypes {
     type Group = SelectionGroup;
     type ActionResult = SelectionTreeActionResult;
 }
+export type AddTagsReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.Tag>>;
+export type AddWorkOrdersReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.WorkOrder>>;
+export type AddEquipmentsReturnType = Promise<AddItemsResponse<GlobalSelectionItemType.Equipment>>;