@opentap/runner-client 2.33.0 → 2.34.0-alpha.1.1.15774461521

package/dist/cjs/DTOs.d.ts

@@ -1518,3 +1518,14 @@ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpda
     static fromJS(data: any): AssetUpdatedEvent;
     toJSON(data?: any): any;
 }
+export interface ISaveDefaultSettings {
+    sessionId?: string;
+    repository?: string;
+}
+export declare class SaveDefaultSettings implements ISaveDefaultSettings {
+    sessionId?: string;
+    repository?: string;
+    constructor(data: ISaveDefaultSettings);
+    static fromJS(data: any): SaveDefaultSettings;
+    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.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.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 = [];
@@ -4237,3 +4237,25 @@ var AssetUpdatedEvent = /** @class */ (function (_super) {
     return AssetUpdatedEvent;
 }(RunnerEvent));
 exports.AssetUpdatedEvent = AssetUpdatedEvent;
+var SaveDefaultSettings = /** @class */ (function () {
+    function SaveDefaultSettings(data) {
+        this.sessionId = data.sessionId;
+        this.repository = data.repository;
+    }
+    SaveDefaultSettings.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new SaveDefaultSettings({
+            sessionId: data['SessionId'],
+            repository: data['Repository'],
+        });
+        return result;
+    };
+    SaveDefaultSettings.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['SessionId'] = this.sessionId;
+        data['Repository'] = this.repository;
+        return data;
+    };
+    return SaveDefaultSettings;
+}());
+exports.SaveDefaultSettings = SaveDefaultSettings;

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, Session } from './DTOs';
+import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, SaveDefaultSettings, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 export declare class RunnerClient extends BaseClient {
     private runnerId;
@@ -10,7 +10,7 @@ export declare class RunnerClient extends BaseClient {
         getImage: () => Promise<Image>;
         setImage: (image: Image) => Promise<Image>;
         getSettings: () => Promise<RepositoryPackageReference | undefined>;
-        setSettings: (repositoryPackageReference: RepositoryPackageReference) => Promise<void>;
+        saveDefaultSettings: (defaultSettings: SaveDefaultSettings) => Promise<void>;
     };
     constructor(baseSubject: string, options: ConnectionOptions);
     /**

package/dist/cjs/RunnerClient.js

@@ -130,10 +130,9 @@ var RunnerClient = /** @class */ (function (_super) {
                     .then(_this.success())
                     .catch(_this.error());
             },
-            /* Sets the base settings package. The base settings is always included
-            in the image creation process and loaded into the created session */
-            setSettings: function (repositoryPackageReference) {
-                return _this.request('SetDefaultSettings', repositoryPackageReference).then(_this.success()).catch(_this.error());
+            /* Saves the default settings in the repository. */
+            saveDefaultSettings: function (defaultSettings) {
+                return _this.request('SaveDefaultSettingsInRepository', defaultSettings).then(_this.success()).catch(_this.error());
             },
         };
         _this.runnerId = (0, utils_1.getSubjectParts)(baseSubject).runnerId;

package/dist/cjs/SessionClient.d.ts

@@ -2,8 +2,16 @@ import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsCo
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
+    private _sessionId;
     private subscriptions;
+    get sessionId(): string | undefined;
     constructor(baseSubject: string, options: ConnectionOptions);
+    /**
+     * Extracts the sessionId from the subject.
+     * @param subject //OpenTap.Runner.<runnerId>.Session.<sessionId>
+     * @returns sessionId or undefined if not found
+     */
+    private getSessionIdFromSubject;
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
      * @param options (optional) Subscription options

package/dist/cjs/SessionClient.js

@@ -35,8 +35,28 @@ var SessionClient = /** @class */ (function (_super) {
     function SessionClient(baseSubject, options) {
         var _this = _super.call(this, baseSubject, options) || this;
         _this.subscriptions = [];
+        _this._sessionId = _this.getSessionIdFromSubject(baseSubject);
         return _this;
     }
+    Object.defineProperty(SessionClient.prototype, "sessionId", {
+        get: function () {
+            return this._sessionId;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Extracts the sessionId from the subject.
+     * @param subject //OpenTap.Runner.<runnerId>.Session.<sessionId>
+     * @returns sessionId or undefined if not found
+     */
+    SessionClient.prototype.getSessionIdFromSubject = function (subject) {
+        var match = subject.match(/Session\.(.+)$/);
+        if (match && match[1]) {
+            return match[1];
+        }
+        return undefined;
+    };
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
      * @param options (optional) Subscription options

package/dist/mjs/DTOs.d.ts

@@ -1518,3 +1518,14 @@ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpda
     static fromJS(data: any): AssetUpdatedEvent;
     toJSON(data?: any): any;
 }
+export interface ISaveDefaultSettings {
+    sessionId?: string;
+    repository?: string;
+}
+export declare class SaveDefaultSettings implements ISaveDefaultSettings {
+    sessionId?: string;
+    repository?: string;
+    constructor(data: ISaveDefaultSettings);
+    static fromJS(data: any): SaveDefaultSettings;
+    toJSON(data?: any): any;
+}

package/dist/mjs/DTOs.js

@@ -3722,3 +3722,23 @@ export class AssetUpdatedEvent extends RunnerEvent {
         return data;
     }
 }
+export class SaveDefaultSettings {
+    constructor(data) {
+        this.sessionId = data.sessionId;
+        this.repository = data.repository;
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new SaveDefaultSettings({
+            sessionId: data['SessionId'],
+            repository: data['Repository'],
+        });
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['SessionId'] = this.sessionId;
+        data['Repository'] = this.repository;
+        return data;
+    }
+}

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, Session } from './DTOs';
+import { ISession, ISessionMetricInfo, Image, MetadataUpdatedEvent, RepositoryPackageReference, SaveDefaultSettings, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 export declare class RunnerClient extends BaseClient {
     private runnerId;
@@ -10,7 +10,7 @@ export declare class RunnerClient extends BaseClient {
         getImage: () => Promise<Image>;
         setImage: (image: Image) => Promise<Image>;
         getSettings: () => Promise<RepositoryPackageReference | undefined>;
-        setSettings: (repositoryPackageReference: RepositoryPackageReference) => Promise<void>;
+        saveDefaultSettings: (defaultSettings: SaveDefaultSettings) => Promise<void>;
     };
     constructor(baseSubject: string, options: ConnectionOptions);
     /**

package/dist/mjs/RunnerClient.js

@@ -71,10 +71,9 @@ export class RunnerClient extends BaseClient {
                     .then(this.success())
                     .catch(this.error());
             },
-            /* Sets the base settings package. The base settings is always included
-            in the image creation process and loaded into the created session */
-            setSettings: (repositoryPackageReference) => {
-                return this.request('SetDefaultSettings', repositoryPackageReference).then(this.success()).catch(this.error());
+            /* Saves the default settings in the repository. */
+            saveDefaultSettings: (defaultSettings) => {
+                return this.request('SaveDefaultSettingsInRepository', defaultSettings).then(this.success()).catch(this.error());
             },
         };
         this.runnerId = getSubjectParts(baseSubject).runnerId;

package/dist/mjs/SessionClient.d.ts

@@ -2,8 +2,16 @@ import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsCo
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
+    private _sessionId;
     private subscriptions;
+    get sessionId(): string | undefined;
     constructor(baseSubject: string, options: ConnectionOptions);
+    /**
+     * Extracts the sessionId from the subject.
+     * @param subject //OpenTap.Runner.<runnerId>.Session.<sessionId>
+     * @returns sessionId or undefined if not found
+     */
+    private getSessionIdFromSubject;
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
      * @param options (optional) Subscription options

package/dist/mjs/SessionClient.js

@@ -5,6 +5,22 @@ export class SessionClient extends BaseClient {
     constructor(baseSubject, options) {
         super(baseSubject, options);
         this.subscriptions = [];
+        this._sessionId = this.getSessionIdFromSubject(baseSubject);
+    }
+    get sessionId() {
+        return this._sessionId;
+    }
+    /**
+     * Extracts the sessionId from the subject.
+     * @param subject //OpenTap.Runner.<runnerId>.Session.<sessionId>
+     * @returns sessionId or undefined if not found
+     */
+    getSessionIdFromSubject(subject) {
+        const match = subject.match(/Session\.(.+)$/);
+        if (match && match[1]) {
+            return match[1];
+        }
+        return undefined;
     }
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received

package/package.json

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