box-node-sdk 3.8.1 → 3.8.2

package/lib-esm/enterprise-event-stream.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * @fileoverview Enterprise event stream backed by the enterprise events API
+ */
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const stream_1 = require("stream");
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const DEFAULT_OPTIONS = Object.freeze({
+    pollingInterval: 60, // seconds
+    chunkSize: 500,
+    streamType: 'admin_logs',
+});
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * 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
+ */
+class EnterpriseEventStream extends stream_1.Readable {
+    constructor(client, options) {
+        super({
+            objectMode: true,
+        });
+        /**
+         * @var {BoxClient} - The client for making API calls
+         * @private
+         */
+        this._client = client;
+        /**
+         * @var {Object} - Options
+         * @private
+         */
+        this._options = Object.assign({}, DEFAULT_OPTIONS, options);
+        // Handle the case where the caller passes streamPosition = 0 instead of streamPosition = '0'.
+        if (this._options.streamType === 'admin_logs' &&
+            !this._options.startDate &&
+            !this._options.streamPosition &&
+            this._options.streamPosition !== 0) {
+            // If neither startDate nor streamPosition is specified, start from the current time.
+            this._options.startDate = new Date()
+                .toISOString()
+                .replace(/\.000Z$/, '-00:00');
+        }
+        /**
+         * @var {?string} - The current stream position
+         * @private
+         */
+        this._streamPosition = this._options.streamPosition;
+    }
+    /**
+     * @returns {?number} - Returns null if no events have been fetched from Box yet.
+     */
+    getStreamPosition() {
+        return this._streamPosition;
+    }
+    /**
+     * Get the stream state.
+     *
+     * @returns {Object} - The stream state
+     */
+    getStreamState() {
+        // We need to return both streamPosition and startDate, since streamPosition will be null until
+        // the first set of events is returned from Box.
+        return {
+            streamPosition: this._streamPosition,
+            startDate: this._options.startDate,
+            endDate: this._options.endDate,
+            eventTypeFilter: this._options.eventTypeFilter,
+        };
+    }
+    /**
+     * Set the stream state.
+     *
+     * @param {Object} state - The stream state
+     * @returns {void}
+     */
+    setStreamState(state) {
+        // We need to set both streamPosition and startDate, since streamPosition will be null until
+        // the first set of events is returned from Box.
+        this._streamPosition = state.streamPosition;
+        this._options.startDate = state.startDate;
+        this._options.endDate = state.endDate;
+        this._options.eventTypeFilter = state.eventTypeFilter;
+    }
+    /**
+     * 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) {
+        const self = this, params = {
+            stream_type: this._options.streamType,
+        };
+        // Use the current stream position.
+        // Handle the case where the caller passes streamPosition === 0 instead of streamPosition === '0'.
+        if (this._streamPosition || this._streamPosition === 0) {
+            params.stream_position = this._streamPosition;
+        }
+        if (this._options.streamType === 'admin_logs' && this._options.startDate) {
+            params.created_after = this._options.startDate;
+        }
+        if (this._options.streamType === 'admin_logs' && this._options.endDate) {
+            params.created_before = this._options.endDate;
+        }
+        if (this._options.eventTypeFilter) {
+            params.event_type = this._options.eventTypeFilter.join(',');
+        }
+        if (this._options.chunkSize) {
+            params.limit = this._options.chunkSize;
+        }
+        this._client.events.get(params, (err /* FIXME */, result /* FIXME */) => {
+            if (err) {
+                self.emit('error', err);
+                // If there was a "permanent" error, we would call the callback with it here.
+                // But it's not clear which errors are truly permanent?
+                // If Box is down or returning errors for an extended period, we still want to resume when it recovers.
+                // So, continue polling at the regular frequency.
+                // Don't use a shorter retry interval (to avoid DDOSing Box).
+            }
+            if (err || !result || !result.entries || result.entries.length === 0) {
+                if (!self._options.pollingInterval) {
+                    // If polling is disabled, end the stream.
+                    callback();
+                    return;
+                }
+                // There were no events returned (or an error occurred), so schedule another poll.
+                const delay = self._options.pollingInterval * 1000;
+                // Stream readers can use this to flush buffered events to a downstream system.
+                self.emit('wait', delay);
+                setTimeout(() => {
+                    self.fetchEvents(callback);
+                }, delay);
+                return;
+            }
+            // Only update the stream position if there were events returned.
+            // The API currently returns next_stream_position = 0 if there are no events (may be a bug?).
+            // But we don't want to start over at the beginning in that case, so ignore it.
+            self._streamPosition = result.next_stream_position;
+            // Notify the reader of the new stream position.
+            // Stream readers can respond to the 'newStreamState' event to persist the stream state.
+            self.emit('newStreamState', self.getStreamState());
+            callback(null, result.entries);
+        });
+    }
+    /**
+     * 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() {
+        // Fetch the next chunk of events.
+        const self = this;
+        // This will poll forever until events are available.
+        this.fetchEvents((err /* FIXME */, events /* FIXME */) => {
+            if (err || !events || events.length === 0) {
+                // Close the stream if there was a "permanent" failure or we reached the end of the events.
+                self.push(null);
+                return;
+            }
+            // Pause the stream to avoid race conditions while pushing in the new events.
+            // Without this, _read() would be called again from inside each push(),
+            // resulting in multiple parallel calls to fetchEvents().
+            // See https://github.com/nodejs/node/issues/3203
+            const wasPaused = self.isPaused();
+            self.pause();
+            // Push all of the events into the stream.
+            events.forEach((event /* FIXME */) => {
+                self.push(event);
+            });
+            if (!wasPaused) {
+                // This will deliver the events and trigger the next call to _read() once they have been consumed.
+                self.resume();
+            }
+        });
+    }
+}
+module.exports = EnterpriseEventStream;
+//# sourceMappingURL=enterprise-event-stream.js.map

