@equinor/echo-framework 0.20.5-beta-7 → 0.20.5-beta9

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.20.5-beta-7",
+  "version": "0.20.5-beta9",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",
-    "@equinor/echo-core": "^0.20.5-beta-4",
+    "@equinor/echo-core": ">= 0.9.0 < 0.10.0",
     "@equinor/echo-search": ">= 0.15.0 < 0.16.0",
     "@equinor/echo-utils": ">= 0.4.0 < 0.5.0",
     "@equinor/eds-core-react": "0.34.0",

package/src/index.d.ts

@@ -2,14 +2,10 @@ import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
 export * from './lib/components';
-export { OpenIn3dDialogs } from './lib/components/openIn3d/OpenIn3dDialogs';
-export { OpenIn3dWarningDialog } from './lib/components/openIn3d/OpenIn3dWarningDialog';
-export { PlantNoSelectionDialog } from './lib/components/openIn3d/PlantNoSelectionDialog';
-export { SelectedItemsMenu } from './lib/components/openIn3d/SelectedItemsMenu';
 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 * from './lib/feature/equipment/index';
@@ -19,6 +15,8 @@ export * from './lib/feature/legend/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 { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
 export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabled';

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

@@ -0,0 +1,9 @@
+import { BaseError } from '@equinor/echo-base';
+interface OpenGlobalSelectionIn3DButtonProps {
+    onPlantLoadError: (args: {
+        error: Error | BaseError;
+        errorMessage: string;
+    }) => void;
+}
+export declare const OpenGlobalSelectionIn3DButton: ({ onPlantLoadError }: OpenGlobalSelectionIn3DButtonProps) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -53,6 +53,10 @@ export interface GlobalSelectionStore {
     setNotFoundItems: (args: {
         itemIds: Readonly<string[]>;
     }) => void;
+    setVisibility: (args: {
+        itemId: string;
+        isVisible: boolean;
+    }) => void;
     resetItemNotFoundStates: () => void;
     resetState: () => void;
 }

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

