box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/util/paging-iterator.js

@@ -0,0 +1,247 @@
+"use strict";
+/**
+ * @fileoverview Iterator for paged responses
+ */
+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;
+    };
+})();
+const qs = __importStar(require("querystring"));
+const bluebird_1 = require("bluebird");
+const PromiseQueue = require("promise-queue");
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * The iterator response object
+ * @typedef {Object} IteratorData
+ * @property {Array} [value] - The next set of values from the iterator
+ * @property {boolean} done - Whether the iterator is completed
+ */
+/**
+ * Iterator callback
+ * @callback IteratorCallback
+ * @param {?Error} err - An error if the iterator encountered one
+ * @param {IteratorData} [data] - New data from the iterator
+ * @returns {void}
+ */
+// -----------------------------------------------------------------------------
+// Requirements
+// -----------------------------------------------------------------------------
+const errors = require('./errors');
+PromiseQueue.configure(bluebird_1.Promise);
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const PAGING_MODES = Object.freeze({
+    MARKER: 'marker',
+    OFFSET: 'offset',
+});
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Asynchronous iterator for paged collections
+ */
+class PagingIterator {
+    /**
+     * Determine if a response is iterable
+     * @param {Object} response - The API response
+     * @returns {boolean} Whether the response is iterable
+     */
+    static isIterable(response /* FIXME */) {
+        // POST responses for uploading a file are explicitly excluded here because, while the response is iterable,
+        // it always contains only a single entry and historically has not been handled as iterable in the SDK.
+        // This behavior is being preserved here to avoid a breaking change.
+        let UPLOAD_PATTERN = /.*upload\.box\.com.*\/content/;
+        var isGetOrPostRequest = response.request &&
+            (response.request.method === 'GET' ||
+                (response.request.method === 'POST' &&
+                    !UPLOAD_PATTERN.test(response.request.uri.href))), hasEntries = response.body && Array.isArray(response.body.entries), notEventStream = response.body && !response.body.next_stream_position;
+        return Boolean(isGetOrPostRequest && hasEntries && notEventStream);
+    }
+    /**
+     * @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 /* FIXME */, client /* FIXME */) {
+        if (!PagingIterator.isIterable(response)) {
+            throw new Error('Cannot create paging iterator for non-paged response!');
+        }
+        var data = response.body;
+        if (Number.isSafeInteger(data.offset)) {
+            this.nextField = PAGING_MODES.OFFSET;
+            this.nextValue = data.offset;
+        }
+        else if (typeof data.next_marker === 'undefined') {
+            // Default to a finished marker collection when there's no field present,
+            // since some endpoints indicate completed paging this way
+            this.nextField = PAGING_MODES.MARKER;
+            this.nextValue = null;
+        }
+        else {
+            this.nextField = PAGING_MODES.MARKER;
+            this.nextValue = data.next_marker;
+        }
+        this.limit = data.limit || data.entries.length;
+        this.done = false;
+        var href = response.request.href.split('?')[0];
+        this.options = {
+            headers: response.request.headers,
+            qs: qs.parse(response.request.uri.query),
+        };
+        if (response.request.body) {
+            if (Object.prototype.toString.call(response.request.body) ===
+                '[object Object]') {
+                this.options.body = response.request.body;
+            }
+            else {
+                this.options.body = JSON.parse(response.request.body);
+            }
+        }
+        // querystring.parse() makes everything a string, ensure numeric params are the correct type
+        if (this.options.qs.limit) {
+            this.options.qs.limit = parseInt(this.options.qs.limit, 10);
+        }
+        if (this.options.qs.offset) {
+            this.options.qs.offset = parseInt(this.options.qs.offset, 10);
+        }
+        delete this.options.headers.Authorization;
+        if (response.request.method === 'GET') {
+            this.fetch = client.get.bind(client, href);
+        }
+        if (response.request.method === 'POST') {
+            this.fetch = client.post.bind(client, href);
+        }
+        this.buffer = response.body.entries;
+        this.queue = new PromiseQueue(1, Infinity);
+        this._updatePaging(response);
+    }
+    /**
+     * Update the paging parameters for the iterator
+     * @private
+     * @param {Object} response - The latest API response
+     * @returns {void}
+     */
+    _updatePaging(response /* FIXME */) {
+        var data = response.body;
+        if (this.nextField === PAGING_MODES.OFFSET) {
+            this.nextValue += this.limit;
+            if (Number.isSafeInteger(data.total_count)) {
+                this.done = data.offset + this.limit >= data.total_count;
+            }
+            else {
+                this.done = data.entries.length === 0;
+            }
+        }
+        else if (this.nextField === PAGING_MODES.MARKER) {
+            if (data.next_marker) {
+                this.nextValue = data.next_marker;
+            }
+            else {
+                this.nextValue = null;
+                this.done = true;
+            }
+        }
+        if (response.request.method === 'GET') {
+            this.options.qs[this.nextField] = this.nextValue;
+        }
+        else if (response.request.method === 'POST') {
+            if (!this.options.body) {
+                this.options.body = {};
+            }
+            this.options.body[this.nextField] = this.nextValue;
+            let bodyString = JSON.stringify(this.options.body);
+            this.options.headers['content-length'] = bodyString.length;
+        }
+    }
+    /**
+     * Fetch the next page of results
+     * @returns {Promise} Promise resolving to iterator state
+     */
+    _getData() {
+        return this.fetch(this.options).then((response /* FIXME */) => {
+            if (response.statusCode !== 200) {
+                throw errors.buildUnexpectedResponseError(response);
+            }
+            this._updatePaging(response);
+            this.buffer = this.buffer.concat(response.body.entries);
+            if (this.buffer.length === 0) {
+                if (this.done) {
+                    return {
+                        value: undefined,
+                        done: true,
+                    };
+                }
+                // If we didn't get any data in this page, but the paging
+                // parameters indicate that there is more data, attempt
+                // to fetch more.  This occurs in multiple places in the API
+                return this._getData();
+            }
+            return {
+                value: this.buffer.shift(),
+                done: false,
+            };
+        });
+    }
+    /**
+     * Fetch the next page of the collection
+     * @returns {Promise} Promise resolving to iterator state
+     */
+    next() {
+        if (this.buffer.length > 0) {
+            return bluebird_1.Promise.resolve({
+                value: this.buffer.shift(),
+                done: false,
+            });
+        }
+        if (this.done) {
+            return bluebird_1.Promise.resolve({
+                value: undefined,
+                done: true,
+            });
+        }
+        return this.queue.add(this._getData.bind(this));
+    }
+    /**
+     * Fetch the next marker
+     * @returns {string|int} String that is the next marker or int that is the next offset
+     */
+    getNextMarker() {
+        return this.nextValue;
+    }
+}
+module.exports = PagingIterator;
+//# sourceMappingURL=paging-iterator.js.map