package/lib-esm/enterprise-event-stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enterprise-event-stream.js","sourceRoot":"","sources":["../src/enterprise-event-stream.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,mCAAkC;AAmBlC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,eAAe,EAAE,EAAE,EAAE,UAAU;IAC/B,SAAS,EAAE,GAAG;IACd,UAAU,EAAE,YAAY;CACzB,CAAC,CAAC;AAEH,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,qBAAsB,SAAQ,iBAAQ;IAK1C,YAAY,MAAiB,EAAE,OAAiB;QAC9C,KAAK,CAAC;YACJ,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH;;;WAGG;QACH,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAE5D,8FAA8F;QAC9F,IACE,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,YAAY;YACzC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS;YACxB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc;YAC5B,IAAI,CAAC,QAAQ,CAAC,cAAsB,KAAK,CAAC,EAC3C,CAAC;YACD,qFAAqF;YACrF,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE;iBACjC,WAAW,EAAE;iBACb,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;QAED;;;WAGG;QACH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,+FAA+F;QAC/F,gDAAgD;QAChD,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;YAC9B,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;SAC/C,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,KAGC;QAED,4FAA4F;QAC5F,gDAAgD;QAChD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CAAC,QAAkB;QAC5B,MAAM,IAAI,GAAG,IAAI,EACf,MAAM,GAOF;YACF,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;SACtC,CAAC;QAEJ,mCAAmC;QACnC,kGAAkG;QAClG,IAAI,IAAI,CAAC,eAAe,IAAK,IAAI,CAAC,eAAuB,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YACzE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACjD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACvE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;YAClC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CACrB,MAAM,EACN,CAAC,GAAQ,CAAC,WAAW,EAAE,MAAW,CAAC,WAAW,EAAE,EAAE;YAChD,IAAI,GAAG,EAAE,CAAC;gBACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBACxB,6EAA6E;gBAC7E,uDAAuD;gBACvD,uGAAuG;gBACvG,iDAAiD;gBACjD,6DAA6D;YAC/D,CAAC;YAED,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;oBACnC,0CAA0C;oBAC1C,QAAQ,EAAE,CAAC;oBACX,OAAO;gBACT,CAAC;gBAED,kFAAkF;gBAClF,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,IAAI,CAAC;gBAEnD,+EAA+E;gBAC/E,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBAEzB,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC7B,CAAC,EAAE,KAAK,CAAC,CAAC;gBACV,OAAO;YACT,CAAC;YAED,iEAAiE;YACjE,6FAA6F;YAC7F,+EAA+E;YAC/E,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,oBAAoB,CAAC;YAEnD,gDAAgD;YAChD,wFAAwF;YACxF,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;YAEnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,kCAAkC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,qDAAqD;QACrD,IAAI,CAAC,WAAW,CAAC,CAAC,GAAQ,CAAC,WAAW,EAAE,MAAW,CAAC,WAAW,EAAE,EAAE;YACjE,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1C,2FAA2F;gBAC3F,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChB,OAAO;YACT,CAAC;YAED,6EAA6E;YAC7E,uEAAuE;YACvE,yDAAyD;YACzD,iDAAiD;YACjD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,EAAE,CAAC;YAEb,0CAA0C;YAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAU,CAAC,WAAW,EAAE,EAAE;gBACxC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,kGAAkG;gBAClG,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,iBAAS,qBAAqB,CAAC"}

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

