@equinor/echo-framework 0.13.1 → 0.14.0-test-0

package/package.json

@@ -1,128 +1,27 @@
 {
-    "name": "@equinor/echo-framework",
-    "version": "0.13.1",
-    "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 Framework",
-    "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.7.0 < 0.8.0",
-        "@equinor/echo-core": ">= 0.8.0 < 0.9.0",
-        "@equinor/echo-search": ">= 0.14.0 < 0.15.0",
-        "@equinor/echo-utils": ">= 0.3.0 < 0.4.0",
-        "@equinor/eds-core-react": "^0.25.0",
-        "@equinor/eds-icons": "^0.17.0",
-        "react": ">= 17.0.2",
-        "react-dom": ">= 17.0.2",
-        "react-router-dom": "^5.3.4",
-        "styled-components": "^5.3.11"
-    },
-    "devDependencies": {
-        "@babel/core": "^7.22.9",
-        "@babel/preset-env": "^7.22.9",
-        "@babel/preset-react": "^7.22.5",
-        "@equinor/echo-base": "^0.6.22",
-        "@equinor/echo-components": "0.7.12",
-        "@equinor/echo-core": "^0.8.0",
-        "@equinor/echo-scripts": "^0.1.5",
-        "@equinor/echo-search": "^0.14.0",
-        "@equinor/echo-update": "^1.3.1",
-        "@equinor/echo-utils": "^0.3.1",
-        "@equinor/eds-core-react": "^0.25.0",
-        "@equinor/eds-icons": "^0.17.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": "^14.0.0",
-        "@types/jest": "^29.5.3",
-        "@types/node": "^18.17.2",
-        "@types/react": "^18.2.18",
-        "@types/react-dom": "^18.2.7",
-        "@types/react-router-dom": "^5.3.3",
-        "@types/styled-components": "5.1.26",
-        "@typescript-eslint/eslint-plugin": "^5.62.0",
-        "@typescript-eslint/parser": "^5.62.0",
-        "@wessberg/rollup-plugin-ts": "^2.0.4",
-        "autoprefixer": "^10.4.14",
-        "babel-jest": "^29.6.2",
-        "eslint": "^8.46.0",
-        "eslint-config-prettier": "^8.10.0",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-react": "^7.33.1",
-        "eslint-plugin-react-hooks": "^4.6.0",
-        "jest": "^29.6.2",
-        "jest-environment-jsdom": "^29.6.2",
-        "jest-expo": "^48.0.2",
-        "postcss": "^8.4.27",
-        "postcss-assets": "^6.0.0",
-        "postcss-modules": "^4.3.1",
-        "prettier": "^2.8.8",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0",
-        "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.35.0",
-        "styled-components": "^5.3.11",
-        "ts-jest": "^29.1.1",
-        "tslib": "^2.6.1",
-        "typescript": "=4.9.5",
-        "user-agent-data-types": "^0.3.1"
-    },
-    "dependencies": {
-        "@microsoft/signalr": "^6.0.20",
-        "immer": "^9.0.21",
-        "zustand": "^4.4.0"
-    },
-    "compilerOptions": {
-        "declaration": true
-    },
-    "files": [
-        "dist/"
-    ],
-    "engines": {
-        "node": ">=16.8.0",
-        "npm": ">=7.0.0"
-    }
+  "name": "@equinor/echo-framework",
+  "version": "0.14.0-test-0",
+  "peerDependencies": {
+    "@equinor/echo-base": ">= 0.6.12 < 0.7.0",
+    "@equinor/echo-components": ">= 0.7.0 < 0.8.0",
+    "@equinor/echo-core": ">= 0.8.0 < 0.9.0",
+    "@equinor/echo-search": ">= 0.14.0 < 0.15.0",
+    "@equinor/echo-utils": ">= 0.3.0 < 0.4.0",
+    "@equinor/eds-core-react": "^0.25.0",
+    "@equinor/eds-icons": "^0.17.0",
+    "react": ">= 17.0.2",
+    "react-dom": ">= 17.0.2",
+    "@microsoft/signalr": "7.0.7",
+    "classnames": "2.3.2",
+    "history": "4.10.1",
+    "lodash": "4.17.21",
+    "react-router-dom": "5.3.4",
+    "ua-parser-js": "1.0.35",
+    "zustand": "4.3.8"
+  },
+  "module": "./index.js",
+  "main": "./index.js",
+  "type": "module",
+  "types": "./src/index.d.ts",
+  "dependencies": {}
 }

