@equinor/echo-framework 0.16.6 → 0.16.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.16.6",
+  "version": "0.16.7",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.9.0 < 0.10.0",
@@ -11,6 +11,7 @@
     "@equinor/eds-icons": "^0.17.0",
     "react": ">= 17.0.2",
     "react-dom": ">= 17.0.2",
+    "@tanstack/react-query": "5.8.1",
     "@microsoft/signalr": "7.0.12",
     "classnames": "2.3.2",
     "history": "5.3.0",

package/src/index.d.ts

@@ -1,11 +1,16 @@
 /// <reference types="react" />
+import { getEquipmentInfoFromApi } from './lib/feature/equipment/api/api-equipmentInfo';
 import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
 export * from './lib/components';
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
 export * from './lib/coreApplication';
+export * from './lib/feature/equipment/index';
+export * from './lib/feature/equipment/types/equipmentInfo';
 export * from './lib/feature/legend/index';
+export * from './lib/feature/measuringPoint/index';
+export * from './lib/feature/measuringPoint/types/measuringPoint';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
 export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabled';
@@ -115,6 +120,7 @@ declare const EchoFramework: Readonly<{
             web3dUrl: string;
         }>;
         createTemporarilyEchoHubListFor3D: (request: import("./lib/types/api-echohub").TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined) => Promise<import("./lib/types/api-echohub").TemporaryHubListCreatedResponse>;
+        getEquipmentInfoFromApi: typeof getEquipmentInfoFromApi;
     }>;
 }>;
 export default EchoFramework;

package/src/lib/components/errorBoundary/chunkLoadErrorHelper.d.ts

@@ -0,0 +1,7 @@
+type ErrorHandlers = {
+    reloadPageClicked: () => void;
+    forcePageReloadOnceOnChunkLoadError: () => void;
+};
+export declare function chunkLoadErrorHelper(error: Error | undefined): ErrorHandlers;
+export declare function isChunkLoadError(error: Error): boolean;
+export {};

package/src/lib/components/errorBoundary/components/chunkLoadErrorMessage.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
-declare const ChunkLoadErrorMessage: () => JSX.Element;
-export default ChunkLoadErrorMessage;
+type Props = {
+    error: Error | undefined;
+};
+export declare const ChunkLoadErrorMessage: ({ error }: Props) => JSX.Element;
+export {};

package/src/lib/components/errorBoundary/pageAutoReloadState.d.ts

@@ -0,0 +1,9 @@
+declare function hasForcedPageReloadAlready(): boolean;
+declare function savePageAutoReloaded(autoReloadedAt?: Date): void;
+declare function deleteState(): void;
+export declare const pageAutoReloadState: {
+    save: typeof savePageAutoReloaded;
+    delete: typeof deleteState;
+    hasReloadedAlready: typeof hasForcedPageReloadAlready;
+};
+export {};

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

@@ -21,3 +21,6 @@ export * from './router';
 export * from './searchMenu';
 export * from './tagNumber';
 export * from './toaster';
+export * from './labelledValueGrid';
+export * from './spinner/spinner';
+export { ListItem } from './listItem/listItem';

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

@@ -0,0 +1 @@
+export * from './labelledValueGrid';

package/src/lib/components/labelledValueGrid/labelledValue.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+interface LabelledValueProps {
+    label: string;
+    value: React.ReactNode | string;
+    colSpan?: boolean;
+}
+export declare const LabelledValue: React.FC<LabelledValueProps>;
+export {};

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

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+interface LabelledValueGridProps {
+    fields: LabelledValueGridField[];
+}
+export type LabelledValueGridField = {
+    label: string;
+    value: React.ReactNode | string;
+    colSpan?: boolean;
+};
+/**
+ * Component for displaying elements in a grid with labels per value
+ * @param fields: takes in a list of values with their corresponding labels
+ * @returns {*}
+ */
+export declare const LabelledValueGrid: React.FC<LabelledValueGridProps>;
+export {};

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

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+interface ListItemProps {
+    title: string;
+    iconName?: string;
+    iconColor?: string;
+    iconBackgroundColor?: string;
+    visualText?: string;
+    description?: string;
+    additionalInfo?: JSX.Element;
+}
+export declare const ListItem: React.FC<ListItemProps>;
+export {};

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+interface SpinnerProps {
+    label?: string;
+    className?: string;
+    size?: 16 | 24 | 32 | 40 | 48;
+}
+export declare const Spinner: React.FC<SpinnerProps>;
+export {};

