appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/functions.js

@@ -9,429 +9,466 @@ const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
+const { File } = require('undici');
+const { ReadableStream } = require('stream/web');
+
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const functions = new Command("functions").description(commandDescriptions['functions']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @typedef {Object} FunctionsListRequestParams
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsListRequestParams} params
+ */
 const functionsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions';
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsCreateRequestParams
+ * @property {string} functionId Function ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} name Function name. Max length: 128 chars.
+ * @property {string} runtime Execution runtime.
+ * @property {string[]} execute An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
+ * @property {string[]} events Events list. Maximum of 100 events are allowed.
+ * @property {string} schedule Schedule CRON syntax.
+ * @property {number} timeout Function maximum execution time in seconds.
+ * @property {boolean} enabled Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
+ * @property {boolean} logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
+ * @property {string} entrypoint Entrypoint File. This path is relative to the "providerRootDirectory".
+ * @property {string} commands Build Commands.
+ * @property {string} installationId Appwrite Installation ID for VCS (Version Control System) deployment.
+ * @property {string} providerRepositoryId Repository ID of the repo linked to the function.
+ * @property {string} providerBranch Production branch for the repo linked to the function.
+ * @property {boolean} providerSilentMode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
+ * @property {string} providerRootDirectory Path to function code in the linked repo.
+ * @property {string} templateRepository Repository name of the template.
+ * @property {string} templateOwner The name of the owner of the template.
+ * @property {string} templateRootDirectory Path to function code in the template repo.
+ * @property {string} templateBranch Production branch for the repo linked to the function template.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsCreateRequestParams} params
+ */
 const functionsCreate = async ({ functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateBranch, parseOutput = true, sdk = undefined}) => {
-    /* @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 */
-    /* @param {string} templateRepository */
-    /* @param {string} templateOwner */
-    /* @param {string} templateRootDirectory */
-    /* @param {string} templateBranch */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof functionId !== 'undefined') {
         payload['functionId'] = functionId;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
-
-
     if (typeof runtime !== 'undefined') {
         payload['runtime'] = runtime;
     }
-
     execute = execute === true ? [] : execute;
-
     if (typeof execute !== 'undefined') {
         payload['execute'] = execute;
     }
-
     events = events === true ? [] : events;
-
     if (typeof events !== 'undefined') {
         payload['events'] = events;
     }
-
-
     if (typeof schedule !== 'undefined') {
         payload['schedule'] = schedule;
     }
-
-
     if (typeof timeout !== 'undefined') {
         payload['timeout'] = timeout;
     }
-
-
     if (typeof enabled !== 'undefined') {
         payload['enabled'] = enabled;
     }
-
-
     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;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const functionsListRuntimes = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} FunctionsListRuntimesRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {FunctionsListRuntimesRequestParams} params
