@equinor/echo-framework 2.4.0 → 2.4.2

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 2.4.0 < 3.0.0",
-    "@equinor/echo-components": ">= 2.4.0 < 3.0.0",
-    "@equinor/echo-core": ">= 2.4.0 < 3.0.0",
-    "@equinor/echo-search": ">= 2.4.0 < 3.0.0",
-    "@equinor/echo-utils": ">= 2.4.0 < 3.0.0",
+    "@equinor/echo-base": ">= 2.4.2 < 3.0.0",
+    "@equinor/echo-components": ">= 2.4.2 < 3.0.0",
+    "@equinor/echo-core": ">= 2.4.2 < 3.0.0",
+    "@equinor/echo-search": ">= 2.4.2 < 3.0.0",
+    "@equinor/echo-utils": ">= 2.4.2 < 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

@@ -90,6 +90,7 @@ export declare const registerEchopediaComponent: ({ name, component }: {
  * Use named exports here.
  */
 export * from './lib/hooks';
+export { useOpenWorkOrderDetails, type OpenWorkOrderFn } from './lib/hooks/useOpenWorkOrderDetails';
 /**
  * Don't add any more default exports here - it may cause some import issues in other packages
  * Let's stick to named imports

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

@@ -0,0 +1,38 @@
+type WorkOrderArgs = {
+    workOrderId: string;
+    panelKey?: string;
+    keepLastNavigationItem?: boolean;
+    allowToggle?: boolean;
+};
+/**
+ * Custom React hook that provides a function to open a work order's details in a left panel.
+ *
+ * This hook manages the navigation state for work order details, ensuring that the correct panel is opened
+ * and populated with the appropriate content. If the work order is already open in the specified panel,
+ * it will close the panel instead.
+ *
+ * @returns {(args: WorkOrderArgs) => void} A callback function to open a work order's details panel.
+ *   - `args.workOrderId` (string): The unique identifier of the work order to open.
+ *   - `args.panelKey` (string, optional): The key of the panel to open the work order in. Defaults to `ECHO_CORE_SEARCH` if not provided.
+ *   - `args.keepLastNavigationItem` (boolean, optional): Whether to keep the last navigation item in the panel.
+ *   - `args.allowToggle` (boolean, optional): Whether toggling the panel is allowed.
+ *
+ * @example
+ * const openWorkOrder = useOpenWorkOrderDetails();
+ * openWorkOrder({ workOrderId: '123', panelKey: 'workOrderPanel' });
+ */
+export declare function useOpenWorkOrderDetails(): OpenWorkOrderFn;
+/**
+ * Opens a work order in the left panel navigation.
+ *
+ * If the specified work order is already open in the given panel, it will close the active panel.
+ * Otherwise, it sets the specified panel as active and adds the work order content to the left panel.
+ *
+ * @param args - The arguments required to open the work order.
+ * @param args.workOrderId - The unique identifier of the work order to open.
+ * @param args.panelKey - (Optional) The key of the panel to open the work order in. Defaults to `ECHO_CORE_SEARCH` if not provided.
+ * @param args.keepLastNavigationItem - (Optional) Whether to keep the last navigation item in the panel.
+ * @param args.allowToggle - (Optional) Whether toggling the panel is allowed.
+ */
+export type OpenWorkOrderFn = (args: WorkOrderArgs) => void;
+export {};

package/src/lib/services/dataLayerPanel/dataLayerPanel.store.d.ts

@@ -1,3 +1,4 @@
+import { WritableDraft } from 'immer';
 export interface PanelUserSettings {
     isTagsVisible: boolean;
     isTagsFromDocumentVisible: boolean;
@@ -30,7 +31,7 @@ interface DataLayerPanelActions {
     toggleIocAnnotations: () => void;
     setIsDataFromStidAnnoDetails: (value: boolean) => void;
 }
-type DataLayerPanelStore = DataLayerPanelState & DataLayerPanelActions;
+export type DataLayerPanelStore = DataLayerPanelState & DataLayerPanelActions;
 export declare const useDataLayerPanelStore: import("zustand").UseBoundStore<Omit<Omit<Omit<import("zustand").StoreApi<DataLayerPanelStore>, "setState"> & {
     setState<A extends string | {
         type: string;
@@ -77,4 +78,5 @@ export declare const useDataLayerPanelStore: import("zustand").UseBoundStore<Omi
     } | undefined): void;
 }>;
 export declare function dataLayerStoreSnapshot(): DataLayerPanelStore;
+export declare const toggleLayerAndDisableAllOthers: (current: WritableDraft<DataLayerPanelStore>, layerToToggle: keyof PanelUserSettings) => void;
 export {};