@equinor/echo-framework 0.18.11 → 0.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.18.11",
+  "version": "0.19.0",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
     "@equinor/echo-components": ">= 0.11.0 < 0.12.0",
@@ -17,7 +17,8 @@
     "history": "5.3.0",
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
-    "zustand": ">= 4.4.7 < 5"
+    "zustand": ">= 4.4.7 < 5",
+    "react-swipeable": "7.0.1"
   },
   "main": "./index.cjs.js",
   "type": "commonjs"

package/src/index.d.ts

@@ -22,8 +22,7 @@ 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';
-export { SearchItemDetailsSideSheet } from './lib/services/searchItemDetails/searchItemDetailsSideSheet';
+export * from './lib/services/leftPanelNavigation';
 export * from './lib/theme/themeConst';
 export * from './lib/types/api-echohub';
 export type { EchoHubPlant } from './lib/types/echoHubPlant';
@@ -34,7 +33,7 @@ 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 { SearchItemDetailsType as searchItemDetailsType } from './lib/types/searchItemDetailsType';
 export * from './lib/utils';
 export { convertPathNameToReadableString } from './lib/utils/moduleNameUtils';
 export * from './lib/utils/startup';
@@ -60,11 +59,6 @@ declare const EchoFramework: Readonly<{
         }>;
     }>;
     Hooks: Readonly<{
-        searchItems: Readonly<{
-            useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<unknown>, "setState"> & {
-                setState(nextStateOrUpdater: unknown, shouldReplace?: boolean | undefined): void;
-            }>;
-        }>;
         useEchoHistory(): (path: string, params?: {
             [key: string]: string;
         } | undefined, state?: any) => void;

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

@@ -20,7 +20,7 @@ export * from './panel';
 export * from './panelButton';
 export * from './plantSelector';
 export * from './prepview';
-export * from './prepviewButton';
+export * from './prepviewButton/prepviewButton';
 export * from './projectSelector';
 export * from './realTimeData';
 export * from './router';

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SearchItemDetailsObject } from '../../services/searchItemDetails/searchItemDetails.store';
+import { LeftPanelNavigationContent } from '../../services/leftPanelNavigation/leftPanelNavigation.store.types';
 /**
  * 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.
@@ -10,5 +10,5 @@ import { SearchItemDetailsObject } from '../../services/searchItemDetails/search
  */
 export declare const useLeftPanelNavigation: () => {
     previousButton: React.ReactNode;
-    activeSearchItem: SearchItemDetailsObject | undefined;
+    activeSearchItem: LeftPanelNavigationContent | undefined;
 };

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import { ColorMap, SideSheetOrientation, WorkOrderDateType } from '@equinor/echo-components';
-import { WorkItemType } from './utils';
 import { HistoricNotificationItem, HistoricPunchItem, HistoricWorkOrderItem, ItemTypes } from './types';
