@equinor/echo-framework 4.1.0 → 4.2.0

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "peerDependencies": {
-    "@equinor/echo-base": ">= 4.1.0 < 5.0.0",
-    "@equinor/echo-components": ">= 4.1.0 < 5.0.0",
-    "@equinor/echo-core": ">= 4.1.0 < 5.0.0",
-    "@equinor/echo-search": ">= 4.1.0 < 5.0.0",
-    "@equinor/echo-utils": ">= 4.1.0 < 5.0.0",
+    "@equinor/echo-base": ">= 4.2.0 < 5.0.0",
+    "@equinor/echo-components": ">= 4.2.0 < 5.0.0",
+    "@equinor/echo-core": ">= 4.2.0 < 5.0.0",
+    "@equinor/echo-search": ">= 4.2.0 < 5.0.0",
+    "@equinor/echo-utils": ">= 4.2.0 < 5.0.0",
     "@equinor/eds-core-react": "0.49.0",
     "@equinor/eds-icons": "0.22.0",
     "@equinor/eds-tokens": "2.1.0",
@@ -16,14 +16,14 @@
     "@microsoft/signalr": "9.0.6",
     "classnames": "2.5.1",
     "lodash": ">= 4.17.23 < 5",
-    "react-router-dom": ">= 6.30.1 < 7",
+    "react-router-dom": ">= 6.30.3 < 7",
     "zustand": ">= 4.4.7 < 5",
-    "immer": "11.1.3",
-    "msw": "2.12.7",
+    "immer": ">= 11.1.4 < 12.0.0",
+    "msw": "2.12.10",
     "date-fns": "4.1.0"
   },
   "dependencies": {
-    "dexie": "4.2.1",
+    "dexie": "4.3.0",
     "mark.js": "8.11.1",
     "ag-charts-community": "12.3.1",
     "ag-charts-react": "12.3.1",

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

@@ -1 +1,2 @@
 export * from './plantSelector';
+export { usePlantSelector } from './plantSelector.hooks';

package/src/lib/components/plantSelector/plantSelector.d.ts

@@ -1,19 +1,10 @@
 import React from 'react';
-/**
- * Dropdown component for displaying a searchable plant selector.
- * @param {PlantSelectorProps} {
- * isDisabled: Flag which decides whether the dropdown should be disabled or not.
- * stayOnPath: Flag which decides if you should stay on your current path after selecting a plant.
- * textSize: Size of the text in the dropdown. Can be 'small', 'medium' or 'large'.
- * noneBackground: Flag which decides if the background of the dropdown should be transparent or not.
- * }
- * @return {*}
- */
 interface PlantSelectorProps {
-    isDisabled?: boolean;
-    stayOnPath?: boolean;
-    textSize?: 'small' | 'medium' | 'large';
-    noneBackground?: boolean;
+    readonly isDisabled?: boolean;
+    readonly stayOnPath?: boolean;
+    readonly textSize?: 'small' | 'medium' | 'large';
+    readonly noneBackground?: boolean;
+    readonly wrapperClassName?: string;
 }
 export declare const PlantSelector: React.FC<PlantSelectorProps>;
 export {};

package/src/lib/components/plantSelector/plantSelector.hooks.d.ts

@@ -0,0 +1,19 @@
+import type { Plant } from '@equinor/echo-core';
+interface UsePlantSelectorResult {
+    readonly plants: readonly Plant[];
+    readonly selectedPlant: Plant | undefined;
+    readonly selectedPlantText: string;
+    readonly isDisabled: boolean;
+    readonly changePlant: (plant: Plant) => void;
+    readonly filterPlant: (plant: Plant, inputValue: string) => boolean;
+    readonly formatPlantOptionText: (plantName: string, plantId: string | null) => string;
+}
+/**
+ * Common logic for plant selection, used by multiple components.
+ * Handles fetching plants, determining the selected plant,
+ * and managing plant-related state and actions.
+ */
+export declare function usePlantSelector(options?: {
+    readonly stayOnPath: boolean;
+} | undefined): UsePlantSelectorResult;
+export {};

package/src/lib/components/tagSearchDropDown/tagSearchDropDown.d.ts

@@ -1,7 +1,7 @@
 import type { TagSummaryDto } from '@equinor/echo-search';
 import React from 'react';
 interface TagsDropdownProps {
-    tags: TagSummaryDto[];
+    tags: ReadonlyArray<TagSummaryDto>;
     onTagSelected: (tag: TagSummaryDto) => void;
     loadingTags?: boolean;
 }

package/src/lib/feature/globalSelection/globalSelectionStore/actions/tagFetch.logic.d.ts

@@ -2,7 +2,7 @@ import { type TagSummaryDto } from '@equinor/echo-search';
 import type { GlobalSelectionTypes } from '../globalSelectionStore.types';
 export type TagFetchResult = {
     result: {
-        values: TagSummaryDto[];
+        values: ReadonlyArray<TagSummaryDto>;
         isSuccess: boolean;
     };
     itemIdsUsed: GlobalSelectionTypes.TagId[];

package/src/lib/feature/legend/hooks/useFetchNotificationsByWorkOrderId.d.ts

@@ -0,0 +1,13 @@
+import { WorkOrderNotificationStatus } from '../../workOrder/api/api-workOrder-notification';
+/**
+ * React Query hook that fetches maintenance record/attachment notification data for a given work order.
+ *
+ * This hook returns only the resolved `data` value from React Query.
+ * Callers that need loading/error state should use `useQuery` directly.
+ *
+ * @param workOrderId - Unique identifier of the work order for which to fetch notification data.
+ * @returns Notification data for the work order, or `undefined` when not yet loaded or when the API returns no data.
+ */
+export declare function useFetchNotificationsByWorkOrderId({ workOrderId }: {
+    workOrderId: string;
+}): WorkOrderNotificationStatus | undefined;

package/src/lib/feature/legend/hooks/useWorkOrdersByTagNos.d.ts

@@ -0,0 +1,11 @@
+import { WorkOrderDto } from '@equinor/echo-search';
+interface TagNoWithWorkOrders {
+    readonly tagNo: string;
+    readonly openWorkOrders: ReadonlyArray<WorkOrderDto>;
+}
+export declare function useOpenWorkOrdersByTagNos(items: ReadonlyArray<{
+    tagNo: string;
+}>): {
+    tagNosWithOpenWorkOrders: readonly TagNoWithWorkOrders[];
+};
+export {};

package/src/lib/feature/legend/hooks/useWorkOrdersByTagsQuery.d.ts

@@ -0,0 +1,15 @@
+import { WorkOrderDto } from '@equinor/echo-search';
+/**
+ * Fetches work orders for multiple tags using React Query.
+ *
+ * @param tagNos - Array of tag numbers to search work orders for
+ * @returns React Query result with work orders data, loading state, and error state
+ *
+ * @example
+ * ```typescript
+ * const tagNos = ['23-PV-1234', '23-XV-5678'];
+ * const { data: workOrders = [], isLoading, error } = useWorkOrdersByTagsQuery(tagNos);
+ * ```
+ *
+ */
+export declare function useWorkOrdersByTagsQuery(tagNos: string[]): import("@tanstack/react-query").UseQueryResult<readonly WorkOrderDto[], Error>;

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

@@ -16,6 +16,8 @@ export type { LegendStrategy } from './types/legendStrategy.type';
 export type { LegendId, LegendOptionConfig } from './types/legendType';
 export { useLegendUniqueBadges } from './hooks/useLegendUniqueBadges';
 export { useLegendUniqueMarkers } from './hooks/useLegendUniqueMarkers';
+export { useOpenWorkOrdersByTagNos } from './hooks/useWorkOrdersByTagNos';
+export { useWorkOrdersByTagsQuery } from './hooks/useWorkOrdersByTagsQuery';
 export { COUNT_MODE_KEYWORD } from './logic/normalizeBadges';
 export { useLegendVisibleDataStore } from './stores/legendVisibleDataStore/legendVisibleDataStore';
 export { useLegendUIStore } from './stores/legendUIStore/legendUIStore';

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/components/WorkOrderPopoverPrimaryRow.d.ts

@@ -5,11 +5,11 @@
  * a list of unique notification type identifiers resolved for the work order.
  *
  * @param props \- Component props.
- * @param props.workOrderNumber \- Work order identifier used for display and for fetching related objects.
+ * @param props.workOrderId \- Work order identifier used for display and for fetching related objects.
  * @param props.isActive \- Whether the work order is active \(`true`\) or completed \(`false`\).
  * @returns A React element containing the primary row content.
  */
-export declare const WorkOrderPopoverPrimaryRow: ({ workOrderNumber, isActive }: {
-    workOrderNumber: string;
+export declare const WorkOrderPopoverPrimaryRow: ({ workOrderId, isActive }: {
+    workOrderId: string;
     isActive: boolean;
 }) => import("react/jsx-runtime").JSX.Element;

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/workOrder.utils.d.ts

@@ -1,2 +1,16 @@
+import { WorkOrderDto } from '@equinor/echo-search';
 import { PopoverProps, WorkOrderPopover } from './workOrderPopover.types';
+/**
+ * Fetches work orders for a given legend data ID and filters them by the provided item IDs.
+ * Only supports tag-based lookups; returns undefined for non-tag legend data IDs
+ * or when no matching work orders are found.
+ */
 export declare function fetchWorkOrdersByLegendIdType({ legendDataId, itemIds }: PopoverProps): Promise<WorkOrderPopover[] | undefined>;
+type WorkOrderIconSource = Readonly<Pick<WorkOrderDto, 'orderTypeId'>>;
+/**
+ * Determines the icon name for a collection of work orders based on their order type IDs.
+ * Returns a group icon when multiple distinct order types are present,
+ * or a type-specific icon when all work orders share the same order type.
+ */
+export declare function getIconForWorkOrder(workOrders: ReadonlyArray<WorkOrderIconSource>): "workorders_pm01" | "workorders_pm02" | "workorders_pm03" | "workorders_pm04" | "workorders_pm05" | "workorders_pm06" | "workorders_pm10" | "workorders_pm15" | "workorders_pm20" | "workorders_main_group";
+export {};

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/workOrderPopover.types.d.ts

@@ -4,12 +4,12 @@ export type PopoverProps = {
     itemIds?: ReadonlyArray<LegendDataId>;
 };
 export interface WorkOrderPopover {
-    workOrderId: string;
-    isActive: boolean;
-    orderTypeId: string;
-    description: string;
-    plantNo: string;
-    workCenter: string;
-    basicFinishDateTime: Date | undefined;
-    basicFinishDateStatus: string | undefined;
+    readonly workOrderId: string;
+    readonly isActive: boolean;
+    readonly orderTypeId: string;
+    readonly description: string;
+    readonly plantNo: string;
+    readonly workCenter: string;
+    readonly basicFinishDateTime: Date | undefined;
+    readonly basicFinishDateStatus: string | undefined;
 }

package/src/lib/feature/measuringPoint/components/lastRecordedMeasurement/lastRecordedMeasurement.logic.d.ts

@@ -1,8 +1,8 @@
 import { MeasurementDto } from '../../types/measuringPoint';
 export type LastRecordedMeasurementData = {
-    conditionAsText?: string;
-    measurementDateTime: string | null;
-    codeAsText?: string;
+    conditionAsText: string | undefined;
+    measurementDateTime: string | undefined;
+    codeAsText: string | undefined;
     lastRecordedMeasurement: MeasurementDto | undefined;
 };
 export declare const getLastRecordedMeasurement: (measurements: MeasurementDto[]) => LastRecordedMeasurementData;

package/src/lib/feature/workOrder/api/api-workOrder-notification.d.ts

@@ -0,0 +1,12 @@
+export interface WorkOrderNotificationStatus {
+    readonly workOrderId: string;
+    readonly maintenanceRecordTypes: string[];
+    readonly hasB30Document: boolean;
+}
+/**
+ * Fetches maintenance record types and attachment type information for a work order.
+ *
+ * @param workOrderId - Unique work order identifier.
+ * @returns The notification data for the given work order, or `undefined` if the request returns no data.
+ */
+export declare function fetchNotificationStatusByWorkOrderId(workOrderId: string): Promise<WorkOrderNotificationStatus | undefined>;

package/src/lib/services/api/api-work-orders-by-tag-nos.d.ts

@@ -0,0 +1,15 @@
+import { WorkOrderDto } from '@equinor/echo-search';
+/**
+ * Fetches work orders for multiple tags using echo-search.
+ * Wraps the echo-search API call for use with React Query.
+ * Throws via `resultHelper.throwIfError` when the search result contains errors.
+ *
+ * @param tagNos - Array of tag numbers to search work orders for
+ * @returns Promise resolving to array of work orders
+ *
+ * @example
+ * ```typescript
+ * const workOrders = await fetchWorkOrdersByTagNos(['23-PV-1234', '23-XV-5678']);
+ * ```
+ */
+export declare function fetchWorkOrdersByTagNos(tagNos: ReadonlyArray<string>): Promise<ReadonlyArray<WorkOrderDto>>;

package/src/lib/feature/measuringPoint/components/lastRecordedMeasurement/lastRecordedMeasurement.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { LastRecordedMeasurementData } from './lastRecordedMeasurement.logic';
-type LastRecordedMeasurementProps = {
-    lastRecordedMeasurement: LastRecordedMeasurementData;
-    failureMechanismDescription: string;
-};
-export declare const LastRecordedMeasurement: React.FC<LastRecordedMeasurementProps>;
-export {};