@equinor/echo-framework 0.25.5 → 0.26.4

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.25.5",
+  "version": "0.26.4",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 0.7.6 < 0.8.0",
-    "@equinor/echo-components": ">= 0.12.4 < 0.13.0",
-    "@equinor/echo-core": ">= 0.9.20 < 0.10.0",
-    "@equinor/echo-search": ">= 0.15.7 < 0.16.0",
-    "@equinor/echo-utils": ">= 0.4.16 < 0.5.0",
+    "@equinor/echo-base": ">= 0.26.4 < 0.27.0",
+    "@equinor/echo-components": ">= 0.26.4 < 0.27.0",
+    "@equinor/echo-core": ">= 0.26.4 < 0.27.0",
+    "@equinor/echo-search": ">= 0.26.4 < 0.27.0",
+    "@equinor/echo-utils": ">= 0.26.4 < 0.27.0",
     "@equinor/eds-core-react": "0.43.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",

package/src/lib/components/prepview/common/additionalInformation/WOAdditionalDetails.d.ts

@@ -2,5 +2,5 @@ import type { WorkOrderDetails } from '../../types';
 interface Props {
     workOrderDetails?: WorkOrderDetails;
 }
-declare function WOAdditionalDetails({ workOrderDetails }: Props): import("react/jsx-runtime").JSX.Element | null;
-export { WOAdditionalDetails };
+export declare function WOAdditionalDetails({ workOrderDetails }: Readonly<Props>): JSX.Element | null;
+export {};

package/src/lib/components/prepview/common/info/block/InfoBlock.d.ts

@@ -5,5 +5,5 @@ interface InfoBlockType {
     children: JSX.Element | string[] | string | number;
     contentClassName?: string;
 }
-declare function InfoBlock({ label, stretched, fit, children, contentClassName }: InfoBlockType): JSX.Element;
-export { InfoBlock };
+export declare function InfoBlock({ label, stretched, fit, children, contentClassName }: Readonly<InfoBlockType>): JSX.Element;
+export {};

package/src/lib/components/prepview/workorder/details/DetailsWorkOrder.d.ts

@@ -3,5 +3,4 @@ export interface Props {
     workOrderDetails: WorkOrderDetails;
     isLoading?: boolean;
 }
-declare function DetailsWorkOrder({ workOrderDetails }: Props): JSX.Element;
-export { DetailsWorkOrder };
+export declare function DetailsWorkOrder({ workOrderDetails }: Readonly<Props>): JSX.Element;

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

@@ -3,5 +3,7 @@ export interface SelectionActionBarProps {
     itemId: GlobalSelectionTypes.ItemId;
     onAddItemClick: () => void;
     className?: string;
+    darkBackground?: boolean;
+    buttonSize?: 'medium' | 'small';
 }
 export declare const SelectionActionBar: React.FC<SelectionActionBarProps>;

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

@@ -132,8 +132,11 @@ export declare const globalSelectionApi: Readonly<{
             isVisible: boolean;
         }) => void;
         /**
-         * Sets the visibility of items in a specified list in global selection.
+         * Sets the visibility of items within a specific group or category.
          *
+         * If a categoryId is provided, only items within that category of the group will be updated.
+         * If no categoryId is provided, all items in all categories of the group will be updated.
+         * The visibility is controlled by the isVisible parameter.
          * @param {Object} args - The arguments for setting visibility.
          * @param {Guid} args.groupId - The ID of the group for which the visibility should be set.
          * @param {GlobalSelectionCategoryId} args.categoryId - Optional. The ID of the category for which the visibility should be set.
@@ -145,6 +148,12 @@ export declare const globalSelectionApi: Readonly<{
             categoryId?: GlobalSelectionCategoryId;
             isVisible: boolean;
         }) => void;
+        /**
+         * Sets the visibility of all items in the selection menu panel. Use it carefully, as it will affect all items in the selection.
+         */
+        setAll: (args: {
+            isVisible: boolean;
+        }) => void;
     }>;
     errorStatus: Readonly<{
         /**
@@ -203,4 +212,10 @@ export declare const globalSelectionApi: Readonly<{
         label: string;
         subLabel: string;
     }) => import("@equinor/echo-utils").Guid;
+    itemIds: {
+        /**
+         * Retrieves the unique IDs of all items stored in the selection menu panel.
+         */
+        getAll: () => Readonly<GlobalSelectionTypes.ItemId[]>;
+    };
 }>;

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

@@ -48,12 +48,4 @@ export declare const useGlobalSelectionStore: import("zustand").UseBoundStore<Om
         type: string;
     } | undefined): void;
 }>;
