@o3r/application/devkit/application-devkit.interface.d.ts

This module provides development help to monitor your Otter Application

import type { ConnectContentMessage, DevtoolsCommonOptions, MessageDataTypes, OtterMessageContent, RequestMessagesContentMessage } from '@o3r/core';
export interface ApplicationDevtoolsServiceOptions extends DevtoolsCommonOptions {
    /**
     * Application name
     */
    appName?: string;
    /**
     * CSS classname applied to an HTML tag to hide it, ignore it, in the e2e visual testing process
     */
    e2eIgnoreClass?: string;
}
/**
 * Session information used to track all the calls done by one or several APIs of the SDK.
 */
export interface SessionInformation {
    /**
     * The session ID
     */
    id: string;
    /**
     * The generated time
     */
    generatedTime: Date;
}
/** Information relative loaded application */
export interface ApplicationInformation {
    /**
     * Application name
     */
    appName: string;
    /** Application Version */
    appVersion: string;
    /**
     * Session Information
     * @note This is a session ID will be provided only with the Amadeus Otter implementation of the application package.
     */
    session?: SessionInformation;
    /**
     * Log Link
     * @note This a link to Alf logs, it will be provided only with the Amadeus Otter implementation of the application package.
     */
    logLink?: string;
    /** Is Production Environment */
    isProduction: boolean;
}
/** Toggle Visual Testing */
export interface ToggleVisualTestingMessage extends OtterMessageContent<'toggleVisualTesting'> {
    /** Toggle the visual testing mode */
    toggle?: boolean;
}
/** Application Information Message Content */
export interface ApplicationInformationContentMessage extends ApplicationInformation, OtterMessageContent<'applicationInformation'> {
}
/** State selection message */
export interface StateSelectionContentMessage extends OtterMessageContent<'stateSelection'> {
    /** Name of the state */
    stateName: string;
    /** Color of the state */
    stateColor: string;
    /** Contrast color of the state */
    stateColorContrast: string;
}
/** Unselect state message */
export interface UnselectStateContentMessage extends OtterMessageContent<'unselectState'> {
}
type ApplicationMessageContents = ApplicationInformationContentMessage | StateSelectionContentMessage | UnselectStateContentMessage | ToggleVisualTestingMessage;
/** List of possible DataTypes for Application messages */
export type ApplicationMessageDataTypes = MessageDataTypes<ApplicationMessageContents>;
/** List of all messages for application purpose */
export type AvailableApplicationMessageContents = ApplicationMessageContents | ConnectContentMessage | RequestMessagesContentMessage<ApplicationMessageDataTypes>;
/**
 * Determine if the given message is a Application message
 * @param message message to check
 */
export declare const isApplicationMessage: (message: any) => message is AvailableApplicationMessageContents;
export {};
//# sourceMappingURL=application-devkit.interface.d.ts.map