@equinor/echo-framework 0.10.24 → 0.10.26-rc0

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/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/types/eventTypes/index.d.ts

@@ -1,3 +1,11 @@
 export type { LegendChangedEvent } from './legendEvent';
 export type { PlantEvent } from './plantEvent';
+export type { SearchItemDetailsClosedEvent } from './searchDetailsContainerEvents';
 export type { ToasterEvent } from './toasterEvent';
+export declare enum EchoEvent {
+    LegendTypeChanged = "legendTypeChanged",
+    PlantChanged = "plantChanged",
+    ProcosysProjectChanged = "procosysProjectChanged",
+    Toaster = "toaster",
+    SearchItemDetailsClosed = "SearchItemDetailsClosed"
+}

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/package.json

@@ -1,123 +1,125 @@
-{
-    "name": "@equinor/echo-framework",
-    "version": "0.10.24",
-    "description": "Modules and components for EchoWeb, utilizing EchoCore",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "source": "src/index.ts",
-    "repository": "https://github.com/equinor/EchoFramework.git",
-    "author": "Echo Core",
-    "license": "MIT",
-    "private": false,
-    "scripts": {
-        "build": "rollup -c",
-        "build-cli": "npm --prefix ../EchoCli run build",
-        "prebuild-cli": "npm --prefix ../EchoClient run build -- --env=cli=true",
-        "cli-publish": "npm run build-cli",
-        "postcli-publish": "npm --prefix ../EchoCli run echo-publish",
-        "cli-next": "npm run build-cli",
-        "postcli-next": "npm --prefix ../EchoCli run echo-publish-next",
-        "start": "rollup -c -w ",
-        "publish-pk": "npm publish --access public",
-        "echo-publish": "npm publish --access public",
-        "echo-publish-beta": "npm publish --access public --tag beta",
-        "echo-publish-next": "npm publish --access public --tag next",
-        "echo-test": "jest",
-        "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
-        "test-wo-install": "jest --watchAll",
-        "test": "npm ci & jest --watchAll",
-        "test-coverage": "npm ci & jest --coverage --watchAll",
-        "patch": "npm version patch",
-        "major": "npm version major",
-        "minor": "npm version minor",
-        "echo-update": "echo-update",
-        "echo-update-all": "echo-update -a",
-        "yalc-purge": "rmdir \"%APPDATA%/../Local/Yalc/packages/@equinor/echo-framework\" /q /s",
-        "re-yalc": "npm run build && yalc push --sig"
-    },
-    "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-search": ">=0.13.2 < 0.14.0",
-        "@equinor/echo-utils": ">=0.2.12 < 0.3.0",
-        "@equinor/eds-core-react": "^0.25.0",
-        "react": "^17.0.2",
-        "react-dom": "^17.0.2",
-        "react-router-dom": "^5.3.4",
-        "styled-components": "^5.3.6"
-    },
-    "devDependencies": {
-        "@babel/core": "^7.20.12",
-        "@babel/preset-env": "^7.20.2",
-        "@babel/preset-react": "^7.18.6",
-        "@equinor/echo-base": "^0.6.22",
-        "@equinor/echo-core": "^0.7.3",
-        "@equinor/echo-components": "^0.5.19",
-        "@equinor/echo-scripts": "^0.1.5",
-        "@equinor/echo-search": "^0.13.11",
-        "@equinor/echo-update": "^1.3.1",
-        "@equinor/echo-utils": "^0.2.12",
-        "@equinor/eds-core-react": "^0.25.0",
-        "@modular-css/rollup": "^28.3.2",
-        "@rollup/plugin-babel": "^5.3.1",
-        "@rollup/plugin-commonjs": "^22.0.2",
-        "@rollup/plugin-image": "^2.1.1",
-        "@rollup/plugin-json": "^4.1.0",
-        "@rollup/plugin-node-resolve": "^13.3.0",
-        "@rollup/plugin-typescript": "^8.5.0",
-        "@rollup/plugin-url": "^7.0.0",
-        "@svgr/rollup": "^6.5.1",
-        "@testing-library/react-hooks": "^8.0.1",
-        "@types/jest": "^29.4.0",
-        "@types/node": "^18.11.18",
-        "@types/react": "^17.0.53",
-        "@types/react-dom": "^17.0.18",
-        "@types/react-router-dom": "^5.3.3",
-        "@types/styled-components": "5.1.26",
-        "@typescript-eslint/eslint-plugin": "^5.49.0",
-        "@typescript-eslint/parser": "^5.49.0",
-        "@wessberg/rollup-plugin-ts": "^2.0.4",
-        "autoprefixer": "^10.4.13",
-        "babel-jest": "^29.4.0",
-        "eslint": "^8.32.0",
-        "eslint-config-prettier": "^8.6.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-react": "^7.32.1",
-        "eslint-plugin-react-hooks": "^4.6.0",
-        "jest": "^29.4.0",
-        "jest-environment-jsdom": "^29.4.0",
-        "jest-expo": "^47.0.1",
-        "postcss": "^8.4.21",
-        "postcss-assets": "^6.0.0",
-        "postcss-modules": "^4.3.1",
-        "prettier": "^2.8.3",
-        "react": "^17.0.2",
-        "react-dom": "^17.0.2",
-        "react-router-dom": "^5.3.4",
-        "rollup": "^2.79.1",
-        "rollup-plugin-delete": "^2.0.0",
-        "rollup-plugin-postcss": "^4.0.2",
-        "rollup-plugin-terser": "^7.0.2",
-        "rollup-plugin-tslib-resolve-id": "^0.0.0",
-        "rollup-plugin-typescript-paths": "^1.4.0",
-        "rollup-plugin-typescript2": "^0.34.1",
-        "styled-components": "^5.3.6",
-        "ts-jest": "^29.0.5",
-        "tslib": "^2.4.1",
-        "typescript": "=4.9.4"
-    },
-    "compilerOptions": {
-        "declaration": true
-    },
-    "files": [
-        "dist/"
-    ],
-    "engines": {
-        "node": ">=16.8.0",
-        "npm": ">=7.0.0"
-    },
-    "dependencies": {
-        "@microsoft/signalr": "^6.0.13"
-    }
-}
+{
+    "name": "@equinor/echo-framework",
+    "version": "0.10.26-rc0",
+    "description": "Modules and components for EchoWeb, utilizing EchoCore",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "source": "src/index.ts",
+    "repository": "https://github.com/equinor/EchoFramework.git",
+    "author": "Echo Core",
+    "license": "MIT",
+    "private": false,
+    "scripts": {
+        "build": "rollup -c",
+        "build-cli": "npm --prefix ../EchoCli run build",
+        "prebuild-cli": "npm --prefix ../EchoClient run build -- --env=cli=true",
+        "cli-publish": "npm run build-cli",
+        "postcli-publish": "npm --prefix ../EchoCli run echo-publish",
+        "cli-next": "npm run build-cli",
+        "postcli-next": "npm --prefix ../EchoCli run echo-publish-next",
+        "start": "rollup -c -w ",
+        "publish-pk": "npm publish --access public",
+        "echo-publish": "npm publish --access public",
+        "echo-publish-beta": "npm publish --access public --tag beta",
+        "echo-publish-next": "npm publish --access public --tag next",
+        "echo-test": "jest",
+        "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
+        "test-wo-install": "jest --watchAll",
+        "test": "npm ci & jest --watchAll",
+        "test-coverage": "npm ci & jest --coverage --watchAll",
+        "patch": "npm version patch",
+        "major": "npm version major",
+        "minor": "npm version minor",
+        "echo-update": "echo-update",
+        "echo-update-all": "echo-update -a",
+        "yalc-purge": "rmdir \"%APPDATA%/../Local/Yalc/packages/@equinor/echo-framework\" /q /s",
+        "re-yalc": "npm run build && yalc push --sig"
+    },
+    "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-search": ">=0.13.2 < 0.14.0",
+        "@equinor/echo-utils": ">=0.2.12 < 0.3.0",
+        "@equinor/eds-core-react": "^0.25.0",
+        "react": "^17.0.2",
+        "react-dom": "^17.0.2",
+        "react-router-dom": "^5.3.4",
+        "styled-components": "^5.3.6"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.20.12",
+        "@babel/preset-env": "^7.20.2",
+        "@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-scripts": "^0.1.5",
+        "@equinor/echo-search": "^0.13.11",
+        "@equinor/echo-update": "^1.3.1",
+        "@equinor/echo-utils": "^0.2.12",
+        "@equinor/eds-core-react": "^0.25.0",
+        "@modular-css/rollup": "^28.3.2",
+        "@rollup/plugin-babel": "^5.3.1",
+        "@rollup/plugin-commonjs": "^22.0.2",
+        "@rollup/plugin-image": "^2.1.1",
+        "@rollup/plugin-json": "^4.1.0",
+        "@rollup/plugin-node-resolve": "^13.3.0",
+        "@rollup/plugin-typescript": "^8.5.0",
+        "@rollup/plugin-url": "^7.0.0",
+        "@svgr/rollup": "^6.5.1",
+        "@testing-library/react-hooks": "^8.0.1",
+        "@types/jest": "^29.4.0",
+        "@types/node": "^18.11.18",
+        "@types/react": "^17.0.53",
+        "@types/react-dom": "^17.0.18",
+        "@types/react-router-dom": "^5.3.3",
+        "@types/styled-components": "5.1.26",
+        "@typescript-eslint/eslint-plugin": "^5.49.0",
+        "@typescript-eslint/parser": "^5.49.0",
+        "@wessberg/rollup-plugin-ts": "^2.0.4",
+        "autoprefixer": "^10.4.13",
+        "babel-jest": "^29.4.0",
+        "eslint": "^8.32.0",
+        "eslint-config-prettier": "^8.6.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-plugin-react": "^7.32.1",
+        "eslint-plugin-react-hooks": "^4.6.0",
+        "jest": "^29.4.0",
+        "jest-environment-jsdom": "^29.4.0",
+        "jest-expo": "^47.0.1",
+        "postcss": "^8.4.21",
+        "postcss-assets": "^6.0.0",
+        "postcss-modules": "^4.3.1",
+        "prettier": "^2.8.3",
+        "react": "^17.0.2",
+        "react-dom": "^17.0.2",
+        "react-router-dom": "^5.3.4",
+        "rollup": "^2.79.1",
+        "rollup-plugin-delete": "^2.0.0",
+        "rollup-plugin-postcss": "^4.0.2",
+        "rollup-plugin-terser": "^7.0.2",
+        "rollup-plugin-tslib-resolve-id": "^0.0.0",
+        "rollup-plugin-typescript-paths": "^1.4.0",
+        "rollup-plugin-typescript2": "^0.34.1",
+        "styled-components": "^5.3.6",
+        "ts-jest": "^29.0.5",
+        "tslib": "^2.4.1",
+        "typescript": "=4.9.4"
+    },
+    "compilerOptions": {
+        "declaration": true
+    },
+    "files": [
+        "dist/"
+    ],
+    "engines": {
+        "node": ">=16.8.0",
+        "npm": ">=7.0.0"
+    },
+    "dependencies": {
+        "@microsoft/signalr": "^6.0.13",
+        "immer": "^9.0.19",
+        "zustand": "^4.3.2"
+    }
+}