package/src/lib/feature/equipment/api/api-equipmentInfo.d.ts

@@ -0,0 +1,5 @@
+import { EquipmentInfo } from '../types/equipmentInfo';
+export declare function getEquipmentInfoFromApi({ tagNo, instCode }: {
+    tagNo: string;
+    instCode: string;
+}): Promise<EquipmentInfo[]>;

package/src/lib/feature/equipment/api/api-equipmentWithMeasuringPoints.d.ts

@@ -0,0 +1,5 @@
+import { EquipmentWithMeasuringPoints } from '../types/equipmentWithMeasuringPoints';
+export declare function getEquipmentWithMeasuringPointsFromApi({ tagNos, instCode }: {
+    tagNos: string[];
+    instCode: string;
+}): Promise<EquipmentWithMeasuringPoints[]>;

package/src/lib/feature/equipment/components/equipmentInfoItem.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { EquipmentInfo } from '../types/equipmentInfo';
+interface EquipmentItemProps {
+    equipment: EquipmentInfo;
+    tagNo: string;
+    plantNo: string;
+}
+export declare const EquipmentInfoItem: React.FC<EquipmentItemProps>;
+export {};

package/src/lib/feature/equipment/components/equipmentItemDetails/equipmentItemDetails.d.ts

@@ -0,0 +1,3 @@
+import * as React from 'react';
+import { EquipmentAccordionContentProps } from '../equipmentTabs/equipmentTabs';
+export declare const EquipmentItemDetails: React.FC<EquipmentAccordionContentProps>;

package/src/lib/feature/equipment/components/equipmentItemHeader/equipmentItemHeader.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface EquipmentItemHeaderProps {
+    equipmentNo: string;
+    tagNo: string;
+}
+export declare const EquipmentItemHeader: React.FC<EquipmentItemHeaderProps>;
+export {};

package/src/lib/feature/equipment/components/equipmentTabs/equipmentTabs.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+export interface EquipmentAccordionContentProps {
+    equipmentNo: string;
+    tagNo: string;
+    plantNo: string;
+    showAdditionalInfo?: boolean;
+}
+export declare const EquipmentTabs: React.FC<EquipmentAccordionContentProps>;

package/src/lib/feature/equipment/components/index.d.ts

@@ -0,0 +1,4 @@
+export { EquipmentTabs } from './equipmentTabs/equipmentTabs';
+export { EquipmentItemHeader } from './equipmentItemHeader/equipmentItemHeader';
+export { EquipmentInfoItem } from './equipmentInfoItem';
+export { EquipmentItemDetails } from './equipmentItemDetails/equipmentItemDetails';

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

@@ -0,0 +1,11 @@
+/**
+ *  Opens equipment details panel on the left side of the screen
+ * @returns {function}
+ */
+export declare function useOpenEquipmentDetails(): (args: {
+    equipmentNo: string;
+    tagNo: string;
+    plantNo: string;
+    panelKey?: string | undefined;
+    keepLastNavigationItem?: boolean | undefined;
+}) => void;

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

@@ -0,0 +1,3 @@
+export { useOpenEquipmentDetails } from './hooks/useOpenEquipmentDetails';
+export { getEquipmentWithMeasuringPointsFromApi } from './api/api-equipmentWithMeasuringPoints';
+export { EquipmentInfoItem, EquipmentItemDetails, EquipmentItemHeader, EquipmentTabs } from './components';

