node-appwrite 4.0.1 → 5.1.0

package/lib/client.js

@@ -4,13 +4,14 @@ const FormData = require('form-data');
 const AppwriteException = require('./exception.js');
 
 class Client {
+    static CHUNK_SIZE = 5*1024*1024; // 5MB
     
     constructor() {
         this.endpoint = 'https://HOSTNAME/v1';
         this.headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:nodejs:4.0.1',
-            'X-Appwrite-Response-Format' : '0.12.0',
+            'x-sdk-version': 'appwrite:nodejs:5.1.0',
+            'X-Appwrite-Response-Format' : '0.13.0',
         };
         this.selfSigned = false;
     }
@@ -115,7 +116,8 @@ class Client {
             process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = 0;
         }
 
-        headers = Object.assign(this.headers, headers);
+
+        headers = Object.assign({}, this.headers, headers);
 
         let contentType = headers['content-type'].toLowerCase();
 
@@ -155,9 +157,9 @@ class Client {
             if('response' in error && error.response !== undefined) {
                 if(error.response && 'data' in error.response) {
                     if (typeof(error.response.data) === 'string') {
-                        throw new AppwriteException(error.response.data, error.response.status, error.response.data);
+                        throw new AppwriteException(error.response.data, error.response.status, '', error.response.data);
                     } else {
-                        throw new AppwriteException(error.response.data.message, error.response.status, error.response.data);
+                        throw new AppwriteException(error.response.data.message, error.response.status, error.response.data.type, error.response.data);
                     }
                 } else {
                     throw new AppwriteException(error.response.statusText, error.response.status, error.response.data);

package/lib/exception.js

@@ -1,7 +1,8 @@
 class AppwriteException extends Error {
-  constructor(message, code, response) {
+  constructor(message, code, type, response) {
     super(message);
     this.code = code;
+    this.type = type;
     this.response = response;
   }
 }

package/lib/query.js

@@ -32,3 +32,5 @@ class Query {
       ? `"${value}"`
       : `${value}`;
 }
+
+module.exports = Query;

package/lib/services/account.js

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Account extends Service {
 
@@ -190,8 +193,9 @@ class Account extends Service {
     /**
      * Update Account Preferences
      *
-     * Update currently logged in user account preferences. You can pass only the
-     * specific settings you wish to update.
+     * Update currently logged in user account preferences. The object you pass is
+     * stored as is, and replaces any previous value. The maximum allowed prefs
+     * size is 64kB and throws error if exceeded.
      *
      * @param {object} prefs
      * @throws {AppwriteException}
@@ -376,12 +380,33 @@ class Account extends Service {
         }, payload);
     }
 
+    /**
+     * Update Session (Refresh Tokens)
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updateSession(sessionId) {
+        if (typeof sessionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "sessionId"');
+        }
+
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
+
+        return await this.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Delete Account Session
      *
      * Use this endpoint to log out the currently logged in user from all their
      * account sessions across all of their different devices. When using the
-     * option id argument, only the session unique ID provider will be deleted.
+     * Session ID argument, only the unique session ID provided is deleted.
+     * 
      *
      * @param {string} sessionId
      * @throws {AppwriteException}

package/lib/services/avatars.js

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Avatars extends Service {
 

package/lib/services/database.js

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Database extends Service {
 
@@ -405,9 +408,9 @@ class Database extends Service {
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
-     * @param {string} min
-     * @param {string} max
-     * @param {string} xdefault
+     * @param {number} min
+     * @param {number} max
+     * @param {number} xdefault
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}

package/lib/services/functions.js

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Functions extends Service {
 
@@ -129,7 +132,7 @@ class Functions extends Service {
     /**
      * List the currently active function runtimes.
      *
-     * Get a list of all runtimes that are currently active in your project.
+     * Get a list of all runtimes that are currently active on your instance.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -248,30 +251,33 @@ class Functions extends Service {
     }
 
     /**
-     * List Executions
+     * List Deployments
      *
-     * Get a list of all the current user function execution logs. You can use the
-     * query params to filter your results. On admin mode, this endpoint will
-     * return a list of all of the project's executions. [Learn more about
-     * different API modes](/docs/admin).
+     * Get a list of all the project's code deployments. You can use the query
+     * params to filter your results.
      *
      * @param {string} functionId
+     * @param {string} search
      * @param {number} limit
      * @param {number} offset
-     * @param {string} search
      * @param {string} cursor
      * @param {string} cursorDirection
+     * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listExecutions(functionId, limit, offset, search, cursor, cursorDirection) {
+    async listDeployments(functionId, search, limit, offset, cursor, cursorDirection, orderType) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+        let path = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
         let payload = {};
 
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
+
         if (typeof limit !== 'undefined') {
             payload['limit'] = limit;
         }
@@ -280,10 +286,6 @@ class Functions extends Service {
             payload['offset'] = offset;
         }
 
-        if (typeof search !== 'undefined') {
-            payload['search'] = search;
-        }
-
         if (typeof cursor !== 'undefined') {
             payload['cursor'] = cursor;
         }
@@ -292,61 +294,145 @@ class Functions extends Service {
             payload['cursorDirection'] = cursorDirection;
         }
 
+        if (typeof orderType !== 'undefined') {
+            payload['orderType'] = orderType;
+        }
+
         return await this.client.call('get', path, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Create Execution
+     * Create Deployment
      *
-     * Trigger a function execution. The returned object will return you the
-     * current execution status. You can ping the `Get Execution` endpoint to get
-     * updates on the current execution status. Once this endpoint is called, your
-     * function execution process will start asynchronously.
+     * Create a new function code deployment. Use this endpoint to upload a new
+     * version of your code function. To execute your newly uploaded code, you'll
+     * need to update the function's deployment to use your new deployment UID.
+     * 
+     * This endpoint accepts a tar.gz file compressed with your code. Make sure to
+     * include any dependencies your code has within the compressed file. You can
+     * learn more about code packaging in the [Appwrite Cloud Functions
+     * tutorial](/docs/functions).
+     * 
+     * Use the "command" param to set the entry point used to execute your code.
      *
      * @param {string} functionId
-     * @param {string} data
+     * @param {string} entrypoint
+     * @param {string} code
+     * @param {boolean} activate
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createExecution(functionId, data) {
+    async createDeployment(functionId, entrypoint, code, activate, onProgress = () => {}) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+        if (typeof entrypoint === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "entrypoint"');
+        }
+
+        if (typeof code === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "code"');
+        }
+
+        if (typeof activate === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "activate"');
+        }
+
+        let path = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
         let payload = {};
 
-        if (typeof data !== 'undefined') {
-            payload['data'] = data;
+        if (typeof entrypoint !== 'undefined') {
+            payload['entrypoint'] = entrypoint;
         }
 
-        return await this.client.call('post', path, {
-            'content-type': 'application/json',
-        }, payload);
+        if (typeof code !== 'undefined') {
+            payload['code'] = code.toString();
+        }
+
+        if (typeof activate !== 'undefined') {
+            payload['activate'] = activate.toString();
+        }
+
+        const { size: size } = await promisify(fs.stat)(code);
+
+        if (size <= client.CHUNK_SIZE) {
+            payload['code'] = fs.createReadStream(code);
+                
+            return await this.client.call('post', path, {
+                'content-type': 'multipart/form-data',
+            }, payload);
+        } else {
+            let id = undefined;
+            let response = undefined;
+
+            let counter = 0;
+            const totalCounters = Math.ceil(size / client.CHUNK_SIZE);
+
+            const headers = {
+                'content-type': 'multipart/form-data',
+            };
+
+
+            for (counter; counter < totalCounters; counter++) {
+                const start = (counter * client.CHUNK_SIZE);
+                const end = Math.min((((counter * client.CHUNK_SIZE) + client.CHUNK_SIZE) - 1), size);
+
+                headers['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
+
+                if (id) {
+                    headers['x-appwrite-id'] = id;
+                }
+
+                const stream = fs.createReadStream(code, {
+                    start,
+                    end
+                });
+                payload['code'] = stream;
+
+                response = await this.client.call('post', path, headers, payload);
+
+                if (!id) {
+                    id = response['$id'];
+                }
+                
+                if (onProgress !== null) {
+                    onProgress({
+                        $id: response['$id'],
+                        progress: Math.min((counter+1) * client.CHUNK_SIZE, size) / size * 100,
+                        sizeUploaded: end+1,
+                        chunksTotal: response['chunksTotal'],
+                        chunksUploaded: response['chunksUploaded']
+                    });
+                }
+            }
+
+            return response;
+        }
     }
 
     /**
-     * Get Execution
+     * Get Deployment
      *
-     * Get a function execution log by its unique ID.
+     * Get a code deployment by its unique ID.
      *
      * @param {string} functionId
-     * @param {string} executionId
+     * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getExecution(functionId, executionId) {
+    async getDeployment(functionId, deploymentId) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof executionId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "executionId"');
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
 
-        let path = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
+        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -355,190 +441,199 @@ class Functions extends Service {
     }
 
     /**
-     * Update Function Tag
+     * Update Function Deployment
      *
-     * Update the function code tag ID using the unique function ID. Use this
-     * endpoint to switch the code tag that should be executed by the execution
-     * endpoint.
+     * Update the function code deployment ID using the unique function ID. Use
+     * this endpoint to switch the code deployment that should be executed by the
+     * execution endpoint.
      *
      * @param {string} functionId
-     * @param {string} tag
+     * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateTag(functionId, tag) {
+    async updateDeployment(functionId, deploymentId) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof tag === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "tag"');
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
 
-        let path = '/functions/{functionId}/tag'.replace('{functionId}', functionId);
+        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         let payload = {};
 
-        if (typeof tag !== 'undefined') {
-            payload['tag'] = tag;
-        }
-
         return await this.client.call('patch', path, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Tags
+     * Delete Deployment
      *
-     * Get a list of all the project's code tags. You can use the query params to
-     * filter your results.
+     * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
-     * @param {string} search
-     * @param {number} limit
-     * @param {number} offset
-     * @param {string} cursor
-     * @param {string} cursorDirection
-     * @param {string} orderType
+     * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listTags(functionId, search, limit, offset, cursor, cursorDirection, orderType) {
+    async deleteDeployment(functionId, deploymentId) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        let path = '/functions/{functionId}/tags'.replace('{functionId}', functionId);
-        let payload = {};
-
-        if (typeof search !== 'undefined') {
-            payload['search'] = search;
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
 
-        if (typeof limit !== 'undefined') {
-            payload['limit'] = limit;
-        }
+        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        let payload = {};
 
-        if (typeof offset !== 'undefined') {
-            payload['offset'] = offset;
-        }
+        return await this.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
 
-        if (typeof cursor !== 'undefined') {
-            payload['cursor'] = cursor;
+    /**
+     * Retry Build
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @param {string} buildId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async retryBuild(functionId, deploymentId, buildId) {
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof cursorDirection !== 'undefined') {
-            payload['cursorDirection'] = cursorDirection;
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
 
-        if (typeof orderType !== 'undefined') {
-            payload['orderType'] = orderType;
+        if (typeof buildId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "buildId"');
         }
 
-        return await this.client.call('get', path, {
+        let path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
+        let payload = {};
+
+        return await this.client.call('post', path, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Create Tag
+     * List Executions
      *
-     * Create a new function code tag. Use this endpoint to upload a new version
-     * of your code function. To execute your newly uploaded code, you'll need to
-     * update the function's tag to use your new tag UID.
-     * 
-     * This endpoint accepts a tar.gz file compressed with your code. Make sure to
-     * include any dependencies your code has within the compressed file. You can
-     * learn more about code packaging in the [Appwrite Cloud Functions
-     * tutorial](/docs/functions).
-     * 
-     * Use the "command" param to set the entry point used to execute your code.
+     * Get a list of all the current user function execution logs. You can use the
+     * query params to filter your results. On admin mode, this endpoint will
+     * return a list of all of the project's executions. [Learn more about
+     * different API modes](/docs/admin).
      *
      * @param {string} functionId
-     * @param {string} command
-     * @param {File} code
+     * @param {number} limit
+     * @param {number} offset
+     * @param {string} search
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createTag(functionId, command, code) {
+    async listExecutions(functionId, limit, offset, search, cursor, cursorDirection) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof command === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "command"');
+        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+        let payload = {};
+
+        if (typeof limit !== 'undefined') {
+            payload['limit'] = limit;
         }
 
-        if (typeof code === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "code"');
+        if (typeof offset !== 'undefined') {
+            payload['offset'] = offset;
         }
 
-        let path = '/functions/{functionId}/tags'.replace('{functionId}', functionId);
-        let payload = {};
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
 
-        if (typeof command !== 'undefined') {
-            payload['command'] = command;
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
         }
 
-        if (typeof code !== 'undefined') {
-            payload['code'] = code;
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
         }
 
-        return await this.client.call('post', path, {
-            'content-type': 'multipart/form-data',
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Tag
+     * Create Execution
      *
-     * Get a code tag by its unique ID.
+     * Trigger a function execution. The returned object will return you the
+     * current execution status. You can ping the `Get Execution` endpoint to get
+     * updates on the current execution status. Once this endpoint is called, your
+     * function execution process will start asynchronously.
      *
      * @param {string} functionId
-     * @param {string} tagId
+     * @param {string} data
+     * @param {boolean} async
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getTag(functionId, tagId) {
+    async createExecution(functionId, data, async) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof tagId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "tagId"');
+        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+        let payload = {};
+
+        if (typeof data !== 'undefined') {
+            payload['data'] = data;
         }
 
-        let path = '/functions/{functionId}/tags/{tagId}'.replace('{functionId}', functionId).replace('{tagId}', tagId);
-        let payload = {};
+        if (typeof async !== 'undefined') {
+            payload['async'] = async;
+        }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('post', path, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Delete Tag
+     * Get Execution
      *
-     * Delete a code tag by its unique ID.
+     * Get a function execution log by its unique ID.
      *
      * @param {string} functionId
-     * @param {string} tagId
+     * @param {string} executionId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async deleteTag(functionId, tagId) {
+    async getExecution(functionId, executionId) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof tagId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "tagId"');
+        if (typeof executionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "executionId"');
         }
 
-        let path = '/functions/{functionId}/tags/{tagId}'.replace('{functionId}', functionId).replace('{tagId}', tagId);
+        let path = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
         let payload = {};
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('get', path, {
             'content-type': 'application/json',
         }, payload);
     }