@equinor/echo-framework 0.18.1 → 0.18.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.18.1",
+  "version": "0.18.2",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",

package/src/index.d.ts

@@ -9,6 +9,7 @@ export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAcces
 export * from './lib/coreApplication';
 export * from './lib/feature/equipment/index';
 export * from './lib/feature/legend/index';
+export { getLatestMeasurementDate, sortMeasuringPointsByMeasurementDate } from './lib/feature/measuringPoint/components/measuringPoints.utils';
 export * from './lib/feature/measuringPoint/index';
 export * from './lib/feature/measuringPoint/types/measuringPoint';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
@@ -17,6 +18,7 @@ export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabl
 export { useScreenOrientation } from './lib/hooks/useScreenOrientation';
 export { useScreenValues } from './lib/hooks/useScreenValues';
 export * from './lib/services/activeSelectionStore';
+export { getPlantsCachedOrApi, getPlantsFromApi } from './lib/services/api/api-plants';
 export { RegisteredComponentName } from './lib/services/componentRegistry/componentRegistry';
 export * from './lib/services/eventHubActions';
 export * from './lib/services/searchItemDetails/searchItemDetails.store';
@@ -26,11 +28,14 @@ export * from './lib/types/api-echohub';
 export type { EchoHubPlant } from './lib/types/echoHubPlant';
 export * from './lib/types/eventTypes';
 export * from './lib/types/extensions';
+export type { BucketPanelKey, BucketSourceKey } from './lib/types/grid/bucketSideDrawer.types';
 export type { SetActiveTagNo, TagData } from './lib/types/hookLibrary';
 export type { ModelPermissions } from './lib/types/modelPermissions';
+export { InternalApplicationLinks } from './lib/types/navigation/internalApplicationLinks';
 export { PingableSources } from './lib/types/pingableSources';
 export { searchItemDetailsType } from './lib/types/searchItemDetailsType';
 export * from './lib/utils';
