box-node-sdk 3.8.1 → 3.8.2

package/lib-esm/chunked-uploader.d.ts

@@ -0,0 +1,128 @@
+/**
+ * @fileoverview Upload manager for large file uploads
+ */
+/**
+ * Chunk uploaded event
+ * @event Chunk#uploaded
+ * @param {UploadPart} data The data of the uploaded chunk
+ * @private
+ */
+/**
+ * Chunk error event
+ * @event Chunk#error
+ * @param {Error} err The error that occurred
+ * @private
+ */
+/**
+ * Event for when the upload is successfully aborted
+ * @event ChunkedUploader#aborted
+ */
+/**
+ * Event for when the abort fails because the upload session is not destroyed.
+ * In general, the abort can be retried, and no new chunks will be uploaded.
+ * @event ChunkedUploader#abortFailed
+ * @param {Error} err The error that occurred
+ */
+/**
+ * Event for when a chunk fails to upload.  Note that the chunk will automatically
+ * retry until it is successfully uploaded.
+ * @event ChunkedUploader#chunkError
+ * @param {Error} err The error that occurred during chunk upload
+ */
+/**
+ * Event for when a chunk is successfully uploaded
+ * @event ChunkedUploader#chunkUploaded
+ * @param {UploadPart} data The data for the uploaded chunk
+ */
+/**
+ * Event for when the entire upload is complete
+ * @event ChunkedUploader#uploadComplete
+ * @param {Object} file The file object for the newly-uploaded file
+ */
+/**
+ * Event for when an upload fails
+ * @event ChunkedUploader#error
+ * @param {Error} err The error that occurred
+ */
+type ChunkedUploaderOptions = {
+    retryInterval?: number;
+    parallelism?: number;
+    fileAttributes?: Record<string, any>;
+};
+type UploadSessionInfo = {
+    id: string;
+    part_size: number;
+};
+import { EventEmitter } from 'events';
+import { Readable as ReadableStream } from 'stream';
+import crypto from 'crypto';
+import BoxClient from './box-client';
+/** Manager for uploading a file in chunks */
+declare class ChunkedUploader extends EventEmitter {
+    _client: BoxClient;
+    _sessionID: string;
+    _partSize: number;
+    _uploadSessionInfo: UploadSessionInfo;
+    _stream: ReadableStream | null;
+    _streamBuffer: Array<any>;
+    _file: Buffer | string | null;
+    _size: number;
+    _options: Required<ChunkedUploaderOptions>;
+    _isStarted: boolean;
+    _numChunksInFlight: number;
+    _chunks: Array<any>;
+    _position: number;
+    _fileHash: crypto.Hash;
+    _promise?: Promise<any>;
+    _resolve?: Function;
+    _reject?: Function;
+    /**
+     * Create an upload manager
+     * @param {BoxClient} client The client to use to upload the file
+     * @param {Object} uploadSessionInfo The upload session info to use for chunked upload
+     * @param {ReadableStream|Buffer|string} file The file to upload
+     * @param {int} size The size of the file to be uploaded
+     * @param {Object} [options] Optional parameters
+     * @param {int} [options.retryInterval=1000] The number of ms to wait before retrying operations
+     * @param {int} [options.parallelism=4] The number of concurrent chunks to upload
+     * @param {Object} [options.fileAttributes] Attributes to set on the file during commit
+     */
+    constructor(client: BoxClient, uploadSessionInfo: UploadSessionInfo, file: ReadableStream | Buffer | string, size: number, options?: ChunkedUploaderOptions);
+    /**
+     * Start an upload
+     * @returns {Promise<Object>} A promise resolving to the uploaded file
+     */
+    start(): Promise<any> | undefined;
+    /**
+     * Abort a running upload, which cancels all currently uploading chunks,
+     * attempts to free up held memory, and aborts the upload session.  This
+     * cannot be undone or resumed.
+     * @returns {Promise} A promise resolving when the upload is aborted
+     * @emits ChunkedUploader#aborted
+     * @emits ChunkedUploader#abortFailed
+     */
+    abort(): any;
+    /**
+     * Get the next chunk of the file to be uploaded
+     * @param {Function} callback Called with the next chunk of the file to be uploaded
+     * @returns {void}
+     * @private
+     */
+    _getNextChunk(callback: Function): void;
+    /**
+     * Upload a chunk
+     * @param {Chunk} chunk The chunk to upload
+     * @returns {void}
+     * @emits ChunkedUploader#chunkError
+     * @emits ChunkedUploader#chunkUploaded
+     */
+    _uploadChunk(chunk: any): void;
+    /**
+     * Commit the upload, finalizing it
+     * @returns {void}
+     * @emits ChunkedUploader#uploadComplete
+     * @emits ChunkedUploader#error
+     */
+    _commit(): void;
+}
+export = ChunkedUploader;

