balena-sdk 15.59.0 → 15.59.2

package/CHANGELOG.md

@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 15.59.2 - 2021-11-28
+
+
+<details>
+<summary> Update balena-request to 11.5.0 [Thodoris Greasidis] </summary>
+
+> ### balena-request-11.5.0 - 2021-11-28
+> 
+> * Convert tests to JavaScript and drop coffeescript [Thodoris Greasidis]
+> * Fix the jsdoc generation [Thodoris Greasidis]
+> * Convert to typescript and publish typings [Thodoris Greasidis]
+> 
+</details>
+
+## 15.59.1 - 2021-11-28
+
+* Fix the typings of the Image contract field [Thodoris Greasidis]
+* Fix the typings for the Release contract field [Thodoris Greasidis]
+
 ## 15.59.0 - 2021-11-24
 
 * Add release setIsInvalidated function [Matthew Yarmolinsky]

package/es2015/balena-browser.js

@@ -12122,7 +12122,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // being embedded in the dist of the consumer project
 // which we want to avoid, both b/c of the dist size increase &
 // the security concerns of including the versions of the dependencies
-const sdkVersion = '15.59.0';
+const sdkVersion = '15.59.2';
 exports.default = sdkVersion;
 
 },{}],47:[function(require,module,exports){
@@ -15295,12 +15295,19 @@ const getProgressStream = function (total, onState) {
     });
     return progressStream;
 };
+/**
+ * This callback is displayed as a global member.
+ * @callback estimateStreamCallback
+ * @param {BalenaRequestOptions} options
+ *
+ * @returns {Promise<NodeJS.ReadableStream>} request stream
+ */
 /**
  * @summary Make a node request with progress
  * @function
  * @protected
  *
- * @returns {(options) => Promise<NodeJS.ReadableStream>} request stream
+ * @returns {estimateStreamCallback} request stream callback
  *
  * @example
  * progress.estimate(options).then (stream) ->
@@ -15332,7 +15339,6 @@ function estimate(requestAsync, isBrowser) {
             const response = yield requestAsync(options);
             const stream = require('stream');
             const output = new stream.PassThrough();
-            // @ts-expect-error
             output.response = response;
             const responseLength = utils.getResponseLength(response);
             const total = responseLength.uncompressed || responseLength.compressed;
@@ -15353,7 +15359,7 @@ function estimate(requestAsync, isBrowser) {
                 // servers send slightly invalid gzip responses that are still accepted
                 // by common browsers.
                 // Always using Z_SYNC_FLUSH is what cURL does.
-                var zlibOptions = {
+                let zlibOptions = {
                     flush: zlib.constants.Z_SYNC_FLUSH,
                     finishFlush: zlib.constants.Z_SYNC_FLUSH,
                 };
@@ -15410,21 +15416,23 @@ limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRequest = void 0;
 const tslib_1 = require("tslib");
-/**
- * @module request
- */
 const urlLib = require("url");
 const errors = require("balena-errors");
 const utils = require("./utils");
 /**
+ * @module request
+ */
+/**
+ * @summary Creates a new balena-request instance.
+ *
  * @param {object} options
- * @param {import('balena-auth').default} options.auth
+ * @param {object} options.auth
  * @param {boolean} options.debug
  * @param {number} options.retries
  * @param {boolean} options.isBrowser
  * @param {array} options.interceptors
  */
