artifact-engine 1.2.0 → 1.3.0

package/Providers/typed-rest-client/Index.d.ts

@@ -1 +0,0 @@
-export {};

package/Providers/typed-rest-client/Index.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Index.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/Providers/typed-rest-client/Interfaces.d.ts

@@ -1,38 +1,38 @@
-export interface IHeaders {
-    [key: string]: any;
-}
-export interface IBasicCredentials {
-    username: string;
-    password: string;
-}
-export interface IRequestHandler {
-    prepareRequest(options: any): void;
-    canHandleAuthentication(res: IHttpResponse): boolean;
-    handleAuthentication(httpClient: any, protocol: any, options: any, objs: any, finalCallback: any): void;
-}
-export interface IHttpResponse {
-    statusCode?: number;
-    headers: any;
-}
-export interface IRequestOptions {
-    socketTimeout?: number;
-    ignoreSslError?: boolean;
-    proxy?: IProxyConfiguration;
-    cert?: ICertConfiguration;
-    allowRedirects?: boolean;
-    maxRedirects?: number;
-    maxSockets?: number;
-    keepAlive?: boolean;
-}
-export interface IProxyConfiguration {
-    proxyUrl: string;
-    proxyUsername?: string;
-    proxyPassword?: string;
-    proxyBypassHosts?: string[];
-}
-export interface ICertConfiguration {
-    caFile?: string;
-    certFile?: string;
-    keyFile?: string;
-    passphrase?: string;
-}
+export interface IHeaders {
+    [key: string]: any;
+}
+export interface IBasicCredentials {
+    username: string;
+    password: string;
+}
+export interface IRequestHandler {
+    prepareRequest(options: any): void;
+    canHandleAuthentication(res: IHttpResponse): boolean;
+    handleAuthentication(httpClient: any, protocol: any, options: any, objs: any, finalCallback: any): void;
+}
+export interface IHttpResponse {
+    statusCode?: number;
+    headers: any;
+}
+export interface IRequestOptions {
+    socketTimeout?: number;
+    ignoreSslError?: boolean;
+    proxy?: IProxyConfiguration;
+    cert?: ICertConfiguration;
+    allowRedirects?: boolean;
+    maxRedirects?: number;
+    maxSockets?: number;
+    keepAlive?: boolean;
+}
+export interface IProxyConfiguration {
+    proxyUrl: string;
+    proxyUsername?: string;
+    proxyPassword?: string;
+    proxyBypassHosts?: string[];
+}
+export interface ICertConfiguration {
+    caFile?: string;
+    certFile?: string;
+    keyFile?: string;
+    passphrase?: string;
+}

package/Providers/typed-rest-client/Interfaces.js

@@ -1,4 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-;
-//# sourceMappingURL=Interfaces.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/Providers/typed-rest-client/RestClient.d.ts

