@equinor/echo-framework 0.11.0-rc13 → 0.11.0-rc15

package/dist/services/componentRegistry/componentRegistry.d.ts

@@ -1,14 +1,34 @@
 /// <reference types="react" />
 type AnyComponentType = React.FC<any>;
-interface ComponentRegistry {
+export declare enum RegisteredComponentName {
+    /** @deprecated Please use 'TagListItem' instead - that supports the new search flow  */
+    TagItem = "TagItem",
+    TagListItem = "TagListItem"
+}
+export declare const componentRegistry: Readonly<{
+    /**
+     * Should be only used by EchopediaWeb, when bootstrapping Echo app.
+     * Use this method to register a legacy component from Echopedia to EchoFramework, so it's available for others to use.
+     * Originally created to make tightly coupled components available until they are properly refactored and decoupled.
+     * @param {RegisteredComponentName} name The component will be assigned to this key.
+     * @param {React.FC<any>} component The component which should be registered.
+     */
     registerComponent: ({ name, component }: {
         name: RegisteredComponentName;
         component: AnyComponentType;
     }) => void;
+    /**
+     * @deprecated Please use 'getTagListItem()' instead - that supports the new search flow
+     * Returns with the TagItem component, which is used in EchopediaWeb's search panel
+     * and pdf side drawer when listing out tags.
+     * @returns {React.FC<any>}
+     */
     getTagItem: () => AnyComponentType;
-}
-export declare enum RegisteredComponentName {
-    TagItem = "TagItem"
-}
-export declare const componentRegistry: ComponentRegistry;
+    /**
+     * Returns with the TagItem component, which is used in EchopediaWeb's search panel
+     * and pdf side drawer when listing out tags.
+     * @returns {React.FC<any>}
+     */
+    getTagListItem: () => AnyComponentType;
+}>;
 export {};

package/dist/services/deviceInformation/deepDeviceInfo.d.ts

@@ -0,0 +1,41 @@
+/// <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/dist/services/deviceInformation/deviceInfo.d.ts

@@ -0,0 +1,45 @@
+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 };

package/dist/services/searchItemDetails/searchItemDetails.store.d.ts

@@ -0,0 +1,26 @@
+import { ReactNode } from 'react';
+export declare const useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<SearchItemDetailsState>, "setState"> & {
+    setState(nextStateOrUpdater: SearchItemDetailsState | Partial<SearchItemDetailsState> | ((state: import("immer/dist/internal").WritableDraft<SearchItemDetailsState>) => void), shouldReplace?: boolean | undefined): void;
+}>;
+export type SearchItemDetailsObject = {
+    content: ReactNode;
+    header?: ReactNode;
+    subHeader?: ReactNode;
+    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;
+    replaceLastNavigationItem?: boolean;
+};
+export {};

package/dist/services/searchItemDetails/searchItemDetails.store.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/services/searchItemDetails/searchItemDetailsContainer.d.ts

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

package/dist/theme/themeConst.d.ts

@@ -47,4 +47,5 @@ export declare const themeConst: {
     defaultSeverity: string;
     toggleActive: string;
     toggleInactive: string;
+    dividerColor: string;
 };

package/dist/types/device.d.ts

@@ -0,0 +1,53 @@
+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/dist/types/eventTypes/index.d.ts

@@ -1,3 +1,4 @@
 export type { LegendChangedEvent } from './legendEvent';
 export type { PlantEvent } from './plantEvent';
+export type { SearchItemDetailsClosedEvent } from './searchDetailsContainerEvents';
 export type { ToasterEvent } from './toasterEvent';

package/dist/types/eventTypes/searchDetailsContainerEvents.d.ts

@@ -0,0 +1,3 @@
+export interface SearchItemDetailsClosedEvent {
+    panelKey: string;
+}

package/dist/types/hookLibrary.d.ts

@@ -1,5 +1,20 @@
-export type SetActiveTagNo = (tagNo: string, activeTagTab?: string, activeTagSubTab?: string, instCode?: string) => void;
+export type SetActiveTagNo = (argsORtagNo: string | {
+    tagNo: string;
+    activeTagTab?: string;
+    activeTagSubTab?: string;
+    instCode?: string;
+    activePanelKey?: string;
+    replaceLastNavigationItem?: boolean;
+}, activeTagTab?: string, activeTagSubTab?: string, instCode?: string) => void;
 export type TagData = [(tagNo: string, instCode: string) => void];