+ */
+const functionsListRuntimes = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/runtimes';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const functionsGetUsage = async ({ range, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} range */
+/**
+ * @typedef {Object} FunctionsGetUsageRequestParams
+ * @property {string} range Date range.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {FunctionsGetUsageRequestParams} params
+ */
+const functionsGetUsage = async ({ range, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/usage';
     let payload = {};
-
-    /** Query Params */
     if (typeof range !== 'undefined') {
         payload['range'] = range;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const functionsGet = async ({ functionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
+/**
+ * @typedef {Object} FunctionsGetRequestParams
+ * @property {string} functionId Function ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {FunctionsGetRequestParams} params
+ */
+const functionsGet = async ({ functionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsUpdateRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} name Function name. Max length: 128 chars.
+ * @property {string} runtime Execution runtime.
+ * @property {string[]} execute An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
+ * @property {string[]} events Events list. Maximum of 100 events are allowed.
+ * @property {string} schedule Schedule CRON syntax.
+ * @property {number} timeout Maximum execution time in seconds.
+ * @property {boolean} enabled Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
+ * @property {boolean} logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
+ * @property {string} entrypoint Entrypoint File. This path is relative to the "providerRootDirectory".
+ * @property {string} commands Build Commands.
+ * @property {string} installationId Appwrite Installation ID for VCS (Version Controle System) deployment.
+ * @property {string} providerRepositoryId Repository ID of the repo linked to the function
+ * @property {string} providerBranch Production branch for the repo linked to the function
+ * @property {boolean} providerSilentMode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
+ * @property {string} providerRootDirectory Path to function code in the linked repo.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsUpdateRequestParams} params
+ */
 const functionsUpdate = async ({ functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, parseOutput = true, sdk = undefined}) => {
-    /* @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 */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
-
-
     if (typeof runtime !== 'undefined') {
         payload['runtime'] = runtime;
     }
-
     execute = execute === true ? [] : execute;
-
     if (typeof execute !== 'undefined') {
         payload['execute'] = execute;
     }
-
     events = events === true ? [] : events;
-
     if (typeof events !== 'undefined') {
         payload['events'] = events;
     }
-
-
     if (typeof schedule !== 'undefined') {
         payload['schedule'] = schedule;
     }
-
-
     if (typeof timeout !== 'undefined') {
         payload['timeout'] = timeout;
     }
-
-
     if (typeof enabled !== 'undefined') {
         payload['enabled'] = enabled;
     }
-
-
     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;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const functionsDelete = async ({ functionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
+/**
+ * @typedef {Object} FunctionsDeleteRequestParams
+ * @property {string} functionId Function ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {FunctionsDeleteRequestParams} params
+ */
+const functionsDelete = async ({ functionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsListDeploymentsRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsListDeploymentsRequestParams} params
+ */
 const functionsListDeployments = async ({ functionId, queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsCreateDeploymentRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} code Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
+ * @property {boolean} activate Automatically activate the deployment when it is finished building.
+ * @property {string} entrypoint Entrypoint File.
+ * @property {string} commands Build Commands.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ * @property {CallableFunction} onProgress
+ */
+
+/**
+ * @param {FunctionsCreateDeploymentRequestParams} params
+ */
 const functionsCreateDeployment = async ({ functionId, code, activate, entrypoint, commands, parseOutput = true, sdk = undefined, onProgress = () => {}}) => {
-    /* @param {string} functionId */
-    /* @param {InputFile} code */
-    /* @param {boolean} activate */
-    /* @param {string} entrypoint */
-    /* @param {string} commands */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof entrypoint !== 'undefined') {
         payload['entrypoint'] = entrypoint;
     }
-
-
     if (typeof commands !== 'undefined') {
         payload['commands'] = commands;
     }
-
-    let folderPath = fs.realpathSync(code);
-    if (!fs.lstatSync(folderPath).isDirectory())
+    const folderPath = fs.realpathSync(code);
+    if (!fs.lstatSync(folderPath).isDirectory()) {
         throw new Error('The path is not a directory.');
+    }
     
     const ignorer = ignore();
 
     const func = localConfig.getFunction(functionId);
 
-    if(func.ignore) {
+    if (func.ignore) {
         ignorer.add(func.ignore);
         log('Ignoring files using configuration from appwrite.json');
-    } else if(fs.existsSync(pathLib.join(code, '.gitignore'))) {
+    } else if (fs.existsSync(pathLib.join(code, '.gitignore'))) {
         ignorer.add(fs.readFileSync(pathLib.join(code, '.gitignore')).toString());
         log('Ignoring files in .gitignore');
     }
@@ -445,156 +482,250 @@ const functionsCreateDeployment = async ({ functionId, code, activate, entrypoin
             cwd: folderPath,
             file: 'code.tar.gz'
         }, files);
+
     let archivePath = fs.realpathSync('code.tar.gz')
     if (typeof archivePath !== 'undefined') {
         payload['code'] = archivePath;
-        code = archivePath;
+       code = archivePath;
     }
 
+    const filePath = fs.realpathSync(code);
+    const nodeStream = fs.createReadStream(filePath);
+    const stream = convertReadStreamToReadableStream(nodeStream);
 
+    if (typeof filePath !== 'undefined') {
+        code = { type: 'file', stream, filename: pathLib.basename(filePath), size: fs.statSync(filePath).size };
+        payload['code'] = code
+    }
     if (typeof activate !== 'undefined') {
-        payload['activate'] = activate.toString();
+        payload['activate'] = activate;
     }
 
+    const size = code.size;
+    
+    const apiHeaders = {
+        'content-type': 'multipart/form-data',
+    };
+
+    let id = undefined;
     let response = undefined;
-    const { size: size } = await promisify(fs.stat)(code);
 
-    if (size <= libClient.CHUNK_SIZE) {
-        payload['code'] = fs.createReadStream(payload['code']);
+    let chunksUploaded = 0;
 
-        response = await client.call('post', apiPath, {
-            'content-type': 'multipart/form-data',
-        }, payload).catch(err => {
-            fs.unlinkSync(archivePath);
-            throw err
-        });
-    } else {
-        const streamFilePath = payload['code'];
+    let currentChunk = 1;
+    let currentPosition = 0;
+    let uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
 
-        const apiHeaders = {
-            'content-type': 'multipart/form-data',
-        };
+    const uploadChunk = async (lastUpload = false) => {
+        if(currentChunk <= chunksUploaded) {
+            return;
+        }
 
-        let offset = 0;
+        const start = ((currentChunk - 1) * client.CHUNK_SIZE);
+        let end = start + currentPosition - 1;
 
-        while (offset < size) {
-            let end = Math.min(offset + libClient.CHUNK_SIZE - 1, size - 1);
+        if(!lastUpload || currentChunk !== 1) {
+            apiHeaders['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
+        }
 
-            apiHeaders['content-range'] = 'bytes ' + offset + '-' + end + '/' + size;
-            if (response && response.$id) {
-                apiHeaders['x-appwrite-id'] = response.$id;
+        let uploadableChunkTrimmed;
+        
+        if(currentPosition + 1 >= client.CHUNK_SIZE) {
+            uploadableChunkTrimmed = uploadableChunk;
+        } else {
+            uploadableChunkTrimmed = new Uint8Array(currentPosition);
+            for(let i = 0; i <= currentPosition; i++) {
+                uploadableChunkTrimmed[i] = uploadableChunk[i];
             }
+        }
 
-            const stream = fs.createReadStream(streamFilePath, {
-                start: offset,
-                end
+        if (id) {
+            apiHeaders['x-appwrite-id'] = id;
+        }
+
+        payload['code'] = { type: 'file', file: new File([uploadableChunkTrimmed], code.filename), filename: code.filename };
+
+        response = await client.call('post', apiPath, apiHeaders, payload);
+
+        if (!id) {
+            id = response['$id'];
+        }
+
+        if (onProgress !== null) {
+            onProgress({
+                $id: response['$id'],
+                progress: Math.min((currentChunk) * client.CHUNK_SIZE, size) / size * 100,
+                sizeUploaded: end+1,
+                chunksTotal: response['chunksTotal'],
+                chunksUploaded: response['chunksUploaded']
             });
-            payload['code'] = stream;
-            response = await client.call('post', apiPath, apiHeaders, payload);
-
-            if (onProgress) {
-                onProgress({
-                    $id: response.$id,
-                    progress: ( offset / size ) * 100,
-                    sizeUploaded: offset,
-                    chunksTotal: response.chunksTotal,
-                    chunksUploaded: response.chunksUploaded
-                });
+        }
+
+        uploadableChunk = new Uint8Array(client.CHUNK_SIZE);
+        currentChunk++;
+        currentPosition = 0;
+    }
+
+    for await (const chunk of code.stream) {
+        for(const b of chunk) {
+            uploadableChunk[currentPosition] = b;
+
+            currentPosition++;
+            if(currentPosition >= client.CHUNK_SIZE) {
+                await uploadChunk();
+                currentPosition = 0;
             }
-            offset += libClient.CHUNK_SIZE;
         }
     }
 
-    fs.unlinkSync(archivePath);
-    
+    if (currentPosition > 0) { // Check if there's any remaining data for the last chunk
+        await uploadChunk(true);
+    }
+
+    fs.unlinkSync(filePath);
+            
     if (parseOutput) {
         parse(response)
         success()
     }
+
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsGetDeploymentRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} deploymentId Deployment ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsGetDeploymentRequestParams} params
+ */
 const functionsGetDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} deploymentId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsUpdateDeploymentRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} deploymentId Deployment ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsUpdateDeploymentRequestParams} params
+ */
 const functionsUpdateDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} deploymentId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsDeleteDeploymentRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} deploymentId Deployment ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsDeleteDeploymentRequestParams} params
+ */
 const functionsDeleteDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} deploymentId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsCreateBuildRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} deploymentId Deployment ID.
+ * @property {string} buildId Build unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsCreateBuildRequestParams} params
+ */
 const functionsCreateBuild = async ({ functionId, deploymentId, buildId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} deploymentId */
-    /* @param {string} buildId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsDownloadDeploymentRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} deploymentId Deployment ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ * @property {string} destination
+ */
+
+/**
+ * @param {FunctionsDownloadDeploymentRequestParams} params
+ */
 const functionsDownloadDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} functionId */
-    /* @param {string} deploymentId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
     let payload = {};
@@ -603,260 +734,335 @@ const functionsDownloadDeployment = async ({ functionId, deploymentId, parseOutp
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
 
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} FunctionsListExecutionsRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsListExecutionsRequestParams} params
+ */
 const functionsListExecutions = async ({ functionId, queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsCreateExecutionRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} body HTTP body of execution. Default value is empty string.
+ * @property {boolean} async Execute code in the background. Default value is false.
+ * @property {string} xpath HTTP path of execution. Path can include query params. Default value is /
+ * @property {string} method HTTP method of execution. Default value is GET.
+ * @property {object} headers HTTP headers of execution. Defaults to empty.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsCreateExecutionRequestParams} params
+ */
 const functionsCreateExecution = async ({ functionId, body, async, xpath, method, headers, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} body */
-    /* @param {boolean} async */
-    /* @param {string} xpath */
-    /* @param {string} method */
-    /* @param {object} headers */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof body !== 'undefined') {
         payload['body'] = body;
     }
-
-
     if (typeof async !== 'undefined') {
         payload['async'] = async;
     }
-
-
     if (typeof xpath !== 'undefined') {
         payload['path'] = xpath;
     }
-
-
     if (typeof method !== 'undefined') {
         payload['method'] = method;
     }
-
     if (typeof headers !== 'undefined') {
         payload['headers'] = JSON.parse(headers);
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsGetExecutionRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} executionId Execution ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsGetExecutionRequestParams} params
+ */
 const functionsGetExecution = async ({ functionId, executionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} executionId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsGetFunctionUsageRequestParams
+ * @property {string} functionId Function ID.
+ * @property {string} range Date range.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsGetFunctionUsageRequestParams} params
+ */
 const functionsGetFunctionUsage = async ({ functionId, range, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} range */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/usage'.replace('{functionId}', functionId);
     let payload = {};
-
-    /** Query Params */
     if (typeof range !== 'undefined') {
         payload['range'] = range;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const functionsListVariables = async ({ functionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
+/**
+ * @typedef {Object} FunctionsListVariablesRequestParams
+ * @property {string} functionId Function unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {FunctionsListVariablesRequestParams} params
+ */
+const functionsListVariables = async ({ functionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsCreateVariableRequestParams
+ * @property {string} functionId Function unique ID.
+ * @property {string} key Variable key. Max length: 255 chars.
+ * @property {string} value Variable value. Max length: 8192 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsCreateVariableRequestParams} params
+ */
 const functionsCreateVariable = async ({ functionId, key, value, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} key */
-    /* @param {string} value */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof key !== 'undefined') {
         payload['key'] = key;
     }
-
-
     if (typeof value !== 'undefined') {
         payload['value'] = value;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsGetVariableRequestParams
+ * @property {string} functionId Function unique ID.
+ * @property {string} variableId Variable unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsGetVariableRequestParams} params
+ */
 const functionsGetVariable = async ({ functionId, variableId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} variableId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsUpdateVariableRequestParams
+ * @property {string} functionId Function unique ID.
+ * @property {string} variableId Variable unique ID.
+ * @property {string} key Variable key. Max length: 255 chars.
+ * @property {string} value Variable value. Max length: 8192 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsUpdateVariableRequestParams} params
+ */
 const functionsUpdateVariable = async ({ functionId, variableId, key, value, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} variableId */
-    /* @param {string} key */
-    /* @param {string} value */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof key !== 'undefined') {
         payload['key'] = key;
     }
-
-
     if (typeof value !== 'undefined') {
         payload['value'] = value;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} FunctionsDeleteVariableRequestParams
+ * @property {string} functionId Function unique ID.
+ * @property {string} variableId Variable unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsDeleteVariableRequestParams} params
+ */
 const functionsDeleteVariable = async ({ functionId, variableId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} functionId */
-    /* @param {string} variableId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 functions
     .command(`list`)
     .description(`Get a list of all the project's functions. You can use the query params to filter your results.`)
@@ -1058,7 +1264,6 @@ functions
     .requiredOption(`--variableId <variableId>`, `Variable unique ID.`)
     .action(actionRunner(functionsDeleteVariable))
 
-
 module.exports = {
     functions,
     functionsList,
@@ -1084,4 +1289,4 @@ module.exports = {
     functionsGetVariable,
     functionsUpdateVariable,
     functionsDeleteVariable
-};
+};