@equinor/echo-framework 4.2.0 → 4.3.0-beta-0

package/src/lib/feature/legend/types/legendStrategy.type.d.ts

@@ -1,5 +1,5 @@
 import { Marker } from './legendMarkerBadge.type';
-import { LegendDataId, LegendId, LegendOptionConfig } from './legendType';
+import { LegendBadgeOptionConfig, LegendDataId, LegendId, LegendMarkerOptionConfig } from './legendType';
 /**
  * A general interface for the legend strategy. This enables us to automatically render all the legend ui parts: the ui with selectable options, the markers & the badges.
  * The specific implementation (like tagStrategy, equipmentStrategy, etc) will implement this, and inject it with legendFacade.injectLegendStrategy.
@@ -12,21 +12,21 @@ export interface LegendStrategy {
     /**
      * Marker options that is selectable by the user.
      */
-    markerOptions?: ReadonlyArray<LegendOptionConfig>;
+    markerOptions?: ReadonlyArray<LegendMarkerOptionConfig>;
     /**
      * Badge options that is selectable by the user.
+     * Each badge option can have enableDisplayOptions: true to show display options (id, count, displayName).
+     * The displayOption property controls how the badge text is rendered.
      */
-    badgeOptions?: ReadonlyArray<LegendOptionConfig>;
-    getBadgeTextOptions?: (selectedBadgeOption: LegendOptionConfig) => ReadonlyArray<string> | undefined;
+    badgeOptions?: ReadonlyArray<LegendBadgeOptionConfig>;
     /**
      * Returns 1 marker with badges for each incoming itemId. The viewport will make them unique when needed, and
      * also split into groups based on (global) selection tree
      *
      * @param itemIds - The legend data IDs to create markers for
-     * @param isViewport - Optional use this for rendering different markers/badges in viewport compared to legendRenderer. For example equipmentLegend, where we render part-type name in legendRenderer, but id in viewport.
      * @returns Array of markers with badges, 1 marker with badges for each incoming itemId
      */
-    useMarkers: (itemIds: ReadonlyArray<LegendDataId>, isViewport?: boolean) => ReadonlyArray<Marker>;
+    useMarkers: (itemIds: ReadonlyArray<LegendDataId>) => ReadonlyArray<Marker>;
     /**
      * Returns popover content that supports pagination for the given legendDataId.
      * One legendDataId can have multiple items associated with it, for example a tag can have multiple work orders.

package/src/lib/feature/legend/types/legendType.d.ts

@@ -1,3 +1,4 @@
+import type { NotificationDto } from '@equinor/echo-search';
 import { Brand } from '@equinor/echo-utils';
 import { GlobalSelectionTypes } from '../../globalSelection';
 export type KnownLegendIds = 'Equipment Legend' | 'Tag Legend' | 'Work Order Legend' | 'Notification Legend';
@@ -9,20 +10,17 @@ export declare const knownLegendIds: {
     workOrderLegendId: LegendId;
     notificationLegendId: LegendId;
 };
-export interface LegendState {
+export interface LegendState<MarkerOptionType = string, BadgeOptionType = string> {
     readonly legendId: LegendId;
     readonly isEnabled: boolean;
     readonly isLoading: boolean;
-    readonly selectedMarkerOption: LegendOptionConfig;
-    readonly selectedBadgeOption: LegendOptionConfig;
-    readonly selectedBadgeTextOptions: Record<string, string>;
+    readonly selectedMarkerOption: LegendMarkerOptionConfig<MarkerOptionType>;
+    readonly selectedBadgeOption: LegendBadgeOptionConfig<BadgeOptionType>;
 }
 export type LegendTagId = GlobalSelectionTypes.TagId;
 export type LegendEquipmentId = GlobalSelectionTypes.EquipmentId;
 export type LegendWorkOrderId = GlobalSelectionTypes.WorkOrderId;
-export type LegendNotificationId = {
-    testId: string;
-};
+export type LegendNotificationId = Pick<NotificationDto, 'maintenanceRecordId'>;
 /**
  * Union of LegendDataId types that correspond to global selection item IDs.
  * These can be safely used with globalSelectionUtils.
@@ -32,18 +30,27 @@ export type LegendNotificationId = {
  * 2. Go to legendDataId.utils.ts and update selectionGuards (this will cause a compile error until you add a guard for the new type)
  */
 export type GlobalSelectionLegendDataId = LegendTagId | LegendEquipmentId | LegendWorkOrderId;
-type NonGlobalSelectionLegendDataId = LegendNotificationId;
+export type NonGlobalSelectionLegendDataId = LegendNotificationId;
 export type LegendDataId = GlobalSelectionLegendDataId | NonGlobalSelectionLegendDataId;
