@equinor/echo-framework 0.15.4-beta-0 → 0.15.4

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.15.4-beta-0",
+  "version": "0.15.4",
   "peerDependencies": {
-    "@equinor/echo-base": "0.7.0-beta-0",
+    "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.8.0 < 0.9.0",
-    "@equinor/echo-core": "0.9.0-beta-2",
-    "@equinor/echo-search": "0.15.0-beta-3",
+    "@equinor/echo-core": ">= 0.9.0 < 0.10.0",
+    "@equinor/echo-search": ">= 0.15.0 < 0.16.0",
     "@equinor/echo-utils": ">= 0.3.0 < 0.4.0",
     "@equinor/eds-core-react": "^0.25.0",
     "@equinor/eds-icons": "^0.17.0",

package/src/index.d.ts

@@ -4,6 +4,7 @@ import { getPlantsInfo, getTagDetails } from './lib/services/api';
 import './lib/theme/theme.css';
 import { getLegendStatusColor } from './lib/utils/legendUtils';
 export * from './lib/components';
+export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
 export * from './lib/coreApplication';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
@@ -15,7 +16,7 @@ export { DetailedDeviceInformationProvider, detailedDeviceInformationProvider }
 export { DeviceInformation, deviceInfo } from './lib/services/deviceInformation/deviceInfo';
 export * from './lib/services/eventHubActions';
 export * from './lib/services/searchItemDetails/searchItemDetails.store';
-export { SearchItemDetailsContainer } from './lib/services/searchItemDetails/searchItemDetailsContainer';
+export { SearchItemDetailsSideSheet } from './lib/services/searchItemDetails/searchItemDetailsSideSheet';
 export * from './lib/theme/themeConst';
 export * from './lib/types/api-echohub';
 export type { EchoHubPlant } from './lib/types/echoHubPlant';
@@ -60,6 +61,18 @@ declare const EchoFramework: Readonly<{
         } | undefined, state?: any) => void;
         useHas3dAccess(plantCode?: string | undefined): boolean;
         useIsFullScreenModeEnabled(): boolean;
+        useOpenPdfFile(): (args: {
+            instCode: string;
+            docNo: string;
+            fileId: string | number;
+            revNo: string;
+            tagNo?: string | undefined;
+        }) => void;
+        useOpenPdfFileUrl(): (args: {
+            instCode: string;
+            fileUrl: string;
+            tagNo?: string | undefined;
+        }) => void;
         usePlantAvailableIn3d(plantCode?: string | undefined): boolean;
         usePlantAvailableIn3dWeb(plantCode?: string | undefined): boolean;
         useScreenOrientation(): import("./lib/types/hookLibrary").ScreenOrientation;

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

