@opentap/runner-client 2.14.0 → 2.15.0-alpha.1.3

package/lib/DTOs.d.ts

@@ -1,7 +1,7 @@
 export declare class Image implements IImage {
     name?: string | undefined;
-    packages?: PackageSpecifier[] | undefined;
-    repositories?: string[] | undefined;
+    packages?: PackageSpecifier[];
+    repositories?: string[];
     id?: string | undefined;
     constructor(data?: IImage);
     init(_data?: any): void;

package/lib/DTOs.js

@@ -15,6 +15,8 @@ var __extends = (this && this.__extends) || (function () {
 })();
 var Image = /** @class */ (function () {
     function Image(data) {
+        this.packages = [];
+        this.repositories = [];
         if (data) {
             for (var property in data) {
                 if (Object.prototype.hasOwnProperty.call(data, property))

package/lib/RunnerClient.d.ts

@@ -1,7 +1,14 @@
-import { Image, Session } from './DTOs';
+import { Image, RepositoryPackageReference, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 import { ConnectionOptions } from 'nats.ws';
 export declare class RunnerClient extends BaseClient {
+    default: {
+        startSession: (testPlanRepositoryReference?: RepositoryPackageReference, timeout?: number) => Promise<Session>;
+        getImage: () => Promise<Image>;
+        setImage: (image: Image) => Promise<Image>;
+        getSettings: () => Promise<RepositoryPackageReference | undefined>;
+        setSettings: (repositoryPackageReference: RepositoryPackageReference) => Promise<void>;
+    };
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * Get the created image with the specified ID.
@@ -26,6 +33,13 @@ export declare class RunnerClient extends BaseClient {
      * @returns {{Promise<Image>}}
      */
     resolveImage(images: Image[], timeout?: number): Promise<Image>;
+    /**
+     * Dry runs to resolve an image from a list of images. Dry run means that no packages will be downloaded.
+     * @param {Image[]} images List of images
+     * @param {number} timeout Optional timeout in milliseconds
+     * @returns {{Promise<Image>}}
+     */
+    resolveImageDryRun(images: Image[], timeout?: number): Promise<Image>;
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down

package/lib/RunnerClient.js

@@ -13,12 +13,56 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-import { Image, Session } from './DTOs';
+import { Image, RepositoryPackageReference, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 var RunnerClient = /** @class */ (function (_super) {
     __extends(RunnerClient, _super);
     function RunnerClient(baseSubject, options) {
-        return _super.call(this, baseSubject, options) || this;
+        var _this = _super.call(this, baseSubject, options) || this;
+        // Contains the endpoints for Defaults in the runner plugin.
+        _this.default = {
+            /* Create a Session based on the dependencies of a TestPlan. Returned
+            Session will have referenced TestPlan pre-loaded. The Session will be
+            created with the base image and base settings. */
+            startSession: function (testPlanRepositoryReference, timeout) {
+                return _this.request('StartDefaultSession', testPlanRepositoryReference !== null && testPlanRepositoryReference !== void 0 ? testPlanRepositoryReference : null, { timeout: timeout })
+                    .then(function (sessionJs) { return Session.fromJS(sessionJs); })
+                    .then(_this.success())
+                    .catch(_this.error());
+            },
+            /* Gets the base image. The base image is always included in the image
+            creation process */
+            getImage: function () {
+                return _this.request('GetDefaultImage')
+                    .then(function (imageJs) { return Image.fromJS(imageJs); })
+                    .then(_this.success())
+                    .catch(_this.error());
+            },
+            /* Sets the base image. The specified image is resolved and set as the
+            base image */
+            setImage: function (image) {
+                return _this.request('SetDefaultImage', image)
+                    .then(function (imageJs) { return Image.fromJS(imageJs); })
+                    .then(_this.success())
+                    .catch(_this.error());
+            },
+            /* Gets the base settings package. The base settings is always included
+            in the image creation process and loaded into the created session */
+            getSettings: function () {
+                return _this.request('GetDefaultSettings')
+                    .then(function (repositoryPackageReferenceJs) {
+                    return repositoryPackageReferenceJs ? RepositoryPackageReference.fromJS(repositoryPackageReferenceJs) : undefined;
+                })
+                    .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());
+            },
+        };
+        return _this;
     }
     /**
      * Get the created image with the specified ID.
@@ -67,6 +111,20 @@ var RunnerClient = /** @class */ (function (_super) {
                 .catch(this.error())
             : Promise.reject('images list is not defined or is empty');
     };
+    /**
+     * Dry runs to resolve an image from a list of images. Dry run means that no packages will be downloaded.
+     * @param {Image[]} images List of images
+     * @param {number} timeout Optional timeout in milliseconds
+     * @returns {{Promise<Image>}}
+     */
+    RunnerClient.prototype.resolveImageDryRun = function (images, timeout) {
+        return (images === null || images === void 0 ? void 0 : images.length) > 0
+            ? this.request('ResolveImageDryRun', images, { timeout: timeout })
+                .then(function (imageJs) { return Image.fromJS(imageJs); })
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('images list is not defined or is empty');
+    };
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.14.0",
+  "version": "2.15.0-alpha.1.3",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",