box-node-sdk 3.8.1 → 4.0.0

package/lib-esm/util/config.js

@@ -0,0 +1,223 @@
+"use strict";
+/**
+ * @fileoverview Configuration Object
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const https = __importStar(require("https"));
+const stream_1 = require("stream");
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const merge_options_1 = __importDefault(require("merge-options"));
+const packageJson = require('../../package.json');
+const sdkVersion = packageJson.version;
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const nodeVersion = process.version;
+var defaults = {
+    clientID: null,
+    clientSecret: null,
+    apiRootURL: 'https://api.box.com',
+    uploadAPIRootURL: 'https://upload.box.com/api',
+    authorizeRootURL: 'https://account.box.com/api',
+    apiVersion: '2.0',
+    uploadRequestTimeoutMS: 60000,
+    retryIntervalMS: 2000,
+    numMaxRetries: 5,
+    retryStrategy: null,
+    expiredBufferMS: 180000,
+    appAuth: undefined,
+    iterators: false,
+    enterpriseID: undefined,
+    analyticsClient: null,
+    disableStreamPassThrough: false,
+    proxy: {
+        url: null,
+        username: null,
+        password: null,
+    },
+    request: {
+        // By default, require API SSL cert to be valid
+        strictSSL: true,
+        // Use an agent with keep-alive enabled to avoid performing SSL handshake per connection
+        agentClass: https.Agent,
+        agentOptions: {
+            keepAlive: true,
+        },
+        // Encode requests as JSON. Encode the response as well if JSON is returned.
+        json: true,
+        // Do not encode the response as a string, since the response could be a file. return Buffers instead.
+        encoding: null,
+        // A redirect is usually information we want to handle, so don't automatically follow
+        followRedirect: false,
+        // By default, we attach a version-specific user-agent string to SDK requests
+        headers: {
+            'User-Agent': `Box Node.js SDK v${sdkVersion} (Node ${nodeVersion})`,
+        },
+    },
+};
+var appAuthDefaults = {
+    algorithm: 'RS256',
+    expirationTime: 30,
+    verifyTimestamp: false,
+};
+/**
+ * Validate the basic Config values needed for the SDK to function
+ * @param {UserConfigurationOptions} params The user-supplied config values
+ * @returns {void}
+ * @throws {AssertionError}
+ * @private
+ */
+function validateBasicParams(params) {
+    // Assert that the given params valid, and that required values are present
+    (0, assert_1.default)(typeof params.clientID === 'string', '"clientID" must be set via init() before using the SDK.');
+    (0, assert_1.default)(typeof params.clientSecret === 'string', '"clientSecret" must be set via init() before using the SDK.');
+}
+/**
+ * Validate app auth-specific Config values
+ * @param {Object} appAuth The user-supplied app auth values
+ * @returns {void}
+ * @throws {AssertionError}
+ * @private
+ */
+function validateAppAuthParams(appAuth) {
+    (0, assert_1.default)(typeof appAuth.keyID === 'string', 'Key ID must be provided in app auth params');
+    (0, assert_1.default)(typeof appAuth.privateKey === 'string' ||
+        appAuth.privateKey instanceof Buffer, 'Private key must be provided in app auth params');
+    (0, assert_1.default)(typeof appAuth.passphrase === 'string' && appAuth.passphrase.length > 0, 'Passphrase must be provided in app auth params');
+    var validAlgorithms = ['RS256', 'RS384', 'RS512'];
+    if (typeof appAuth.algorithm !== 'undefined') {
+        (0, assert_1.default)(validAlgorithms.indexOf(appAuth.algorithm) > -1, `Algorithm in app auth params must be one of: ${validAlgorithms.join(', ')}`);
+    }
+    if (typeof appAuth.expirationTime !== 'undefined') {
+        (0, assert_1.default)(Number.isInteger(appAuth.expirationTime) &&
+            appAuth.expirationTime > 0 &&
+            appAuth.expirationTime <= 60, 'Valid token expiration time (0 - 60) must be provided in app auth params');
+    }
+}
+/**
+ * Update the agentClass based on the proxy config values passed in by the user
+ * @param {UserConfigurationOptions} params The current Config values
+ * @returns {void}
+ * @private
+ */
+function updateRequestAgent(params) {
+    if (params.proxy.url) {
+        let proxyUrl = params.proxy.url;
+        if (params.proxy.username && params.proxy.password) {
+            proxyUrl = proxyUrl.replace('://', `://${params.proxy.username}:${params.proxy.password}@`);
+        }
+        const { ProxyAgent } = require('proxy-agent');
+        params.request.agentClass = ProxyAgent;
+        params.request.agentOptions = Object.assign({}, params.request.agentOptions, {
+            getProxyForUrl: (url) => proxyUrl,
+        });
+    }
+}
+/**
+ * Deep freeze an object and all nested objects within it. It doesn't go deep on
+ * Buffers and Readable streams so can be used on objects containing requests.
+ * @param {Object} obj The object to freeze
+ * @returns {Object} The frozen object
+ */
+function deepFreezeWithRequest(obj) {
+    Object.freeze(obj);
+    Object.getOwnPropertyNames(obj).forEach(function (name) {
+        const prop = obj[name];
+        if (prop !== null &&
+            typeof prop === 'object' &&
+            obj.hasOwnProperty(name) &&
+            !Object.isFrozen(prop) &&
+            !(prop instanceof Buffer) &&
+            !(prop instanceof stream_1.Readable)) {
+            deepFreezeWithRequest(obj[name]);
+        }
+    });
+    return obj;
+}
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * A Config Object holds the configuration options of the current setup. These are all
+ * customizable by the user, and will default if no value is specified in the given params
+ * object. The object is frozen on initialization, so that no values can be changed after
+ * setup.
+ *
+ * @param {UserConfigurationOptions} params - The config options set by the user
+ * @constructor
+ */
+class Config {
+    _params;
+    constructor(params) {
+        validateBasicParams(params);
+        if (typeof params.appAuth === 'object') {
+            validateAppAuthParams(params.appAuth);
+            params.appAuth = (0, merge_options_1.default)({}, appAuthDefaults, params.appAuth);
+        }
+        // Ensure that we don't accidentally assign over Config methods
+        (0, assert_1.default)(!params.hasOwnProperty('extend'), 'Config params may not override Config methods');
+        (0, assert_1.default)(!params.hasOwnProperty('_params'), 'Config params may not override Config methods');
+        // Set the given params or default value if params property is missing
+        this._params = (0, merge_options_1.default)(defaults, params);
+        updateRequestAgent(this._params);
+        Object.assign(this, this._params);
+        // Freeze the object so that configuration options cannot be modified
+        deepFreezeWithRequest(this);
+    }
+    /**
+     * Extend the current config into a new config with new params overriding old ones
+     * @param {UserConfigurationOptions} params The override options
+     * @returns {Config} The extended configuration
+     */
+    extend(params) {
+        var newParams = (0, merge_options_1.default)({}, this._params, params);
+        delete newParams.extend;
+        delete newParams._params;
+        return new Config(newParams);
+    }
+}
+/**
+ * @module box-node-sdk/lib/util/config
+ * @see {@Link Config}
+ */
+exports.default = Config;
+//# sourceMappingURL=config.js.map

