box-node-sdk 1.32.0 → 1.34.2

package/CHANGELOG.md

@@ -1,9 +1,27 @@
 # Changelog
 
-## 1.32.0 [2020-03-30]
+## 1.34.2 [2020-08-20]
 
-- Temporarily removed Node 4 and Node 5 builds from Travis, due to tests not passing.  Will investigate, going forward.
-- Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call ([#476](https://github.com/box/box-node-sdk/pull/76)).
+- Make iterator bug fix for uploading files non breaking ([#534](https://github.com/box/box-node-sdk/pull/534))
+
+## 1.34.1 [2020-08-17]
+
+- Fix iterator bug for uploading new file versions ([#531](https://github.com/box/box-node-sdk/pull/531))
+
+## 1.34.0 [2020-08-04]
+
+- Add zip functionality ([#525](https://github.com/box/box-node-sdk/pull/525))
+- Add proxy support for `http`, `https`, `socks` and `pac` protocols ([#529](https://github.com/box/box-node-sdk/pull/529))
+
+## 1.33.0 [2020-06-25]
+
+- Add path parameter sanitization ([#505](https://github.com/box/box-node-sdk/pull/505))
+- Add support for all streams for uploading files ([#519](https://github.com/box/box-node-sdk/pull/519))
+
+## 1.32.0 [2020-04-01]
+
+- Temporarily removed Node 4 and Node 5 builds from Travis, due to tests not passing.  Will investigate, going forward ([#495](https://github.com/box/box-node-sdk/pull/495)).
+- Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call  ([#477](https://github.com/box/box-node-sdk/pull/477)).
 - Added the ability to [query](./docs/metadata.md#query) Box items based on their metadata ([#487](https://github.com/box/box-node-sdk/pull/487)).
 
 ## 1.31.0 [2020-02-13]

package/lib/managers/files.js

@@ -44,7 +44,8 @@ var urlPath = require('../util/url-path'),
 var BASE_PATH = '/files',
 	VERSIONS_SUBRESOURCE = '/versions',
 	WATERMARK_SUBRESOURCE = '/watermark',
-	UPLOAD_SESSION_SUBRESOURCE = '/upload_sessions';
+	UPLOAD_SESSION_SUBRESOURCE = '/upload_sessions',
+	ZIP_DOWNLOAD_PATH = '/zip_downloads';
 
 // Enum of valid lock types
 var lockTypes = {
@@ -78,10 +79,11 @@ function createFileMetadataFormData(parentFolderID, filename, options) {
 /**
  * Returns the multipart form value for file upload content.
  * @param {string|Buffer|Stream} content - the content of the file being uploaded
+ * @param {Object} options - options for the content
  * @returns {Object} - the form value expected by the API for the 'content' key
  * @private
  */
-function createFileContentFormData(content) {
+function createFileContentFormData(content, options) {
 	// The upload API appears to look for a form field that contains a filename
 	// property and assume that this form field contains the file content. Thus,
 	// the value of name does not actually matter (as long as it does not conflict
@@ -90,7 +92,7 @@ function createFileContentFormData(content) {
 	// filename specified in the metadata form field instead.
 	return {
 		value: content,
-		options: { filename: 'unused' }
+		options: Object.assign({ filename: 'unused' }, options)
 	};
 }
 
@@ -601,6 +603,7 @@ Files.prototype.promoteVersion = function(fileID, versionID, callback) {
  * @param {Object} [options] - Optional parameters
  * @param {string} [options.content_created_at] - RFC 3339 timestamp when the file was created
  * @param {string} [options.content_modified_at] - RFC 3339 timestamp when the file was last modified
+ * @param {int} [options.content_length] - Optional length of the content. Required if content is a read stream of any type other than fs stream.
  * @param {Function} [callback] - called with data about the upload if successful, or an error if the
  * upload failed
  * @returns {Promise<Object>} A promise resolving to the uploaded file
@@ -613,10 +616,17 @@ Files.prototype.uploadFile = function(parentFolderID, filename, content, options
 		options = {};
 	}
 
+	var formOptions = {};
+	if (options && options.hasOwnProperty('content_length')) {
+		formOptions.knownLength = options.content_length;
+		// Delete content_length from options so it's not added to the attributes of the form
+		delete options.content_length;
+	}
+
 	var apiPath = urlPath(BASE_PATH, '/content'),
 		multipartFormData = {
 			attributes: createFileMetadataFormData(parentFolderID, filename, options),
-			content: createFileContentFormData(content)
+			content: createFileContentFormData(content, formOptions)
 		};
 
 	return this.client.wrapWithDefaultHandler(this.client.upload)(apiPath, null, multipartFormData, callback);
@@ -635,6 +645,7 @@ Files.prototype.uploadFile = function(parentFolderID, filename, content, options
  * @param {Object} [options] - Optional parameters
  * @param {string} [options.content_modified_at] - RFC 3339 timestamp when the file was last modified
  * @param {string} [options.name] - A new name for the file
+ * @param {int} [options.content_length] - Optional length of the content. Required if content is a read stream of any type other than fs stream.
  * @param {Function} [callback] - called with data about the upload if successful, or an error if the
  * upload failed
  * @returns {Promise<Object>} A promise resolving to the uploaded file
@@ -650,11 +661,18 @@ Files.prototype.uploadNewFileVersion = function(fileID, content, options, callba
 	var apiPath = urlPath(BASE_PATH, fileID, '/content'),
 		multipartFormData = {};
 
+
+	var formOptions = {};
 	if (options) {
+		if (options.hasOwnProperty('content_length')) {
+			formOptions.knownLength = options.content_length;
+			// Delete content_length from options so it's not added to the attributes of the form
+			delete options.content_length;
+		}
 		multipartFormData.attributes = JSON.stringify(options);
 	}
 
-	multipartFormData.content = createFileContentFormData(content);
+	multipartFormData.content = createFileContentFormData(content, formOptions);
 
 	return this.client.wrapWithDefaultHandler(this.client.upload)(apiPath, null, multipartFormData, callback);
 };
@@ -1574,6 +1592,67 @@ Files.prototype.getRepresentationContent = function(fileID, representationType,
 		.asCallback(callback);
 };
 
+/**
+ * Creates a zip of multiple files and folders.
+ *
+ * API Endpoint: '/zip_downloads'
+ * Method: POST
+ *
+ * @param {name} name - The name of the zip file to be created
+ * @param {Array} items - Array of files or folders to be part of the created zip
+ * @param {Function} [callback] Passed a stream over the representation contents if successful
+ * @returns {Promise<string>} A promise resolving to the file's download URL
+ */
+Files.prototype.createZip = function(name, items, callback) {
+	var params = {
+		body: {
+			download_file_name: name,
+			items
+		}
+	};
+
+	return this.client.wrapWithDefaultHandler(this.client.post)(ZIP_DOWNLOAD_PATH, params, callback);
+};
+
+/**
+ * Creates a zip of multiple files and folders and downloads it.
+ *
+ * API Endpoint: '/zip_downloads'
+ * Method: GET
+ *
+ * @param {name} name - The name of the zip file to be created
+ * @param {Array} items - Array of files or folders to be part of the created zip
+ * @param {Stream} stream - Stream to pipe the readable stream of the zip file
+ * @param {Function} [callback] - Passed a status response object
+ * @returns {Promise<Readable>} A promise resolving for the file stream
+ */
+Files.prototype.downloadZip = function(name, items, stream, callback) {
+	var downloadStreamOptions = {
+		streaming: true,
+		headers: {}
+	};
+
+	var params = {
+		body: {
+			download_file_name: name,
+			items
+		}
+	};
+
+	return this.client.post(ZIP_DOWNLOAD_PATH, params)
+		.then(response => this.client.get(response.body.download_url, downloadStreamOptions)
+			.then(responseStream => {
+				responseStream.pipe(stream);
+				// eslint-disable-next-line promise/avoid-new
+				return new Promise((resolve, reject) => {
+					responseStream.on('end', () => resolve('Done downloading'));
+					responseStream.on('error', error => reject(error));
+				}).then(() => this.client.get(response.body.status_url).then(responseStatus => responseStatus.body));
+			})
+		)
+		.asCallback(callback);
+};
+
 /**
  * @module box-node-sdk/lib/managers/files
  * @see {@Link Files}

package/lib/managers/metadata.js

@@ -325,7 +325,12 @@ Metadata.prototype = {
 	 *
 	 * @param {string} from - The template used in the query. Must be in the form scope.templateKey
 	 * @param {string} ancestorFolderId - The folder_id to which to restrain the query
-	 * @param {Object} options - Query options
+	 * @param {Object} options - Optional parameters
+	 * @param {string} [options.query] - The logical expression of the query
+	 * @param {Object} [options.query_parameters] - Required if query present. The arguments for the query
+	 * @param {string} [options.index_name] - The name of the Index to use
+	 * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s)
+	 * @param {Array} [options.fields] - An array of fields to return
 	 * @param {Function} [callback] - Passed a collection of items and their associated metadata
 	 * @returns {Promise<void>} Promise resolving to a collection of items and their associated metadata
 	 */

package/lib/util/config.js

@@ -10,7 +10,9 @@
 var assert = require('assert'),
 	https = require('https'),
 	merge = require('merge-options'),
-	sdkVersion = require('../../package.json').version;
+	sdkVersion = require('../../package.json').version,
+	ProxyAgent = require('proxy-agent'),
+	url = require('url');
 
 // ------------------------------------------------------------------------------
 // Private
@@ -64,6 +66,11 @@ var defaults = {
 	iterators: false,
 	enterpriseID: undefined,
 	analyticsClient: null,
+	proxy: {
+		url: null,
+		username: null,
+		password: null,
+	},
 	request: {
 		// By default, require API SSL cert to be valid
 		strictSSL: true,
@@ -130,6 +137,22 @@ function validateAppAuthParams(appAuth) {
 	}
 }
 
+/**
+ * Update the agentClass based on the proxy config values passed in by the user
+ * @param {UserConfigurationOptions} params The current Config values
+ * @returns {void}
+ * @private
+ */
+function updateRequestAgent(params) {
+	if (params.proxy.url) {
+		params.request.agentClass = ProxyAgent;
+		params.request.agentOptions = Object.assign({}, params.request.agentOptions, url.parse(params.proxy.url));
+		if (params.proxy.username && params.proxy.password) {
+			Object.assign(params.request.agentOptions, {auth: `${params.proxy.username}:${params.proxy.password}`});
+		}
+	}
+}
+
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
@@ -157,8 +180,8 @@ function Config(params) {
 
 	// Set the given params or default value if params property is missing
 	this._params = merge(defaults, params);
+	updateRequestAgent(this._params);
 	Object.assign(this, this._params);
-
 	// Freeze the object so that configuration options cannot be modified
 	Object.freeze(this);
 }

package/lib/util/paging-iterator.js

@@ -58,7 +58,11 @@ class PagingIterator {
 	 * @returns {boolean} Whether the response is iterable
 	 */
 	static isIterable(response) {
-		var isGetOrPostRequest = (response.request && (response.request.method === 'GET' || response.request.method === 'POST')),
+		// POST responses for uploading a file are explicitly excluded here because, while the response is iterable,
+		// it always contains only a single entry and historically has not been handled as iterable in the SDK.
+		// This behavior is being preserved here to avoid a breaking change.
+		let UPLOAD_PATTERN = /.*upload\.box\.com.*\/content/;
+		var isGetOrPostRequest = (response.request && (response.request.method === 'GET' || (response.request.method === 'POST' && !UPLOAD_PATTERN.test(response.request.uri.href)))),
 			hasEntries = (response.body && Array.isArray(response.body.entries)),
 			notEventStream = (response.body && !response.body.next_stream_position);
 
@@ -160,6 +164,9 @@ class PagingIterator {
 		if (response.request.method === 'GET') {
 			this.options.qs[this.nextField] = this.nextValue;
 		} else if (response.request.method === 'POST') {
+			if (!this.options.body) {
+				this.options.body = {};
+			}
 			this.options.body[this.nextField] = this.nextValue;
 			let bodyString = JSON.stringify(this.options.body);
 			this.options.headers['content-length'] = bodyString.length;

package/lib/util/url-path.js

@@ -8,6 +8,8 @@
 // Private
 // ------------------------------------------------------------------------------
 
+// Pattern to check for relative paths
+var PATTERN = /\/\.+/;
 /**
  * remove leading & trailing slashes from some string. This is useful for
  * removing slashes from the path segments that are actually a part of the
@@ -39,7 +41,14 @@ function trimSlashes(segment) {
  */
 module.exports = function urlPath(/* arguments*/) {
 	var args = Array.prototype.slice.call(arguments);
-	var path = args.map(x => String(x)).map(x => trimSlashes(x))
+	var path = args.map(x => String(x))
+		.map(x => {
+			var trimmedX = trimSlashes(x);
+			if (PATTERN.test(trimmedX)) {
+				throw new Error(`An invalid path parameter exists in ${trimmedX}. Relative path parameters cannot be passed.`);
+			}
+			return trimmedX;
+		})
 		.map(x => encodeURIComponent(x))
 		.join('/');
 	return `/${path}`;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box <oss@box.com>",
-  "version": "1.32.0",
+  "version": "1.34.2",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {
@@ -36,8 +36,8 @@
     "http-status": "^1.4.1",
     "jsonwebtoken": "^8.5.1",
     "merge-options": "^1.0.1",
-    "npm-upgrade": "^2.0.2",
     "promise-queue": "^2.2.3",
+    "proxy-agent": "^3.1.1",
     "request": "^2.88.0",
     "url-template": "^2.0.8",
     "uuid": "^3.3.3"
@@ -57,6 +57,7 @@
     "mockery": "^2.1.0",
     "nock": "^9.6.1",
     "np": "^5.1.3",
+    "npm-upgrade": "^2.0.3",
     "nyc": "^11.9.0",
     "shelljs": "^0.8.3",
     "shelljs-nodecli": "^0.1.1",