@equinor/echo-framework 0.9.22 → 0.10.0-r18-beta-2

package/dist/hooks/index.d.ts

@@ -1,2 +1,4 @@
 export * from './useEchoHistory';
+export * from './useScreenOrientation';
+export * from './useScreenValues';
 export * from './useTagDetails';

package/dist/hooks/useEchoHistory.d.ts

@@ -1,7 +1,7 @@
-declare type EchoHistoryParams = {
+type EchoHistoryParams = {
     [key: string]: string;
 };
-declare type EchoHistory = (path: string, params?: EchoHistoryParams | undefined, state?: any) => void;
+type EchoHistory = (path: string, params?: EchoHistoryParams | undefined, state?: any) => void;
 /**
  * Hook returns a Echo compliant push function for the browser history
  * Which supports deeplinking functionality via EchoHistoryParams and forces to use instCode.

package/dist/hooks/useIsCompactLayout.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Hook for checking if the current size of the browser window is mobile size.
+ * @returns {boolean} If the current screen is below threshold or not.
+ */
+export declare function useIsCompactLayout(isLandscape: boolean): boolean;

package/dist/hooks/useScreenOrientation.d.ts

@@ -0,0 +1,5 @@
+import { ScreenOrientation } from '../types/hookLibrary';
+/**
+ * @returns {ScreenOrientation}
+ */
+export declare function useScreenOrientation(): ScreenOrientation;

package/dist/hooks/useScreenValues.d.ts

@@ -0,0 +1,13 @@
+import { ScreenOrientation } from '../types/hookLibrary';
+/**
+ * Provides screen values for current screen.
+ *
+ * @returns {boolean} response.isScreenMobileSize If the device screen is small or not
+ * @returns {ScreenOrientation} response.screenOrientation
+ */
+type DeviceValues = {
+    isScreenMobileSize: boolean;
+    screenOrientation: ScreenOrientation;
+};
+export declare function useScreenValues(): DeviceValues;
+export {};

package/dist/hooks/useSemi.d.ts

@@ -13,7 +13,7 @@ export declare function useSemi({ tagNo, instCode }: {
     tagNo: string;
     instCode: string;
 }): Semi;
-declare type Semi = {
+type Semi = {
     isSemiDocumentAvailable: boolean;
     semiDocumentId: string;
     isSemiLoading: boolean;

package/dist/hooks/useWindowSize.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get the current size of the browser window.
+ * @returns {width?: number; height?: number} Width and height of the current browser size.
+
+ */
+export declare function useWindowSize(): {
+    width: number;
+    height: number;
+};

package/dist/index.d.ts

@@ -6,8 +6,15 @@ import { getLegendStatusColor } from './utils/legendUtils';
 export * from './components';
 export * from './coreApplication';
 export { RegisteredHookName } from './hooks/hookLibrary';
+export { useIsCompactLayout } from './hooks/useIsCompactLayout';
+export { useScreenOrientation } from './hooks/useScreenOrientation';
+export { useScreenValues } from './hooks/useScreenValues';
 export { RegisteredComponentName } from './services/componentRegistry/componentRegistry';
+export { DetailedDeviceInformationProvider, detailedDeviceInformationProvider } from './services/deviceInformation/deepDeviceInfo';
+export { deviceInfo, DeviceInformation } from './services/deviceInformation/deviceInfo';
 export * from './services/eventHubActions';
+export * from './services/searchItemDetails/searchItemDetails.store';
+export { SearchItemDetailsContainer } from './services/searchItemDetails/searchItemDetailsContainer';
 export * from './theme/themeConst';
 export type { EchoHubPlant } from './types/echoHubPlant';
 export * from './types/eventTypes';
@@ -17,7 +24,7 @@ export { LegendStatus, LegendType } from './types/legend';
 export type { ModelPermissions } from './types/modelPermissions';
 export { PingableSources } from './types/pingableSources';
 export * from './utils';
-export { getLegendStatusColor, legendTypeToLegendStatus, valueToEnum } from './utils/legendUtils';
+export { getLegendStatusColor, legendTypeToLegendStatus, toLegendStatusOrString, valueToEnum } from './utils/legendUtils';
 export * from './utils/startup';
 export declare const registerEchopediaComponent: ({ name, component }: {
     name: import("./services/componentRegistry/componentRegistry").RegisteredComponentName;
@@ -33,9 +40,19 @@ declare const EchoFramework: Readonly<{
         }>;
     }>;
     Hooks: Readonly<{
+        searchItems: Readonly<{
+            useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState>, "setState"> & {
+                setState(nextStateOrUpdater: import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState | Partial<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState> | ((state: import("immer/dist/internal").WritableDraft<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState>) => void), shouldReplace?: boolean | undefined): void;
+            }>;
+        }>;
         useEchoHistory(): (path: string, params?: {
             [key: string]: string;
         } | undefined, state?: any) => void;
+        useScreenOrientation(): import("./types/hookLibrary").ScreenOrientation;
+        useScreenValues(): {
+            isScreenMobileSize: boolean;
+            screenOrientation: import("./types/hookLibrary").ScreenOrientation;
+        };
         useTagDetails({ instCode, tagNo }: {
             tagNo: string;
             instCode: string;
@@ -52,7 +69,19 @@ declare const EchoFramework: Readonly<{
         useSetActiveMcPackNo: () => import("./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;