@ama-mfe/ng-utils 14.0.0-next.0 → 14.0.0-next.10

package/index.d.ts

@@ -1,12 +1,61 @@
 import * as i0 from '@angular/core';
 import { PipeTransform } from '@angular/core';
-import { VersionedMessage, RoutedMessage, PeerConnectionOptions } from '@amadeus-it-group/microfrontends';
-import { MessagePeerServiceType, MessagePeerConfig } from '@amadeus-it-group/microfrontends-angular';
-export { MessagePeerConfig as ConnectionConfig, MessagePeerService as ConnectionService } from '@amadeus-it-group/microfrontends-angular';
-import { ResizeMessage, ResizeV1_0, NavigationMessage, NavigationV1_0, ThemeMessage, ThemeV1_0, ThemeStructure } from '@ama-mfe/messages';
-import * as rxjs from 'rxjs';
 import { SafeResourceUrl } from '@angular/platform-browser';
 import { Logger } from '@o3r/logger';
+import { MessagePeerConfig, MessagePeerServiceType } from '@amadeus-it-group/microfrontends-angular';
+export { MessagePeerConfig as ConnectionConfig, MessagePeerService as ConnectionService } from '@amadeus-it-group/microfrontends-angular';
+import { UserActivityMessage, HistoryMessage, HistoryV1_0, NavigationMessage, NavigationV1_0, ResizeMessage, ResizeV1_0, ThemeMessage, ThemeV1_0, ThemeStructure, UserActivityEventType, UserActivityMessageV1_0 } from '@ama-mfe/messages';
+import { VersionedMessage, RoutedMessage, PeerConnectionOptions } from '@amadeus-it-group/microfrontends';
+import * as rxjs from 'rxjs';
+
+declare class ConnectDirective {
+    /**
+     * The connection ID required for the message peer service.
+     */
+    connect: i0.InputSignal<string>;
+    /**
+     * The sanitized source URL for the iframe.
+     */
+    src: i0.InputSignal<SafeResourceUrl | undefined>;
+    /**
+     * Binds the `src` attribute of the iframe to the sanitized source URL.
+     */
+    get srcAttr(): SafeResourceUrl | undefined;
+    private readonly messageService;
+    private readonly domSanitizer;
+    private readonly iframeElement;
+    private readonly clientOrigin;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<ConnectDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ConnectDirective, "iframe[connect]", never, { "connect": { "alias": "connect"; "required": true; "isSignal": true; }; "src": { "alias": "src"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/** Options to configure the connection inside the communication protocol */
+interface ConnectionConfigOptions extends Omit<MessagePeerConfig, 'id'> {
+    /** @inheritdoc */
+    id?: string;
+    /** Logger used to gather information */
+    logger?: Logger;
+}
+/**
+ * Provide the communication protocol connection configuration
+ * @param connectionConfigOptions The identifier of the application in the communication protocol ecosystem plus the types of messages able to exchange and a logger object
+ */
+declare function provideConnection(connectionConfigOptions?: ConnectionConfigOptions): i0.EnvironmentProviders;
+
+/**
+ * Gets the available consumers and formats them into a {@link DeclareMessages} object.
+ * @param consumers - The list of registered message consumers.
+ * @returns The formatted DeclareMessages object.
+ */
+declare const getAvailableConsumers: (consumers: BasicMessageConsumer[]) => {
+    type: "declare_messages";
+    version: "1.0";
+    messages: {
+        type: string;
+        version: string;
+    }[];
+};
 
 /** the error message type */
 declare const ERROR_MESSAGE_TYPE = "error";
@@ -51,18 +100,10 @@ declare const isErrorMessage: (message: any) => message is VersionedMessage & {
 } & ErrorContent;
 
 /**
- * Gets the available consumers and formats them into a {@see DeclareMessages} object.
- * @param consumers - The list of registered message consumers.
- * @returns The formatted DeclareMessages object.
+ * Type guard to check if a message is a user activity message
+ * @param message The message to check
  */
-declare const getAvailableConsumers: (consumers: BasicMessageConsumer[]) => {
-    type: "declare_messages";
-    version: "1.0";
-    messages: {
-        type: string;
-        version: string;
-    }[];
-};
+declare function isUserActivityMessage(message: unknown): message is UserActivityMessage;
 
 /**
  * Use the message payload to execute an action based on message type
@@ -183,92 +224,120 @@ declare const registerProducer: (producer: MessageProducer) => void;
 declare const registerConsumer: (consumer: MessageConsumer) => void;
 
 /**
- * This service listens for resize messages and updates the height of elements based on the received messages.
+ * A service that handles history messages.
+ *
+ * This service listens for history messages and navigates accordingly.
  */
-declare class ResizeConsumerService implements MessageConsumer<ResizeMessage> {
-    private readonly newHeight;
-    /**
-     * A readonly signal that provides the new height information from the channel.
-     */
-    readonly newHeightFromChannel: i0.Signal<{
-        height: number;
-        channelId: string;
-    } | undefined>;
+declare class HistoryConsumerService implements MessageConsumer<HistoryMessage> {
     /**
-     * The type of messages this service handles ('resize').
+     * The type of messages this service handles.
      */
-    readonly type = "resize";
+    readonly type = "history";
     /**
-     * The supported versions of resize messages and their handlers.
+     * @inheritdoc
      */
-    supportedVersions: {
+    readonly supportedVersions: {
         /**
-         * Use the message paylod to compute a new height and emit it via the public signal
+         * Use the message payload to navigate in the history
          * @param message message to consume
          */
-        '1.0': (message: RoutedMessage<ResizeV1_0>) => void;
+        '1.0': (message: RoutedMessage<HistoryV1_0>) => void;
     };
     private readonly consumerManagerService;
     constructor();
     /**
-     * Starts the resize handler service by registering it into the consumer manager service.
+     * @inheritdoc
      */
     start(): void;
     /**
-     * Stops the resize handler service by unregistering it from the consumer manager service.
+     * @inheritdoc
      */
     stop(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ResizeConsumerService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ResizeConsumerService>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HistoryConsumerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HistoryConsumerService>;
 }
 
 /**
- * This service observe changes in the document's body height.
- * When the height changes, it sends a resize message with the new height, to the connected peers
+ * Provides necessary overrides to make the module navigation in history work in an embedded context :
+ * - Prevent pushing states to history, replace state instead
+ * - Handle history navigation via History messages to let the host manage the states
  */
-declare class ResizeService implements MessageProducer<ResizeMessage> {
-    private actualHeight?;
-    private readonly messageService;
-    private resizeObserver?;
+declare function provideHistoryOverrides(): i0.EnvironmentProviders;
+
+/**
+ * Search parameter to add to the URL when embedding an iframe containing the URL of the host.
+ * This is needed to support Firefox (on which {@link https://developer.mozilla.org/docs/Web/API/Location/ancestorOrigins | location.ancestorOrigins} is not currently supported)
+ * in case of redirection inside the iframe.
+ */
+declare const MFE_HOST_URL_PARAM = "ama-mfe-host-url";
+/**
+ * Search parameter to add to the URL to let a module know on which application it's embedded
+ */
+declare const MFE_HOST_APPLICATION_ID_PARAM = "ama-mfe-host-app-id";
+/**
+ * Search parameter to add to the URL to identify the application in the network of peers in the communication protocol
+ */
+declare const MFE_MODULE_APPLICATION_ID_PARAM = "ama-mfe-module-app-id";
+/** The list of query parameters which can be set by the host */
+declare const hostQueryParams: string[];
+/**
+ * Information set up at host level to use in embedded context
+ */
+interface MFEHostInformation {
     /**
-     * @inheritdoc
+     * URL of the host application
      */
-    readonly types = "resize";
-    constructor();
+    hostURL?: string;
     /**
-     * @inheritdoc
+     * ID of the host application
      */
-    handleError(message: ErrorContent<ResizeMessage>): void;
+    hostApplicationId?: string;
     /**
-     * This method sets up a `ResizeObserver` to observe changes in the document's body height.
-     * When the height changes, it sends a resize message with the new height, to the connected peers
+     * ID of the module to embed defined at host level
      */
-    startResizeObserver(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ResizeService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ResizeService>;
+    moduleApplicationId?: string;
 }
+/**
+ * Gather the host information from the url parameters
+ * The host url will use the first found among:
+ * - look for the search parameter {@link MFE_HOST_URL_PARAM} in the URL of the iframe
+ * - use the first item in `location.ancestorOrigins` (currently not supported on Firefox)
+ * - use `document.referrer` (will only work if called before any redirection in the iframe)
+ * The host application ID is taken from the search parameter {@link MFE_HOST_APPLICATION_ID_PARAM} in the URL of the iframe
+ * The module application ID is taken from the search parameter {@link MFE_APPLICATION_ID_PARAM} in the URL of the iframe
+ * @param locationParam - A {@link Location} object with information about the current location of the document. Defaults to global {@link location}.
+ */
+declare function getHostInfo(locationParam?: Location): MFEHostInformation;
+/**
+ * Gather the host information from the url parameters and handle the persistence in session storage.
+ */
+declare function persistHostInfo(): void;
 
 /**
- * A directive that adjusts the height of an element based on resize messages from a specified channel.
+ * A pipe that adds the host information in the URL of an iframe,
  */
-declare class ScalableDirective {
-    /**
-     * The connection ID for the element, used as channel id backup
-     */
-    connect: i0.InputSignal<string | undefined>;
-    /**
-     * The channel id
-     */
-    scalable: i0.InputSignal<string | undefined>;
-    private readonly resizeHandler;
+declare class HostInfoPipe implements PipeTransform {
+    private readonly domSanitizer;
     /**
-     * This signal checks if the current channel requesting the resize matches the channel ID from the resize handler.
-     * If they match, it returns the new height information; otherwise, it returns undefined.
+     * Transforms the given URL or SafeResourceUrl by appending query parameters.
+     * @param url - The URL or SafeResourceUrl to be transformed.
+     * @param options - hostId and moduleId
+     * @returns - The transformed SafeResourceUrl or undefined if the input URL is invalid.
      */
-    private readonly newHeightFromChannel;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScalableDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ScalableDirective, "[scalable]", never, { "connect": { "alias": "connect"; "required": false; "isSignal": true; }; "scalable": { "alias": "scalable"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+    transform(url: string, options: {
+        hostId: string;
+        moduleId?: string;
+    }): string;
+    transform(url: SafeResourceUrl, options: {
+        hostId: string;
+        moduleId?: string;
+    }): SafeResourceUrl;
+    transform(url: undefined, options: {
+        hostId: string;
+        moduleId?: string;
+    }): undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HostInfoPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<HostInfoPipe, "hostInfo", true>;
 }
 
 /**
@@ -327,6 +396,48 @@ declare class NavigationConsumerService implements MessageConsumer<NavigationMes
     static ɵprov: i0.ɵɵInjectableDeclaration<NavigationConsumerService>;
 }
 
+/**
+ * Options for restoring a route with optional query parameters and memory channel ID.
+ */
+interface RestoreRouteOptions {
+    /**
+     * Whether to propagate query parameters from the top window to the module URL.
+     */
+    propagateQueryParams?: boolean;
+    /**
+     * Whether to override existing query parameters in the module URL with those from the top window.
+     */
+    overrideQueryParams?: boolean;
+    /**
+     * The memory channel ID used to retrieve the memorized route.
+     * If provided, the memorized route associated with this ID will be used.
+     */
+    memoryChannelId?: string;
+}
+/**
+ * A pipe that restores a route with optional query parameters and memory channel ID.
+ *
+ * This pipe is used to transform a URL or SafeResourceUrl by appending query parameters
+ * and adjusting the pathname based on the current active route and memorized route.
+ */
+declare class RestoreRoute implements PipeTransform {
+    private readonly activeRoute;
+    private readonly domSanitizer;
+    private readonly routeMemorizeService;
+    private readonly window;
+    /**
+     * Transforms the given URL or SafeResourceUrl by appending query parameters and adjusting the pathname.
+     * @param url - The URL or SafeResourceUrl to be transformed.
+     * @param options - Optional parameters to control the transformation. {@link RestoreRouteOptions}
+     * @returns - The transformed SafeResourceUrl or undefined if the input URL is invalid.
+     */
+    transform(url: string, options?: Partial<RestoreRouteOptions>): string;
+    transform(url: SafeResourceUrl, options?: Partial<RestoreRouteOptions>): SafeResourceUrl;
+    transform(url: undefined, options?: Partial<RestoreRouteOptions>): undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RestoreRoute, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<RestoreRoute, "restoreRoute", true>;
+}
+
 declare class RouteMemorizeDirective {
     /**
      * Whether to memorize the route.
@@ -403,6 +514,7 @@ declare class RoutingService implements MessageProducer<NavigationMessage>, Mess
     private readonly activatedRoute;
     private readonly messageService;
     private readonly logger;
+    private readonly window;
     /**
      * @inheritdoc
      */
@@ -435,7 +547,7 @@ declare class RoutingService implements MessageProducer<NavigationMessage>, Mess
      * Handles embedded routing by listening to router events and sending navigation messages to the connected endpoints.
      * It can be a parent window or another iframe
      * @note - This method has to be called in an injection context
-     * @param options - Optional parameters to control the routing behavior {@see RoutingServiceOptions}.
+     * @param options - Optional parameters to control the routing behavior {@link RoutingServiceOptions}.
      */
     handleEmbeddedRouting(options?: RoutingServiceOptions): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RoutingService, never>;
@@ -443,44 +555,92 @@ declare class RoutingService implements MessageProducer<NavigationMessage>, Mess
 }
 
 /**
- * Options for restoring a route with optional query parameters and memory channel ID.
+ * This service listens for resize messages and updates the height of elements based on the received messages.
  */
-interface RestoreRouteOptions {
+declare class ResizeConsumerService implements MessageConsumer<ResizeMessage> {
+    private readonly newHeight;
     /**
-     * Whether to propagate query parameters from the top window to the module URL.
+     * A readonly signal that provides the new height information from the channel.
      */
-    propagateQueryParams?: boolean;
+    readonly newHeightFromChannel: i0.Signal<{
+        height: number;
+        channelId: string;
+    } | undefined>;
     /**
-     * Whether to override existing query parameters in the module URL with those from the top window.
+     * The type of messages this service handles ('resize').
      */
-    overrideQueryParams?: boolean;
+    readonly type = "resize";
     /**
-     * The memory channel ID used to retrieve the memorized route.
-     * If provided, the memorized route associated with this ID will be used.
+     * The supported versions of resize messages and their handlers.
      */
-    memoryChannelId?: string;
-}
-/**
- * A pipe that restores a route with optional query parameters and memory channel ID.
- *
- * This pipe is used to transform a URL or SafeResourceUrl by appending query parameters
- * and adjusting the pathname based on the current active route and memorized route.
- */
-declare class RestoreRoute implements PipeTransform {
-    private readonly activeRoute;
-    private readonly domSanitizer;
-    private readonly routeMemorizeService;
-    /**
-     * Transforms the given URL or SafeResourceUrl by appending query parameters and adjusting the pathname.
-     * @param url - The URL or SafeResourceUrl to be transformed.
-     * @param options - Optional parameters to control the transformation. {@see RestoreRouteOptions}
-     * @returns - The transformed SafeResourceUrl or undefined if the input URL is invalid.
+    supportedVersions: {
+        /**
+         * Use the message paylod to compute a new height and emit it via the public signal
+         * @param message message to consume
+         */
+        '1.0': (message: RoutedMessage<ResizeV1_0>) => void;
+    };
+    private readonly consumerManagerService;
+    constructor();
+    /**
+     * Starts the resize handler service by registering it into the consumer manager service.
      */
-    transform(url: string, options?: Partial<RestoreRouteOptions>): string;
-    transform(url: SafeResourceUrl, options?: Partial<RestoreRouteOptions>): SafeResourceUrl;
-    transform(url: undefined, options?: Partial<RestoreRouteOptions>): undefined;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RestoreRoute, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<RestoreRoute, "restoreRoute", true>;
+    start(): void;
+    /**
+     * Stops the resize handler service by unregistering it from the consumer manager service.
+     */
+    stop(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ResizeConsumerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ResizeConsumerService>;
+}
+
+/**
+ * This service observe changes in the document's body height.
+ * When the height changes, it sends a resize message with the new height, to the connected peers
+ */
+declare class ResizeService implements MessageProducer<ResizeMessage> {
+    private actualHeight?;
+    private readonly messageService;
+    private resizeObserver?;
+    /**
+     * @inheritdoc
+     */
+    readonly types = "resize";
+    constructor();
+    /**
+     * @inheritdoc
+     */
+    handleError(message: ErrorContent<ResizeMessage>): void;
+    /**
+     * This method sets up a `ResizeObserver` to observe changes in the document's body height.
+     * When the height changes, it sends a resize message with the new height, to the connected peers
+     */
+    startResizeObserver(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ResizeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ResizeService>;
+}
+
+/**
+ * A directive that adjusts the height of an element based on resize messages from a specified channel.
+ */
+declare class ScalableDirective {
+    /**
+     * The connection ID for the element, used as channel id backup
+     */
+    connect: i0.InputSignal<string | undefined>;
+    /**
+     * The channel id
+     */
+    scalable: i0.InputSignal<string | undefined>;
+    private readonly resizeHandler;
+    /**
+     * This signal checks if the current channel requesting the resize matches the channel ID from the resize handler.
+     * If they match, it returns the new height information; otherwise, it returns undefined.
+     */
+    private readonly newHeightFromChannel;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<ScalableDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ScalableDirective, "[scalable]", never, { "connect": { "alias": "connect"; "required": false; "isSignal": true; }; "scalable": { "alias": "scalable"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 /**
@@ -581,6 +741,7 @@ declare class ThemeProducerService implements MessageProducer<ThemeMessage> {
     private readonly messageService;
     private readonly logger;
     private previousTheme;
+    private readonly window;
     private readonly currentThemeSelection;
     /** Current selected theme signal */
     readonly currentTheme: i0.Signal<ThemeStructure | undefined>;
@@ -606,133 +767,315 @@ declare class ThemeProducerService implements MessageProducer<ThemeMessage> {
     static ɵprov: i0.ɵɵInjectableDeclaration<ThemeProducerService>;
 }
 
-declare class ConnectDirective {
+/**
+ * Information about user activity received from another context
+ */
+interface ActivityInfo {
+    /** The channel ID (source ID) that sent the activity */
+    channelId: string;
+    /** The type of activity event */
+    eventType: string;
+    /** Timestamp when the activity occurred */
+    timestamp: number;
+}
+/**
+ * Configuration options for the activity producer service
+ */
+interface ActivityProducerConfig {
     /**
-     * The connection ID required for the message peer service.
+     * Minimum interval in milliseconds between activity messages sent to the consumer.
+     * When multiple events occur within this interval, only the first one triggers a message.
+     * This prevents flooding the communication channel with too many messages.
      */
-    connect: i0.InputSignal<string>;
+    throttleMs: number;
     /**
-     * The sanitized source URL for the iframe.
+     * Optional filter function to determine if an event should be broadcast to the host(shell) app.
+     * Return true to broadcast the event, false to ignore it.
+     * Useful for filtering out events that occur on specific elements (e.g., iframes handled separately).
+     * @param event The DOM event that triggered the activity
+     * @returns Whether the event should be broadcast
      */
-    src: i0.InputSignal<SafeResourceUrl | undefined>;
+    shouldBroadcast?: (event: Event) => boolean;
     /**
-     * Binds the `src` attribute of the iframe to the sanitized source URL.
+     * Enable tracking of nested iframes. When enabled, the service will detect when focus
+     * moves to an iframe within the document and send periodic activity signals while
+     * the iframe has focus. This is useful for modules that contain iframes whose content
+     * cannot be modified to include activity tracking.
      */
-    get srcAttr(): SafeResourceUrl | undefined;
-    private readonly messageService;
-    private readonly domSanitizer;
-    private readonly iframeElement;
-    private readonly clientOrigin;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConnectDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ConnectDirective, "iframe[connect]", never, { "connect": { "alias": "connect"; "required": true; "isSignal": true; }; "src": { "alias": "src"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-/** Options to configure the connection inside the communication protocol */
-interface ConnectionConfigOptions extends Omit<MessagePeerConfig, 'id'> {
-    /** @inheritdoc */
-    id?: string;
-    /** Logger used to gather information */
-    logger?: Logger;
+    trackNestedIframes?: boolean;
+    /**
+     * Interval in milliseconds for polling document.activeElement to detect iframe focus.
+     * Only used when trackNestedIframes is true.
+     * @default 1000
+     */
+    nestedIframePollIntervalMs?: number;
+    /**
+     * Interval in milliseconds for sending activity signals to the host(shell) app while a nested iframe has focus.
+     * Only used when trackNestedIframes is true.
+     * @default 30000
+     */
+    nestedIframeActivityEmitIntervalMs?: number;
+    /**
+     * Throttle time in milliseconds for high-frequency events (scroll, mousemove).
+     * These events are throttled to avoid performance issues.
+     * @default 300
+     */
+    highFrequencyThrottleMs?: number;
 }
 /**
- * Provide the communication protocol connection configuration
- * @param connectionConfigOptions The identifier of the application in the communication protocol ecosystem plus the types of messages able to exchange and a logger object
+ * Configuration for the iframe activity tracker
  */
-declare function provideConnection(connectionConfigOptions?: ConnectionConfigOptions): i0.EnvironmentProviders;
+interface IframeActivityTrackerConfig {
+    /**
+     * Interval in milliseconds for polling document.activeElement to detect iframe focus.
+     * @default 1000
+     */
+    pollIntervalMs?: number;
+    /**
+     * Interval in milliseconds for sending activity signals to the host(shell) app while an iframe has focus.
+     * @default 30000
+     */
+    activityIntervalMs?: number;
+    /**
+     * Callback to invoke when activity is detected
+     */
+    onActivity: () => void;
+}
 
 /**
- * A constant array of known message types and their versions.
+ * DOM events that indicate user activity
  */
-declare const KNOWN_MESSAGES: [{
-    readonly type: "error";
-    readonly version: "1.0";
-}];
+declare const ACTIVITY_EVENTS: readonly Exclude<UserActivityEventType, 'visibilitychange'>[];
 /**
- * Returns the default options for starting a client endpoint peer connection.
- * As `origin`, it will take the hostURL from {@link getHostInfo} and the `window` will be the parent window.
+ * Custom activity event type for iframe interactions.
+ * Emitted programmatically when an iframe gains focus, not from a DOM event listener.
  */
-declare function getDefaultClientEndpointStartOptions(): PeerConnectionOptions;
+declare const IFRAME_INTERACTION_EVENT: UserActivityEventType;
 /**
- * Return `true` if embedded inside an iframe, `false` otherwise
+ * Custom activity event type for visibility changes.
+ * Emitted programmatically when the document becomes visible, not from a DOM event listener.
  */
-declare function isEmbedded(): boolean;
-
+declare const VISIBILITY_CHANGE_EVENT: UserActivityEventType;
 /**
- * Search parameter to add to the URL when embedding an iframe containing the URL of the host.
- * This is needed to support Firefox (on which {@link https://developer.mozilla.org/docs/Web/API/Location/ancestorOrigins | location.ancestorOrigins} is not currently supported)
- * in case of redirection inside the iframe.
+ * High-frequency events that require throttling to avoid performance issues
  */
-declare const MFE_HOST_URL_PARAM = "ama-mfe-host-url";
+declare const HIGH_FREQUENCY_EVENTS: readonly UserActivityEventType[];
 /**
- * Search parameter to add to the URL to let a module know on which application it's embedded
+ * Default configuration values for the ActivityProducerService
  */
-declare const MFE_HOST_APPLICATION_ID_PARAM = "ama-mfe-host-app-id";
-/**
- * Search parameter to add to the URL to identify the application in the network of peers in the communication protocol
- */
-declare const MFE_MODULE_APPLICATION_ID_PARAM = "ama-mfe-module-app-id";
-/** The list of query parameters which can be set by the host */
-declare const hostQueryParams: string[];
+declare const DEFAULT_ACTIVITY_PRODUCER_CONFIG: Readonly<ActivityProducerConfig>;
+
 /**
- * Information set up at host level to use in embedded context
+ * Generic service that tracks user activity and sends messages.
+ * Can be configured for different contexts (cockpit or modules) via start() method parameter.
  */
-interface MFEHostInformation {
+declare class ActivityProducerService implements MessageProducer<UserActivityMessage> {
+    private readonly messageService;
+    private readonly destroyRef;
+    private readonly iframeActivityTracker;
+    private readonly logger;
     /**
-     * URL of the host application
+     * Timestamp of the last sent activity message
      */
-    hostURL?: string;
+    private lastSentTimestamp;
     /**
-     * ID of the host application
+     * Bound event listeners for cleanup
      */
-    hostApplicationId?: string;
+    private readonly boundListeners;
     /**
-     * ID of the module to embed defined at host level
+     * Last emission timestamps for throttled high-frequency events
      */
-    moduleApplicationId?: string;
+    private readonly lastEmitTimestamps;
+    /**
+     * Whether the service has been started
+     */
+    private started;
+    /**
+     * Signal that emits local activity information.
+     * This allows consumers to react to activity detected by this producer.
+     */
+    private readonly localActivityWritable;
+    /**
+     * Read-only signal containing the latest local activity info.
+     * Use this signal to react to locally detected activity.
+     */
+    readonly localActivity: i0.Signal<ActivityInfo | undefined>;
+    /**
+     * @inheritdoc
+     */
+    readonly types = "user_activity";
+    constructor();
+    /**
+     * Handles high-frequency events by applying a per-eventType throttle before calling onActivity.
+     *
+     * Difference with onActivity:
+     * - onActivityThrottled limits how often a given high-frequency event type (e.g. scroll) is processed
+     *   (based on highFrequencyThrottleMs and lastEmitTimestamps)
+     * - onActivity updates the local activity signal and applies the global message throttle
+     *   (based on global throttleMs and lastSentTimestamp)
+     * @param eventType The type of activity event that occurred
+     * @param configObject
+     */
+    private onActivityThrottled;
+    /**
+     * Handles activity by sending a throttled message and emitting to local signal.
+     * @param eventType The type of activity event that occurred
+     * @param configObject
+     */
+    private onActivity;
+    /**
+     * Sends an activity message.
+     * @param eventType The type of activity event
+     * @param timestamp The timestamp of the event
+     */
+    private sendActivityMessage;
+    /**
+     * @inheritdoc
+     */
+    handleError(message: ErrorContent<UserActivityMessage>): void;
+    /**
+     * Starts observing user activity events.
+     * When activity is detected, it sends a throttled message.
+     * Event listeners are attached after the next render to ensure DOM is ready.
+     * @param config Configuration for the activity producer
+     */
+    start(config?: Partial<ActivityProducerConfig>): void;
+    /**
+     * Stops observing user activity events.
+     */
+    stop(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActivityProducerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ActivityProducerService>;
 }
+
 /**
- * Gather the host information from the url parameters
- * The host url will use the first found among:
- * - look for the search parameter {@link MFE_HOST_URL_PARAM} in the URL of the iframe
- * - use the first item in `location.ancestorOrigins` (currently not supported on Firefox)
- * - use `document.referrer` (will only work if called before any redirection in the iframe)
- * The host application ID is taken from the search parameter {@link MFE_HOST_APPLICATION_ID_PARAM} in the URL of the iframe
- * The module application ID is taken from the search parameter {@link MFE_APPLICATION_ID_PARAM} in the URL of the iframe
- */
-declare function getHostInfo(): MFEHostInformation;
-/**
- * Gather the host information from the url parameters and handle the persistence in session storage.
+ * Generic service that consumes user activity messages.
+ * Can be used in both shell (to receive from modules) and modules (to receive from shell).
  */
-declare function persistHostInfo(): void;
+declare class ActivityConsumerService implements BasicMessageConsumer<UserActivityMessageV1_0> {
+    private readonly consumerManagerService;
+    /**
+     * Signal containing the latest activity info
+     */
+    private readonly latestReceivedActivityWritable;
+    /**
+     * Read-only signal containing the latest activity info received from other peers via the message protocol.
+     * Access the timestamp via latestReceivedActivity()?.timestamp
+     */
+    readonly latestReceivedActivity: i0.Signal<ActivityInfo | undefined>;
+    /**
+     * @inheritdoc
+     */
+    readonly type = "user_activity";
+    /**
+     * @inheritdoc
+     */
+    readonly supportedVersions: Record<string, (message: RoutedMessage<UserActivityMessageV1_0>) => void>;
+    /**
+     * Starts the activity consumer service by registering it with the consumer manager.
+     */
+    start(): void;
+    /**
+     * Stops the activity consumer service by unregistering it from the consumer manager.
+     */
+    stop(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActivityConsumerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ActivityConsumerService>;
+}
 
 /**
- * A pipe that adds the host information in the URL of an iframe,
+ * Service that tracks user activity within nested iframes.
+ *
+ * Polls document.activeElement frequently to detect when an iframe has focus.
+ * When an iframe gains focus, emits immediately and then at the configured interval.
+ * When focus leaves the iframe, it stops emitting.
+ *
+ * This is needed because cross-origin iframes don't fire focus/blur events
+ * that bubble to the parent, and the regular activity tracker can't detect
+ * user interactions inside iframes.
  */
-declare class HostInfoPipe implements PipeTransform {
-    private readonly domSanitizer;
+declare class IframeActivityTrackerService {
     /**
-     * Transforms the given URL or SafeResourceUrl by appending query parameters.
-     * @param url - The URL or SafeResourceUrl to be transformed.
-     * @param options - hostId and moduleId
-     * @returns - The transformed SafeResourceUrl or undefined if the input URL is invalid.
+     * Interval ID for polling activeElement
      */
-    transform(url: string, options: {
-        hostId: string;
-        moduleId?: string;
-    }): string;
-    transform(url: SafeResourceUrl, options: {
-        hostId: string;
-        moduleId?: string;
-    }): SafeResourceUrl;
-    transform(url: undefined, options: {
-        hostId: string;
-        moduleId?: string;
-    }): undefined;
-    static ɵfac: i0.ɵɵFactoryDeclaration<HostInfoPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<HostInfoPipe, "hostInfo", true>;
+    private pollIntervalId?;
+    /**
+     * Interval ID for emitting activity at configured interval
+     */
+    private activityIntervalId?;
+    /**
+     * Current configuration
+     */
+    private config?;
+    /**
+     * Bound visibility change handler for cleanup
+     */
+    private readonly visibilityChangeHandler;
+    /**
+     * Whether the service has been started
+     */
+    private get started();
+    /**
+     * Whether we are currently tracking iframe activity (iframe had focus on last poll)
+     */
+    private get isTrackingIframeActivity();
+    /**
+     * Polls document.activeElement to detect iframe focus changes.
+     * When iframe gains focus: emit immediately and start activity interval.
+     * When iframe loses focus: stop activity interval.
+     */
+    private checkActiveElement;
+    /**
+     * Handles visibility change events to pause/resume polling when tab visibility changes.
+     */
+    private handleVisibilityChange;
+    /**
+     * Starts polling for active element changes.
+     */
+    private startPolling;
+    /**
+     * Stops polling for active element changes.
+     */
+    private stopPolling;
+    /**
+     * Starts the activity emission interval.
+     */
+    private startActivityInterval;
+    /**
+     * Stops the activity emission interval.
+     */
+    private stopActivityInterval;
+    /**
+     * Starts tracking nested iframes within the document.
+     * @param config Configuration for the tracker
+     */
+    start(config: IframeActivityTrackerConfig): void;
+    /**
+     * Stops tracking nested iframes and cleans up resources.
+     */
+    stop(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IframeActivityTrackerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<IframeActivityTrackerService>;
 }
 
-export { ApplyTheme, ConnectDirective, ConsumerManagerService, ERROR_MESSAGE_TYPE, HostInfoPipe, KNOWN_MESSAGES, MFE_HOST_APPLICATION_ID_PARAM, MFE_HOST_URL_PARAM, MFE_MODULE_APPLICATION_ID_PARAM, NavigationConsumerService, ProducerManagerService, ResizeConsumerService, ResizeService, RestoreRoute, RouteMemorizeDirective, RouteMemorizeService, RoutingService, ScalableDirective, THEME_QUERY_PARAM_NAME, THEME_URL_SUFFIX, ThemeConsumerService, ThemeProducerService, applyInitialTheme, applyTheme, downloadApplicationThemeCss, getAvailableConsumers, getDefaultClientEndpointStartOptions, getHostInfo, getStyle, hostQueryParams, isEmbedded, isErrorMessage, persistHostInfo, provideConnection, registerConsumer, registerProducer, sendError };
-export type { BasicMessageConsumer, ConnectionConfigOptions, ErrorContent, ErrorMessage, ErrorMessageV1_0, ErrorReason, MFEHostInformation, MessageCallback, MessageConsumer, MessageProducer, MessageVersions, RestoreRouteOptions, RoutingServiceOptions, StyleHelperOptions };
+/**
+ * A constant array of known message types and their versions.
+ */
+declare const KNOWN_MESSAGES: [{
+    readonly type: "error";
+    readonly version: "1.0";
+}];
+/**
+ * Returns the default options for starting a client endpoint peer connection.
+ * As `origin`, it will take the hostURL from {@link getHostInfo} and the `window` will be the parent window.
+ */
+declare function getDefaultClientEndpointStartOptions(): PeerConnectionOptions;
+/**
+ * Return `true` if embedded inside an iframe, `false` otherwise
+ * @param windowParam - A {@link window} object with information about the current window of the document. Defaults to global {@link window}.
+ */
+declare function isEmbedded(windowParam?: Window): boolean;
+
+export { ACTIVITY_EVENTS, ActivityConsumerService, ActivityProducerService, ApplyTheme, ConnectDirective, ConsumerManagerService, DEFAULT_ACTIVITY_PRODUCER_CONFIG, ERROR_MESSAGE_TYPE, HIGH_FREQUENCY_EVENTS, HistoryConsumerService, HostInfoPipe, IFRAME_INTERACTION_EVENT, IframeActivityTrackerService, KNOWN_MESSAGES, MFE_HOST_APPLICATION_ID_PARAM, MFE_HOST_URL_PARAM, MFE_MODULE_APPLICATION_ID_PARAM, NavigationConsumerService, ProducerManagerService, ResizeConsumerService, ResizeService, RestoreRoute, RouteMemorizeDirective, RouteMemorizeService, RoutingService, ScalableDirective, THEME_QUERY_PARAM_NAME, THEME_URL_SUFFIX, ThemeConsumerService, ThemeProducerService, VISIBILITY_CHANGE_EVENT, applyInitialTheme, applyTheme, downloadApplicationThemeCss, getAvailableConsumers, getDefaultClientEndpointStartOptions, getHostInfo, getStyle, hostQueryParams, isEmbedded, isErrorMessage, isUserActivityMessage, persistHostInfo, provideConnection, provideHistoryOverrides, registerConsumer, registerProducer, sendError };
+export type { ActivityInfo, ActivityProducerConfig, BasicMessageConsumer, ConnectionConfigOptions, ErrorContent, ErrorMessage, ErrorMessageV1_0, ErrorReason, IframeActivityTrackerConfig, MFEHostInformation, MessageCallback, MessageConsumer, MessageProducer, MessageVersions, RestoreRouteOptions, RoutingServiceOptions, StyleHelperOptions };
 //# sourceMappingURL=index.d.ts.map