@equinor/echo-framework 0.23.1 → 0.23.3

package/src/lib/feature/globalSelection/selectionMenu/selectionTreeStore/selectionTree.store.types.d.ts

@@ -1,4 +1,4 @@
-import { ResultArray, TagSummaryDto } from '@equinor/echo-search';
+import { EquipmentData, ResultArray, TagSummaryDto, WorkOrderData } from '@equinor/echo-search';
 import { Guid } from '@equinor/echo-utils';
 import { GlobalSelectionItemType, GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
 import { AddByLabel, AddItemArgs, AddItemsResponse, SelectionTreeActionResult } from './actions/selectionTree.action.types';
@@ -9,14 +9,10 @@ export type SelectionItemTypeToItemIdMap = {
 };
 export declare enum GlobalSelectionCategoryId {
     Tags = "DEFAULT_TAG_LIST_ID",
-    WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID"
+    WorkOrders = "DEFAULT_WORK_ORDER_LIST_ID",
+    Equipments = "DEFAULT_EQUIPMENT_LIST_ID"
 }
 export declare const globalSelectionDefaultGroupId: Guid;
-/**  @deprecated Use GlobalSelectionCategoryId instead */
-export declare enum SelectionMenuDefaultListIds {
-    TagList = "DEFAULT_TAG_LIST_ID",
-    WorkOrderList = "DEFAULT_WORK_ORDER_LIST_ID"
-}
 export type SelectionTreeItem<T extends GlobalSelectionItemType> = {
     id: SelectionItemTypeToItemIdMap[T];
     type: T;
@@ -48,13 +44,12 @@ export interface SelectionTreeData {
 }
 export interface SelectionTreeStore {
     groups: SelectionGroup[];
-    addTags: <T extends boolean | undefined = undefined>(args: AddItemArgs<GlobalSelectionTypes.TagId> & {
-        getActionResult?: T;
-    }) => Promise<AddTagsReturnType<T>>;
-    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => void;
     addItems: (args: {
         itemIds: GlobalSelectionTypes.ItemId[];
     } & AddByLabel) => void;
+    addTags: (args: AddItemArgs<GlobalSelectionTypes.TagId>) => Promise<AddItemsResponse<ResultArray<TagSummaryDto>[]>>;
+    addWorkOrders: (args: AddItemArgs<GlobalSelectionTypes.WorkOrderId>) => Promise<AddItemsResponse<ResultArray<WorkOrderData>[]>>;
+    addEquipments: (args: AddItemArgs<GlobalSelectionTypes.EquipmentId>) => Promise<AddItemsResponse<ResultArray<EquipmentData>[]>>;
     createGroup: (args: {
         label: string;
         subLabel: string;
@@ -86,4 +81,3 @@ export declare namespace SelectionTreeTypes {
     type Group = SelectionGroup;
     type ActionResult = SelectionTreeActionResult;
 }
-export type AddTagsReturnType<T extends boolean | undefined = undefined> = T extends true ? AddItemsResponse<ResultArray<TagSummaryDto>[]> : ResultArray<TagSummaryDto>[];

package/src/lib/feature/hooks/useAddTagToLegendRegistry.d.ts

@@ -6,7 +6,7 @@ import { LegendItemStatus } from '../legacyLegend';
  * Adds one given tag item to the legend registry service, which tracks the legend status of the registered items.
  * Returns with the updated itemIdToStatusMap, which contains this newly added item by id as well.
  *
- * @param {string} tagId The given tag's id to be stored in the registry.
+ * @param {string} tagNo The given tag's id to be stored in the registry.
  * @returns {Record<string, LegendItemStatus>} A legend status map: keys are the item ids, values are the legend statuses.
  */
-export declare function useAddTagToLegendRegistry(tagId: string): Record<string, LegendItemStatus>;
+export declare function useAddTagToLegendRegistry(tagNo: string): Record<string, LegendItemStatus>;

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

@@ -1,2 +1,3 @@
+export declare function unsubscribeToLegendDataChanged(): void;
 export declare function subscribeToLegendDataChanged(): void;
 export declare const sleep: (ms: number) => Promise<unknown>;

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

@@ -52,6 +52,7 @@ export declare const useLegendVisibleDataStore: import("zustand").UseBoundStore<
         type: string;
     } | undefined): void;
 }>;
+export declare function legendVisibleDataSnapshot(): LegendVisibleDataStore;
 /**
  * Visible items are all items on screen that should be affected by the legend.
  * @returns A function for adding visible items by type and key, which is automatically removed when the component unmounts.

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

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

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/components/PointCountSelector.d.ts

@@ -0,0 +1,15 @@
+/**
+ * PointCountSelector lets users choose how many data points to display,
+ * such as the last 5, 10, 15, 20, or all available points.
+ *
+ * @param maxPoints - The total number of points available for selection.
+ * @param pointCount - The currently selected number of points to display.
+ * @param onChange - Callback when the user selects a different point count.
+ */
+interface PointCountSelectorProps {
+    maxPoints: number;
+    pointCount: number;
+    onChange: (selectedValue: number) => void;
+}
+export declare const PointCountSelector: React.FC<PointCountSelectorProps>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/components/graphStyleControls.d.ts

@@ -0,0 +1,7 @@
+import { ActiveStyle, HandleInterpolationChange } from '../types/activeStyleType';
+type GraphStyleControlsProps = {
+    activeStyle: ActiveStyle;
+    onInterpolationChange: HandleInterpolationChange;
+};
+export declare const GraphStyleControls: React.FC<GraphStyleControlsProps>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/components/measuringHistoryGraphDialog.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+type DialogBox = {
+    open: boolean;
+    onClose: () => void;
+    content: React.ReactNode;
+};
+export declare const MeasuringHistoryGraphDialog: React.FC<DialogBox>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/components/measuringHistoryGraphTooltip.d.ts

@@ -0,0 +1,2 @@
+import { AgBarSeriesTooltipRendererParams } from 'ag-charts-community';
+export declare function measuringHistoryGraphTooltip(params: AgBarSeriesTooltipRendererParams): string;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/components/viewInFullScreenButton.d.ts

@@ -0,0 +1,5 @@
+export declare const ViewInFullScreenButton: React.FC<{
+    open: boolean;
+    onToggle: () => void;
+    children: React.ReactNode;
+}>;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/hooks/useActiveStyleGraph.d.ts

@@ -0,0 +1,5 @@
+import { ActiveStyle, SetActiveStyle } from '../types/activeStyleType';
+export declare const useActiveStyle: () => {
+    activeStyle: ActiveStyle;
+    setActiveStyle: SetActiveStyle;
+};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/hooks/useMeasuringChartConfig.d.ts

@@ -0,0 +1,10 @@
+import { AgCartesianChartOptions } from 'ag-charts-community';
+import { MeasurementDto } from '../../../../types/measuringPoint';
+import { ActiveStyle, HandleInterpolationChange } from '../types/activeStyleType';
+export declare function useMeasuringChartConfig(measurements: MeasurementDto[], activeStyle: ActiveStyle, setActiveStyle: (style: ActiveStyle) => void, isFullscreen: boolean): {
+    chartConfig: AgCartesianChartOptions;
+    sortedMeasurements: import("../utils/measuringPointHistoryListUtils").SortedMeasurement[];
+    pointCount: number;
+    setPointCount: import("react").Dispatch<import("react").SetStateAction<number>>;
+    updateInterpolation: HandleInterpolationChange;
+};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/measuringDocumentsHistoryGraph.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { MeasurementDto } from '../../../types/measuringPoint';
+import { ActiveStyle, SetActiveStyle } from './types/activeStyleType';
+type MeasuringDocumentsHistoryGraphProps = {
+    measurements: MeasurementDto[];
+    activeStyle: ActiveStyle;
+    setActiveStyle: SetActiveStyle;
+    isFullSize?: boolean;
+    specifiedHeight?: string;
+    specifiedPadding?: string;
+    graphStyleControls?: boolean;
+};
+export declare const MeasuringDocumentsHistoryGraph: React.FC<MeasuringDocumentsHistoryGraphProps>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/measuringPointHistoryGraphSection.d.ts

@@ -0,0 +1,6 @@
+import { MeasurementDto } from '../../../types/measuringPoint';
+interface MeasuringPointHistoryGraphSectionProps {
+    measurements: MeasurementDto[];
+}
+export declare const MeasuringPointHistoryGraphSection: React.FC<MeasuringPointHistoryGraphSectionProps>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/measuringPointHistoryItem.d.ts

@@ -0,0 +1,6 @@
+import { MeasurementDto } from '../../../types/measuringPoint';
+export declare const MeasuringPointHistoryItem: React.FC<{
+    measurement: MeasurementDto;
+    quantitativeCharacteristicId: string | undefined;
+    instCode: string | undefined;
+}>;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/{measuringPointHistoryList.d.ts → measuringPointHistoryList/measuringPointHistoryList.d.ts}

@@ -1,4 +1,4 @@
-import { MeasuringPointDto } from '../../types/measuringPoint';
+import { MeasuringPointDto } from '../../../types/measuringPoint';
 type MeasuringPointHistoryListProps = {
     measuringPoint: MeasuringPointDto;
 };

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/types/activeStyleType.d.ts

@@ -0,0 +1,7 @@
+import { Position, Type } from './measuringDocumentsHistoryGraphType';
+export type ActiveStyle = {
+    type: Type;
+    position?: Position;
+};
+export type HandleInterpolationChange = (type: ActiveStyle['type'], position?: ActiveStyle['position']) => void;
+export type SetActiveStyle = (style: ActiveStyle) => void;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/types/measuringDocumentsHistoryGraphType.d.ts

@@ -0,0 +1,7 @@
+import { AgBaseAxisLabelOptions } from 'ag-charts-community';
+import { SortedMeasurement } from '../utils/measuringPointHistoryListUtils';
+export declare const strongRed: string;
+export declare const strongRedFade: string;
+export type Type = 'linear' | 'smooth' | 'step';
+export type Position = 'start' | 'middle' | 'end';
+export declare const createLabel: (fullScreenDialogOpen: boolean | undefined, sortedMeasurements: SortedMeasurement[], yAxisLabel?: boolean) => AgBaseAxisLabelOptions;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/utils/createMeasuringChartConfig.d.ts

@@ -0,0 +1,4 @@
+import { AgCartesianChartOptions } from 'ag-charts-community';
+import { ActiveStyle } from '../types/activeStyleType';
+import { SortedMeasurement } from './measuringPointHistoryListUtils';
+export declare function createMeasuringChartConfig(data: SortedMeasurement[], activeStyle: ActiveStyle, fullScreen?: boolean): AgCartesianChartOptions;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/measuringPointHistoryList/utils/measuringPointHistoryListUtils.d.ts

@@ -0,0 +1,63 @@
+import { AgAxisLabelFormatterParams, AgCartesianChartOptions } from 'ag-charts-community';
+import { MeasurementDto } from '../../../../types/measuringPoint';
+import { ActiveStyle } from '../types/activeStyleType';
+export interface SortedMeasurement {
+    date: string;
+    condition: number;
+    fullDateTime: Date;
+    unit: string;
+}
+/**
+ * Filters the given list of measurements to include only those with valid quantitative or qualitative readings.
+ *
+ * @param {MeasurementDto[]} measurements - The list of measurements to filter.
+ * @returns {MeasurementDto[]} - The filtered list of measurements.
+ */
+export declare const filterMeasurements: (measurements: MeasurementDto[]) => MeasurementDto[];
+/**
+ * Maps a MeasurementDto to a simplified sortable measurement object.
+ *
+ * @param {MeasurementDto} measurement - The measurement to transform.
+ * @returns {Omit<SortedMeasurement, 'date'> & { fullDateTime: Date, date: Date }} - The transformed measurement with full datetime info.
+ */
+export declare const mapToSortableMeasurement: (measurement: MeasurementDto) => Omit<SortedMeasurement, "date"> & {
+    fullDateTime: Date;
+    date: Date;
+};
+/**
+ * Sorts the given list of measurements by their measurement date and maps them to a simplified structure.
+ *
+ * @param {MeasurementDto[]} measurements - The list of measurements to sort and map.
+ * @returns {SortedMeasurement[]} - The sorted and mapped list of measurements.
+ */
+export declare const sortMeasurements: (measurements: MeasurementDto[]) => SortedMeasurement[];
+/**
+ * Formats the x-axis labels for the chart, where only a specified number of labels are displayed.
+ *
+ * @param {AgAxisLabelFormatterParams} params - The parameters for the axis label formatter.
+ * @returns {string} - The formatted label for the x-axis.
+ */
+export declare function xAxisLabelFormatter(args: {
+    params: AgAxisLabelFormatterParams;
+    sortedMeasurements: SortedMeasurement[];
+    numberOfLabels: 3 | number;
+}): any;
+/**
+ * Updates the chart interpolation style for the given chart options.
+ *
+ * @param {AgCartesianChartOptions} chartOptions - The chart options to update.
+ * @param {boolean} enableInterpolation - Whether to enable or disable interpolation.
+ * @returns {AgCartesianChartOptions} - The updated chart options with the interpolation setting applied.
+ */
+export declare function updateChartInterpolation(prevConfig: AgCartesianChartOptions, type: ActiveStyle['type'], position: ActiveStyle['position'] | undefined, isFullscreen: boolean): AgCartesianChartOptions;
+/**
+ * Formats a measurement value for display in the chart tooltip or list.
+ *
+ * @param {number} value - The measurement value to format.
+ * @param {string} unit - The unit of the measurement.
+ * @returns {string} - The formatted measurement value with the unit.
+ */
+export declare function formatMeasurement(measurement: {
+    quantitativeReading?: number;
+    quantitativeReadingUnitId?: string | null;
+}): string;

package/src/lib/feature/measuringPoint/types/measuringPoint.d.ts

@@ -1,3 +1,4 @@
+import { MeasuringPointData } from '@equinor/echo-search';
 export interface MeasurementDto {
     measurementId: string;
     measuringPointId: string;
@@ -14,20 +15,6 @@ export interface MeasurementDto {
     qualitativeCodeId?: string;
     longText?: object;
 }
-export interface MeasuringPointDto {
-    readonly measuringPointId: string;
-    readonly measuringPosition?: string;
-    readonly measuringPoint?: string;
-    readonly functionalLocationId?: string;
-    readonly tagPlantId?: string;
-    readonly tagId?: string;
-    readonly equipmentId?: string;
-    readonly quantitativeCharacteristicId?: string;
-    readonly quantitativeCharacteristicUnit?: string;
-    readonly positionDetails_CoordinateSystemName?: string;
-    readonly positionDetails_E3DReferenceNumber?: string;
-    readonly positionDetails_CoordinateEast?: string;
-    readonly positionDetails_CoordinateNorth?: string;
-    readonly positionDetails_CoordinateUp?: string;
+export interface MeasuringPointDto extends MeasuringPointData {
     readonly measurements: MeasurementDto[];
 }

package/src/lib/utils/highlightTextUtil.d.ts

@@ -0,0 +1,26 @@
+/**
+ * CSS class name to be added to components that should be highlightable.
+ *
+ * @example
+ * // Add this class to the `className` of a component to make it highlightable.
+ * <div className={highlightableComponentCssClass}>...</div>
+ */
+export declare const highlightableComponentCssClass = "highlightableComponentCssClass";
+/**
+ * Highlights text within elements that have the `highlightableComponentCssClass` class.
+ *
+ * This function uses the `mark.js` library to highlight text matching the `search` query parameter
+ * in the URL. It applies the `highlightedText` CSS class to the matched text. The styling for
+ * `highlightedText` should be defined in `./public/index.css`.
+ *
+ * @example
+ * // Add the following to a React component to enable text highlighting:
+ * useEffect(() => {
+ *     highlightText();
+ * }, []);
+ *
+ * @remarks
+ * - The `search` query parameter is retrieved using `getLinkParams` from `@equinor/echo-utils`.
+ * - Punctuation characters are ignored during the matching process.
+ */
+export declare const highlightText: () => void;

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

@@ -1,5 +1,6 @@
 export { echopediaWebReactPortalUtils } from './echopediaWebReactPortal.utils';
 export * from './formatTimeHelpers';
+export * from './highlightTextUtil';
 export * from './navigationUtils';
 export * from './openIn3d';
 export * from './plantInfo';

package/src/lib/utils/stringUtils.d.ts

@@ -1 +1,6 @@
+/**
+ * @deprecated This is a duplicate, we plan to remove this. Please use the same function from "@equinor/echo-utils".
+ * @param inputString
+ * @returns {string}
+ */
 export declare function removeLeadingZeros(inputString: string): string;

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

@@ -1,4 +0,0 @@
-import { WorkOrderData } from '@equinor/echo-search';
-import { GlobalSelectionTypes } from './globalSelectionStore.types';
-export declare function createNullTagSummaryDb(itemId: GlobalSelectionTypes.TagId): GlobalSelectionTypes.TagDto;
-export declare function createNullWorkOrderData(itemId: GlobalSelectionTypes.WorkOrderId): WorkOrderData;