box-node-sdk 1.36.0 → 1.38.0

package/lib/box-node-sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"box-node-sdk.js","sourceRoot":"","sources":["../src/box-node-sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,iCAAsC;AACtC,8CAAkC;AAClC,kEAAqE;AACrE,yDAA4D;AAC5D,wCAA2C;AAC3C,8CAAiD;AAEjD,IAAI,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,EACpC,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,EACrD,oBAAoB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAC/D,cAAc,GAAG,OAAO,CAAC,6BAA6B,CAAC,EACvD,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAuC3C,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACH;IAAyB,8BAAY;IA2BpC,oBAAY,MAAgC;QAA5C,YACC,iBAAO,SAeP;QAbA,IAAI,QAAQ,GAAG,IAAI,qBAAY,EAAE,CAAC;QAElC,IAAI,IAAI,GAAG,KAAI,CAAC;QAChB,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE;YACvB,IAAI,IAAI,GAAoB,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,KAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,KAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,KAAI,CAAC,MAAM,EAAE,CAAC;;IACf,CAAC;IAED;;;;;;OAMG;IACH,2BAAM,GAAN;QACC,kCAAkC;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACvE,IAAI,CAAC,gBAAgB,GAAG,IAAI,mBAAmB,CAC9C,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,mCAAwB,GAA/B,UAAgC,SAAc,CAAC,WAAW;QACzD,IAAI,OAAO,SAAS,CAAC,cAAc,KAAK,QAAQ,EAAE;YACjD,MAAM,IAAI,SAAS,CAClB,uDAAuD,CACvD,CAAC;SACF;QAED,IAAI,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;QAC9C,IAAI,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YACjC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SACtE;QAED,IAAI,MAAM,GASN,EAAE,CAAC;QAEP,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChD,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SAC1C;QAED,IAAI,OAAO,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE;YACpD,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;SAClD;QAED,2DAA2D;QAC3D,wFAAwF;QACxF,IACC,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ;YAC1C,cAAc,CAAC,OAAO,CAAC,WAAW,EACjC;YACD,MAAM,CAAC,OAAO,GAAG;gBAChB,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW;gBACzC,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,UAAU;aAC7C,CAAC;YAEF,IAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC;YACrD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBACnC,MAAM,CAAC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;aACvC;SACD;QAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,QAAQ,EAAE;YAC/C,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;SAC7C;QAED,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,8BAAS,GAAT,UAAU,MAAgC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,mCAAc,GAAd,UAAe,WAAmB;QACjC,IAAI,UAAU,GAAG,IAAI,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACrE,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACI,yBAAc,GAArB,UAAsB,WAAmB;QACxC,OAAO,IAAI,UAAU,CAAC;YACrB,QAAQ,EAAE,EAAE;YACZ,YAAY,EAAE,EAAE;SAChB,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,wCAAmB,GAAnB,UAAoB,SAAc,CAAC,WAAW,EAAE,UAAuB;QACtE,IAAI,UAAU,GAAG,IAAI,oBAAoB,CACxC,SAAS,EACT,UAAU,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,CACjB,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,uCAAkB,GAAlB;QACC,OAAO,IAAI,SAAS,CACnB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,CACnB,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,qCAAgB,GAAhB,UAAiB,IAAY,EAAE,EAAW,EAAE,UAAuB;QAClE,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aAC9B;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,IAAI,cAAc,GAAG,IAAI,cAAc,CACtC,IAAI,EACJ,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,UAAU,CACV,CAAC;QACF,OAAO,IAAI,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,oCAAe,GAAf,UAAgB,MAA8B;QAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAExC,OAAU,IAAI,CAAC,MAAM,CAAC,gBAAgB,0BAAqB,EAAE,CAAC,SAAS,CACtE,MAAM,CACJ,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,oDAA+B,GAA/B,UACC,iBAAyB,EACzB,OAAmC,EACnC,QAAkB;QAElB,OAAO,IAAI,CAAC,YAAY;aACtB,+BAA+B,CAC/B,iBAAiB,EACjB,OAAc,CAAC,WAAW,CAC1B;aACA,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,0CAAqB,GAArB,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,qBAAqB,CAAC,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,+CAA0B,GAA1B,UACC,YAAoB,EACpB,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,IAAI,CAAC,YAAY,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAC7B,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;aACxC;iBAAM;gBACN,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAc,CAAC,WAAW,CAAC;aACzE,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,qCAAgB,GAAhB,UACC,MAAc,EACd,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAc,CAAC,WAAW,CAAC;aAC7D,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,iCAAY,GAAZ,UACC,KAAa,EACb,OAA8C,EAC9C,QAAkB;QAElB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,OAAO,IAAI,CAAC,YAAY;aACtB,YAAY,CAAC,KAAK,EAAE,OAAc,CAAC,WAAW,CAAC;aAC/C,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAnWD;;;;OAIG;IACI,uBAAY,GAAG,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC;IACjD,6BAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAC7D,0BAAe,GAAG,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC;IAE9D;;;;OAIG;IACI,iCAAsB,GAAG,QAAQ,CAAC,eAAe,CAAC;IAsV1D,iBAAC;CAAA,AA/WD,CAAyB,qBAAY,GA+WpC;AAED;;;;GAIG;AACH,UAAU,CAAC,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC;AACrE,UAAU,CAAC,SAAS,CAAC,kBAAkB;IACtC,SAAS,CAAC,SAAS,CAAC,kBAAkB,CAAC;AACxC,UAAU,CAAC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC;AAG3E,iBAAS,UAAU,CAAC"}

package/lib/chunked-uploader.d.ts

@@ -0,0 +1,129 @@
+/**
+ * @fileoverview Upload manager for large file uploads
+ */
+/// <reference types="node" />
+/**
+ * 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
+ */
+declare type ChunkedUploaderOptions = {
+    retryInterval?: number;
+    parallelism?: number;
+    fileAttributes?: Record<string, any>;
+};
+declare 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;