@opentap/runner-client 2.38.1-alpha.1.3.18391676602 → 2.38.1

package/dist/cjs/DTOs.d.ts

@@ -70,7 +70,7 @@ export declare class Session implements ISession {
     subject?: string | undefined;
     id?: string | undefined;
     imageId?: string | undefined;
-    sessionState?: SessionState;
+    executionState?: ExecutionState;
     testPlanRunId?: string | undefined;
     startedBy?: string | undefined;
     metadata?: {
@@ -85,7 +85,7 @@ export interface ISession {
     subject?: string | undefined;
     id?: string | undefined;
     imageId?: string | undefined;
-    sessionState?: SessionState;
+    executionState?: ExecutionState;
     testPlanRunId?: string | undefined;
     startedBy?: string | undefined;
     metadata?: {
@@ -809,7 +809,7 @@ export declare class RunStatus implements IRunStatus {
     verdict?: Verdict;
     testPlanRunId?: string | undefined;
     failedToStart?: boolean;
-    sessionState?: SessionState;
+    executionState?: ExecutionState;
     executingSteps?: string[] | undefined;
     constructor(data?: IRunStatus);
     init(_data?: any): void;
@@ -821,7 +821,7 @@ export interface IRunStatus {
     verdict?: Verdict;
     testPlanRunId?: string | undefined;
     failedToStart?: boolean;
-    sessionState?: SessionState;
+    executionState?: ExecutionState;
     executingSteps?: string[] | undefined;
 }
 /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
@@ -833,13 +833,12 @@ export declare enum Verdict {
     Aborted = "Aborted",
     Error = "Error"
 }
-export declare enum SessionState {
+export declare enum ExecutionState {
     Idle = "Idle",
     Executing = "Executing",
     Breaking = "Breaking",
     Aborting = "Aborting",
-    WaitingForUserInput = "WaitingForUserInput",
-    Loading = "Loading"
+    WaitingForUserInput = "WaitingForUserInput"
 }
 export declare class TestPlan implements ITestPlan {
     childTestSteps?: TestStep[] | undefined;
@@ -1154,118 +1153,168 @@ export interface IMetricValue {
     time: number;
     value: boolean | number | string | object;
 }
-export declare enum SessionEventName {
-    TypeCacheInvalidated = "TypeCacheInvalidated",
-    TestPlanSettingsChanged = "TestPlanSettingsChanged",
-    SessionTimeout = "SessionTimeout",
-    Starting = "Starting",
-    Started = "Started",
-    Heartbeat = "Heartbeat",
-    Stopping = "Stopping",
-    Stopped = "Stopped",
+export declare class SessionEvent implements ISessionEvent {
+    eventType?: SessionEventType;
+    sessionId?: string;
+    protected _discriminator: string;
+    constructor(data?: ISessionEvent);
+    init(_data?: any): void;
+    static fromJS(data: any): SessionEvent;
+    toJSON(data?: any): any;
+}
+export interface ISessionEvent {
+    eventType?: SessionEventType;
+    sessionId?: string;
+}
+export declare enum SessionEventType {
+    SessionStarting = "SessionStarting",
+    SessionStarted = "SessionStarted",
+    SessionStopping = "SessionStopping",
+    SessionStopped = "SessionStopped",
     TestPlanChanged = "TestPlanChanged",
-    SessionStateChanged = "SessionStateChanged",
+    TestPlanExecutionStateChanged = "TestPlanExecutionStateChanged",
     SettingsChanged = "SettingsChanged",
     TestStepChanged = "TestStepChanged",
-    Break = "Break",
+    BreakEvent = "BreakEvent",
     UserInputRequested = "UserInputRequested",
-    UserInputRequestCompleted = "UserInputRequestCompleted"
-}
-export declare abstract class SessionEvent {
-    readonly eventName: SessionEventName;
-    sessionId?: string;
-    protected constructor(eventName: SessionEventName);
-}
-export declare class TypeCacheInvalidatedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): TypeCacheInvalidatedEvent;
-}
-export declare class TestPlanSettingsChangedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): TestPlanSettingsChangedEvent;
+    UserInputCompleted = "UserInputCompleted",
+    SessionTimeoutHit = "SessionTimeoutHit",
+    TestPlanSettingsChanged = "TestPlanSettingsChanged",
+    TypeCacheInvalidated = "TypeCacheInvalidated",
+    Heartbeat = "Heartbeat",
+    MetricsConfigurationChanged = "MetricsConfigurationChanged"
 }
-export declare class SessionTimeoutEvent extends SessionEvent {
-    constructor();
-    static fromJS(): SessionTimeoutEvent;
+export declare class SessionTimeoutEventArgs extends SessionEvent implements ISessionTimeoutEventArgs {
+    constructor(data?: ISessionTimeoutEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): SessionTimeoutEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class StartingEvent extends SessionEvent {
-    constructor();
-    static fromJS(): StartingEvent;
+export declare type ISessionTimeoutEventArgs = ISessionEvent;
+export declare class StartingEventArgs extends SessionEvent implements IStartingEventArgs {
+    constructor(data?: IStartingEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): StartingEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class StartedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): StartedEvent;
+export declare type IStartingEventArgs = ISessionEvent;
+export declare class StartedEventArgs extends SessionEvent implements IStartedEventArgs {
+    constructor(data?: IStartedEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): StartedEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class StoppingEvent extends SessionEvent {
-    constructor();
-    static fromJS(): StoppingEvent;
+export declare type IStartedEventArgs = ISessionEvent;
+export declare class StoppingEventArgs extends SessionEvent implements IStoppingEventArgs {
+    constructor(data?: IStoppingEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): StoppingEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class StoppedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): StoppedEvent;
+export declare type IStoppingEventArgs = ISessionEvent;
+export declare class StoppedEventArgs extends SessionEvent implements IStoppedEventArgs {
+    constructor(data?: IStoppedEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): StoppedEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class TestPlanChangedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): TestPlanChangedEvent;
+export declare type IStoppedEventArgs = ISessionEvent;
+export declare class TestPlanChangeEventArgs extends SessionEvent implements ITestPlanChangeEventArgs {
+    constructor(data?: ITestPlanChangeEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): TestPlanChangeEventArgs;
+    toJSON(data?: any): any;
 }
-export declare class SessionStateChangedEvent extends SessionEvent {
+export declare type ITestPlanChangeEventArgs = ISessionEvent;
+export declare class TestPlanExecutionStateChangedEventArgs extends SessionEvent implements ITestPlanExecutionStateChangedEventArgs {
     runStatus?: RunStatus | undefined;
-    constructor(data?: {
-        runStatus?: RunStatus;
-    });
+    constructor(data?: ITestPlanExecutionStateChangedEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): SessionStateChangedEvent;
+    static fromJS(data: any): TestPlanExecutionStateChangedEventArgs;
     toJSON(data?: any): any;
 }
-export declare class HeartbeatEvent extends SessionEvent {
-    timestamp?: number;
-    watchDog?: WatchDog | undefined;
-    state?: SessionState;
-    testPlanRunId?: string | undefined;
-    constructor(data?: Partial<HeartbeatEvent>);
+export interface ITestPlanExecutionStateChangedEventArgs extends ISessionEvent {
+    runStatus?: RunStatus | undefined;
+}
+export declare class SettingsChangedEventArgs extends SessionEvent implements ISettingsChangedEventArgs {
+    constructor(data?: ISettingsChangedEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): HeartbeatEvent;
+    static fromJS(data: any): SettingsChangedEventArgs;
     toJSON(data?: any): any;
 }
-export declare class SettingsChangedEvent extends SessionEvent {
-    group?: string | undefined;
-    name?: string | undefined;
-    constructor(data?: Partial<SettingsChangedEvent>);
+export declare type ISettingsChangedEventArgs = ISessionEvent;
+export declare class TestStepChangeEventArgs extends SessionEvent implements ITestStepChangeEventArgs {
+    stepId?: string;
+    constructor(data?: ITestStepChangeEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): SettingsChangedEvent;
+    static fromJS(data: any): TestStepChangeEventArgs;
     toJSON(data?: any): any;
 }
-export declare class TestStepChangedEvent extends SessionEvent {
-    stepId?: string | undefined;
-    constructor(data?: Partial<TestStepChangedEvent>);
+export interface ITestStepChangeEventArgs extends ISessionEvent {
+    stepId?: string;
+}
+export declare class BreakEventArgs extends SessionEvent implements IBreakEventArgs {
+    stepId?: string;
+    constructor(data?: IBreakEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): TestStepChangedEvent;
+    static fromJS(data: any): BreakEventArgs;
     toJSON(data?: any): any;
 }
-export declare class BreakEvent extends SessionEvent {
-    stepId?: string | undefined;
-    constructor(data?: Partial<BreakEvent>);
+export interface IBreakEventArgs extends ISessionEvent {
+    stepId?: string;
+}
+export declare class UserInputRequestEventArgs extends SessionEvent implements IUserInputRequestEventArgs {
+    requestId?: string;
+    constructor(data?: IUserInputRequestEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): BreakEvent;
+    static fromJS(data: any): UserInputRequestEventArgs;
     toJSON(data?: any): any;
 }
-export declare class UserInputRequestedEvent extends SessionEvent {
-    requestId?: string | undefined;
-    constructor(data?: Partial<UserInputRequestedEvent>);
+export interface IUserInputRequestEventArgs extends ISessionEvent {
+    requestId?: string;
+}
+export declare class UserInputRequestCompletedEventArgs extends SessionEvent implements IUserInputRequestCompletedEventArgs {
+    requestId?: string;
+    answered?: boolean;
+    timeout?: boolean;
+    constructor(data?: IUserInputRequestCompletedEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): UserInputRequestedEvent;
+    static fromJS(data: any): UserInputRequestCompletedEventArgs;
     toJSON(data?: any): any;
 }
-export declare class UserInputRequestCompletedEvent extends SessionEvent {
-    requestId?: string | undefined;
+export interface IUserInputRequestCompletedEventArgs extends ISessionEvent {
+    requestId?: string;
     answered?: boolean;
     timeout?: boolean;
-    constructor(data?: Partial<UserInputRequestCompletedEvent>);
+}
+export declare class TestPlanSettingsChangedEventArgs extends SessionEvent implements ITestPlanSettingsChangedEventArgs {
+    constructor(data?: ITestPlanSettingsChangedEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): TestPlanSettingsChangedEventArgs;
+    toJSON(data?: any): any;
+}
+export declare type ITestPlanSettingsChangedEventArgs = ISessionEvent;
+export declare class HeartbeatEventArgs extends SessionEvent implements IHeartbeatEventArgs {
+    constructor(data?: IHeartbeatEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): HeartbeatEventArgs;
+    toJSON(data?: any): any;
+}
+export interface IHeartbeatEventArgs extends ISessionEvent {
+    timestamp?: number;
+    watchDog?: IWatchDog;
+    state?: ExecutionState;
+    testPlanRunID?: string;
+}
+export declare class MetricsConfigurationChangedEventArgs extends SessionEvent implements IMetricsConfigurationChangedEventArgs {
+    constructor(data?: IMetricsConfigurationChangedEventArgs);
     init(_data?: any): void;
-    static fromJS(data: any): UserInputRequestCompletedEvent;
+    static fromJS(data: any): MetricsConfigurationChangedEventArgs;
     toJSON(data?: any): any;
 }
-export declare type ISessionEvent = SessionEvent;
+export interface IMetricsConfigurationChangedEventArgs extends ISessionEvent {
+    metricsConfiguration?: IMetricsConfiguration;
+}
 export interface IOnTestPlanRun {
     status?: string;
     userId?: string;