package/lib-esm/chunked-uploader.js

@@ -0,0 +1,276 @@
+"use strict";
+/**
+ * @fileoverview Upload manager for large file uploads
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const bluebird_1 = require("bluebird");
+// -----------------------------------------------------------------------------
+// Requirements
+// -----------------------------------------------------------------------------
+const events_1 = require("events");
+const stream_1 = require("stream");
+const crypto_1 = __importDefault(require("crypto"));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const DEFAULT_OPTIONS = Object.freeze({
+    parallelism: 4,
+    retryInterval: 1000,
+});
+/**
+ * Chunk of a file to be uploaded, which handles trying to upload itself until
+ * it succeeds.
+ * @private
+ */
+class Chunk extends events_1.EventEmitter {
+    /**
+     * Create a Chunk, representing a part of a file being uploaded
+     * @param {BoxClient} client The Box SDK client
+     * @param {string} sessionID The ID of the upload session the chunk belongs to
+     * @param {Buffer|string} chunk The chunk that was uploaded
+     * @param {int} offset The byte offset within the file where this chunk begins
+     * @param {int} totalSize The total size of the file this chunk belongs to
+     * @param {Object} options The options from the ChunkedUploader
+     * @param {int} options.retryInterval The number of ms to wait before retrying a chunk upload
+     */
+    constructor(client, sessionID, chunk, offset, totalSize, options) {
+        super();
+        this.client = client;
+        this.sessionID = sessionID;
+        this.chunk = chunk;
+        this.length = chunk.length;
+        this.offset = offset;
+        this.totalSize = totalSize;
+        this.options = options;
+        this.data = null;
+        this.retry = null;
+        this.canceled = false;
+    }
+    /**
+     * Get the final object representation of this chunk for the API
+     * @returns {UploadPart} The chunk object
+     */
+    getData() {
+        return this.data.part;
+    }
+    /**
+     * Upload a chunk to the API
+     * @returns {void}
+     * @emits Chunk#uploaded
+     * @emits Chunk#error
+     */
+    upload() {
+        this.client.files.uploadPart(this.sessionID, this.chunk, this.offset, this.totalSize, (err /* FIXME */, data /* FIXME */) => {
+            if (this.canceled) {
+                this.chunk = null;
+                return;
+            }
+            if (err) {
+                // handle the error or retry
+                if (err.statusCode) {
+                    // an API error, probably not retryable!
+                    this.emit('error', err);
+                }
+                else {
+                    // maybe a network error, retry
+                    this.retry = setTimeout(() => this.upload(), this.options.retryInterval);
+                }
+                return;
+            }
+            // Record the chunk data for commit, and try to free up the chunk buffer
+            this.data = data;
+            this.chunk = null;
+            this.emit('uploaded', data);
+        });
+    }
+    /**
+     * Cancel trying to upload a chunk, preventing it from retrying and clearing
+     * the associated buffer
+     * @returns {void}
+     */
+    cancel() {
+        clearTimeout(this.retry); // number or NodeJS.Timeout
+        this.chunk = null;
+        this.canceled = true;
+    }
+}
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/** Manager for uploading a file in chunks */
+class ChunkedUploader extends events_1.EventEmitter {
+    /**
+     * Create an upload manager
+     * @param {BoxClient} client The client to use to upload the file
+     * @param {Object} uploadSessionInfo The upload session info to use for chunked upload
+     * @param {ReadableStream|Buffer|string} file The file to upload
+     * @param {int} size The size of the file to be uploaded
+     * @param {Object} [options] Optional parameters
+     * @param {int} [options.retryInterval=1000] The number of ms to wait before retrying operations
+     * @param {int} [options.parallelism=4] The number of concurrent chunks to upload
+     * @param {Object} [options.fileAttributes] Attributes to set on the file during commit
+     */
+    constructor(client, uploadSessionInfo, file, size, options) {
+        super();
+        this._client = client;
+        this._sessionID = uploadSessionInfo.id;
+        this._partSize = uploadSessionInfo.part_size;
+        this._uploadSessionInfo = uploadSessionInfo;
+        if (file instanceof stream_1.Readable) {
+            // Pause the stream so we can read specific chunks from it
+            this._stream = file.pause();
+            this._streamBuffer = [];
+        }
+        else if (file instanceof Buffer || typeof file === 'string') {
+            this._file = file;
+        }
+        else {
+            throw new TypeError('file must be a Stream, Buffer, or string!');
+        }
+        this._size = size;
+        this._options = Object.assign({}, DEFAULT_OPTIONS, options);
+        this._isStarted = false;
+        this._numChunksInFlight = 0;
+        this._chunks = [];
+        this._position = 0;
+        this._fileHash = crypto_1.default.createHash('sha1');
+    }
+    /**
+     * Start an upload
+     * @returns {Promise<Object>} A promise resolving to the uploaded file
+     */
+    start() {
+        if (this._isStarted) {
+            return this._promise;
+        }
+        // Create the initial chunks
+        for (let i = 0; i < this._options.parallelism; i++) {
+            this._getNextChunk((chunk /* FIXME */) => chunk ? this._uploadChunk(chunk) : this._commit());
+        }
+        this._isStarted = true;
+        /* eslint-disable promise/avoid-new */
+        this._promise = new bluebird_1.Promise((resolve, reject) => {
+            this._resolve = resolve;
+            this._reject = reject;
+        });
+        /* eslint-enable promise/avoid-new */
+        return this._promise;
+    }
+    /**
+     * Abort a running upload, which cancels all currently uploading chunks,
+     * attempts to free up held memory, and aborts the upload session.  This
+     * cannot be undone or resumed.
+     * @returns {Promise} A promise resolving when the upload is aborted
+     * @emits ChunkedUploader#aborted
+     * @emits ChunkedUploader#abortFailed
+     */
+    abort() {
+        this._chunks.forEach((chunk) => chunk.removeAllListeners().cancel());
+        this._chunks = [];
+        this._file = null;
+        this._stream = null;
+        return (this._client.files
+            .abortUploadSession(this._sessionID)
+            /* eslint-disable promise/always-return */
+            .then(() => {
+            this.emit('aborted');
+        })
+            /* eslint-enable promise/always-return */
+            .catch((err /* FIXME */) => {
+            this.emit('abortFailed', err);
+            throw err;
+        }));
+    }
+    /**
+     * Get the next chunk of the file to be uploaded
+     * @param {Function} callback Called with the next chunk of the file to be uploaded
+     * @returns {void}
+     * @private
+     */
+    _getNextChunk(callback) {
+        if (this._position >= this._size) {
+            callback(null);
+            return;
+        }
+        let buf;
+        if (this._file) {
+            // Buffer/string case, just get the slice we need
+            buf = this._file.slice(this._position, this._position + this._partSize);
+        }
+        else if (this._streamBuffer.length > 0) {
+            buf = this._streamBuffer.shift();
+        }
+        else {
+            // Stream case, need to read
+            buf = this._stream.read(this._partSize);
+            if (!buf) {
+                // stream needs to read more, retry later
+                setImmediate(() => this._getNextChunk(callback));
+                return;
+            }
+            else if (buf.length > this._partSize) {
+                // stream is done reading and had extra data, buffer the remainder of the file
+                for (let i = 0; i < buf.length; i += this._partSize) {
+                    this._streamBuffer.push(buf.slice(i, i + this._partSize));
+                }
+                buf = this._streamBuffer.shift();
+            }
+        }
+        this._fileHash.update(buf);
+        let chunk = new Chunk(this._client, this._sessionID, buf, this._position, this._size, this._options);
+        this._position += buf.length;
+        callback(chunk);
+    }
+    /**
+     * Upload a chunk
+     * @param {Chunk} chunk The chunk to upload
+     * @returns {void}
+     * @emits ChunkedUploader#chunkError
+     * @emits ChunkedUploader#chunkUploaded
+     */
+    _uploadChunk(chunk /* FIXME */) {
+        this._numChunksInFlight += 1;
+        chunk.on('error', (err /* FIXME */) => this.emit('chunkError', err));
+        chunk.on('uploaded', (data /* FIXME */) => {
+            this._numChunksInFlight -= 1;
+            this.emit('chunkUploaded', data);
+            this._getNextChunk((nextChunk /* FIXME */) => nextChunk ? this._uploadChunk(nextChunk) : this._commit());
+        });
+        chunk.upload();
+        this._chunks.push(chunk);
+    }
+    /**
+     * Commit the upload, finalizing it
+     * @returns {void}
+     * @emits ChunkedUploader#uploadComplete
+     * @emits ChunkedUploader#error
+     */
+    _commit() {
+        if (!this._isStarted || this._numChunksInFlight > 0) {
+            return;
+        }
+        let hash = this._fileHash.digest('base64');
+        this._isStarted = false;
+        let options = Object.assign({
+            parts: this._chunks.map((c) => c.getData()),
+        }, this._options.fileAttributes);
+        this._client.files.commitUploadSession(this._sessionID, hash, options, (err /* FIMXE */, file /* FIMXE */) => {
+            // It's not clear what the SDK can do here, so we just return the error and session info
+            // so users can retry if they wish
+            if (err) {
+                this.emit('error', {
+                    uploadSession: this._uploadSessionInfo,
+                    error: err,
+                });
+                this._reject(err);
+                return;
+            }
+            this.emit('uploadComplete', file);
+            this._resolve(file);
+        });
+    }
+}
+module.exports = ChunkedUploader;
+//# sourceMappingURL=chunked-uploader.js.map