@@ -0,0 +1,91 @@
+/**
+ * @fileoverview Event stream backed by the events API
+ */
+import { Readable } from 'stream';
+import BoxClient from './box-client';
+type Options = {
+    retryDelay: number;
+    deduplicationFilterSize: number;
+    fetchInterval: number;
+};
+type LongPollInfo = {
+    max_retries: number;
+    retry_timeout: number;
+    url: string;
+};
+/**
+ * Stream of Box events from a given client and point in time.
+ * @param {BoxClient} client The client to use to get events
+ * @param {string} streamPosition The point in time to start at
+ * @param {Object} [options] Optional parameters
+ * @param {int} [options.retryDelay=1000] Number of ms to wait before retrying after an error
+ * @param {int} [options.deduplicationFilterSize=5000] Number of IDs to track for deduplication
+ * @param {int} [options.fetchInterval=1000] Minimunm number of ms between calls for more events
+ * @constructor
+ * @extends Readable
+ */
+declare class EventStream extends Readable {
+    _client: BoxClient;
+    _streamPosition: string;
+    _longPollInfo?: LongPollInfo;
+    _longPollRetries: number;
+    _dedupHash: Record<string, boolean>;
+    _rateLimiter: Promise<any>;
+    _options: Options;
+    _retryTimer?: NodeJS.Timeout | number;
+    constructor(client: BoxClient, streamPosition: string, options?: Partial<Options>);
+    /**
+     * Retrieve the url and params for long polling for new updates
+     * @returns {Promise} Promise for testing purposes
+     * @private
+     */
+    getLongPollInfo(): any;
+    /**
+     * Long poll for notification of new events.	We do this rather than
+     * polling for the events directly in order to minimize the number of API
+     * calls necessary.
+     * @returns {Promise} Promise for testing pruposes
+     * @private
+     */
+    doLongPoll(): any;
+    /**
+     * Retries long-polling after a delay.
+     * Does not attempt if stream is already destroyed.
+     * @returns {void}
+     * @private
+     */
+    retryPollInfo(): void;
+    /**
+     * Fetch the latest group of events and push them into the stream
+     * @returns {Promise} Promise for testing purposes
+     * @private
+     */
+    fetchEvents(): Promise<any>;
+    /**
+     * Clean up the deduplication filter, to prevent it from growing
+     * too big and eating up memory.	We look at the latest set of events
+     * returned and assume that any IDs not in that set don't need to be
+     * tracked for deduplication any more.
+     * @param {Object[]} latestEvents The latest events from the API
+     * @returns {void}
+     * @private
+     */
+    cleanupDedupFilter(latestEvents: any): 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;
+    /**
+     * Implementation of stream-internal `_destroy` function (v8.0.0 and later).
+     * Called by stream consumers to effectively stop polling via the public
+     * `destroy()`.
+     * @returns {void}
+     * @private
+     */
+    _destroy(): void;
+}
+export = EventStream;