package/src/lib/feature/equipment/types/equipmentInfo.d.ts

@@ -0,0 +1,18 @@
+export interface EquipmentInfo {
+    readonly equipmentNo: string;
+    readonly description: string;
+    readonly manufacturer: string;
+    readonly modelNo: string;
+    readonly partNo: string;
+    readonly serialNo: string;
+    readonly materialNo: string;
+    readonly functionalLocation: string;
+    readonly validFrom: string;
+    readonly weightNet: number;
+    readonly documents: {
+        readonly docId: string;
+        readonly docNo: string;
+        readonly description: string;
+        readonly url: string;
+    };
+}

package/src/lib/feature/equipment/types/equipmentWithMeasuringPoints.d.ts

@@ -0,0 +1,19 @@
+import { MeasuringPointDto } from '../../measuringPoint/types/measuringPoint';
+export interface EquipmentWithMeasuringPoints {
+    readonly equipmentId: string;
+    readonly equipment: string;
+    readonly maintenancePlantId: string;
+    readonly functionalLocationId: string;
+    readonly tagPlantId: string;
+    readonly tagId: string;
+    readonly locationId: string;
+    readonly area: string;
+    readonly categoryId: string;
+    readonly activeStatusIds: string[];
+    readonly systemStatusIds: string[];
+    readonly userStatusIds: string[];
+    readonly equipmentsStatus: string[];
+    readonly changedDate: string;
+    readonly createdDate: string;
+    readonly measuringPoints: MeasuringPointDto[];
+}

package/src/lib/feature/measuringPoint/components/failureMechanism.config.d.ts

@@ -0,0 +1,19 @@
+export declare const failureMechanismConfig: ({
+    title: string;
+    id: string;
+    legendValueType: string;
+    measuringPointQueryTypeIdentifier: string;
+    values: {
+        value: string;
+        color: string;
+    }[];
+} | {
+    title: string;
+    id: string;
+    legendValueType: string;
+    measuringPointQueryTypeIdentifier: string;
+    values: {
+        value: number;
+        color: string;
+    }[];
+})[];

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

@@ -0,0 +1,3 @@
+export { MeasuringPointItem } from './measuringPointItem';
+export { MeasuringPointHeader } from './measuringPointHeader/measuringPointHeader';
+export { MeasuringPointDetails } from './measuringPointDetails/measuringPointDetails';

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { MeasuringPointDto } from '../../types/measuringPoint';
+type LastRecordedMeasurementProps = {
+    measuringPoint: MeasuringPointDto;
+};
+export declare const LastRecordedMeasurement: React.FC<LastRecordedMeasurementProps>;
+export {};

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

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

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

@@ -0,0 +1,6 @@
+import { MeasuringPointDto } from '../../types/measuringPoint';
+type MeasuringPointDetailsProps = {
+    measuringPoint: MeasuringPointDto;
+};
+export declare const MeasuringPointDetails: ({ measuringPoint }: MeasuringPointDetailsProps) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,2 @@
+export declare const getInstCodeForSapPlantId: (sapPlantId: string) => string;
+export declare const isNumberInRange: (sapPlantIdStr: string, sapPlantIdRange: string) => boolean;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/useAddTagToLegendRegistry.d.ts

@@ -0,0 +1,12 @@
+import { LegendItemStatus } from '../../../legend';
+/**
+ * @deprecated Don't use this - the current legend registry service is a heavily outdated solution,
+ * we shouldn't increase the tech dept even further.
+ *
+ * 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.
+ * @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>;

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

@@ -0,0 +1,6 @@
+import { MeasuringPointDto } from '../../types/measuringPoint';
+type Props = {
+    measuringPoint: MeasuringPointDto;
+};
+export declare const MeasuringPointHeader: ({ measuringPoint }: Props) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,16 @@
+import React from 'react';
+import { MeasuringPointDto } from '../types/measuringPoint';
+interface MeasuringPointItemProps {
+    measuringPoint: MeasuringPointDto;
+    asHeader?: boolean;
+    isActive: boolean;
+    onClick: () => void;
+}
+/**
+ * Component for displaying measuring point item.
+ * Displays information about the condition of the measuring point, as well as the last recorded measurement.
+ * @param {MeasuringPointItemProps}
+ * @returns {*}
+ */
+export declare const MeasuringPointItem: React.FC<React.PropsWithChildren<MeasuringPointItemProps>>;
+export {};