package/src/index.d.ts

@@ -0,0 +1,100 @@
+/// <reference types="react" />
+import './lib/globalStyles.css';
+import { getPlantsInfo, getTagDetails } from './lib/services/api';
+import './lib/theme/theme.css';
+import { getLegendStatusColor } from './lib/utils/legendUtils';
+export * from './lib/components';
+export * from './lib/coreApplication';
+export { RegisteredHookName } from './lib/hooks/hookLibrary';
+export { useIsCompactLayout } from './lib/hooks/useIsCompactLayout';
+export { useScreenOrientation } from './lib/hooks/useScreenOrientation';
+export { useScreenValues } from './lib/hooks/useScreenValues';
+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 { SearchItemDetailsContainer } from './lib/services/searchItemDetails/searchItemDetailsContainer';
+export * from './lib/theme/themeConst';
+export * from './lib/types/api-echohub';
+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;
+    component: import("react").FunctionComponent<any>;
+}) => void;
+declare const EchoFramework: Readonly<{
+    Utils: Readonly<{
+        Navigation: Readonly<{
+            goToExternalLink: (link: string, redirect?: boolean | undefined) => void;
+        }>;
+        Color: Readonly<{
+            getLegendStatusColor: typeof getLegendStatusColor;
+        }>;
+    }>;
+    Hooks: Readonly<{
+        searchItems: Readonly<{
+            useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<unknown>, "setState"> & {
+                setState(nextStateOrUpdater: unknown, shouldReplace?: boolean | undefined): void;
+            }>;
+        }>;
+        useEchoHistory(): (path: string, params?: {
+            [key: string]: string;
+        } | undefined, state?: any) => void;
+        useHas3dAccess(plantCode?: string | undefined): boolean;
+        usePlantAvailableIn3d(plantCode?: string | undefined): boolean;
+        usePlantAvailableIn3dWeb(plantCode?: string | undefined): boolean;
+        useScreenOrientation(): import("./lib/types/hookLibrary").ScreenOrientation;
+        useScreenValues(): {
+            isScreenMobileSize: boolean;
+            screenOrientation: import("./lib/types/hookLibrary").ScreenOrientation;
+        };
+        useTagDetails({ instCode, tagNo }: {
+            tagNo: string;
+            instCode: string;
+        }): {
+            tagDetails: import("@equinor/echo-search").TagDetailsDto | undefined;
+            isTagDetailsLoading: boolean;
+            hasError: boolean;
+        };
+        useSetActiveTagNo: () => import("./lib/types/hookLibrary").SetActiveTagNo;
+        useContextMenuDataInfo: (tagNo: string, expanded: boolean, setActivePanel?: (() => void) | undefined) => import("@equinor/echo-components").DataInformation[];
+        useTagData: () => import("./lib/types/hookLibrary").TagData;
+        useIsContextMenuInfoLoading: () => boolean;
+        useSetActiveCommPackNo: () => import("./lib/types/hookLibrary").SetActiveCommPackNo;
+        useSetActiveMcPackNo: () => import("./lib/types/hookLibrary").SetActiveMcPackNo;
+    }>;
+    EchopediaComponentLibrary: Readonly<{
+        /**
+         * @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>} legacy TagItem component
+         */
+        getTagItem: () => import("react").FunctionComponent<any>;
+        /**
+         * 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>} TagListItem component
+         */
+        getTagListItem: () => import("react").FunctionComponent<any>;
+    }>;
+    APIs: Readonly<{
+        getPlantsInfo: typeof getPlantsInfo;
+        getTagDetails: typeof getTagDetails;
+        getTemporarilyEchoHubListFor3D: (instCode: string, request: import("./lib/types/api-echohub").TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined, withoutBaseUrl?: boolean | undefined) => Promise<{
+            app3dUrl: string;
+            web3dUrl: string;
+        }>;
+        createTemporarilyEchoHubListFor3D: (request: import("./lib/types/api-echohub").TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined) => Promise<import("./lib/types/api-echohub").TemporaryHubListCreatedResponse>;
+    }>;
+}>;
+export default EchoFramework;

