files.com 1.0.212 → 1.0.214

package/lib/Files.js

@@ -17,6 +17,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
+var userAgent = 'Files.com JavaScript SDK v1.0';
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;
 var debugResponseHeaders = false;
@@ -28,6 +29,12 @@ var autoPaginate = true;
 var Files = /*#__PURE__*/(0, _createClass2.default)(function Files() {
   (0, _classCallCheck2.default)(this, Files);
 });
+(0, _defineProperty2.default)(Files, "setUserAgent", function (value) {
+  return userAgent = value;
+});
+(0, _defineProperty2.default)(Files, "getUserAgent", function () {
+  return userAgent;
+});
 (0, _defineProperty2.default)(Files, "setApiKey", function (value) {
   return apiKey = value;
 });

package/lib/models/File.js

@@ -50,7 +50,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
   var _this = this;
 
   var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+  var _options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
   (0, _classCallCheck2.default)(this, File);
   (0, _defineProperty2.default)(this, "attributes", {});
   (0, _defineProperty2.default)(this, "options", {});
@@ -140,7 +142,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     };
   }());
   (0, _defineProperty2.default)(this, "copyTo", /*#__PURE__*/function () {
-    var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(destinationFilePath) {
+    var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(destinationFilePath, options) {
       var params;
       return _regenerator.default.wrap(function _callee3$(_context3) {
         while (1) {
@@ -149,7 +151,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
               params = {
                 destination: destinationFilePath
               };
-              return _context3.abrupt("return", _Api.default.sendRequest("/file_actions/copy/".concat(encodeURIComponent(_this.path)), 'POST', params));
+              return _context3.abrupt("return", _Api.default.sendRequest("/file_actions/copy/".concat(encodeURIComponent(_this.path)), 'POST', params, options));
 
             case 2:
             case "end":
@@ -159,12 +161,12 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }, _callee3);
     }));
 
-    return function (_x3) {
+    return function (_x3, _x4) {
       return _ref3.apply(this, arguments);
     };
   }());
   (0, _defineProperty2.default)(this, "moveTo", /*#__PURE__*/function () {
-    var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(destinationFilePath) {
+    var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(destinationFilePath, options) {
       var params;
       return _regenerator.default.wrap(function _callee4$(_context4) {
         while (1) {
@@ -173,7 +175,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
               params = {
                 destination: destinationFilePath
               };
-              return _context4.abrupt("return", _Api.default.sendRequest("/file_actions/move/".concat(encodeURIComponent(_this.path)), 'POST', params));
+              return _context4.abrupt("return", _Api.default.sendRequest("/file_actions/move/".concat(encodeURIComponent(_this.path)), 'POST', params, options));
 
             case 2:
             case "end":
@@ -183,7 +185,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }, _callee4);
     }));
 
-    return function (_x4) {
+    return function (_x5, _x6) {
       return _ref4.apply(this, arguments);
     };
   }());
@@ -897,10 +899,10 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       writable: false
     });
   });