package/lib-esm/util/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/util/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oDAA4B;AAC5B,6CAA+B;AAE/B,mCAAkC;AAElC,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AACjF,kEAAkC;AAClC,MAAM,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAClD,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC;AAEvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;AA6DpC,IAAI,QAAQ,GAAG;IACb,QAAQ,EAAE,IAAI;IACd,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,qBAAqB;IACjC,gBAAgB,EAAE,4BAA4B;IAC9C,gBAAgB,EAAE,6BAA6B;IAC/C,UAAU,EAAE,KAAK;IACjB,sBAAsB,EAAE,KAAK;IAC7B,eAAe,EAAE,IAAI;IACrB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,MAAM;IACvB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,KAAK;IAChB,YAAY,EAAE,SAAS;IACvB,eAAe,EAAE,IAAI;IACrB,wBAAwB,EAAE,KAAK;IAC/B,KAAK,EAAE;QACL,GAAG,EAAE,IAAI;QACT,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,+CAA+C;QAC/C,SAAS,EAAE,IAAI;QACf,wFAAwF;QACxF,UAAU,EAAE,KAAK,CAAC,KAAK;QACvB,YAAY,EAAE;YACZ,SAAS,EAAE,IAAI;SAChB;QACD,4EAA4E;QAC5E,IAAI,EAAE,IAAI;QACV,sGAAsG;QACtG,QAAQ,EAAE,IAAI;QACd,qFAAqF;QACrF,cAAc,EAAE,KAAK;QACrB,6EAA6E;QAC7E,OAAO,EAAE;YACP,YAAY,EAAE,oBAAoB,UAAU,UAAU,WAAW,GAAG;SACrE;KACF;CACF,CAAC;AAEF,IAAI,eAAe,GAAG;IACpB,SAAS,EAAE,OAAO;IAClB,cAAc,EAAE,EAAE;IAClB,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,MAAgC;IAC3D,2EAA2E;IAC3E,IAAA,gBAAM,EACJ,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EACnC,yDAAyD,CAC1D,CAAC;IACF,IAAA,gBAAM,EACJ,OAAO,MAAM,CAAC,YAAY,KAAK,QAAQ,EACvC,6DAA6D,CAC9D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,OAAsB;IACnD,IAAA,gBAAM,EACJ,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EACjC,4CAA4C,CAC7C,CAAC;IACF,IAAA,gBAAM,EACJ,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ;QACpC,OAAO,CAAC,UAAU,YAAY,MAAM,EACtC,iDAAiD,CAClD,CAAC;IACF,IAAA,gBAAM,EACJ,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EACvE,gDAAgD,CACjD,CAAC;IAEF,IAAI,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QAC7C,IAAA,gBAAM,EACJ,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAC/C,gDAAgD,eAAe,CAAC,IAAI,CAClE,IAAI,CACL,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,OAAO,CAAC,cAAc,KAAK,WAAW,EAAE,CAAC;QAClD,IAAA,gBAAM,EACJ,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC;YACtC,OAAO,CAAC,cAAc,GAAG,CAAC;YAC1B,OAAO,CAAC,cAAc,IAAI,EAAE,EAC9B,0EAA0E,CAC3E,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CACzB,MACmD;IAEnD,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACrB,IAAI,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QAChC,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CACzB,KAAK,EACL,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,GAAG,CACxD,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;QACvC,MAAM,CAAC,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,CACzC,EAAE,EACF,MAAM,CAAC,OAAO,CAAC,YAAY,EAC3B;YACE,cAAc,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,QAAQ;SAC1C,CACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,GAAQ;IACrC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAEnB,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,IAAI;QACpD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;QAEvB,IACE,IAAI,KAAK,IAAI;YACb,OAAO,IAAI,KAAK,QAAQ;YACxB,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC;YACxB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtB,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC;YACzB,CAAC,CAAC,IAAI,YAAY,iBAAQ,CAAC,EAC3B,CAAC;YACD,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;GAQG;AACH,MAAM,MAAM;IACV,OAAO,CAAqC;IAG5C,YAAY,MAAgC;QAC1C,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACvC,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,GAAG,IAAA,uBAAK,EAAC,EAAE,EAAE,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QAED,+DAA+D;QAC/D,IAAA,gBAAM,EACJ,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAChC,+CAA+C,CAChD,CAAC;QACF,IAAA,gBAAM,EACJ,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,EACjC,+CAA+C,CAChD,CAAC;QAEF,sEAAsE;QACtE,IAAI,CAAC,OAAO,GAAG,IAAA,uBAAK,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,qEAAqE;QACrE,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAgC;QACrC,IAAI,SAAS,GAAG,IAAA,uBAAK,EAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,OAAO,SAAS,CAAC,MAAM,CAAC;QACxB,OAAO,SAAS,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;GAGG;AACH,kBAAe,MAAM,CAAC"}

