box-node-sdk 1.35.0 → 1.37.2

package/lib/util/errors.js

@@ -1,174 +1,163 @@
+"use strict";
 /**
  * @fileoverview Errors Helper
  */
-
-'use strict';
-
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var qs = __importStar(require("querystring"));
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-var qs = require('querystring'),
-	httpStatusCodes = require('http-status');
-
-const TRACE_ID_HEADER_NAME = 'box-request-id';
-
+var httpStatusCodes = require('http-status');
+var TRACE_ID_HEADER_NAME = 'box-request-id';
 // ------------------------------------------------------------------------------
 // Typedefs and Callbacks
 // ------------------------------------------------------------------------------
-
 /**
  * An generic error propagated when the response has caused an error.
  * @typedef {Error} Errors~ResponseError
  * @property {APIRequest~ResponseObject} response The response object that generated the error
  * @property {int} statusCode A shortcut to the status code of the response
  */
-
 /**
  * Error propagated whenever the SDK is unable to successfully complete an action
  * due to an expired access token (and refresh token, if one was provided).
  * @typedef {Errors~ResponseError} Errors~AuthError
  * @property {boolean} authExpired - always true
  */
-
 /**
  * Request structure for error objects
  * @param {Object} req The request object
  * @constructor
  * @private
  */