package/{dist → src/lib}/components/appLinks/AppLinks.d.ts

@@ -1,6 +1,6 @@
-import React from 'react';
-interface AppLinksProps {
-    isHome?: boolean;
-}
-export declare const AppLinks: React.FC<AppLinksProps>;
-export {};
+import React from 'react';
+interface AppLinksProps {
+    isHome?: boolean;
+}
+export declare const AppLinks: React.FC<AppLinksProps>;
+export {};

package/{dist → src/lib}/components/appLinks/applinkUtils.d.ts

@@ -1,2 +1,2 @@
-import { AppLink } from '@equinor/echo-core';
-export declare const addInstCodeParamToAppLink: (appLink: AppLink, instCode: string) => AppLink;
+import { AppLink } from '@equinor/echo-core';
+export declare const addInstCodeParamToAppLink: (appLink: AppLink, instCode: string) => AppLink;

package/{dist → src/lib}/components/appLinks/index.d.ts

@@ -1,2 +1,2 @@
-export * from './AppLinks';
-export * from './linkButton/linkButton';
+export * from './AppLinks';
+export * from './linkButton/linkButton';

package/{dist → src/lib}/components/appLinks/linkButton/linkButton.d.ts

@@ -1,7 +1,7 @@
-import { AppLink } from '@equinor/echo-core';
-import React from 'react';
-export interface LinkButtonProps {
-    appLink: AppLink;
-}
-export declare const LinkButton: React.FC<LinkButtonProps>;
-export default LinkButton;
+import { AppLink } from '@equinor/echo-core';
+import React from 'react';
+export interface LinkButtonProps {
+    appLink: AppLink;
+}
+export declare const LinkButton: React.FC<LinkButtonProps>;
+export default LinkButton;

package/{dist → src/lib}/components/containers/index.d.ts

@@ -1 +1 @@
-export * from './layouts';
+export * from './layouts';

package/{dist → src/lib}/components/containers/layouts.d.ts

@@ -1,7 +1,7 @@
-import React from 'react';
-export type LayoutKey = 'main' | 'nativePdf' | 'colorLayout' | '3dweb' | undefined;
-export interface LayoutProps {
-    layoutKey?: string;
-    children: React.ReactNode;
-}
-export declare const Layout: React.FC<LayoutProps>;
+import React from 'react';
+export type LayoutKey = 'main' | 'nativePdf' | 'colorLayout' | '3dweb' | undefined;
+export interface LayoutProps {
+    layoutKey?: string;
+    children: React.ReactNode;
+}
+export declare const Layout: React.FC<LayoutProps>;

package/{dist → src/lib}/components/contextualAppLinks/contextualAppLinks.context.d.ts

@@ -1,7 +1,7 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-import React from 'react';
-export type ContextualAppLinksContextType = {
-    tag: TagSummaryDto;
-    instCode: string;
-} | undefined;
-export declare const AppLinksContext: React.Context<ContextualAppLinksContextType>;
+import { TagSummaryDto } from '@equinor/echo-search';
+import React from 'react';
+export type ContextualAppLinksContextType = {
+    tag: TagSummaryDto;
+    instCode: string;
+} | undefined;
+export declare const AppLinksContext: React.Context<ContextualAppLinksContextType>;

package/{dist → src/lib}/components/contextualAppLinks/contextualAppLinks.d.ts

@@ -1,9 +1,9 @@
-import { TagSummaryDto } from '@equinor/echo-search';
-import React from 'react';
-type ContextualAppLinksProps = {
-    children: React.ReactNode;
-    tag: TagSummaryDto;
-    instCode: string;
-};
-declare const _default: React.NamedExoticComponent<ContextualAppLinksProps>;
-export default _default;
+import { TagSummaryDto } from '@equinor/echo-search';
+import React from 'react';
+type ContextualAppLinksProps = {
+    children: React.ReactNode;
+    tag: TagSummaryDto;
+    instCode: string;
+};
+declare const _default: React.NamedExoticComponent<ContextualAppLinksProps>;
+export default _default;

package/{dist → src/lib}/components/contextualAppLinks/externalAppsMenu.d.ts

