@equinor/echo-framework 0.16.0-beta-1 → 0.16.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.16.0-beta-1",
+  "version": "0.16.0",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.7.0 < 0.8.0",
-    "@equinor/echo-components": "0.9.0-beta-0",
+    "@equinor/echo-components": ">= 0.9.0 < 0.10.0",
     "@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",
@@ -16,7 +16,6 @@
     "history": "5.3.0",
     "lodash": "4.17.21",
     "react-router-dom": "5.3.4",
-    "ua-parser-js": "1.0.36",
     "zustand": "4.4.1"
   },
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -1,18 +1,18 @@
 /// <reference types="react" />
+import { getLegendStatusColor } from './lib/feature/legend/utils/legendUtils';
 import './lib/globalStyles.css';
 import { getPlantsInfo, getTagDetails } from './lib/services/api';
-import { getLegendStatusColor } from './lib/utils/legendUtils';
 export * from './lib/components';
 export { RequestSapAccess } from './lib/components/requestAccess/RequestSapAccess';
 export * from './lib/coreApplication';
+export * from './lib/feature/legend/index';
 export { RegisteredHookName } from './lib/hooks/hookLibrary';
 export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
 export { useIsFullScreenModeEnabled } from './lib/hooks/useIsFullScreenModeEnabled';
 export { useScreenOrientation } from './lib/hooks/useScreenOrientation';
 export { useScreenValues } from './lib/hooks/useScreenValues';
+export * from './lib/services/activeSelectionStore';
 export { RegisteredComponentName } from './lib/services/componentRegistry/componentRegistry';
-export { DetailedDeviceInformationProvider, detailedDeviceInformationProvider } from './lib/services/deviceInformation/deepDeviceInfo';
-export { DeviceInformation, deviceInfo } from './lib/services/deviceInformation/deviceInfo';
 export * from './lib/services/eventHubActions';
 export * from './lib/services/searchItemDetails/searchItemDetails.store';
 export { SearchItemDetailsSideSheet } from './lib/services/searchItemDetails/searchItemDetailsSideSheet';
@@ -22,11 +22,9 @@ export type { EchoHubPlant } from './lib/types/echoHubPlant';
 export * from './lib/types/eventTypes';
 export * from './lib/types/extensions';
 export type { SetActiveTagNo, TagData } from './lib/types/hookLibrary';
-export { LegendStatus, LegendType } from './lib/types/legend';
 export type { ModelPermissions } from './lib/types/modelPermissions';
 export { PingableSources } from './lib/types/pingableSources';
 export * from './lib/utils';