@@ -2,9 +2,10 @@ import React from 'react';
 import { SideSheetOrientation } from '@equinor/echo-components';
 import { PrepviewEvents } from './context/PrepviewContext';
 interface PrepviewProps {
-    instCode: string;
     orientation: SideSheetOrientation;
+    instCode?: string;
     workOrderId?: string;
+    workOrderOperationId?: string;
     notificationId?: string;
     punchId?: string;
     closePanel: () => void;

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

@@ -1,7 +1,7 @@
 import { PrepviewNotificationDto, PrepviewWorkOrderDto, PunchDetails } from '../types';
 import * as workOrderApi from './attachment';
 export { workOrderApi };
-export declare function getWorkOrder(instCode: string, workOrderId: string): Promise<PrepviewWorkOrderDto>;
+export declare function getWorkOrder(workOrderId: string): Promise<PrepviewWorkOrderDto>;
 export declare function getNotification(instCode: string, notificationId: string): Promise<PrepviewNotificationDto>;
 export declare function getPunch(instCode: string, punchId: string): Promise<PunchDetails>;
 export declare function getWorkType(instCode: string, workOrderId: string): Promise<string[]>;

package/src/lib/components/prepview/api/resources.d.ts

@@ -1,4 +1,4 @@
-export declare function getWorkOrder(instCode: string, workOrderId: string): string;
+export declare function getWorkOrder(workOrderId: string): string;
 export declare function getNotification(instCode: string, notificationId: string): string;
 export declare function getPunch(instCode: string, punchId: string): string;
 export declare function getWorkTypeUrl(instCode: string, workOrderId: string): string;

package/src/lib/components/prepview/common/access/request/RequestAccess.d.ts

@@ -2,5 +2,5 @@ import React from 'react';
 type RequestAccessProps = {
     padding?: boolean;
 };
-declare const RequestAccess: React.FC<RequestAccessProps>;
-export { RequestAccess };
+export declare const RequestAccess: React.FC<RequestAccessProps>;
+export {};

package/src/lib/components/prepview/common/additionalInformation/AdditionalDetails.d.ts

@@ -5,5 +5,5 @@ interface Props {
     additionalDetails: AdditionalDetailsDto;
     closePanel: () => void;
 }
-declare function AdditionalDetails({ workOrderDetails, notificationDetails, additionalDetails, closePanel }: Props): import("react/jsx-runtime").JSX.Element;
+declare function AdditionalDetails({ workOrderDetails, notificationDetails, additionalDetails, closePanel, }: Props): import("react/jsx-runtime").JSX.Element;
 export { AdditionalDetails };

package/src/lib/components/prepview/common/additionalInformation/tabsPanels/TabsPanels.d.ts

@@ -6,7 +6,7 @@ interface Props {
     additionalDetails: AdditionalDetailsDto;
     closePanel: () => void;
 }
-declare function TabsPanels({ workOrderDetails, notificationDetails, additionalDetails, closePanel }: Props): import("react/jsx-runtime").JSX.Element | null;
+declare function TabsPanels({ workOrderDetails, notificationDetails, additionalDetails, closePanel, }: Props): import("react/jsx-runtime").JSX.Element | null;
 interface TabsListProps {
     tabListRef: React.RefObject<HTMLDivElement>;
 }

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

@@ -8,6 +8,7 @@ interface PrepviewContext {
     instCode: string;
     orientation: SideSheetOrientation;
     isWorkOrder: boolean;
+    workOrderOperationId?: string;
     events: PrepviewEvents;
 }
 export declare const PrepviewContext: React.Context<PrepviewContext>;

package/src/lib/components/prepview/panels/operations/Operations.d.ts

@@ -1,6 +1,7 @@
 import { PrepviewOperation } from '../../types';
 interface Props {
     operations: PrepviewOperation[];
+    workOrderId: string;
 }
-declare function OperationsPanel({ operations }: Props): import("react/jsx-runtime").JSX.Element;
+declare function OperationsPanel({ operations, workOrderId }: Props): import("react/jsx-runtime").JSX.Element;
 export { OperationsPanel };

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

@@ -38,6 +38,7 @@ export type WorkOrderDetails = FetchStatus & {
     system: string;
     priority: string;
     priorityId: string;
+    instCode: string;
     plantId: string;
 };
 export type WorkOrderAdditionalDetails = {

package/src/lib/components/requestAccess/RequestAccessButton.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+interface Props {
+    applyForAccessUrl: string;
+    buttonLabel?: string;
+    className?: string;
+    onClicked?: () => void;
+}
+export declare const RequestAccessButton: React.FC<React.PropsWithChildren<Props>>;
+export {};

package/src/lib/components/requestAccess/RequestSapAccess.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type RequestSapAccessProps = {
+    padding?: boolean;
+    onClicked?: () => void;
+};
+export declare const RequestSapAccess: React.FC<RequestSapAccessProps>;
+export {};

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

@@ -1,6 +1,7 @@
 export * from './useEchoHistory';
 export * from './useHas3dAccess';
 export * from './useIsFullScreenModeEnabled';
+export * from './useOpenPdfFile';
 export * from './usePlantAvailableIn3d';
 export * from './usePlantAvailableIn3dWeb';
 export * from './useScreenOrientation';

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

@@ -0,0 +1,12 @@
+export declare function useOpenPdfFile(): (args: {
+    instCode: string;
+    docNo: string;
+    fileId: string | number;
+    revNo: string;
+    tagNo?: string;
+}) => void;
+export declare function useOpenPdfFileUrl(): (args: {
+    instCode: string;
+    fileUrl: string;
+    tagNo?: string;
+}) => void;

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface PreviousProps {
+    title: string;
+    onClick: () => void;
+}
+export declare const Previous: React.FC<PreviousProps>;
+export {};

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

@@ -6,6 +6,7 @@ export type SearchItemDetailsObject = {
     content: ReactNode;
     header?: ReactNode;
     subHeader?: ReactNode;
+    itemId: string;
     isOpen: boolean;
 };
 export type SearchItemDetailsState = {
@@ -22,5 +23,6 @@ type ShowDetailsArgs = {
     header?: ReactNode;
     subHeader?: ReactNode;
     keepLastNavigationItem?: boolean;
+    itemId: string;
 };
 export {};

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

@@ -1,6 +1,7 @@
 import React from 'react';
+import { SearchItemDetailsObject } from './searchItemDetails.store';
 interface SearchItemDetailsContainerProps {
-    onSearchDetailsClose?: (panelKey: string) => void;
+    itemToDisplay: SearchItemDetailsObject;
 }
 export declare const SearchItemDetailsContainer: React.FC<SearchItemDetailsContainerProps>;
 export {};

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { SearchItemDetailsObject } from './searchItemDetails.store';
+interface SearchItemDetailsSideSheetProps {
+    itemToDisplay: SearchItemDetailsObject | undefined;
+}
+export declare const SearchItemDetailsSideSheet: React.FC<SearchItemDetailsSideSheetProps>;
+export {};

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

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

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

@@ -0,0 +1,5 @@
+export interface LeftPanelNavigationUpdateEvent {
+    previousTitle?: string;
+    onClick?: () => void;
+    resetNavigation?: boolean;
+}

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

@@ -1,3 +1,5 @@
 export * from './navigationUtils';
 export * from './plantInfo';
+export * from './previousUtils';
 export * from './searchUtil';
+export * from './stringUtils';

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

@@ -0,0 +1,21 @@
+import { Panel } from '@equinor/echo-core';
+import { SearchItemDetailsObject } from '../services/searchItemDetails/searchItemDetails.store';
+/**
+ * Get the previous search item id or the previous active panel label
+ *
+ * @export
+ * @param {Record<string, SearchItemDetailsObject[]>} openedSearchItemsByPanel Opened search items by panel
+ * @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;
+/**
+ * Get the active panel label
+ *
+ * @export
+ * @param {Panel[]} modulePanels Module panels
+ * @param {string} activePanelKey The active panel key
+ * @return {*}  {string} Returns the active panel label
+ */
+export declare function getPanelTitle(modulePanels: Panel[], activePanelKey: string): string;

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

@@ -0,0 +1 @@
+export declare function removeLeadingZeros(inputString: string): string;