appwrite-cli 4.2.1 → 5.0.0

package/lib/commands/functions.js

@@ -37,7 +37,7 @@ function convertReadStreamToReadableStream(readStream) {
 
 const functions = new Command("functions").description(commandDescriptions['functions']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} FunctionsListRequestParams
@@ -52,7 +52,6 @@ const functions = new Command("functions").description(commandDescriptions['func
  */
 const functionsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions';
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -62,14 +61,12 @@ const functionsList = async ({ queries, search, parseOutput = true, sdk = undefi
         payload['search'] = search;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -82,7 +79,7 @@ const functionsList = async ({ queries, search, parseOutput = true, sdk = undefi
  * @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 {Runtime} 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.
@@ -109,7 +106,6 @@ const functionsList = async ({ queries, search, parseOutput = true, sdk = undefi
  */
 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}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions';
     let payload = {};
     if (typeof functionId !== 'undefined') {
@@ -175,14 +171,12 @@ const functionsCreate = async ({ functionId, name, runtime, execute, events, sch
         payload['templateBranch'] = templateBranch;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -202,18 +196,15 @@ const functionsCreate = async ({ functionId, name, runtime, execute, events, sch
  */
 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()
@@ -224,7 +215,7 @@ const functionsListRuntimes = async ({ parseOutput = true, sdk = undefined}) =>
 
 /**
  * @typedef {Object} FunctionsGetUsageRequestParams
- * @property {string} range Date range.
+ * @property {FunctionUsageRange} range Date range.
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -234,21 +225,18 @@ const functionsListRuntimes = async ({ parseOutput = true, sdk = undefined}) =>
  */
 const functionsGetUsage = async ({ range, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/usage';
     let payload = {};
     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()
@@ -269,18 +257,15 @@ const functionsGetUsage = async ({ range, parseOutput = true, sdk = undefined})
  */
 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()
@@ -293,7 +278,7 @@ const functionsGet = async ({ functionId, parseOutput = true, sdk = undefined})
  * @typedef {Object} FunctionsUpdateRequestParams
  * @property {string} functionId Function ID.
  * @property {string} name Function name. Max length: 128 chars.
- * @property {string} runtime Execution runtime.
+ * @property {Runtime} 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.
@@ -316,7 +301,6 @@ const functionsGet = async ({ functionId, parseOutput = true, sdk = undefined})
  */
 const functionsUpdate = async ({ functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof name !== 'undefined') {
@@ -367,14 +351,12 @@ const functionsUpdate = async ({ functionId, name, runtime, execute, events, sch
         payload['providerRootDirectory'] = providerRootDirectory;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -395,18 +377,15 @@ const functionsUpdate = async ({ functionId, name, runtime, execute, events, sch
  */
 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()
@@ -429,7 +408,6 @@ const functionsDelete = async ({ functionId, parseOutput = true, sdk = undefined
  */
 const functionsListDeployments = async ({ functionId, queries, search, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -439,14 +417,12 @@ const functionsListDeployments = async ({ functionId, queries, search, parseOutp
         payload['search'] = search;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -472,7 +448,6 @@ const functionsListDeployments = async ({ functionId, queries, search, parseOutp
  */
 const functionsCreateDeployment = async ({ functionId, code, activate, entrypoint, commands, parseOutput = true, sdk = undefined, onProgress = () => {}}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/deployments'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof entrypoint !== 'undefined') {
@@ -508,6 +483,12 @@ const functionsCreateDeployment = async ({ functionId, code, activate, entrypoin
             file: 'code.tar.gz'
         }, files);
 
+    let archivePath = fs.realpathSync('code.tar.gz')
+    if (typeof archivePath !== 'undefined') {
+        payload['code'] = archivePath;
+       code = archivePath;
+    }
+
     const filePath = fs.realpathSync(code);
     const nodeStream = fs.createReadStream(filePath);
     const stream = convertReadStreamToReadableStream(nodeStream);
@@ -520,8 +501,6 @@ const functionsCreateDeployment = async ({ functionId, code, activate, entrypoin
         payload['activate'] = activate;
     }
 
-
-
     const size = code.size;
     
     const apiHeaders = {
@@ -611,7 +590,6 @@ const functionsCreateDeployment = async ({ functionId, code, activate, entrypoin
     }
 
     return response;
-
 }
 
 /**
@@ -627,18 +605,15 @@ const functionsCreateDeployment = async ({ functionId, code, activate, entrypoin
  */
 const functionsGetDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -660,18 +635,15 @@ const functionsGetDeployment = async ({ functionId, deploymentId, parseOutput =
  */
 const functionsUpdateDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -693,18 +665,15 @@ const functionsUpdateDeployment = async ({ functionId, deploymentId, parseOutput
  */
 const functionsDeleteDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -727,18 +696,15 @@ const functionsDeleteDeployment = async ({ functionId, deploymentId, parseOutput
  */
 const functionsCreateBuild = async ({ functionId, deploymentId, buildId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -753,7 +719,7 @@ const functionsCreateBuild = async ({ functionId, deploymentId, buildId, parseOu
  * @property {string} deploymentId Deployment ID.
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
-* @property {string} destination
+ * @property {string} destination
  */
 
 /**
@@ -761,23 +727,21 @@ const functionsCreateBuild = async ({ functionId, deploymentId, buildId, parseOu
  */
 const functionsDownloadDeployment = async ({ functionId, deploymentId, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
     let payload = {};
-
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -800,7 +764,6 @@ const functionsDownloadDeployment = async ({ functionId, deploymentId, parseOutp
  */
 const functionsListExecutions = async ({ functionId, queries, search, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -810,14 +773,12 @@ const functionsListExecutions = async ({ functionId, queries, search, parseOutpu
         payload['search'] = search;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -832,7 +793,7 @@ const functionsListExecutions = async ({ functionId, queries, search, parseOutpu
  * @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 {ExecutionMethod} 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
@@ -843,7 +804,6 @@ const functionsListExecutions = async ({ functionId, queries, search, parseOutpu
  */
 const functionsCreateExecution = async ({ functionId, body, async, xpath, method, headers, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof body !== 'undefined') {
@@ -862,14 +822,12 @@ const functionsCreateExecution = async ({ functionId, body, async, xpath, method
         payload['headers'] = JSON.parse(headers);
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -891,18 +849,15 @@ const functionsCreateExecution = async ({ functionId, body, async, xpath, method
  */
 const functionsGetExecution = async ({ functionId, executionId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -914,7 +869,7 @@ const functionsGetExecution = async ({ functionId, executionId, parseOutput = tr
 /**
  * @typedef {Object} FunctionsGetFunctionUsageRequestParams
  * @property {string} functionId Function ID.
- * @property {string} range Date range.
+ * @property {FunctionUsageRange} range Date range.
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -924,21 +879,18 @@ const functionsGetExecution = async ({ functionId, executionId, parseOutput = tr
  */
 const functionsGetFunctionUsage = async ({ functionId, range, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/usage'.replace('{functionId}', functionId);
     let payload = {};
     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()
@@ -959,18 +911,15 @@ const functionsGetFunctionUsage = async ({ functionId, range, parseOutput = true
  */
 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()
@@ -993,7 +942,6 @@ const functionsListVariables = async ({ functionId, parseOutput = true, sdk = un
  */
 const functionsCreateVariable = async ({ functionId, key, value, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/variables'.replace('{functionId}', functionId);
     let payload = {};
     if (typeof key !== 'undefined') {
@@ -1003,14 +951,12 @@ const functionsCreateVariable = async ({ functionId, key, value, parseOutput = t
         payload['value'] = value;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -1032,18 +978,15 @@ const functionsCreateVariable = async ({ functionId, key, value, parseOutput = t
  */
 const functionsGetVariable = async ({ functionId, variableId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -1067,7 +1010,6 @@ const functionsGetVariable = async ({ functionId, variableId, parseOutput = true
  */
 const functionsUpdateVariable = async ({ functionId, variableId, key, value, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/functions/{functionId}/variables/{variableId}'.replace('{functionId}', functionId).replace('{variableId}', variableId);
     let payload = {};
     if (typeof key !== 'undefined') {
@@ -1077,14 +1019,12 @@ const functionsUpdateVariable = async ({ functionId, variableId, key, value, par
         payload['value'] = value;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -1106,18 +1046,15 @@ const functionsUpdateVariable = async ({ functionId, variableId, key, value, par
  */
 const functionsDeleteVariable = async ({ functionId, variableId, parseOutput = true, sdk = undefined}) => {
     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()
@@ -1126,7 +1063,6 @@ const functionsDeleteVariable = async ({ functionId, variableId, parseOutput = t
     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.`)
@@ -1328,30 +1264,29 @@ functions
     .requiredOption(`--variableId <variableId>`, `Variable unique ID.`)
     .action(actionRunner(functionsDeleteVariable))
 
-
 module.exports = {
     functions,
-    functionsList,    
-    functionsCreate,    
-    functionsListRuntimes,    
-    functionsGetUsage,    
-    functionsGet,    
-    functionsUpdate,    
-    functionsDelete,    
-    functionsListDeployments,    
-    functionsCreateDeployment,    
-    functionsGetDeployment,    
-    functionsUpdateDeployment,    
-    functionsDeleteDeployment,    
-    functionsCreateBuild,    
-    functionsDownloadDeployment,    
-    functionsListExecutions,    
-    functionsCreateExecution,    
-    functionsGetExecution,    
-    functionsGetFunctionUsage,    
-    functionsListVariables,    
-    functionsCreateVariable,    
-    functionsGetVariable,    
-    functionsUpdateVariable,    
-    functionsDeleteVariable    
+    functionsList,
+    functionsCreate,
+    functionsListRuntimes,
+    functionsGetUsage,
+    functionsGet,
+    functionsUpdate,
+    functionsDelete,
+    functionsListDeployments,
+    functionsCreateDeployment,
+    functionsGetDeployment,
+    functionsUpdateDeployment,
+    functionsDeleteDeployment,
+    functionsCreateBuild,
+    functionsDownloadDeployment,
+    functionsListExecutions,
+    functionsCreateExecution,
+    functionsGetExecution,
+    functionsGetFunctionUsage,
+    functionsListVariables,
+    functionsCreateVariable,
+    functionsGetVariable,
+    functionsUpdateVariable,
+    functionsDeleteVariable
 };

package/lib/commands/generic.js

@@ -118,7 +118,6 @@ const client = new Command("client")
         success()
     }));
 
-
 module.exports = {
     login,
     logout,