package/lib-esm/util/paging-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paging-iterator.js","sourceRoot":"","sources":["../../src/util/paging-iterator.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAClC,uCAAmC;AACnC,8CAA+C;AAE/C,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;;GAKG;AAEH;;;;;;GAMG;AAEH,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEnC,YAAY,CAAC,SAAS,CAAC,kBAAc,CAAC,CAAC;AAEvC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;GAEG;AACH,MAAM,cAAc;IAClB;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,QAAa,CAAC,WAAW;QACzC,4GAA4G;QAC5G,uGAAuG;QACvG,oEAAoE;QACpE,IAAI,cAAc,GAAG,+BAA+B,CAAC;QACrD,IAAI,kBAAkB,GAClB,QAAQ,CAAC,OAAO;YAChB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK;gBAChC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM;oBACjC,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EACvD,UAAU,GAAG,QAAQ,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAClE,cAAc,GAAG,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAExE,OAAO,OAAO,CAAC,kBAAkB,IAAI,UAAU,IAAI,cAAc,CAAC,CAAC;IACrE,CAAC;IAYD;;;;;;OAMG;IACH,YAAY,QAAa,CAAC,WAAW,EAAE,MAAW,CAAC,WAAW;QAC5D,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QACzB,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/B,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,WAAW,EAAE,CAAC;YACnD,yEAAyE;YACzE,0DAA0D;YAC1D,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAC/C,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAElB,IAAI,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO;YACjC,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;SACzC,CAAC;QACF,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC1B,IACE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;gBACrD,iBAAiB,EACjB,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,4FAA4F;QAC5F,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAC1C,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,QAAa,CAAC,WAAW;QACrC,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAEzB,IAAI,IAAI,CAAC,SAAS,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;YAC3C,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;YAE7B,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;YAClD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gBACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnD,CAAC;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC;YACzB,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YACnD,IAAI,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAa,CAAC,WAAW,EAAE,EAAE;YACjE,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAChC,MAAM,MAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YAED,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAE7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAExD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,OAAO;wBACL,KAAK,EAAE,SAAS;wBAChB,IAAI,EAAE,IAAI;qBACX,CAAC;gBACJ,CAAC;gBAED,yDAAyD;gBACzD,uDAAuD;gBACvD,4DAA4D;gBAC5D,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzB,CAAC;YAED,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC1B,IAAI,EAAE,KAAK;aACZ,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,kBAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC1B,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,kBAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CACF;AAED,iBAAS,cAAc,CAAC"}

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

