@equinor/echo-framework 0.21.0 → 0.21.1-beta-0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.21.0",
+  "version": "0.21.1-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

@@ -48,24 +48,25 @@ export declare const globalSelectionApi: Readonly<{
     }>;
     add: Readonly<{
         /**
-         * Adds tags to a specified list in the selection menu panel.
+         * Adds tags to a selection and updates the state accordingly.
+         * Creates a group if label and sublabel are passed and the group doesn't exist.
          *
-         * @param {Object} args - The arguments for adding tags.
-         * @param {Guid} args.groupId - Optional - The ID of the group to which the tags should be added. If not provided, it will be added to the "Local Selection".
-         * @param {Readonly<GlobalSelectionTypes.TagId[]>} args.itemIds - An array of TagId objects representing the tags to be added.
+         * @param {AddTagsArgs} args - The arguments for adding tags.
+         * @param {Array<string>} args.itemIds - The IDs of the items to add tags to.
+         * @param {boolean} [args.replaceItems=false] - Whether to replace existing items with the new tags.
+         * @param {boolean} [args.getActionResult] - Optional, temporary. Will be removed. When passed the function will return with the actionResult as well.
+         * Otherwise it just returns with ResultArray<TagSummaryDto>[]>.
+         * @returns {Promise<AddTagsResponse>} response The response of the add tags action.
+         * @returns {Array<Object>} response.tagFetchResults - The results of the tag fetch operation.
+         * @returns {string} response.actionResult - The result of the action, if 'getActionResult' is set to true. It can be the following:
+         * - 'NoChanges': No new tags were added.
+         * - 'NewGroupCreated': A new group was created.
+         * - 'ItemsUpdated': Existing items were replaced with new tags.
+         * - 'ItemsAdded': New tags were added to the existing items.
          */
-        tags: (args: {
-            groupId? /**
-             * Removes items from a specified list in the selection menu panel by their IDs.
-             *
-             * @param {Object} args - The arguments for removing items.
-             * @param {Readonly<GlobalSelectionTypes.ItemId[]>} args.itemIds - An array of item IDs representing the items to be removed.
-             * @param {Guid} args.groupId - Optional. The ID of the list where the subList of the items are located.
-             * Local selection will be used by default.
-             * @param {GlobalSelectionCategoryId} args.category - The ID of the list where the items to be removed are located.
-             */: import("dist/libs/echo-utils/src").Guid;
-            itemIds: Readonly<GlobalSelectionTypes.TagId[]>;
-        }) => Promise<import("dist/libs/echo-search/src").ResultArray<import("dist/libs/echo-search/src").TagSummaryDto>[]>;
+        tags: <T extends boolean | undefined>(args: import("./selectionMenu/selectionTreeStore/actions/addTag.action.types").AddTagsArgs & {
+            getActionResult?: T;
+        }) => Promise<import("./selectionMenu/selectionTreeStore/selectionTree.store.types").AddTagsReturnType<T>>;
         /**
          * Adds work orders to a specified list in the selection menu panel.
          *
@@ -86,7 +87,16 @@ export declare const globalSelectionApi: Readonly<{
          *
          */
         addItems: (args: {
-            groupId?: import("dist/libs/echo-utils/src").Guid;
+            groupId? /**
+             * Removes a group or category by ID from the selection store.
+             *
+             * If a categoryId is provided, it removes all items from the specified category within the group.
+             * If no categoryId is provided, it removes the entire group and all its items.
+             *
+             * @param {Object} args - The function arguments.
+             * @param {Guid} args.groupId - The ID of the group to remove.
+             * @param {GlobalSelectionCategoryId} [args.categoryId] - The ID of the category to remove (optional).
+             */: import("dist/libs/echo-utils/src").Guid;
             itemIds: (GlobalSelectionTypes.TagId | import("./globalSelectionStore/globalSelectionStore.types").OptimizedWorkOrderDto)[];
         }) => void;
     }>;
@@ -179,6 +189,6 @@ export declare const globalSelectionApi: Readonly<{
     clearSelection: () => void;
     createGroup: (args: {
         label: string;
-        subLabel?: string;
-    }) => import("dist/libs/echo-utils/src").Guid | undefined;
+        subLabel: string;
+    }) => import("dist/libs/echo-utils/src").Guid;
 }>;

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