+export { convertPathNameToReadableString } from './lib/utils/moduleNameUtils';
 export * from './lib/utils/startup';
 export declare const registerEchopediaComponent: ({ name, component }: {
     name: import("./lib/services/componentRegistry/componentRegistry").RegisteredComponentName;
@@ -88,7 +93,7 @@ declare const EchoFramework: Readonly<{
             tagNo: string;
             instCode: string;
         }): {
-            tagDetails: import("@equinor/echo-search").TagDetailsDto | undefined;
+            tagDetails: import("dist/libs/echo-search/src").TagDetailsDto | undefined;
             isTagDetailsLoading: boolean;
             hasError: boolean;
         };

package/src/lib/components/contextualAppLinks/hooks/useContextualAppLinksContext.d.ts

@@ -1,4 +1,4 @@
 export declare function useContextualAppLinksContext(): {
-    tag: import("@equinor/echo-search").TagSummaryDto;
+    tag: import("dist/libs/echo-search/src").TagSummaryDto;
     instCode: string;
 };

package/src/lib/components/panel/corePanelLeft.d.ts

@@ -1,3 +1,2 @@
 import React from 'react';
-declare const CorePanelLeft: React.FC;
-export default CorePanelLeft;
+export declare const CorePanelLeft: React.FC;

package/src/lib/components/panel/corePanelRight.d.ts

@@ -1,3 +1,2 @@
 import React from 'react';
-declare const _default: React.NamedExoticComponent<{}>;
-export default _default;
+export declare const CorePanelRight: React.FC;

package/src/lib/components/panel/panelNavigation.helper.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { SearchItemDetailsObject } from '../../services/searchItemDetails/searchItemDetails.store';
+/**
+ * Hook for support the search panel navigation: it supports the "breadcumb" functionality, where the currently open item
+ * needs to refer back to the previous one.
+ *
+ * @returns { previousButton: React.ReactNode, activeSearchItem: React.ReactNode } An object containing two React components.
+ * previousButton to go back to the previous item in the search flow.
+ * activeSearchItem: the currently opened search item in the search flow.
+ */
+export declare const useLeftPanelNavigation: () => {
+    previousButton: React.ReactNode;
+    activeSearchItem: SearchItemDetailsObject | undefined;
+};

package/src/lib/components/prepview/common/error/ErrorCard.d.ts

@@ -0,0 +1,8 @@
+type ErrorContentProps = {
+    workOrderId?: string;
+    notificationId?: string;
+    punchId?: string;
+    error: Error;
+};
+export declare function ErrorCard(props: ErrorContentProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/components/prepview/common/error/index.d.ts

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

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

@@ -4,3 +4,4 @@ export * from './details';
 export * from './fileSizeDisplay';
 export * from './info';
 export * from './statusLabel/StatusLabel';
+export * from './error';

package/src/lib/components/prepview/panels/history/TagHistory.d.ts

@@ -5,5 +5,5 @@ interface HistoryProps {
     workOrderGroups: PrepviewTagHistoryGroup<PrepviewWorkOrder>[];
     punchGroups: PrepviewTagHistoryGroup<PrepviewPunch>[];
 }
-declare function TagHistoryPanel({ notificationGroups, workOrderGroups, punchGroups }: HistoryProps): JSX.Element;
+declare function TagHistoryPanel({ notificationGroups, workOrderGroups, punchGroups, }: HistoryProps): JSX.Element;
 export { TagHistoryPanel };

package/src/lib/components/prepview/panels/tagInformation/TagInformation.d.ts

@@ -1,10 +1,11 @@
 import { PrepviewTagInformation } from '../../types';
 interface Props {
     tagInformation: PrepviewTagInformation;
+    noInformationFound: boolean;
 }
 /**
  * TagInformationPanel
  * this panel requires the user to have maintenance access to show data.
  */
-declare function TagInformationPanel({ tagInformation }: Props): import("react/jsx-runtime").JSX.Element;
+declare function TagInformationPanel({ tagInformation, noInformationFound: notFound, }: Props): import("react/jsx-runtime").JSX.Element;
 export { TagInformationPanel };

package/src/lib/components/prepview/types/attachment.d.ts

@@ -3,5 +3,5 @@ export type PrepviewAttachment = {
     fileName: string;
     fileSize: number;
     id: string;
-    statusCode?: string;
+    statusCode?: number;
 };

package/src/lib/components/prepview/types/common.d.ts

@@ -8,7 +8,7 @@ import { PrepviewSafety } from './safety';
 import { PrepviewRelatedTag, PrepviewTagInformation } from './tag';
 import { PrepviewTagHistoryGroup, PrepviewWorkOrder } from './workorder';
 export type FetchStatus = {
-    statusCode?: 'Forbidden' | string;
+    statusCode?: 'Forbidden' | number;
 };
 export type ContentPickerGroup = {
     title?: string;

package/src/lib/components/prepview/types/operation.d.ts

@@ -3,6 +3,7 @@ export type PrepviewOperation = {
     title: string;
     workCenterId: string;
     plantId: string;
+    plantName: string;
     activeStatusIds: string;
     earliestStartDateTime: Date;
     earliestFinishDateTime: Date;

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

@@ -1,5 +1,5 @@
 import { Panel } from '@equinor/echo-core';
-/** TODO: This is not used (?) **/
+/** Used in echo-client for creating a host application for echo modules in dev mode **/
 /**
  * Core Main menu panel registered at client startup
  */

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

@@ -33,7 +33,10 @@ export declare enum LegendStatus {
     PM15 = "PM15",
     PM20 = "PM20",
     LC = "LC",
-    LO = "LO"
+    LO = "LO",
+    OnWatch = "OnWatch",
+    InProgress = "InProgress",
+    AnnotationError = "AnnotationError"
 }
 export declare enum LegendType {
     Stid = "Stid",
@@ -46,5 +49,6 @@ export declare enum LegendType {
     WorkOrderRevision = "WorkOrderRevision",
     ValvePosition = "ValvePosition",
     MeasuringPosition = "MeasuringPosition",
-    WorkPermit = "WorkPermit"
+    WorkPermit = "WorkPermit",
+    Annotations = "Annotations"
 }

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

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

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

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

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

@@ -1,7 +1,15 @@
-interface FailureMechanismCondition {
-    id: string | undefined;
-    value: string | undefined;
-    color: string;
-}
-export declare function getFailureMechanismCondition(qualitativeCodeGroupId: string | undefined, qualitativeCodeId: string | number | undefined): FailureMechanismCondition;
+import { MeasurementDto, MeasuringPointDto } from '../types/measuringPoint';
+type FailureMechanismIdAndValue = {
+    id: string;
+    value: string;
+};
+type FailureMechanismParams = {
+    lastRecordedMeasurement: MeasurementDto | undefined;
+    quantitativeCharacteristicId: string | undefined;
+};
+export declare function getFailureMechanismColor({ lastRecordedMeasurement, quantitativeCharacteristicId }: FailureMechanismParams): string;
+export declare function getFailureMechanismIdAndValue({ lastRecordedMeasurement, quantitativeCharacteristicId }: FailureMechanismParams): FailureMechanismIdAndValue | undefined;
+export declare function getColor(measurement: FailureMechanismIdAndValue): string | undefined;
+export declare const getLatestMeasurementDate: (point: MeasuringPointDto) => Date | undefined;
+export declare const sortMeasuringPointsByMeasurementDate: (a: MeasuringPointDto, b: MeasuringPointDto) => number;
 export {};

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

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

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

@@ -22,6 +22,7 @@ export interface MeasuringPointDto {
     readonly tagPlantId?: string;
     readonly tagId?: string;
     readonly equipmentId?: string;
+    readonly quantitativeCharacteristicId?: string;
     readonly quantitativeCharacteristicUnit?: string;
     readonly positionDetails_CoordinateSystemName?: string;
     readonly positionDetails_E3DReferenceNumber?: string;

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

@@ -5,3 +5,4 @@ import { Plant } from '@equinor/echo-core';
  * @return {*}  {Promise<Plant[]>}
  */
 export declare function getPlantsFromApi(): Promise<Plant[]>;
+export declare function getPlantsCachedOrApi(): Promise<ReadonlyArray<Plant>>;

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

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

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

@@ -0,0 +1,6 @@
+import { SetMainSearchTextEvent } from '../../types/eventTypes/setMainSearchTextEvent';
+/**
+ * Emit a SetSearchTextEvent on echo core eventHub with a specific payload.
+ * @param {SetMainSearchTextEvent} payload
+ */
+export declare const setMainSearchText: (payload: SetMainSearchTextEvent) => void;

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

@@ -3,4 +3,5 @@ export type { LeftPanelNavigationUpdateEvent } from './leftPanelNavigationUpdate
 export type { LegendChangedEvent, LegendStatusesChangedEvent } from './legendEvent';
 export type { PlantEvent } from './plantEvent';
 export type { SearchItemDetailsClosedEvent } from './searchDetailsContainerEvents';
+export type { SetMainSearchTextEvent } from './setMainSearchTextEvent';
 export type { ToasterEvent } from './toasterEvent';

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

@@ -2,4 +2,5 @@ import { Plant } from '@equinor/echo-core';
 export interface PlantEvent {
     selectedPlant: Plant;
     stayOnPath?: boolean;
+    alertUserPlantChanged?: boolean;
 }

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

@@ -0,0 +1,3 @@
+export interface SetMainSearchTextEvent {
+    searchText: string;
+}

package/src/lib/types/grid/bucketSideDrawer.types.d.ts

@@ -0,0 +1,2 @@
+export type BucketPanelKey = 'turnaround' | 'sharedWithMe' | 'project';
+export type BucketSourceKey = 'Turnaround grid' | 'Project grid';

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

@@ -0,0 +1 @@
+export type { BucketPanelKey, BucketSourceKey } from './bucketSideDrawer.types';

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

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

package/src/lib/types/navigation/internalApplicationLinks.d.ts

@@ -0,0 +1,20 @@
+export declare enum InternalApplicationLinks {
+    Ayelix = "/ayelix",
+    Events = "/events",
+    OfflineCamera = "/camera",
+    OnlineCamera = "/newcamera",
+    MyTasks = "/MyTasks",
+    Media = "/media",
+    MissionPlanner = "/missionplanner",
+    EchoHub = "/EchoHub",
+    RelatedTag = "/RelatedTag",
+    Tags = "/tags",
+    OfflineDocuments = "/OfflineDocuments",
+    Viewer = "/viewer",
+    Echo4Project = "/project",
+    XLD = "/xld",
+    SmartPortal = "/smartportal",
+    EchoMaps = "/maps",
+    Echo3dWeb = "/echo3d",
+    Turnaround = "/turnaround"
+}