-function Request(req) {
-	this.method = req.method;
-	if (req.uri) {
-		this.url = {
-			protocol: req.uri.protocol,
-			host: req.uri.host,
-			path: req.uri.pathname,
-			query: qs.parse(req.uri.query),
-			fragment: req.uri.hash
-		};
-	} else {
-		this.url = null;
-	}
-	this.httpVersion = req.response ? req.response.httpVersion : null;
-	this.headers = req.headers;
-	this.body = req.body;
-}
-
-// ------------------------------------------------------------------------------
-// Public
-// ------------------------------------------------------------------------------
-
-/**
- * A Helper for building errors across the SDK. Makes sure that easily-forgotten
- * fields aren't missed, and that everything is formatted properly to return to the
- * consumer.
- *
- * @name Errors
- * @module box-node-sdk/lib/util/errors
- */
+var Request = /** @class */ (function () {
+    function Request(req /* FIXME */) {
+        this.method = req.method;
+        if (req.uri) {
+            this.url = {
+                protocol: req.uri.protocol,
+                host: req.uri.host,
+                path: req.uri.pathname,
+                query: qs.parse(req.uri.query),
+                fragment: req.uri.hash,
+            };
+        }
+        else {
+            this.url = null;
+        }
+        this.httpVersion = req.response ? req.response.httpVersion : null;
+        this.headers = req.headers;
+        this.body = req.body;
+    }
+    return Request;
+}());
 module.exports = {
-
-	/**
-	 * Build a response error with the given message, and attaching meta data from the
-	 * response data.
-	 *
-	 * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
-	 * @param {string} message - the response error message
-	 * @returns {Errors~ResponseError} an error describing the response error
-	 */
-	buildResponseError(response, message) {
-		response = response || {};
-		message = message || 'API Response Error';
-
-		var statusCode = response.statusCode;
-		var statusMessage = httpStatusCodes[statusCode];
-		var debugID = ''; // Of the form <requestID>.<traceID>, both parts optional
-		var errorCode;
-		var errorDescription;
-
-		if (response.headers && response.headers[TRACE_ID_HEADER_NAME]) {
-			// Append trace ID with dot separator — if not present, the dot should be omitted
-			debugID += `.${response.headers[TRACE_ID_HEADER_NAME]}`;
-		}
-
-
-		if (response.body) {
-
-			if (response.body.request_id) {
-				// Prepend request ID
-				debugID = response.body.request_id + debugID;
-			}
-
-			errorCode = response.body.code || response.body.error;
-			errorDescription = response.body.message || response.body.error_description;
-		}
-
-		var errorMessage;
-		if (debugID) {
-			errorMessage = `${message} [${statusCode} ${statusMessage} | ${debugID}]`;
-		} else {
-			errorMessage = `${message} [${statusCode} ${statusMessage}]`;
-		}
-
-		if (errorCode) {
-			errorMessage += ` ${errorCode}`;
-		}
-		if (errorDescription) {
-			errorMessage += ` - ${errorDescription}`;
-		}
-
-		var responseError = new Error(errorMessage);
-
-		responseError.statusCode = response.statusCode;
-		responseError.response = response;
-		responseError.request = response.request ? new Request(response.request) : {};
-
-		return responseError;
-	},
-
-	/**
-	 * Build an authentication error. {@see Errors~AuthError}
-	 *
-	 * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
-	 * @param {string} [message] - Optional message for the error
-	 * @returns {Errors~AuthError} A properly formatted authentication error
-	 */
-	buildAuthError(response, message) {
-
-		message = message || 'Expired Auth: Auth code or refresh token has expired';
-		var responseError = this.buildResponseError(response, message);
-		responseError.authExpired = true;
-		return responseError;
-	},
-
-	/**
-	 * Build the error for an "Unexpected Response" from the API. This is a shortcut for
-	 * responseError built specifically for the 401 UNEXPECTED response case. It
-	 * should be called and the error should be propogated to the consumer
-	 * whenever an unexpected response was recieved from the API.
-	 *
-	 * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
-	 * @returns {Errors~ResponseError} an error describing the response error
-	 */
-	buildUnexpectedResponseError(response) {
-		return this.buildResponseError(response, 'Unexpected API Response');
-	},
-
-	/**
-	 * Unwrap a Bluebird error and throw it, or just re-throw if the error
-	 * is not a Bluebird error.  This is necessary to preserve errors when
-	 * a function is promisified.
-	 * @param {Error} error The error to unwrap
-	 * @returns {void}
-	 * @throws {Error} The unwrapped error
-	 */
-	unwrapAndThrow(error) {
-
-		if (error.cause) {
-			throw error.cause;
-		}
-
-		throw error;
-	}
-
+    /**
+     * Build a response error with the given message, and attaching meta data from the
+     * response data.
+     *
+     * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
+     * @param {string} message - the response error message
+     * @returns {Errors~ResponseError} an error describing the response error
+     */
+    buildResponseError: function (response /* FIXME */, message) {
+        response = response || {};
+        message = message || 'API Response Error';
+        var statusCode = response.statusCode;
+        var statusMessage = httpStatusCodes[statusCode];
+        var debugID = ''; // Of the form <requestID>.<traceID>, both parts optional
+        var errorCode;
+        var errorDescription;
+        if (response.headers && response.headers[TRACE_ID_HEADER_NAME]) {
+            // Append trace ID with dot separator — if not present, the dot should be omitted
+            debugID += "." + response.headers[TRACE_ID_HEADER_NAME];
+        }
+        if (response.body) {
+            if (response.body.request_id) {
+                // Prepend request ID
+                debugID = response.body.request_id + debugID;
+            }
+            errorCode = response.body.code || response.body.error;
+            errorDescription =
+                response.body.message || response.body.error_description;
+        }
+        var errorMessage;
+        if (debugID) {
+            errorMessage = message + " [" + statusCode + " " + statusMessage + " | " + debugID + "]";
+        }
+        else {
+            errorMessage = message + " [" + statusCode + " " + statusMessage + "]";
+        }
+        if (errorCode) {
+            errorMessage += " " + errorCode;
+        }
+        if (errorDescription) {
+            errorMessage += " - " + errorDescription;
+        }
+        var responseError = new Error(errorMessage);
+        responseError.statusCode = response.statusCode;
+        responseError.response = response;
+        responseError.request = response.request
+            ? new Request(response.request)
+            : {};
+        return responseError;
+    },
+    /**
+     * Build an authentication error. {@see Errors~AuthError}
+     *
+     * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
+     * @param {string} [message] - Optional message for the error
+     * @returns {Errors~AuthError} A properly formatted authentication error
+     */
+    buildAuthError: function (response /* FIXME */, message) {
+        message = message || 'Expired Auth: Auth code or refresh token has expired';
+        var responseError = this.buildResponseError(response, message);
+        responseError.authExpired = true;
+        return responseError;
+    },
+    /**
+     * Build the error for an "Unexpected Response" from the API. This is a shortcut for
+     * responseError built specifically for the 401 UNEXPECTED response case. It
+     * should be called and the error should be propogated to the consumer
+     * whenever an unexpected response was recieved from the API.
+     *
+     * @param {?APIRequest~ResponseObject} response - The response returned by an APIRequestManager request
+     * @returns {Errors~ResponseError} an error describing the response error
+     */
+    buildUnexpectedResponseError: function (response /* FIXME */) {
+        return this.buildResponseError(response, 'Unexpected API Response');
+    },
+    /**
+     * Unwrap a Bluebird error and throw it, or just re-throw if the error
+     * is not a Bluebird error.  This is necessary to preserve errors when
+     * a function is promisified.
+     * @param {Error} error The error to unwrap
+     * @returns {void}
+     * @throws {Error} The unwrapped error
+     */
+    unwrapAndThrow: function (error /* FIXME */) {
+        if (error.cause) {
+            throw error.cause;
+        }
+        throw error;
+    },
 };
