@equinor/echo-framework 0.26.7 → 0.26.9

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/components/SSUListItem/SSUListItem.d.ts

@@ -0,0 +1,6 @@
+import { PrepViewSafetyCard } from '../../types/workOrder-safetyCards';
+interface SSUListItemProps {
+    readonly data: PrepViewSafetyCard;
+}
+export declare const SSUListItem: (props: SSUListItemProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/components/SSUListItem/SSUListItemMarker.d.ts

@@ -0,0 +1,5 @@
+interface SSUListItemMarkerProps {
+    readonly severity: number;
+}
+declare function SSUListItemMarker({ severity }: SSUListItemMarkerProps): import("react/jsx-runtime").JSX.Element;
+export { SSUListItemMarker };

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/hooks/usePrepviewWorkOrderSafetyCards.d.ts

@@ -0,0 +1,6 @@
+import { PrepViewSafetyCard } from '../types/workOrder-safetyCards';
+export declare const usePrepviewWorkOrderSafetyCards: (workOrderId: string) => {
+    isLoading: boolean;
+    error: Error | null;
+    safetyCards?: PrepViewSafetyCard[];
+};

package/src/lib/feature/workOrder/components/WorkOrderPanelSafeX/types/workOrder-safetyCards.d.ts

@@ -0,0 +1,16 @@
+export interface PrepViewSafetyCardDto {
+    title: string;
+    description?: string | null;
+    caseDate: string;
+    country?: string | null;
+    url?: string | null;
+    severity: number;
+}
+export interface PrepViewSafetyCard {
+    title: string;
+    description: string;
+    caseDate?: Date;
+    country: string;
+    url: string;
+    severity: number;
+}

package/src/lib/hooks/hookLibrary.d.ts

@@ -11,7 +11,26 @@ export declare enum RegisteredHookName {
 export declare const HookLibrary: Readonly<{
     /**
      * Hook for setting the selected tag application wide.
-     * @returns {SetActiveTagNo}
+     *
+     * @param {SetActiveTagNoArgs | string} argsORtagNo - Arguments for setting the active tag and controlling tag details panel behavior.
+     * If you pass a string, it will be handled as the tagNo
+     * @property {string} argsORtagNo.tagNo - The tag number to activate and open details for.
+     * @property {TagItemContentTabsType} [argsORtagNo.activeTagTab] - The main tab to activate in the tag details panel (e.g., Info, History, etc.).
+     * @property {SubTabType} [argsORtagNo.activeTagSubTab] - The sub-tab to activate within the main tab, if applicable.
+     * @property {string} [argsORtagNo.instCode] - The installation code associated with the tag (for multi-installation contexts).
+     * @property {string} [argsORtagNo.activePanelKey] - The key of the panel to activate (if using multiple panels).
+     * @property {boolean} [argsORtagNo.keepLastNavigationItem] - If true, keeps the last navigation item in the breadcrumb/search flow.
+     * @property {boolean} [argsORtagNo.openInPanel] - If true, opens the tag details in a side panel instead of the main view.
+     * @property {boolean} [argsORtagNo.displayMessageOnItemNotFound] - If true, displays a message if the tag is not found.
+     * @property {boolean} [argsORtagNo.allowToggle] - If true, enables toggle mode (e.g., toggling selection or panel state).
+     * @property {boolean} [argsORtagNo.omitTagNoFromUrl] - If true, omits the tag number from the URL (used only by echo maps; planned for removal).
+     *
+     * @param {TagItemContentTabsType} [activeTagTab] - The active tab for the tag item.
+     * @param {SubTabType} [activeTagSubTab] - The active sub-tab for the tag item.
+     * @param {string} [instCode] - The installation code associated with the tag.
+     * @param {boolean} [openInPanel] - Whether to open the tag details in a panel.
+     * @param {boolean} [displayMessageOnItemNotFound] - Whether to display a message if the tag is not found.
+     * @returns {void}
      */
     useSetActiveTagNo: () => SetActiveTagNo;
     /**

package/src/lib/hooks/useOpenPrepview.d.ts

@@ -1,3 +1,27 @@
+/**
+ * Custom React hook that returns a function to open a "Prepview" panel with specified content and navigation state.
+ *
+ * This hook integrates with the panel management system and search hooks for MC and Comm packages.
+ * The returned function allows opening a panel with a "Prepview" component, handling toggling, navigation state,
+ * and package/tag click events.
+ *
+ * @returns A function that opens a "Prepview" panel with the provided input and options.
+ *
+ * @param args - The arguments for opening the Prepview panel.
+ * @param args.prepviewInput - Input object containing optional identifiers for the item to display:
+ *   - `notificationId` (optional): The notification ID.
+ *   - `workOrderId` (optional): The work order ID.
+ *   - `punchId` (optional): The punch ID.
+ *   - `instCode` (optional): The instrument code.
+ * @param args.panelKey - The key identifying the panel to open.
+ * @param args.keepLastNavigationItem - (optional) Whether to keep the last navigation item in the panel.
+ * @param args.allowToggle - (optional) If true, toggles the panel closed if the same item is already open.
+ *
+ * @remarks
+ * - At least one of `notificationId`, `workOrderId`, or `punchId` should be provided in `prepviewInput`.
+ * - Handles package and tag click events by invoking appropriate search or navigation actions.
+ * - If `allowToggle` is true and the item is already open in the panel, the panel will be closed.
+ */
 export declare function useOpenPrepview(): (args: {
     prepviewInput: {
         notificationId?: string;
@@ -7,4 +31,5 @@ export declare function useOpenPrepview(): (args: {
     };
     panelKey: string;
     keepLastNavigationItem?: boolean;
+    allowToggle?: boolean;
 }) => void;

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

@@ -0,0 +1,13 @@
+export { ReactComponent as ConditionAdviserIcon } from './ConditionAdviserIcon.svg';
+export { ReactComponent as Evision } from './Evision.svg';
+export { ReactComponent as Fusion } from './Fusion.svg';
+export { ReactComponent as McApp } from './McApp.svg';
+export { ReactComponent as NotificationIcon } from './Notification.svg';
+export { ReactComponent as ProCoSysIcon } from './ProCoSysIcon.svg';
+export { ReactComponent as SapLogo } from './SapLogo.svg';
+export { ReactComponent as Stid } from './Stid.svg';
+export { ReactComponent as TR2000 } from './TR2000.svg';
+export { ReactComponent as TrendingAppIcon } from './TrendingAppIcon.svg';
+export { ReactComponent as VivaEngage } from './VivaEngage.svg';
+export { ReactComponent as WorkOrderIcon } from './WorkOrder.svg';
+export { ReactComponent as Yammer } from './Yammer.svg';

package/src/lib/services/eventHubActions/toastActions.d.ts

@@ -3,4 +3,4 @@ import { ToasterEvent } from './../../types/eventTypes/toasterEvent';
  * Emit a Toaster event on echo core eventHub with a specific payload.
  * @param {ToasterEvent} payload
  */
-export declare const displayToast: (payload: ToasterEvent) => void;
+export declare function displayToast(payload: ToasterEvent): Promise<void>;

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

@@ -1,2 +1,3 @@
 export { getLeftPanelNavigationState } from './leftPanelNavigation.store';
+export { isItemOpenInPanel } from './leftPanelNavigation.utils';
 export * from './leftPanelNavigation.store.types';

package/src/lib/services/leftPanelNavigation/leftPanelNavigation.store.types.d.ts

@@ -4,7 +4,6 @@ export type LeftPanelNavigationContent = {
     header?: ReactNode;
     subHeader?: ReactNode;
     itemId?: string;
-    isOpen: boolean;
 };
 export interface LeftPanelNavigationStore {
     addContent: (args: {

package/src/lib/services/leftPanelNavigation/leftPanelNavigation.utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Determines whether a specific item is currently open in a given left panel.
+ *
+ * @param args - An object containing:
+ *   - `itemId`: The unique identifier of the item to check.
+ *   - `panelKey` (optional): The key of the panel to check. If not provided, defaults to `ECHO_CORE_SEARCH`.
+ * @returns `true` if the item with the specified `itemId` is the last item in the specified panel and the panel is currently active; otherwise, `false`.
+ */
+export declare function isItemOpenInPanel(args: {
+    itemId: string;
+    panelKey: string;
+}): boolean;

package/src/lib/types/dataAccess/dataAccessLinks.d.ts

@@ -0,0 +1,34 @@
+export declare const dataAccessLinks: {
+    Y0900: {
+        label: string;
+        url: string;
+    };
+    YT105: {
+        label: string;
+        url: string;
+    };
+    Y0018: {
+        label: string;
+        url: string;
+    };
+    YO017: {
+        label: string;
+        url: string;
+    };
+    UserAccessIOCSolutions: {
+        label: string;
+        url: string;
+    };
+    DataAccessIOCSolutions: {
+        label: string;
+        url: string;
+    };
+    STIDReadInternal: (plantName: string) => {
+        label: string;
+        url: string;
+    };
+    ProCoSys: (plantName: string) => {
+        label: string;
+        url: string;
+    };
+};

package/src/lib/types/dataAccess/index.d.ts

@@ -0,0 +1 @@
+export type { dataAccessLinks } from './dataAccessLinks';

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

@@ -7,6 +7,7 @@ export type SetActiveTagNo = (argsORtagNo: string | {
     keepLastNavigationItem?: boolean;
     openInPanel?: boolean;
     displayMessageOnItemNotFound?: boolean;
+    allowToggle?: boolean;
     omitTagNoFromUrl?: boolean;
 }, activeTagTab?: string, activeTagSubTab?: string, instCode?: string, openInPanel?: boolean, displayMessageOnItemNotFound?: boolean) => void;
 export type TagData = [(tagNo: string, instCode: string) => void];

package/src/lib/utils/asyncUtils.d.ts

@@ -8,4 +8,6 @@
 export declare function fireAndForget(asyncFunc: () => Promise<void>, options: {
     userFriendlyErrorMessage: string;
     displayToast?: boolean;
+    preAction?: () => void;
+    postAction?: () => void;
 }): void;