@equinor/echo-framework 0.18.0 → 0.18.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.18.0",
+  "version": "0.18.1",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",
@@ -11,13 +11,13 @@
     "@equinor/eds-icons": "0.19.3",
     "react": ">= 17.0.2",
     "react-dom": ">= 17.0.2",
-    "@tanstack/react-query": "5.8.1",
+    "@tanstack/react-query": ">= 5.14.2 < 6",
     "@microsoft/signalr": "7.0.12",
     "classnames": "2.3.2",
     "history": "5.3.0",
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
-    "zustand": "4.4.6"
+    "zustand": ">= 4.4.7 < 5"
   },
   "main": "./index.cjs.js",
   "type": "commonjs"

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

@@ -8,8 +8,13 @@ export * from './errorBoundary';
 export * from './externalLinkButton/externalLinkButton';
 export * from './footer';
 export * from './fullScreenButtons';
+export * from './labelledValueGrid';
 export * from './lazyLoading';
+export { ListItem } from './listItem/listItem';
 export * from './mediator';
+export { OpenIn3dWarningDialog } from './openIn3d/OpenIn3dWarningDialog';
+export { PlantNoSelectionDialog } from './openIn3d/PlantNoSelectionDialog';
+export { SelectedItemsMenu } from './openIn3d/SelectedItemsMenu';
 export * from './pageMenu';
 export * from './panel';
 export * from './panelButton';
@@ -19,8 +24,6 @@ export * from './projectSelector';
 export * from './realTimeData';
 export * from './router';
 export * from './searchMenu';
+export * from './spinner/spinner';
 export * from './tagNumber';
 export * from './toaster';
-export * from './labelledValueGrid';
-export * from './spinner/spinner';
-export { ListItem } from './listItem/listItem';

package/src/lib/components/openIn3d/OpenIn3dWarningDialog.d.ts

@@ -0,0 +1,7 @@
+import React, { Dispatch, SetStateAction } from 'react';
+interface OpenIn3dWarningDialogProps {
+    open: boolean;
+    setIsOpenIn3dWarningDialogOpen: Dispatch<SetStateAction<boolean>>;
+}
+export declare const OpenIn3dWarningDialog: React.FC<OpenIn3dWarningDialogProps>;
+export {};

package/src/lib/components/openIn3d/PlantNoSelectionDialog.d.ts

@@ -0,0 +1,13 @@
+import React, { Dispatch, SetStateAction } from 'react';
+interface PlantNoSelectionDialogProps {
+    onOKButtonClicked: () => void;
+    open: boolean;
+    uniquePlantNos: string[];
+    selectedPlantNo: string | undefined;
+    setSelectedPlantNo: Dispatch<SetStateAction<string | undefined>>;
+    isSelectPlantNoDialogOpen: boolean;
+    setIsSelectPlantNoDialogOpen: Dispatch<SetStateAction<boolean>>;
+    tagNoCounts: Record<string, number>;
+}
+export declare const PlantNoSelectionDialog: React.FC<PlantNoSelectionDialogProps>;
+export {};

package/src/lib/components/openIn3d/SelectedItemsMenu.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ObjectsToSendTo3dTypes } from '../../utils';
+interface SelectedItemsProps {
+    numberOfSelectedRows: number;
+    onOpenIn3dButtonClick: (ObjectsToSendTo3d: ObjectsToSendTo3dTypes) => void;
+}
+export declare const SelectedItemsMenu: React.FC<SelectedItemsProps>;
+export {};

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

@@ -0,0 +1,4 @@
+export { OpenIn3dWarningDialog } from './OpenIn3dWarningDialog';
+export { PlantNoSelectionDialog } from './PlantNoSelectionDialog';
+export { SelectedItemsMenu } from './SelectedItemsMenu';
+export { OpenIn3dMenu } from './openIn3dMenu';

package/src/lib/components/openIn3d/openIn3dMenu.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ObjectsToSendTo3dTypes } from '../../utils/openIn3d/tagLists';
+interface OpenIn3dMenuProps {
+    onOpenIn3dButtonClick: (objectsToSendTo3d: ObjectsToSendTo3dTypes) => void;
+}
+export declare const OpenIn3dMenu: React.FC<OpenIn3dMenuProps>;
+export {};

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

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

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

@@ -0,0 +1,8 @@
+import { Equipment } from '../../types/equipment';
+interface ShowEquipmentIn3DButtonArgs {
+    equipment: Equipment;
+    tagNo: string;
+    plantNo: string;
+}
+export declare const ShowEquipmentIn3DButton: ({ equipment, tagNo, plantNo }: ShowEquipmentIn3DButtonArgs) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -21,3 +21,7 @@ export interface Equipment {
     readonly createdDate?: string;
     readonly e3DRef?: string;
 }
+export declare enum EquipmentCategoryId {
+    L = "L",
+    M = "M"
+}

package/src/lib/feature/equipment/utils/equipmentUtils.d.ts

