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

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

@@ -0,0 +1,70 @@
+import { Guid } from '@equinor/echo-utils';
+import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
+import { GlobalSelectionCategoryId, SelectionTreeTypes } from './selectionTree.store.types';
+/**
+ * Check if an item ID is present in the selection tree.
+ *
+ * This function checks if a given item ID is present in the selection tree within a specific group and category.
+ * If groupId or categoryId is not provided, it checks all groups and categories.
+ *
+ * @param {Object} args - The function arguments.
+ * @param {GlobalSelectionTypes.ItemId} args.itemId - The ID of the item to check.
+ * @param {string} [args.groupId] - The ID of the group to check within (optional).
+ * @param {string} [args.categoryId] - The ID of the category to check within (optional).
+ * @param {SelectionTreeTypes.Group[]} args.groups - The selection tree groups to check within.
+ * @returns {boolean} True if the item ID is present in the selection tree, false otherwise.
+ */
+export declare function isItemIdInSelectionTree(args: {
+    itemId: GlobalSelectionTypes.ItemId;
+    groupId?: string;
+    categoryId?: string;
+    groups: SelectionTreeTypes.Group[];
+}): boolean;
+/**
+ * Find a selection category by group ID and optionally category ID.
+ *
+ * This function finds the group and optionally the category within the selection tree groups.
+ *
+ * @param {Object} args - The function arguments.
+ * @param {string} args.groupId - The ID of the group to search within.
+ * @param {string} [args.categoryId] - The ID of the category to search for (optional).
+ * @param {SelectionTreeTypes.Group[]} args.groups - The selection tree groups to search within.
+ * @returns {Object | undefined} The group and optionally the category, or undefined if not found.
+ */
+export declare function findSelectionCategoryById(args: {
+    groupId: string;
+    categoryId?: string;
+    groups: SelectionTreeTypes.Group[];
+}): {
+    group: SelectionTreeTypes.Group;
+    category?: SelectionTreeTypes.Category;
+} | undefined;
+/**
+ * Retrieves an array of itemIds that were not found in the selection menu.
+ *
+ * @param {Object} args - The arguments containing the list and itemIds to check.
+ * @param {SelectionTreeTypes.Group[]} args.groups - The list of SelectionMenuList objects to search through.
+ * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - An array of ItemId objects to check for presence in the list.
+ * @returns {GlobalSelectionTypes.ItemId[]} An array of itemId strings that correspond to counts of 0 in the selection menu.
+ * itemIds object values are concatenated via '-' char
+ */
+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;

package/src/lib/feature/legacyLegend/legend.d.ts

@@ -34,9 +34,11 @@ export declare enum LegendStatus {
     PM20 = "PM20",
     LC = "LC",
     LO = "LO",
-    OnWatch = "OnWatch",
-    InProgress = "InProgress",
-    IocAnnotationError = "IocAnnotationError"
+    OnWatch = "On watch",
+    InProgress = "In progress",
+    IocAnnotationError = "IocAnnotationError",
+    Note = "Note",
+    Archived = "Archived"
 }
 /**
  * Renaming these strings are BREAKING: since it's saved with zustand store.

package/src/lib/hooks/useCommPackSearch.d.ts

@@ -0,0 +1,2 @@
+import { SetActiveCommPackNo } from '../types/hookLibrary';
+export declare function useCommPackSearch(): SetActiveCommPackNo;

package/src/lib/hooks/useMcPackSearch.d.ts

@@ -0,0 +1,2 @@
+import { SetActiveMcPackNo } from '../types/hookLibrary';
+export declare function useMcPackSearch(): SetActiveMcPackNo;

package/src/lib/utils/mediaTypeUtils.d.ts

@@ -0,0 +1,2 @@
+export declare function isImage(fileName: string): boolean;
+export declare function isVideo(fileName: string): boolean;

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

@@ -1,7 +0,0 @@
-import { SelectionMenuList } from '../selectionMenuStore/selectionMenu.store.types';
-/**
- * Custom hook to get the selection menu lists from the selection menu store, displayed in the left selection panel.
- *
- * @returns {SelectionMenuList[]} - An array of selection menu lists.
- */
-export declare function useSelectionMenuLists(): SelectionMenuList[];

package/src/lib/feature/globalSelection/selectionMenu/selectionMenuStore/selectionMenu.store.d.ts

@@ -1,28 +0,0 @@
-import { SelectionMenuStore } from './selectionMenu.store.types';
-export declare enum SelectionMenuDefaultListIds {
-    TagList = "DEFAULT_TAG_LIST_ID",
-    WorkOrderList = "DEFAULT_WORK_ORDER_LIST_ID"
-}
-export declare const useSelectionMenuStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<SelectionMenuStore>, "setState"> & {
-    setState<A extends string | {
-        type: string;
-    }>(partial: SelectionMenuStore | Partial<SelectionMenuStore> | ((state: SelectionMenuStore) => SelectionMenuStore | Partial<SelectionMenuStore>), replace?: boolean | undefined, action?: A | undefined): void;
-}, "subscribe"> & {
-    subscribe: {
-        (listener: (selectedState: SelectionMenuStore, previousSelectedState: SelectionMenuStore) => void): () => void;
-        <U>(selector: (state: SelectionMenuStore) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
-            equalityFn?: ((a: U, b: U) => boolean) | undefined;
-            fireImmediately?: boolean;
-        } | undefined): () => void;
-    };
-}, "setState"> & {
-    setState(nextStateOrUpdater: SelectionMenuStore | Partial<SelectionMenuStore> | ((state: import("immer").WritableDraft<SelectionMenuStore>) => void), shouldReplace?: boolean | undefined, action?: string | {
-        type: string;
-    } | undefined): void;
-}>;
-/**
- * Get a snapshot of the current selection menu store state.
- *
- * Selection menu: left panel, which holds items from global selection.
- */
-export declare function getSelectionMenuStoreSnapshot(): SelectionMenuStore;

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

