@opentap/runner-client 3.0.0 → 3.1.0-alpha.1.1.20063228389

package/dist/cjs/DTOs.d.ts

@@ -569,6 +569,7 @@ export declare class RepositoryPackageReference implements IRepositoryPackageRef
     version?: string | undefined;
     repository?: string | undefined;
     path?: string | undefined;
+    pathId?: string | undefined;
     constructor(data?: IRepositoryPackageReference);
     init(_data?: any): void;
     static fromJS(data: any): RepositoryPackageReference;
@@ -579,6 +580,7 @@ export interface IRepositoryPackageReference {
     version?: string | undefined;
     repository?: string | undefined;
     path?: string | undefined;
+    pathId?: string | undefined;
 }
 export declare class RepositoryPackageDefinition extends RepositoryPackageReference implements IRepositoryPackageDefinition {
     tags?: string[] | undefined;
@@ -597,6 +599,26 @@ export declare class RepositorySettingsPackageDefinition extends RepositoryPacka
     toJSON(data?: any): any;
 }
 export declare type IRepositorySettingsPackageDefinition = IRepositoryPackageDefinition;
+export declare class GetTestPlanReferenceResponse implements IGetTestPlanReferenceResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+    constructor(data?: IGetTestPlanReferenceResponse);
+    init(_data?: any): void;
+    static fromJS(data: any): GetTestPlanReferenceResponse;
+    toJSON(data?: any): any;
+}
+export interface IGetTestPlanReferenceResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+}
+export declare class SaveTestPlanToRepositoryResponse implements ISaveTestPlanToRepositoryResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+    constructor(data?: ISaveTestPlanToRepositoryResponse);
+    init(_data?: any): void;
+    static fromJS(data: any): SaveTestPlanToRepositoryResponse;
+    toJSON(data?: any): any;
+}
+export interface ISaveTestPlanToRepositoryResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+}
 export declare class SettingsTapPackage implements ISettingsTapPackage {
     name?: string | undefined;
     version?: string | undefined;
@@ -824,6 +846,20 @@ export interface IRunStatus {
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
 }
+export declare class EditStatus implements IEditStatus {
+    undoBufferSize?: number;
+    redoBufferSize?: number;
+    testPlanDirty?: boolean;
+    constructor(data?: IEditStatus);
+    init(_data?: any): void;
+    static fromJS(data: any): EditStatus;
+    toJSON(data?: any): any;
+}
+export interface IEditStatus {
+    undoBufferSize?: number;
+    redoBufferSize?: number;
+    testPlanDirty?: boolean;
+}
 /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
 export declare enum Verdict {
     NotSet = "NotSet",
@@ -1205,8 +1241,13 @@ export declare class StoppedEvent extends SessionEvent {
     static fromJS(): StoppedEvent;
 }
 export declare class TestPlanChangedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): TestPlanChangedEvent;
+    editStatus?: EditStatus;
+    constructor(data?: {
+        editStatus?: EditStatus;
+    });
+    init(_data: any): void;
+    static fromJS(data: any): TestPlanChangedEvent;
+    toJSON(data?: any): any;
 }
 export declare class SessionStateChangedEvent extends SessionEvent {
     runStatus?: RunStatus | undefined;

package/dist/cjs/DTOs.js

@@ -15,9 +15,9 @@ 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.TestPlanChangedEvent = exports.StoppedEvent = exports.StoppingEvent = exports.StartedEvent = exports.StartingEvent = exports.SessionTimeoutEvent = exports.TestPlanSettingsChangedEvent = exports.TypeCacheInvalidatedEvent = exports.SessionEvent = exports.SessionEventName = exports.MetricValue = exports.MetricsConfiguration = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = 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.SessionState = 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.RunnerStatus = exports.StreamInfoStatus = exports.RemoteConnection = exports.SaveDefaultSettings = exports.AssetUpdatedEvent = exports.MetadataUpdatedEvent = exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEvent = exports.TestPlanRunStartEvent = exports.TestPlanRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.UserInputRequestCompletedEvent = exports.UserInputRequestedEvent = exports.BreakEvent = exports.TestStepChangedEvent = exports.SettingsChangedEvent = exports.HeartbeatEvent = exports.SessionStateChangedEvent = void 0;
+exports.SettingsTapPackage = exports.SaveTestPlanToRepositoryResponse = exports.GetTestPlanReferenceResponse = 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.StartedEvent = exports.StartingEvent = exports.SessionTimeoutEvent = exports.TestPlanSettingsChangedEvent = exports.TypeCacheInvalidatedEvent = exports.SessionEvent = exports.SessionEventName = exports.MetricValue = exports.MetricsConfiguration = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = 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.SessionState = exports.Verdict = exports.EditStatus = 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 = exports.SessionStartInitiated = exports.SessionEventArgs = void 0;
+exports.RunnerStatus = exports.StreamInfoStatus = exports.RemoteConnection = exports.SaveDefaultSettings = exports.AssetUpdatedEvent = exports.MetadataUpdatedEvent = exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEvent = exports.TestPlanRunStartEvent = exports.TestPlanRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.UserInputRequestCompletedEvent = exports.UserInputRequestedEvent = exports.BreakEvent = exports.TestStepChangedEvent = exports.SettingsChangedEvent = exports.HeartbeatEvent = exports.SessionStateChangedEvent = exports.TestPlanChangedEvent = exports.StoppedEvent = exports.StoppingEvent = void 0;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -1625,6 +1625,7 @@ var RepositoryPackageReference = /** @class */ (function () {
             this.version = _data['Version'];
             this.repository = _data['Repository'];
             this.path = _data['Path'];
+            this.pathId = _data['PathId'];
         }
     };
     RepositoryPackageReference.fromJS = function (data) {
@@ -1639,6 +1640,7 @@ var RepositoryPackageReference = /** @class */ (function () {
         data['Version'] = this.version;
         data['Repository'] = this.repository;
         data['Path'] = this.path;
+        data['PathId'] = this.pathId;
         return data;
     };
     return RepositoryPackageReference;
@@ -1704,6 +1706,62 @@ var RepositorySettingsPackageDefinition = /** @class */ (function (_super) {
     return RepositorySettingsPackageDefinition;
 }(RepositoryPackageDefinition));
 exports.RepositorySettingsPackageDefinition = RepositorySettingsPackageDefinition;
+var GetTestPlanReferenceResponse = /** @class */ (function () {
+    function GetTestPlanReferenceResponse(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    GetTestPlanReferenceResponse.prototype.init = function (_data) {
+        if (_data) {
+            this.testPlanReference = _data['TestPlanReference'] ? RepositoryPackageReference.fromJS(_data['TestPlanReference']) : undefined;
+        }
+    };
+    GetTestPlanReferenceResponse.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new GetTestPlanReferenceResponse();
+        result.init(data);
+        return result;
+    };
+    GetTestPlanReferenceResponse.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['TestPlanReference'] = this.testPlanReference ? this.testPlanReference.toJSON() : undefined;
+        return data;
+    };
+    return GetTestPlanReferenceResponse;
+}());
+exports.GetTestPlanReferenceResponse = GetTestPlanReferenceResponse;
+var SaveTestPlanToRepositoryResponse = /** @class */ (function () {
+    function SaveTestPlanToRepositoryResponse(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    SaveTestPlanToRepositoryResponse.prototype.init = function (_data) {
+        if (_data) {
+            this.testPlanReference = _data['TestPlanReference'] ? RepositoryPackageReference.fromJS(_data['TestPlanReference']) : undefined;
+        }
+    };
+    SaveTestPlanToRepositoryResponse.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new SaveTestPlanToRepositoryResponse();
+        result.init(data);
+        return result;
+    };
+    SaveTestPlanToRepositoryResponse.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['TestPlanReference'] = this.testPlanReference ? this.testPlanReference.toJSON() : undefined;
+        return data;
+    };
+    return SaveTestPlanToRepositoryResponse;
+}());
+exports.SaveTestPlanToRepositoryResponse = SaveTestPlanToRepositoryResponse;
 var SettingsTapPackage = /** @class */ (function () {
     function SettingsTapPackage(data) {
         if (data) {
@@ -2333,6 +2391,39 @@ var RunStatus = /** @class */ (function () {
     return RunStatus;
 }());
 exports.RunStatus = RunStatus;
+var EditStatus = /** @class */ (function () {
+    function EditStatus(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property)) {
+                    this[property] = data[property];
+                }
+            }
+        }
+    }
+    EditStatus.prototype.init = function (_data) {
+        if (_data) {
+            this.undoBufferSize = _data['UndoBufferSize'];
+            this.redoBufferSize = _data['RedoBufferSize'];
+            this.testPlanDirty = _data['TestPlanDirty'];
+        }
+    };
+    EditStatus.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new EditStatus();
+        result.init(data);
+        return result;
+    };
+    EditStatus.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['UndoBufferSize'] = this.undoBufferSize;
+        data['RedoBufferSize'] = this.redoBufferSize;
+        data['TestPlanDirty'] = this.testPlanDirty;
+        return data;
+    };
+    return EditStatus;
+}());
+exports.EditStatus = EditStatus;
 /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
 var Verdict;
 (function (Verdict) {
@@ -3322,11 +3413,27 @@ var StoppedEvent = /** @class */ (function (_super) {
 exports.StoppedEvent = StoppedEvent;
 var TestPlanChangedEvent = /** @class */ (function (_super) {
     __extends(TestPlanChangedEvent, _super);
-    function TestPlanChangedEvent() {
-        return _super.call(this, SessionEventName.TestPlanChanged) || this;
+    function TestPlanChangedEvent(data) {
+        var _this = _super.call(this, SessionEventName.TestPlanChanged) || this;
+        if (data === null || data === void 0 ? void 0 : data.editStatus) {
+            _this.editStatus = data.editStatus;
+        }
+        return _this;
     }
-    TestPlanChangedEvent.fromJS = function () {
-        return new TestPlanChangedEvent();
+    TestPlanChangedEvent.prototype.init = function (_data) {
+        var data = ensureObject(_data);
+        var payload = data['EditStatus'];
+        this.editStatus = payload ? EditStatus.fromJS(payload) : undefined;
+    };
+    TestPlanChangedEvent.fromJS = function (data) {
+        var result = new TestPlanChangedEvent();
+        result.init(data);
+        return result;
+    };
+    TestPlanChangedEvent.prototype.toJSON = function (data) {
+        var json = ensureObject(data);
+        json['EditStatus'] = this.editStatus ? this.editStatus.toJSON() : undefined;
+        return json;
     };
     return TestPlanChangedEvent;
 }(SessionEvent));

package/dist/cjs/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, SessionEventName, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, GetTestPlanReferenceResponse, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SaveTestPlanToRepositoryResponse, SessionEvent, SessionEventName, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog, EditStatus } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
@@ -115,6 +115,11 @@ export declare class SessionClient extends BaseClient {
      * @return RunStatus retrieved
      */
     getStatus(timeout: number | null | undefined): Promise<RunStatus>;
+    /**
+     * Get edit status that contains undo/redo buffer count and testplan dirty status
+     * @returns EditStatus retrieved
+     */
+    getEditStatus(): Promise<EditStatus>;
     /**
      * Upload test plan XML
      * @param xml Test Plan XML
@@ -131,6 +136,49 @@ export declare class SessionClient extends BaseClient {
      * @return Raw bytes representing the resource
      */
     downloadResource(resource: Resource): Promise<Uint8Array>;
+    /**
+     * Moves the test steps as children of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveStepsAsChildren(targetStepId: string, StepIds: string[]): void;
+    /**
+     * Moves the test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveSteps(targetStepId: string, StepIds: string[]): void;
+    /**
+     * Copy test steps
+     * @param stepIds test step ids to copy
+     * @return copied steps
+     */
+    copySteps(StepIds: string[]): Promise<string>;
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteStepsAsChildren(targetStepId: string, Clipboard: string): void;
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteSteps(targetStepId: string, Clipboard: string): void;
+    /**
+     * Delete test steps
+     * @param stepIds test step ids to delete
+     */
+    deleteSteps(StepIds: string[]): void;
+    /**
+     * Undo
+     */
+    testPlanUndo(): void;
+    /**
+     * Redo
+     */
+    testPlanRedo(): void;
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference
@@ -140,9 +188,9 @@ export declare class SessionClient extends BaseClient {
     /**
      * Save currently loaded test plan to a repository
      * @param {RepositoryPackageDefinition} packageReference
-     * @return Test plan uploaded.
+     * @return Test plan uploaded with reference.
      */
-    saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<void>;
+    saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<SaveTestPlanToRepositoryResponse>;
     /**
      * Test plan resources opened
      * @return Test plan resources opened.
@@ -184,6 +232,11 @@ export declare class SessionClient extends BaseClient {
      * @return {Promise<void>}
      */
     setTestPlanName(testPlanName: string): Promise<void>;
+    /**
+     * Gets the loaded test plan repository reference.
+     * @return {Promise<GetTestPlanReferenceResponse>}
+     */
+    getTestPlanReference(): Promise<GetTestPlanReferenceResponse>;
     /**
      * Retrieve all validation errors present in the test plan
      * @return Retrieved validation errors for loaded TestPlan

package/dist/cjs/SessionClient.js

@@ -31,6 +31,7 @@ exports.SessionClient = void 0;
 var DTOs_1 = require("./DTOs");
 var BaseClient_1 = require("./BaseClient");
 var encoders_1 = require("./encoders");
+var uuid_1 = require("uuid");
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
     function SessionClient(baseSubject, options) {
@@ -318,6 +319,16 @@ var SessionClient = /** @class */ (function (_super) {
             .then(this.success())
             .catch(this.error());
     };
+    /**
+     * Get edit status that contains undo/redo buffer count and testplan dirty status
+     * @returns EditStatus retrieved
+     */
+    SessionClient.prototype.getEditStatus = function () {
+        return this.request('GetEditStatus')
+            .then(function (editStatusJs) { return DTOs_1.EditStatus.fromJS(editStatusJs); })
+            .then(this.success())
+            .catch(this.error());
+    };
     /**
      * Upload test plan XML
      * @param xml Test Plan XML
@@ -349,6 +360,73 @@ var SessionClient = /** @class */ (function (_super) {
             .then(this.success())
             .catch(this.error());
     };
+    /**
+     * Moves the test steps as children of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    SessionClient.prototype.moveStepsAsChildren = function (targetStepId, StepIds) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        var TargetStepId = targetStepId ? targetStepId : uuid_1.NIL;
+        this.request('MoveStepsAsChildren', { StepIds: StepIds, TargetStepId: TargetStepId }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Moves the test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    SessionClient.prototype.moveSteps = function (targetStepId, StepIds) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        var TargetStepId = targetStepId ? targetStepId : uuid_1.NIL;
+        this.request('MoveSteps', { StepIds: StepIds, TargetStepId: TargetStepId }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Copy test steps
+     * @param stepIds test step ids to copy
+     * @return copied steps
+     */
+    SessionClient.prototype.copySteps = function (StepIds) {
+        return this.request('CopySteps', { StepIds: StepIds }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    SessionClient.prototype.pasteStepsAsChildren = function (targetStepId, Clipboard) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        var TargetStepId = targetStepId ? targetStepId : uuid_1.NIL;
+        this.request('PasteStepsAsChildren', { TargetStepId: TargetStepId, Clipboard: Clipboard }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    SessionClient.prototype.pasteSteps = function (targetStepId, Clipboard) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        var TargetStepId = targetStepId ? targetStepId : uuid_1.NIL;
+        this.request('PasteSteps', { TargetStepId: TargetStepId, Clipboard: Clipboard }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Delete test steps
+     * @param stepIds test step ids to delete
+     */
+    SessionClient.prototype.deleteSteps = function (StepIds) {
+        this.request('DeleteSteps', { StepIds: StepIds }).then(this.success()).catch(this.error());
+    };
+    /**
+     * Undo
+     */
+    SessionClient.prototype.testPlanUndo = function () {
+        this.request('TestPlanUndo').then(this.success()).catch(this.error());
+    };
+    /**
+     * Redo
+     */
+    SessionClient.prototype.testPlanRedo = function () {
+        this.request('TestPlanRedo').then(this.success()).catch(this.error());
+    };
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference
@@ -360,10 +438,12 @@ var SessionClient = /** @class */ (function (_super) {
     /**
      * Save currently loaded test plan to a repository
      * @param {RepositoryPackageDefinition} packageReference
-     * @return Test plan uploaded.
+     * @return Test plan uploaded with reference.
      */
     SessionClient.prototype.saveTestPlanToRepository = function (packageReference) {
-        return this.request('SaveTestPlanToRepository', packageReference).then(this.success()).catch(this.error());
+        return this.request('SaveTestPlanToRepository', packageReference)
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Test plan resources opened
@@ -439,6 +519,13 @@ var SessionClient = /** @class */ (function (_super) {
     SessionClient.prototype.setTestPlanName = function (testPlanName) {
         return this.request('SetTestPlanName', testPlanName).then(this.success()).catch(this.error());
     };
+    /**
+     * Gets the loaded test plan repository reference.
+     * @return {Promise<GetTestPlanReferenceResponse>}
+     */
+    SessionClient.prototype.getTestPlanReference = function () {
+        return this.request('GetTestPlanReference').then(this.success()).catch(this.error());
+    };
     /**
      * Retrieve all validation errors present in the test plan
      * @return Retrieved validation errors for loaded TestPlan
@@ -748,7 +835,7 @@ var SessionClient = /** @class */ (function (_super) {
         _a[DTOs_1.SessionEventName.Heartbeat] = function (payload) { return DTOs_1.HeartbeatEvent.fromJS(payload); },
         _a[DTOs_1.SessionEventName.Stopping] = function () { return DTOs_1.StoppingEvent.fromJS(); },
         _a[DTOs_1.SessionEventName.Stopped] = function () { return DTOs_1.StoppedEvent.fromJS(); },
-        _a[DTOs_1.SessionEventName.TestPlanChanged] = function () { return DTOs_1.TestPlanChangedEvent.fromJS(); },
+        _a[DTOs_1.SessionEventName.TestPlanChanged] = function (payload) { return DTOs_1.TestPlanChangedEvent.fromJS(payload); },
         _a[DTOs_1.SessionEventName.SessionStateChanged] = function (payload) { return DTOs_1.SessionStateChangedEvent.fromJS(payload); },
         _a[DTOs_1.SessionEventName.SettingsChanged] = function (payload) { return DTOs_1.SettingsChangedEvent.fromJS(payload); },
         _a[DTOs_1.SessionEventName.TestStepChanged] = function (payload) { return DTOs_1.TestStepChangedEvent.fromJS(payload); },

package/dist/mjs/DTOs.d.ts

@@ -569,6 +569,7 @@ export declare class RepositoryPackageReference implements IRepositoryPackageRef
     version?: string | undefined;
     repository?: string | undefined;
     path?: string | undefined;
+    pathId?: string | undefined;
     constructor(data?: IRepositoryPackageReference);
     init(_data?: any): void;
     static fromJS(data: any): RepositoryPackageReference;
@@ -579,6 +580,7 @@ export interface IRepositoryPackageReference {
     version?: string | undefined;
     repository?: string | undefined;
     path?: string | undefined;
+    pathId?: string | undefined;
 }
 export declare class RepositoryPackageDefinition extends RepositoryPackageReference implements IRepositoryPackageDefinition {
     tags?: string[] | undefined;
@@ -597,6 +599,26 @@ export declare class RepositorySettingsPackageDefinition extends RepositoryPacka
     toJSON(data?: any): any;
 }
 export declare type IRepositorySettingsPackageDefinition = IRepositoryPackageDefinition;
+export declare class GetTestPlanReferenceResponse implements IGetTestPlanReferenceResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+    constructor(data?: IGetTestPlanReferenceResponse);
+    init(_data?: any): void;
+    static fromJS(data: any): GetTestPlanReferenceResponse;
+    toJSON(data?: any): any;
+}
+export interface IGetTestPlanReferenceResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+}
+export declare class SaveTestPlanToRepositoryResponse implements ISaveTestPlanToRepositoryResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+    constructor(data?: ISaveTestPlanToRepositoryResponse);
+    init(_data?: any): void;
+    static fromJS(data: any): SaveTestPlanToRepositoryResponse;
+    toJSON(data?: any): any;
+}
+export interface ISaveTestPlanToRepositoryResponse {
+    testPlanReference?: RepositoryPackageReference | undefined;
+}
 export declare class SettingsTapPackage implements ISettingsTapPackage {
     name?: string | undefined;
     version?: string | undefined;
@@ -824,6 +846,20 @@ export interface IRunStatus {
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
 }
+export declare class EditStatus implements IEditStatus {
+    undoBufferSize?: number;
+    redoBufferSize?: number;
+    testPlanDirty?: boolean;
+    constructor(data?: IEditStatus);
+    init(_data?: any): void;
+    static fromJS(data: any): EditStatus;
+    toJSON(data?: any): any;
+}
+export interface IEditStatus {
+    undoBufferSize?: number;
+    redoBufferSize?: number;
+    testPlanDirty?: boolean;
+}
 /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
 export declare enum Verdict {
     NotSet = "NotSet",
@@ -1205,8 +1241,13 @@ export declare class StoppedEvent extends SessionEvent {
     static fromJS(): StoppedEvent;
 }
 export declare class TestPlanChangedEvent extends SessionEvent {
-    constructor();
-    static fromJS(): TestPlanChangedEvent;
+    editStatus?: EditStatus;
+    constructor(data?: {
+        editStatus?: EditStatus;
+    });
+    init(_data: any): void;
+    static fromJS(data: any): TestPlanChangedEvent;
+    toJSON(data?: any): any;
 }
 export declare class SessionStateChangedEvent extends SessionEvent {
     runStatus?: RunStatus | undefined;

package/dist/mjs/DTOs.js

@@ -1416,6 +1416,7 @@ export class RepositoryPackageReference {
             this.version = _data['Version'];
             this.repository = _data['Repository'];
             this.path = _data['Path'];
+            this.pathId = _data['PathId'];
         }
     }
     static fromJS(data) {
@@ -1430,6 +1431,7 @@ export class RepositoryPackageReference {
         data['Version'] = this.version;
         data['Repository'] = this.repository;
         data['Path'] = this.path;
+        data['PathId'] = this.pathId;
         return data;
     }
 }
@@ -1483,6 +1485,58 @@ export class RepositorySettingsPackageDefinition extends RepositoryPackageDefini
         return data;
     }
 }
+export class GetTestPlanReferenceResponse {
+    constructor(data) {
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.testPlanReference = _data['TestPlanReference'] ? RepositoryPackageReference.fromJS(_data['TestPlanReference']) : undefined;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new GetTestPlanReferenceResponse();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['TestPlanReference'] = this.testPlanReference ? this.testPlanReference.toJSON() : undefined;
+        return data;
+    }
+}
+export class SaveTestPlanToRepositoryResponse {
+    constructor(data) {
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.testPlanReference = _data['TestPlanReference'] ? RepositoryPackageReference.fromJS(_data['TestPlanReference']) : undefined;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new SaveTestPlanToRepositoryResponse();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['TestPlanReference'] = this.testPlanReference ? this.testPlanReference.toJSON() : undefined;
+        return data;
+    }
+}
 export class SettingsTapPackage {
     constructor(data) {
         if (data) {
@@ -2038,6 +2092,37 @@ export class RunStatus {
         return data;
     }
 }
+export class EditStatus {
+    constructor(data) {
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property)) {
+                    this[property] = data[property];
+                }
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.undoBufferSize = _data['UndoBufferSize'];
+            this.redoBufferSize = _data['RedoBufferSize'];
+            this.testPlanDirty = _data['TestPlanDirty'];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new EditStatus();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['UndoBufferSize'] = this.undoBufferSize;
+        data['RedoBufferSize'] = this.redoBufferSize;
+        data['TestPlanDirty'] = this.testPlanDirty;
+        return data;
+    }
+}
 /** Enumeration containing the verdict types used for Verdict and Verdict properties. */
 export var Verdict;
 (function (Verdict) {
@@ -2903,11 +2988,26 @@ export class StoppedEvent extends SessionEvent {
     }
 }
 export class TestPlanChangedEvent extends SessionEvent {
-    constructor() {
+    constructor(data) {
         super(SessionEventName.TestPlanChanged);
+        if (data === null || data === void 0 ? void 0 : data.editStatus) {
+            this.editStatus = data.editStatus;
+        }
     }
-    static fromJS() {
-        return new TestPlanChangedEvent();
+    init(_data) {
+        const data = ensureObject(_data);
+        const payload = data['EditStatus'];
+        this.editStatus = payload ? EditStatus.fromJS(payload) : undefined;
+    }
+    static fromJS(data) {
+        const result = new TestPlanChangedEvent();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        const json = ensureObject(data);
+        json['EditStatus'] = this.editStatus ? this.editStatus.toJSON() : undefined;
+        return json;
     }
 }
 export class SessionStateChangedEvent extends SessionEvent {

package/dist/mjs/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, SessionEventName, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, GetTestPlanReferenceResponse, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SaveTestPlanToRepositoryResponse, SessionEvent, SessionEventName, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog, EditStatus } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
@@ -115,6 +115,11 @@ export declare class SessionClient extends BaseClient {
      * @return RunStatus retrieved
      */
     getStatus(timeout: number | null | undefined): Promise<RunStatus>;
+    /**
+     * Get edit status that contains undo/redo buffer count and testplan dirty status
+     * @returns EditStatus retrieved
+     */
+    getEditStatus(): Promise<EditStatus>;
     /**
      * Upload test plan XML
      * @param xml Test Plan XML
@@ -131,6 +136,49 @@ export declare class SessionClient extends BaseClient {
      * @return Raw bytes representing the resource
      */
     downloadResource(resource: Resource): Promise<Uint8Array>;
+    /**
+     * Moves the test steps as children of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveStepsAsChildren(targetStepId: string, StepIds: string[]): void;
+    /**
+     * Moves the test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveSteps(targetStepId: string, StepIds: string[]): void;
+    /**
+     * Copy test steps
+     * @param stepIds test step ids to copy
+     * @return copied steps
+     */
+    copySteps(StepIds: string[]): Promise<string>;
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteStepsAsChildren(targetStepId: string, Clipboard: string): void;
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteSteps(targetStepId: string, Clipboard: string): void;
+    /**
+     * Delete test steps
+     * @param stepIds test step ids to delete
+     */
+    deleteSteps(StepIds: string[]): void;
+    /**
+     * Undo
+     */
+    testPlanUndo(): void;
+    /**
+     * Redo
+     */
+    testPlanRedo(): void;
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference
@@ -140,9 +188,9 @@ export declare class SessionClient extends BaseClient {
     /**
      * Save currently loaded test plan to a repository
      * @param {RepositoryPackageDefinition} packageReference
-     * @return Test plan uploaded.
+     * @return Test plan uploaded with reference.
      */
-    saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<void>;
+    saveTestPlanToRepository(packageReference: RepositoryPackageDefinition): Promise<SaveTestPlanToRepositoryResponse>;
     /**
      * Test plan resources opened
      * @return Test plan resources opened.
@@ -184,6 +232,11 @@ export declare class SessionClient extends BaseClient {
      * @return {Promise<void>}
      */
     setTestPlanName(testPlanName: string): Promise<void>;
+    /**
+     * Gets the loaded test plan repository reference.
+     * @return {Promise<GetTestPlanReferenceResponse>}
+     */
+    getTestPlanReference(): Promise<GetTestPlanReferenceResponse>;
     /**
      * Retrieve all validation errors present in the test plan
      * @return Retrieved validation errors for loaded TestPlan

package/dist/mjs/SessionClient.js

@@ -1,6 +1,7 @@
-import { BreakEvent, BreakPoints, CommonContext, CommonSettings, DataGridControl, HeartbeatEvent, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Result, RunStatus, SessionEventName, SessionStateChangedEvent, SessionTimeoutEvent, Setting, SettingsChangedEvent, StartingEvent, StartedEvent, StoppedEvent, StoppingEvent, TestPlan, TestPlanChangedEvent, TestPlanSettingsChangedEvent, TestStepChangedEvent, TestStepType, TestStepValidationError, TypeCacheInvalidatedEvent, UserInputRequestCompletedEvent, UserInputRequestedEvent, WatchDog, } from './DTOs';
+import { BreakEvent, BreakPoints, CommonContext, CommonSettings, DataGridControl, HeartbeatEvent, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Result, RunStatus, SessionEventName, SessionStateChangedEvent, SessionTimeoutEvent, Setting, SettingsChangedEvent, StartingEvent, StartedEvent, StoppedEvent, StoppingEvent, TestPlan, TestPlanChangedEvent, TestPlanSettingsChangedEvent, TestStepChangedEvent, TestStepType, TestStepValidationError, TypeCacheInvalidatedEvent, UserInputRequestCompletedEvent, UserInputRequestedEvent, WatchDog, EditStatus, } from './DTOs';
 import { BaseClient } from './BaseClient';
 import { jsonCodec } from './encoders';
+import { NIL } from 'uuid';
 export class SessionClient extends BaseClient {
     constructor(baseSubject, options) {
         super(baseSubject, options);
@@ -280,6 +281,16 @@ export class SessionClient extends BaseClient {
             .then(this.success())
             .catch(this.error());
     }
+    /**
+     * Get edit status that contains undo/redo buffer count and testplan dirty status
+     * @returns EditStatus retrieved
+     */
+    getEditStatus() {
+        return this.request('GetEditStatus')
+            .then(editStatusJs => EditStatus.fromJS(editStatusJs))
+            .then(this.success())
+            .catch(this.error());
+    }
     /**
      * Upload test plan XML
      * @param xml Test Plan XML
@@ -311,6 +322,73 @@ export class SessionClient extends BaseClient {
             .then(this.success())
             .catch(this.error());
     }
+    /**
+     * Moves the test steps as children of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveStepsAsChildren(targetStepId, StepIds) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        const TargetStepId = targetStepId ? targetStepId : NIL;
+        this.request('MoveStepsAsChildren', { StepIds, TargetStepId }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Moves the test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param StepIds test steps ids to move
+     */
+    moveSteps(targetStepId, StepIds) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        const TargetStepId = targetStepId ? targetStepId : NIL;
+        this.request('MoveSteps', { StepIds, TargetStepId }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Copy test steps
+     * @param stepIds test step ids to copy
+     * @return copied steps
+     */
+    copySteps(StepIds) {
+        return this.request('CopySteps', { StepIds }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteStepsAsChildren(targetStepId, Clipboard) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        const TargetStepId = targetStepId ? targetStepId : NIL;
+        this.request('PasteStepsAsChildren', { TargetStepId, Clipboard }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Paste copied test steps as sibling of target step
+     * @param TargetStepId target test step id
+     * @param Clipboard test steps copied to clipboard
+     */
+    pasteSteps(targetStepId, Clipboard) {
+        // need to send GUID.EMPTY if target step id is empty, so that runner can parse correctly
+        const TargetStepId = targetStepId ? targetStepId : NIL;
+        this.request('PasteSteps', { TargetStepId, Clipboard }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Delete test steps
+     * @param stepIds test step ids to delete
+     */
+    deleteSteps(StepIds) {
+        this.request('DeleteSteps', { StepIds }).then(this.success()).catch(this.error());
+    }
+    /**
+     * Undo
+     */
+    testPlanUndo() {
+        this.request('TestPlanUndo').then(this.success()).catch(this.error());
+    }
+    /**
+     * Redo
+     */
+    testPlanRedo() {
+        this.request('TestPlanRedo').then(this.success()).catch(this.error());
+    }
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference
@@ -322,10 +400,12 @@ export class SessionClient extends BaseClient {
     /**
      * Save currently loaded test plan to a repository
      * @param {RepositoryPackageDefinition} packageReference
-     * @return Test plan uploaded.
+     * @return Test plan uploaded with reference.
      */
     saveTestPlanToRepository(packageReference) {
-        return this.request('SaveTestPlanToRepository', packageReference).then(this.success()).catch(this.error());
+        return this.request('SaveTestPlanToRepository', packageReference)
+            .then(this.success())
+            .catch(this.error());
     }
     /**
      * Test plan resources opened
@@ -401,6 +481,13 @@ export class SessionClient extends BaseClient {
     setTestPlanName(testPlanName) {
         return this.request('SetTestPlanName', testPlanName).then(this.success()).catch(this.error());
     }
+    /**
+     * Gets the loaded test plan repository reference.
+     * @return {Promise<GetTestPlanReferenceResponse>}
+     */
+    getTestPlanReference() {
+        return this.request('GetTestPlanReference').then(this.success()).catch(this.error());
+    }
     /**
      * Retrieve all validation errors present in the test plan
      * @return Retrieved validation errors for loaded TestPlan
@@ -709,7 +796,7 @@ SessionClient.sessionEventFactories = {
     [SessionEventName.Heartbeat]: payload => HeartbeatEvent.fromJS(payload),
     [SessionEventName.Stopping]: () => StoppingEvent.fromJS(),
     [SessionEventName.Stopped]: () => StoppedEvent.fromJS(),
-    [SessionEventName.TestPlanChanged]: () => TestPlanChangedEvent.fromJS(),
+    [SessionEventName.TestPlanChanged]: payload => TestPlanChangedEvent.fromJS(payload),
     [SessionEventName.SessionStateChanged]: payload => SessionStateChangedEvent.fromJS(payload),
     [SessionEventName.SettingsChanged]: payload => SettingsChangedEvent.fromJS(payload),
     [SessionEventName.TestStepChanged]: payload => TestStepChangedEvent.fromJS(payload),

package/package.json

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