@equinor/echo-framework 0.20.10 → 0.20.11

package/package.json

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

package/src/index.d.ts

@@ -8,6 +8,7 @@ export { RequestProCoSysAccess } from './lib/components/requestAccess/RequestPro
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
 export { WorkOrderListItem } from './lib/components/workOrderListItem';
 export * from './lib/coreApplication';
+export { fetchEquipmentFromApi } from './lib/feature/equipment/api/api-equipmentWithMeasuringPoints';
 export * from './lib/feature/equipment/index';
 export * from './lib/feature/globalSelection';
 export type { GlobalSelectionItem, OptimizedWorkOrderDto } from './lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types';

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

@@ -1,5 +1,4 @@
 export * from '../../verticalTabsSplitView';
-export * from './access';
 export * from './details';
 export * from './error';
 export * from './fileSizeDisplay';

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

@@ -1,2 +1 @@
 export * from './InfoSection';
-export * from './longText';

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

@@ -1,3 +1,2 @@
 export * from './useFetch';
 export * from './useOnClickDownload';
-export * from './useIsMobile';

package/src/lib/components/prepview/utils/documents.d.ts

@@ -1,2 +1 @@
-export declare function setFileIcon(fileExtension: string | undefined): string;
 export declare function getExtension(filename: string): string | undefined;

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

@@ -1,10 +1,8 @@
 export * from './date';
 export * from './documents';
-export * from './dom';
 export * from './enums';
 export * from './logger';
 export * from './object';
 export * from './string';
 export * from './url';
 export * from './workorder';
-export * from './notification';

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

@@ -1,5 +1,10 @@
 import { EquipmentWithMeasuringPoints } from '../types/equipmentWithMeasuringPoints';
-export declare function getEquipmentFromApi({ equipmentId, includeMeasuringPoints }: {
+interface EquipmentRequest {
     equipmentId: string;
     includeMeasuringPoints?: boolean;
-}): Promise<EquipmentWithMeasuringPoints[]>;
+}
+interface EquipmentsRequest {
+    equipmentIds: ReadonlyArray<string>;
+}
+export declare function fetchEquipmentFromApi(args: EquipmentRequest | EquipmentsRequest): Promise<EquipmentWithMeasuringPoints[]>;
+export {};

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

@@ -0,0 +1,9 @@
+import React from 'react';
+interface EquipmentLinkFieldProps {
+    equipmentId: string;
+    tagNo: string;
+    plantNo: string;
+}
+export declare const EquipmentLinkField: React.FC<EquipmentLinkFieldProps>;
+export declare function getEquipmentLinkField(equipmentId: string, tagNo: string, plantNo: string): JSX.Element;
+export {};

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

@@ -1,4 +1,5 @@
 export { EquipmentItemHeader } from './equipmentItemHeader/equipmentItemHeader';
 export { EquipmentItemInfo } from './equipmentItemInfo/equipmentItemInfo';
+export { EquipmentLinkField, getEquipmentLinkField } from './equipmentLinkField/equipmentLinkField';
 export { EquipmentListItem } from './equipmentListItem';
 export { EquipmentTabs } from './equipmentTabs/equipmentTabs';

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

@@ -1,4 +1,4 @@
-export { EquipmentItemHeader, EquipmentItemInfo, EquipmentListItem, EquipmentTabs } from './components';
+export { EquipmentItemHeader, EquipmentItemInfo, EquipmentLinkField, EquipmentListItem, EquipmentTabs, getEquipmentLinkField } from './components';
 export { useOpenEquipmentDetails } from './hooks/useOpenEquipmentDetails';
 export type { Equipment } from './types/equipment';
 export type { EquipmentWithMeasuringPoints } from './types/equipmentWithMeasuringPoints';

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.types.d.ts

@@ -24,7 +24,7 @@ export type GlobalSelectionGenericItem<T extends GlobalSelectionItemType> = {
     metaData: {
         color: string;
         isHiddenByUser: boolean;
-        errorStatuses: GlobalSelectionItemErrorStatuses[];
+        errorStatus?: string;
     };
 };
 export type EquipmentGlobalSelectionListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
@@ -35,9 +35,9 @@ type EquipmentGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.
 export type WorkOrderGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.WorkOrder>;
 export type TagGlobalSelectionList = GlobalSelectionList<GlobalSelectionItemType.Tag>;
 export type GlobalSelectionListUnion = WorkOrderGlobalSelectionList | TagGlobalSelectionList | EquipmentGlobalSelectionList;