@@ -1,29 +1,29 @@
-import React from 'react';
-type ExternalAppsMenuProp = {
-    children?: React.ReactNode;
-    classNames?: {
-        button?: string;
-        popupMenu?: string;
-    };
-    [key: string]: unknown;
-};
-/**
- * Wrapper component for external application links. To be used inside ContextualAppLinks component.
- * This will render an icon button with external link icon. When the button is clicked, an EDS menu will be shown.
- * Pass any external icons as children inside this component: they will rendered inside the above mentioned menu.
- * This component is extendable: Also renders any external app link icon, which is registered in the EchoCore application state.
- *
- * @param {ExternalAppsMenuProp} props
- * @param {React.ReactNode} props.children Optional: Will be rendered inside the EDS menu
- * @param {Object} props.classNames Optional: custom class names for inner structural DOM elements.
- * @param {string} props.classNames.button Optional: custom class name to be applied to the icon button
- * @param {string} props.classNames.popupMenu Optional: custom class name to be applied to the popup menu
- * @param {unknown} ...rest param: Every other props will be applied on the topmost, wrapper div element.
- *
- * @returns {React.FC<ExternalAppsMenuProp>}
- *
- * @throws {BaseError} If used outside of ContextualAppLinks compound component - requires react context provided by it.
- *
- */
-export declare const ExternalAppsMenu: React.FC<ExternalAppsMenuProp>;
-export {};
+import React from 'react';
+type ExternalAppsMenuProp = {
+    children?: React.ReactNode;
+    classNames?: {
+        button?: string;
+        popupMenu?: string;
+    };
+    [key: string]: unknown;
+};
+/**
+ * Wrapper component for external application links. To be used inside ContextualAppLinks component.
+ * This will render an icon button with external link icon. When the button is clicked, an EDS menu will be shown.
+ * Pass any external icons as children inside this component: they will rendered inside the above mentioned menu.
+ * This component is extendable: Also renders any external app link icon, which is registered in the EchoCore application state.
+ *
+ * @param {ExternalAppsMenuProp} props
+ * @param {React.ReactNode} props.children Optional: Will be rendered inside the EDS menu
+ * @param {Object} props.classNames Optional: custom class names for inner structural DOM elements.
+ * @param {string} props.classNames.button Optional: custom class name to be applied to the icon button
+ * @param {string} props.classNames.popupMenu Optional: custom class name to be applied to the popup menu
+ * @param {unknown} ...rest param: Every other props will be applied on the topmost, wrapper div element.
+ *
+ * @returns {React.FC<ExternalAppsMenuProp>}
+ *
+ * @throws {BaseError} If used outside of ContextualAppLinks compound component - requires react context provided by it.
+ *
+ */
+export declare const ExternalAppsMenu: React.FC<ExternalAppsMenuProp>;
+export {};

package/{dist → src/lib}/components/contextualAppLinks/externalLinkButtons/allExternalLinks.d.ts

@@ -1,12 +1,12 @@
-import React from 'react';
-/**
- * To be used inside ContextualAppLinks component.
- * List of pre-defined external app links.
- * Contains link to: Stid, ProCoSys, Sap, Semi, McApp, SafeX, TR2000.
- *
- * Each link will determine by itself if they should be rendered (or not) based on various conditions, like: the passed tag.
- *
- * @returns {React.FC}
- * @throws {BaseError} If used outside of ContextualAppLinks compound component - requires react context provided by it.
- */
-export declare const AllExternalLinks: React.FC;
+import React from 'react';
+/**
+ * To be used inside ContextualAppLinks component.
+ * List of pre-defined external app links.
+ * Contains link to: Stid, ProCoSys, Sap, Semi, McApp, SafeX, TR2000.
+ *
+ * Each link will determine by itself if they should be rendered (or not) based on various conditions, like: the passed tag.
+ *
+ * @returns {React.FC}
+ * @throws {BaseError} If used outside of ContextualAppLinks compound component - requires react context provided by it.
+ */
+export declare const AllExternalLinks: React.FC;

package/{dist → src/lib}/components/contextualAppLinks/externalLinkButtons/externalLinkButtons.helpers.d.ts