+//# sourceMappingURL=errors.js.map

package/lib/util/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/util/errors.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;AAEH,8CAAkC;AAElC,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AACjF,IAAM,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAE/C,IAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAE9C,iFAAiF;AACjF,yBAAyB;AACzB,iFAAiF;AAEjF;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AACH;IAOC,iBAAY,GAAQ,CAAC,WAAW;QAC/B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,GAAG,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,GAAG;gBACV,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ;gBAC1B,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI;gBAClB,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ;gBACtB,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;gBAC9B,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI;aACtB,CAAC;SACF;aAAM;YACN,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;SAChB;QACD,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;QAClE,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,CAAC;IACF,cAAC;AAAD,CAAC,AAxBD,IAwBC;AAcD,iBAAS;IACR;;;;;;;OAOG;IACH,kBAAkB,EAAlB,UAAmB,QAAa,CAAC,WAAW,EAAE,OAAgB;QAC7D,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC1B,OAAO,GAAG,OAAO,IAAI,oBAAoB,CAAC;QAE1C,IAAI,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACrC,IAAI,aAAa,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,OAAO,GAAG,EAAE,CAAC,CAAC,yDAAyD;QAC3E,IAAI,SAAS,CAAC;QACd,IAAI,gBAAgB,CAAC;QAErB,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE;YAC/D,iFAAiF;YACjF,OAAO,IAAI,MAAI,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAG,CAAC;SACxD;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE;YAClB,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;gBAC7B,qBAAqB;gBACrB,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;aAC7C;YAED,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;YACtD,gBAAgB;gBACf,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC;SAC1D;QAED,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,EAAE;YACZ,YAAY,GAAM,OAAO,UAAK,UAAU,SAAI,aAAa,WAAM,OAAO,MAAG,CAAC;SAC1E;aAAM;YACN,YAAY,GAAM,OAAO,UAAK,UAAU,SAAI,aAAa,MAAG,CAAC;SAC7D;QAED,IAAI,SAAS,EAAE;YACd,YAAY,IAAI,MAAI,SAAW,CAAC;SAChC;QACD,IAAI,gBAAgB,EAAE;YACrB,YAAY,IAAI,QAAM,gBAAkB,CAAC;SACzC;QAED,IAAI,aAAa,GAAoB,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAE7D,aAAa,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC/C,aAAa,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAClC,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO;YACvC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC/B,CAAC,CAAC,EAAE,CAAC;QAEN,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,cAAc,EAAd,UAAe,QAAa,CAAC,WAAW,EAAE,OAAgB;QACzD,OAAO,GAAG,OAAO,IAAI,sDAAsD,CAAC;QAC5E,IAAI,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC/D,aAAa,CAAC,WAAW,GAAG,IAAI,CAAC;QACjC,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACH,4BAA4B,EAA5B,UAA6B,QAAa,CAAC,WAAW;QACrD,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,EAAd,UAAe,KAAU,CAAC,WAAW;QACpC,IAAI,KAAK,CAAC,KAAK,EAAE;YAChB,MAAM,KAAK,CAAC,KAAK,CAAC;SAClB;QAED,MAAM,KAAK,CAAC;IACb,CAAC;CACD,CAAC"}