-export declare enum GlobalSelectionItemErrorStatuses {
-    NotFoundInActiveEchoModule = "NotFoundInActiveEchoModule",
-    NotShownInActiveEchoModule = "NotShownInActiveEchoModule"
+export interface ItemErrorStatusUpdates {
+    itemId: string;
+    errorStatus: string;
 }
 export interface GlobalSelectionStore {
     lists: GlobalSelectionListUnion[];
@@ -61,14 +61,19 @@ export interface GlobalSelectionStore {
         itemId: string;
         isVisible: boolean;
     }) => void;
+    /**
+     *@deprecated This method is deprecated. Use `removeErrorStatusForItems` instead.
+     */
     resetItemNotFoundStates: () => void;
     resetState: () => void;
-    setStatusForItems: (args: {
+    setErrorStatusForItems: (args: {
+        itemErrorStatuses: ItemErrorStatusUpdates[];
+    }) => void;
+    removeErrorStatusForItems: (args: {
         itemIds: string[];
-        status: GlobalSelectionItemErrorStatuses;
     }) => void;
     /**
-     *@deprecated This method is deprecated. Use `setStatusForItems` instead, with `GlobalSelectionItemErrorStatuses.NotFoundInActiveEchoModule`.
+     *@deprecated This method is deprecated. Use `setStatusForItems` instead.
      */
     setNotFoundItems: (args: {
         itemIds: string[];

package/src/lib/feature/globalSelection/globalSelectionStore/globalSelectionStore.utils.d.ts

@@ -1,7 +1,6 @@
 import { PlantAndTagForOpenIn3d } from '../../openItemsIn3d/logic/openItemsIn3d.utils';
-import { GlobalSelectionGenericItem, GlobalSelectionItemErrorStatuses, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionListUnion, GlobalSelectionStore } from './globalSelectionStore.types';
+import { GlobalSelectionGenericItem, GlobalSelectionItemType, GlobalSelectionItemTypeToDataMap, GlobalSelectionListUnion, GlobalSelectionStore } from './globalSelectionStore.types';
 export declare function toGlobalSelectionItem<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(item: T, type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>;
 export declare function toGlobalSelectionItems<T extends GlobalSelectionItemTypeToDataMap[K], K extends GlobalSelectionItemType>(items: T[], type: K, idSelector: (item: T) => string): GlobalSelectionGenericItem<K>[];
 export declare function findGlobalSelectionListByKey(state: GlobalSelectionStore, key: string): GlobalSelectionListUnion | undefined;
-export declare function hasGlobalSelectionItemErrorStatus<T extends GlobalSelectionItemType>(item: GlobalSelectionGenericItem<T>, status: GlobalSelectionItemErrorStatuses): boolean;
 export declare function convertGlobalSelectionItemsToPlantTagPairs(): Promise<PlantAndTagForOpenIn3d[]>;

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

@@ -1,8 +1,8 @@
+export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';
 export { getGlobalSelectionStoreState, useGlobalSelectionStore } from './globalSelectionStore/globalSelectionStore';
 export * from './globalSelectionStore/globalSelectionStore.types';
-export { convertGlobalSelectionItemsToPlantTagPairs, hasGlobalSelectionItemErrorStatus } from './globalSelectionStore/globalSelectionStore.utils';
+export { convertGlobalSelectionItemsToPlantTagPairs } from './globalSelectionStore/globalSelectionStore.utils';
 export { useGlobalSelectionItems } from './hooks/useGlobalSelectionItems';
 export { useGlobalSelectionLists } from './hooks/useGlobalSelectionLists';
 export { useGlobalSelectionTags } from './hooks/useGlobalSelectionTags';
 export { useGlobalSelectionWorkOrders } from './hooks/useGlobalSelectionWorkOrders';
-export { OpenGlobalSelectionIn3DButton } from './OpenGlobalSelectionIn3DButton';

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

@@ -7,7 +7,7 @@ interface DocumentRelationshipsAttachment {
     readonly attachmentId: string;
     readonly attachmentImageUri?: string;
     readonly createdDateTime?: string;
-    readonly quantitativeReading: string;
+    readonly quantitativeReading: number;
     readonly quantitativeReadingUnitId: string;
 }
 interface DocumentRelationshipsCharacteristics {

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

@@ -1,6 +1,7 @@
 interface PanelUserSettings {
     readonly isTagsVisible: boolean;
     readonly isWorkOrdersVisible: boolean;
+    readonly isEquipmentsVisible: boolean;
 }
 interface DataLayerPanelState {
     readonly isOpen: boolean;
@@ -9,6 +10,7 @@ interface DataLayerPanelState {
 interface DataLayerPanelActions {
     togglePanel: () => void;
     toggleWorkOrders: () => void;
+    toggleEquipments: () => void;
     toggleTags: () => void;
 }
 type DataLayerPanelStore = DataLayerPanelState & DataLayerPanelActions;

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

@@ -15,5 +15,6 @@ export declare enum InternalApplicationLinks {
     SmartPortal = "/smartportal",
     EchoMaps = "/maps",
     Echo3dWeb = "/echo3d",
-    Turnaround = "/turnaround"
+    Turnaround = "/turnaround",
+    Sandbox = "/sandbox"
 }

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

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

package/src/lib/components/homePage/HomePage.d.ts

@@ -1 +0,0 @@
-export declare const HomePage: () => import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -1,6 +0,0 @@
-import React from 'react';
-interface CoreIconProps {
-    name: string;
-}
-export declare const CoreIcon: React.FC<CoreIconProps>;
-export {};

package/src/lib/components/prepview/common/access/handler/StatusHandler.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { FetchStatus } from '../../../types';
-interface Props {
-    statusCode: FetchStatus['statusCode'];
-    children: React.ReactNode;
-}
-declare function StatusHandler({ statusCode, children }: Props): JSX.Element;
-export { StatusHandler };

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

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

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

@@ -1,2 +0,0 @@
-export * from './handler';
-export * from './request';

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

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

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

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

package/src/lib/components/prepview/common/info/section/longText/LongTextSection.d.ts

@@ -1,7 +0,0 @@
-interface Props {
-    text: string;
-    toggleLongText: () => void;
-    isPunch?: boolean;
-}
-declare function LongTextSection({ text, toggleLongText }: Props): import("react/jsx-runtime").JSX.Element;
-export { LongTextSection };

package/src/lib/components/prepview/common/info/section/longText/index.d.ts

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

package/src/lib/components/prepview/hooks/useIsMobile.d.ts

@@ -1,4 +0,0 @@
-/**
- * @deprecated use isMobileDevice from @equinor/echo-utils instead
- */
-export declare function useIsMobile(): boolean;

package/src/lib/components/prepview/panels/history/items/index.d.ts

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

package/src/lib/components/prepview/utils/dom.d.ts

@@ -1 +0,0 @@
-export declare function escapeSpecialCharacters(text: string): string[];

package/src/lib/components/prepview/utils/notification.d.ts

@@ -1,2 +0,0 @@
-export declare function getStatusColor(statusIds: string): "#4bb748" | "#fbca36";
-export declare function getStatusText(statusIds: string): "Completed" | "Active";

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

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

package/src/lib/services/api/api-stid-tags.d.ts

@@ -1,13 +0,0 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-/**
- * Get a list of tags from STID.
- * @param {string} args.instCode Plant instCode
- * @param {string[]} args.tagNos Tag ids to query for
- * @param {boolean} args.enableCache With this enabled, the call will be cached in memory and
- * will be fetched from there instead of getting it from the API
- * @returns {TagSummaryDto[]}
- */
-export declare function getTagsFromStidApi(args: {
-    instCode: string;
-    tagNos: string[];
-}): Promise<TagSummaryDto[]>;

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

@@ -1,53 +0,0 @@
-export type SupportedPlatforms = 'Android' | 'Linux' | 'MacOs' | 'iOS' | 'iPadOS' | 'Windows' | 'Platform not found.';
-export type DetailedDeviceInformation = {
-    operatingSystem: string;
-    webBrowser: string;
-    deviceModel: string;
-    platform?: SupportedPlatforms;
-};
-export type IDeepDeviceInformation = {
-    operatingSystem: string;
-    webBrowser: string;
-    deviceModel: string;
-    platform?: SupportedPlatforms;
-};
-/** If the viewport is a square, then the orientation will be portrait. */
-export type ScreenOrientation = 'portrait' | 'landscape';
-/** Keep in mind, this is calculated when the page loads, so be sure to do refresh if simulating a device in DevTools. */
-export type DeviceType = 'mobile' | 'tablet' | 'desktop';
-export type UserInput = 'touch' | 'mouse';
-export type Browser = 'Chrome' | 'Safari' | 'Firefox' | 'Edge' | 'Opera';
-type Dimensions = {
-    width: number;
-    height: number;
-};
-export type ScreenDimensions = {
-    /** Provides measurements for use in the visual viewport.
-     *
-     * The visual viewport is the currently visible viewport and these dimensions
-     * can be smaller than the layout viewport if, for example, the user has pinch zoomed or summoned their
-     * on-screen keyboards.
-     */
-    visual: Dimensions;
-    /**
-     * Provides measurements for the layout viewport. These values are always fetched from
-     * innerHeight and innerWidth, so scrollbars are included.
-     */
-    layout?: Dimensions;
-    /** Provides measurements for use in fullscreen contexts. */
-    fullscreen?: FullscreenDimensions;
-};
-export type FullscreenDimensions = {
-    /** The total screen dimensions, essentially equal to the screen resolution configured in OS settings.*/
-    total: Dimensions;
-    /** The available screen dimensions, taking into account overlays such as browser address bar or virtual keyboard. */
-    available: Dimensions;
-};
-export interface IDeviceSummary {
-    orientation: ScreenOrientation;
-    deviceType: DeviceType;
-    userInput: UserInput;
-    screenDimensions: ScreenDimensions;
-    deepInfo: IDeepDeviceInformation;
-}
-export {};

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

@@ -1,3 +0,0 @@
-export interface OnClickTagsTriggerEvent {
-    tagId: string;
-}

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

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

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

@@ -1,7 +0,0 @@
-import { ToasterMessage } from './toasterMessage';
-export interface Toaster {
-    toastNumber: number;
-    toast: ToasterMessage;
-    numberOfToasts: number;
-    onClose?: () => void;
-}