@equinor/echo-framework 0.17.1 → 0.17.3

package/package.json

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

package/src/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { getEquipmentInfoFromApi } from './lib/feature/equipment/api/api-equipmentInfo';
+import { getEquipmentWithMeasuringPointsFromApi } from './lib/feature/equipment/api/api-equipmentWithMeasuringPoints';
 import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
@@ -7,7 +7,6 @@ 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';
@@ -29,6 +28,7 @@ export * from './lib/types/extensions';
 export type { SetActiveTagNo, TagData } from './lib/types/hookLibrary';
 export type { ModelPermissions } from './lib/types/modelPermissions';
 export { PingableSources } from './lib/types/pingableSources';
+export { searchItemDetailsType } from './lib/types/searchItemDetailsType';
 export * from './lib/utils';
 export * from './lib/utils/startup';
 export declare const registerEchopediaComponent: ({ name, component }: {
@@ -82,6 +82,7 @@ declare const EchoFramework: Readonly<{
             isScreenMobileSize: boolean;
             screenOrientation: import("./lib/types/hookLibrary").ScreenOrientation;
         };
+        useTabTitle(): void;
         useTagDetails({ instCode, tagNo }: {
             tagNo: string;
             instCode: string;
@@ -120,7 +121,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;
+        getEquipmentWithMeasuringPointsFromApi: typeof getEquipmentWithMeasuringPointsFromApi;
     }>;
 }>;
 export default EchoFramework;

package/src/lib/components/prepview/Prepview.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { SideSheetOrientation } from '@equinor/echo-components';
+import { ColorMap, SideSheetOrientation } from '@equinor/echo-components';
 import { PrepviewEvents } from './context/PrepviewContext';
 interface PrepviewProps {
     orientation: SideSheetOrientation;
@@ -11,6 +11,7 @@ interface PrepviewProps {
     closePanel: () => void;
     headerAction?: React.ReactNode;
     events?: PrepviewEvents;
+    colorMap?: ColorMap;
 }
 declare function Prepview(props: PrepviewProps): JSX.Element | null;
 export { MaintenanceApiNameForWorkOrders, WorkItemType } from './utils';

package/src/lib/components/prepview/context/PrepviewContext.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SideSheetOrientation } from '@equinor/echo-components';
+import { ColorMap, SideSheetOrientation } from '@equinor/echo-components';
 import { WorkItemType } from '../utils';
 export interface PrepviewEvents {
     onClickHistoricItem?: (instCode: string, id: string, type: WorkItemType) => void;
@@ -10,6 +10,7 @@ interface PrepviewContext {
     isWorkOrder: boolean;
     workOrderOperationId?: string;
     events: PrepviewEvents;
+    colorMap?: ColorMap;
 }
 export declare const PrepviewContext: React.Context<PrepviewContext>;
 export declare const usePrepviewContext: () => PrepviewContext;

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

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

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

@@ -1,7 +1,7 @@
 import React from 'react';
-import { EquipmentInfo } from '../types/equipmentInfo';
+import { Equipment } from '../types/equipment';
 interface EquipmentItemProps {
-    equipment: EquipmentInfo;
+    equipment: Equipment;
     tagNo: string;
     plantNo: string;
 }

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

@@ -1,3 +1,10 @@
 import * as React from 'react';
-import { EquipmentAccordionContentProps } from '../equipmentTabs/equipmentTabs';
+import { EquipmentWithMeasuringPoints } from '../../types/equipmentWithMeasuringPoints';
+interface EquipmentAccordionContentProps {
+    equipmentWithMeasuringPoints: EquipmentWithMeasuringPoints[];
+    tagNo: string;
+    plantNo: string;
+    showAdditionalInfo?: boolean;
+}
 export declare const EquipmentItemDetails: React.FC<EquipmentAccordionContentProps>;
+export {};

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

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

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 export interface EquipmentAccordionContentProps {
-    equipmentNo: string;
+    equipmentId: string;
     tagNo: string;
     plantNo: string;
     showAdditionalInfo?: boolean;

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

@@ -0,0 +1,4 @@
+export declare function useEquipmentWithMeasuringPoints(equipmentId: string): {
+    status: "error" | "success" | "pending";
+    equipmentWithMeasuringPoints: import("..").EquipmentWithMeasuringPoints[];
+};

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

@@ -3,7 +3,7 @@
  * @returns {function}
  */
 export declare function useOpenEquipmentDetails(): (args: {
-    equipmentNo: string;
+    equipmentId: string;
     tagNo: string;
     plantNo: string;
     panelKey?: string | undefined;

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

@@ -1,3 +1,5 @@
-export { useOpenEquipmentDetails } from './hooks/useOpenEquipmentDetails';
 export { getEquipmentWithMeasuringPointsFromApi } from './api/api-equipmentWithMeasuringPoints';
 export { EquipmentInfoItem, EquipmentItemDetails, EquipmentItemHeader, EquipmentTabs } from './components';
+export { useOpenEquipmentDetails } from './hooks/useOpenEquipmentDetails';
+export type { Equipment } from './types/equipment';
+export type { EquipmentWithMeasuringPoints } from './types/equipmentWithMeasuringPoints';

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

@@ -0,0 +1,23 @@
+export interface Equipment {
+    readonly equipmentId: string;
+    readonly equipmentDescription: string;
+    readonly maintenancePlantId: string;
+    readonly functionalLocationId: string;
+    readonly manufacturer: string;
+    readonly materialNo: string;
+    readonly modelNo: string;
+    readonly partNo: string;
+    readonly serialNo: 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 e3DRef?: string;
+}

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

@@ -1,19 +1,6 @@
 import { MeasuringPointDto } from '../../measuringPoint/types/measuringPoint';
+import { Equipment } from './equipment';
 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 equipment: Equipment;
     readonly measuringPoints: MeasuringPointDto[];
 }

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

@@ -6,4 +6,5 @@ export * from './usePlantAvailableIn3d';
 export * from './usePlantAvailableIn3dWeb';
 export * from './useScreenOrientation';
 export * from './useScreenValues';
+export * from './useTabTitle';
 export * from './useTagDetails';

package/src/lib/hooks/useTabTitle.d.ts

@@ -0,0 +1 @@
+export declare function useTabTitle(): void;

package/src/lib/services/searchItemDetails/searchItemDetails.store.d.ts

@@ -1,4 +1,5 @@
 import { ReactNode } from 'react';
+import { searchItemDetailsType } from '../../types/searchItemDetailsType';
 export declare const useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<unknown>, "setState"> & {
     setState(nextStateOrUpdater: unknown, shouldReplace?: boolean | undefined): void;
 }>;
@@ -7,6 +8,7 @@ export type SearchItemDetailsObject = {
     header?: ReactNode;
     subHeader?: ReactNode;
     itemId: string;
+    itemType: searchItemDetailsType;
     isOpen: boolean;
 };
 export type SearchItemDetailsState = {
@@ -24,5 +26,6 @@ type ShowDetailsArgs = {
     subHeader?: ReactNode;
     keepLastNavigationItem?: boolean;
     itemId: string;
+    itemType: searchItemDetailsType;
 };
 export {};

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

@@ -0,0 +1,12 @@
+export declare enum searchItemDetailsType {
+    Tag = "Tag",
+    Document = "Document",
+    Punch = "Punch",
+    Checklist = "Checklist",
+    CommPk = "CommPk",
+    McPk = "McPk",
+    Notification = "Notification",
+    WorkOrder = "WorkOrder",
+    MeasuringPoint = "MeasuringPoint",
+    Equipment = "Equipment"
+}

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

@@ -0,0 +1,2 @@
+export declare const showModuleName: (moduleName: string, moduleNameToReadableString: string) => string | undefined;
+export declare const convertPathNameToReadableString: (pathName: string) => string;

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

@@ -4,12 +4,12 @@ import { SearchItemDetailsObject } from '../services/searchItemDetails/searchIte
  * Get the previous search item id or the previous active panel label
  *
  * @export
- * @param {Record<string, SearchItemDetailsObject[]>} openedSearchItemsByPanel Opened search items by panel
+ * @param {SearchItemDetailsObject[]} openedSearchItems Opened search items
  * @param {Panel[]} modulePanels  Module panels
  * @param {string} activePanelKey The active panel key
  * @return {*}  {string} Returns the previous search item id or active panel label
  */
-export declare function getPreviousItemIdOrPanelTitle(openedSearchItemsByPanel: Record<string, SearchItemDetailsObject[]>, modulePanels: Panel[], activePanelKey: string): string;
+export declare function getPreviousItemIdOrPanelTitle(openedSearchItems: SearchItemDetailsObject[], modulePanels: Panel[], activePanelKey: string): string;
 /**
  * Get the active panel label
  *

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

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

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

@@ -1,18 +0,0 @@
-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;
-    };
-}