-/**
- * Get a snapshot of the current global selection store state.
- *
- * You shouldn't use this store directly in any code.
- * If you want to add, and remove items, use `useSelectionMenuStore` zustand store.
- *
- * For accessing and using global selection features, use the globalSelectionApi from echo-framework.
- */
 export declare function getGlobalSelectionStoreState(): GlobalSelectionTypes.Store;

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

@@ -75,11 +75,15 @@ export interface GlobalSelectionStore extends GlobalSelectionStoreData {
         itemIds: Readonly<Readonly<GlobalSelectionTypes.ItemId>>[];
         isVisible: boolean;
     }) => void;
+    setAllItemsVisibility: (args: {
+        isVisible: boolean;
+    }) => void;
     setItemMetaData: (args: ReadonlyArray<{
         itemId: GlobalSelectionTypes.ItemId;
         metaData: Partial<GlobalSelectionMetaData>;
     }>) => void;
     resetItemErrorStatuses: () => void;
+    getStoredItemIds: () => Readonly<GlobalSelectionTypes.ItemId[]>;
     resetState: () => void;
     setErrorStatusForItems: (args: {
         itemErrorStatuses: GlobalSelectionTypes.ItemErrorStatusUpdate[];

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

@@ -0,0 +1,5 @@
+/**
+ * React hook to get whether all items are visible in the global selection store.
+ * Returns true if all items are visible, false otherwise.
+ */
+export declare function useAreAllItemsVisible(): boolean;

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

@@ -1,8 +1,6 @@
-export { RemoveSelectionItemsConfirmDialog } from './components/RemoveSelectionItemsConfirmDialog';
-export { globalSelectionApi } from './globalSelection.api';
-export { globalSelectionInternal } from './globalSelection.internal';
 export * from './globalSelectionStore/globalSelectionStore.types';
-export { globalSelectionUtils } from './globalSelectionStore/globalSelectionStore.utils';
+export * from './selectionMenu/selectionTreeStore/selectionTree.store.types';
+export { useAreAllItemsVisible } from './hooks/useAreAllItemsVisible';
 export { useGlobalSelectionByItemId } from './hooks/useGlobalSelectionByItemId';
 export { useGlobalSelectionItems } from './hooks/useGlobalSelectionItems';
 export { useGlobalSelectionItemsByType } from './hooks/useGlobalSelectionItemsByType';
@@ -10,6 +8,10 @@ export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
 export { useGlobalSelectionTags } from './hooks/useGlobalSelectionTags';
 export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';
 export { useSelectionCategoriesByGroupId } from './hooks/useSelectionCategoriesByGroupId';
-export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
 export { useSelectionMenuGroups } from './selectionMenu/hooks/useSelectionMenuGroups';
-export * from './selectionMenu/selectionTreeStore/selectionTree.store.types';
+export { RemoveSelectionItemsConfirmDialog } from './components/RemoveSelectionItemsConfirmDialog';
+export { globalSelectionApi } from './globalSelection.api';
+export { globalSelectionInternal } from './globalSelection.internal';
+export { globalSelectionUtils } from './globalSelectionStore/globalSelectionStore.utils';
+export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
+export { convertGlobalSelectionItemsToPlantTagPairs } from './OpenGlobalSelectionIn3DButton.utils';

package/src/lib/feature/legend/components/popover/LegendPopoverContent.d.ts

@@ -0,0 +1,36 @@
+import { FC } from 'react';
+import { LegendDataId, LegendId } from '../../types/legendType';
+export interface LegendPopoverContentProps {
+    legendId: LegendId;
+    legendDataId: LegendDataId;
+    title: string | React.ReactNode;
+    description: string;
+    tertiary?: LegendPopoverTertiaryLabels | React.ReactNode;
+    onPopoverClicked?: () => void;
+    children?: React.ReactNode;
+    excludedLegendTitles?: ReadonlyArray<string>;
+}
+export type LegendPopoverTertiaryLabels = {
+    first: string;
+    second?: string;
+    third?: string;
+};
+/**
+ * Renders the content for a legend popover, typically used as the content for the ItemMarkerPopover component.
+ *
+ * Uses `legendId` and `legendDataId` to look up and render relevant `LegendChip` components for the given legend item.
+ * Displays a title, description, and optional tertiary content (either a structured object with up to three strings, or a custom ReactNode).
+ * Additional custom content can be rendered via `children`.
+ *
+ * @component
+ * @param {object} props - Component props
+ * @param {LegendId} props.legendId - The identifier used to look up legend strategy.
+ * @param {LegendDataId} props.legendDataId - The identifier for retrieving the markers.
+ * @param {string | React.ReactNode} props.title - The main title of the popover.
+ * @param {string} props.description - The description or supporting text.
+ * @param {LegendPopoverTertiaryLabels | React.ReactNode} [props.tertiary] - Optional tertiary content. If an object, displays up to three labeled strings; if a ReactNode, renders as-is.
+ * @param {() => void} [props.onPopoverClicked] - Optional callback for popover click events.
+ * @param {React.ReactNode} [props.children] - Optional custom content to render below the predefined main content.
+ * @param {ReadonlyArray<string>} [props.excludedLegendTitles] - Optional array of titles to exclude from the legend chips.
+ */
+export declare const LegendPopoverContent: FC<LegendPopoverContentProps>;

package/src/lib/feature/legend/components/popover/LegendPopoverContent.logic.d.ts

@@ -0,0 +1,20 @@
+import { LegendChipProps } from "@equinor/echo-components";
+import { LegendState } from "../../types/legendType";
+import { Marker } from './../../types/legendMarkerBadge.type';
+/**
+ * Returns an array of visible LegendChipProps for the given markers and legend state.
+ *
+ * Filters out markers and badges that are hidden (using isHiddenMarker/isHiddenBadge) or whose titles match any value in the
+ * excludedLegendTitles array (case-insensitive). Badge chips are only included if selectedMarkerOption !== selectedBadgeOption.
+ *
+ * @param {object} params - The function parameters.
+ * @param {ReadonlyArray<Marker>} params.markers - The list of marker objects to process.
+ * @param {LegendState} params.legend - The legend state, used for filtering and selection logic.
+ * @param {ReadonlyArray<string>} [params.excludedLegendTitles] - Optional array of titles to exclude from the chips (case-insensitive).
+ * @returns {LegendChipProps[]} The filtered and mapped array of LegendChipProps for rendering.
+ */
+export declare function getVisibleLegendChips({ markers, legend, excludedLegendTitles, }: {
+    markers: ReadonlyArray<Marker>;
+    legend: LegendState;
+    excludedLegendTitles?: ReadonlyArray<string>;
+}): LegendChipProps[];

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

@@ -2,6 +2,8 @@ import './legendStrategies/workOrderStrategy/WorkOrderLegend';
 export { LegendList } from './components/LegendList';
 export { PositionalItem } from './components/pdfMarkers/PositionalItem';
 export { MultipleMarkersByLegends } from './components/pdfMarkers/subComponents/MultipleMarkersByLegends';
+export { LegendPopoverContent } from './components/popover/LegendPopoverContent';
+export type { LegendPopoverContentProps, LegendPopoverTertiaryLabels } from './components/popover/LegendPopoverContent';
 export { legendFacade } from './legendFacade';
 export type { Badge, Marker } from './types/legendMarkerBadge.type';
 export type { LegendStrategy } from './types/legendStrategy.type';

package/src/lib/feature/legend/types/legendType.d.ts

@@ -1,7 +1,7 @@
 import { Brand } from '@equinor/echo-utils';
 import { GlobalSelectionTypes } from '../../globalSelection';
-type TemporaryLegendIdsForTesting = 'Tag Legend' | 'Work Orders with Custom UI';
-export type KnownLegendIds = 'Equipment' | TemporaryLegendIdsForTesting;
+type TemporaryLegendIdsForTesting = 'Work Orders with Custom UI';
+export type KnownLegendIds = 'Equipment' | 'Tag Legend' | TemporaryLegendIdsForTesting;
 export type LegendId = KnownLegendIds | Brand<string, 'LegendId'>;
 export declare function createLegendId(id: string): LegendId;
 export declare const knownLegendIds: {

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

@@ -1,10 +1,26 @@
 import { Plant3dInfo, PlantAndTagForOpenIn3d } from '../../logic/openItemsIn3d.utils';
 interface PlantNoSelectionDialogProps {
-    getItems: () => Promise<PlantAndTagForOpenIn3d[]>;
+    itemGetterCallback: () => Promise<PlantAndTagForOpenIn3d[]>;
     onPlantSelectionConfirmed: (selectedPlantNo: Plant3dInfo) => void;
     onCancelButtonClicked: () => void;
     onSetIsWarningDialogOpen: () => void;
     open: boolean;
+    title?: string;
 }
-export declare const PlantNoSelectionDialog: ({ getItems, onPlantSelectionConfirmed, onCancelButtonClicked, onSetIsWarningDialogOpen, open }: PlantNoSelectionDialogProps) => JSX.Element | null;
+/**
+ * Displays a dialog for selecting a plant when items from multiple plants are selected.
+ *
+ * This dialog is shown when the user has selected items that belong to different plants.
+ * It allows the user to choose which plant to open in 3D. If only one plant is found,
+ * the selection is automatically confirmed. If no plants are found, a warning dialog is shown.
+ *
+ * @param itemGetterCallback - Async callback to retrieve the list of items for plant selection.
+ * @param onPlantSelectionConfirmed - Callback invoked when a plant is selected and confirmed.
+ * @param onCancelButtonClicked - Callback invoked when the dialog is cancelled.
+ * @param onSetIsWarningDialogOpen - Callback to open a warning dialog if no plants are found.
+ * @param open - Boolean indicating whether the dialog is open.
+ *
+ * @returns The plant selection dialog JSX element, or null if not open.
+ */
+export declare const PlantNoSelectionDialog: ({ itemGetterCallback, onPlantSelectionConfirmed, onCancelButtonClicked, onSetIsWarningDialogOpen, open, title }: PlantNoSelectionDialogProps) => JSX.Element | null;
 export {};

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

@@ -1,3 +1,3 @@
-export { tagIdPlantIdToPlantTagPairs } from './logic/convertToPlantTagPairs';
+export { tagIdPlantIdToPlantTagPairs, tagToPlantTagPairs } from './logic/convertToPlantTagPairs';
 export type { Plant3dInfo, PlantAndTagForOpenIn3d } from './logic/openItemsIn3d.utils';
 export { OpenItemsIn3dDialog } from './openItemsIn3dDialog';

package/src/lib/feature/openItemsIn3d/logic/convertToPlantTagPairs.d.ts

@@ -3,8 +3,26 @@ export interface TagIdPlantId {
     tagPlantId: string | undefined;
     tagId: string | undefined;
 }
+/**
+ * Converts a list of selected work orders into plant-tag pairs suitable for opening in 3D.
+ *
+ * Groups the input work orders by their `instCode`, fetches additional tag information asynchronously,
+ * and returns an array of objects containing plant and tag details for use in 3D visualization.
+ *
+ * @param selectedWorkOrders - A readonly array of objects, each containing a `tagNo` and an `instCode`.
+ * @returns A promise that resolves to an array of `PlantAndTagForOpenIn3d` objects, each containing
+ *          `instCode`, `pdmsPlantCode`, `tagNo`, and `plantNo` properties.
+ */
 export declare function tagToPlantTagPairs(selectedWorkOrders: ReadonlyArray<{
     tagNo: string;
     instCode: string;
 }>): Promise<PlantAndTagForOpenIn3d[]>;
+/**
+ * Converts an array of `TagIdPlantId` items into an array of `PlantAndTagForOpenIn3d` pairs,
+ * grouped by their `tagPlantId` property. For each group, it calls
+ * `tagIdTagPlantIdToPlantTagPairsBySapId` to generate the corresponding plant-tag pairs.
+ *
+ * @param items - A readonly array of `TagIdPlantId` objects to be grouped and converted.
+ * @returns A promise that resolves to an array of `PlantAndTagForOpenIn3d` pairs.
+ */
 export declare function tagIdPlantIdToPlantTagPairs(items: ReadonlyArray<TagIdPlantId>): Promise<PlantAndTagForOpenIn3d[]>;

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

@@ -7,24 +7,26 @@ import { Plant3dInfo, PlantAndTagForOpenIn3d } from './logic/openItemsIn3d.utils
  *
  * @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 {Array} props.itemGetterCallback - Async callback to retrieve the list of items for plant selection.
  * @param {boolean} props.open - Boolean indicating whether the dialog should be open or closed.
  * @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.
+ * @param {string} [props.title] - Optional title for the dialog. If not provided, a default title will be used.
  *
  * @returns {React.ReactElement} A React Element representing the OpenItemsIn3dDialog.
  *
  */
-export declare const OpenItemsIn3dDialog: ({ getItems, open, onPlantSelectionCompleted, onCancelButtonClicked, plantNotAvailableDialogProps, disableDefault3dOpener }: OpenItemsIn3dDialogProps) => import("react/jsx-runtime").JSX.Element;
+export declare const OpenItemsIn3dDialog: ({ itemGetterCallback, open, onPlantSelectionCompleted, onCancelButtonClicked, plantNotAvailableDialogProps, disableDefault3dOpener, title }: OpenItemsIn3dDialogProps) => import("react/jsx-runtime").JSX.Element;
 interface BaseOpenItemsIn3dDialogProps {
-    getItems: () => Promise<PlantAndTagForOpenIn3d[]>;
+    itemGetterCallback: () => Promise<PlantAndTagForOpenIn3d[]>;
     onPlantSelectionCompleted: (args: {
         selectedPlant: Plant3dInfo;
     }) => void;
     onCancelButtonClicked: () => void;
     open: boolean;
+    title?: string;
 }
 interface WithDefault3dOpener extends BaseOpenItemsIn3dDialogProps {
     disableDefault3dOpener?: false;