box-node-sdk 1.34.2 → 1.37.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## Next Release
+
+**New Features and Enhancements:**
+
+- Add support for copyInstanceOnItemCopy field for metadata templates ([#572](https://github.com/box/box-node-sdk/pull/572))
+
+**Bug Fixes:**
+
+- Fix webhook signature validation ([#568](https://github.com/box/box-node-sdk/pull/568))
+- Update dependencies to patch security vulnerabilities ([#578](https://github.com/box/box-node-sdk/pull/578))
+
+## 1.36.0 (2020-01-27)
+
+**New Features and Enhancements:**
+
+- Add folder lock functionality ([#560](https://github.com/box/box-node-sdk/pull/560))
+- Add support for filtering groups by name ([#561](https://github.com/box/box-node-sdk/pull/561))
+
+**Bug Fixes:**
+
+- Update proxy-agent to patch proxy support issue ([#563](https://github.com/box/box-node-sdk/pull/563))
+- Update dependencies to patch security vulnerabilities ([#566](https://github.com/box/box-node-sdk/pull/566))
+
+## 1.35.0 (2020-11-02)
+
+**New Features and Enhancements:**
+
+- Add support for search param to get shared link items ([#547](https://github.com/box/box-node-sdk/pull/547))
+
+## 1.34.3 (2020-10-02)
+
+**Bug Fixes:**
+
+- Upgrade ajv dependency ([#545](https://github.com/box/box-node-sdk/pull/545))
+
 ## 1.34.2 [2020-08-20]
 
 - Make iterator bug fix for uploading files non breaking ([#534](https://github.com/box/box-node-sdk/pull/534))
@@ -139,11 +174,11 @@ to specify a client ID and secret (thanks to @cbetta)
 
 ## 1.16.0 [2018-04-10]
 
-- Added support for [assigning Retention Policies to Metadata Templates](https://github.com/box/box-node-sdk/blob/master/docs/retention-policies.md#assign-retention-policy)
+- Added support for [assigning Retention Policies to Metadata Templates](https://github.com/box/box-node-sdk/blob/main/docs/retention-policies.md#assign-retention-policy)
 
 ## 1.15.0 [2018-03-29]
 
-- Fixed [`client.webhooks.validateMessage() and `sdk.validateWebhookMessage()`](https://github.com/box/box-node-sdk/blob/master/docs/webhooks.md#validate-a-webhook-message)
+- Fixed [`client.webhooks.validateMessage() and `sdk.validateWebhookMessage()`](https://github.com/box/box-node-sdk/blob/main/docs/webhooks.md#validate-a-webhook-message)
 to accept the request body as an `Object`
 - Fixed `sdk.configure()` to correct reconfigure all options
 - Improved error messages for API errors and added the request object as `error.request` for easier debugging

package/README.md

@@ -184,7 +184,7 @@ client.comments.delete('456')
 
 For complete documentation about the available operations, please see
 the [SDK documentation pages](./docs) and the auto-generated
-[JSDocs](https://rawgit.com/box/box-node-sdk/master/docs/jsdoc/index.html).
+[JSDocs](https://rawgit.com/box/box-node-sdk/main/docs/jsdoc/index.html).
 These contain detailed information about which methods are available and
 how to use them.
 

package/lib/managers/files.js

@@ -1600,8 +1600,8 @@ Files.prototype.getRepresentationContent = function(fileID, representationType,
  *
  * @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
+ * @param {Function} [callback] Passed a zip information object
+ * @returns {Promise<string>} A promise resolving to a zip information object
  */
 Files.prototype.createZip = function(name, items, callback) {
 	var params = {
@@ -1623,8 +1623,8 @@ Files.prototype.createZip = function(name, items, callback) {
  * @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
+ * @param {Function} [callback] - Passed a zip download status object
+ * @returns {Promise<Readable>} A promise resolving to a zip download status object
  */
 Files.prototype.downloadZip = function(name, items, stream, callback) {
 	var downloadStreamOptions = {

package/lib/managers/folders.js

@@ -15,6 +15,7 @@ var urlPath = require('../util/url-path'),
 // Private
 // ------------------------------------------------------------------------------
 var BASE_PATH = '/folders',
+	FOLDER_LOCK = '/folder_locks',
 	WATERMARK_SUBRESOURCE = '/watermark';
 
 
@@ -577,6 +578,68 @@ Folders.prototype.removeWatermark = function(folderID, callback) {
 
 	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
 };
+
+/**
+ * Used to lock a Box folder.
+ *
+ * API Endpoint: '/folder_locks'
+ * Method: POST
+ *
+ * @param {string} folderID - The Box ID of the folder to lock
+ * @param {Function} [callback] - Passed the folder lock object if successful, error otherwise
+ * @returns {Promise<void>} A promise resolving to a folder lock object
+ */
+Folders.prototype.lock = function(folderID, callback) {
+	var params = {
+		body: {
+			folder: {
+				type: 'folder',
+				id: folderID
+			},
+			locked_operations: {
+				move: true,
+				delete: true
+			}
+		}
+	};
+	return this.client.wrapWithDefaultHandler(this.client.post)(FOLDER_LOCK, params, callback);
+};
+
+/**
+ * Used to get all locks on a folder.
+ *
+ * API Endpoint: '/folder_locks'
+ * Method: GET
+ *
+ * @param {string} folderID - The Box ID of the folder to lock
+ * @param {Function} [callback] - Passed a collection of folder lock objects if successful, error otherwise
+ * @returns {Promise<void>} A promise resolving to a collection of folder lock objects
+ */
+Folders.prototype.getLocks = function(folderID, callback) {
+	var params = {
+		qs: {
+			folder_id: folderID
+		}
+	};
+	return this.client.wrapWithDefaultHandler(this.client.get)(FOLDER_LOCK, params, callback);
+};
+
+/**
+ * Used to delete a lock on a folder.
+ *
+ * API Endpoint: '/folder_locks/:folderLockID'
+ * Method: DELETE
+ *
+ * @param {string} folderLockID - The Box ID of the folder lock
+ * @param {Function} [callback] - Empty response body passed if successful, error otherwise
+ * @returns {Promise<void>} A promise resolving to nothing
+ */
+Folders.prototype.deleteLock = function(folderLockID, callback) {
+
+	var apiPath = urlPath(FOLDER_LOCK, folderLockID);
+
+	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+};
 /**
  * @module box-node-sdk/lib/managers/folders
  * @see {@Link Folders}

package/lib/managers/groups.js

@@ -279,6 +279,7 @@ Groups.prototype.getMemberships = function(groupID, options, callback) {
  * Method: GET
  *
  * @param {Object} [options] - Optional parameters, can be left null in most cases
+ * @param {string} [options.filter_term] - Limits the results to only groups whose name starts with the search term
  * @param {int} [options.limit] - The number of memberships to retrieve
  * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
  * @param {Function} [callback] - Passed a list of groups if successful, error otherwise

package/lib/managers/metadata.js

@@ -148,6 +148,7 @@ Metadata.prototype = {
 	 * @param {string} [options.templateKey] - The programmatic key for the template
 	 * @param {boolean} [options.hidden] - Whether the template should be hidden in the UI
 	 * @param {string} [options.scope=enterprise] - The scope for the template, only 'enterprise' is supported for now
+	 * @param {boolean} [options.copyInstanceOnItemCopy] - Whether to include the metadata when a file or folder is copied
 	 * @param {Function} [callback] - Passed the template if successful, error otherwise
 	 * @returns {Promise<Object>} A promise resolving to the created template
 	 */

package/lib/managers/search.js

@@ -76,6 +76,8 @@ Search.prototype = {
 	 * @param {string} [options.type] - The type of objects you want to include in the search results. The type can be file, folder, or web_link
 	 * @param {string} [options.trash_content=non_trashed_only] - Controls whether to search in the trash. The value can be trashed_only or non_trashed_only
 	 * @param {SearchMetadataFilter[]} [options.mdfilters] - Searches for objects with a specific metadata object association.  Searches with the this parameter do not require a query string
+	 * @param {boolean} [options.include_recent_shared_links] - Determines whether to include items accessible only via shared link in the response.
+	 * @param {string} [options.fields] - Comma-delimited list of fields to be included in the response
 	 * @param {int} [options.limit=30] - The number of search results to return, max 200
 	 * @param {int} [options.offset=0] - The search result at which to start the response, must be a multiple of limit
 	 * @param {string} [options.sort] - The field on which the results should be sorted, e.g. "modified_at"

package/lib/managers/webhooks.js

@@ -110,6 +110,17 @@ function validateDeliveryTimestamp(headers, maxMessageAge) {
 	return true;
 }
 
+/**
+ * Stringify JSON with escaped multibyte Unicode characters to ensure computed signatures match PHP's default behavior
+ *
+ * @param {Object} body - The parsed JSON object
+ * @returns {string} - Stringified JSON with escaped multibyte Unicode characters
+ * @private
+ */
+function jsonStringifyWithEscapedUnicode(body) {
+	return JSON.stringify(body).replace(/[\u007f-\uffff]/g, char => `\\u${`0000${char.charCodeAt(0).toString(16)}`.slice(-4)}`);
+}
+
 // -----------------------------------------------------------------------------
 // Public
 // -----------------------------------------------------------------------------
@@ -351,7 +362,8 @@ Webhooks.validateMessage = function(body, headers, primaryKey, secondaryKey, max
 	// For frameworks like Express that automatically parse JSON
 	// bodies into Objects, re-stringify for signature testing
 	if (typeof body === 'object') {
-		body = JSON.stringify(body);
+		// Escape forward slashes to ensure a matching signature
+		body = jsonStringifyWithEscapedUnicode(body).replace(/\//g, '\\/');
 	}
 
 	if (!validateSignature(body, headers, primaryKey, secondaryKey)) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box <oss@box.com>",
-  "version": "1.34.2",
+  "version": "1.37.0",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {
@@ -32,19 +32,20 @@
     "major": "node Makefile.js major"
   },
   "dependencies": {
+    "ajv": "^6.12.3",
     "bluebird": "^3.7.1",
     "http-status": "^1.4.1",
     "jsonwebtoken": "^8.5.1",
     "merge-options": "^1.0.1",
     "promise-queue": "^2.2.3",
-    "proxy-agent": "^3.1.1",
+    "proxy-agent": "^4.0.0",
     "request": "^2.88.0",
     "url-template": "^2.0.8",
     "uuid": "^3.3.3"
   },
   "devDependencies": {
     "chai": "^4.2.0",
-    "coveralls": "^3.0.8",
+    "coveralls": "^3.1.0",
     "eslint": "^4.19.1",
     "eslint-plugin-node": "^6.0.1",
     "eslint-plugin-promise": "^3.8.0",
@@ -53,12 +54,13 @@
     "jsdoc": "^3.6.3",
     "jsonlint2": "^1.7.1",
     "leche": "^2.3.0",
-    "mocha": "^5.2.0",
+    "mocha": "^6.0.0",
     "mockery": "^2.1.0",
     "nock": "^9.6.1",
-    "np": "^5.1.3",
-    "npm-upgrade": "^2.0.3",
-    "nyc": "^11.9.0",
+    "np": "^7.2.0",
+    "npm-force-resolutions": "0.0.3",
+    "npm-upgrade": "^3.0.0",
+    "nyc": "^14.0.0",
     "shelljs": "^0.8.3",
     "shelljs-nodecli": "^0.1.1",
     "sinon": "^7.5.0"
@@ -66,5 +68,9 @@
   "files": [
     "config",
     "lib"
-  ]
+  ],
+  "resolutions": {
+    "handlebars": "4.5.3",
+    "minimist": "1.2.5"
+  }
 }