files.com 1.1.18 → 1.2.0

package/src/models/UserCipherUse.js

@@ -1,7 +1,9 @@
 /* eslint-disable no-unused-vars */
 import Api from '../Api'
 import * as errors from '../Errors'
-import { getType, isArray, isInt, isObject, isString } from '../utils'
+import {
+  getType, isArray, isInt, isObject, isString,
+} from '../utils'
 /* eslint-enable no-unused-vars */
 
 /**
@@ -9,6 +11,7 @@ import { getType, isArray, isInt, isObject, isString } from '../utils'
  */
 class UserCipherUse {
   attributes = {}
+
   options = {}
 
   constructor(attributes = {}, options = {}) {
@@ -24,6 +27,7 @@ class UserCipherUse {
   }
 
   isLoaded = () => !!this.attributes.id
+
   // int64 # UserCipherUse ID
   getId = () => this.attributes.id
 
@@ -42,27 +46,25 @@ class UserCipherUse {
   // int64 # ID of the user who performed this access
   getUserId = () => this.attributes.user_id
 
-
   // Parameters:
   //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
   static list = async (params = {}, options = {}) => {
-    if (params['user_id'] && !isInt(params['user_id'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params['user_id'])}`)
+    if (params.user_id && !isInt(params.user_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
     }
 
-    if (params['cursor'] && !isString(params['cursor'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
+    if (params.cursor && !isString(params.cursor)) {
+      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
     }
 
-    if (params['per_page'] && !isInt(params['per_page'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
+    if (params.per_page && !isInt(params.per_page)) {
+      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
     }
 
-    const response = await Api.sendRequest(`/user_cipher_uses`, 'GET', params, options)
+    const response = await Api.sendRequest('/user_cipher_uses', 'GET', params, options)
 
-    
     return response?.data?.map(obj => new UserCipherUse(obj, options)) || []
   }
 

package/src/models/UserRequest.js

@@ -1,7 +1,9 @@
 /* eslint-disable no-unused-vars */
 import Api from '../Api'
 import * as errors from '../Errors'
-import { getType, isArray, isInt, isObject, isString } from '../utils'
+import {
+  getType, isArray, isInt, isObject, isString,
+} from '../utils'
 /* eslint-enable no-unused-vars */
 
 /**
@@ -9,6 +11,7 @@ import { getType, isArray, isInt, isObject, isString } from '../utils'
  */
 class UserRequest {
   attributes = {}
+
   options = {}
 
   constructor(attributes = {}, options = {}) {
@@ -24,6 +27,7 @@ class UserRequest {
   }
 
   isLoaded = () => !!this.attributes.id
+
   // int64 # ID
   getId = () => this.attributes.id
 
@@ -52,7 +56,6 @@ class UserRequest {
     this.attributes.details = value
   }
 
-
   delete = async (params = {}) => {
     if (!this.attributes.id) {
       throw new errors.EmptyPropertyError('Current object has no id')
@@ -63,51 +66,48 @@ class UserRequest {
     }
 
     params.id = this.attributes.id
-    if (params['id'] && !isInt(params['id'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params['id'])}`)
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
     }
 
-    if (!params['id']) {
+    if (!params.id) {
       if (this.attributes.id) {
-        params['id'] = this.id
+        params.id = this.id
       } else {
         throw new errors.MissingParameterError('Parameter missing: id')
       }
     }
 
-    const response = await Api.sendRequest(`/user_requests/${encodeURIComponent(params['id'])}`, 'DELETE', params, this.options)
-
-    return
+    await Api.sendRequest(`/user_requests/${encodeURIComponent(params.id)}`, 'DELETE', params, this.options)
   }
 
   destroy = (params = {}) =>
     this.delete(params)
 
   save = async () => {
-      if (this.attributes['id']) {
-        throw new errors.NotImplementedError('The UserRequest object doesn\'t support updates.')
-      } else {
-        const newObject = await UserRequest.create(this.attributes, this.options)
-        this.attributes = { ...newObject.attributes }
-        return true
-      }
+    if (this.attributes.id) {
+      throw new errors.NotImplementedError('The UserRequest object doesn\'t support updates.')
+    } else {
+      const newObject = await UserRequest.create(this.attributes, this.options)
+      this.attributes = { ...newObject.attributes }
+      return true
+    }
   }
 
   // Parameters:
   //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
   static list = async (params = {}, options = {}) => {
-    if (params['cursor'] && !isString(params['cursor'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
+    if (params.cursor && !isString(params.cursor)) {
+      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
     }
 
-    if (params['per_page'] && !isInt(params['per_page'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
+    if (params.per_page && !isInt(params.per_page)) {
+      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
     }
 
-    const response = await Api.sendRequest(`/user_requests`, 'GET', params, options)
+    const response = await Api.sendRequest('/user_requests', 'GET', params, options)
 
-    
     return response?.data?.map(obj => new UserRequest(obj, options)) || []
   }
 
@@ -121,19 +121,18 @@ class UserRequest {
       throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
     }
 
-    params['id'] = id
+    params.id = id
 
-    if (!params['id']) {
+    if (!params.id) {
       throw new errors.MissingParameterError('Parameter missing: id')
     }
 
-    if (params['id'] && !isInt(params['id'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params['id'])}`)
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
     }
 
-    const response = await Api.sendRequest(`/user_requests/${encodeURIComponent(params['id'])}`, 'GET', params, options)
+    const response = await Api.sendRequest(`/user_requests/${encodeURIComponent(params.id)}`, 'GET', params, options)
 
-    
     return new UserRequest(response?.data, options)
   }
 
@@ -145,33 +144,32 @@ class UserRequest {
   //   email (required) - string - Email of user requested
   //   details (required) - string - Details of the user request
   static create = async (params = {}, options = {}) => {
-    if (!params['name']) {
+    if (!params.name) {
       throw new errors.MissingParameterError('Parameter missing: name')
     }
 
-    if (!params['email']) {
+    if (!params.email) {
       throw new errors.MissingParameterError('Parameter missing: email')
     }
 
-    if (!params['details']) {
+    if (!params.details) {
       throw new errors.MissingParameterError('Parameter missing: details')
     }
 
-    if (params['name'] && !isString(params['name'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params['name'])}`)
+    if (params.name && !isString(params.name)) {
+      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
     }
 
-    if (params['email'] && !isString(params['email'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: email must be of type String, received ${getType(params['email'])}`)
+    if (params.email && !isString(params.email)) {
+      throw new errors.InvalidParameterError(`Bad parameter: email must be of type String, received ${getType(params.email)}`)
     }
 
-    if (params['details'] && !isString(params['details'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: details must be of type String, received ${getType(params['details'])}`)
+    if (params.details && !isString(params.details)) {
+      throw new errors.InvalidParameterError(`Bad parameter: details must be of type String, received ${getType(params.details)}`)
     }
 
-    const response = await Api.sendRequest(`/user_requests`, 'POST', params, options)
+    const response = await Api.sendRequest('/user_requests', 'POST', params, options)
 
-    
     return new UserRequest(response?.data, options)
   }
 }

package/src/models/WebhookTest.js

@@ -1,7 +1,9 @@
 /* eslint-disable no-unused-vars */
 import Api from '../Api'
 import * as errors from '../Errors'
-import { getType, isArray, isInt, isObject, isString } from '../utils'
+import {
+  getType, isArray, isInt, isObject, isString,
+} from '../utils'
 /* eslint-enable no-unused-vars */
 
 /**
@@ -9,6 +11,7 @@ import { getType, isArray, isInt, isObject, isString } from '../utils'
  */
 class WebhookTest {
   attributes = {}
+
   options = {}
 
   constructor(attributes = {}, options = {}) {
@@ -24,6 +27,7 @@ class WebhookTest {
   }
 
   isLoaded = () => !!this.attributes.id
+
   // int64 # Status HTTP code
   getCode = () => this.attributes.code
 
@@ -129,15 +133,14 @@ class WebhookTest {
     this.attributes.use_dedicated_ips = value
   }
 
-
   save = async () => {
-      if (this.attributes['id']) {
-        throw new errors.NotImplementedError('The WebhookTest object doesn\'t support updates.')
-      } else {
-        const newObject = await WebhookTest.create(this.attributes, this.options)
-        this.attributes = { ...newObject.attributes }
-        return true
-      }
+    if (this.attributes.id) {
+      throw new errors.NotImplementedError('The WebhookTest object doesn\'t support updates.')
+    } else {
+      const newObject = await WebhookTest.create(this.attributes, this.options)
+      this.attributes = { ...newObject.attributes }
+      return true
+    }
   }
 
   // Parameters:
@@ -152,37 +155,36 @@ class WebhookTest {
   //   action - string - action for test body
   //   use_dedicated_ips - boolean - Use dedicated IPs for sending the webhook?
   static create = async (params = {}, options = {}) => {
-    if (!params['url']) {
+    if (!params.url) {
       throw new errors.MissingParameterError('Parameter missing: url')
     }
 
-    if (params['url'] && !isString(params['url'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: url must be of type String, received ${getType(params['url'])}`)
+    if (params.url && !isString(params.url)) {
+      throw new errors.InvalidParameterError(`Bad parameter: url must be of type String, received ${getType(params.url)}`)
     }
 
-    if (params['method'] && !isString(params['method'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: method must be of type String, received ${getType(params['method'])}`)
+    if (params.method && !isString(params.method)) {
+      throw new errors.InvalidParameterError(`Bad parameter: method must be of type String, received ${getType(params.method)}`)
     }
 
-    if (params['encoding'] && !isString(params['encoding'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: encoding must be of type String, received ${getType(params['encoding'])}`)
+    if (params.encoding && !isString(params.encoding)) {
+      throw new errors.InvalidParameterError(`Bad parameter: encoding must be of type String, received ${getType(params.encoding)}`)
     }
 
-    if (params['raw_body'] && !isString(params['raw_body'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: raw_body must be of type String, received ${getType(params['raw_body'])}`)
+    if (params.raw_body && !isString(params.raw_body)) {
+      throw new errors.InvalidParameterError(`Bad parameter: raw_body must be of type String, received ${getType(params.raw_body)}`)
     }
 
-    if (params['file_form_field'] && !isString(params['file_form_field'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: file_form_field must be of type String, received ${getType(params['file_form_field'])}`)
+    if (params.file_form_field && !isString(params.file_form_field)) {
+      throw new errors.InvalidParameterError(`Bad parameter: file_form_field must be of type String, received ${getType(params.file_form_field)}`)
     }
 
-    if (params['action'] && !isString(params['action'])) {
-      throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params['action'])}`)
+    if (params.action && !isString(params.action)) {
+      throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
     }
 
-    const response = await Api.sendRequest(`/webhook_tests`, 'POST', params, options)
+    const response = await Api.sendRequest('/webhook_tests', 'POST', params, options)
 
-    
     return new WebhookTest(response?.data, options)
   }
 }

package/test/Api.test.js

@@ -0,0 +1,163 @@
+import nock from 'nock'
+
+import {
+  FilesError,
+  NotAuthenticated_LockoutRegionMismatchError,
+  NotFound_FolderNotFoundError,
+} from '../lib/Errors'
+import Files from '../lib/Files'
+import ApiKey from '../lib/models/ApiKey'
+import Folder from '../lib/models/Folder'
+
+const API_URL = 'http://example.test'
+Files.setBaseUrl(API_URL)
+Files.setApiKey('test-key')
+
+describe('API client', () => {
+  it('lists API keys', () => {
+    const params = { user_id: 1 }
+    nock(API_URL)
+      .get('/api/rest/v1/api_keys')
+      .query(params)
+      .reply(200, [{
+        id: 1,
+        name: 'test1',
+      }, {
+        id: 2,
+        name: 'test2',
+      }])
+
+    return ApiKey.list(params)
+      .then(items => {
+        expect(items.length).toBe(2)
+        expect(items[0].name).toBe('test1')
+        expect(items[0].id).toBe(1)
+        expect(items[1].name).toBe('test2')
+        expect(items[1].id).toBe(2)
+      })
+  })
+
+  it('creates an API key', () => {
+    nock(API_URL)
+      .post('/api/rest/v1/api_keys')
+      .reply(201, {
+        id: 123,
+        name: 'testing',
+      })
+
+    return ApiKey.create({ name: 'testing' })
+      .then(apiKey => {
+        expect(apiKey.name).toBe('testing')
+        expect(apiKey.id).toBe(123)
+      })
+  })
+
+  it('updates an API key', () => {
+    nock(API_URL)
+      .patch('/api/rest/v1/api_keys/123', {
+        id: 123,
+        name: 'testing123',
+      })
+      .reply(200, {
+        id: 123,
+        name: 'testing123',
+      })
+
+    const apiKey = new ApiKey({ id: 123 })
+    apiKey.setName('testing123')
+    return apiKey.save()
+      .then(() => {
+        expect(apiKey.getName()).toBe('testing123')
+        expect(apiKey.getId()).toBe(123)
+      })
+  })
+
+  it('deletes an API key', () => {
+    nock(API_URL)
+      .delete('/api/rest/v1/api_keys/123')
+      .reply(204)
+
+    const apiKey = new ApiKey({ id: 123 })
+    return apiKey.delete()
+  })
+
+  it('handles empty response', () => {
+    const params = { user_id: 1 }
+    nock(API_URL)
+      .get('/api/rest/v1/api_keys')
+      .query(params)
+      .reply(200, [])
+
+    return ApiKey.list(params)
+      .then(items => {
+        expect(items.length).toBe(0)
+      })
+  })
+
+  it('handles not found', () => {
+    nock(API_URL)
+      .get('/api/rest/v1/folders/missing')
+      .query(true)
+      .reply(404, {
+        error: 'Folder missing not found.',
+        'http-code': 404,
+        title: 'Folder Not Found',
+        type: 'not-found/folder-not-found',
+      })
+
+    return Folder.listFor('missing')
+      .then(() => {
+        throw new Error('Missing folder did not throw an error')
+      })
+      .catch(error => {
+        expect(error).toBeInstanceOf(NotFound_FolderNotFoundError)
+        expect(error.error).toBe('Folder missing not found.')
+        expect(error.httpCode).toBe(404)
+        expect(error.title).toBe('Folder Not Found')
+        expect(error.type).toBe('not-found/folder-not-found')
+      })
+  })
+
+  it('handles bad gateway', () => {
+    nock(API_URL)
+      .get('/api/rest/v1/api_keys')
+      .reply(502, '<html><head><title>502 Bad Gateway</title></head><body><center><h1>502 Bad Gateway</h1></center><hr><center>files.com</center></body></html>')
+
+    return ApiKey.list()
+      .then(() => {
+        throw new Error('Missing folder did not throw an error')
+      })
+      .catch(error => {
+        expect(error).toBeInstanceOf(FilesError)
+        expect(error.code).toBe(502)
+      })
+  })
+
+  it('handles region mismatch', () => {
+    nock(API_URL)
+      .get('/api/rest/v1/folders/test')
+      .query(true)
+      .reply(401, {
+        data: {
+          host: 'test.host',
+        },
+        error: 'Your account must login using a different server, test.host.',
+        'http-code': 401,
+        title: 'Lockout Region Mismatch',
+        type: 'not-authenticated/lockout-region-mismatch',
+      })
+
+    return Folder.listFor('test')
+      .then(() => {
+        throw new Error('Missing folder did not throw an error')
+      })
+      .catch(error => {
+        expect(error).toBeInstanceOf(NotAuthenticated_LockoutRegionMismatchError)
+        expect(error.error).toBe('Your account must login using a different server, test.host.')
+        expect(error.httpCode).toBe(401)
+        expect(error.title).toBe('Lockout Region Mismatch')
+        expect(error.type).toBe('not-authenticated/lockout-region-mismatch')
+        expect(error.data.host).toBe('test.host')
+      })
+  })
+})

package/test/{package.json → integration/package.json}

@@ -7,7 +7,7 @@
   "license": "ISC",
   "dependencies": {
     "@babel/runtime": "^7.10.3",
-    "files.com": "file:../",
+    "files.com": "file:../../",
     "readable-stream": "^3.6.0",
     "tiny-invariant": "^1.3.1"
   },

package/test/{src → integration/src}/index.js

@@ -71,7 +71,7 @@ const testSuite = async () => {
   }
 
   const testUploadAndDownloadToFile = async () => {
-    const sourceFilePath = '../files.com-logo.png'
+    const sourceFilePath = '../../files.com-logo.png'
 
     const displayName = `files.com-logo__${nonce}.png`
     const destinationPath = `${SDK_TEST_ROOT_FOLDER}/${displayName}`

package/test.sh

@@ -7,5 +7,6 @@ cd "$(dirname "$0")"
 
 # Install dependencies
 npm install
-npm run lint
+npm run lint && \
+npm run build && \
 npm run test