@equinor/echo-framework 0.21.1 → 0.21.3

package/package.json

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

package/src/lib/components/prepview/Prepview.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { SideSheetOrientation, WorkOrderDateType } from '@equinor/echo-components';
+import { SEBadgeType, SNBadgeType, WoBadgeType } from './colors';
 import { Coordinates, HistoricNotificationItem, HistoricPunchItem, HistoricWorkOrderItem, ItemTypes, WorkOrderEquipment } from './types';
 import { WorkItemType } from './utils';
-import { SEBadgeType, SNBadgeType, WoBadgeType } from './colors';
 interface PrepviewProps {
     orientation: SideSheetOrientation;
     headerAction?: React.ReactNode;
@@ -25,5 +25,5 @@ interface PrepviewProps {
 }
 declare function Prepview(props: PrepviewProps): JSX.Element | null;
 export * from './types/shared';
-export { MaintenanceApiNameForWorkOrders, WorkItemType } from './utils';
+export { WorkItemType } from './utils';
 export { Prepview };

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

@@ -5,4 +5,3 @@ export * from './logger';
 export * from './object';
 export * from './string';
 export * from './url';
-export * from './workorder';

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

@@ -1,8 +1,8 @@
 import { WorkOrderDateType } from '@equinor/echo-components';
 interface WorkOrderProps {
-    workOrderId: string;
-    headerAction?: React.ReactNode;
-    workOrderDateType?: WorkOrderDateType;
+    readonly workOrderId: string;
+    readonly headerAction?: React.ReactNode;
+    readonly workOrderDateType?: WorkOrderDateType;
 }
-declare function WorkOrder(props: WorkOrderProps): JSX.Element | null;
-export { WorkOrder };
+export declare const WorkOrder: React.FC<WorkOrderProps>;
+export {};

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

@@ -1,8 +1,8 @@
 import React from 'react';
 export interface PrepviewButtonProps {
-    workOrderId?: string | undefined;
-    notificationId?: string | undefined;
-    punchId?: string | undefined;
-    instCode?: string | undefined;
+    workOrderId?: string;
+    notificationId?: string;
+    punchId?: string;
+    instCode?: string;
 }
 export declare const PrepviewButton: React.FC<PrepviewButtonProps>;

package/src/lib/feature/globalSelection/components/RemoveSelectionItemsConfirmDialog.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const RemoveSelectionItemsConfirmDialog: React.FC;

package/src/lib/feature/globalSelection/eventHub/globalSelectionEventHubActions.d.ts

@@ -0,0 +1,6 @@
+import { OpenRemoveSelectionItemsConfirmDialogEvent } from './globalSelectionEventHubEvents';
+/**
+ * Emit a statuses for item type event on echo core eventHub with a specific payload.
+ * @param {OpenRemoveSelectionItemsConfirmDialogEvent} payload
+ */
+export declare const emitOpenRemoveSelectionItemsConfirmDialog: (payload: OpenRemoveSelectionItemsConfirmDialogEvent) => void;

package/src/lib/feature/globalSelection/eventHub/globalSelectionEventHubEvents.d.ts

@@ -0,0 +1,11 @@
+import { Guid } from '@equinor/echo-utils';
+import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
+export interface OpenRemoveSelectionItemsConfirmDialogEvent {
+    itemIds: GlobalSelectionTypes.ItemId[];
+    affectedGroups: {
+        id: Guid;
+        label: string;
+        subLabel?: string;
+    }[];
+    onDialogConfirm: () => void;
+}

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

@@ -35,6 +35,18 @@ export declare const globalSelectionApi: Readonly<{
             categoryId: GlobalSelectionCategoryId;
             itemIds: GlobalSelectionTypes.ItemId[];
         }) => void;
+        /**
+         * Removes all items by their IDs, from all groups, from the state.
+         *
+         * If the given item ids are in more than one group, then a confirmation dialog will be shown to confirm the action.
+         *
+         * @param {Object} args - The arguments object.
+         * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - The array of item IDs to remove.
+         * @returns {void}
+         */
+        allItemsById: (args: {
+            itemIds: GlobalSelectionTypes.ItemId[];
+        }) => void;
         /**
          * Removes a group or category by ID from the selection store.
          *
@@ -89,7 +101,15 @@ export declare const globalSelectionApi: Readonly<{
          *
          */
         addItems: (args: {
-            groupId?: import("dist/libs/echo-utils/src").Guid;
+            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: (GlobalSelectionTypes.TagId | import("./globalSelectionStore/globalSelectionStore.types").OptimizedWorkOrderDto)[];
         }) => void;
     }>;

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

@@ -9,4 +9,5 @@ export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrde
 export { useSelectionCategoriesByGroupId } from './hooks/useSelectionCategoriesByGroupId';
 export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
 export { useSelectionMenuGroups } from './selectionMenu/hooks/useSelectionMenuGroups';
+export { RemoveSelectionItemsConfirmDialog } from './components/RemoveSelectionItemsConfirmDialog';
 export * from './selectionMenu/selectionTreeStore/selectionTree.store.types';

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

@@ -0,0 +1,16 @@
+import { WritableDraft } from 'immer';
+import { GlobalSelectionTypes } from '../../../globalSelectionStore/globalSelectionStore.types';
+import { SelectionTreeStore } from '../selectionTree.store.types';
+type SetFunction = (set: (state: WritableDraft<SelectionTreeStore>) => void, shouldReplace?: boolean | undefined, action?: string) => void;
+/**
+ * Removes all items by their IDs, from all groups, from the state.
+ *
+ * @param {SetFunction} set - The function to update the state.
+ * @param {Object} args - The arguments object.
+ * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - The array of item IDs to remove.
+ * @returns {void}
+ */
+export declare function removeAllItemsById(set: SetFunction, args: {
+    itemIds: GlobalSelectionTypes.ItemId[];
+}): void;
+export {};

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

