appwrite-cli 6.0.0-rc.6 → 6.0.0-rc.7

package/lib/commands/functions.js

@@ -35,7 +35,7 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const functions = new Command("functions").description(commandDescriptions['functions']).configureHelp({
+const functions = new Command("functions").description(commandDescriptions['functions'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
@@ -74,7 +74,6 @@ const functionsList = async ({queries,search,parseOutput = true, overrideForCli
             showConsoleLink('functions', 'list');
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -193,7 +192,6 @@ const functionsCreate = async ({functionId,name,runtime,execute,events,schedule,
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -224,7 +222,91 @@ const functionsListRuntimes = async ({parseOutput = true, overrideForCli = false
 
     if (parseOutput) {
         parse(response)
-        success()
+    }
+
+    return response;
+
+}
+
+/**
+ * @typedef {Object} FunctionsListTemplatesRequestParams
+ * @property {string[]} runtimes List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
+ * @property {string[]} useCases List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
+ * @property {number} limit Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
+ * @property {number} offset Offset the list of returned templates. Maximum offset is 5000.
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsListTemplatesRequestParams} params
+ */
+const functionsListTemplates = async ({runtimes,useCases,limit,offset,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/functions/templates';
+    let payload = {};
+    if (typeof runtimes !== 'undefined') {
+        payload['runtimes'] = runtimes;
+    }
+    if (typeof useCases !== 'undefined') {
+        payload['useCases'] = useCases;
+    }
+    if (typeof limit !== 'undefined') {
+        payload['limit'] = limit;
+    }
+    if (typeof offset !== 'undefined') {
+        payload['offset'] = offset;
+    }
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('functions', 'listTemplates');
+         } else {
+            parse(response)
+        }
+    }
+
+    return response;
+
+}
+
+/**
+ * @typedef {Object} FunctionsGetTemplateRequestParams
+ * @property {string} templateId Template ID.
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsGetTemplateRequestParams} params
+ */
+const functionsGetTemplate = async ({templateId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/functions/templates/{templateId}'.replace('{templateId}', templateId);
+    let payload = {};
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('functions', 'getTemplate', templateId);
+         } else {
+            parse(response)
+        }
     }
 
     return response;
@@ -259,7 +341,6 @@ const functionsGetUsage = async ({range,parseOutput = true, overrideForCli = fal
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -294,7 +375,6 @@ const functionsGet = async ({functionId,parseOutput = true, overrideForCli = fal
             showConsoleLink('functions', 'get', functionId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -394,7 +474,6 @@ const functionsUpdate = async ({functionId,name,runtime,execute,events,schedule,
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -426,7 +505,6 @@ const functionsDelete = async ({functionId,parseOutput = true, overrideForCli =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -469,7 +547,6 @@ const functionsListDeployments = async ({functionId,queries,search,parseOutput =
             showConsoleLink('functions', 'listDeployments', functionId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -523,15 +600,17 @@ const functionsCreateDeployment = async ({functionId,code,activate,entrypoint,co
 
     const files = getAllFiles(code).map((file) => pathLib.relative(code, file)).filter((file) => !ignorer.ignores(file));
 
+    const archiveFileName = `${functionId}-code.tar.gz`;
+
     await tar
         .create({
             gzip: true,
             sync: true,
             cwd: folderPath,
-            file: 'code.tar.gz'
+            file: archiveFileName
         }, files);
 
-    let archivePath = fs.realpathSync('code.tar.gz')
+    let archivePath = fs.realpathSync(archiveFileName)
     if (typeof archivePath !== 'undefined') {
         payload['code'] = archivePath;
        code = archivePath;
@@ -634,7 +713,6 @@ const functionsCreateDeployment = async ({functionId,code,activate,entrypoint,co
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -669,7 +747,6 @@ const functionsGetDeployment = async ({functionId,deploymentId,parseOutput = tru
             showConsoleLink('functions', 'getDeployment', functionId, deploymentId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -703,7 +780,6 @@ const functionsUpdateDeployment = async ({functionId,deploymentId,parseOutput =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -736,7 +812,6 @@ const functionsDeleteDeployment = async ({functionId,deploymentId,parseOutput =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -773,7 +848,6 @@ const functionsCreateBuild = async ({functionId,deploymentId,buildId,parseOutput
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -806,7 +880,6 @@ const functionsUpdateDeploymentBuild = async ({functionId,deploymentId,parseOutp
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -814,7 +887,7 @@ const functionsUpdateDeploymentBuild = async ({functionId,deploymentId,parseOutp
 }
 
 /**
- * @typedef {Object} FunctionsDownloadDeploymentRequestParams
+ * @typedef {Object} FunctionsGetDeploymentDownloadRequestParams
  * @property {string} functionId Function ID.
  * @property {string} deploymentId Deployment ID.
  * @property {boolean} overrideForCli
@@ -824,9 +897,9 @@ const functionsUpdateDeploymentBuild = async ({functionId,deploymentId,parseOutp
  */
 
 /**
- * @param {FunctionsDownloadDeploymentRequestParams} params
+ * @param {FunctionsGetDeploymentDownloadRequestParams} params
  */
-const functionsDownloadDeployment = async ({functionId,deploymentId,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+const functionsGetDeploymentDownload = async ({functionId,deploymentId,parseOutput = true, overrideForCli = false, sdk = undefined, destination, console}) => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
@@ -850,8 +923,11 @@ const functionsDownloadDeployment = async ({functionId,deploymentId,parseOutput
 
     fs.writeFileSync(destination, response);
     if (parseOutput) {
-        parse(response)
-        success()
+        if(console) {
+            showConsoleLink('functions', 'getDeploymentDownload', functionId, deploymentId);
+         } else {
+            parse(response)
+        }
     }
 
     return response;
@@ -894,7 +970,6 @@ const functionsListExecutions = async ({functionId,queries,search,parseOutput =
             showConsoleLink('functions', 'listExecutions', functionId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -951,7 +1026,6 @@ const functionsCreateExecution = async ({functionId,body,async,xpath,method,head
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -987,7 +1061,6 @@ const functionsGetExecution = async ({functionId,executionId,parseOutput = true,
             showConsoleLink('functions', 'getExecution', functionId, executionId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -1021,7 +1094,6 @@ const functionsDeleteExecution = async ({functionId,executionId,parseOutput = tr
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1060,7 +1132,6 @@ const functionsGetFunctionUsage = async ({functionId,range,parseOutput = true, o
             showConsoleLink('functions', 'getFunctionUsage', functionId);
          } else {
             parse(response)
-            success()
         }
     }
 
@@ -1093,7 +1164,6 @@ const functionsListVariables = async ({functionId,parseOutput = true, overrideFo
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1133,7 +1203,6 @@ const functionsCreateVariable = async ({functionId,key,value,parseOutput = true,
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1166,7 +1235,6 @@ const functionsGetVariable = async ({functionId,variableId,parseOutput = true, o
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1207,7 +1275,6 @@ const functionsUpdateVariable = async ({functionId,variableId,key,value,parseOut
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1240,7 +1307,6 @@ const functionsDeleteVariable = async ({functionId,variableId,parseOutput = true
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -1286,6 +1352,23 @@ functions
     .description(`Get a list of all runtimes that are currently active on your instance.`)
     .action(actionRunner(functionsListRuntimes))
 
+functions
+    .command(`list-templates`)
+    .description(`List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.`)
+    .option(`--runtimes [runtimes...]`, `List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.`)
+    .option(`--use-cases [use-cases...]`, `List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.`)
+    .option(`--limit <limit>`, `Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.`, parseInteger)
+    .option(`--offset <offset>`, `Offset the list of returned templates. Maximum offset is 5000.`, parseInteger)
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(functionsListTemplates))
+
+functions
+    .command(`get-template`)
+    .description(`Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.`)
+    .requiredOption(`--template-id <template-id>`, `Template ID.`)
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(functionsGetTemplate))
+
 functions
     .command(`get-usage`)
     .description(``)
@@ -1384,12 +1467,13 @@ functions
     .action(actionRunner(functionsUpdateDeploymentBuild))
 
 functions
-    .command(`download-deployment`)
+    .command(`get-deployment-download`)
     .description(`Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.`)
     .requiredOption(`--function-id <function-id>`, `Function ID.`)
     .requiredOption(`--deployment-id <deployment-id>`, `Deployment ID.`)
     .requiredOption(`--destination <path>`, `output file path.`)
-    .action(actionRunner(functionsDownloadDeployment))
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(functionsGetDeploymentDownload))
 
 functions
     .command(`list-executions`)
@@ -1477,6 +1561,8 @@ module.exports = {
     functionsList,
     functionsCreate,
     functionsListRuntimes,
+    functionsListTemplates,
+    functionsGetTemplate,
     functionsGetUsage,
     functionsGet,
     functionsUpdate,
@@ -1488,7 +1574,7 @@ module.exports = {
     functionsDeleteDeployment,
     functionsCreateBuild,
     functionsUpdateDeploymentBuild,
-    functionsDownloadDeployment,
+    functionsGetDeploymentDownload,
     functionsListExecutions,
     functionsCreateExecution,
     functionsGetExecution,

package/lib/commands/generic.js

@@ -6,7 +6,7 @@ const { globalConfig, localConfig } = require("../config");
 const { actionRunner, success, parseBool, commandDescriptions, error, parse, hint, log, drawTable, cliConfig } = require("../parser");
 const ID = require("../id");
 const { questionsLogin, questionsLogout, questionsListFactors, questionsMfaChallenge } = require("../questions");
-const {  accountUpdateMfaChallenge, accountCreateMfaChallenge, accountGet, accountCreateEmailPasswordSession, accountDeleteSession } = require("./account");
+const { accountUpdateMfaChallenge, accountCreateMfaChallenge, accountGet, accountCreateEmailPasswordSession, accountDeleteSession } = require("./account");
 
 const DEFAULT_ENDPOINT = 'https://cloud.appwrite.io/v1';
 
@@ -14,17 +14,17 @@ const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
     const oldCurrent = globalConfig.getCurrentSession();
     let configEndpoint = endpoint ?? DEFAULT_ENDPOINT;
 
-    if(globalConfig.getCurrentSession() !== '') {
+    if (globalConfig.getCurrentSession() !== '') {
         log('You are currently signed in as ' + globalConfig.getEmail());
 
-        if(globalConfig.getSessions().length === 1) {
+        if (globalConfig.getSessions().length === 1) {
             hint('You can sign in and manage multiple accounts with Appwrite CLI');
         }
     }
 
     const answers = email && password ? { email, password } : await inquirer.prompt(questionsLogin);
 
-    if(!answers.method) {
+    if (!answers.method) {
         answers.method = 'login';
     }
 
@@ -92,7 +92,7 @@ const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
         } else {
             globalConfig.removeSession(id);
             globalConfig.setCurrentSession(oldCurrent);
-            if(endpoint !== DEFAULT_ENDPOINT && error.response === 'user_invalid_credentials'){
+            if (endpoint !== DEFAULT_ENDPOINT && error.response === 'user_invalid_credentials') {
                 log('Use the --endpoint option for self-hosted instances')
             }
             throw error;
@@ -135,7 +135,7 @@ const whoami = new Command("whoami")
             }
         ];
 
-        if(cliConfig.json) {
+        if (cliConfig.json) {
             console.log(data);
             return;
         }
@@ -193,7 +193,7 @@ const logout = new Command("logout")
         }
         if (sessions.length === 1) {
             await deleteSession(current);
-            success();
+            success("Logging out");
 
             return;
         }
@@ -207,16 +207,16 @@ const logout = new Command("logout")
             }
         }
 
-        const remainingSessions  = globalConfig.getSessions();
+        const remainingSessions = globalConfig.getSessions();
 
-        if (remainingSessions .length > 0 && remainingSessions .filter(session => session.id === current).length !== 1) {
+        if (remainingSessions.length > 0 && remainingSessions.filter(session => session.id === current).length !== 1) {
             const accountId = remainingSessions [0].id;
             globalConfig.setCurrentSession(accountId);
 
             success(`Current account is ${accountId}`);
         }
 
-        success();
+        success("Logging out");
     }));
 
 const client = new Command("client")
@@ -292,7 +292,7 @@ const client = new Command("client")
             }
         }
 
-        success()
+        success("Setting client")
     }));
 
 const migrate = async () => {

package/lib/commands/graphql.js

@@ -35,7 +35,7 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const graphql = new Command("graphql").description(commandDescriptions['graphql']).configureHelp({
+const graphql = new Command("graphql").description(commandDescriptions['graphql'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
@@ -68,7 +68,6 @@ const graphqlQuery = async ({query,parseOutput = true, overrideForCli = false, s
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -104,7 +103,6 @@ const graphqlMutation = async ({query,parseOutput = true, overrideForCli = false
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;

package/lib/commands/health.js

@@ -35,7 +35,7 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const health = new Command("health").description(commandDescriptions['health']).configureHelp({
+const health = new Command("health").description(commandDescriptions['health'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
@@ -63,7 +63,6 @@ const healthGet = async ({parseOutput = true, overrideForCli = false, sdk = unde
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -94,7 +93,6 @@ const healthGetAntivirus = async ({parseOutput = true, overrideForCli = false, s
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -125,7 +123,6 @@ const healthGetCache = async ({parseOutput = true, overrideForCli = false, sdk =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -160,7 +157,6 @@ const healthGetCertificate = async ({domain,parseOutput = true, overrideForCli =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -191,7 +187,6 @@ const healthGetDB = async ({parseOutput = true, overrideForCli = false, sdk = un
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -222,7 +217,6 @@ const healthGetPubSub = async ({parseOutput = true, overrideForCli = false, sdk
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -253,7 +247,6 @@ const healthGetQueue = async ({parseOutput = true, overrideForCli = false, sdk =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -288,7 +281,6 @@ const healthGetQueueBuilds = async ({threshold,parseOutput = true, overrideForCl
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -323,7 +315,6 @@ const healthGetQueueCertificates = async ({threshold,parseOutput = true, overrid
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -362,7 +353,6 @@ const healthGetQueueDatabases = async ({name,threshold,parseOutput = true, overr
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -397,7 +387,6 @@ const healthGetQueueDeletes = async ({threshold,parseOutput = true, overrideForC
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -433,7 +422,6 @@ const healthGetFailedJobs = async ({name,threshold,parseOutput = true, overrideF
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -468,7 +456,6 @@ const healthGetQueueFunctions = async ({threshold,parseOutput = true, overrideFo
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -503,7 +490,6 @@ const healthGetQueueLogs = async ({threshold,parseOutput = true, overrideForCli
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -538,7 +524,6 @@ const healthGetQueueMails = async ({threshold,parseOutput = true, overrideForCli
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -573,7 +558,6 @@ const healthGetQueueMessaging = async ({threshold,parseOutput = true, overrideFo
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -608,7 +592,6 @@ const healthGetQueueMigrations = async ({threshold,parseOutput = true, overrideF
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -643,7 +626,6 @@ const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -678,7 +660,6 @@ const healthGetQueueUsageDump = async ({threshold,parseOutput = true, overrideFo
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -713,7 +694,6 @@ const healthGetQueueWebhooks = async ({threshold,parseOutput = true, overrideFor
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -744,7 +724,6 @@ const healthGetStorage = async ({parseOutput = true, overrideForCli = false, sdk
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -775,7 +754,6 @@ const healthGetStorageLocal = async ({parseOutput = true, overrideForCli = false
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;
@@ -806,7 +784,6 @@ const healthGetTime = async ({parseOutput = true, overrideForCli = false, sdk =
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;