@@ -0,0 +1,10 @@
+export declare class Serializable<T> {
+    constructor(options: {
+        serialize: (value: T) => any;
+        deserialize: (data: any) => T;
+    });
+    readonly serialize: (value: T | undefined) => any;
+    readonly deserialize: (data: any) => T;
+    serializeArray(value: T[] | undefined): any[];
+    deserializeArray(data: any[]): T[];
+}

package/lib-esm/util/serializable.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Serializable = void 0;
+class Serializable {
+    constructor(options) {
+        this.serialize = options.serialize;
+        this.deserialize = options.deserialize;
+    }
+    serializeArray(value) {
+        return (value || []).map(this.serialize);
+    }
+    deserializeArray(data) {
+        return data.map(this.deserialize);
+    }
+}
+exports.Serializable = Serializable;
+//# sourceMappingURL=serializable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serializable.js","sourceRoot":"","sources":["../../src/util/serializable.ts"],"names":[],"mappings":";;;AAAA,MAAa,YAAY;IACvB,YAAY,OAGX;QACC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAgB,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACzC,CAAC;IAKD,cAAc,CAAC,KAAsB;QACnC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB,CAAC,IAAW;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;CACF;AAnBD,oCAmBC"}

package/lib-esm/util/url-path.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview URL Path Builder
+ */
+/**
+ * URLPath will create a full URL path from the given array of segments.
+ *
+ * It also provides the following features:
+ * - convert all segments to strings
+ * - add/remove slashes between segments, where appropriate
+ * - encode each path segment to prevent path manipulation
+ *
+ * @name URLPath
+ * @returns {string} Return a valid URL path comprised of the given path segments
+ */
+declare const _default: (...args: any[]) => string;
+export = _default;

package/lib-esm/util/url-path.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * @fileoverview URL Path Builder
+ */
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+// Pattern to check for relative paths
+const PATTERN = /\/\.+/;
+/**
+ * remove leading & trailing slashes from some string. This is useful for
+ * removing slashes from the path segments that are actually a part of the
+ * path itself. Without this step, these slashes would be uri-encoded.
+ *
+ * @param {string} segment The path segment (ex: '/users')
+ * @returns {string} The path segment with slashes trimmed (ex: 'users')
+ * @private
+ */
+function trimSlashes(segment) {
+    return segment.replace(/^\/|\/$/g, '');
+}
+module.exports = function urlPath(...args) {
+    const path = args
+        .map((x) => String(x))
+        .map((x) => {
+        var trimmedX = trimSlashes(x);
+        if (PATTERN.test(trimmedX)) {
+            throw new Error(`An invalid path parameter exists in ${trimmedX}. Relative path parameters cannot be passed.`);
+        }
+        return trimmedX;
+    })
+        .map((x) => encodeURIComponent(x))
+        .join('/');
+    return `/${path}`;
+};
+//# sourceMappingURL=url-path.js.map