@@ -47,7 +47,7 @@ export interface GlobalSelectionStore {
     }) => void;
     addTagsToSelection: (args: {
         tagIds: Readonly<GlobalSelectionTypes.TagId[]>;
-    }) => Promise<ResultArray<TagSummaryDto>[]>;
+    }) => Promise<AddTagActionResult>;
     removeItemsFromSelection: (args: {
         itemIds: ReadonlyArray<GlobalSelectionTypes.ItemId>;
     }) => void;
@@ -64,6 +64,11 @@ export interface GlobalSelectionStore {
         itemIds: Readonly<GlobalSelectionTypes.ItemId[]>;
     }) => void;
 }
+type GlobalSelectionActionResult = 'NoChanges' | 'ItemsAdded';
+type AddTagActionResult = {
+    fetchResult: ResultArray<TagSummaryDto>[];
+    actionResult: GlobalSelectionActionResult;
+};
 export declare namespace GlobalSelectionTypes {
     type WorkOrderId = Pick<OptimizedWorkOrderDto, 'workOrderId'>;
     type EquipmentId = Pick<Equipment, 'equipmentId'>;
@@ -83,6 +88,7 @@ export declare namespace GlobalSelectionTypes {
     type EquipmentList = EquipmentGlobalSelectionList;
     type ListUnion = GlobalSelectionListUnion;
     type ItemTypeToDataMap = GlobalSelectionItemTypeToDataMap;
+    type AddTagResult = AddTagActionResult;
 }
 export interface OptimizedWorkOrderDto {
     workOrderId: string;

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

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

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

@@ -0,0 +1,18 @@
+import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
+import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+export type AddTagsArgs = {
+    itemIds: Readonly<GlobalSelectionTypes.TagId[]>;
+    replaceItems?: boolean;
+    getActionResult?: boolean;
+} & ({
+    label: string;
+    subLabel: string;
+} | {
+    label?: undefined;
+    subLabel?: undefined;
+});
+export type AddTagsResponse = {
+    fetchResults: ResultArray<TagSummaryDto>[];
+    actionResult: SelectionTreeActionResult;
+};
+export type SelectionTreeActionResult = 'ItemsUpdated' | 'ItemsAdded' | 'NewGroupCreated' | 'NoChanges';

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/initialData.d.ts

@@ -0,0 +1,10 @@
+import { SelectionCategory, SelectionGroup } from './selectionTree.store.types';
+export declare const selectionTreeInitialData: Readonly<{
+    localSelectionGroup: SelectionGroup;
+    categoryOrder: {
+        tagIndex: number;
+        workOrderIndex: number;
+    };
+    localSelectionGroupIndex: 0;
+    getInitialCategories: () => SelectionCategory[];
+}>;

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

@@ -1,19 +1,4 @@
 import { SelectionTreeStore } from './selectionTree.store.types';
-/**
- * Store for the selection menu, in a left panel.
- *
- * Stores the hierachry, tree structure of the items in Global Selection.
- * With this, it is in charge of:
- *   - tracking which item belongs to which list
- *   - adding items to global selection
- *   - remove items from global selection
- *   - update items (visibility, removal etc.) via list ids
- *   - maintaining the global selection store based on the changes in the items, in the selection menu panel
- *
- * You shouldn't use this store directly in any code, unless you have very special reason to do so.
- *
- * For accessing and using global selection features, use the globalSelectionApi from echo-framework.
- */
 export declare const useSelectionTreeStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<SelectionTreeStore>, "setState"> & {
     setState<A extends string | {
         type: string;

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

@@ -1,7 +1,8 @@
 import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
 import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionItemType, GlobalSelectionTypes, OptimizedWorkOrderDto } from '../../globalSelectionStore/globalSelectionStore.types';
-type SelectionItem = SelectionItemTag | SelectionItemWorkOrder | SelectionItemEquipment;
+import { AddTagsArgs, AddTagsResponse, SelectionTreeActionResult } from './actions/addTag.action.types';
+type SelectionItem = SelectionMenuTag | SelectionMenuWorkOrder | SelectionMenuEquipment;
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
     WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID"
@@ -12,15 +13,15 @@ export declare enum SelectionMenuDefaultListIds {
     TagList = "DEFAULT_TAG_LIST_ID",
     WorkOrderList = "DEFAULT_WORK_ORDER_LIST_ID"
 }
-interface SelectionItemTag {
+export interface SelectionMenuTag {
     id: GlobalSelectionTypes.TagId;
     type: GlobalSelectionItemType.Tag;
 }
-interface SelectionItemWorkOrder {
+export interface SelectionMenuWorkOrder {
     id: GlobalSelectionTypes.WorkOrderId;
     type: GlobalSelectionItemType.WorkOrder;
 }
-interface SelectionItemEquipment {
+export interface SelectionMenuEquipment {
     id: GlobalSelectionTypes.EquipmentId;
     type: GlobalSelectionItemType.Equipment;
 }
@@ -28,20 +29,19 @@ interface SelectionBase {
     label: string;
     subLabel?: string;
 }
-interface SelectionCategory extends SelectionBase {
+export interface SelectionCategory extends SelectionBase {
     id: GlobalSelectionCategoryId;
     items: SelectionItem[];
 }
-interface SelectionGroup extends SelectionBase {
+export interface SelectionGroup extends SelectionBase {
     id: Guid;
     categories: SelectionCategory[];
 }
 export interface SelectionTreeStore {
     groups: SelectionGroup[];
-    addTags: (args: {
-        groupId?: Guid;
-        itemIds: Readonly<GlobalSelectionTypes.TagId[]>;
-    }) => Promise<ResultArray<TagSummaryDto>[]>;
+    addTags: <T extends boolean | undefined>(args: AddTagsArgs & {
+        getActionResult?: T;
+    }) => Promise<AddTagsReturnType<T>>;
     addWorkOrders: (args: {
         groupId?: Guid;
         items: Readonly<Readonly<OptimizedWorkOrderDto>[]>;
@@ -52,8 +52,8 @@ export interface SelectionTreeStore {
     }) => void;
     createGroup: (args: {
         label: string;
-        subLabel?: string;
-    }) => Guid | undefined;
+        subLabel: string;
+    }) => Guid;
     removeGroupById: (args: {
         groupId: Guid;
         categoryId?: GlobalSelectionCategoryId;
@@ -77,8 +77,7 @@ export declare namespace SelectionTreeTypes {
     type Category = SelectionCategory;
     type Group = SelectionGroup;
     type Item = SelectionItem;
-    type TagItem = SelectionItemTag;
-    type WorkOrderItem = SelectionItemWorkOrder;
-    type EquipmentItem = SelectionItemEquipment;
+    type ActionResult = SelectionTreeActionResult;
 }
+export type AddTagsReturnType<T extends boolean | undefined> = T extends true ? Promise<AddTagsResponse> : Promise<ResultArray<TagSummaryDto>[]>;
 export {};

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

@@ -1,5 +1,6 @@
+import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
-import { SelectionTreeTypes } from './selectionTree.store.types';
+import { GlobalSelectionCategoryId, SelectionTreeTypes } from './selectionTree.store.types';
 /**
  * Check if an item ID is present in the selection tree.
  *
@@ -51,3 +52,19 @@ export declare function itemsNotFoundInSelectionTree(args: {
     groups: SelectionTreeTypes.Group[];
     itemIds: GlobalSelectionTypes.ItemId[];
 }): GlobalSelectionTypes.ItemId[];
+/**
+ * Checks if the items in a given group's category are the same as the provided item IDs.
+ *
+ * @param args - The arguments object.
+ * @param args.itemIds - An array of item IDs to compare.
+ * @param args.groups - An array of groups to search within.
+ * @param args.groupId - The ID of the group to check.
+ * @param args.categoryId - The ID of the category within the group to check.
+ * @returns `true` if the items in the group are the same as the provided item IDs, otherwise `false`.
+ */
+export declare function areItemsTheSameInGroup(args: {
+    itemIds: GlobalSelectionTypes.TagId[];
+    groups: SelectionTreeTypes.Group[];
+    groupId: Guid;
+    categoryId: GlobalSelectionCategoryId;
+}): boolean;