@@ -1,27 +1,73 @@
-/// <reference types="node" />
-import httpm = require('./HttpClient');
-import ifm = require("./Interfaces");
-export interface IRestResponse<T> {
-    statusCode: number;
-    result: T;
-}
-export interface IRequestOptions {
-    acceptHeader?: string;
-    additionalHeaders?: ifm.IHeaders;
-    responseProcessor?: Function;
-}
-export declare class RestClient {
-    client: httpm.HttpClient;
-    versionParam: string;
-    constructor(userAgent: string, baseUrl?: string, handlers?: ifm.IRequestHandler[], requestOptions?: ifm.IRequestOptions);
-    private _baseUrl;
-    options<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    get<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    del<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    create<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    update<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    replace<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    uploadStream<T>(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, options?: IRequestOptions): Promise<IRestResponse<T>>;
-    private _headersFromOptions;
-    private _processResponse;
-}
+import httpm = require('./HttpClient');
+import ifm = require("./Interfaces");
+export interface IRestResponse<T> {
+    statusCode: number;
+    result: T;
+}
+export interface IRequestOptions {
+    acceptHeader?: string;
+    additionalHeaders?: ifm.IHeaders;
+    responseProcessor?: Function;
+}
+export declare class RestClient {
+    client: httpm.HttpClient;
+    versionParam: string;
+    /**
+     * Creates an instance of the RestClient
+     * @constructor
+     * @param {string} userAgent - userAgent for requests
+     * @param {string} baseUrl - (Optional) If not specified, use full urls per request.  If supplied and a function passes a relative url, it will be appended to this
+     * @param {ifm.IRequestHandler[]} handlers - handlers are typically auth handlers (basic, bearer, ntlm supplied)
+     * @param {ifm.IRequestOptions} requestOptions - options for each http requests (http proxy setting, socket timeout)
+     */
+    constructor(userAgent: string, baseUrl?: string, handlers?: ifm.IRequestHandler[], requestOptions?: ifm.IRequestOptions);
+    private _baseUrl;
+    /**
+     * Gets a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    options<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    /**
+     * Gets a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    get<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    /**
+     * Deletes a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    del<T>(requestUrl: string, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    /**
+     * Creates resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    create<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    /**
+     * Updates resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    update<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    /**
+     * Replaces resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    replace<T>(requestUrl: string, resources: any, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    uploadStream<T>(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, options?: IRequestOptions): Promise<IRestResponse<T>>;
+    private _headersFromOptions(options, contentType?);
+    private _processResponse<T>(res, options);
+}

package/Providers/typed-rest-client/RestClient.js

@@ -1,134 +1,186 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestClient = void 0;
-const httpm = require("./HttpClient");
-const util = require("./Util");
-class RestClient {
-    constructor(userAgent, baseUrl, handlers, requestOptions) {
-        this.client = new httpm.HttpClient(userAgent, handlers, requestOptions);
-        if (baseUrl) {
-            this._baseUrl = baseUrl;
-        }
-    }
-    options(requestUrl, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let res = yield this.client.options(url, this._headersFromOptions(options));
-            return this._processResponse(res, options);
-        });
-    }
-    get(requestUrl, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let res = yield this.client.get(url, this._headersFromOptions(options));
-            return this._processResponse(res, options);
-        });
-    }
-    del(requestUrl, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let res = yield this.client.del(url, this._headersFromOptions(options));
-            return this._processResponse(res, options);
-        });
-    }
-    create(requestUrl, resources, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let headers = this._headersFromOptions(options, true);
-            let data = JSON.stringify(resources, null, 2);
-            let res = yield this.client.post(url, data, headers);
-            return this._processResponse(res, options);
-        });
-    }
-    update(requestUrl, resources, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let headers = this._headersFromOptions(options, true);
-            let data = JSON.stringify(resources, null, 2);
-            let res = yield this.client.patch(url, data, headers);
-            return this._processResponse(res, options);
-        });
-    }
-    replace(requestUrl, resources, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let headers = this._headersFromOptions(options, true);
-            let data = JSON.stringify(resources, null, 2);
-            let res = yield this.client.put(url, data, headers);
-            return this._processResponse(res, options);
-        });
-    }
-    uploadStream(verb, requestUrl, stream, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = util.getUrl(requestUrl, this._baseUrl);
-            let headers = this._headersFromOptions(options, true);
-            let res = yield this.client.sendStream(verb, url, stream, headers);
-            return this._processResponse(res, options);
-        });
-    }
-    _headersFromOptions(options, contentType) {
-        options = options || {};
-        let headers = options.additionalHeaders || {};
-        headers["Accept"] = options.acceptHeader || "application/json";
-        if (contentType) {
-            headers["Content-Type"] = headers["Content-Type"] || 'application/json; charset=utf-8';
-        }
-        return headers;
-    }
-    _processResponse(res, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-                let rres = {};
-                let statusCode = res.message.statusCode;
-                rres.statusCode = statusCode;
-                if (statusCode == httpm.HttpCodes.NotFound) {
-                    resolve(rres);
-                }
-                let obj;
-                try {
-                    let contents = yield res.readBody();
-                    if (contents && contents.length > 0) {
-                        obj = JSON.parse(contents);
-                        if (options && options.responseProcessor) {
-                            rres.result = options.responseProcessor(obj);
-                        }
-                        else {
-                            rres.result = obj;
-                        }
-                    }
-                }
-                catch (err) {
-                }
-                if (statusCode > 299) {
-                    let msg;
-                    if (obj && obj.message) {
-                        msg = obj.message;
-                    }
-                    else {
-                        msg = "Failed request: (" + statusCode + ")";
-                    }
-                    let err = new Error(msg);
-                    err['statusCode'] = statusCode;
-                    if (rres.result) {
-                        err['result'] = rres.result;
-                    }
-                    reject(err);
-                }
-                else {
-                    resolve(rres);
-                }
-            }));
-        });
-    }
-}
-exports.RestClient = RestClient;
-//# sourceMappingURL=RestClient.js.map
+"use strict";
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const httpm = require("./HttpClient");
+const util = require("./Util");
+class RestClient {
+    /**
+     * Creates an instance of the RestClient
+     * @constructor
+     * @param {string} userAgent - userAgent for requests
+     * @param {string} baseUrl - (Optional) If not specified, use full urls per request.  If supplied and a function passes a relative url, it will be appended to this
+     * @param {ifm.IRequestHandler[]} handlers - handlers are typically auth handlers (basic, bearer, ntlm supplied)
+     * @param {ifm.IRequestOptions} requestOptions - options for each http requests (http proxy setting, socket timeout)
+     */
+    constructor(userAgent, baseUrl, handlers, requestOptions) {
+        this.client = new httpm.HttpClient(userAgent, handlers, requestOptions);
+        if (baseUrl) {
+            this._baseUrl = baseUrl;
+        }
+    }
+    /**
+     * Gets a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    options(requestUrl, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let res = yield this.client.options(url, this._headersFromOptions(options));
+            return this._processResponse(res, options);
+        });
+    }
+    /**
+     * Gets a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    get(requestUrl, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let res = yield this.client.get(url, this._headersFromOptions(options));
+            return this._processResponse(res, options);
+        });
+    }
+    /**
+     * Deletes a resource from an endpoint
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    del(requestUrl, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let res = yield this.client.del(url, this._headersFromOptions(options));
+            return this._processResponse(res, options);
+        });
+    }
+    /**
+     * Creates resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    create(requestUrl, resources, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let headers = this._headersFromOptions(options, true);
+            let data = JSON.stringify(resources, null, 2);
+            let res = yield this.client.post(url, data, headers);
+            return this._processResponse(res, options);
+        });
+    }
+    /**
+     * Updates resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    update(requestUrl, resources, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let headers = this._headersFromOptions(options, true);
+            let data = JSON.stringify(resources, null, 2);
+            let res = yield this.client.patch(url, data, headers);
+            return this._processResponse(res, options);
+        });
+    }
+    /**
+     * Replaces resource(s) from an endpoint
+     * T type of object returned.
+     * Be aware that not found returns a null.  Other error conditions reject the promise
+     * @param {string} requestUrl - fully qualified or relative url
+     * @param {IRequestOptions} requestOptions - (optional) requestOptions object
+     */
+    replace(requestUrl, resources, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let headers = this._headersFromOptions(options, true);
+            let data = JSON.stringify(resources, null, 2);
+            let res = yield this.client.put(url, data, headers);
+            return this._processResponse(res, options);
+        });
+    }
+    uploadStream(verb, requestUrl, stream, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = util.getUrl(requestUrl, this._baseUrl);
+            let headers = this._headersFromOptions(options, true);
+            let res = yield this.client.sendStream(verb, url, stream, headers);
+            return this._processResponse(res, options);
+        });
+    }
+    _headersFromOptions(options, contentType) {
+        options = options || {};
+        let headers = options.additionalHeaders || {};
+        headers["Accept"] = options.acceptHeader || "application/json";
+        if (contentType) {
+            headers["Content-Type"] = headers["Content-Type"] || 'application/json; charset=utf-8';
+        }
+        return headers;
+    }
+    _processResponse(res, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                let rres = {};
+                let statusCode = res.message.statusCode;
+                rres.statusCode = statusCode;
+                // not found leads to null obj returned
+                if (statusCode == httpm.HttpCodes.NotFound) {
+                    resolve(rres);
+                }
+                let obj;
+                // get the result from the body
+                try {
+                    let contents = yield res.readBody();
+                    if (contents && contents.length > 0) {
+                        obj = JSON.parse(contents);
+                        if (options && options.responseProcessor) {
+                            rres.result = options.responseProcessor(obj);
+                        }
+                        else {
+                            rres.result = obj;
+                        }
+                    }
+                }
+                catch (err) {
+                    // Invalid resource (contents not json);  leaving result obj null
+                }
+                // note that 3xx redirects are handled by the http layer.
+                if (statusCode > 299) {
+                    let msg;
+                    // if exception/error in body, attempt to get better error
+                    if (obj && obj.message) {
+                        msg = obj.message;
+                    }
+                    else {
+                        msg = "Failed request: (" + statusCode + ")";
+                    }
+                    let err = new Error(msg);
+                    // attach statusCode and body obj (if available) to the error object
+                    err['statusCode'] = statusCode;
+                    if (rres.result) {
+                        err['result'] = rres.result;
+                    }
+                    reject(err);
+                }
+                else {
+                    resolve(rres);
+                }
+            }));
+        });
+    }
+}
+exports.RestClient = RestClient;