package/lib-esm/util/url-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-path.js","sourceRoot":"","sources":["../../src/util/url-path.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,sCAAsC;AACtC,MAAM,OAAO,GAAG,OAAO,CAAC;AAExB;;;;;;;;GAQG;AACH,SAAS,WAAW,CAAC,OAAe;IAClC,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACzC,CAAC;AAiBD,iBAAS,SAAS,OAAO,CAAC,GAAG,IAAW;IACtC,MAAM,IAAI,GAAG,IAAI;SACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACrB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,IAAI,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,uCAAuC,QAAQ,8CAA8C,CAC9F,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;SACjC,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,IAAI,IAAI,EAAE,CAAC;AACpB,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box <oss@box.com>",
-  "version": "3.8.0",
+  "version": "3.8.2",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {
@@ -21,76 +21,81 @@
     "node": ">= 14.0.0"
   },
   "main": "./lib/box-node-sdk.js",
+  "module": "./lib-esm/box-node-sdk.js",
+  "exports": {
+    ".": {
+      "import": "./lib-esm/box-node-sdk.js",
+      "require": "./lib/box-node-sdk.js"
+    },
+    "./*": {
+      "import": "./lib-esm/*.js",
+      "require": "./lib/*.js"
+    }
+  },
   "scripts": {
-    "test": "node Makefile.js",
+    "test": "npm run build && nyc mocha",
     "jest": "npm run build && jest",
-    "build": "node Makefile.js build",
-    "codegen": "ts-node codegen/codegen.tsx",
-    "lint": "node Makefile.js lint",
-    "docs": "node Makefile.js docs",
-    "docs-dev": "node Makefile.js docsDev",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc --project tsconfig.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "codegen": "cd codegen && npm run codegen",
+    "docs": "jsdoc -p -r -c ./jsdoc.json -d ./docs/jsdoc ./src/",
     "doctoc": "doctoc docs",
     "deps": "npm prune && npm install",
-    "changelog": "node node_modules/standard-version/bin/cli.js --skip.commit --skip.push --skip.tag --dry-run"
+    "changelog": "node node_modules/standard-version/bin/cli.js --skip.commit --skip.push --skip.tag --dry-run",
+    "prettier": "npx prettier --write ."
   },
   "dependencies": {
-    "@cypress/request": "^3.0.1",
+    "@cypress/request": "^3.0.9",
     "@types/bluebird": "^3.5.35",
     "@types/node": "^18.15.3",
     "ajv": "^6.12.3",
     "bluebird": "^3.7.2",
     "http-status": "^1.4.1",
     "jsonwebtoken": "^9.0.2",
-    "merge-options": "^1.0.1",
+    "merge-options": "^3.0.4",
     "promise-queue": "^2.2.3",
     "proxy-agent": "^6.4.0",
     "url-template": "^2.0.8",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^28.1.1",
+    "@types/jest": "^29.5.14",
     "@types/jsonwebtoken": "^8.5.1",
-    "@types/lodash": "^4.14.172",
     "@types/prettier": "^2.3.2",
     "@types/promise-queue": "^2.2.0",
-    "@types/shelljs": "^0.8.9",
     "@types/url-template": "^2.0.28",
     "@types/uuid": "^9.0.1",
     "better-docs": "^2.7.2",
     "chai": "^4.2.0",
     "doctoc": "^2.2.1",
-    "eslint": "^6.8.0",
+    "eslint": "^9.28.0",
+    "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-jest": "^23.20.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-unicorn": "^4.0.3",
-    "istanbul": "^0.4.3",
-    "jest": "^28.1.3",
+    "jest": "^29.7.0",
     "jsdoc": "^4.0.4",
-    "jsonlint": "^1.6.3",
-    "jsonlint2": "^1.7.1",
     "leche": "^2.3.0",
-    "lodash": "^4.17.21",
-    "mocha": "^10.2.0",
+    "mocha": "^10.8.2",
     "mockery": "^2.1.0",
     "nock": "^13.3.1",
     "nyc": "^14.0.0",
-    "prettier": "^2.3.2",
-    "shelljs": "^0.8.5",
-    "shelljs-nodecli": "^0.1.1",
+    "prettier": "^3.5.3",
     "sinon": "^7.5.0",
     "standard-version": "^9.3.2",
-    "ts-jest": "^28.0.8",
-    "ts-node": "^10.2.0",
-    "typescript": "^4.2.4"
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.8.2"
   },
-	"overrides": {
+  "overrides": {
     "leche": {
       "mocha": ">=1.18"
     }
   },
   "files": [
     "config",
-    "lib"
+    "lib",
+    "lib-esm"
   ]
 }