@opentap/runner-client 2.34.0 → 2.35.0

package/dist/cjs/DTOs.d.ts

@@ -1529,3 +1529,53 @@ export declare class SaveDefaultSettings implements ISaveDefaultSettings {
     static fromJS(data: any): SaveDefaultSettings;
     toJSON(data?: any): any;
 }
+export interface IRemoteConnection {
+    endPoint: string;
+    connected: boolean;
+    rtt: string;
+}
+export declare class RemoteConnection implements IRemoteConnection {
+    endPoint: string;
+    connected: boolean;
+    rtt: string;
+    constructor(data?: IRemoteConnection);
+    init(data?: any): void;
+    static fromJS(data?: any): RemoteConnection;
+    toJSON(data?: any): any;
+}
+export interface IStreamInfoStatus {
+    runsMaxBytes: number;
+    runsUsage: number;
+    diskFree: number;
+}
+export declare class StreamInfoStatus implements IStreamInfoStatus {
+    runsMaxBytes: number;
+    runsUsage: number;
+    diskFree: number;
+    constructor(data?: IStreamInfoStatus);
+    init(data?: any): void;
+    static fromJS(data?: any): StreamInfoStatus;
+    toJSON(data?: any): any;
+}
+export interface IRunnerStatus {
+    version: string;
+    runningAsService: boolean;
+    runningInContainer: boolean;
+    remoteConnection?: RemoteConnection;
+    streamInfo?: StreamInfoStatus;
+    ipAddress: string;
+    hostame: string;
+}
+export declare class RunnerStatus implements IRunnerStatus {
+    version: string;
+    runningAsService: boolean;
+    runningInContainer: boolean;
+    remoteConnection?: RemoteConnection;
+    streamInfo?: StreamInfoStatus;
+    ipAddress: string;
+    hostame: string;
+    constructor(data?: IRunnerStatus);
+    init(data?: any): void;
+    static fromJS(data?: any): RunnerStatus;
+    toJSON(data?: any): any;
+}

package/dist/cjs/DTOs.js

@@ -17,7 +17,7 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionStartInitiated = exports.SessionEventArgs = exports.SettingsTapPackage = exports.RepositorySettingsPackageDefinition = exports.RepositoryPackageDefinition = exports.RepositoryPackageReference = exports.ProfileGroup = exports.ListItemType = exports.ComponentSettings = exports.FileDescriptor = exports.Resource = exports.PluginTypeSelectorControl = exports.PictureControl = exports.PasswordControl = exports.MultiSelectControl = exports.DropdownControl = exports.EnabledControl = exports.DirectoryPathControl = exports.FilePathControl = exports.ComboBoxControl = exports.TextBoxControl = exports.DataGridControl = exports.DataGridReferenceControl = exports.CheckBoxControl = exports.AvailableValue = exports.ButtonsControl = exports.ButtonControl = exports.ExternalParameter = exports.MetaData = exports.DisplayAttribute = exports.VisualStatus = exports.UnitAttribute = exports.Icon = exports.ColumnDisplayName = exports.LayoutMode = exports.Layout = exports.Setting = exports.ComponentSettingsListItem = exports.AnnotatedObject = exports.ComponentSettingsList = exports.DisplayMode = exports.ComponentSettingsIdentifier = exports.ComponentSettingsBase = exports.Links = exports.Session = exports.ImageResolveErrorResponse = exports.NoResponderError = exports.ErrorResponse = exports.PackageSpecifier = exports.Image = void 0;
 exports.TestPlanExecutionStateChangedEventArgs = exports.TestPlanChangeEventArgs = exports.StoppedEventArgs = exports.StoppingEventArgs = exports.StartedEventArgs = exports.StartingEventArgs = exports.SessionTimeoutEventArgs = exports.SessionEventType = exports.SessionEvent = exports.MetricValue = exports.MetricsConfiguration = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = exports.TestRun = exports.WatchDog = exports.Parameter = exports.BreakPoints = exports.InstalledFile = exports.Interaction = exports.CommonContext = exports.CommonSettings = exports.ValidationError = exports.TestStepValidationError = exports.TestStepCopy = exports.TestStepType = exports.TestStep = exports.TestPlan = exports.ExecutionState = exports.Verdict = exports.RunStatus = exports.MissingLicenseResponse = exports.LogEntry = exports.LogList = exports.ApiException = exports.ImageCreationFailed = exports.ImageCreated = exports.ImageCreating = exports.ImageEventArgs = exports.SessionInactivityLimitHit = exports.SessionShutdownFailed = exports.SessionShutdown = exports.SessionShutdownInitiated = exports.SessionStartFailed = exports.SessionStarted = void 0;