-export { getLegendStatusColor, legendTypeToLegendStatus, toLegendStatusOrString, valueToEnum } from './lib/utils/legendUtils';
 export * from './lib/utils/startup';
 export declare const registerEchopediaComponent: ({ name, component }: {
     name: import("./lib/services/componentRegistry/componentRegistry").RegisteredComponentName;

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

@@ -6,11 +6,9 @@ export * from './echo3DButton';
 export { EchoLogo } from './echoLogo/echoLogo';
 export * from './errorBoundary';
 export * from './externalLinkButton/externalLinkButton';
-export * from './footer';
 export * from './fullScreenButtons';
 export * from './lazyLoading';
 export * from './mediator';
-export * from './pageMenu';
 export * from './panel';
 export * from './panelButton';
 export * from './plantSelector';
@@ -18,6 +16,5 @@ export * from './prepview';
 export * from './projectSelector';
 export * from './realTimeData';
 export * from './router';
-export * from './searchMenu';
 export * from './tagNumber';
 export * from './toaster';

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

@@ -1,6 +1,5 @@
 export * from './EchoBarComponent';
 export * from './EchoContent';
-export * from './EchoContentPanels';
 export * from './EchoEventHandler';
 export * from './EchoToolBar';
 export * from './EchoTopBar';

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

@@ -0,0 +1,5 @@
+export { LegendStatus, LegendType } from './legend';
+export type { LegendItemStatus } from './legend';
+export { createChipStatusProps } from './utils/createChipStatusProps';
+export { getLegendStatusColor, legendTypeToLegendStatus, toLegendStatusOrString, valueToEnum } from './utils/legendUtils';
+export { statusHelper } from './utils/statusHelper';

package/src/lib/{types → feature/legend}/legend.d.ts

@@ -1,5 +1,8 @@
+export type LegendItemStatus = LegendStatus | string;
 export declare enum LegendStatus {
     Unknown = "Unknown",
+    Multiple = "Multiple",
+    ApiError = "Api Error: Failed to get data for legend",
     AsBuilt = "AsBuilt",
     Planned = "Planned",
     Reserved = "Reserved",

package/src/lib/feature/legend/utils/createChipStatusProps.d.ts

@@ -0,0 +1,7 @@
+import { TagIconChipsProps } from '@equinor/echo-components';
+import { LegendItemStatus } from '../legend';
+export declare function createChipStatusProps(args: {
+    tagCategoryDescription: string;
+    status: LegendItemStatus;
+    isChipsEnabled: boolean;
+}): TagIconChipsProps;

package/src/lib/{utils → feature/legend/utils}/legendUtils.d.ts

@@ -1,4 +1,4 @@
-import { LegendStatus, LegendType } from '../types/legend';
+import { LegendStatus, LegendType } from '../legend';
 /**
  * Get the right status color for a given tag status
  * @param {LegendStatus} tagStatus

package/src/lib/feature/legend/utils/statusHelper.d.ts

@@ -0,0 +1,27 @@
+import { LegendItemStatus } from '../legend';
+/**
+ * Converts to a list of single statuses
+ * @example "M1+M2+M3" becomes: ["M1", "M2", "M3"]
+ */
+declare function toSingleStatuses(statusesConcatedWithPlus?: LegendItemStatus): LegendItemStatus[];
+/**
+ * Returns a string with all statuses joined by +
+ * * @example ["M1", "M2", "M3"] becomes: "M1+M2+M3"
+ */
+declare function toMultiStatus(statuses: ReadonlyArray<LegendItemStatus>): LegendItemStatus;
+declare function hasMultiStatuses(statuses: LegendItemStatus): boolean;
+declare function isSingleStatus(status: LegendItemStatus): boolean;
+/**
+ * Converts to a list of single statuses
+ * @example ["M1", "M2", "M1+M2+M3"] becomes: ["M1", "M2", "M3", "Multiple"]
+ * @example ["M1", "M2"] stays the same: ["M1", "M2"]
+ */
+declare function multiListToSingleList(statuses: ReadonlyArray<LegendItemStatus>): string[];
+export declare const statusHelper: {
+    toMultiStatus: typeof toMultiStatus;
+    toSingleStatuses: typeof toSingleStatuses;
+    hasMultiStatuses: typeof hasMultiStatuses;
+    isSingleStatus: typeof isSingleStatus;
+    multiListToSingleList: typeof multiListToSingleList;
+};
+export {};

package/src/lib/services/activeSelectionStore/activeSelectionStore.d.ts

@@ -0,0 +1,19 @@
+import * as zustand from 'zustand';
+export declare const useActiveSelectionStore: zustand.UseBoundStore<zustand.StoreApi<ActiveSelectionState>>;
+export type ActiveSelectionItemType = 'tagNos' | 'workOrderIds' | 'measuringPointIds';
+export type ActiveSelectionItems = {
+    [key in ActiveSelectionItemType]: string[];
+};
+export interface ActiveSelectionState {
+    items: ActiveSelectionItems;
+    userRequestAction: string | null;
+    actions: ActiveSelectionActions;
+}
+interface ActiveSelectionActions {
+    addToSelectionByType: (itemType: ActiveSelectionItemType, items: string[]) => void;
+    removeFromSelectionByType: (itemType: ActiveSelectionItemType, items: string[]) => void;
+    clearSelectionByType: (itemType: ActiveSelectionItemType) => void;
+    clearSelectionForAllTypes: () => void;
+    replaceSelection: (items: ActiveSelectionItems, action?: string) => void;
+}
+export {};

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

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

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

@@ -1,4 +1,4 @@
-import { LegendType } from '../legend';
+import { LegendType } from '../../feature/legend/legend';
 export interface LegendChangedEvent {
     newLegendType: LegendType;
 }

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

@@ -1,4 +1,5 @@
 export interface ToasterMessage {
+    count: number;
     id: number;
     message: string;
     onClose?: () => void;

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

@@ -1,10 +0,0 @@
-import React from 'react';
-export declare enum FooterType {
-    normal = "normal",
-    termOfService = "tos"
-}
-interface FooterProps {
-    footerType?: FooterType;
-}
-export declare const Footer: React.FC<FooterProps>;
-export {};

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

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

package/src/lib/components/pageMenu/Navigation/applicationList.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const ApplicationList: React.FC;
-export default ApplicationList;

package/src/lib/components/pageMenu/defaultAccordionItem.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-type DefaultAccordionItemProps = {
-    isExpanded: boolean;
-    handleClick: () => void;
-    title: string;
-    subtitle?: string;
-    iconName: string;
-    iconTitle: string;
-    children: React.ReactChild | React.ReactChild[];
-};
-declare const DefaultAccordionItem: React.FC<DefaultAccordionItemProps>;
-export default DefaultAccordionItem;

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

@@ -1,3 +0,0 @@
-export * from './defaultAccordionItem';
-export * from './pageMenu';
-export * from './pageMenuDrawerItem';

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

@@ -1,15 +0,0 @@
-import React from 'react';
-interface PageMenuProps {
-    trackEventOpenExternalLink: (linkTo: string) => void;
-    isSyncing: boolean;
-}
-/**
- * Component for displaying a side menu including Home button, Profile, About Echo link and Terms & Conditions link.
- * @param {PageMenuProps} {
- * trackEventOpenExternalLink: Function for tracking event in appInsight.
- * isSyncing: Flag to determine whether the app is currently syncing data or not.
- * }
- * @return {*}
- */
-export declare const PageMenu: React.FC<PageMenuProps>;
-export {};

package/src/lib/components/pageMenu/pageMenuDrawerItem.d.ts

@@ -1,16 +0,0 @@
-import React from 'react';
-interface ExternalLinkProps {
-    link: string;
-    linkText: string;
-    trackEvent: string;
-}
-interface PageMenuDrawerItemProps {
-    iconName: string;
-    iconTitle: string;
-    trackEventOpenExternalLink: (linkTo: string) => void;
-    children?: React.ReactNode;
-    externalLink?: ExternalLinkProps;
-    classNames?: string;
-}
-declare const PageMenuDrawerItem: React.FC<PageMenuDrawerItemProps>;
-export default PageMenuDrawerItem;

package/src/lib/components/pageMenu/settings/asset.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-interface AssetProps {
-    isDisabled: boolean;
-}
-declare const Asset: React.FC<AssetProps>;
-export default Asset;

package/src/lib/components/pageMenu/settings/profile.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-interface ProfileProps {
-    trackEventOpenExternalLink: (linkTo: string) => void;
-}
-declare const Profile: React.FC<ProfileProps>;
-export default Profile;

package/src/lib/components/pageMenu/settings/settings.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-interface SettingsProps {
-    trackEventOpenExternalLink: (linkTo: string) => void;
-    isDisabled: boolean;
-}
-declare const Settings: React.FC<SettingsProps>;
-export default Settings;

package/src/lib/components/pageMenu/version/version.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const Version: React.FC;
-export default Version;

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

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

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

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const SearchMenu: React.FC;
-export default SearchMenu;

package/src/lib/coreApplication/EchoContentPanels.d.ts

@@ -1,9 +0,0 @@
-import { Panel } from '@equinor/echo-core';
-/**
- * Core Main menu panel registered at client startup
- */
-export declare const mainMenu: Panel;
-/**
- * Core Application search panel registered at client startup
- */
-export declare const searchPanel: Panel;

package/src/lib/services/deviceInformation/deepDeviceInfo.d.ts

@@ -1,41 +0,0 @@
-/// <reference types="user-agent-data-types" />
-import UAParser from 'ua-parser-js';
-import { DetailedDeviceInformation } from '../../types/device';
-/**
- * This object is concerned with gathering and holding information about the users device.
- * This object will be read-only after initialization and should as a rule throw errors if the
- * deviceInformation property is altered after intialization.
- */
-declare class DetailedDeviceInformationProvider {
-    /** Represents the user agent string parser.
-     * This method is treated as a fallback if the User-Agent Client Hints API does not provide a coherent value
-     * or if the browser does not yet support it.
-     */
-    private readonly _uaParser;
-    /**
-     * Stores the system report from a call to the underlying system.
-     * - If this is undefined, it is not yet initialized (it happens asynchronously).
-     */
-    private readonly _uaDataValues;
-    /** Holds the current device information and should be the single source of truth.
-     *
-     * It can be undefined because we have to asynchronously fetch underlying system information.
-     */
-    private readonly _deviceInformation;
-    private constructor();
-    get deviceInformation(): DetailedDeviceInformation;
-    get uaDataValues(): UADataValues | null | undefined;
-    get uaParser(): UAParser.UAParserInstance;
-    /** Constructs the parser and returns it.  */
-    static initialize(): DetailedDeviceInformationProvider;
-    private static getPlatform;
-    private static getWebBrowser;
-    private static getOperatingSystem;
-    /**
-     * TODO: Get the device model from Client Hints API.
-     * This requires top-level await support, which in turn has to be implemented to modules downstream.
-     */
-    private static getDeviceModel;
-}
-declare const detailedDeviceInformationProvider: DetailedDeviceInformationProvider;
-export { DetailedDeviceInformationProvider, detailedDeviceInformationProvider };

package/src/lib/services/deviceInformation/deviceInfo.d.ts

@@ -1,45 +0,0 @@
-import { Browser, DetailedDeviceInformation, DeviceType, IDeviceSummary, ScreenDimensions, ScreenOrientation, UserInput } from '../../types/device';
-import { detailedDeviceInformationProvider } from './deepDeviceInfo';
-type Props = {
-    detailedDeviceInfo: typeof detailedDeviceInformationProvider;
-};
-declare class DeviceInformation {
-    /**
-     * Represents the current viewport orientation.
-     * If the viewport is square, it will default to portrait.
-     */
-    private _orientation;
-    /**
-     * Represents an abstracted device type: desktop, tablet or mobile.
-     */
-    private readonly _deviceType;
-    /**
-     * Represents the current input source.
-     * Note: On a touchscreen device which has a mouse plugged in, it will return the mouse.
-     */
-    private readonly _userInput;
-    private readonly _browser?;
-    /**
-     * Represents the viewport (layout and visual) and (full)screen dimensions.
-     * WebKit browsers prior to 15 will only support layout dimensions.
-     */
-    private _dimensions;
-    protected orientationIsLandscapeQuery: MediaQueryList;
-    private _detailedDeviceInfo;
-    constructor(props: Props);
-    private getUpdatedScreenDimensions;
-    private getBrowser;
-    private getUserInput;
-    /** Returns the current viewing medium.*/
-    private getDeviceType;
-    private getOrientation;
-    getDeviceDetails(): DetailedDeviceInformation;
-    get orientation(): ScreenOrientation;
-    get deviceType(): DeviceType;
-    get userInput(): UserInput;
-    get screenDimensions(): ScreenDimensions;
-    get browser(): Browser | undefined;
-    getDeviceSummary(): IDeviceSummary;
-}
-declare const deviceInfo: DeviceInformation;
-export { deviceInfo, DeviceInformation };