package/lib-esm/chunked-uploader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunked-uploader.js","sourceRoot":"","sources":["../src/chunked-uploader.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,uCAAmC;AAoEnC,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,mCAAsC;AACtC,mCAAoD;AACpD,oDAA4B;AAG5B,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,WAAW,EAAE,CAAC;IACd,aAAa,EAAE,IAAI;CACpB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,KAAM,SAAQ,qBAAY;IAY9B;;;;;;;;;OASG;IACH,YACE,MAAiB,EACjB,SAAiB,EACjB,KAAsB,EACtB,MAAc,EACd,SAAiB,EACjB,OAA+B;QAE/B,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAC1B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAM,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,CAAC,GAAQ,CAAC,WAAW,EAAE,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9C,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,OAAO;YACT,CAAC;YAED,IAAI,GAAG,EAAE,CAAC;gBACR,4BAA4B;gBAC5B,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;oBACnB,wCAAwC;oBACxC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,IAAI,CAAC,KAAK,GAAG,UAAU,CACrB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EACnB,IAAI,CAAC,OAAO,CAAC,aAAa,CAC3B,CAAC;gBACJ,CAAC;gBACD,OAAO;YACT,CAAC;YAED,wEAAwE;YACxE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,YAAY,CAAC,IAAI,CAAC,KAAY,CAAC,CAAC,CAAC,2BAA2B;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;CACF;AAED,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF,6CAA6C;AAC7C,MAAM,eAAgB,SAAQ,qBAAY;IAmBxC;;;;;;;;;;OAUG;IACH,YACE,MAAiB,EACjB,iBAAoC,EACpC,IAAsC,EACtC,IAAY,EACZ,OAAgC;QAEhC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC;QAC7C,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAE5C,IAAI,IAAI,YAAY,iBAAc,EAAE,CAAC;YACnC,0DAA0D;YAC1D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC;aAAM,IAAI,IAAI,YAAY,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC3B,EAAE,EACF,eAAe,EACf,OAAO,CAC4B,CAAC;QAEtC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,gBAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;QAED,4BAA4B;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC;YACnD,IAAI,CAAC,aAAa,CAAC,CAAC,KAAU,CAAC,WAAW,EAAE,EAAE,CAC5C,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAClD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,sCAAsC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,qCAAqC;QAErC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,OAAO,CACL,IAAI,CAAC,OAAO,CAAC,KAAK;aACf,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpC,0CAA0C;aACzC,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC,CAAC;YACF,yCAAyC;aACxC,KAAK,CAAC,CAAC,GAAQ,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAC9B,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,QAAkB;QAC9B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACjC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACf,OAAO;QACT,CAAC;QAED,IAAI,GAAG,CAAC;QAER,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,iDAAiD;YACjD,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1E,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,4BAA4B;YAC5B,GAAG,GAAI,IAAI,CAAC,OAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE5D,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,yCAAyC;gBACzC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACjD,OAAO;YACT,CAAC;iBAAM,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;gBACvC,8EAA8E;gBAC9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACpD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC5D,CAAC;gBACD,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,KAAK,GAAG,IAAI,KAAK,CACnB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,UAAU,EACf,GAAG,EACH,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,QAAQ,CACd,CAAC;QACF,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,MAAM,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,KAAU,CAAC,WAAW;QACjC,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC;QAE7B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1E,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,IAAS,CAAC,WAAW,EAAE,EAAE;YAC7C,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC;YAE7B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,aAAa,CAAC,CAAC,SAAc,CAAC,WAAW,EAAE,EAAE,CAChD,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAC1D,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,kBAAkB,GAAG,CAAC,EAAE,CAAC;YACpD,OAAO;QACT,CAAC;QAED,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CACzB;YACE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;SAC5C,EACD,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC7B,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CACpC,IAAI,CAAC,UAAU,EACf,IAAI,EACJ,OAAO,EACP,CAAC,GAAQ,CAAC,WAAW,EAAE,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9C,wFAAwF;YACxF,kCAAkC;YAClC,IAAI,GAAG,EAAE,CAAC;gBACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,aAAa,EAAE,IAAI,CAAC,kBAAkB;oBACtC,KAAK,EAAE,GAAG;iBACX,CAAC,CAAC;gBACH,IAAI,CAAC,OAAQ,CAAC,GAAG,CAAC,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,QAAS,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAED,iBAAS,eAAe,CAAC"}

