@opentap/runner-client 2.38.1 → 2.39.0

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