@equinor/echo-framework 0.26.8 → 0.26.10

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.26.8",
+  "version": "0.26.10",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-components": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-core": ">= 0.26.8 < 0.27.0",
+    "@equinor/echo-components": ">= 0.26.9 < 0.27.0",
+    "@equinor/echo-core": ">= 0.26.9 < 0.27.0",
     "@equinor/echo-search": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-utils": ">= 0.26.8 < 0.27.0",
+    "@equinor/echo-utils": ">= 0.26.10 < 0.27.0",
     "@equinor/eds-core-react": "0.43.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",

package/src/index.d.ts

@@ -100,6 +100,8 @@ declare const EchoFramework: Readonly<{
             sapPlantId: string | undefined;
         }) => string | undefined;
         useIsFullScreenModeEnabled(): boolean;
+        disableFullScreenMode: () => void;
+        enableFullScreenMode: () => void;
         useOpenPdfFile(): (args: {
             instCode: string;
             docNo: string;

package/src/lib/components/fullScreenButtons/FullScreenModeButton.d.ts

@@ -1,2 +1,9 @@
 import React from 'react';
-export declare const FullScreenModeButton: React.FC;
+interface FullScreenModeButtonProps {
+    active?: boolean;
+    dataTestId?: string;
+    onClick?: () => void;
+    toolTipDisabled?: boolean;
+}
+export declare const FullScreenModeButton: React.FC<FullScreenModeButtonProps>;
+export {};

package/src/lib/components/fullScreenButtons/FullScreenModeChip.d.ts

@@ -1,5 +1,14 @@
 interface FullScreenModeChipProps {
     className?: string;
 }
+/**
+ * Renders a chip component that allows users to toggle full screen mode.
+ * This makes the application header and sidebar disappear, providing a more immersive experience.
+ * The chip is only visible when full screen mode is enabled and the chip visibility state is true.
+ *
+ * The chip provides two actions:
+ * - Clicking the chip toggles the full screen mode.
+ * - Deleting the chip hides it from view.
+ */
 export declare const FullScreenModeChip: ({ className }: FullScreenModeChipProps) => false | import("react/jsx-runtime").JSX.Element;
 export {};

package/src/lib/components/prepview/panels/objects/HorizontalObjects.d.ts

@@ -2,5 +2,5 @@ import { PrepviewObject } from '../../types';
 interface HorizontalObjectProps {
     objects: PrepviewObject[];
 }
-declare function HorizontalObject({ objects }: HorizontalObjectProps): import("react/jsx-runtime").JSX.Element;
+declare function HorizontalObject({ objects }: Readonly<HorizontalObjectProps>): import("react/jsx-runtime").JSX.Element;
 export { HorizontalObject };

package/src/lib/components/prepview/panels/objects/Objects.d.ts

@@ -1,5 +1,5 @@
 interface Props {
     workOrderId: string;
 }
-declare function ObjectsPanel({ workOrderId }: Props): import("react/jsx-runtime").JSX.Element;
+declare function ObjectsPanel({ workOrderId }: Readonly<Props>): import("react/jsx-runtime").JSX.Element;
 export { ObjectsPanel };

package/src/lib/feature/equipment/hooks/useOpenEquipmentDetails.d.ts

@@ -1,22 +1,28 @@
 /**
- * Custom React hook that returns a function to open equipment details in a left panel.
+ * Custom hook that returns a function to open equipment details in a side panel.
  *
- * The returned function accepts an object with equipment details and panel options,
- * and manages the navigation state to display the equipment details in the appropriate panel.
- * If the equipment item is already open in the specified panel, it will close the panel instead.
+ * The returned function accepts an `OpenEquipmentArgs` object, which specifies the equipment to display,
+ * the panel to use, and additional options such as toggling and navigation behavior.
  *
- * @returns {(args: OpenEquipmentArgs) => void} Function to open equipment details in a panel.
+ * If `allowToggle` is true and the equipment is already open in the specified panel, the panel will be closed.
+ * Otherwise, the panel will be activated and populated with the equipment details.
+ *
+ * @returns A function that opens equipment details in the left panel based on the provided arguments.
  *
  * @example
  * const openEquipmentDetails = useOpenEquipmentDetails();
  * openEquipmentDetails({ equipmentId: '123', tagNo: 'TAG-001', plantNo: 'PLANT-01' });
  *
- * @typedef {Object} OpenEquipmentArgs
- * @property {string} equipmentId - The unique identifier of the equipment to display.
- * @property {string} [tagNo] - Optional tag number of the equipment.
- * @property {string} [plantNo] - Optional plant number of the equipment.
- * @property {string} [panelKey] - Optional key to specify which panel to open.
- * @property {boolean} [keepLastNavigationItem] - Whether to keep the last navigation item in the panel.
+ * Returns a function that opens the equipment details panel with the specified arguments.
+ * @param args - The arguments for opening the equipment details panel.
+ * @param args.equipmentId - The unique identifier of the equipment to display.
+ * @param args.tagNo - (Optional) The tag number of the equipment.
+ * @param args.plantNo - (Optional) The plant number associated with the equipment.
+ * @param args.panelKey - (Optional) The key of the panel to open. Defaults to the core search panel if not provided.
+ * @param args.keepLastNavigationItem - (Optional) Whether to keep the last navigation item in the panel.
+ * @param args.allowToggle - (Optional) If true, toggles the panel open/closed if the same item is already open.
+ *
+ * @returns A function that, when called with the above arguments, opens the equipment details panel accordingly.
  */
 export declare function useOpenEquipmentDetails(): (args: {
     equipmentId: string;
@@ -24,4 +30,5 @@ export declare function useOpenEquipmentDetails(): (args: {
     plantNo?: string;
     panelKey?: string;
     keepLastNavigationItem?: boolean;
+    allowToggle?: boolean;
 }) => void;

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

@@ -1,10 +1,10 @@
 import { PersistOptions } from 'zustand/middleware';
 import { PersistedSelectionGroup } from '../selectionMenu/selectionTreeStore/selectionTree.store.types';
 import { GlobalSelectionStore } from './globalSelectionStore.types';
-declare function loadAndPopulateStoreMetadata(store: GlobalSelectionStore): Promise<void>;
+declare function loadAndPopulateStoreMetadataFromDisk(store: GlobalSelectionStore): Promise<void>;
 declare function loadAndPopulateStoreMetadataFromApi(store: GlobalSelectionStore, data: PersistedSelectionGroup[]): Promise<void>;
 export declare const globalSelectionRepository: {
-    loadAndPopulateStoreMetadata: typeof loadAndPopulateStoreMetadata;
+    loadAndPopulateStoreMetadataFromDisk: typeof loadAndPopulateStoreMetadataFromDisk;
     loadAndPopulateStoreMetadataFromApi: typeof loadAndPopulateStoreMetadataFromApi;
     persistOptions: PersistOptions<GlobalSelectionStore, GlobalSelectionStore>;
 };

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

@@ -102,9 +102,7 @@ export type GlobalSelectionAddItemResult<DataType> = {
     fetchResult: DataType;
     actionResult: GlobalSelectionActionResult;
 };
-export type PersistedGlobalSelectionMetaData = Pick<GlobalSelectionMetaData, 'color'> & {
-    isHidden: boolean;
-};
+export type PersistedGlobalSelectionMetaData = Pick<GlobalSelectionMetaData, 'color' | 'isHiddenByUser'>;
 export declare namespace GlobalSelectionTypes {
     type WorkOrderId = Pick<GlobalSelectionWorkOrderDto, 'workOrderId'>;
     type EquipmentId = Pick<GlobalSelectionEquipmentDto, 'equipmentId'>;

package/src/lib/feature/measuringPoint/hooks/useOpenMeasuringPointDetails.d.ts

@@ -1,21 +1,30 @@
 import { MeasuringPointData } from '@equinor/echo-search';
 import { MeasurementDto } from '../types/measuringPoint';
 /**
- * Custom hook that provides a function to open the measuring point details panel in the left navigation.
+ * Custom hook that provides a function to open the measuring point details panel.
  *
- * This hook manages the logic for displaying the details of a measuring point in a side panel,
- * handling panel activation, navigation state, and optionally clearing or keeping previous navigation items.
+ * The returned function, `openMeasuringPointDetails`, opens the measuring point details panel with the specified arguments.
+ * It can optionally toggle the panel, keep the last navigation item, and pass measurement data to the details component.
  *
- * @returns {(args: MeasuringPointArgs) => void} A function to open the measuring point details panel with the specified arguments.
+ * @returns A function to open the measuring point details panel.
  *
  * @example
  * const openMeasuringPointDetails = useOpenMeasuringPointDetails();
  * openMeasuringPointDetails({
- *   measuringPointProps: { measuringPointId: '123', ... },
- *   panelKey: 'CUSTOM_PANEL_KEY',
- *   keepLastNavigationItem: false,
- *   measurements: [/* measurement data *\/]
+ *   measuringPointProps: { measuringPointId: 123, ... },
+ *   panelKey: 'MY_PANEL',
+ *   keepLastNavigationItem: true,
+ *   measurements: [...],
+ *   allowToggle: false
  * });
+ *
+ * @function
+ * @param {Object} args - Arguments for opening the measuring point details panel.
+ * @param {MeasuringPointProps} args.measuringPointProps - The properties of the measuring point, including its ID and position.
+ * @param {string} [args.panelKey] - The key of the panel to open. Defaults to ECHO_CORE_SEARCH if not provided.
+ * @param {boolean} [args.keepLastNavigationItem] - Whether to keep the last navigation item in the panel.
+ * @param {MeasurementDto[]} [args.measurements] - Optional array of measurement data associated with the measuring point. If not provided, the UI component will fetch the measurements.
+ * @param {boolean} [args.allowToggle] - Whether to allow toggling the panel open/closed if the item is already open.
  */
 export declare function useOpenMeasuringPointDetails(): (args: MeasuringPointArgs) => void;
 type MeasuringPointArgs = {
@@ -23,5 +32,6 @@ type MeasuringPointArgs = {
     measurements?: MeasurementDto[];
     panelKey?: string;
     keepLastNavigationItem?: boolean;
+    allowToggle?: boolean;
 };
 export {};

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

@@ -11,7 +11,26 @@ export declare enum RegisteredHookName {
 export declare const HookLibrary: Readonly<{
     /**
      * Hook for setting the selected tag application wide.
-     * @returns {SetActiveTagNo}
+     *
+     * @param {SetActiveTagNoArgs | string} argsORtagNo - Arguments for setting the active tag and controlling tag details panel behavior.
+     * If you pass a string, it will be handled as the tagNo
+     * @property {string} argsORtagNo.tagNo - The tag number to activate and open details for.
+     * @property {TagItemContentTabsType} [argsORtagNo.activeTagTab] - The main tab to activate in the tag details panel (e.g., Info, History, etc.).
+     * @property {SubTabType} [argsORtagNo.activeTagSubTab] - The sub-tab to activate within the main tab, if applicable.
+     * @property {string} [argsORtagNo.instCode] - The installation code associated with the tag (for multi-installation contexts).
+     * @property {string} [argsORtagNo.activePanelKey] - The key of the panel to activate (if using multiple panels).
+     * @property {boolean} [argsORtagNo.keepLastNavigationItem] - If true, keeps the last navigation item in the breadcrumb/search flow.
+     * @property {boolean} [argsORtagNo.openInPanel] - If true, opens the tag details in a side panel instead of the main view.
+     * @property {boolean} [argsORtagNo.displayMessageOnItemNotFound] - If true, displays a message if the tag is not found.
+     * @property {boolean} [argsORtagNo.allowToggle] - If true, enables toggle mode (e.g., toggling selection or panel state).
+     * @property {boolean} [argsORtagNo.omitTagNoFromUrl] - If true, omits the tag number from the URL (used only by echo maps; planned for removal).
+     *
+     * @param {TagItemContentTabsType} [activeTagTab] - The active tab for the tag item.
+     * @param {SubTabType} [activeTagSubTab] - The active sub-tab for the tag item.
+     * @param {string} [instCode] - The installation code associated with the tag.
+     * @param {boolean} [openInPanel] - Whether to open the tag details in a panel.
+     * @param {boolean} [displayMessageOnItemNotFound] - Whether to display a message if the tag is not found.
+     * @returns {void}
      */
     useSetActiveTagNo: () => SetActiveTagNo;
     /**

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

@@ -1 +1,11 @@
+/**
+ * Custom hook that returns whether the full screen mode is enabled.
+ *
+ * Using this mode hides the header and footer of the application, providing a more immersive experience.
+ * Mainly used in PDF viewer and 3D.
+ *
+ * @returns {boolean} `true` if full screen mode is enabled, otherwise `false`.
+ */
 export declare function useIsFullScreenModeEnabled(): boolean;
+export declare const disableFullScreenMode: () => void;
+export declare const enableFullScreenMode: () => void;

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

@@ -1,3 +1,27 @@
+/**
+ * Custom React hook that returns a function to open a "Prepview" panel with specified content and navigation state.
+ *
+ * This hook integrates with the panel management system and search hooks for MC and Comm packages.
+ * The returned function allows opening a panel with a "Prepview" component, handling toggling, navigation state,
+ * and package/tag click events.
+ *
+ * @returns A function that opens a "Prepview" panel with the provided input and options.
+ *
+ * @param args - The arguments for opening the Prepview panel.
+ * @param args.prepviewInput - Input object containing optional identifiers for the item to display:
+ *   - `notificationId` (optional): The notification ID.
+ *   - `workOrderId` (optional): The work order ID.
+ *   - `punchId` (optional): The punch ID.
+ *   - `instCode` (optional): The instrument code.
+ * @param args.panelKey - The key identifying the panel to open.
+ * @param args.keepLastNavigationItem - (optional) Whether to keep the last navigation item in the panel.
+ * @param args.allowToggle - (optional) If true, toggles the panel closed if the same item is already open.
+ *
+ * @remarks
+ * - At least one of `notificationId`, `workOrderId`, or `punchId` should be provided in `prepviewInput`.
+ * - Handles package and tag click events by invoking appropriate search or navigation actions.
+ * - If `allowToggle` is true and the item is already open in the panel, the panel will be closed.
+ */
 export declare function useOpenPrepview(): (args: {
     prepviewInput: {
         notificationId?: string;
@@ -7,4 +31,5 @@ export declare function useOpenPrepview(): (args: {
     };
     panelKey: string;
     keepLastNavigationItem?: boolean;
+    allowToggle?: boolean;
 }) => void;

package/src/lib/types/hookLibrary.d.ts

@@ -7,6 +7,7 @@ export type SetActiveTagNo = (argsORtagNo: string | {
     keepLastNavigationItem?: boolean;
     openInPanel?: boolean;
     displayMessageOnItemNotFound?: boolean;
+    allowToggle?: boolean;
     omitTagNoFromUrl?: boolean;
 }, activeTagTab?: string, activeTagSubTab?: string, instCode?: string, openInPanel?: boolean, displayMessageOnItemNotFound?: boolean) => void;
 export type TagData = [(tagNo: string, instCode: string) => void];