package/src/lib/feature/measuringPoint/components/measuringPoints.utils.d.ts

@@ -0,0 +1,7 @@
+interface FailureMechanismCondition {
+    id: string | undefined;
+    value: string | undefined;
+    color: string;
+}
+export declare function getFailureMechanismCondition(qualitativeCodeGroupId: string | undefined, qualitativeCodeId: string | number | undefined): FailureMechanismCondition;
+export {};

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

@@ -0,0 +1 @@
+export { useOpenMeasuringPointDetails } from './useOpenMeasuringPointDetails';

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

@@ -0,0 +1,12 @@
+import { MeasuringPointDto } from '../types/measuringPoint';
+/**
+ *  Opens measuring point details panel on the left side of the screen
+ * @returns {function}
+ */
+export declare function useOpenMeasuringPointDetails(): (args: MeasuringPointArgs) => void;
+type MeasuringPointArgs = {
+    measuringPoint: MeasuringPointDto;
+    panelKey?: string;
+    keepLastNavigationItem?: boolean;
+};
+export {};

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

@@ -0,0 +1,3 @@
+export { MeasuringPointDetails, MeasuringPointItem, MeasuringPointHeader } from './components';
+export type { MeasurementDto, MeasuringPointDto } from './types/measuringPoint';
+export { useOpenMeasuringPointDetails } from './hooks';

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

@@ -0,0 +1,32 @@
+export interface MeasurementDto {
+    measurementId: string;
+    measuringPointId: string;
+    measurementDateTime?: string;
+    measurementTitle?: string;
+    longTextExists?: string;
+    createdDateTime?: string;
+    maintenanceRecordId?: string;
+    workOrderId?: string;
+    quantitativeReadingInSIUnit?: number;
+    quantitativeReading?: number;
+    quantitativeReadingUnitId?: string;
+    qualitativeCodeGroupId?: string;
+    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 quantitativeCharacteristicUnit?: string;
+    readonly positionDetails_CoordinateSystemName?: string;
+    readonly positionDetails_E3DReferenceNumber?: string;
+    readonly positionDetails_CoordinateEast?: string;
+    readonly positionDetails_CoordinateNorth?: string;
+    readonly positionDetails_CoordinateUp?: string;
+    readonly measurements: MeasurementDto[];
+}

package/src/lib/services/activeSelectionStore/activeSelectionData.hooks.d.ts

@@ -0,0 +1,10 @@
+import { TagSummaryDto } from '@equinor/echo-search';
+import { UseQueryResult } from '@tanstack/react-query';
+/**
+ * Get the tag summaries for those tags, which are part of the active selection.
+ * Works with deep linking: if the selected instCode is different then the instCode in the URL
+ * it will fetch the tag summaries from STID API.
+ * Otherwise it will get it from echo-search.
+ * @returns {UseQueryResult<TagSummaryDto[]>}
+ */
+export declare function useActiveSelectedTagSummaries(): UseQueryResult<TagSummaryDto[]>;

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

@@ -1,5 +1,13 @@
 import * as zustand from 'zustand';