package/lib-esm/event-stream.js

@@ -0,0 +1,277 @@
+"use strict";
+/**
+ * @fileoverview Event stream backed by the events API
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const bluebird_1 = require("bluebird");
+const querystring_1 = __importDefault(require("querystring"));
+const stream_1 = require("stream");
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const DEFAULT_OPTIONS = Object.freeze({
+    deduplicationFilterSize: 5000,
+    retryDelay: 1000,
+    fetchInterval: 1000,
+});
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Stream of Box events from a given client and point in time.
+ * @param {BoxClient} client The client to use to get events
+ * @param {string} streamPosition The point in time to start at
+ * @param {Object} [options] Optional parameters
+ * @param {int} [options.retryDelay=1000] Number of ms to wait before retrying after an error
+ * @param {int} [options.deduplicationFilterSize=5000] Number of IDs to track for deduplication
+ * @param {int} [options.fetchInterval=1000] Minimunm number of ms between calls for more events
+ * @constructor
+ * @extends Readable
+ */
+class EventStream extends stream_1.Readable {
+    constructor(client, streamPosition, options) {
+        super({
+            objectMode: true,
+        });
+        /**
+         * @var {BoxClient} The client for making API calls
+         * @private
+         */
+        this._client = client;
+        /**
+         * @var {string} The latest stream position
+         * @private
+         */
+        this._streamPosition = streamPosition;
+        /**
+         * @var {?Object} The information for how to long poll
+         * @private
+         */
+        this._longPollInfo = undefined;
+        /**
+         * @var {int} The number of long poll requests we've made against one URL so far
+         * @private
+         */
+        this._longPollRetries = 0;
+        /**
+         * @var {Object.<string, boolean>} Hash of event IDs we've already pushed
+         * @private
+         */
+        this._dedupHash = {};
+        /**
+         * Rate limiting promise to ensure that events are not fetched too often,
+         * initially resolved to allow an immediate API call.
+         * @var {Promise}
+         * @private
+         */
+        this._rateLimiter = bluebird_1.Promise.resolve();
+        this._options = Object.assign({}, DEFAULT_OPTIONS, options);
+    }
+    /**
+     * Retrieve the url and params for long polling for new updates
+     * @returns {Promise} Promise for testing purposes
+     * @private
+     */
+    getLongPollInfo() {
+        if (this.destroyed) {
+            return bluebird_1.Promise.resolve(false);
+        }
+        return this._client.events
+            .getLongPollInfo()
+            .then((longPollInfo) => {
+            // On getting new long poll info, reset everything
+            this._longPollInfo = longPollInfo;
+            this._longPollRetries = 0;
+            return this.doLongPoll();
+        })
+            .catch((err /* FIXME */) => {
+            this.emit('error', err);
+            // Only retry on resolvable errors
+            if (!err.authExpired) {
+                this.retryPollInfo();
+            }
+        });
+    }
+    /**
+     * Long poll for notification of new events.	We do this rather than
+     * polling for the events directly in order to minimize the number of API
+     * calls necessary.
+     * @returns {Promise} Promise for testing pruposes
+     * @private
+     */
+    doLongPoll() {
+        if (this.destroyed) {
+            return bluebird_1.Promise.resolve(false);
+        }
+        // If we're over the max number of retries, reset
+        if (this._longPollRetries > this._longPollInfo.max_retries) {
+            return this.getLongPollInfo();
+        }
+        var url = this._longPollInfo.url, qsDelim = url.indexOf('?'), query = {};
+        // Break out the query params, otherwise the request URL gets messed up
+        if (qsDelim > 0) {
+            query = querystring_1.default.parse(url.substr(qsDelim + 1));
+            url = url.substr(0, qsDelim);
+        }
+        query.stream_position = this._streamPosition;
+        var options = {
+            qs: query,
+            timeout: this._longPollInfo.retry_timeout * 1000,
+        };
+        this._longPollRetries += 1;
+        return this._client
+            .wrapWithDefaultHandler(this._client.get)(url, options)
+            .then((data /* FIXME */) => {
+            if (this.destroyed) {
+                return false;
+            }
+            if (data.message === 'reconnect') {
+                return this.getLongPollInfo();
+            }
+            // We don't expect any messages other than reconnect and new_change, so if
+            // we get one just retry the long poll
+            if (data.message !== 'new_change') {
+                return this.doLongPoll();
+            }
+            return this.fetchEvents();
+        })
+            .catch(() => {
+            this.retryPollInfo();
+        });
+    }
+    /**
+     * Retries long-polling after a delay.
+     * Does not attempt if stream is already destroyed.
+     * @returns {void}
+     * @private
+     */
+    retryPollInfo() {
+        if (!this.destroyed) {
+            this._retryTimer = setTimeout(() => this.getLongPollInfo(), this._options.retryDelay);
+        }
+    }
+    /**
+     * Fetch the latest group of events and push them into the stream
+     * @returns {Promise} Promise for testing purposes
+     * @private
+     */
+    fetchEvents() {
+        if (this.destroyed) {
+            return bluebird_1.Promise.resolve(false);
+        }
+        var eventParams = {
+            stream_position: this._streamPosition,
+            limit: 500,
+        };
+        // Get new events after the rate limiter expires
+        return this._rateLimiter.then(() => this._client.events
+            .get(eventParams)
+            .then((events /* FIXME */) => {
+            // Reset the rate limiter
+            this._rateLimiter = bluebird_1.Promise.delay(this._options.fetchInterval);
+            // If the response wasn't what we expected, re-poll
+            if (!events.entries || !events.next_stream_position) {
+                return this.doLongPoll();
+            }
+            this._streamPosition = events.next_stream_position;
+            // De-duplicate the fetched events, since the API often returns
+            // the same events at multiple subsequent stream positions
+            var newEvents = events.entries.filter((event /* FIXME */) => !this._dedupHash[event.event_id]);
+            // If there aren't any non-duplicate events, go back to polling
+            if (newEvents.length === 0) {
+                return this.doLongPoll();
+            }
+            // Pause the stream to avoid race conditions while pushing in the new events.
+            // Without this, _read() would be called again from inside each push(),
+            // resulting in multiple parallel calls to fetchEvents().
+            // See https://github.com/nodejs/node/issues/3203
+            var wasPaused = this.isPaused();
+            this.pause();
+            // Push new events into the stream
+            newEvents.forEach((event /* FIXME */) => {
+                this._dedupHash[event.event_id] = true;
+                this.push(event);
+            });
+            if (!wasPaused) {
+                // This will deliver the events and trigger the next call to _read() once they have been consumed.
+                this.resume();
+            }
+            // Once the deduplication filter gets too big, clean it up
+            if (Object.keys(this._dedupHash).length >=
+                this._options.deduplicationFilterSize) {
+                this.cleanupDedupFilter(events.entries);
+            }
+            return true;
+        })
+            .catch((err /* FIXME */) => {
+            this.emit('error', err);
+            this.retryPollInfo();
+        }));
+    }
+    /**
+     * Clean up the deduplication filter, to prevent it from growing
+     * too big and eating up memory.	We look at the latest set of events
+     * returned and assume that any IDs not in that set don't need to be
+     * tracked for deduplication any more.
+     * @param {Object[]} latestEvents The latest events from the API
+     * @returns {void}
+     * @private
+     */
+    cleanupDedupFilter(latestEvents /* FIXME */) {
+        var dedupIDs = Object.keys(this._dedupHash);
+        dedupIDs.forEach((eventID) => {
+            var isEventCleared = !latestEvents.find((e /* FIXME */) => e.event_id === eventID);
+            if (isEventCleared) {
+                delete this._dedupHash[eventID];
+            }
+        });
+    }
+    /**
+     * 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() {
+        // Start the process of getting new events
+        this.getLongPollInfo();
+    }
+    /**
+     * Implementation of stream-internal `_destroy` function (v8.0.0 and later).
+     * Called by stream consumers to effectively stop polling via the public
+     * `destroy()`.
+     * @returns {void}
+     * @private
+     */
+    _destroy() {
+        clearTimeout(this._retryTimer);
+        delete this._retryTimer;
+    }
+}
+// backwards-compat for Node.js pre-v8.0.0
+/* istanbul ignore if */
+if (typeof stream_1.Readable.prototype.destroy !== 'function') {
+    /**
+     * Destroys the stream.  Rough polyfill for `Readable#destroy`.
+     * @returns {void}
+     * @public
+     */
+    EventStream.prototype.destroy = function (error) {
+        if (!this.destroyed) {
+            process.nextTick(() => {
+                this.emit('close');
+            });
+            this.destroyed = true;
+            this._destroy();
+        }
+        return this;
+    };
+}
+module.exports = EventStream;
+//# sourceMappingURL=event-stream.js.map