package/lib/util/exponential-backoff.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @fileoverview Calculate exponential backoff time
+ */
+declare const _default: (numRetries: number, baseInterval: number) => number;
+/**
+ * Calculate the exponential backoff time with randomized jitter
+ * @param {int} numRetries Which retry number this one will be
+ * @param {int} baseInterval The base retry interval set in config
+ * @returns {int} The number of milliseconds after which to retry
+ */
+export = _default;

package/lib/util/exponential-backoff.js

@@ -1,29 +1,17 @@
+"use strict";
 /**
  * @fileoverview Calculate exponential backoff time
  */
-
-'use strict';
-
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
-
 // Retry intervals are between 50% and 150% of the exponentially increasing base amount
-const RETRY_RANDOMIZATION_FACTOR = 0.5;
-
-/**
- * Calculate the exponential backoff time with randomized jitter
- * @param {int} numRetries Which retry number this one will be
- * @param {int} baseInterval The base retry interval set in config
- * @returns {int} The number of milliseconds after which to retry
- */
-function getRetryTimeout(numRetries, baseInterval) {
-
-	var minRandomization = 1 - RETRY_RANDOMIZATION_FACTOR;
-	var maxRandomization = 1 + RETRY_RANDOMIZATION_FACTOR;
-	var randomization = (Math.random() * (maxRandomization - minRandomization)) + minRandomization;
-	var exponential = Math.pow(2, numRetries - 1);
-	return Math.ceil(exponential * baseInterval * randomization);
-}
-
-module.exports = getRetryTimeout;
+var RETRY_RANDOMIZATION_FACTOR = 0.5;
+module.exports = function getRetryTimeout(numRetries, baseInterval) {
+    var minRandomization = 1 - RETRY_RANDOMIZATION_FACTOR;
+    var maxRandomization = 1 + RETRY_RANDOMIZATION_FACTOR;
+    var randomization = Math.random() * (maxRandomization - minRandomization) + minRandomization;
+    var exponential = Math.pow(2, numRetries - 1);
+    return Math.ceil(exponential * baseInterval * randomization);
+};
+//# sourceMappingURL=exponential-backoff.js.map

package/lib/util/exponential-backoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exponential-backoff.js","sourceRoot":"","sources":["../../src/util/exponential-backoff.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,uFAAuF;AACvF,IAAM,0BAA0B,GAAG,GAAG,CAAC;AAQvC,iBAAS,SAAS,eAAe,CAAC,UAAkB,EAAE,YAAoB;IACzE,IAAI,gBAAgB,GAAG,CAAC,GAAG,0BAA0B,CAAC;IACtD,IAAI,gBAAgB,GAAG,CAAC,GAAG,0BAA0B,CAAC;IACtD,IAAI,aAAa,GAChB,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;IAC1E,IAAI,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;IAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC,CAAC;AAC9D,CAAC,CAAC"}

package/lib/util/paging-iterator.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @fileoverview Iterator for paged responses
+ */
+/**
+ * Asynchronous iterator for paged collections
+ */
+declare class PagingIterator {
+    /**
+     * Determine if a response is iterable
+     * @param {Object} response - The API response
+     * @returns {boolean} Whether the response is iterable
+     */
+    static isIterable(response: any): boolean;
+    nextField: any;
+    nextValue: any;
+    limit: any;
+    done: boolean;
+    options: Record<string, any>;
+    fetch: any;
+    buffer: any;
+    queue: any;
+    /**
+     * @constructor
+     * @param {Object} response - The original API response
+     * @param {BoxClient} client - An API client to make further requests
+     * @returns {void}
+     * @throws {Error} Will throw when collection cannot be paged
+     */
+    constructor(response: any, client: any);
+    /**
+     * Update the paging parameters for the iterator
+     * @private
+     * @param {Object} response - The latest API response
+     * @returns {void}
+     */
+    _updatePaging(response: any): void;
+    /**
+     * Fetch the next page of results
+     * @returns {Promise} Promise resolving to iterator state
+     */
+    _getData(): any;
+    /**
+     * Fetch the next page of the collection
+     * @returns {Promise} Promise resolving to iterator state
+     */
+    next(): any;
+    /**
+     * Fetch the next marker
+     * @returns {string|int} String that is the next marker or int that is the next offset
+     */
+    getNextMarker(): any;
+}
+export = PagingIterator;