-export interface LegendOptionConfig<T = string> {
-    propertyName: T;
-    /**
-     * The idea with this is to use it with general rules for strategies US.
-     * Indicates whether the propertyName corresponds to a field in an object structure.
-     * When true, propertyName refers to an actual field in a data object.
-     * When false, propertyName is just a string identifier not tied to object fields.
-     * Comment it in when it is needed.
-     */
-    displayName: string;
-    showChipsInViewportOnly?: boolean;
+/**
+ * Base configuration for legend options (markers and badges).
+ */
+interface LegendOptionConfigBase<T = string> {
+    readonly propertyName: T;
+    readonly displayName: string;
+    readonly showChipsInViewportOnly?: boolean;
+}
+export type LegendMarkerOptionConfig<T = string> = LegendOptionConfigBase<T>;
+/**
+ * Configuration for badge options. Badges can have display options to control
+ * how badge text is rendered (displayName, id, or count).
+ */
+export interface LegendBadgeOptionConfig<T = string> extends LegendOptionConfigBase<T> {
+    readonly enableDisplayOptions?: boolean;
+    readonly displayOption?: LegendOptionDisplayOption;
 }
+export type LegendOptionConfig<T = string> = LegendMarkerOptionConfig<T> | LegendBadgeOptionConfig<T>;
+export declare const ID_MODE_KEYWORD = "id";
+export declare const COUNT_MODE_KEYWORD = "count";
+export type LegendOptionDisplayOption = 'displayName' | typeof ID_MODE_KEYWORD | typeof COUNT_MODE_KEYWORD;
 export {};

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

@@ -1,3 +1,9 @@
+/**
+ * Hook that returns a callback to open a standard PDF file in the viewer.
+ * Navigates to `/viewer` with `docNo`, `fileId`, and `revNo` as query params.
+ *
+ * @returns A callback that accepts `{ instCode, docNo, fileId, revNo, tagNo? }` and navigates to the viewer.
+ */
 export declare function useOpenPdfFile(): (args: {
     instCode: string;
     docNo: string;
@@ -5,6 +11,12 @@ export declare function useOpenPdfFile(): (args: {
     revNo: string;
     tagNo?: string;
 }) => void;
+/**
+ * Hook that returns a callback to open a loop file (external URL) in the viewer.
+ * Navigates to `/viewer` with `fileUrl` as query param instead of `fileId`.
+ *
+ * @returns A callback that accepts `{ instCode, fileUrl, tagNo? }` and navigates to the viewer.
+ */
 export declare function useOpenPdfFileUrl(): (args: {
     instCode: string;
     fileUrl: string;

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

@@ -6,8 +6,8 @@ import { ScreenOrientation } from '../types/hookLibrary';
  * @returns {ScreenOrientation} response.screenOrientation
  */
 type DeviceValues = {
-    isScreenMobileSize: boolean;
-    screenOrientation: ScreenOrientation;
+    readonly isScreenMobileSize: boolean;
+    readonly screenOrientation: ScreenOrientation;
 };
 export declare function useScreenValues(): DeviceValues;
 export {};

package/src/lib/services/dataLayerPanel/dataLayerPanel.store.d.ts

@@ -30,6 +30,7 @@ interface DataLayerPanelActions {
     toggleEquipmentsFromSelectionVisible: () => void;
     setEquipmentsForEcm: () => void;
     toggleIocAnnotations: () => void;
+    toggleNotifications: () => void;
     setIsDataFromStidAnnoDetails: (value: boolean) => void;
 }
 export type DataLayerPanelStore = DataLayerPanelState & DataLayerPanelActions;
@@ -74,6 +75,7 @@ export declare const useDataLayerPanelStore: import("zustand").UseBoundStore<Omi
         toggleEquipmentsFromSelectionVisible: () => void;
         setEquipmentsForEcm: () => void;
         toggleIocAnnotations: () => void;
+        toggleNotifications: () => void;
         setIsDataFromStidAnnoDetails: (value: boolean) => void;
     }) => void), shouldReplace?: boolean | undefined, action?: string | {
         type: string;

package/src/lib/feature/globalSelection/components/SelectionActionBar/SelectionFeedbackDisplay.d.ts

@@ -1,7 +0,0 @@
-import type { SelectionFeedbackType } from './selectionFeedback.types';
-interface SelectionFeedbackDisplayProps {
-    readonly feedbackType: SelectionFeedbackType;
-    readonly className?: string;
-}
-export declare const SelectionFeedbackDisplay: React.FC<SelectionFeedbackDisplayProps>;
-export {};

package/src/lib/feature/globalSelection/components/SelectionActionBar/selectionFeedback.types.d.ts

@@ -1 +0,0 @@
-export type SelectionFeedbackType = 'added' | 'removed' | 'addError' | 'removeError' | 'colorChanged' | 'colorChangeError';

package/src/lib/feature/globalSelection/components/SelectionMenuTrigger/SelectionGroupMenuItem.d.ts

@@ -1,9 +0,0 @@
-import { Guid } from '@equinor/echo-utils';
-import { SelectionGroup } from '../../selectionMenu/selectionTreeStore/selectionTree.store.types';
-interface SelectionGroupMenuItemProps {
-    readonly group: SelectionGroup;
-    readonly isItemInGroup: boolean;
-    readonly onSelectionChanged: (groupId: Guid) => void;
-}
-export declare const SelectionGroupMenuItem: (props: SelectionGroupMenuItemProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/src/lib/feature/globalSelection/components/SelectionMenuTrigger/SelectionMenuTrigger.d.ts

@@ -1,12 +0,0 @@
-import { Guid } from '@equinor/echo-utils';
-import { GlobalSelectionTypes } from '../../globalSelectionStore/globalSelectionStore.types';
-interface SelectionMenuTriggerProps {
-    readonly itemId: GlobalSelectionTypes.ItemId;
-    readonly onAddToSelection: (groupId: Guid) => void;
-    readonly onRemoveFromSelection: (groupId: Guid) => void;
-    readonly partOfListsText?: string;
-    readonly isError?: boolean;
-    readonly isLoading?: boolean;
-}
-export declare const SelectionMenuTrigger: (props: SelectionMenuTriggerProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/src/lib/feature/legend/components/legendTextSelector/LegendTextSelector.d.ts

@@ -1,20 +0,0 @@
-interface LegendTextSelectorProps<T extends string> {
-    options: ReadonlyArray<T>;
-    selectedOption: T;
-    onOptionSelected?: (option: T, e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
-}
-/**
- * LegendTextSelector renders a group of selectable buttons for legend text options.
- *
- * Displays each option as a button, highlights the currently selected option, and calls the `onSelect` callback when a different option is chosen.
- * Uses Echo UI components and compact density for consistent styling.
- *
- * @component
- * @param {object} props - Component props
- * @param {ReadonlyArray<string>} props.options - List of selectable options.
- * @param {string} props.selectedOption - The currently selected option.
- * @param {(option: string) => void} [props.onOptionSelected] - Callback invoked when a new option is selected.
- * @returns {JSX.Element | null} The rendered button group, or null if no options are provided.
- */
-export declare const LegendTextSelector: <T extends string>(props: LegendTextSelectorProps<T>) => import("react/jsx-runtime").JSX.Element | null;
-export {};

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/components/WorkOrderPopoverPrimaryRow.d.ts

@@ -1,15 +0,0 @@
-/**
- * Renders the primary (first) row of the Work Order popover.
- *
- * Displays the work order number, an active/completed status label, and (if present)
- * a list of unique notification type identifiers resolved for the work order.
- *
- * @param props \- Component props.
- * @param props.workOrderId \- Work order identifier used for display and for fetching related objects.
- * @param props.isActive \- Whether the work order is active \(`true`\) or completed \(`false`\).
- * @returns A React element containing the primary row content.
- */
-export declare const WorkOrderPopoverPrimaryRow: ({ workOrderId, isActive }: {
-    workOrderId: string;
-    isActive: boolean;
-}) => import("react/jsx-runtime").JSX.Element;

package/src/lib/feature/legend/legendStrategies/workOrderStrategy/components/WorkOrderPopoverThirdRow.d.ts

@@ -1,16 +0,0 @@
-/**
- * Renders the 3rd row in the Work Order popover (plant, work center, and finish date).
- *
- * @param props \- Component props.
- * @param props.plantNo \- The plant identifier/number to display.
- * @param props.workCenter \- The work center identifier to display.
- * @param props.basicFinishDateTime \- Optional planned/basic finish date/time for the work order.
- * @param props.basicFinishDateStatus \- Optional status label associated with the finish date (e.g. overdue, upcoming).
- * @returns A React element containing the 3rd row content.
- */
-export declare const WorkOrderPopoverThirdRow: ({ plantNo, workCenter, basicFinishDateTime, basicFinishDateStatus }: {
-    plantNo: string;
-    workCenter: string;
-    basicFinishDateTime: Date | undefined;
-    basicFinishDateStatus: string | undefined;
-}) => import("react/jsx-runtime").JSX.Element;