@opentap/runner-client 2.7.1 → 2.8.0-alpha.1.2

package/lib/BaseClient.d.ts

@@ -1,3 +1,4 @@
+import { DownloadTapSettingsRequest } from './requestDTOs';
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions, PublishOptions } from 'nats.ws';
 interface BaseClientRequestOptions {
@@ -200,6 +201,12 @@ export declare class BaseClient {
      * @returns {Promise<void>}
      */
     uploadComponentSettings(file: FileParameter): Promise<string[]>;
+    /**
+     * Downloads a .TapSettings file containing the settings for a given component settings group
+     * @param {DownloadTapSettingsRequest} tapSettingsRequest The download request specifying the component settings group to download
+     * @returns {Promise<Uint8Array>} A byte array containing the downloaded .TapSettings file
+     */
+    downloadComponentSettings(tapSettingsRequest: DownloadTapSettingsRequest): Promise<Uint8Array>;
     /**
      * Load a component settings TapPackage by referencing a package in a package repository
      * @param {RepositoryPackageReference} packageReference

package/lib/BaseClient.js

@@ -593,6 +593,16 @@ var BaseClient = /** @class */ (function () {
             ? this.request('UploadComponentSettings', file).then(this.success()).catch(this.error())
             : Promise.reject('file must be defined');
     };
+    /**
+     * Downloads a .TapSettings file containing the settings for a given component settings group
+     * @param {DownloadTapSettingsRequest} tapSettingsRequest The download request specifying the component settings group to download
+     * @returns {Promise<Uint8Array>} A byte array containing the downloaded .TapSettings file
+     */
+    BaseClient.prototype.downloadComponentSettings = function (tapSettingsRequest) {
+        return this.request('DownloadComponentSettings', tapSettingsRequest, { rawResponse: true })
+            .then(this.success())
+            .catch(this.error());
+    };
     /**
      * Load a component settings TapPackage by referencing a package in a package repository
      * @param {RepositoryPackageReference} packageReference

package/lib/requestDTOs.d.ts

@@ -66,3 +66,6 @@ export interface AddComponentSettingDataGridItemTypeRequest extends GetComponent
 export interface AddComponentSettingsListItemRequest extends GetComponentSettingsRequest {
     typeName: string | undefined;
 }
+export interface DownloadTapSettingsRequest {
+    groupName: string | undefined;
+}

package/package.json

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