-exports.SaveDefaultSettings = exports.AssetUpdatedEvent = exports.MetadataUpdatedEvent = exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.MetricsConfigurationChangedEventArgs = exports.HeartbeatEventArgs = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = void 0;
+exports.RunnerStatus = exports.StreamInfoStatus = exports.RemoteConnection = exports.SaveDefaultSettings = exports.AssetUpdatedEvent = exports.MetadataUpdatedEvent = exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.MetricsConfigurationChangedEventArgs = exports.HeartbeatEventArgs = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = void 0;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -4259,3 +4259,120 @@ var SaveDefaultSettings = /** @class */ (function () {
     return SaveDefaultSettings;
 }());
 exports.SaveDefaultSettings = SaveDefaultSettings;
+var RemoteConnection = /** @class */ (function () {
+    function RemoteConnection(data) {
+        this.endPoint = '';
+        this.connected = false;
+        this.rtt = '';
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    RemoteConnection.prototype.init = function (data) {
+        var _a, _b, _c;
+        if (data) {
+            this.endPoint = (_a = data['EndPoint']) !== null && _a !== void 0 ? _a : '';
+            this.connected = (_b = data['Connected']) !== null && _b !== void 0 ? _b : false;
+            this.rtt = (_c = data['Rtt']) !== null && _c !== void 0 ? _c : '';
+        }
+    };
+    RemoteConnection.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new RemoteConnection();
+        result.init(data);
+        return result;
+    };
+    RemoteConnection.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['EndPoint'] = this.endPoint;
+        data['Connected'] = this.connected;
+        data['Rtt'] = this.rtt;
+        return data;
+    };
+    return RemoteConnection;
+}());
+exports.RemoteConnection = RemoteConnection;
+var StreamInfoStatus = /** @class */ (function () {
+    function StreamInfoStatus(data) {
+        this.runsMaxBytes = 0;
+        this.runsUsage = 0;
+        this.diskFree = 0;
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    StreamInfoStatus.prototype.init = function (data) {
+        var _a, _b, _c;
+        if (data) {
+            this.runsMaxBytes = (_a = data['RunsMaxBytes']) !== null && _a !== void 0 ? _a : 0;
+            this.runsUsage = (_b = data['RunsUsage']) !== null && _b !== void 0 ? _b : 0;
+            this.diskFree = (_c = data['DiskFree']) !== null && _c !== void 0 ? _c : 0;
+        }
+    };
+    StreamInfoStatus.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new StreamInfoStatus();
+        result.init(data);
+        return result;
+    };
+    StreamInfoStatus.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['RunsMaxBytes'] = this.runsMaxBytes;
+        data['RunsUsage'] = this.runsUsage;
+        data['DiskFree'] = this.diskFree;
+        return data;
+    };
+    return StreamInfoStatus;
+}());
+exports.StreamInfoStatus = StreamInfoStatus;
+var RunnerStatus = /** @class */ (function () {
+    function RunnerStatus(data) {
+        this.version = '';
+        this.runningAsService = false;
+        this.runningInContainer = false;
+        this.ipAddress = '';
+        this.hostame = '';
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    RunnerStatus.prototype.init = function (data) {
+        var _a, _b, _c, _d, _e;
+        if (data) {
+            this.version = (_a = data['Version']) !== null && _a !== void 0 ? _a : '';
+            this.runningAsService = (_b = data['RunningAsService']) !== null && _b !== void 0 ? _b : false;
+            this.runningInContainer = (_c = data['RunningInContainer']) !== null && _c !== void 0 ? _c : false;
+            this.remoteConnection = data['RemoteConnection'] ? RemoteConnection.fromJS(data['RemoteConnection']) : undefined;
+            this.streamInfo = data['StreamInfo'] ? StreamInfoStatus.fromJS(data['StreamInfo']) : undefined;
+            this.ipAddress = (_d = data['IpAddress']) !== null && _d !== void 0 ? _d : '';
+            this.hostame = (_e = data['Hostname']) !== null && _e !== void 0 ? _e : '';
+        }
+    };
+    RunnerStatus.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new RunnerStatus();
+        result.init(data);
+        return result;
+    };
+    RunnerStatus.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Version'] = this.version;
+        data['RunningAsService'] = this.runningAsService;
+        data['RunningInContainer'] = this.runningInContainer;
+        data['RemoteConnection'] = this.remoteConnection ? this.remoteConnection.toJSON() : undefined;
+        data['StreamInfo'] = this.streamInfo ? this.streamInfo.toJSON() : undefined;
+        data['IpAddress'] = this.ipAddress;
+        data['Hostname'] = this.hostame;
+    };
+    return RunnerStatus;
+}());
+exports.RunnerStatus = RunnerStatus;