@@ -66,6 +66,9 @@ export interface SelectionTreeStore {
         categoryId: GlobalSelectionCategoryId;
         itemIds: GlobalSelectionTypes.ItemId[];
     }) => void;
+    removeAllItemsById: (args: {
+        itemIds: GlobalSelectionTypes.ItemId[];
+    }) => void;
     setVisibilityById: (args: {
         groupId: Guid;
         categoryId?: GlobalSelectionCategoryId;

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

@@ -1,6 +1,7 @@
 import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
 import { GlobalSelectionCategoryId, SelectionTreeTypes } from './selectionTree.store.types';
+import { WritableDraft } from 'immer';
 /**
  * Check if an item ID is present in the selection tree.
  *
@@ -53,18 +54,43 @@ export declare function itemsNotFoundInSelectionTree(args: {
     itemIds: GlobalSelectionTypes.ItemId[];
 }): GlobalSelectionTypes.ItemId[];
 /**
- * Checks if the items in a given group's category are the same as the provided item IDs.
+ * Get an array of group IDs where any of the item IDs are found.
  *
- * @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`.
+ * This function searches through the selection tree groups and returns an array of group IDs
+ * where any of the specified item IDs are found.
+ *
+ * @param {Object} args - The function arguments.
+ * @param {GlobalSelectionTypes.ItemId[]} args.itemIds - The array of item IDs to search for.
+ * @param {SelectionTreeTypes.Group[]} args.groups - The selection tree groups to search within.
+ * @returns {string[]} An array of group IDs, with labels and sublabels, where any of the item IDs are found.
  */
+export declare function getGroupIdsByItemIds(args: {
+    itemIds: GlobalSelectionTypes.ItemId[];
+    groups: SelectionTreeTypes.Group[];
+}): {
+    id: Guid;
+    label: string;
+    subLabel?: string;
+}[];
 export declare function areItemsTheSameInGroup(args: {
     itemIds: GlobalSelectionTypes.TagId[];
     groups: SelectionTreeTypes.Group[];
     groupId: Guid;
     categoryId: GlobalSelectionCategoryId;
 }): boolean;
+/**
+ * Removes an empty group from the list of groups, except if it's the local (default) selection.
+ *
+ * @param {WritableDraft<SelectionTreeTypes.Group[]>} allGroups - The list of all groups.
+ * @param {SelectionTreeTypes.Group} targetGroup - The group to check and potentially remove.
+ * @returns {void}
+ */
+export declare function removeGroupIfEmpty(allGroups: WritableDraft<SelectionTreeTypes.Group[]>, targetGroup: SelectionTreeTypes.Group): void;
+/**
+ * Removes items from the global selection if they are not present in the tree store anymore.
+ *
+ * @param {SelectionTreeTypes.Group[]} groups - The list of groups in the selection tree.
+ * @param {GlobalSelectionTypes.ItemId[]} itemIds - The list of item IDs to be checked and potentially removed.
+ * @returns {void}
+ */
+export declare function removeItemsFromGlobalSelection(groups: SelectionTreeTypes.Group[], itemIds: GlobalSelectionTypes.ItemId[]): void;

package/src/lib/types/eventTypes/plantEvent.d.ts

@@ -4,3 +4,8 @@ export interface PlantEvent {
     stayOnPath?: boolean;
     alertUserPlantChanged?: boolean;
 }
+export interface PlantSelectedToBeOpenedIn3DEvent {
+    instCode: string;
+    sapId: string | undefined;
+    pdmsPlantCode: string | undefined;
+}

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

@@ -1 +0,0 @@
-export declare const MaintenanceApiNameForWorkOrders: Record<string, string>;

package/src/lib/components/prepview/workorder/pm15/PM15WorkOrder.d.ts

@@ -1,6 +0,0 @@
-import { WorkOrderDetails } from '../../types';
-export interface Props {
-    workOrderDetails: WorkOrderDetails;
-}
-declare function PM15WorkOrder({ workOrderDetails }: Props): JSX.Element;
-export { PM15WorkOrder };

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

@@ -1,5 +0,0 @@
-export interface WOEquipmentProps {
-    workOrderId: string;
-}
-declare function WOEquipment({ workOrderId }: WOEquipmentProps): JSX.Element;
-export { WOEquipment };

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

@@ -1,6 +0,0 @@
-import { WorkOrderEquipment } from '../../../types';
-interface WOEquipmentHorizontalProps {
-    equipment: WorkOrderEquipment[];
-}
-declare function WOEquipmentHorizontal({ equipment }: WOEquipmentHorizontalProps): import("react/jsx-runtime").JSX.Element;
-export { WOEquipmentHorizontal };

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

@@ -1,6 +0,0 @@
-import { WorkOrderEquipment } from '../../../types';
-interface WOEquipmentVerticalProps {
-    equipment: WorkOrderEquipment[];
-}
-declare function WOEquipmentVertical({ equipment }: WOEquipmentVerticalProps): import("react/jsx-runtime").JSX.Element;
-export { WOEquipmentVertical };

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

@@ -1,18 +0,0 @@
-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/components/prepview/workorder/pm15/equipment/index.d.ts

@@ -1 +0,0 @@
-export * from './WOEquipment';

package/src/lib/components/prepview/workorder/pm15/index.d.ts

@@ -1 +0,0 @@
-export * from './PM15WorkOrder';