package/lib-esm/event-stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-stream.js","sourceRoot":"","sources":["../src/event-stream.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,uCAAmC;AACnC,8DAA6B;AAC7B,mCAAkC;AAoBlC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,eAAe,GAAY,MAAM,CAAC,MAAM,CAAC;IAC7C,uBAAuB,EAAE,IAAI;IAC7B,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,IAAI;CACpB,CAAC,CAAC;AAEH,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;GAUG;AACH,MAAM,WAAY,SAAQ,iBAAQ;IAUhC,YACE,MAAiB,EACjB,cAAsB,EACtB,OAA0B;QAE1B,KAAK,CAAC;YACJ,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH;;;WAGG;QACH,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAEtC;;;WAGG;QACH,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAE/B;;;WAGG;QACH,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAE1B;;;WAGG;QACH,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB;;;;;WAKG;QACH,IAAI,CAAC,YAAY,GAAG,kBAAO,CAAC,OAAO,EAAE,CAAC;QAEtC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,eAAe;QACb,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,kBAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;aACvB,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,YAA0B,EAAE,EAAE;YACnC,kDAAkD;YAClD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YAClC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;YAE1B,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAC3B,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAQ,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAExB,kCAAkC;YAClC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,UAAU;QACR,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,kBAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,iDAAiD;QACjD,IAAI,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,aAAc,CAAC,WAAW,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,GAAG,GAAG,IAAI,CAAC,aAAc,CAAC,GAAG,EAC/B,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAC1B,KAAK,GAAG,EAAE,CAAC;QAEb,uEAAuE;QACvE,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,KAAK,GAAG,qBAAE,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;YAC1C,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC;QAEA,KAA6B,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAEtE,IAAI,OAAO,GAAG;YACZ,EAAE,EAAE,KAAK;YACT,OAAO,EAAE,IAAI,CAAC,aAAc,CAAC,aAAa,GAAG,IAAI;SAClD,CAAC;QAEF,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO;aAChB,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC;aACtD,IAAI,CAAC,CAAC,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;YAChC,CAAC;YAED,0EAA0E;YAC1E,sCAAsC;YACtC,IAAI,IAAI,CAAC,OAAO,KAAK,YAAY,EAAE,CAAC;gBAClC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,CAAC;YAED,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,GAAG,UAAU,CAC3B,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,EAC5B,IAAI,CAAC,QAAQ,CAAC,UAAU,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,kBAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,WAAW,GAAG;YAChB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,KAAK,EAAE,GAAG;SACX,CAAC;QAEF,gDAAgD;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,OAAO,CAAC,MAAM;aAChB,GAAG,CAAC,WAAW,CAAC;aAChB,IAAI,CAAC,CAAC,MAAW,CAAC,WAAW,EAAE,EAAE;YAChC,yBAAyB;YACzB,IAAI,CAAC,YAAY,GAAG,kBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAE/D,mDAAmD;YACnD,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;gBACpD,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,CAAC;YAED,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,oBAAoB,CAAC;YAEnD,+DAA+D;YAC/D,0DAA0D;YAC1D,IAAI,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CACnC,CAAC,KAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAC7D,CAAC;YAEF,+DAA+D;YAC/D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,CAAC;YAED,6EAA6E;YAC7E,uEAAuE;YACvE,yDAAyD;YACzD,iDAAiD;YACjD,IAAI,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,EAAE,CAAC;YAEb,kCAAkC;YAClC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAU,CAAC,WAAW,EAAE,EAAE;gBAC3C,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;gBACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,kGAAkG;gBAClG,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,CAAC;YAED,0DAA0D;YAC1D,IACE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM;gBACnC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EACrC,CAAC;gBACD,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAQ,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAExB,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAAC,YAAiB,CAAC,WAAW;QAC9C,IAAI,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE5C,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,IAAI,cAAc,GAAG,CAAC,YAAY,CAAC,IAAI,CACrC,CAAC,CAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAC/C,CAAC;YACF,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,0CAA0C;QAC1C,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,QAAQ;QACN,YAAY,CAAC,IAAI,CAAC,WAAqB,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAED,0CAA0C;AAC1C,wBAAwB;AACxB,IAAI,OAAO,iBAAQ,CAAC,SAAS,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;IACrD;;;;OAIG;IACH,WAAW,CAAC,SAAS,CAAC,OAAO,GAAG,UAAU,KAAyB;QACjE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AAED,iBAAS,WAAW,CAAC"}

package/lib-esm/managers/ai.generated.d.ts

@@ -0,0 +1,58 @@
+import BoxClient from '../box-client';
+import * as schemas from '../schemas';
+/**
+ */
+declare class AIManager {
+    client: BoxClient;
+    /**
+     * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+     */
+    constructor(client: BoxClient);
+    /**
+     * Send AI question request
+     *
+     * Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
+     * @param {schemas.AiAsk} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiResponseFull>} A promise resolving to the result or rejecting with an error
+     */
+    ask(body: schemas.AiAsk, options?: {}, callback?: Function): Promise<schemas.AiResponseFull>;
+    /**
+     * Send AI request to generate text
+     *
+     * Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
+     * @param {schemas.AiTextGen} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
+     */
+    textGen(body: schemas.AiTextGen, options?: {}, callback?: Function): Promise<schemas.AiResponse>;
+    /**
+     * Get AI agent default configuration
+     *
+     * Get the AI agent default config
+     * @param {object} options Options for the request
+     * @param {"ask" | "text_gen"} options.mode The mode to filter the agent config to return.
+     * @param {string} [options.language] The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.
+     * @param {string} [options.model] The model to return the default agent config for.
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>} A promise resolving to the result or rejecting with an error
+     */
+    getAiAgentDefaultConfig(options: {
+        /**
+         * The mode to filter the agent config to return.
+         */
+        readonly mode: 'ask' | 'text_gen';
+        /**
+         * The ISO language code to return the agent config for.
+         * If the language is not supported the default agent config is returned.
+         */
+        readonly language?: string;
+        /**
+         * The model to return the default agent config for.
+         */
+        readonly model?: string;
+    }, callback?: Function): Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>;
+}
+export = AIManager;