package/dist/cjs/RunnerClient.d.ts

@@ -1,6 +1,6 @@
 import { ConnectionOptions, Consumer, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { RunnerUpdateRequest } from './requestDTOs';
-import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, SaveDefaultSettings, Session } from './DTOs';
+import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, RunnerStatus, SaveDefaultSettings, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 export declare class RunnerClient extends BaseClient {
     private runnerId;
@@ -96,4 +96,9 @@ export declare class RunnerClient extends BaseClient {
         encodedMetrics: Uint8Array[];
         timestamps: number[];
     }) => void): Promise<Consumer>;
+    /**
+     * Gets the runner status
+     * @return Promise
+     */
+    getStatus(): Promise<RunnerStatus>;
 }

package/dist/cjs/RunnerClient.js

@@ -397,6 +397,16 @@ var RunnerClient = /** @class */ (function (_super) {
             return consumer;
         });
     };
+    /**
+     * Gets the runner status
+     * @return Promise
+     */
+    RunnerClient.prototype.getStatus = function () {
+        return this.request('Status')
+            .then(function (status) { return DTOs_1.RunnerStatus.fromJS(status); })
+            .then(this.success())
+            .catch(this.error());
+    };
     return RunnerClient;
 }(BaseClient_1.BaseClient));
 exports.RunnerClient = RunnerClient;

package/dist/mjs/DTOs.d.ts

@@ -1529,3 +1529,53 @@ export declare class SaveDefaultSettings implements ISaveDefaultSettings {
     static fromJS(data: any): SaveDefaultSettings;
     toJSON(data?: any): any;
 }
+export interface IRemoteConnection {
+    endPoint: string;
+    connected: boolean;
+    rtt: string;
+}
+export declare class RemoteConnection implements IRemoteConnection {
+    endPoint: string;
+    connected: boolean;
+    rtt: string;
+    constructor(data?: IRemoteConnection);
+    init(data?: any): void;
+    static fromJS(data?: any): RemoteConnection;
+    toJSON(data?: any): any;
+}
+export interface IStreamInfoStatus {
+    runsMaxBytes: number;
+    runsUsage: number;
+    diskFree: number;
+}
+export declare class StreamInfoStatus implements IStreamInfoStatus {
+    runsMaxBytes: number;
+    runsUsage: number;
+    diskFree: number;
+    constructor(data?: IStreamInfoStatus);
+    init(data?: any): void;
+    static fromJS(data?: any): StreamInfoStatus;
+    toJSON(data?: any): any;
+}
+export interface IRunnerStatus {
+    version: string;
+    runningAsService: boolean;
+    runningInContainer: boolean;
+    remoteConnection?: RemoteConnection;
+    streamInfo?: StreamInfoStatus;
+    ipAddress: string;
+    hostame: string;
+}
+export declare class RunnerStatus implements IRunnerStatus {
+    version: string;
+    runningAsService: boolean;
+    runningInContainer: boolean;
+    remoteConnection?: RemoteConnection;
+    streamInfo?: StreamInfoStatus;
+    ipAddress: string;
+    hostame: string;
+    constructor(data?: IRunnerStatus);
+    init(data?: any): void;
+    static fromJS(data?: any): RunnerStatus;
+    toJSON(data?: any): any;
+}

package/dist/mjs/DTOs.js

@@ -3742,3 +3742,114 @@ export class SaveDefaultSettings {
         return data;
     }
 }
