Add customHeaders option to DropboxAuth (#854)

Author: mtruong-dbx

generator/typescript/index.d.tstemplate

@@ -20,6 +20,8 @@ export interface DropboxAuthOptions {
   domain?: string;
   // A custom delimiter to use when separating domain from subdomain. This should only be used for testing as scaffolding.
   domainDelimiter?: string;
+  // An object (in the form of header: value) designed to set custom headers to use during a request.
+  customHeaders?: object;
 }
 
 export class DropboxAuth {

package.json

@@ -1,6 +1,6 @@
 {
     "name": "dropbox",
-    "version": "10.18.0",
+    "version": "10.19.0",
     "registry": "npm",
     "description": "The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.",
     "main": "cjs/index.js",

src/auth.js

@@ -53,7 +53,9 @@ const IncludeGrantedScopes = ['none', 'user', 'team'];
  * should only be used for testing as scaffolding to avoid making network requests.
  * @arg {String} [options.domainDelimiter] - A custom delimiter to use when separating domain from
  * subdomain. This should only be used for testing as scaffolding.
- */
+ * @arg {Object} [options.customHeaders] - An object (in the form of header: value) designed to set
+ * custom headers to use during a request.
+*/
 export default class DropboxAuth {
   constructor(options) {
     options = options || {};
@@ -67,6 +69,7 @@ export default class DropboxAuth {
 
     this.domain = options.domain;
     this.domainDelimiter = options.domainDelimiter;
+    this.customHeaders = options.customHeaders;
   }
 
   /**

src/dropbox.js

@@ -69,9 +69,9 @@ export default class Dropbox {
     this.selectAdmin = options.selectAdmin;
     this.pathRoot = options.pathRoot;
 
-    this.domain = options.domain;
-    this.domainDelimiter = options.domainDelimiter;
-    this.customHeaders = options.customHeaders;
+    this.domain = options.domain || this.auth.domain;
+    this.domainDelimiter = options.domainDelimiter || this.auth.domainDelimiter;
+    this.customHeaders = options.customHeaders || this.auth.customHeaders;
 
     Object.assign(this, routes);
   }

test/unit/auth.js

@@ -41,6 +41,18 @@ describe('DropboxAuth', () => {
     });
   });
 
+  describe('customHeaders', () => {
+    it('can be set in the constructor', () => {
+      const dbx = new DropboxAuth({ customHeaders: { foo: 'bar' } });
+      chai.assert.equal(dbx.customHeaders.foo, 'bar');
+    });
+
+    it('is undefined if not set in constructor', () => {
+      const dbx = new DropboxAuth();
+      chai.assert.equal(dbx.customHeaders, undefined);
+    });
+  });
+
   describe('getAuthenticationUrl()', () => {
     it('throws an error if the client id isn\'t set', () => {
       const dbx = new DropboxAuth();

test/unit/dropbox.js

@@ -29,6 +29,42 @@ describe('Dropbox', () => {
     });
   });
 
+  describe('domain', () => {
+    it('can be set in the constructor', () => {
+      const dbx = new Dropbox({ domain: 'mydomain.com' });
+      chai.assert.equal(dbx.domain, 'mydomain.com');
+    });
+
+    it('is undefined if not set in constructor', () => {
+      const dbx = new Dropbox();
+      chai.assert.equal(dbx.domain, undefined);
+    });
+
+    it('is set by auth.domain if not set in constructor', () => {
+      const auth = new DropboxAuth({ domain: 'mydomain.com' });
+      const dbx = new Dropbox({ auth });
+      chai.assert.equal(dbx.domain, 'mydomain.com');
+    });
+  });
+
+  describe('domainDelimiter', () => {
+    it('can be set in the constructor', () => {
+      const dbx = new Dropbox({ domainDelimiter: '-' });
+      chai.assert.equal(dbx.domainDelimiter, '-');
+    });
+
+    it('is undefined if not set in constructor', () => {
+      const dbx = new Dropbox();
+      chai.assert.equal(dbx.domainDelimiter, undefined);
+    });
+
+    it('is set by auth.domainDelimiter if not set in constructor', () => {
+      const auth = new DropboxAuth({ domainDelimiter: '-' });
+      const dbx = new Dropbox({ auth });
+      chai.assert.equal(dbx.domainDelimiter, '-');
+    });
+  });
+
   describe('customHeaders', () => {
     it('can be set in the constructor', () => {
       const dbx = new Dropbox({ customHeaders: { foo: 'bar' } });
@@ -39,6 +75,12 @@ describe('Dropbox', () => {
       const dbx = new Dropbox();
       chai.assert.equal(dbx.customHeaders, undefined);
     });
+
+    it('is set by auth.customHeaders if not set in constructor', () => {
+      const auth = new DropboxAuth({ customHeaders: { foo: 'bar' } });
+      const dbx = new Dropbox({ auth });
+      chai.assert.equal(dbx.customHeaders.foo, 'bar');
+    });
   });
 
   describe('RPC requests', () => {

types/index.d.ts

@@ -20,6 +20,8 @@ export interface DropboxAuthOptions {
   domain?: string;
   // A custom delimiter to use when separating domain from subdomain. This should only be used for testing as scaffolding.
   domainDelimiter?: string;
+  // An object (in the form of header: value) designed to set custom headers to use during a request.
+  customHeaders?: object;
 }
 
 export class DropboxAuth {