-function getRequest({ auth, debug = false, retries = 0, isBrowser = false, interceptors = [], }) {
+function getRequest({ auth, debug = false, retries = 0, isBrowser = false, interceptors: $interceptors = [], }) {
     const requestAsync = utils.getRequestAsync();
     const requestStream = isBrowser
         ? utils.getRequestAsync(require('fetch-readablestream'))
@@ -15434,7 +15442,6 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
             // noop
         }
         : utils.debugRequest;
-    const exports = {};
     const prepareOptions = function (options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             if (options == null) {
@@ -15457,7 +15464,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
                 options.refreshToken &&
                 (yield utils.shouldRefreshKey(auth))) {
                 if (baseUrl && !isAbsoluteUrl) {
-                    yield exports.refreshToken({ baseUrl });
+                    yield refreshToken({ baseUrl });
                 }
                 if (yield auth.isExpired()) {
                     throw new errors.BalenaExpiredToken(yield auth.getKey());
@@ -15486,7 +15493,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
     const interceptRequestError = (requestError) => interceptRequestOrError(Promise.reject(requestError));
     const interceptResponse = (response) => interceptResponseOrError(Promise.resolve(response));
     const interceptResponseError = (responseError) => interceptResponseOrError(Promise.reject(responseError));
-    var interceptRequestOrError = (initialPromise) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+    const interceptRequestOrError = (initialPromise) => tslib_1.__awaiter(this, void 0, void 0, function* () {
         return exports.interceptors.reduce(function (promise, { request, requestError }) {
             if (request != null || requestError != null) {
                 return promise.then(request, requestError);
@@ -15496,10 +15503,12 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
             }
         }, initialPromise);
     });
-    var interceptResponseOrError = function (initialPromise) {
+    const interceptResponseOrError = function (initialPromise) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            interceptors = exports.interceptors.slice().reverse();
-            return interceptors.reduce(function (promise, { response, responseError }) {
+            return exports.interceptors
+                .slice()
+                .reverse()
+                .reduce(function (promise, { response, responseError }) {
                 if (response != null || responseError != null) {
                     return promise.then(response, responseError);
                 }
@@ -15550,7 +15559,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
      * 		hello: 'world'
      * .get('body')
      */
-    exports.send = function (options) {
+    function send(options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // Only set the default timeout when doing a normal HTTP
             // request and not also when streaming since in the latter
@@ -15586,7 +15595,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
             }))
                 .then(interceptResponse, interceptResponseError);
         });
-    };
+    }
     /**
      * @summary Stream an HTTP response from balena.
      * @function
@@ -15625,16 +15634,14 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
      *
      * 	stream.pipe(fs.createWriteStream('/opt/download'))
      */
-    exports.stream = function (options) {
+    function stream(options) {
         const progress = require('./progress');
         return prepareOptions(options)
             .then(interceptRequestOptions, interceptRequestError)
             .then((opts) => tslib_1.__awaiter(this, void 0, void 0, function* () {
             const download = yield progress.estimate(requestStream, isBrowser)(opts);
-            // @ts-expect-error
             if (!utils.isErrorCode(download.response.statusCode)) {
                 // TODO: Move this to balena-image-manager
-                // @ts-expect-error
                 download.mime = download.response.headers.get('Content-Type');
                 return download;
             }
@@ -15650,34 +15657,12 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
                 download.on('done', resolve);
             });
             const responseError = chunks.join() || 'The request was unsuccessful';
-            // @ts-expect-error
             debugRequest(options, download.response);
             // @ts-expect-error
-            throw new errors.BalenaRequestError(responseError, 
-            // @ts-expect-error
-            download.response.statusCode);
+            throw new errors.BalenaRequestError(responseError, download.response.statusCode);
         }))
-            .then(interceptResponse, interceptResponseError);
-    };
-    /**
-     * @summary Array of interceptors
-     * @type {Interceptor[]}
-     * @public
-     *
-     * @description
-     * The current array of interceptors to use. Interceptors intercept requests made
-     * by calls to `.stream()` and `.send()` (some of which are made internally) and
-     * are executed in the order they appear in this array for requests, and in the
-     * reverse order for responses.
-     *
-     * @example
-     * request.interceptors.push(
-     * 	requestError: (error) ->
-     * 		console.log(error)
-     * 		throw error
-     * )
-     */
-    exports.interceptors = interceptors;
+            .then((x) => interceptResponse(x), interceptResponseError);
+    }
     /**
      * @typedef Interceptor
      * @type {object}
@@ -15706,6 +15691,26 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
      * an error for the request, a network error, or an error response from the server. Should return
      * (or resolve to) a new response, or throw/reject.
      */
+    /**
+     * @summary Array of interceptor
+     * @type {Interceptor[]}
+     * @public
+     *
+     * @description
+     * The current array of interceptors to use. Interceptors intercept requests made
+     * by calls to `.stream()` and `.send()` (some of which are made internally) and
+     * are executed in the order they appear in this array for requests, and in the
+     * reverse order for responses.
+     *
+     * @example
+     * request.interceptors.push(
+     * 	requestError: (error) ->
+     * 		console.log(error)
+     * 		throw error
+     * )
+     */
+    // Shortcut to get the correct jsdoc readme generated
+    const interceptors = $interceptors;
     /**
      * @summary Refresh token on user request
      * @function
@@ -15723,7 +15728,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
      * request.refreshToken
      * 	baseUrl: 'https://api.balena-cloud.com'
      */
-    exports.refreshToken = function ({ baseUrl }) {
+    function refreshToken({ baseUrl, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // Only refresh if we have balena-auth
             if (auth == null) {
@@ -15731,7 +15736,7 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
             }
             let response;
             try {
-                response = yield exports.send({
+                response = yield send({
                     url: '/user/v1/refresh-token',
                     baseUrl,
                     refreshToken: false,
@@ -15749,6 +15754,12 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
             yield auth.setKey(refreshedKey);
             return refreshedKey;
         });
+    }
+    const exports = {
+        send,
+        stream,
+        interceptors,
+        refreshToken,
     };
     return exports;
 }
@@ -15783,7 +15794,7 @@ const IS_BROWSER = typeof window !== 'undefined' && window !== null;
 /**
  * @module utils
  */
-exports.TOKEN_REFRESH_INTERVAL = 1 * 1000 * 60 * 60; // 1 hour in milliseconds
+exports.TOKEN_REFRESH_INTERVAL = 1 * 60 * 60 * 1000; // 1 hour in milliseconds
 /**
  * @summary Determine if the token should be updated
  * @function
@@ -15793,7 +15804,7 @@ exports.TOKEN_REFRESH_INTERVAL = 1 * 1000 * 60 * 60; // 1 hour in milliseconds
  * This function makes use of a soft user-configurable setting called `tokenRefreshInterval`.
  * That setting doesn't express that the token is "invalid", but represents that it is a good time for the token to be updated *before* it get's outdated.
  *
- * @param {import('balena-auth').default} auth - an instance of `balena-auth`
+ * @param {object} auth - an instance of `balena-auth`
  * @returns {Promise<Boolean>} the token should be updated
  *
  * @example
@@ -15802,6 +15813,7 @@ exports.TOKEN_REFRESH_INTERVAL = 1 * 1000 * 60 * 60; // 1 hour in milliseconds
  * 			console.log('Updating token!')
  */
 function shouldRefreshKey(auth) {
+    var _a;
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const hasKey = yield auth.hasKey();
         if (!hasKey) {
@@ -15811,8 +15823,7 @@ function shouldRefreshKey(auth) {
         if (type !== token_1.TokenType.JWT) {
             return false;
         }
-        const age = yield auth.getAge();
-        // @ts-expect-error
+        const age = (_a = (yield auth.getAge())) !== null && _a !== void 0 ? _a : 0;
         return age >= exports.TOKEN_REFRESH_INTERVAL;
     });
 }
@@ -15825,7 +15836,7 @@ exports.shouldRefreshKey = shouldRefreshKey;
  * @description
  * This promise becomes undefined if no saved token.
  *
- * @param {import('balena-auth').default} auth - an instance of `balena-auth`
+ * @param {object} auth - an instance of `balena-auth`
  * @returns {Promise<string | undefined>} authorization header
  *
  * @example
@@ -15833,7 +15844,7 @@ exports.shouldRefreshKey = shouldRefreshKey;
  * 		headers =
  * 			Authorization: authorizationHeader
  */
-exports.getAuthorizationHeader = function (auth) {
+function getAuthorizationHeader(auth) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         if (auth == null) {
             return;
@@ -15845,7 +15856,8 @@ exports.getAuthorizationHeader = function (auth) {
         const key = yield auth.getKey();
         return `Bearer ${key}`;
     });
-};
+}
+exports.getAuthorizationHeader = getAuthorizationHeader;
 /**
  * @summary Get error message from response
  * @function
@@ -15946,10 +15958,7 @@ exports.getResponseLength = getResponseLength;
  * 	utils.debugRequest(options, response)
  */
 function debugRequest(options, response) {
-    return console.error(Object.assign({
-        statusCode: response.statusCode,
-        duration: response.duration,
-    }, options));
+    return console.error(Object.assign({ statusCode: response.statusCode, duration: response.duration }, options));
 }
 exports.debugRequest = debugRequest;
 // fetch adapter
@@ -15987,10 +15996,10 @@ const UNSUPPORTED_REQUEST_PARAMS = [
     'callback',
 ];
 const processRequestOptions = function (options) {
-    if (options == null) {
-        options = {};
-    }
     let url = options.url || options.uri;
+    if (url == null) {
+        throw new Error('url option not provided');
+    }
     if (options.baseUrl) {
         url = urlLib.resolve(options.baseUrl, url);
     }
@@ -15998,12 +16007,6 @@ const processRequestOptions = function (options) {
         const params = qs.stringify(options.qs);
         url += (url.indexOf('?') >= 0 ? '&' : '?') + params;
     }
-    const opts = {};
-    opts.timeout = options.timeout;
-    opts.retries = options.retries;
-    opts.method = options.method;
-    opts.compress = options.gzip;
-    opts.signal = options.signal;
     let { body, headers } = options;
     if (headers == null) {
         headers = {};
@@ -16012,25 +16015,21 @@ const processRequestOptions = function (options) {
         body = JSON.stringify(body);
         headers['Content-Type'] = 'application/json';
     }
-    opts.body = body;
     if (!IS_BROWSER) {
         if (!headers['Accept-Encoding']) {
             headers['Accept-Encoding'] = 'compress, gzip';
         }
     }
-    if (options.followRedirect) {
-        opts.redirect = 'follow';
-    }
-    opts.headers = new HeadersPonyfill(headers);
     if (options.strictSSL === false) {
         throw new Error('`strictSSL` must be true or absent');
     }
-    for (let key of UNSUPPORTED_REQUEST_PARAMS) {
-        if (options[key] != null) {
-            throw new Error(`The ${key} param is not supported. Value: ${options[key]}`);
+    for (const key of UNSUPPORTED_REQUEST_PARAMS) {
+        const unsupportedOptionValue = options[key];
+        if (unsupportedOptionValue != null) {
+            throw new Error(`The ${key} param is not supported. Value: ${unsupportedOptionValue}`);
         }
     }
-    opts.mode = 'cors';
+    const opts = Object.assign({ timeout: options.timeout, retries: options.retries, method: options.method, compress: options.gzip, signal: options.signal, body, headers: new HeadersPonyfill(headers), mode: 'cors' }, (options.followRedirect && { redirect: 'follow' }));
     return [url, opts];
 };
 /**
@@ -16078,7 +16077,7 @@ function getBody(response, responseFormat) {
 }
 exports.getBody = getBody;
 // This is the actual implementation that hides the internal `retriesRemaining` parameter
-var requestAsync = function (fetch, options, retriesRemaining) {
+function requestAsync(fetch, options, retriesRemaining) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const [url, opts] = processRequestOptions(options);
         if (retriesRemaining == null) {
@@ -16105,7 +16104,7 @@ var requestAsync = function (fetch, options, retriesRemaining) {
                     p.then(resolve, reject);
                 });
             }
-            const response = yield p;
+            const response = (yield p);
             if (opts.signal) {
                 handleAbortIfNotSupported(opts.signal, response);
             }
@@ -16125,8 +16124,8 @@ var requestAsync = function (fetch, options, retriesRemaining) {
             throw err;
         }
     });
-};
-var handleAbortIfNotSupported = function (signal, response) {
+}
+function handleAbortIfNotSupported(signal, response) {
     const emulateAbort = (() => {
         var _a, _b;
         if ((_a = response.body) === null || _a === void 0 ? void 0 : _a.cancel) {
@@ -16154,7 +16153,7 @@ var handleAbortIfNotSupported = function (signal, response) {
             });
         }
     }
-};
+}
 /**
  * @summary The factory that returns the `requestAsync` function.
  * @function
@@ -16170,11 +16169,8 @@ var handleAbortIfNotSupported = function (signal, response) {
  * utils.getRequestAsync()({ url: 'http://example.com' }).then (response) ->
  * 	console.log(response)
  */
-function getRequestAsync(fetch) {
-    if (fetch == null) {
-        fetch = normalFetch;
-    }
-    return (options) => requestAsync(fetch, options);
+function getRequestAsync($fetch = normalFetch) {
+    return (options) => requestAsync($fetch, options);
 }
 exports.getRequestAsync = getRequestAsync;