+import { WorkItemType } from './utils';
 interface PrepviewProps {
     orientation: SideSheetOrientation;
     instCode?: string;
@@ -17,6 +17,6 @@ interface PrepviewProps {
     workOrderDateType?: WorkOrderDateType;
 }
 declare function Prepview(props: PrepviewProps): JSX.Element | null;
-export { MaintenanceApiNameForWorkOrders, WorkItemType } from './utils';
 export * from './types/shared';
+export { MaintenanceApiNameForWorkOrders, WorkItemType } from './utils';
 export { Prepview };

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

@@ -3,5 +3,6 @@ export interface PrepviewButtonProps {
     workOrderId?: string | undefined;
     notificationId?: string | undefined;
     punchId?: string | undefined;
+    instCode?: string | undefined;
 }
 export declare const PrepviewButton: React.FC<PrepviewButtonProps>;

package/src/lib/feature/measuringPoint/components/measuringPointDetails/api/api-documentRelationships.d.ts

@@ -0,0 +1,4 @@
+import { DocumentRelationships } from '../../../types/documentRelationships';
+export declare function getDocumentRelationshipsFromApi(args: {
+    measuringPointId: string;
+}): Promise<DocumentRelationships[]>;

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

@@ -0,0 +1,10 @@
+import { DocumentRelationships } from '../../types/documentRelationships';
+interface LabelledImageListProps {
+    documentId: string;
+    createdDateTime: string;
+    imageSrc: string;
+    documentRelationships: DocumentRelationships[];
+    imageIndex: number;
+}
+export declare const LabelledImageList: ({ documentId, createdDateTime, imageSrc, documentRelationships, imageIndex }: LabelledImageListProps) => import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,5 @@
+interface MeasuringPointImageListProps {
+    measuringPointId: string;
+}
+export declare const MeasuringPointImageList: ({ measuringPointId }: MeasuringPointImageListProps) => import("react/jsx-runtime").JSX.Element | import("react/jsx-runtime").JSX.Element[];
+export {};

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

@@ -0,0 +1,15 @@
+import React from 'react';
+interface MeasuringPointImageViewProps {
+    title: string;
+    date: string;
+    triggerScrim: () => void;
+    showPrevious: () => void;
+    showNext: () => void;
+    showPrevIcon: boolean;
+    showNextIcon: boolean;
+    imageSrc: string;
+    description?: string;
+    open: boolean;
+}
+export declare const MeasuringPointImageView: React.FC<React.PropsWithChildren<MeasuringPointImageViewProps>>;
+export {};

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

@@ -0,0 +1,7 @@
+import React from 'react';
+interface MeasuringPointImageViewFooterProps {
+    date: string;
+    description?: string;
+}
+export declare const MeasuringPointImageViewFooter: React.FC<MeasuringPointImageViewFooterProps>;
+export {};

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

@@ -0,0 +1,10 @@
+import React from 'react';
+interface MeasuringPointImageViewMediaProps {
+    imageSrc: string;
+    showPrevious: () => void;
+    showNext: () => void;
+    showNextIcon: boolean;
+    showPrevIcon: boolean;
+}
+export declare const MeasuringPointImageViewMedia: React.FC<React.PropsWithChildren<MeasuringPointImageViewMediaProps>>;
+export {};

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

@@ -7,7 +7,7 @@ interface MeasuringPointItemProps {
 }
 /**
  * Component for displaying measuring point item.
- * Displays information about the condition of the measuring point, as well as the last recorded measurement.
+ * Displays information about the condition of the measuring point, as well as the last reported measurement.
  * @param {MeasuringPointItemProps}
  * @returns {*}
  */

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

@@ -0,0 +1,6 @@
+export declare function useDocumentRelationships(measuringPointId: string): {
+    status: "error" | "success" | "pending";
+    documentRelationships: import("../types/documentRelationships").DocumentRelationships[];
+    error: Error | null;
+    totalAttachments: string;
+};

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

@@ -0,0 +1,18 @@
+export interface DocumentRelationships {
+    readonly documentId: string;
+    readonly characteristics?: DocumentRelationshipsCharacteristics[];
+    readonly attachments?: DocumentRelationshipsAttachment[];
+}
+interface DocumentRelationshipsAttachment {
+    readonly attachmentId: string;
+    readonly attachmentImageUri?: string;
+    readonly createdDateTime?: string;
+    readonly _links?: DocumentRelationshipsLinks;
+}
+interface DocumentRelationshipsCharacteristics {
+    readonly valueId?: string;
+}
+interface DocumentRelationshipsLinks {
+    readonly enclosure?: string;
+}
+export {};

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

@@ -0,0 +1,2 @@
+export { getLeftPanelNavigationState } from './leftPanelNavigation.store';
+export * from './leftPanelNavigation.store.types';

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

@@ -0,0 +1,13 @@
+import { LeftPanelNavigationStore } from './leftPanelNavigation.store.types';
+export declare const useLeftPanelNavigationStore: import("zustand").UseBoundStore<Omit<Omit<import("zustand").StoreApi<unknown>, "subscribe"> & {
+    subscribe: {
+        (listener: (selectedState: unknown, previousSelectedState: unknown) => void): () => void;
+        <U>(selector: (state: unknown) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+            equalityFn?: ((a: U, b: U) => boolean) | undefined;
+            fireImmediately?: boolean | undefined;
+        } | undefined): () => void;
+    };
+}, "setState"> & {
+    setState(nextStateOrUpdater: unknown, shouldReplace?: boolean | undefined): void;
+}>;
+export declare function getLeftPanelNavigationState(): LeftPanelNavigationStore;

