@opentap/runner-client 1.0.0-alpha.37.12 → 1.0.0-alpha.72

package/lib/BaseClient.d.ts

@@ -1,4 +1,5 @@
-import { RequestOptions } from 'nats.ws';
+import { ConnectionOptions, RequestOptions } from 'nats.ws/cjs/nats.js';
+import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
 export declare class BaseClient {
     private _accessToken;
     /** Get access token */
@@ -10,15 +11,15 @@ export declare class BaseClient {
     get timeout(): number;
     /** Set timeout */
     set timeout(value: number);
-    private _natsServer;
-    /** Get nats server */
-    get natsServer(): string;
     private _baseSubject;
     /** Get subject */
     get baseSubject(): string;
+    private _connectionOptions;
+    /** Get connection options */
+    get connectionOptions(): ConnectionOptions;
     private domainAccess;
     private natsConnection;
-    constructor(baseSubject: string, natsServer?: string);
+    constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * Send a request to the nats server.
      * @param subject The subject to request
@@ -34,11 +35,165 @@ export declare class BaseClient {
     /**
      * Close the connection.
      */
-    private close;
+    close(): Promise<void>;
     /**
      * Add a domain specific access token to the dictionary.
      * @param domain
      * @param accessToken
      */
     protected setDomainAccessToken(domain: string, accessToken: string): void;
+    /**
+     * Generic error callback function.
+     * @returns
+     */
+    protected error(): ((reason: any) => PromiseLike<never>) | null | undefined;
+    /**
+     * Generic success callback function.
+     * @returns
+     */
+    protected success<T>(): ((value: T) => T | PromiseLike<T>) | null | undefined;
+    /**
+     * Retrieve component settings overview
+     * @returns {{Promise<ComponentSettingsIdentifier[]>}}
+     */
+    getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
+    /**
+     * Change componentsettings
+     * @param groupName
+     * @param name
+     * @param returnedSettings
+     * @returns {{Promise<ComponentSettingsBase>}}
+     */
+    setComponentSettings(groupName: string, name: string, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
+    /**
+     * Retrieve componentsettings
+     * @param groupName
+     * @param name
+     * @returns {{Promise<ComponentSettingsBase>}}
+     */
+    getComponentSettings(groupName: string, name: string): Promise<ComponentSettingsBase>;
+    /**
+     * Retrieve componentsettings list item
+     * @param groupName
+     * @param name
+     * @param index
+     * @returns {{Promise<ComponentSettingsListItem>}}
+     */
+    getComponentSettingsListItem(groupName: string, name: string, index: number): Promise<ComponentSettingsListItem>;
+    /**
+     * Set componentsettings list item settings
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {ComponentSettingsListItem} item
+     * @returns {Promise<ComponentSettingsListItem>}
+     */
+    setComponentSettingsListItem(groupName: string, name: string, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
+    /**
+     * Get component setting data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @returns {Promise<DataGridControl>}
+     */
+    getComponentSettingDataGrid(groupName: string, name: string, index: number, propertyName: string): Promise<DataGridControl>;
+    /**
+     * Set component setting data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @param {DataGridControl} dataGridControl
+     * @returns {{Promise<DataGridControl>}}
+     */
+    setComponentSettingDataGrid(groupName: string, name: string, index: number, propertyName: string, dataGridControl: DataGridControl): Promise<DataGridControl>;
+    /**
+     * Add component setting item type to data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @param {string} typeName
+     * @returns {Promise<DataGridControl>}
+     */
+    addComponentSettingDataGridItemType(groupName: string, name: string, index: number, propertyName: string, typeName: string): Promise<DataGridControl>;
+    /**
+     * Add component setting item to data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @returns {Promise<DataGridControl>}
+     */
+    addComponentSettingDataGridItem(groupName: string, name: string, index: number, propertyName: string): Promise<DataGridControl>;
+    /**
+     * Get item types available in the component setting data grid
+     * @param groupName
+     * @param name
+     * @param index
+     * @param propertyName
+     * @returns {Promise<ListItemType[]>}
+     */
+    getComponentSettingDataGridTypes(groupName: string, name: string, index: number, propertyName: string): Promise<ListItemType[]>;
+    /**
+     * Change componentsettings profiles
+     * @param {ProfileGroup[]} returnedSettings
+     * @returns {Promise<ProfileGroup[]>}
+     */
+    setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
+    /**
+     * Get componentsettings profiles
+     * @returns {Promise<ProfileGroup[]>}
+     */
+    getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
+    /**
+     * Upload exported OpenTAP Settings files
+     * @param {FileParameter} file
+     * @returns {Promise<void>}
+     */
+    uploadComponentSettings(file: FileParameter): Promise<void>;
+    /**
+     * Load a component settings TapPackage by referencing a package in a package repository
+     * @param {RepositoryPackageReference} packageReference
+     * @returns {Promise<ErrorResponse[]>}
+     */
+    loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
+    /**
+     * Save a TapPackage containing component settings in a package repository
+     * @param {RepositorySettingsPackageDefinition} repositoryPackageDefinition
+     * @returns {Promise<void>}
+     */
+    saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
+    /**
+     * Retrieve types available to be added to specified component settings list
+     * @param {string} groupName
+     * @param {string} name
+     * @returns {Promise<ListItemType[]>}
+     */
+    getComponentSettingsListAvailableTypes(groupName: string, name: string): Promise<ListItemType[]>;
+    /**
+     * Adds a new item to a component settings list
+     * @param {string} groupName
+     * @param {string} name
+     * @param {string} typeName
+     * @returns {Promise<ListItemType[]>}
+     */
+    addComponentSettingsListItem(groupName: string, name: string, typeName: string): Promise<ListItemType[]>;
+    /**
+     * Get settings package files
+     * @returns {Promise<string[]>}
+     */
+    getSettingsPackageFiles(): Promise<string[]>;
+    /**
+     * Get settings package types
+     * @returns {Promise<string[]>}
+     */
+    settingsPackageTypes(): Promise<string[]>;
+    /**
+     * Download a TapPackage containing settings files
+     * @param {SettingsPackage} settingsTapPackage
+     * @returns {Promise<FileResponse>}
+     */
+    downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
 }

package/lib/BaseClient.js

@@ -34,15 +34,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { connect, Empty, JSONCodec, StringCodec } from 'nats.ws';
+// ! import { connect, ConnectionOptions, Empty, JSONCodec, NatsConnection, RequestOptions, StringCodec } from 'nats.ws' if consuming this library in angular >= 13.
+import { connect, Empty, JSONCodec, StringCodec } from 'nats.ws/cjs/nats.js';
 var BaseClient = /** @class */ (function () {
-    function BaseClient(baseSubject, natsServer) {
-        if (natsServer === void 0) { natsServer = 'ws://localhost:443'; }
+    function BaseClient(baseSubject, options) {
         this.domainAccess = new Map();
         this._baseSubject = baseSubject;
-        this._natsServer = natsServer;
-        if (baseSubject && natsServer)
-            this.connect();
+        this._connectionOptions = options || { servers: 'ws://localhost:443' };
+        var undefinedSubject = function () {
+            throw new Error('A base subject must be specified');
+        };
+        baseSubject ? this.connect(this._connectionOptions) : undefinedSubject();
     }
     Object.defineProperty(BaseClient.prototype, "accessToken", {
         /** Get access token */
@@ -68,18 +70,18 @@ var BaseClient = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(BaseClient.prototype, "natsServer", {
-        /** Get nats server */
+    Object.defineProperty(BaseClient.prototype, "baseSubject", {
+        /** Get subject */
         get: function () {
-            return this._natsServer;
+            return this._baseSubject;
         },
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(BaseClient.prototype, "baseSubject", {
-        /** Get subject */
+    Object.defineProperty(BaseClient.prototype, "connectionOptions", {
+        /** Get connection options */
         get: function () {
-            return this._baseSubject;
+            return this._connectionOptions;
         },
         enumerable: false,
         configurable: true
@@ -122,15 +124,14 @@ var BaseClient = /** @class */ (function () {
     /**
      * Create a connection to the nats server.
      */
-    BaseClient.prototype.connect = function () {
+    BaseClient.prototype.connect = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var options, error_1;
+            var error_1;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        options = { servers: this._natsServer };
                         return [4 /*yield*/, connect(options).then(function (connection) {
                                 _this.natsConnection = connection;
                             })];
@@ -139,7 +140,7 @@ var BaseClient = /** @class */ (function () {
                         return [3 /*break*/, 3];
                     case 2:
                         error_1 = _a.sent();
-                        throw new Error("error connecting to ".concat(this.natsServer));
+                        throw new Error("connection to ".concat(options.servers, " failed due to ").concat(error_1));
                     case 3: return [2 /*return*/];
                 }
             });
@@ -176,6 +177,301 @@ var BaseClient = /** @class */ (function () {
             return;
         this.domainAccess.set(domain, accessToken);
     };
+    /**
+     * Generic error callback function.
+     * @returns
+     */
+    BaseClient.prototype.error = function () {
+        return function (error) {
+            throw new Error(error);
+        };
+    };
+    /**
+     * Generic success callback function.
+     * @returns
+     */
+    BaseClient.prototype.success = function () {
+        return function (response) { return response; };
+    };
+    /**
+     * Retrieve component settings overview
+     * @returns {{Promise<ComponentSettingsIdentifier[]>}}
+     */
+    BaseClient.prototype.getComponentSettingsOverview = function () {
+        return this.request('GetComponentSettingsOverview').then(this.success()).catch(this.error());
+    };
+    /**
+     * Change componentsettings
+     * @param groupName
+     * @param name
+     * @param returnedSettings
+     * @returns {{Promise<ComponentSettingsBase>}}
+     */
+    BaseClient.prototype.setComponentSettings = function (groupName, name, returnedSettings) {
+        var setComponentSettingsRequest = { groupName: groupName, name: name, returnedSettings: returnedSettings };
+        return groupName && name && returnedSettings
+            ? this.request('SetComponentSettings', setComponentSettingsRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Retrieve componentsettings
+     * @param groupName
+     * @param name
+     * @returns {{Promise<ComponentSettingsBase>}}
+     */
+    BaseClient.prototype.getComponentSettings = function (groupName, name) {
+        var getComponentSettingsRequest = { groupName: groupName, name: name };
+        return groupName && name
+            ? this.request('GetComponentSettings', getComponentSettingsRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Retrieve componentsettings list item
+     * @param groupName
+     * @param name
+     * @param index
+     * @returns {{Promise<ComponentSettingsListItem>}}
+     */
+    BaseClient.prototype.getComponentSettingsListItem = function (groupName, name, index) {
+        var getComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index };
+        return groupName && name
+            ? this.request('GetComponentSettingsListItem', getComponentSettingsListItemRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Set componentsettings list item settings
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {ComponentSettingsListItem} item
+     * @returns {Promise<ComponentSettingsListItem>}
+     */
+    BaseClient.prototype.setComponentSettingsListItem = function (groupName, name, index, item) {
+        var setComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index, item: item };
+        return groupName && name && item
+            ? this.request('SetComponentSettingsListItem', setComponentSettingsListItemRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Get component setting data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @returns {Promise<DataGridControl>}
+     */
+    BaseClient.prototype.getComponentSettingDataGrid = function (groupName, name, index, propertyName) {
+        var getComponentSettingDataGridRequest = {
+            groupName: groupName,
+            name: name,
+            index: index,
+            propertyName: propertyName,
+        };
+        return groupName && name && propertyName
+            ? this.request('GetComponentSettingDataGrid', getComponentSettingDataGridRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Set component setting data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @param {DataGridControl} dataGridControl
+     * @returns {{Promise<DataGridControl>}}
+     */
+    BaseClient.prototype.setComponentSettingDataGrid = function (groupName, name, index, propertyName, dataGridControl) {
+        var setComponentSettingDataGridRequest = {
+            groupName: groupName,
+            name: name,
+            index: index,
+            propertyName: propertyName,
+            dataGridControl: dataGridControl,
+        };
+        return groupName && name && propertyName && dataGridControl
+            ? this.request('SetComponentSettingDataGrid', setComponentSettingDataGridRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Add component setting item type to data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @param {string} typeName
+     * @returns {Promise<DataGridControl>}
+     */
+    BaseClient.prototype.addComponentSettingDataGridItemType = function (groupName, name, index, propertyName, typeName) {
+        var addComponentSettingDataGridItemTypeRequest = {
+            groupName: groupName,
+            name: name,
+            index: index,
+            propertyName: propertyName,
+            typeName: typeName,
+        };
+        return groupName && name && propertyName && typeName
+            ? this.request('AddComponentSettingDataGridItemType', addComponentSettingDataGridItemTypeRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Add component setting item to data grid
+     * @param {string} groupName
+     * @param {string} name
+     * @param {number} index
+     * @param {string} propertyName
+     * @returns {Promise<DataGridControl>}
+     */
+    BaseClient.prototype.addComponentSettingDataGridItem = function (groupName, name, index, propertyName) {
+        var getComponentSettingDataGridRequest = {
+            groupName: groupName,
+            name: name,
+            index: index,
+            propertyName: propertyName,
+        };
+        return groupName && name && propertyName
+            ? this.request('AddComponentSettingDataGridItem', getComponentSettingDataGridRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Get item types available in the component setting data grid
+     * @param groupName
+     * @param name
+     * @param index
+     * @param propertyName
+     * @returns {Promise<ListItemType[]>}
+     */
+    BaseClient.prototype.getComponentSettingDataGridTypes = function (groupName, name, index, propertyName) {
+        var getComponentSettingDataGridRequest = {
+            groupName: groupName,
+            name: name,
+            index: index,
+            propertyName: propertyName,
+        };
+        return groupName && name && propertyName
+            ? this.request('GetComponentSettingDataGridTypes', getComponentSettingDataGridRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Change componentsettings profiles
+     * @param {ProfileGroup[]} returnedSettings
+     * @returns {Promise<ProfileGroup[]>}
+     */
+    BaseClient.prototype.setComponentSettingsProfiles = function (returnedSettings) {
+        return returnedSettings
+            ? this.request('SetComponentSettingsProfiles', returnedSettings).then(this.success()).catch(this.error())
+            : Promise.reject('returnedSettings must be defined');
+    };
+    /**
+     * Get componentsettings profiles
+     * @returns {Promise<ProfileGroup[]>}
+     */
+    BaseClient.prototype.getComponentSettingsProfiles = function () {
+        return this.request('GetComponentSettingsProfiles').then(this.success()).catch(this.error());
+    };
+    /**
+     * Upload exported OpenTAP Settings files
+     * @param {FileParameter} file
+     * @returns {Promise<void>}
+     */
+    BaseClient.prototype.uploadComponentSettings = function (file) {
+        var uploadFileRequest = { file: file, fileName: file === null || file === void 0 ? void 0 : file.fileName };
+        return file
+            ? this.request('UploadComponentSettings', uploadFileRequest).then(this.success()).catch(this.error())
+            : Promise.reject('file must be defined');
+    };
+    /**
+     * Load a component settings TapPackage by referencing a package in a package repository
+     * @param {RepositoryPackageReference} packageReference
+     * @returns {Promise<ErrorResponse[]>}
+     */
+    BaseClient.prototype.loadComponentSettingsFromRepository = function (packageReference) {
+        return packageReference
+            ? this.request('LoadComponentSettingsFromRepository', packageReference)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('packageReference must be defined');
+    };
+    /**
+     * Save a TapPackage containing component settings in a package repository
+     * @param {RepositorySettingsPackageDefinition} repositoryPackageDefinition
+     * @returns {Promise<void>}
+     */
+    BaseClient.prototype.saveComponentSettingsToRepository = function (repositoryPackageDefinition) {
+        return repositoryPackageDefinition
+            ? this.request('SaveComponentSettingsToRepository', repositoryPackageDefinition).then(this.success()).catch(this.error())
+            : Promise.reject('repositoryPackageDefinition must be defined');
+    };
+    /**
+     * Retrieve types available to be added to specified component settings list
+     * @param {string} groupName
+     * @param {string} name
+     * @returns {Promise<ListItemType[]>}
+     */
+    BaseClient.prototype.getComponentSettingsListAvailableTypes = function (groupName, name) {
+        var getComponentSettingsRequest = { groupName: groupName, name: name };
+        return groupName && name
+            ? this.request('GetComponentSettingsListAvailableTypes', getComponentSettingsRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Adds a new item to a component settings list
+     * @param {string} groupName
+     * @param {string} name
+     * @param {string} typeName
+     * @returns {Promise<ListItemType[]>}
+     */
+    BaseClient.prototype.addComponentSettingsListItem = function (groupName, name, typeName) {
+        var addComponentSettingsListItemRequest = { groupName: groupName, name: name, typeName: typeName };
+        return groupName && name && typeName
+            ? this.request('AddComponentSettingsListItem', addComponentSettingsListItemRequest)
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('all parameters must be defined');
+    };
+    /**
+     * Get settings package files
+     * @returns {Promise<string[]>}
+     */
+    BaseClient.prototype.getSettingsPackageFiles = function () {
+        return this.request('GetSettingsPackageFiles').then(this.success()).catch(this.error());
+    };
+    /**
+     * Get settings package types
+     * @returns {Promise<string[]>}
+     */
+    BaseClient.prototype.settingsPackageTypes = function () {
+        return this.request('SettingsPackageTypes').then(this.success()).catch(this.error());
+    };
+    /**
+     * Download a TapPackage containing settings files
+     * @param {SettingsPackage} settingsTapPackage
+     * @returns {Promise<FileResponse>}
+     */
+    BaseClient.prototype.downloadSettingsPackage = function (settingsTapPackage) {
+        return settingsTapPackage
+            ? this.request('DownloadSettingsPackage', settingsTapPackage).then(this.success()).catch(this.error())
+            : Promise.reject('settingsTapPackage must be defined');
+    };
     return BaseClient;
 }());
 export { BaseClient };