Added pathRoot option, added typings for fetch option (#230)

* feat(options): added pathRoot and fetch options to Dropbox

* feat(options): fixes and tests for pathRoot and fetch options

* feat(frontend): reverted changes for package.json

* feat(code-styles): fixed code-styles

* feat(code-styles): fixed code-styles (2)

* feat(fetch-option): changed option type to Function

* feat(options): removed changes in generated code

* feat(options): reverted autoFormatting

* feat(options): reset dropbox_types.d.ts

Author: Bohdan-Tereta

generator/typescript/dropbox_types.d.tstemplate

@@ -6,6 +6,10 @@ declare module DropboxTypes {
     clientId?: string;
     // Select user is only used by team endpoints. It specifies which user the team access token should be acting as.
     selectUser?: string;
+    // Root path used to access namespaces different from home namespace (team folders etc)
+    pathRoot?: string;
+    // Fetch library for making requests.
+    fetch?: Function
   }
 
   class DropboxBase {

src/download-request.js

@@ -50,6 +50,9 @@ export function downloadRequest(fetch) {
       if (options.selectAdmin) {
         fetchOptions.headers['Dropbox-API-Select-Admin'] = options.selectAdmin;
       }
+      if (options.pathRoot) {
+        fetchOptions.headers['Dropbox-API-Path-Root'] = options.pathRoot;
+      }
     }
 
 

src/dropbox-base.js

@@ -106,6 +106,8 @@ if (!Array.prototype.includes) {
  * to act as.
  * @arg {String} [options.selectAdmin] - Team admin that the team access token would like
  * to act as.
+ * @arg {String} [options.pathRoot] - root pass to access other namespaces
+ * Use to access team folders for example
  */
 
 function parseBodyToType(res) {
@@ -126,6 +128,7 @@ export class DropboxBase {
     this.selectUser = options.selectUser;
     this.selectAdmin = options.selectAdmin;
     this.fetch = options.fetch || fetch;
+    this.pathRoot = options.pathRoot;
     if (!options.fetch) { console.warn('Global fetch is deprecated and will be unsupported in a future version. Please pass fetch function as option when instantiating dropbox instance: new Dropbox({fetch})'); } // eslint-disable-line no-console
   }
 
@@ -274,11 +277,11 @@ client_id=${clientId}&client_secret=${clientSecret}`;
    */
 
 
- /**
-  * An authentication process that works with cordova applications.
-  * @param {successCallback} successCallback
-  * @param {errorCallback} errorCallback
-  */
+  /**
+   * An authentication process that works with cordova applications.
+   * @param {successCallback} successCallback
+   * @param {errorCallback} errorCallback
+   */
   authenticateWithCordova(successCallback, errorCallback) {
     const redirectUrl = 'https://www.dropbox.com/1/oauth2/redirect_receiver';
     const url = this.getAuthenticationUrl(redirectUrl);
@@ -352,6 +355,7 @@ client_id=${clientId}&client_secret=${clientSecret}`;
       selectAdmin: this.selectAdmin,
       clientId: this.getClientId(),
       clientSecret: this.getClientSecret(),
+      pathRoot: this.pathRoot,
     };
     return request(path, args, auth, host, this.getAccessToken(), options);
   }

src/dropbox.js

@@ -14,6 +14,8 @@ import { DropboxBase } from './dropbox-base';
  * authentication URL.
  * @arg {String} [options.selectUser] - Select user is only used by DropboxTeam.
  * It specifies which user the team access token should be acting as.
+ * @arg {String} [options.pathRoot] - root pass to access other namespaces
+ * Use to access team folders for example
  */
 export class Dropbox extends DropboxBase {
 

src/rpc-request.js

@@ -45,6 +45,9 @@ export function rpcRequest(fetch) {
       if (options.selectAdmin) {
         headers['Dropbox-API-Select-Admin'] = options.selectAdmin;
       }
+      if (options.pathRoot) {
+        headers['Dropbox-API-Path-Root'] = options.pathRoot;
+      }
     }
 
     fetchOptions.headers = headers;

src/upload-request.js

@@ -35,6 +35,9 @@ export function uploadRequest(fetch) {
       if (options.selectAdmin) {
         fetchOptions.headers['Dropbox-API-Select-Admin'] = options.selectAdmin;
       }
+      if (options.pathRoot) {
+        fetchOptions.headers['Dropbox-API-Path-Root'] = options.pathRoot;
+      }
     }
 
     return fetch(getBaseURL(host) + path, fetchOptions)

test/download-request.js

@@ -14,8 +14,8 @@ describe('downloadRequest', function () {
     fetchMock = FetchMock.sandbox().mock('*', new Response(
       createReadStream(resolve(__dirname, './file.txt')),
       {
-        status : 200 ,
-        statusText : "OK",
+        status: 200,
+        statusText: "OK",
         headers: {
           'Content-Type': 'application/octet-stream',
           'dropbox-api-result': '{"test":"json"}'
@@ -73,20 +73,20 @@ describe('downloadRequest', function () {
 
   it('sets the Dropbox-API-Arg header', function (done) {
     downloadRequest(fetchMock)('sharing/create_shared_link', { foo: 'bar' }, 'user', 'content', 'atoken')
-    .then((data) => {
-      assert.equal(fetchMock.lastOptions().headers['Authorization'], 'Bearer atoken');
-      assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Arg'], JSON.stringify({ foo: 'bar' }));
-      done();
-    }, done);
+      .then((data) => {
+        assert.equal(fetchMock.lastOptions().headers['Authorization'], 'Bearer atoken');
+        assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Arg'], JSON.stringify({ foo: 'bar' }));
+        done();
+      }, done);
   });
 
   it('escapes special characters in the Dropbox-API-Arg header', function (done) {
     downloadRequest(fetchMock)('sharing/create_shared_link', { foo: 'bar单bazá' }, 'user', 'content', 'atoken')
-    .then((data) => {
-      assert.equal(fetchMock.lastOptions().headers['Authorization'], 'Bearer atoken');
-      assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Arg'], '{"foo":"bar\\u5355baz\\u00e1"}');
-      done();
-    }, done);
+      .then((data) => {
+        assert.equal(fetchMock.lastOptions().headers['Authorization'], 'Bearer atoken');
+        assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Arg'], '{"foo":"bar\\u5355baz\\u00e1"}');
+        done();
+      }, done);
   });
 
   it('returns a valid response', function (done) {
@@ -96,4 +96,13 @@ describe('downloadRequest', function () {
         done();
       }, done);
   });
+
+  it('sets Dropbox-Api-Path-Root header if pathRoot set', function (done) {
+    downloadRequest(fetchMock)('sharing/create_shared_link', { foo: 'bar' }, 'user', 'content', 'atoken', {pathRoot: 'selectedPathRoot'})
+      .then((data) => {
+        assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Path-Root'], 'selectedPathRoot');
+        done();
+      }, done);
+  });
+
 });

test/dropbox-base.js

@@ -301,4 +301,16 @@ describe('DropboxBase', function () {
       );
     });
   });
+
+  describe('.pathRoot', function () {
+    it('can be set in the constructor', function () {
+      dbx = new DropboxBase({ pathRoot: 'foo' });
+      assert.equal(dbx.pathRoot, 'foo');
+    });
+
+    it('is undefined if not set in constructor', function () {
+      dbx = new DropboxBase();
+      assert.equal(dbx.pathRoot, undefined);
+    });
+  });
 });

test/rpc-request.js

@@ -12,8 +12,8 @@ describe('rpcRequest', function () {
     fetchMock = FetchMock.sandbox().mock('*', new Response(
       '{"test": "test"}',
       {
-        status : 200 ,
-        statusText : "OK",
+        status: 200,
+        statusText: "OK",
         headers: {
           'Content-Type': 'application/json',
           'dropbox-api-result': '{"test":"json"}'
@@ -90,4 +90,12 @@ describe('rpcRequest', function () {
       });
   });
 
+  it('sets Dropbox-Api-Path-Root header if pathRoot set', function (done) {
+    rpcRequest(fetchMock)('files/list', { foo: 'bar' }, 'user', 'api', 'atoken', { pathRoot: 'selectedPathRoot' })
+      .then((data) => {
+        assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Path-Root'], 'selectedPathRoot');
+        done();
+      }, done);
+  });
+
 });

test/upload-request.js

@@ -10,8 +10,8 @@ describe('uploadRequest', function () {
     fetchMock = FetchMock.sandbox().post('*', new Response(
       '{"foo": "bar"}',
       {
-        status : 200 ,
-        statusText : "OK",
+        status: 200,
+        statusText: "OK",
         headers: {
           'Content-Type': 'application/json',
           'dropbox-api-result': '{"test":"json"}'
@@ -101,4 +101,12 @@ describe('uploadRequest', function () {
       }, done);
   });
 
+  it('sets Dropbox-Api-Path-Root header if pathRoot set', function (done) {
+    uploadRequest(fetchMock)('files/upload', { foo: 'bar' }, 'user', 'content', 'atoken', {pathRoot: 'selectedPathRoot'})
+      .then((data) => {
+        assert.equal(fetchMock.lastOptions().headers['Dropbox-API-Path-Root'], 'selectedPathRoot');
+        done();
+      }, done);
+  });
+
 });