@@ -1,5 +1,7 @@
-import { GlobalSelectionGenericItem, GlobalSelectionItemErrorStatuses, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionListUnion, GlobalSelectionStore } from './globalSelectionStore.types';
+import { PlantTagPair } from '../../openItemsIn3d/openItemsIn3d.utils';
+import { GlobalSelectionGenericItem, GlobalSelectionItem, GlobalSelectionItemErrorStatuses, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionListUnion, GlobalSelectionStore } from './globalSelectionStore.types';
 export declare function toGlobalSelectionItem<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(item: T, type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>;
 export declare function toGlobalSelectionItems<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>[];
 export declare function findGlobalSelectionListByKey(state: GlobalSelectionStore, key: string): GlobalSelectionListUnion | undefined;
 export declare function hasGlobalSelectionItemErrorStatus<T extends GlobalSelectionItemType>(item: GlobalSelectionGenericItem<T>, status: GlobalSelectionItemErrorStatuses): boolean;
+export declare const convertGlobalSelectionItemsToPlantTagPairs: (items: GlobalSelectionItem[]) => PlantTagPair[];

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionItems.d.ts

@@ -0,0 +1,2 @@
+import { GlobalSelectionItem } from '../globalSelectionStore/globalSelectionStore.types';
+export declare const useGlobalSelectionItems: () => GlobalSelectionItem[];

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

@@ -1,6 +1,8 @@
 export { getGlobalSelectionStoreState, useGlobalSelectionStore } from './globalSelectionStore/globalSelectionStore';
 export * from './globalSelectionStore/globalSelectionStore.types';
-export { hasGlobalSelectionItemErrorStatus } from './globalSelectionStore/globalSelectionStore.utils';
+export { convertGlobalSelectionItemsToPlantTagPairs, hasGlobalSelectionItemErrorStatus } from './globalSelectionStore/globalSelectionStore.utils';
+export { useGlobalSelectionItems } from './hooks/useGlobalSelectionItems';
 export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
 export { useGlobalSelectionTags } from './hooks/useGlobalSelectionTags';
 export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';
+export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';

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

@@ -0,0 +1,3 @@
+export type { PlantTagPair } from './openItemsIn3d.utils';
+export { OpenItemsIn3dDialog } from './openItemsIn3dDialog';
+export { SelectedItemsMenu } from './SelectedItemsMenu';

package/src/lib/{components/openIn3d/OpenIn3dWarningDialog.d.ts → feature/openItemsIn3d/openIn3dWarningDialog.d.ts}

@@ -1,7 +1,7 @@
-import React, { Dispatch, SetStateAction } from 'react';
+import React from 'react';
 interface OpenIn3dWarningDialogProps {
     open: boolean;
-    setIsOpenIn3dWarningDialogOpen: Dispatch<SetStateAction<boolean>>;
+    onOKButtonClicked?: () => void;
 }
 export declare const OpenIn3dWarningDialog: React.FC<OpenIn3dWarningDialogProps>;
 export {};

package/src/lib/feature/openItemsIn3d/openItemsIn3d.utils.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Retrieves unique plant numbers and item number counts from an array of PlantTagPair objects.
+ *
+ * @param args - The arguments for the function.
+ * @param args.items - The array of PlantTagPair objects.
+ * @returns An object containing unique plant numbers and item number counts.
+ */
+export declare function getUniquePlantNosAndItemNoCounts(args: {
+    items: PlantTagPair[];
+}): {
+    uniquePlantNos: string[];
+    itemCountsByPlantNo: Record<string, number>;
+};
+/**
+ * Retrieves the items from the given array that have the same plant number as the selected plant number.
+ *
+ * @param selectedItems - The array of PlantTagPair objects.
+ * @param selectedPlantNo - The selected plant number.
+ * @returns An array of PlantTagPair objects that have the same plant number as the selected plant number.
+ */
+export declare function getItemsForSelectedPlantNo(selectedItems: PlantTagPair[], selectedPlantNo: string): PlantTagPair[];
+/**
+ * Checks if there are more then one unique plant numbers in the passed PlantTagPair[].
+ *
+ * @param items - The array of PlantTagPair objects to check.
+ * @returns A boolean indicating whether multiple, unique plant numbers are present in the passed array.
+ */
+export declare function isMultiplePlantNoSelected(items: PlantTagPair[]): boolean;
+/**
+ * Retrieves the plant SAP ID from an array of PlantTagPair. It will return with the first, non empty plant SAP ID found.
+ * @param items - The array of PlantTagPair items.
+ * @returns The plant SAP ID if found, otherwise undefined.
+ */
+export declare function getPlantSapIdFromItems(items: PlantTagPair[]): string | undefined;
+export interface PlantTagPair {
+    plantNo: string | undefined;
+    tagNo: string | undefined;
+}

package/src/lib/feature/openItemsIn3d/openItemsIn3dDialog.d.ts

@@ -0,0 +1,49 @@
+import { BaseError } from '@equinor/echo-base';
+import { PlantTagPair } from './openItemsIn3d.utils';
+/**
+ * This component is designed to facilitate the opening of items in a 3D view within the application.
+ * It manages user interactions for selecting a plant number when multiple options are available,
+ * displays warnings if there are issues with opening items in 3D, and handles scenarios where a plant is not available.
+ * Contains built in mechanism to open items in 3d, but can be disabled if the consumer wants to handle this themselves.
+ *
+ * @component
+ * @param {Object} props - The properties passed to the component.
+ * @param {Array} props.items - Array of items that the user intends to open in 3D. Each item should contain necessary information for the 3D view to be rendered.
+ * @param {boolean} props.open - Boolean indicating whether the dialog should be open or closed.
+ * @param {Function} props.onPlantLoadError - Function to be called when there is an error loading the plant information. Only needed when props.disableDefault3dOpener=false.
+ * @param {Function} props.onPlantSelectionCompleted - Function to be called when the plant selection process has been completed by the user.
+ * @param {Function} props.onCancelButtonClicked - Function to be called when the user clicks the cancel button.
+ * @param {Object} props.plantNotAvailableDialogProps - Object containing properties for the dialog shown when a plant is not available. Only needed when props.disableDefault3dOpener=true.
+ * @param {boolean} [props.disableDefault3dOpener=false] - Boolean indicating whether the default mechanism to open items in 3D should be disabled.
+ *
+ * @returns {React.ReactElement} A React Element representing the OpenItemsIn3dDialog.
+ *
+ */
+export declare const OpenItemsIn3dDialog: ({ items, open, onPlantLoadError, onPlantSelectionCompleted, onCancelButtonClicked, plantNotAvailableDialogProps, disableDefault3dOpener }: OpenItemsIn3dDialogProps) => import("react/jsx-runtime").JSX.Element;
+interface BaseOpenItemsIn3dDialogProps {
+    items: PlantTagPair[];
+    onPlantSelectionCompleted: (args: {
+        plantId: string | undefined;
+        itemsForSelectedPlant: PlantTagPair[];
+    }) => void;
+    onCancelButtonClicked: () => void;
+    open: boolean;
+}
+interface WithDefault3dOpener extends BaseOpenItemsIn3dDialogProps {
+    disableDefault3dOpener?: false;
+    onPlantLoadError: (args: {
+        error: Error | BaseError;
+        errorMessage: string;
+    }) => void;
+    plantNotAvailableDialogProps?: never;
+}
+interface WithDefault3dOpenerDisabled extends BaseOpenItemsIn3dDialogProps {
+    disableDefault3dOpener: true;
+    plantNotAvailableDialogProps: {
+        open: boolean;
+        onCloseDialogClicked: () => void;
+    };
+    onPlantLoadError?: never;
+}
+type OpenItemsIn3dDialogProps = WithDefault3dOpenerDisabled | WithDefault3dOpener;
+export {};

package/src/lib/feature/openItemsIn3d/plantNoSelectionDialog.d.ts

@@ -0,0 +1,9 @@
+import { PlantTagPair } from './openItemsIn3d.utils';
+interface PlantNoSelectionDialogProps {
+    items: PlantTagPair[];
+    onPlantSelectionConfirmed: (plantId: string, itemsForSelectedPlant: PlantTagPair[]) => void;
+    onCancelButtonClicked: () => void;
+    open: boolean;
+}
+export declare const PlantNoSelectionDialog: ({ items, onPlantSelectionConfirmed, onCancelButtonClicked, open }: PlantNoSelectionDialogProps) => JSX.Element;
+export {};

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

@@ -0,0 +1,4 @@
+export declare const echopediaWebReactPortalUtils: Readonly<{
+    portalId: "echopedia-web--dialog-container";
+    domSelector: HTMLElement;
+}>;

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

@@ -1,3 +1,4 @@
+export { echopediaWebReactPortalUtils } from './echopediaWebReactPortal.utils';
 export * from './formatTimeHelpers';
 export * from './navigationUtils';
 export * from './openIn3d';

package/src/lib/components/openIn3d/OpenIn3dDialogs.d.ts

@@ -1,14 +0,0 @@
-import React, { Dispatch, SetStateAction } from 'react';
-interface OpenIn3dDialogsProps {
-    isOpenIn3dWarningDialogOpen: boolean;
-    isSelectPlantNoDialogOpen: boolean;
-    setIsOpenIn3dWarningDialogOpen: Dispatch<React.SetStateAction<boolean>>;
-    setIsSelectPlantNoDialogOpen: Dispatch<React.SetStateAction<boolean>>;
-    onOKButtonClicked: () => void;
-    uniquePlantNos: string[];
-    tagNoCounts: Record<string, number>;
-    selectedPlantNo: string | undefined;
-    setSelectedPlantNo: Dispatch<SetStateAction<string | undefined>>;
-}
-export declare const OpenIn3dDialogs: React.FC<OpenIn3dDialogsProps>;
-export {};

package/src/lib/components/openIn3d/PlantNoSelectionDialog.d.ts

@@ -1,13 +0,0 @@
-import React, { Dispatch, SetStateAction } from 'react';
-interface PlantNoSelectionDialogProps {
-    onOKButtonClicked: () => void;
-    open: boolean;
-    uniquePlantNos: string[];
-    selectedPlantNo: string | undefined;
-    setSelectedPlantNo: Dispatch<SetStateAction<string | undefined>>;
-    isSelectPlantNoDialogOpen: boolean;
-    setIsSelectPlantNoDialogOpen: Dispatch<SetStateAction<boolean>>;
-    tagNoCounts: Record<string, number>;
-}
-export declare const PlantNoSelectionDialog: React.FC<PlantNoSelectionDialogProps>;
-export {};

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

@@ -1,4 +0,0 @@
-export { OpenIn3dDialogs } from './OpenIn3dDialogs';
-export { OpenIn3dWarningDialog } from './OpenIn3dWarningDialog';
-export { PlantNoSelectionDialog } from './PlantNoSelectionDialog';
-export { SelectedItemsMenu } from './SelectedItemsMenu';