-export type SetActiveCommPackNo = (commPackNo: string, activeCommPackProject: string, activeCommPackTab?: string, activeCommPackSubTab?: string) => void;
-export type SetActiveMcPackNo = (mcPackNo: string, activeMcPackProject: string, activeMcPackTab?: string, activeMcPackSubTab?: string) => void;
+export type SetActiveCommPackNo = (argsORcommPackNo: string | {
+    commPackNo: string;
+    activeCommPackProject: string;
+    activePanelKey?: string;
+}, activeCommPackProject?: string) => void;
+export type SetActiveMcPackNo = (argsORmcPackNo: string | {
+    mcPackNo: string;
+    activeMcPackProject: string;
+    activePanelKey?: string;
+}, activeMcPackProject?: string) => void;
 export type ScreenOrientation = 'landscape' | 'portrait' | undefined;

package/dist/utils/arrayUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function for creating a range between two numbers
+ * @export
+ * @param {number} start: The starting point of the range.
+ * @param {number} end: The end point of the range.
+ * @return {*}  {number[]}
+ */
+export declare function range(start: number, end: number): number[];

package/dist/utils/arrayUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/tagUtils.d.ts

@@ -0,0 +1,23 @@
+import { TagDetailsDto } from '@equinor/echo-search';
+/**
+ * Function for getting the echoUrl based on tag details
+ * Returns the url if found, builds and returns an url if plantCode and tagNo is found
+ * Otherwise - returns empty string
+ * @param {(TagDetailsDto | undefined)} tagDetails
+ * @return {*}  {string}
+ */
+export declare function getEcho3DAppUrlForTag(tagDetails: TagDetailsDto | undefined): Promise<string>;
+/**
+ * Function for getting Plant Code based on Tag Details data
+ * Returns the plant Code if found, returns empty string otherwise.
+ * @param {TagDetailsDto} tagDetails
+ * @returns {*} {string}
+ */
+export declare function getPlantCodeForTag(tagDetails: TagDetailsDto): Promise<string>;
+/**
+ * Function for getting plant project description based on Tag Details
+ * Returns the plant project description if found, otherwise, return empty string.
+ * @param {TagDetailsDto} tagDetails
+ * @returns {*} {string}
+ */
+export declare function getProjectDescriptionForTag(tagDetails: TagDetailsDto): Promise<string>;

package/dist/utils/tagUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/echo-framework",
-    "version": "0.11.0-rc13",
+    "version": "0.11.0-rc15",
     "description": "Modules and components for EchoWeb, utilizing EchoCore",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
     "peerDependencies": {
         "@equinor/echo-base": ">=0.6.12 < 0.7.0",
         "@equinor/echo-components": ">=0.5.0 < 0.6.0",
-        "@equinor/echo-core": ">=0.6.20 < 0.8.0",
+        "@equinor/echo-core": ">=0.7.5 < 0.8.0",
         "@equinor/echo-search": ">=0.13.2 < 0.14.0",
         "@equinor/echo-utils": ">=0.2.12 < 0.3.0",
         "@equinor/eds-core-react": "^0.25.0",
@@ -53,9 +53,9 @@
         "@babel/preset-react": "^7.18.6",
         "@equinor/echo-base": "^0.6.22",
         "@equinor/echo-components": "^0.5.19",
-        "@equinor/echo-core": "^0.7.3",
+        "@equinor/echo-core": "^0.7.5",
         "@equinor/echo-scripts": "^0.1.5",
-        "@equinor/echo-search": "^0.13.11",
+        "@equinor/echo-search": "^0.13.13",
         "@equinor/echo-update": "^1.3.1",
         "@equinor/echo-utils": "^0.2.12",
         "@equinor/eds-core-react": "^0.25.0",
@@ -105,7 +105,8 @@
         "styled-components": "^5.3.6",
         "ts-jest": "^29.0.5",
         "tslib": "^2.4.1",
-        "typescript": "=4.9.4"
+        "typescript": "=4.9.4",
+        "user-agent-data-types": "^0.3.0"
     },
     "compilerOptions": {
         "declaration": true
@@ -119,6 +120,7 @@
     },
     "dependencies": {
         "@microsoft/signalr": "^6.0.13",
+        "immer": "^9.0.19",
         "zustand": "^4.3.2"
     }
 }