@@ -1,60 +1,60 @@
-import { TagDetailsDto } from '@equinor/echo-search';
-import { ProCoSysApiTag } from '../../../types/api-proCoSysTagResponse';
-type GetTagDetailsAndProCoSysDataResult = {
-    tagDetails: TagDetailsDto | undefined;
-    proCoSysTag: ProCoSysApiTag | undefined;
-    hasError: boolean;
-};
-/**
- * Specific tool for external link buttons to help build URLS for deep linking into ProCoSys web app.
- * Fetches both tag details and tag information from ProCoSys.
- *
- * @param {Object} params
- * @param {string} params.tagNo The tag number to query.
- * @param {string} params.instCode Plant installation code for the given tag.
- * @returns {GetTagDetailsAndProCoSysDataResult} response - The returned promise will resolve once both API calls are resolved. (with Promise.all)
- * @returns {TagDetailsDto} response.tagDetails - Result of tag details API call.
- * @returns {ProCoSysApiTag} response.proCoSysTag - Tag related information from the ProCoSys system.
- * @returns {hasError} response.hasError - indicates if there were any errors during the API calls. The exception is handled under the hood.
- */
-export declare function getTagDetailsAndProCoSysData({ tagNo, instCode }: {
-    tagNo: any;
-    instCode: any;
-}): Promise<GetTagDetailsAndProCoSysDataResult>;
-type getTagDetailsWithErrorHandlingResponse = {
-    tagDetails: TagDetailsDto | undefined;
-    hasError: boolean;
-};
-/**
- * Wraps the 'getTagDetails' function. Handles and logs any Error thrown by it whi;e displaying an error message toast.
- * Use 'getTagDetails' if you want complete freedom on how you handle any exceptions.
- *
- * If there were any errors during the API call, the returned value will have a 'hasError' flag set to 'true'.
- *
- * @param {Object} params
- * @param {string} params.tagNo The tag number to query.
- * @param {string} params.instCode Plant installation code for the given tag.
- * @param {AbortSignal} params.abortSignal A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.
- * @returns {getTagDetailsWithErrorHandlingResponse} response
- * @returns {TagDetailsDto} response.tagDetails - Result of tag details API call.
- * @returns {hasError} response.hasError - indicates if there were any errors during the API call.
- */
-export declare function getTagDetailsWithErrorHandling({ tagNo, instCode }: {
-    tagNo: string;
-    instCode?: string;
-}): Promise<getTagDetailsWithErrorHandlingResponse>;
-/**
- * Replace all non-aplhanumeric characters (eg: '-' and ' ') with a wildcard (*)
- *
- * @param {string} tagNo The tag number
- * @returns New tag number with non-alpha characters replaced
- */
-export declare function replaceNonAlphaCharsWithWildcard(tagNo: string | undefined): string | undefined;
-/**
- * Add a wildcard (*) between number and characters
- *
- * @param {string} tagNo The tag number
- * @returns New tag number with a wildcard (*) between number and characters
- */
-export declare function addWildcardBetweenNumAndChar(tagNo: string | undefined): string | undefined;
-export {};
+import { TagDetailsDto } from '@equinor/echo-search';
+import { ProCoSysApiTag } from '../../../types/api-proCoSysTagResponse';
+type GetTagDetailsAndProCoSysDataResult = {
+    tagDetails: TagDetailsDto | undefined;
+    proCoSysTag: ProCoSysApiTag | undefined;
+    hasError: boolean;
+};
+/**
+ * Specific tool for external link buttons to help build URLS for deep linking into ProCoSys web app.
+ * Fetches both tag details and tag information from ProCoSys.
+ *
+ * @param {Object} params
+ * @param {string} params.tagNo The tag number to query.
+ * @param {string} params.instCode Plant installation code for the given tag.
+ * @returns {GetTagDetailsAndProCoSysDataResult} response - The returned promise will resolve once both API calls are resolved. (with Promise.all)
+ * @returns {TagDetailsDto} response.tagDetails - Result of tag details API call.
+ * @returns {ProCoSysApiTag} response.proCoSysTag - Tag related information from the ProCoSys system.
+ * @returns {hasError} response.hasError - indicates if there were any errors during the API calls. The exception is handled under the hood.
+ */
+export declare function getTagDetailsAndProCoSysData({ tagNo, instCode }: {
+    tagNo: string;
+    instCode: string;
+}): Promise<GetTagDetailsAndProCoSysDataResult>;
+type getTagDetailsWithErrorHandlingResponse = {
+    tagDetails: TagDetailsDto | undefined;
+    hasError: boolean;
+};
+/**
+ * Wraps the 'getTagDetails' function. Handles and logs any Error thrown by it whi;e displaying an error message toast.
+ * Use 'getTagDetails' if you want complete freedom on how you handle any exceptions.
+ *
+ * If there were any errors during the API call, the returned value will have a 'hasError' flag set to 'true'.
+ *
+ * @param {Object} params
+ * @param {string} params.tagNo The tag number to query.
+ * @param {string} params.instCode Plant installation code for the given tag.
+ * @param {AbortSignal} params.abortSignal A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.
+ * @returns {getTagDetailsWithErrorHandlingResponse} response
+ * @returns {TagDetailsDto} response.tagDetails - Result of tag details API call.
+ * @returns {hasError} response.hasError - indicates if there were any errors during the API call.
+ */
+export declare function getTagDetailsWithErrorHandling({ tagNo, instCode }: {
+    tagNo: string;
+    instCode?: string;
+}): Promise<getTagDetailsWithErrorHandlingResponse>;
+/**
+ * Replace all non-aplhanumeric characters (eg: '-' and ' ') with a wildcard (*)
+ *
+ * @param {string} tagNo The tag number
+ * @returns New tag number with non-alpha characters replaced
+ */
+export declare function replaceNonAlphaCharsWithWildcard(tagNo: string | undefined): string | undefined;
+/**
+ * Add a wildcard (*) between number and characters
+ *
+ * @param {string} tagNo The tag number
+ * @returns New tag number with a wildcard (*) between number and characters
+ */
+export declare function addWildcardBetweenNumAndChar(tagNo: string | undefined): string | undefined;
+export {};