package/Providers/typed-rest-client/Util.d.ts

@@ -1 +1,7 @@
-export declare function getUrl(requestUrl: string, baseUrl?: string): string;
+/**
+ * creates an url from a request url and optional base url (http://server:8080)
+ * @param {string} requestUrl - a fully qualified url or relative url
+ * @param {string} baseUrl - an optional baseUrl (http://server:8080)
+ * @return {string} - resultant url
+ */
+export declare function getUrl(requestUrl: string, baseUrl?: string): string;

package/Providers/typed-rest-client/Util.js

@@ -1,18 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUrl = void 0;
-const url = require("url");
-function getUrl(requestUrl, baseUrl) {
-    if (!baseUrl) {
-        return requestUrl;
-    }
-    let base = url.parse(baseUrl);
-    let combined = url.parse(requestUrl);
-    combined.protocol = combined.protocol || base.protocol;
-    combined.auth = combined.auth || base.auth;
-    combined.host = combined.host || base.host;
-    let res = url.format(combined);
-    return res;
-}
-exports.getUrl = getUrl;
-//# sourceMappingURL=Util.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const url = require("url");
+/**
+ * creates an url from a request url and optional base url (http://server:8080)
+ * @param {string} requestUrl - a fully qualified url or relative url
+ * @param {string} baseUrl - an optional baseUrl (http://server:8080)
+ * @return {string} - resultant url
+ */
+function getUrl(requestUrl, baseUrl) {
+    if (!baseUrl) {
+        return requestUrl;
+    }
+    let base = url.parse(baseUrl);
+    // requestUrl (specific per request) always wins
+    let combined = url.parse(requestUrl);
+    combined.protocol = combined.protocol || base.protocol;
+    combined.auth = combined.auth || base.auth;
+    combined.host = combined.host || base.host;
+    // path from requestUrl always wins
+    let res = url.format(combined);
+    return res;
+}
+exports.getUrl = getUrl;

package/Providers/typed-rest-client/handlers/basiccreds.d.ts

@@ -1,9 +1,9 @@
-import ifm = require('../Interfaces');
-export declare class BasicCredentialHandler implements ifm.IRequestHandler {
-    username: string;
-    password: string;
-    constructor(username: string, password: string);
-    prepareRequest(options: any): void;
-    canHandleAuthentication(res: ifm.IHttpResponse): boolean;
-    handleAuthentication(httpClient: any, protocol: any, options: any, objs: any, finalCallback: any): void;
-}
+import ifm = require('../Interfaces');
+export declare class BasicCredentialHandler implements ifm.IRequestHandler {
+    username: string;
+    password: string;
+    constructor(username: string, password: string);
+    prepareRequest(options: any): void;
+    canHandleAuthentication(res: ifm.IHttpResponse): boolean;
+    handleAuthentication(httpClient: any, protocol: any, options: any, objs: any, finalCallback: any): void;
+}