@@ -1,56 +0,0 @@
-import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
-import { Guid } from '@equinor/echo-utils';
-import { GlobalSelectionItemType, GlobalSelectionTypes, OptimizedWorkOrderDto } from '../../globalSelectionStore/globalSelectionStore.types';
-import { SelectionMenuDefaultListIds } from './selectionMenu.store';
-export type SelectionMenuItem = SelectionMenuTag | SelectionMenuWorkOrder | SelectionMenuEquipment;
-export interface SelectionMenuTag {
-    id: GlobalSelectionTypes.TagId;
-    type: GlobalSelectionItemType.Tag;
-}
-export interface SelectionMenuWorkOrder {
-    id: GlobalSelectionTypes.WorkOrderId;
-    type: GlobalSelectionItemType.WorkOrder;
-}
-export interface SelectionMenuEquipment {
-    id: GlobalSelectionTypes.EquipmentId;
-    type: GlobalSelectionItemType.Equipment;
-}
-export type SelectionMenuList = SelectionMenuWithItems | SelectionMenuWithSubLists;
-interface SelectionMenuBase {
-    id: Guid | SelectionMenuDefaultListIds;
-    label: string;
-}
-interface SelectionMenuWithItems extends SelectionMenuBase {
-    items: SelectionMenuItem[];
-    subLists?: never;
-}
-interface SelectionMenuWithSubLists extends SelectionMenuBase {
-    subLists: SelectionMenuWithItems[];
-    items?: never;
-}
-export interface SelectionMenuStore {
-    lists: SelectionMenuList[];
-    addItems: (args: {
-        listId?: string;
-        itemIds: (GlobalSelectionTypes.TagId | OptimizedWorkOrderDto)[];
-    }) => void;
-    addTags: (args: {
-        listId?: string;
-        itemIds: Readonly<GlobalSelectionTypes.TagId[]>;
-    }) => Promise<ResultArray<TagSummaryDto>[]>;
-    addWorkOrders: (args: {
-        listId?: string;
-        items: Readonly<Readonly<OptimizedWorkOrderDto>[]>;
-    }) => void;
-    addList: (args: SelectionMenuList) => void;
-    removeItemsByListId: (args: {
-        listId: string;
-        itemIds: GlobalSelectionTypes.ItemId[];
-    }) => void;
-    setVisibilityByListId: (args: {
-        listId: string;
-        isVisible: boolean;
-    }) => void;
-    resetState: () => void;
-}
-export {};

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

@@ -1,56 +0,0 @@
-import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
-import { SelectionMenuList } from './selectionMenu.store.types';
-/**
- * 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.
- * @param {SelectionMenuList[]} args.lists - An optional array of selection menu lists to search within.
- * If not provided, the function will use the lists from the selection menu store state.
- * If you want to alter the store state, you should provide the lists as an argument.
- * @returns {SelectionMenuList | undefined} The selection menu list with the specified ID, or `undefined` if not found.
- */
-export declare function findSelectionListById(args: {
-    listId: string;
-    lists: SelectionMenuList[];
-}): SelectionMenuList | undefined;
-/**
- * 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.
- * @param {SelectionMenuList[]} args.lists - The selection menu lists where you would like to search for the given item.
- * @returns {boolean} A boolean indicating whether the item ID is found in the list.
- */
-export declare function isItemIdInList(args: {
-    itemId: GlobalSelectionTypes.ItemId;
-    listId: string;
-    lists: SelectionMenuList[];
-}): 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.
- * @param {SelectionMenuList[]} args.lists - The selection menu lists where you would like to search for the given item.
- * @returns {boolean} A boolean indicating whether the item ID is present in the selection lists.
- */
-export declare function isItemIdInTheSelection(args: {
-    itemId?: GlobalSelectionTypes.ItemId;
-    lists: SelectionMenuList[];
-}): boolean;
-/**
- * Retrieves an array of itemIds that were not found in the selection menu.
- *
- * @param {Object} args - The arguments containing the list and itemIds to check.
- * @param {SelectionMenuList[]} args.list - The list of SelectionMenuList objects to search through.
- * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - An array of ItemId objects to check for presence in the list.
- * @returns {string[]} An array of itemId strings that correspond to counts of 0 in the selection menu.
- * itemIds object values are concatenated via '-' char
- */
-export declare function itemsNotFoundInSelectionMenu(args: {
-    lists: SelectionMenuList[];
-    itemIds: GlobalSelectionTypes.ItemId[];
-}): string[];