-  this.options = _objectSpread({}, options);
+  this.options = _objectSpread({}, _options);
 });
 (0, _defineProperty2.default)(File, "_openUpload", /*#__PURE__*/function () {
-  var _ref13 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(path, paramsRaw) {
+  var _ref13 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(path, paramsRaw, options) {
     var params, response, partData;
     return _regenerator.default.wrap(function _callee11$(_context11) {
       while (1) {
@@ -910,7 +912,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
               action: 'put'
             });
             _context11.next = 3;
-            return _Api.default.sendRequest("/files/".concat(encodeURIComponent(path)), 'POST', params);
+            return _Api.default.sendRequest("/files/".concat(encodeURIComponent(path)), 'POST', params, options);
 
           case 3:
             response = _context11.sent;
@@ -937,12 +939,12 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee11);
   }));
 
-  return function (_x5, _x6) {
+  return function (_x7, _x8, _x9) {
     return _ref13.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(File, "_continueUpload", /*#__PURE__*/function () {
-  var _ref14 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(path, partNumber, firstFileUploadPart) {
+  var _ref14 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(path, partNumber, firstFileUploadPart, options) {
     var params, response, partData;
     return _regenerator.default.wrap(function _callee12$(_context12) {
       while (1) {
@@ -954,7 +956,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
               ref: firstFileUploadPart.ref
             };
             _context12.next = 3;
-            return _Api.default.sendRequest("/files/".concat(encodeURIComponent(path)), 'POST', params);
+            return _Api.default.sendRequest("/files/".concat(encodeURIComponent(path)), 'POST', params, options);
 
           case 3:
             response = _context12.sent;
@@ -981,12 +983,12 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee12);
   }));
 
-  return function (_x7, _x8, _x9) {
+  return function (_x10, _x11, _x12, _x13) {
     return _ref14.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(File, "_completeUpload", /*#__PURE__*/function () {
-  var _ref15 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(firstFileUploadPart) {
+  var _ref15 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(firstFileUploadPart, options) {
     var params;
     return _regenerator.default.wrap(function _callee13$(_context13) {
       while (1) {
@@ -996,7 +998,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
               action: 'end',
               ref: firstFileUploadPart.ref
             };
-            return _context13.abrupt("return", _Api.default.sendRequest("/files/".concat(encodeURIComponent(firstFileUploadPart.path)), 'POST', params));
+            return _context13.abrupt("return", _Api.default.sendRequest("/files/".concat(encodeURIComponent(firstFileUploadPart.path)), 'POST', params, options));
 
           case 2:
           case "end":
@@ -1006,19 +1008,19 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee13);
   }));
 
-  return function (_x10) {
+  return function (_x14, _x15) {
     return _ref15.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(File, "uploadStream", /*#__PURE__*/function () {
-  var _ref16 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16(destinationPath, readableStream, params) {
+  var _ref16 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16(destinationPath, readableStream, params, options) {
     var firstFileUploadPart, file;
     return _regenerator.default.wrap(function _callee16$(_context16) {
       while (1) {
         switch (_context16.prev = _context16.next) {
           case 0:
             _context16.next = 2;
-            return File._openUpload(destinationPath, params);
+            return File._openUpload(destinationPath, params, options);
 
           case 2:
             firstFileUploadPart = _context16.sent;
@@ -1064,7 +1066,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
                           chunks.push(lastChunkForPart);
                           buffer = _safeBuffer.Buffer.concat(chunks);
                           _context14.next = 12;
-                          return File._continueUpload(destinationPath, ++part, firstFileUploadPart);
+                          return File._continueUpload(destinationPath, ++part, firstFileUploadPart, options);
 
                         case 12:
                           nextFileUploadPart = _context14.sent;
@@ -1096,7 +1098,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
                   }, _callee14, null, [[0, 23]]);
                 }));
 
-                return function (_x14) {
+                return function (_x20) {
                   return _ref17.apply(this, arguments);
                 };
               }());
@@ -1115,7 +1117,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
 
                         buffer = _safeBuffer.Buffer.concat(chunks);
                         _context15.next = 5;
-                        return File._continueUpload(destinationPath, ++part, firstFileUploadPart);
+                        return File._continueUpload(destinationPath, ++part, firstFileUploadPart, options);
 
                       case 5:
                         nextFileUploadPart = _context15.sent;
@@ -1127,11 +1129,11 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
 
                       case 9:
                         _context15.next = 11;
-                        return File._completeUpload(firstFileUploadPart);
+                        return File._completeUpload(firstFileUploadPart, options);
 
                       case 11:
                         response = _context15.sent;
-                        createdFile = new File(response.data);
+                        createdFile = new File(response.data, options);
                         resolve(createdFile);
                         _context15.next = 19;
                         break;
@@ -1167,12 +1169,12 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee16, null, [[5, 12]]);
   }));
 
-  return function (_x11, _x12, _x13) {
+  return function (_x16, _x17, _x18, _x19) {
     return _ref16.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(File, "uploadData", /*#__PURE__*/function () {
-  var _ref19 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(destinationPath, data, params) {
+  var _ref19 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(destinationPath, data, params, options) {
     return _regenerator.default.wrap(function _callee17$(_context17) {
       while (1) {
         switch (_context17.prev = _context17.next) {
@@ -1185,7 +1187,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
             throw new errors.MissingParameterError('Upload data was not provided');
 
           case 2:
-            return _context17.abrupt("return", File.uploadStream(destinationPath, _readableStream.default.from(data), params));
+            return _context17.abrupt("return", File.uploadStream(destinationPath, _readableStream.default.from(data), params, options));
 
           case 3:
           case "end":
@@ -1195,12 +1197,12 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee17);
   }));
 
-  return function (_x15, _x16, _x17) {
+  return function (_x21, _x22, _x23, _x24) {
     return _ref19.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(File, "uploadFile", /*#__PURE__*/function () {
-  var _ref20 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(destinationPath, sourceFilePath, params) {
+  var _ref20 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(destinationPath, sourceFilePath, params, options) {
     var _require3, openDiskFileReadStream, stream;
 
     return _regenerator.default.wrap(function _callee18$(_context18) {
@@ -1217,7 +1219,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
           case 2:
             _require3 = require('../isomorphic/File.node.js'), openDiskFileReadStream = _require3.openDiskFileReadStream;
             stream = openDiskFileReadStream(sourceFilePath);
-            return _context18.abrupt("return", File.uploadStream(destinationPath, stream, params));
+            return _context18.abrupt("return", File.uploadStream(destinationPath, stream, params, options));
 
           case 5:
           case "end":
@@ -1227,7 +1229,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee18);
   }));
 
-  return function (_x18, _x19, _x20) {
+  return function (_x25, _x26, _x27, _x28) {
     return _ref20.apply(this, arguments);
   };
 }());
@@ -1357,7 +1359,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee19);
   }));
 
-  return function (_x21) {
+  return function (_x29) {
     return _ref21.apply(this, arguments);
   };
 }());
@@ -1423,7 +1425,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     }, _callee20);
   }));
 
-  return function (_x22) {
+  return function (_x30) {
     return _ref22.apply(this, arguments);
   };
 }());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.0.212",
+  "version": "1.0.214",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Api.js

@@ -37,7 +37,14 @@ class Api {
       : `${baseUrl}${Files.getEndpointPrefix()}${path}`
 
     Logger.debug(`Sending request: ${verb} ${url}`)
-    Logger.debug('Sending options:', options)
+
+    Logger.debug('Sending options:', {
+      ...options,
+      headers: {
+        ...options.headers,
+        'X-FilesAPI-Key': '<redacted>',
+      },
+    })
 
     Api._configureAutoRetry()
 
@@ -78,7 +85,7 @@ class Api {
   }
 
   static _autoPaginate = async (path, verb, params, options, response, metadata) => {
-    if (Files.getAutoPaginate()) {
+    if (options.autoPaginate ?? Files.getAutoPaginate()) {
       const nextCursor = response?.headers?.['x-files-cursor']
 
       const {
@@ -119,7 +126,7 @@ class Api {
     const headers = {
       Accept: 'application/json',
       ...options.headers,
-      'User-Agent': 'Files.com JavaScript SDK v1.0',
+      'User-Agent': Files.getUserAgent(),
     }
 
     const isExternal = /^[a-zA-Z]+:\/\//.test(path)

package/src/Errors.js

@@ -94,6 +94,7 @@ export class BadRequest_DestinationSameError extends BadRequestError { construct
 export class BadRequest_FolderMustNotBeAFileError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_FolderMustNotBeAFileError' } } errorClasses.BadRequest_FolderMustNotBeAFileError = BadRequest_FolderMustNotBeAFileError
 export class BadRequest_InvalidBodyError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidBodyError' } } errorClasses.BadRequest_InvalidBodyError = BadRequest_InvalidBodyError
 export class BadRequest_InvalidCursorError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidCursorError' } } errorClasses.BadRequest_InvalidCursorError = BadRequest_InvalidCursorError
+export class BadRequest_InvalidCursorTypeForSortError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidCursorTypeForSortError' } } errorClasses.BadRequest_InvalidCursorTypeForSortError = BadRequest_InvalidCursorTypeForSortError
 export class BadRequest_InvalidEtagsError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidEtagsError' } } errorClasses.BadRequest_InvalidEtagsError = BadRequest_InvalidEtagsError
 export class BadRequest_InvalidFilterCombinationError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidFilterCombinationError' } } errorClasses.BadRequest_InvalidFilterCombinationError = BadRequest_InvalidFilterCombinationError
 export class BadRequest_InvalidFilterFieldError extends BadRequestError { constructor(message, code) { super(message, code); this.name = 'BadRequest_InvalidFilterFieldError' } } errorClasses.BadRequest_InvalidFilterFieldError = BadRequest_InvalidFilterFieldError

package/src/Files.js

@@ -5,6 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
+let userAgent = 'Files.com JavaScript SDK v1.0'
 
 let logLevel = LogLevel.INFO
 let debugRequest = false
@@ -17,6 +18,9 @@ let networkTimeout = 30.0
 let autoPaginate = true
 
 class Files {
+  static setUserAgent = value => userAgent = value
+  static getUserAgent = () => userAgent
+
   static setApiKey = value => apiKey = value
   static getApiKey = () => apiKey
 

package/src/models/File.js

@@ -28,9 +28,9 @@ class File {
   }
 
   isLoaded = () => !!this.attributes.path
-  static _openUpload = async (path, paramsRaw) => {
+  static _openUpload = async (path, paramsRaw, options) => {
     const params = { ...paramsRaw, action: 'put' }
-    const response = await Api.sendRequest(`/files/${encodeURIComponent(path)}`, 'POST', params)
+    const response = await Api.sendRequest(`/files/${encodeURIComponent(path)}`, 'POST', params, options)
 
     if (!response) {
       return null
@@ -45,14 +45,14 @@ class File {
     return new FileUploadPart(partData)
   }
 
-  static _continueUpload = async (path, partNumber, firstFileUploadPart) => {
+  static _continueUpload = async (path, partNumber, firstFileUploadPart, options) => {
     const params = {
       action: 'put',
       part: partNumber,
       ref: firstFileUploadPart.ref,
     }
 
-    const response = await Api.sendRequest(`/files/${encodeURIComponent(path)}`, 'POST', params)
+    const response = await Api.sendRequest(`/files/${encodeURIComponent(path)}`, 'POST', params, options)
 
     if (!response) {
       return null
@@ -67,20 +67,20 @@ class File {
     return new FileUploadPart(partData)
   }
 
-  static _completeUpload = async firstFileUploadPart => {
+  static _completeUpload = async (firstFileUploadPart, options) => {
     const params = {
       action: 'end',
       ref: firstFileUploadPart.ref,
     }
 
-    return Api.sendRequest(`/files/${encodeURIComponent(firstFileUploadPart.path)}`, 'POST', params)
+    return Api.sendRequest(`/files/${encodeURIComponent(firstFileUploadPart.path)}`, 'POST', params, options)
   }
 
   /**
    * @note see File.copy() for list of supported params
    */
-  static uploadStream = async (destinationPath, readableStream, params) => {
-    const firstFileUploadPart = await File._openUpload(destinationPath, params)
+  static uploadStream = async (destinationPath, readableStream, params, options) => {
+    const firstFileUploadPart = await File._openUpload(destinationPath, params, options)
 
     if (!firstFileUploadPart) {
       return
@@ -111,7 +111,7 @@ class File {
               chunks.push(lastChunkForPart)
 
               const buffer = Buffer.concat(chunks)
-              const nextFileUploadPart = await File._continueUpload(destinationPath, ++part, firstFileUploadPart)
+              const nextFileUploadPart = await File._continueUpload(destinationPath, ++part, firstFileUploadPart, options)
 
               concurrentUploads.push(Api.sendFilePart(nextFileUploadPart.upload_uri, 'PUT', buffer))
 
@@ -132,15 +132,15 @@ class File {
           try {
             if (chunks.length > 0) {
               const buffer = Buffer.concat(chunks)
-              const nextFileUploadPart = await File._continueUpload(destinationPath, ++part, firstFileUploadPart)
+              const nextFileUploadPart = await File._continueUpload(destinationPath, ++part, firstFileUploadPart, options)
 
               concurrentUploads.push(Api.sendFilePart(nextFileUploadPart.upload_uri, 'PUT', buffer))
             }
 
             await Promise.all(concurrentUploads)
 
-            const response = await File._completeUpload(firstFileUploadPart)
-            const createdFile = new File(response.data)
+            const response = await File._completeUpload(firstFileUploadPart, options)
+            const createdFile = new File(response.data, options)
 
             resolve(createdFile)
           } catch (error) {
@@ -159,18 +159,18 @@ class File {
    * data - string, Buffer, Stream, any object implementing Symbol.iterator or Symbol.asyncIterator
    * @note see File.copy() for list of supported params
    */
-  static uploadData = async (destinationPath, data, params) => {
+  static uploadData = async (destinationPath, data, params, options) => {
     if (!data) {
       throw new errors.MissingParameterError('Upload data was not provided')
     }
 
-    return File.uploadStream(destinationPath, Readable.from(data), params)
+    return File.uploadStream(destinationPath, Readable.from(data), params, options)
   }
 
   /**
    * @note see File.copy() for list of supported params
    */
-  static uploadFile = async (destinationPath, sourceFilePath, params) => {
+  static uploadFile = async (destinationPath, sourceFilePath, params, options) => {
     if (isBrowser()) {
       throw new errors.NotImplementedError('Disk file uploads are only available in a NodeJS environment')
     }
@@ -178,7 +178,7 @@ class File {
     const { openDiskFileReadStream } = require('../isomorphic/File.node.js')
     const stream = openDiskFileReadStream(sourceFilePath)
 
-    return File.uploadStream(destinationPath, stream, params)
+    return File.uploadStream(destinationPath, stream, params, options)
   }
 
   downloadToStream = async writableStream => {
@@ -211,14 +211,14 @@ class File {
     return saveUrlToFile(downloadUri, destinationPath)
   }
 
-  copyTo = async destinationFilePath => {
+  copyTo = async (destinationFilePath, options) => {
     const params = { destination: destinationFilePath }
-    return Api.sendRequest(`/file_actions/copy/${encodeURIComponent(this.path)}`, 'POST', params)
+    return Api.sendRequest(`/file_actions/copy/${encodeURIComponent(this.path)}`, 'POST', params, options)
   }
 
-  moveTo = async destinationFilePath => {
+  moveTo = async (destinationFilePath, options) => {
     const params = { destination: destinationFilePath }
-    return Api.sendRequest(`/file_actions/move/${encodeURIComponent(this.path)}`, 'POST', params)
+    return Api.sendRequest(`/file_actions/move/${encodeURIComponent(this.path)}`, 'POST', params, options)
   }
 
   // string # File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

package/test/src/index.js

@@ -46,6 +46,7 @@ const testSuite = async () => {
     Files.configureNetwork({
       autoPaginate: false,
     })
+
     const firstPageItems = await Folder.listFor('/', { per_page: 1 })
 
     assert(firstPageItems.length === 1)
@@ -53,6 +54,7 @@ const testSuite = async () => {
     Files.configureNetwork({
       autoPaginate: true,
     })
+
     // note: this test will fail if the root folder has <= 1 file or folder
     const allPageItems = await Folder.listFor('/', { per_page: 1 })