package/{dist → src/lib}/components/contextualAppLinks/externalLinkButtons/externalLinkToCommApp.d.ts

@@ -1,14 +1,14 @@
-import React from 'react';
-type ExternalLinkToCommAppProps = {
-    tagNo: string;
-    instCode: string;
-};
-/**
- * External link button to Commissioning web app.
- *
- * @param {string} tagNo The tag's number to open in the Comm app.
- * @param {string} instCode Plant installation code.
- * @returns {React.FC<ExternalLinkToMcAppProps>} React component.
- */
-export declare const ExternalLinkToCommApp: React.FC<ExternalLinkToCommAppProps>;
-export {};
+import React from 'react';
+type ExternalLinkToCommAppProps = {
+    tagNo: string;
+    instCode: string;
+};
+/**
+ * External link button to Commissioning web app.
+ *
+ * @param {string} tagNo The tag's number to open in the Comm app.
+ * @param {string} instCode Plant installation code.
+ * @returns {React.FC<ExternalLinkToMcAppProps>} React component.
+ */
+export declare const ExternalLinkToCommApp: React.FC<ExternalLinkToCommAppProps>;
+export {};

package/{dist → src/lib}/components/contextualAppLinks/externalLinkButtons/externalLinkToConditionAdviser.d.ts

@@ -1,15 +1,15 @@
-import React from 'react';
-type ExternalLinkToConditionAdviserProps = {
-    tagNo: string;
-    instCode: string;
-    loadingStatusCallback?: (isLoading: boolean) => void;
-};
-/**
- * External link button to the Condition Adviser tool.
- *
- * @param {string} tagNo The tag's number to open in the Condition Adviser tool.
- * @param {string} instCode Plant installation code.
- * @returns {React.FC<ExternalLinkToConditionAdviserProps>} React component.
- */
-export declare const ExternalLinkToConditionAdviser: React.FC<ExternalLinkToConditionAdviserProps>;
-export {};
+import React from 'react';
+type ExternalLinkToConditionAdviserProps = {
+    tagNo: string;
+    instCode: string;
+    loadingStatusCallback?: (isLoading: boolean) => void;
+};
+/**
+ * External link button to the Condition Adviser tool.
+ *
+ * @param {string} tagNo The tag's number to open in the Condition Adviser tool.
+ * @param {string} instCode Plant installation code.
+ * @returns {React.FC<ExternalLinkToConditionAdviserProps>} React component.
+ */
+export declare const ExternalLinkToConditionAdviser: React.FC<ExternalLinkToConditionAdviserProps>;
+export {};