node-appwrite 9.0.0 → 10.0.1

package/lib/services/functions.js

@@ -26,7 +26,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async list(queries, search) {
-        let path = '/functions';
+        const apiPath = '/functions';
         let payload = {};
 
         if (typeof queries !== 'undefined') {
@@ -37,7 +37,7 @@ class Functions extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -57,11 +57,23 @@ class Functions extends Service {
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
+     * @param {string} templateRepository
+     * @param {string} templateOwner
+     * @param {string} templateRootDirectory
+     * @param {string} templateBranch
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async create(functionId, name, runtime, execute, events, schedule, timeout, enabled) {
-        let path = '/functions';
+    async create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateBranch) {
+        const apiPath = '/functions';
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -84,14 +96,14 @@ class Functions extends Service {
             payload['name'] = name;
         }
 
-        if (typeof execute !== 'undefined') {
-            payload['execute'] = execute;
-        }
-
         if (typeof runtime !== 'undefined') {
             payload['runtime'] = runtime;
         }
 
+        if (typeof execute !== 'undefined') {
+            payload['execute'] = execute;
+        }
+
         if (typeof events !== 'undefined') {
             payload['events'] = events;
         }
@@ -108,7 +120,55 @@ class Functions extends Service {
             payload['enabled'] = enabled;
         }
 
-        return await this.client.call('post', path, {
+        if (typeof logging !== 'undefined') {
+            payload['logging'] = logging;
+        }
+
+        if (typeof entrypoint !== 'undefined') {
+            payload['entrypoint'] = entrypoint;
+        }
+
+        if (typeof commands !== 'undefined') {
+            payload['commands'] = commands;
+        }
+
+        if (typeof installationId !== 'undefined') {
+            payload['installationId'] = installationId;
+        }
+
+        if (typeof providerRepositoryId !== 'undefined') {
+            payload['providerRepositoryId'] = providerRepositoryId;
+        }
+
+        if (typeof providerBranch !== 'undefined') {
+            payload['providerBranch'] = providerBranch;
+        }
+
+        if (typeof providerSilentMode !== 'undefined') {
+            payload['providerSilentMode'] = providerSilentMode;
+        }
+
+        if (typeof providerRootDirectory !== 'undefined') {
+            payload['providerRootDirectory'] = providerRootDirectory;
+        }
+
+        if (typeof templateRepository !== 'undefined') {
+            payload['templateRepository'] = templateRepository;
+        }
+
+        if (typeof templateOwner !== 'undefined') {
+            payload['templateOwner'] = templateOwner;
+        }
+
+        if (typeof templateRootDirectory !== 'undefined') {
+            payload['templateRootDirectory'] = templateRootDirectory;
+        }
+
+        if (typeof templateBranch !== 'undefined') {
+            payload['templateBranch'] = templateBranch;
+        }
+
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -122,10 +182,10 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async listRuntimes() {
-        let path = '/functions/runtimes';
+        const apiPath = '/functions/runtimes';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -140,14 +200,14 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async get(functionId) {
-        let path = '/functions/{functionId}'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -159,16 +219,25 @@ class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
+     * @param {string} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async update(functionId, name, execute, events, schedule, timeout, enabled) {
-        let path = '/functions/{functionId}'.replace('{functionId}', functionId);
+    async update(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory) {
+        const apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -178,11 +247,19 @@ class Functions extends Service {
             throw new AppwriteException('Missing required parameter: "name"');
         }
 
+        if (typeof runtime === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "runtime"');
+        }
+
 
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
 
+        if (typeof runtime !== 'undefined') {
+            payload['runtime'] = runtime;
+        }
+
         if (typeof execute !== 'undefined') {
             payload['execute'] = execute;
         }
@@ -203,7 +280,39 @@ class Functions extends Service {
             payload['enabled'] = enabled;
         }
 
-        return await this.client.call('put', path, {
+        if (typeof logging !== 'undefined') {
+            payload['logging'] = logging;
+        }
+
+        if (typeof entrypoint !== 'undefined') {
+            payload['entrypoint'] = entrypoint;
+        }
+
+        if (typeof commands !== 'undefined') {
+            payload['commands'] = commands;
+        }
+
+        if (typeof installationId !== 'undefined') {
+            payload['installationId'] = installationId;
+        }
+
+        if (typeof providerRepositoryId !== 'undefined') {
+            payload['providerRepositoryId'] = providerRepositoryId;
+        }
+
+        if (typeof providerBranch !== 'undefined') {
+            payload['providerBranch'] = providerBranch;
+        }
+
+        if (typeof providerSilentMode !== 'undefined') {
+            payload['providerSilentMode'] = providerSilentMode;
+        }
+
+        if (typeof providerRootDirectory !== 'undefined') {
+            payload['providerRootDirectory'] = providerRootDirectory;
+        }
+
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -218,14 +327,14 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async delete(functionId) {
-        let path = '/functions/{functionId}'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -243,7 +352,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async listDeployments(functionId, queries, search) {
-        let path = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -258,7 +367,7 @@ class Functions extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -275,26 +384,23 @@ class Functions extends Service {
      * 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.
+     * Use the "command" param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
-     * @param {string} entrypoint
      * @param {InputFile} code
      * @param {boolean} activate
+     * @param {string} entrypoint
+     * @param {string} commands
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createDeployment(functionId, entrypoint, code, activate, onProgress = () => {}) {
-        let path = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
+    async createDeployment(functionId, code, activate, entrypoint, commands, onProgress = () => {}) {
+        const apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
-        if (typeof entrypoint === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "entrypoint"');
-        }
-
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -308,6 +414,10 @@ class Functions extends Service {
             payload['entrypoint'] = entrypoint;
         }
 
+        if (typeof commands !== 'undefined') {
+            payload['commands'] = commands;
+        }
+
         if (typeof code !== 'undefined') {
             payload['code'] = code;
         }
@@ -318,7 +428,7 @@ class Functions extends Service {
 
         const size = code.size;
 
-        const headers = {
+        const apiHeaders = {
             'content-type': 'multipart/form-data',
         };
 
@@ -340,20 +450,24 @@ class Functions extends Service {
             }
             
             const start = currentChunkStart;
-            const end = Math.min(((start + client.CHUNK_SIZE) - 1), size);
+            const end = currentChunkStart + currentChunkSize - 1;
 
             if(!lastUpload || currentChunkStart !== 0) {
-                headers['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
+                apiHeaders['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
             }
 
             if (id) {
-                headers['x-appwrite-id'] = id;
+                apiHeaders['x-appwrite-id'] = id;
             }
 
-            const stream = Stream.Readable.from(currentChunk);
-            payload['code'] = { type: 'file', file: stream, filename: code.filename };
+            payload['code'] = {
+                type: 'file',
+                file: currentChunk,
+                filename: code.filename,
+                size: currentChunkSize
+            };
 
-            response = await selfClient.call('post', path, headers, payload);
+            response = await selfClient.call('post', apiPath, apiHeaders, payload);
 
             if (!id) {
                 id = response['$id'];
@@ -392,6 +506,7 @@ class Functions extends Service {
                         if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
                             // Upload chunk
                             currentChunk = Buffer.concat([currentChunk, chunk]);
+                            currentChunkSize = Buffer.byteLength(currentChunk);
                             await uploadChunk();
                             currentChunk = Buffer.from('');
                             currentChunkSize = 0;
@@ -449,7 +564,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async getDeployment(functionId, deploymentId) {
-        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -460,7 +575,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -478,7 +593,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async updateDeployment(functionId, deploymentId) {
-        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -489,7 +604,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -505,7 +620,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async deleteDeployment(functionId, deploymentId) {
-        let path = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -516,7 +631,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -524,6 +639,9 @@ class Functions extends Service {
     /**
      * Create Build
      *
+     * Create a new build for an Appwrite Function deployment. This endpoint can
+     * be used to retry a failed build.
+     *
      * @param {string} functionId
      * @param {string} deploymentId
      * @param {string} buildId
@@ -531,7 +649,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async createBuild(functionId, deploymentId, buildId) {
-        let path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -546,11 +664,36 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
+    /**
+     * Download Deployment
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async downloadDeployment(functionId, deploymentId) {
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        let payload = {};
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
+        }
+
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
+        }
+
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload, 'arraybuffer');
+    }
+
     /**
      * List Executions
      *
@@ -564,7 +707,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async listExecutions(functionId, queries, search) {
-        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -579,7 +722,7 @@ class Functions extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -593,28 +736,43 @@ class Functions extends Service {
      * function execution process will start asynchronously.
      *
      * @param {string} functionId
-     * @param {string} data
+     * @param {string} body
      * @param {boolean} async
+     * @param {string} xpath
+     * @param {string} method
+     * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createExecution(functionId, data, async) {
-        let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
+    async createExecution(functionId, body, async, xpath, method, headers) {
+        const apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
 
-        if (typeof data !== 'undefined') {
-            payload['data'] = data;
+        if (typeof body !== 'undefined') {
+            payload['body'] = body;
         }
 
         if (typeof async !== 'undefined') {
             payload['async'] = async;
         }
 
-        return await this.client.call('post', path, {
+        if (typeof xpath !== 'undefined') {
+            payload['path'] = xpath;
+        }
+
+        if (typeof method !== 'undefined') {
+            payload['method'] = method;
+        }
+
+        if (typeof headers !== 'undefined') {
+            payload['headers'] = headers;
+        }
+
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -630,7 +788,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async getExecution(functionId, executionId) {
-        let path = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
+        const apiPath = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -641,7 +799,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -656,14 +814,14 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async listVariables(functionId) {
-        let path = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -671,8 +829,8 @@ class Functions extends Service {
     /**
      * Create Variable
      *
-     * Create a new function variable. These variables can be accessed within
-     * function in the `env` object under the request variable.
+     * Create a new function environment variable. These variables can be accessed
+     * in the function at runtime as environment variables.
      *
      * @param {string} functionId
      * @param {string} key
@@ -681,7 +839,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async createVariable(functionId, key, value) {
-        let path = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
+        const apiPath = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -704,7 +862,7 @@ class Functions extends Service {
             payload['value'] = value;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -720,7 +878,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async getVariable(functionId, variableId) {
-        let path = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
+        const apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -731,7 +889,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -749,7 +907,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async updateVariable(functionId, variableId, key, value) {
-        let path = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
+        const apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -772,7 +930,7 @@ class Functions extends Service {
             payload['value'] = value;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -788,7 +946,7 @@ class Functions extends Service {
      * @returns {Promise}
      */
     async deleteVariable(functionId, variableId) {
-        let path = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
+        const apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
         let payload = {};
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
@@ -799,7 +957,7 @@ class Functions extends Service {
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }