box-node-sdk 1.35.0 → 1.37.2

package/lib/chunked-uploader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunked-uploader.js","sourceRoot":"","sources":["../src/chunked-uploader.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;AAEH,qCAAmC;AAoEnC,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,iCAAsC;AACtC,iCAAoD;AACpD,kDAA4B;AAG5B,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,IAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,WAAW,EAAE,CAAC;IACd,aAAa,EAAE,IAAI;CACnB,CAAC,CAAC;AAEH;;;;GAIG;AACH;IAAoB,yBAAY;IAY/B;;;;;;;;;OASG;IACH,eACC,MAAiB,EACjB,SAAiB,EACjB,KAAsB,EACtB,MAAc,EACd,SAAiB,EACjB,OAA+B;QANhC,YAQC,iBAAO,SAYP;QAVA,KAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,KAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,KAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,KAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,KAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,KAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,KAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,KAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,KAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;;IACvB,CAAC;IAED;;;OAGG;IACH,uBAAO,GAAP;QACC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,sBAAM,GAAN;QAAA,iBAiCC;QAhCA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAC3B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,UAAC,GAAQ,CAAC,WAAW,EAAE,IAAS,CAAC,WAAW;YAC3C,IAAI,KAAI,CAAC,QAAQ,EAAE;gBAClB,KAAI,CAAC,KAAK,GAAG,IAAI,CAAC;gBAClB,OAAO;aACP;YAED,IAAI,GAAG,EAAE;gBACR,4BAA4B;gBAC5B,IAAI,GAAG,CAAC,UAAU,EAAE;oBACnB,wCAAwC;oBACxC,KAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;iBACxB;qBAAM;oBACN,+BAA+B;oBAC/B,KAAI,CAAC,KAAK,GAAG,UAAU,CACtB,cAAM,OAAA,KAAI,CAAC,MAAM,EAAE,EAAb,CAAa,EACnB,KAAI,CAAC,OAAO,CAAC,aAAa,CAC1B,CAAC;iBACF;gBACD,OAAO;aACP;YAED,wEAAwE;YACxE,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,KAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,KAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7B,CAAC,CACD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,sBAAM,GAAN;QACC,YAAY,CAAC,IAAI,CAAC,KAAY,CAAC,CAAC,CAAC,2BAA2B;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACtB,CAAC;IACF,YAAC;AAAD,CAAC,AAvGD,CAAoB,qBAAY,GAuG/B;AAED,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF,6CAA6C;AAC7C;IAA8B,mCAAY;IAmBzC;;;;;;;;;;OAUG;IACH,yBACC,MAAiB,EACjB,iBAAoC,EACpC,IAAsC,EACtC,IAAY,EACZ,OAAgC;QALjC,YAOC,iBAAO,SA6BP;QA3BA,KAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,KAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACvC,KAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC;QAC7C,KAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAE5C,IAAI,IAAI,YAAY,iBAAc,EAAE;YACnC,0DAA0D;YAC1D,KAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAC5B,KAAI,CAAC,aAAa,GAAG,EAAE,CAAC;SACxB;aAAM,IAAI,IAAI,YAAY,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC9D,KAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SAClB;aAAM;YACN,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;SACjE;QAED,KAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,KAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,EAAE,EACF,eAAe,EACf,OAAO,CAC6B,CAAC;QAEtC,KAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,KAAI,CAAC,kBAAkB,GAAG,CAAC,CAAC;QAC5B,KAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,KAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,KAAI,CAAC,SAAS,GAAG,gBAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;;IAC5C,CAAC;IAED;;;OAGG;IACH,+BAAK,GAAL;QAAA,iBAqBC;QApBA,IAAI,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;SACrB;QAED,4BAA4B;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,UAAC,KAAU,CAAC,WAAW;gBACzC,OAAA,KAAK,CAAC,CAAC,CAAC,KAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAI,CAAC,OAAO,EAAE;YAAjD,CAAiD,CACjD,CAAC;SACF;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,sCAAsC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAO,CAAC,UAAC,OAAO,EAAE,MAAM;YAC3C,KAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;YACxB,KAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,qCAAqC;QAErC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACH,+BAAK,GAAL;QAAA,iBAmBC;QAlBA,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAnC,CAAmC,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,CACN,IAAI,CAAC,OAAO,CAAC,KAAK;aAChB,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpC,0CAA0C;aACzC,IAAI,CAAC;YACL,KAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtB,CAAC,CAAC;YACF,yCAAyC;aACxC,KAAK,CAAC,UAAC,GAAQ,CAAC,WAAW;YAC3B,KAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAC9B,MAAM,GAAG,CAAC;QACX,CAAC,CAAC,CACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,uCAAa,GAAb,UAAc,QAAkB;QAAhC,iBAyCC;QAxCA,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE;YACjC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACf,OAAO;SACP;QAED,IAAI,GAAG,CAAC;QAER,IAAI,IAAI,CAAC,KAAK,EAAE;YACf,iDAAiD;YACjD,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;SACxE;aAAM,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACzC,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;SACjC;aAAM;YACN,4BAA4B;YAC5B,GAAG,GAAI,IAAI,CAAC,OAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAE5D,IAAI,CAAC,GAAG,EAAE;gBACT,yCAAyC;gBACzC,YAAY,CAAC,cAAM,OAAA,KAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAA5B,CAA4B,CAAC,CAAC;gBACjD,OAAO;aACP;iBAAM,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE;gBACvC,8EAA8E;gBAC9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE;oBACpD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC1D;gBACD,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;aACjC;SACD;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,KAAK,GAAG,IAAI,KAAK,CACpB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,UAAU,EACf,GAAG,EACH,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,QAAQ,CACb,CAAC;QACF,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,MAAM,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,sCAAY,GAAZ,UAAa,KAAU,CAAC,WAAW;QAAnC,iBAcC;QAbA,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC;QAE7B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,GAAQ,CAAC,WAAW,IAAK,OAAA,KAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,EAA5B,CAA4B,CAAC,CAAC;QAC1E,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE,UAAC,IAAS,CAAC,WAAW;YAC1C,KAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC;YAE7B,KAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACjC,KAAI,CAAC,aAAa,CAAC,UAAC,SAAc,CAAC,WAAW;gBAC7C,OAAA,SAAS,CAAC,CAAC,CAAC,KAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAI,CAAC,OAAO,EAAE;YAAzD,CAAyD,CACzD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,iCAAO,GAAP;QAAA,iBA+BC;QA9BA,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,kBAAkB,GAAG,CAAC,EAAE;YACpD,OAAO;SACP;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,CAC1B;YACC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,OAAO,EAAE,EAAX,CAAW,CAAC;SAC3C,EACD,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC5B,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,UACtE,GAAQ,CAAC,WAAW,EACpB,IAAS,CAAC,WAAW;YAErB,wFAAwF;YACxF,kCAAkC;YAClC,IAAI,GAAG,EAAE;gBACR,KAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBAClB,aAAa,EAAE,KAAI,CAAC,kBAAkB;oBACtC,KAAK,EAAE,GAAG;iBACV,CAAC,CAAC;gBACH,KAAI,CAAC,OAAQ,CAAC,GAAG,CAAC,CAAC;gBACnB,OAAO;aACP;YAED,KAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YAClC,KAAI,CAAC,QAAS,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACJ,CAAC;IACF,sBAAC;AAAD,CAAC,AA1OD,CAA8B,qBAAY,GA0OzC;AAED,iBAAS,eAAe,CAAC"}

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

