@equinor/echo-framework 0.20.11-beta-0 → 0.20.12-beta-0

package/package.json

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

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/globalSelection/globalSelectionStore/globalSelectionStore.types.d.ts

@@ -46,7 +46,7 @@ export type WorkOrderGlobalSelectionListItem = GlobalSelectionTypes.GenericItem<
  */
 export type TagGlobalSelectionListItem = GlobalSelectionTypes.GenericItem<GlobalSelectionItemType.Tag>;
 /**
- * @deprecated We plan to make this private in the future: Use the public GlobalSelectionTypes namespace to access this type.
+ * @deprecated We plan to make this private in the future: Use the public namespace, GlobalSelectionTypes.SelectionItem type instead.
  */
 export type GlobalSelectionItem = WorkOrderGlobalSelectionListItem | TagGlobalSelectionListItem | EquipmentGlobalSelectionListItem;
 /**
@@ -97,6 +97,7 @@ export interface GlobalSelectionStore {
      *@deprecated This method is deprecated. Use `removeErrorStatusForItems` instead.
      */
     resetItemNotFoundStates: () => void;
+    resetItemErrorStatuses: () => void;
     resetState: () => void;
     setErrorStatusForItems: (args: {
         itemErrorStatuses: GlobalSelectionTypes.ItemErrorStatusUpdate[];
@@ -116,11 +117,11 @@ export declare namespace GlobalSelectionTypes {
     type EquipmentId = Pick<Equipment, 'equipmentId'>;
     type TagId = Pick<TagSummaryDto, 'tagNo' | 'instCode'>;
     type ItemId = WorkOrderId | EquipmentId | TagId;
-    type EquipmentListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
-    type WorkOrderListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.WorkOrder>;
-    type TagListItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
+    type EquipmentItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Equipment>;
+    type WorkOrderItem = GlobalSelectionGenericItem<GlobalSelectionItemType.WorkOrder>;
+    type TagItem = GlobalSelectionGenericItem<GlobalSelectionItemType.Tag>;
     type List<T extends GlobalSelectionItemType> = GlobalSelectionList<T>;
-    type ListItem = EquipmentListItem | WorkOrderListItem | TagListItem;
+    type SelectionItem = EquipmentItem | WorkOrderItem | TagItem;
     type GenericItem<T extends GlobalSelectionItemType> = GlobalSelectionGenericItem<T>;
     type Store = GlobalSelectionStore;
     type ItemErrorStatusUpdate = ItemErrorStatusUpdates;

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

@@ -17,10 +17,7 @@ declare function itemIdToString(itemId: Record<string, string | number>): string
  * @property {Function} isTagId - Checks if the passed object is a global selection TagID.
  * @property {Function} idsEqual - Compares two global selection item IDs for equality.
  * @property {Function} mapToId - Maps an object to its global selection item ID.
- * @property {Function} allTags - Retrieves all tags in the global selection store.
- * @property {Function} allEquipments - Retrieves all equipments in the global selection store.
- * @property {Function} allWorkOrders - Retrieves all work orders in the global selection store.
- * @property {Function} snapshot - Returns the current state of the global selection store.
+ * @property {Function} itemIdToString - Converts a global selection item id object to a string, each value is concatenated by a '-'
  */
 export declare const globalSelectionUtils: Readonly<{
     isWorkOrderId: typeof isWorkOrderId;

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionItems.d.ts

@@ -1,2 +1,2 @@
 import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
-export declare const useGlobalSelectionItems: () => GlobalSelectionTypes.ListItem[];
+export declare const useGlobalSelectionItems: () => GlobalSelectionTypes.SelectionItem[];

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionTags.d.ts

@@ -3,4 +3,4 @@ import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionSto
  * Returns with the stored Tags from the global selection store
  * @returns {TagGlobalSelectionListItem[]} Array of Tags with some global selection meta data.
  */
-export declare function useGlobalSelectionTags(): GlobalSelectionTypes.TagListItem[];
+export declare function useGlobalSelectionTags(): GlobalSelectionTypes.TagItem[];

package/src/lib/feature/globalSelection/hooks/useGlobalSelectionWorkOrders.d.ts

@@ -1,6 +1,6 @@
 import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 /**
  * Returns with the stored Work Orders from the global selection store
- * @returns {GlobalSelectionTypes.WorkOrderListItem[]} Array of Work Orders
+ * @returns {GlobalSelectionTypes.WorkOrderItem[]} Array of Work Orders
  */
-export declare function useGlobalSelectionWorkOrders(): GlobalSelectionTypes.WorkOrderListItem[];
+export declare function useGlobalSelectionWorkOrders(): GlobalSelectionTypes.WorkOrderItem[];

package/src/lib/feature/globalSelection/panToEcho3d/panTo3DButton.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 interface PanTo3DButtonProps {
-    item: GlobalSelectionTypes.ListItem;
+    item: GlobalSelectionTypes.SelectionItem;
 }
 export declare const PanTo3DButton: React.FC<PanTo3DButtonProps>;
 export {};

package/src/lib/feature/globalSelection/panToEcho3d/usePanTo3DWeb.d.ts

@@ -1,4 +1,4 @@
 import { GlobalSelectionTypes } from '../globalSelectionStore/globalSelectionStore.types';
 export declare const usePanTo3dWeb: () => {
-    panTo3D: (item: GlobalSelectionTypes.ListItem) => Promise<void>;
+    panTo3D: (item: GlobalSelectionTypes.SelectionItem) => Promise<void>;
 };

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

@@ -1,4 +1,4 @@
-export { workOrdersToPlantTagPairs } from './logic/convertToPlantTagPairs';
+export { tagIdPlantIdToPlantTagPairs } from './logic/convertToPlantTagPairs';
 export type { Plant3dInfo, PlantAndTagForOpenIn3d } from './logic/openItemsIn3d.utils';
 export { OpenItemsIn3dDialog } from './openItemsIn3dDialog';
 export { SelectedItemsMenu } from './SelectedItemsMenu';

package/src/lib/feature/openItemsIn3d/logic/convertToPlantTagPairs.d.ts

@@ -1,10 +1,10 @@
 import { PlantAndTagForOpenIn3d } from './openItemsIn3d.utils';
-export interface WorkOrderTag {
+export interface TagIdPlantId {
     tagPlantId: string | undefined;
     tagId: string | undefined;
 }
-export declare function tagToPlantTagPairs(selectedWorkOrders: {
+export declare function tagToPlantTagPairs(selectedWorkOrders: ReadonlyArray<{
     tagNo: string;
     instCode: string;
-}[]): Promise<PlantAndTagForOpenIn3d[]>;
-export declare function workOrdersToPlantTagPairs(selectedWorkOrders: WorkOrderTag[]): Promise<PlantAndTagForOpenIn3d[]>;
+}>): Promise<PlantAndTagForOpenIn3d[]>;
+export declare function tagIdPlantIdToPlantTagPairs(items: ReadonlyArray<TagIdPlantId>): Promise<PlantAndTagForOpenIn3d[]>;

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;
-}