package/lib-esm/enterprise-event-stream.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @fileoverview Enterprise event stream backed by the enterprise events API
+ */
+import { Readable } from 'stream';
+import BoxClient from './box-client';
+type Options = {
+    streamPosition?: string;
+    startDate?: string;
+    endDate?: string;
+    eventTypeFilter?: EventType[];
+    pollingInterval?: number;
+    chunkSize?: number;
+    streamType?: 'admin_logs' | 'admin_logs_streaming';
+};
+type EventType = string;
+/**
+ * Stream of Box enterprise events.
+ *
+ * By default, the stream starts from the current time.
+ * Pass 'startDate' to start from a specific time.
+ * Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year).
+ * Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds.
+ * If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling).
+ *
+ * @param {BoxClient} client - The client to use to get events
+ * @param {Object} [options] - Options
+ * @param {string} [options.streamPosition] - The stream position to start from (pass '0' for all past events)
+ * @param {string} [options.startDate] - The date to start from
+ * @param {string} [options.endDate] - The date to end at
+ * @param {EventType[]} [options.eventTypeFilter] - Array of event types to return
+ * @param {int} [options.pollingInterval=60] - Polling interval (in seconds).  Pass 0 for no polling.
+ * @param {int} [options.chunkSize=500] - Number of events to fetch per call (max = 500)
+ * @constructor
+ * @extends Readable
+ */
+declare class EnterpriseEventStream extends Readable {
+    _client: BoxClient;
+    _options: Options & Required<Pick<Options, 'pollingInterval' | 'chunkSize'>>;
+    _streamPosition?: string;
+    constructor(client: BoxClient, options?: Options);
+    /**
+     * @returns {?number} - Returns null if no events have been fetched from Box yet.
+     */
+    getStreamPosition(): string | undefined;
+    /**
+     * Get the stream state.
+     *
+     * @returns {Object} - The stream state
+     */
+    getStreamState(): {
+        streamPosition: string | undefined;
+        startDate: string | undefined;
+        endDate: string | undefined;
+        eventTypeFilter: string[] | undefined;
+    };
+    /**
+     * Set the stream state.
+     *
+     * @param {Object} state - The stream state
+     * @returns {void}
+     */
+    setStreamState(state: Pick<Options, 'streamPosition' | 'startDate' | 'endDate' | 'eventTypeFilter'>): void;
+    /**
+     * Fetch the next chunk of events
+     *
+     * If there are no events, poll until events are available.
+     * If an error occurs, emit the error but continuing polling as usual.
+     * @param {Function} callback - Passed the array of events
+     * @returns {void}
+     * @private
+     */
+    fetchEvents(callback: Function): void;
+    /**
+     * Implementation of the stream-internal read function.	This is called
+     * by the stream whenever it needs more data, and will not be called again
+     * until data is pushed into the stream.
+     * @returns {void}
+     * @private
+     */
+    _read(): void;
+}
+export = EnterpriseEventStream;