-export declare const useActiveSelectionStore: zustand.UseBoundStore<zustand.StoreApi<ActiveSelectionState>>;
+export declare const useActiveSelectionStore: zustand.UseBoundStore<Omit<zustand.StoreApi<ActiveSelectionState>, "subscribe"> & {
+    subscribe: {
+        (listener: (selectedState: ActiveSelectionState, previousSelectedState: ActiveSelectionState) => void): () => void;
+        <U>(selector: (state: ActiveSelectionState) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+            equalityFn?: ((a: U, b: U) => boolean) | undefined;
+            fireImmediately?: boolean | undefined;
+        } | undefined): () => void;
+    };
+}>;
 export type ActiveSelectionItemType = 'tagNos' | 'workOrderIds' | 'measuringPointIds';
 export type ActiveSelectionItems = {
     [key in ActiveSelectionItemType]: string[];

package/src/lib/services/activeSelectionStore/index.d.ts

@@ -1 +1,2 @@
+export * from './activeSelectionData.hooks';
 export * from './activeSelectionStore';

package/src/lib/services/api/api-manager.d.ts

@@ -13,7 +13,10 @@ interface Request<T> {
         isEnabled: boolean;
         timeToLiveMilliseconds?: number;
     };
+    method?: string;
+    body?: BodyInit;
+    headerOptions?: Record<string, unknown>;
     options?: RequestOptions<T>;
 }
-export declare function request<T>({ cache, url, abortSignal, options }: Request<T>): Promise<T | undefined>;
+export declare function request<T>({ cache, url, abortSignal, options, headerOptions, method, body }: Request<T>): Promise<T | undefined>;
 export {};

package/src/lib/services/api/api-stid-tags.d.ts

@@ -0,0 +1,14 @@
+import { TagSummaryDto } from '@equinor/echo-search';
+/**
+ * Get a list of tags from STID.
+ * @param {string} args.instCode Plant instCode
+ * @param {string[]} args.tagNos Tag ids to query for
+ * @param {boolean} args.enableCache With this enabled, the call will be cached in memory and
+ * will be fetched from there instead of getting it from the API
+ * @returns {TagSummaryDto[]}
+ */
+export declare function getTagsFromStidApi(args: {
+    instCode: string;
+    tagNos: string[];
+    enableCache?: boolean;
+}): Promise<TagSummaryDto[]>;

package/src/lib/services/eventHubActions/index.d.ts

@@ -1 +1,2 @@
 export * from './toastActions';
+export * from './legendActions';

package/src/lib/services/eventHubActions/legendActions.d.ts

@@ -0,0 +1,6 @@
+import { LegendStatusesChangedEvent } from '../../types/eventTypes';
+/**
+ * Emit a statuses for item type event on echo core eventHub with a specific payload.
+ * @param {LegendStatusesChangedEvent} payload
+ */
+export declare const emitLegendStatusChangedEvent: (payload: LegendStatusesChangedEvent) => void;

package/src/lib/types/eventTypes/index.d.ts

@@ -1,6 +1,6 @@
 export type { FullScreenModeEvent } from './fullScreenModeEvent';
 export type { LeftPanelNavigationUpdateEvent } from './leftPanelNavigationUpdateEvent';
-export type { LegendChangedEvent } from './legendEvent';
+export type { LegendChangedEvent, LegendStatusesChangedEvent } from './legendEvent';
 export type { PlantEvent } from './plantEvent';
 export type { SearchItemDetailsClosedEvent } from './searchDetailsContainerEvents';
 export type { ToasterEvent } from './toasterEvent';

package/src/lib/types/eventTypes/legendEvent.d.ts

@@ -1,4 +1,7 @@
-import { LegendType } from '../../feature/legend/legend';
+import { LegendItemStatus, LegendType } from '../../feature/legend/legend';
 export interface LegendChangedEvent {
     newLegendType: LegendType;
 }
+export interface LegendStatusesChangedEvent {
+    itemIdToStatusMap: Record<string, LegendItemStatus>;
+}

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

@@ -0,0 +1 @@
+export declare function dateToStringOrEmptyWithoutTime(date: Date | string | undefined): string;

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

@@ -0,0 +1 @@
+export default function handleErrors(exception: Error | unknown): void;

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

@@ -3,3 +3,4 @@ export * from './plantInfo';
 export * from './previousUtils';
 export * from './searchUtil';
 export * from './stringUtils';
+export * from './formatTimeHelpers';