package/lib-esm/util/errors.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @fileoverview Errors Helper
+ */
+/**
+ * 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
+ */
+declare const errors: {
+    /**
+     * 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: any, message?: string): any;
+    /**
+     * 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: any, message?: string): any;
+    /**
+     * 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: any): any;
+    /**
+     * 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: any): never;
+};
+export default errors;

package/lib-esm/util/errors.js

@@ -0,0 +1,194 @@
+"use strict";
+/**
+ * @fileoverview Errors Helper
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const qs = __importStar(require("querystring"));
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const httpStatusCodes = require('http-status');
+const 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
+ */
+class Request {
+    method;
+    url;
+    httpVersion;
+    headers;
+    body;
+    constructor(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;
+    }
+}
+// ------------------------------------------------------------------------------
+// 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
+ */
+const errors = {
+    /**
+     * 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 /* 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 /* FIXME */ = 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 /* 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(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(error /* FIXME */) {
+        if (error.cause) {
+            throw error.cause;
+        }
+        throw error;
+    },
+};
+exports.default = errors;
+//# sourceMappingURL=errors.js.map

package/lib-esm/util/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/util/errors.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAElC,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AACjF,MAAM,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAE/C,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAE9C,iFAAiF;AACjF,yBAAyB;AACzB,iFAAiF;AAEjF;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,OAAO;IACX,MAAM,CAAkB;IACxB,GAAG,CAAkB;IACrB,WAAW,CAAkB;IAC7B,OAAO,CAAkB;IACzB,IAAI,CAAkB;IAEtB,YAAY,GAAQ,CAAC,WAAW;QAC9B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,GAAG;gBACT,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;aACvB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAClB,CAAC;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;IACvB,CAAC;CACF;AAED,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;GAOG;AACH,MAAM,MAAM,GAAG;IACb;;;;;;;OAOG;IACH,kBAAkB,CAAC,QAAa,CAAC,WAAW,EAAE,OAAgB;QAC5D,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,CAAC;YAC/D,iFAAiF;YACjF,OAAO,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAC1D,CAAC;QAED,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YAClB,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC7B,qBAAqB;gBACrB,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;YAC/C,CAAC;YAED,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;YACtD,gBAAgB;gBACd,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC;QAC7D,CAAC;QAED,IAAI,YAAY,CAAC;QACjB,IAAI,OAAO,EAAE,CAAC;YACZ,YAAY,GAAG,GAAG,OAAO,KAAK,UAAU,IAAI,aAAa,MAAM,OAAO,GAAG,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,GAAG,OAAO,KAAK,UAAU,IAAI,aAAa,GAAG,CAAC;QAC/D,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,IAAI,IAAI,SAAS,EAAE,CAAC;QAClC,CAAC;QACD,IAAI,gBAAgB,EAAE,CAAC;YACrB,YAAY,IAAI,MAAM,gBAAgB,EAAE,CAAC;QAC3C,CAAC;QAED,IAAI,aAAa,CAAM,WAAW,GAAG,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;YACtC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC/B,CAAC,CAAC,EAAE,CAAC;QAEP,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,QAAa,CAAC,WAAW,EAAE,OAAgB;QACxD,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;IACvB,CAAC;IAED;;;;;;;;OAQG;IACH,4BAA4B,CAAC,QAAa,CAAC,WAAW;QACpD,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,KAAU,CAAC,WAAW;QACnC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,KAAK,CAAC,KAAK,CAAC;QACpB,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}

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

@@ -0,0 +1,11 @@
+/**
+ * @fileoverview Calculate exponential backoff time
+ */
+/**
+ * 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
+ */
+declare function getRetryTimeout(numRetries: number, baseInterval: number): number;
+export default getRetryTimeout;

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

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @fileoverview Calculate exponential backoff time
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+// ------------------------------------------------------------------------------
+// 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);
+}
+exports.default = getRetryTimeout;
+//# sourceMappingURL=exponential-backoff.js.map

package/lib-esm/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,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC;;;;;GAKG;AACH,SAAS,eAAe,CAAC,UAAkB,EAAE,YAAoB;IAC/D,IAAI,gBAAgB,GAAG,CAAC,GAAG,0BAA0B,CAAC;IACtD,IAAI,gBAAgB,GAAG,CAAC,GAAG,0BAA0B,CAAC;IACtD,IAAI,aAAa,GACf,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;IAC3E,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;AAC/D,CAAC;AAED,kBAAe,eAAe,CAAC"}

package/lib-esm/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 default PagingIterator;