@@ -0,0 +1,82 @@
+/**
+ * @fileoverview Enterprise event stream backed by the enterprise events API
+ */
+/// <reference types="node" />
+import { Readable } from 'stream';
+import BoxClient from './box-client';
+declare type Options = {
+    streamPosition?: string;
+    startDate?: string;
+    endDate?: string;
+    eventTypeFilter?: EventType[];
+    pollingInterval?: number;
+    chunkSize?: number;
+};
+declare 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;

package/lib/enterprise-event-stream.js

@@ -1,28 +1,36 @@
+"use strict";
 /**
  * @fileoverview Enterprise event stream backed by the enterprise events API
  */
-
-'use strict';
-
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-
-const Readable = require('stream').Readable,
-	util = require('util');
-
+var stream_1 = require("stream");
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
-
-const DEFAULT_OPTIONS = Object.freeze({
-	pollingInterval: 60,	// seconds
-	chunkSize: 500
-
-});// ------------------------------------------------------------------------------
+var DEFAULT_OPTIONS = Object.freeze({
+    pollingInterval: 60,
+    chunkSize: 500,
+});
+// ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * Stream of Box enterprise events.
  *
@@ -43,193 +51,171 @@ const DEFAULT_OPTIONS = Object.freeze({
  * @constructor
  * @extends Readable
  */
-function EnterpriseEventStream(client, options) {
-
-	Readable.call(this, {
-		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.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;
-}
-
-util.inherits(EnterpriseEventStream, Readable);
-
-/**
- * @returns {?string} - Returns null if no events have been fetched from Box yet.
- */
-EnterpriseEventStream.prototype.getStreamPosition = function() {
-	return this._streamPosition;
-};
-
-/**
- * Get the stream state.
- *
- * @returns {Object} - The stream state
- */
-EnterpriseEventStream.prototype.getStreamState = function() {
-	// 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}
- */
-EnterpriseEventStream.prototype.setStreamState = function(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
- */
-EnterpriseEventStream.prototype.fetchEvents = function(callback) {
-	const self = this,
-		params = {
-			stream_type: 'admin_logs'
-		};
-
-	// 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.startDate) {
-		params.created_after = this._options.startDate;
-	}
-
-	if (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, result) => {
-		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
- */
-EnterpriseEventStream.prototype._read = function() {
-	// Fetch the next chunk of events.
-	const self = this;
-
-	// This will poll forever until events are available.
-	this.fetchEvents((err, events) => {
-		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 => {
-			self.push(event);
-		});
-
-		if (!wasPaused) {
-			// This will deliver the events and trigger the next call to _read() once they have been consumed.
-			self.resume();
-		}
-	});
-};
-
+var EnterpriseEventStream = /** @class */ (function (_super) {
+    __extends(EnterpriseEventStream, _super);
+    function EnterpriseEventStream(client, options) {
+        var _this = _super.call(this, {
+            objectMode: true,
+        }) || this;
+        /**
+         * @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.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;
+        return _this;
+    }
+    /**
+     * @returns {?number} - Returns null if no events have been fetched from Box yet.
+     */
+    EnterpriseEventStream.prototype.getStreamPosition = function () {
+        return this._streamPosition;
+    };
+    /**
+     * Get the stream state.
+     *
+     * @returns {Object} - The stream state
+     */
+    EnterpriseEventStream.prototype.getStreamState = function () {
+        // 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}
+     */
+    EnterpriseEventStream.prototype.setStreamState = function (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
+     */
+    EnterpriseEventStream.prototype.fetchEvents = function (callback) {
+        var self = this, params = {
+            stream_type: 'admin_logs',
+        };
+        // 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.startDate) {
+            params.created_after = this._options.startDate;
+        }
+        if (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, function (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.
+                var delay = self._options.pollingInterval * 1000;
+                // Stream readers can use this to flush buffered events to a downstream system.
+                self.emit('wait', delay);
+                setTimeout(function () {
+                    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
+     */
+    EnterpriseEventStream.prototype._read = function () {
+        // Fetch the next chunk of events.
+        var self = this;
+        // This will poll forever until events are available.
+        this.fetchEvents(function (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
+            var wasPaused = self.isPaused();
+            self.pause();
+            // Push all of the events into the stream.
+            events.forEach(function (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();
+            }
+        });
+    };
+    return EnterpriseEventStream;
+}(stream_1.Readable));
 module.exports = EnterpriseEventStream;
+//# sourceMappingURL=enterprise-event-stream.js.map

package/lib/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,iCAAkC;AAkBlC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,eAAe,EAAE,EAAE;IACnB,SAAS,EAAE,GAAG;CACd,CAAC,CAAC;AAEH,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;;;;;;;;GAmBG;AACH;IAAoC,yCAAQ;IAK3C,+BAAY,MAAiB,EAAE,OAAiB;QAAhD,YACC,kBAAM;YACL,UAAU,EAAE,IAAI;SAChB,CAAC,SA+BF;QA7BA;;;WAGG;QACH,KAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB;;;WAGG;QACH,KAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAE5D,8FAA8F;QAC9F,IACC,CAAC,KAAI,CAAC,QAAQ,CAAC,SAAS;YACxB,CAAC,KAAI,CAAC,QAAQ,CAAC,cAAc;YAC5B,KAAI,CAAC,QAAQ,CAAC,cAAsB,KAAK,CAAC,EAC1C;YACD,qFAAqF;YACrF,KAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE;iBAClC,WAAW,EAAE;iBACb,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SAC/B;QAED;;;WAGG;QACH,KAAI,CAAC,eAAe,GAAG,KAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;;IACrD,CAAC;IAED;;OAEG;IACH,iDAAiB,GAAjB;QACC,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,8CAAc,GAAd;QACC,+FAA+F;QAC/F,gDAAgD;QAChD,OAAO;YACN,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;SAC9C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,8CAAc,GAAd,UACC,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;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,2CAAW,GAAX,UAAY,QAAkB;QAC7B,IAAM,IAAI,GAAG,IAAI,EAChB,MAAM,GAOF;YACH,WAAW,EAAE,YAAY;SACzB,CAAC;QAEH,mCAAmC;QACnC,kGAAkG;QAClG,IAAI,IAAI,CAAC,eAAe,IAAK,IAAI,CAAC,eAAuB,KAAK,CAAC,EAAE;YAChE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;SAC9C;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;SAC/C;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YAC1B,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;SAC9C;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;YAClC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC5D;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;SACvC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,UAC/B,GAAQ,CAAC,WAAW,EACpB,MAAW,CAAC,WAAW;YAEvB,IAAI,GAAG,EAAE;gBACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBACxB,6EAA6E;gBAC7E,uDAAuD;gBACvD,uGAAuG;gBACvG,iDAAiD;gBACjD,6DAA6D;aAC7D;YAED,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;oBACnC,0CAA0C;oBAC1C,QAAQ,EAAE,CAAC;oBACX,OAAO;iBACP;gBAED,kFAAkF;gBAClF,IAAM,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;oBACV,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC5B,CAAC,EAAE,KAAK,CAAC,CAAC;gBACV,OAAO;aACP;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;QAChC,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,qCAAK,GAAL;QACC,kCAAkC;QAClC,IAAM,IAAI,GAAG,IAAI,CAAC;QAElB,qDAAqD;QACrD,IAAI,CAAC,WAAW,CAAC,UAAC,GAAQ,CAAC,WAAW,EAAE,MAAW,CAAC,WAAW;YAC9D,IAAI,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1C,2FAA2F;gBAC3F,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChB,OAAO;aACP;YAED,6EAA6E;YAC7E,uEAAuE;YACvE,yDAAyD;YACzD,iDAAiD;YACjD,IAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,EAAE,CAAC;YAEb,0CAA0C;YAC1C,MAAM,CAAC,OAAO,CAAC,UAAC,KAAU,CAAC,WAAW;gBACrC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,EAAE;gBACf,kGAAkG;gBAClG,IAAI,CAAC,MAAM,EAAE,CAAC;aACd;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IACF,4BAAC;AAAD,CAAC,AAlND,CAAoC,iBAAQ,GAkN3C;AAED,iBAAS,qBAAqB,CAAC"}

package/lib/event-stream.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @fileoverview Event stream backed by the events API
+ */
+/// <reference types="node" />
+import { Readable } from 'stream';
+import BoxClient from './box-client';
+declare type Options = {
+    retryDelay: number;
+    deduplicationFilterSize: number;
+    fetchInterval: number;
+};
+declare 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;