package/src/lib/services/leftPanelNavigation/leftPanelNavigation.store.types.d.ts

@@ -0,0 +1,21 @@
+import { ReactNode } from 'react';
+export type LeftPanelNavigationContent = {
+    content: ReactNode;
+    header?: ReactNode;
+    subHeader?: ReactNode;
+    itemId?: string;
+    isOpen: boolean;
+};
+export interface LeftPanelNavigationStore {
+    addContent: (args: {
+        panelKey: string;
+        content: ReactNode;
+        header?: ReactNode;
+        subHeader?: ReactNode;
+        keepLastNavigationItem?: boolean;
+        itemId?: string;
+    }) => void;
+    removeLastContentByPanelKey: (panelKey: string) => void;
+    clearItemsByPanelKey: (panelKey: string) => void;
+    items: Record<string, LeftPanelNavigationContent[]>;
+}

package/src/lib/services/leftPanelNavigation/leftPanelNavigationContainer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { LeftPanelNavigationContent } from './leftPanelNavigation.store.types';
+interface LeftPanelNavigationItemContainerProps {
+    itemToDisplay: LeftPanelNavigationContent;
+}
+export declare const LeftPanelNavigationItemContainer: React.FC<LeftPanelNavigationItemContainerProps>;
+export {};

package/src/lib/services/leftPanelNavigation/leftPanelNavigationSideSheet.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { LeftPanelNavigationContent } from './leftPanelNavigation.store.types';
+interface LeftPanelNavigationSideSheetProps {
+    itemToDisplay: LeftPanelNavigationContent | undefined;
+}
+export declare const LeftPanelNavigationSideSheet: React.FC<LeftPanelNavigationSideSheetProps>;
+export {};

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

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

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

@@ -2,4 +2,5 @@ export interface PrepviewEvent {
     notificationId?: string;
     workOrderId?: string;
     punchId?: string;
+    instCode?: string;
 }

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

@@ -1,4 +1,4 @@
-export declare enum searchItemDetailsType {
+export declare enum SearchItemDetailsType {
     Tag = "Tag",
     Document = "Document",
     Punch = "Punch",

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

@@ -1,15 +1,15 @@
 import { Panel } from '@equinor/echo-core';
-import { SearchItemDetailsObject } from '../services/searchItemDetails/searchItemDetails.store';
+import { LeftPanelNavigationContent } from '../services/leftPanelNavigation';
 /**
  * Get the previous search item id or the previous active panel label
  *
  * @export
- * @param {SearchItemDetailsObject[]} openedSearchItems Opened search items
+ * @param {LeftPanelNavigationContent[]} 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(openedSearchItems: SearchItemDetailsObject[], modulePanels: Panel[], activePanelKey: string): string;
+export declare function getPreviousItemIdOrPanelTitle(openedSearchItems: LeftPanelNavigationContent[], modulePanels: Panel[], activePanelKey: string): string;
 /**
  * Get the active panel label
  *

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

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

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

@@ -1,31 +0,0 @@
-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;
-}>;
-export type SearchItemDetailsObject = {
-    content: ReactNode;
-    header?: ReactNode;
-    subHeader?: ReactNode;
-    itemId: string;
-    itemType: searchItemDetailsType;
-    isOpen: boolean;
-};
-export type SearchItemDetailsState = {
-    actions: {
-        showDetails: (args: ShowDetailsArgs) => void;
-        hideDetails: (panelKey: string) => void;
-        clearItemsByPanelKey: (panelKey: string) => void;
-    };
-    items: Record<string, SearchItemDetailsObject[]>;
-};
-type ShowDetailsArgs = {
-    panelKey: string;
-    content: ReactNode;
-    header?: ReactNode;
-    subHeader?: ReactNode;
-    keepLastNavigationItem?: boolean;
-    itemId: string;
-    itemType: searchItemDetailsType;
-};
-export {};

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

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

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

@@ -1,7 +0,0 @@
-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/leftPanelNavigationUpdateEvent.d.ts

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