@equinor/echo-framework 2.0.1 → 2.2.0

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 2.0.1 < 3.0.0",
-    "@equinor/echo-components": ">= 2.0.1 < 3.0.0",
-    "@equinor/echo-core": ">= 2.0.1 < 3.0.0",
-    "@equinor/echo-search": ">= 2.0.1 < 3.0.0",
-    "@equinor/echo-utils": ">= 2.0.1 < 3.0.0",
+    "@equinor/echo-base": ">= 2.2.0 < 3.0.0",
+    "@equinor/echo-components": ">= 2.2.0 < 3.0.0",
+    "@equinor/echo-core": ">= 2.2.0 < 3.0.0",
+    "@equinor/echo-search": ">= 2.2.0 < 3.0.0",
+    "@equinor/echo-utils": ">= 2.2.0 < 3.0.0",
     "@equinor/eds-core-react": "0.49.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",

package/src/index.d.ts

@@ -43,13 +43,14 @@ export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabl
 export { useOpenPrepview } from './lib/hooks/useOpenPrepview';
 export { useScreenOrientation } from './lib/hooks/useScreenOrientation';
 export { useScreenValues } from './lib/hooks/useScreenValues';
+export { useSelectionGroupLabelsPerItem } from './lib/hooks/useSelectionGroupLabelsPerItem';
 export { getMeasurementsFromMaintenanceDataApi } from './lib/services/api/api-measuringPoints';
 export { getPlantsCachedOrApi, getPlantsFromApi } from './lib/services/api/api-plants';
 export { RegisteredComponentName } from './lib/services/componentRegistry/componentRegistry';
 export * from './lib/services/dataLayerPanel';
 export { EchoViewInspectionToolMode } from './lib/services/echoViewService/echoView.type';
 export type { EchoView, EchoViewEcmPdfInspectionToolConfig, EchoViewSyncSettings } from './lib/services/echoViewService/echoView.type';
-export { echoViewService, setEchoView } from './lib/services/echoViewService/echoViewService';
+export { echoViewService, echoViewServiceAPI, setEchoView, clearEchoView } from './lib/services/echoViewService/echoViewService';
 export * from './lib/services/eventHubActions';
 export * from './lib/services/leftPanelNavigation';
 export * from './lib/services/locationService/locationService';
@@ -127,6 +128,7 @@ declare const EchoFramework: Readonly<{
             isScreenMobileSize: boolean;
             screenOrientation: import("./lib/types/hookLibrary").ScreenOrientation;
         };
+        useSelectionGroupLabelsPerItem: () => Map<string, string[]>;
         useTabTitle(): void;
         useTagDetails({ instCode, tagNo }: {
             tagNo: string;

package/src/lib/coreApplication/EchoUserInterfaceStore.d.ts

@@ -13,7 +13,3 @@ export interface EchoUiState {
     updateModuleName: (newModuleName: string) => void;
 }
 export declare const useEchoUserInterfaceStore: zustand.UseBoundStore<zustand.StoreApi<EchoUiState>>;
-/**
- * @deprecated useEchoUiContext() is deprecated, please use useEchoUserInterfaceStore() instead.
- */
-export declare const useEchoUiContext: any;

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

@@ -8,5 +8,6 @@ export * from './usePlantAvailableIn3d';
 export * from './usePlantAvailableIn3dWeb';
 export * from './useScreenOrientation';
 export * from './useScreenValues';
+export * from './useSelectionGroupLabelsPerItem';
 export * from './useTabTitle';
 export * from './useTagDetails';

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

@@ -0,0 +1,19 @@
+/**
+ * Custom hook that creates a mapping between selection items and their associated group labels.
+ *
+ * This hook is primarily used in 3D Web for determining which selection groups
+ * contain specific items. It's particularly useful for Legend components that need to display
+ * which lists/groups items belong to and their associated colors.
+ *
+ * @returns {Map<string, string[]>} A Map where:
+ *   - Key: Item ID as a string (converted using globalSelectionUtils.itemIdToString)
+ *   - Value: Array of group labels that the item belongs to
+ *
+ * @example
+ * ```typescript
+ * const itemGroupLabels = useSelectionGroupLabelsPerItem();
+ * const groupsForItem = itemGroupLabels.get('item-123');
+ * // Returns: ['Group A', 'Group B'] if item-123 belongs to both groups
+ * ```
+ */
+export declare const useSelectionGroupLabelsPerItem: () => Map<string, string[]>;

package/src/lib/services/echoViewService/echoViewService.d.ts

@@ -1,4 +1,73 @@
 import { EchoView } from './echoView.type';
+/**
+ * @internal
+ * Sets the EchoView instance. This function is primarily intended for internal framework use and testing.
+ *
+ * @param echoView - The EchoView instance to set
+ */
 export declare function setEchoView(echoView: EchoView): void;
+/**
+ * @internal
+ * Sets the EchoView instance. This function is primarily intended for internal framework use and testing.
+ *
+ * Clears the current echo view instance and resets access keys.
+ *
+ * This function performs cleanup by setting the echo view instance to undefined
+ * and clearing the first access keys array. This is typically called when
+ * reinitializing or shutting down the echo view system.
+ */
 export declare function clearEchoView(): void;
+/**
+ * @deprecated Use echoViewServiceAPI.get instead.
+ *
+ * Gets the current EchoView instance.
+ *
+ * @returns The current EchoView instance if available, undefined otherwise
+ */
 export declare function echoViewService(): EchoView | undefined;
+/**
+ * Marks that an application has accessed the echoViewService data for the first time in the current session.
+ * Remote apps can use this to track whether they have already loaded data from echoViewService
+ * or if this is their first access after navigation.
+ *
+ * @param appKey - The unique identifier for the application (e.g., 'echo3d')
+ */
+declare function markFirstAccessByKey(appKey: string): void;
+/**
+ * Checks if an application has accessed the echoViewService data before in the current session.
+ * Allows remote apps to differentiate between their first data access and subsequent accesses.
+ *
+ * @param appKey - The unique identifier for the application to check
+ * @returns `true` if the application has accessed the data before, `false` otherwise
+ */
+declare function hasBeenAccessedByKey(appKey: string): boolean;
+/**
+ * EchoView Service API
+ *
+ * Provides methods to manage the EchoView instance and track application data access.
+ *
+ * @example
+ * ```typescript
+ * // Set the EchoView instance
+ * echoViewServiceAPI.set(myEchoView);
+ *
+ * // Get the current instance
+ * const view = echoViewServiceAPI.get();
+ *
+ * // Track first access
+ * if (!echoViewServiceAPI.hasBeenAccessedByKey('echo3d')) {
+ *   // First time accessing data
+ *   loadInitialData();
+ *   echoViewServiceAPI.markFirstAccessByKey('echo3d');
+ * }
+ * ```
+ */
+export declare const echoViewServiceAPI: Readonly<{
+    /** Gets the current EchoView instance */
+    get: () => EchoView | undefined;
+    /** Marks that an application has accessed the echoViewService data for the first time */
+    markFirstAccessByKey: typeof markFirstAccessByKey;
+    /** Checks if an application has accessed the echoViewService data before in the current session */
+    hasBeenAccessedByKey: typeof hasBeenAccessedByKey;
+}>;
+export {};