@@ -0,0 +1,19 @@
+import { Link } from '@equinor/echo-core';
+import { Equipment } from '../types/equipment';
+import { EquipmentWithMeasuringPoints } from '../types/equipmentWithMeasuringPoints';
+interface OpenMeasuringPointsArgs {
+    equipmentId: string;
+    e3dRef: string;
+    goToLink: Link;
+    pathname: string;
+    instCode: string;
+    tagNo: string;
+    plantNo: string;
+}
+export declare const openEquipmentIn3dWeb: ({ equipmentId, e3dRef, goToLink, pathname, instCode, tagNo, plantNo }: OpenMeasuringPointsArgs) => Promise<void>;
+export declare const is3DEquipment: (equipment: Equipment) => boolean;
+export declare const sortMeasurementsInEquipmentWithMeasuringPointsByNewestFirst: (equipmentWithMeasuringPoints: EquipmentWithMeasuringPoints[]) => {
+    equipment: Equipment;
+    measuringPoints: import("../../measuringPoint").MeasuringPointDto[];
+}[];
+export {};

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

@@ -1,7 +1,7 @@
 export type LegendItemStatus = LegendStatus | string;
 export declare enum LegendStatus {
     Unknown = "Unknown",
-    Multiple = "Multiple",
+    Multiple = "Multiple",//if status contains plus, eg: PM01+PM02
     ApiError = "Api Error: Failed to get data for legend",
     AsBuilt = "AsBuilt",
     Planned = "Planned",

package/src/lib/types/hookLibrary.d.ts

@@ -5,7 +5,9 @@ export type SetActiveTagNo = (argsORtagNo: string | {
     instCode?: string;
     activePanelKey?: string;
     keepLastNavigationItem?: boolean;
-}, activeTagTab?: string, activeTagSubTab?: string, instCode?: string) => void;
+    openInPanel?: boolean;
+    displayMessageOnItemNotFound?: boolean;
+}, activeTagTab?: string, activeTagSubTab?: string, instCode?: string, openInPanel?: boolean, displayMessageOnItemNotFound?: boolean) => void;
 export type TagData = [(tagNo: string, instCode: string) => void];
 export type SetActiveCommPackNo = (argsORcommPackNo: string | {
     commPackNo: string;

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

@@ -1,6 +1,7 @@
+export * from './formatTimeHelpers';
 export * from './navigationUtils';
+export * from './openIn3d';
 export * from './plantInfo';
 export * from './previousUtils';
 export * from './searchUtil';
 export * from './stringUtils';
-export * from './formatTimeHelpers';

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

@@ -0,0 +1,2 @@
+export { ObjectsToSendTo3dTypes, generateTemporaryTagListObject, getRandomColor, getTemporarilyEchoHubListFor3d } from './tagLists';
+export type { HubListReturnType } from './tagLists';

package/src/lib/utils/openIn3d/tagLists.d.ts

@@ -0,0 +1,28 @@
+import { TemporaryEchoHubListDto, TemporaryHubResultsList } from '../../types/api-echohub';
+import { EchoHubPlant } from '../../types/echoHubPlant';
+export declare const getTemporarilyEchoHubListFor3d: (instCode: string, request: TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined, withoutBaseUrl?: boolean | undefined) => Promise<{
+    app3dUrl: string;
+    web3dUrl: string;
+}>;
+export declare enum ObjectsToSendTo3dTypes {
+    workOrders = "workOrders",
+    tags = "tags"
+}
+export type HubListReturnType = {
+    app3dUrl: string;
+    web3dUrl: string;
+};
+/**
+ * Function for generating a temporary tag list object, used to open tags in Echo3D
+ * @export
+ * @param {string} sourceModuleName name of the source module name
+ * @param {string} createdBy created by (e.g: user email)
+ * @param {EchoHubPlant} plant plant
+ * @param {TemporaryHubResultsList[]} tagList tag list
+ * @param {string} source source (e.g: Echo)
+ * @param {number} timeToLiveSeconds time to live (in seconds) for the temporary list
+
+ * @return {*} {TemporaryEchoHubListDto} temporary tag list object
+ */
+export declare const generateTemporaryTagListObject: (ObjectsToSendTo3d: ObjectsToSendTo3dTypes, sourceModuleName: string, createdBy: string, plant: EchoHubPlant, tagList: TemporaryHubResultsList[], source: string, section?: string | undefined, timeToLiveSeconds?: number) => TemporaryEchoHubListDto;
+export declare function getRandomColor(): string;

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

@@ -13,7 +13,10 @@ export declare function getEcho3DAppUrlForTag(tagDetails: TagDetailsDto | undefi
  * @param {TagDetailsDto} tagDetails
  * @returns {*} {string}
  */
-export declare function getPlantCodeForTag(tagDetails: TagDetailsDto): Promise<string>;
+export declare function getPlantCodeForTag(args: {
+    plantNo: string;
+    instCode: string;
+}): Promise<string>;
 /**
  * Function for getting plant project description based on Tag Details
  * Returns the plant project description if found, otherwise, return empty string.