+export class RemoteConnection {
+    constructor(data) {
+        this.endPoint = '';
+        this.connected = false;
+        this.rtt = '';
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(data) {
+        var _a, _b, _c;
+        if (data) {
+            this.endPoint = (_a = data['EndPoint']) !== null && _a !== void 0 ? _a : '';
+            this.connected = (_b = data['Connected']) !== null && _b !== void 0 ? _b : false;
+            this.rtt = (_c = data['Rtt']) !== null && _c !== void 0 ? _c : '';
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new RemoteConnection();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['EndPoint'] = this.endPoint;
+        data['Connected'] = this.connected;
+        data['Rtt'] = this.rtt;
+        return data;
+    }
+}
+export class StreamInfoStatus {
+    constructor(data) {
+        this.runsMaxBytes = 0;
+        this.runsUsage = 0;
+        this.diskFree = 0;
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(data) {
+        var _a, _b, _c;
+        if (data) {
+            this.runsMaxBytes = (_a = data['RunsMaxBytes']) !== null && _a !== void 0 ? _a : 0;
+            this.runsUsage = (_b = data['RunsUsage']) !== null && _b !== void 0 ? _b : 0;
+            this.diskFree = (_c = data['DiskFree']) !== null && _c !== void 0 ? _c : 0;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new StreamInfoStatus();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['RunsMaxBytes'] = this.runsMaxBytes;
+        data['RunsUsage'] = this.runsUsage;
+        data['DiskFree'] = this.diskFree;
+        return data;
+    }
+}
+export class RunnerStatus {
+    constructor(data) {
+        this.version = '';
+        this.runningAsService = false;
+        this.runningInContainer = false;
+        this.ipAddress = '';
+        this.hostame = '';
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(data) {
+        var _a, _b, _c, _d, _e;
+        if (data) {
+            this.version = (_a = data['Version']) !== null && _a !== void 0 ? _a : '';
+            this.runningAsService = (_b = data['RunningAsService']) !== null && _b !== void 0 ? _b : false;
+            this.runningInContainer = (_c = data['RunningInContainer']) !== null && _c !== void 0 ? _c : false;
+            this.remoteConnection = data['RemoteConnection'] ? RemoteConnection.fromJS(data['RemoteConnection']) : undefined;
+            this.streamInfo = data['StreamInfo'] ? StreamInfoStatus.fromJS(data['StreamInfo']) : undefined;
+            this.ipAddress = (_d = data['IpAddress']) !== null && _d !== void 0 ? _d : '';
+            this.hostame = (_e = data['Hostname']) !== null && _e !== void 0 ? _e : '';
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new RunnerStatus();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['Version'] = this.version;
+        data['RunningAsService'] = this.runningAsService;
+        data['RunningInContainer'] = this.runningInContainer;
+        data['RemoteConnection'] = this.remoteConnection ? this.remoteConnection.toJSON() : undefined;
+        data['StreamInfo'] = this.streamInfo ? this.streamInfo.toJSON() : undefined;
+        data['IpAddress'] = this.ipAddress;
+        data['Hostname'] = this.hostame;
+    }
+}

package/dist/mjs/RunnerClient.d.ts

@@ -1,6 +1,6 @@
 import { ConnectionOptions, Consumer, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { RunnerUpdateRequest } from './requestDTOs';
-import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, SaveDefaultSettings, Session } from './DTOs';
+import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, RunnerStatus, SaveDefaultSettings, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 export declare class RunnerClient extends BaseClient {
     private runnerId;
@@ -96,4 +96,9 @@ export declare class RunnerClient extends BaseClient {
         encodedMetrics: Uint8Array[];
         timestamps: number[];
     }) => void): Promise<Consumer>;
+    /**
+     * Gets the runner status
+     * @return Promise
+     */
+    getStatus(): Promise<RunnerStatus>;
 }

package/dist/mjs/RunnerClient.js

@@ -15,7 +15,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 import { JSONCodec, nanos } from 'nats.ws';
-import { Image, MetadataUpdatedEvent, RepositoryPackageReference, Session, } from './DTOs';
+import { Image, MetadataUpdatedEvent, RepositoryPackageReference, RunnerStatus, Session, } from './DTOs';
 import { BaseClient } from './BaseClient';
 import { getSubjectParts } from './utils';
 export class RunnerClient extends BaseClient {
@@ -295,4 +295,14 @@ export class RunnerClient extends BaseClient {
             return consumer;
         });
     }
+    /**
+     * Gets the runner status
+     * @return Promise
+     */
+    getStatus() {
+        return this.request('Status')
+            .then(status => RunnerStatus.fromJS(status))
+            .then(this.success())
+            .catch(this.error());
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.34.0",
+  "version": "2.35.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/mjs/index.js",