appwrite-cli 1.1.1 → 2.0.0

package/lib/commands/account.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const account = new Command("account").description(commandDescriptions['account'])
+const account = new Command("account").description(commandDescriptions['account']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const accountGet = async ({ parseOutput = true, sdk = undefined}) => {
 
@@ -40,18 +42,22 @@ const accountCreate = async ({ userId, email, password, name, parseOutput = true
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
 
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -77,10 +83,12 @@ const accountUpdateEmail = async ({ email, password, parseOutput = true, sdk = u
     let payload = {};
     
     /** Body Params */
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
@@ -145,6 +153,7 @@ const accountUpdateName = async ({ name, parseOutput = true, sdk = undefined}) =
     let payload = {};
     
     /** Body Params */
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -170,10 +179,12 @@ const accountUpdatePassword = async ({ password, oldPassword, parseOutput = true
     let payload = {};
     
     /** Body Params */
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
 
+
     if (typeof oldPassword !== 'undefined') {
         payload['oldPassword'] = oldPassword;
     }
@@ -199,10 +210,12 @@ const accountUpdatePhone = async ({ phone, password, parseOutput = true, sdk = u
     let payload = {};
     
     /** Body Params */
+
     if (typeof phone !== 'undefined') {
         payload['phone'] = phone;
     }
 
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
@@ -269,10 +282,12 @@ const accountCreateRecovery = async ({ email, url, parseOutput = true, sdk = und
     let payload = {};
     
     /** Body Params */
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
@@ -300,18 +315,22 @@ const accountUpdateRecovery = async ({ userId, secret, password, passwordAgain,
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
 
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
 
+
     if (typeof passwordAgain !== 'undefined') {
         payload['passwordAgain'] = passwordAgain;
     }
@@ -388,10 +407,12 @@ const accountCreateEmailSession = async ({ email, password, parseOutput = true,
     let payload = {};
     
     /** Body Params */
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
@@ -418,14 +439,17 @@ const accountCreateMagicURLSession = async ({ userId, email, url, parseOutput =
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
@@ -451,10 +475,12 @@ const accountUpdateMagicURLSession = async ({ userId, secret, parseOutput = true
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
@@ -512,10 +538,12 @@ const accountCreatePhoneSession = async ({ userId, phone, parseOutput = true, sd
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof phone !== 'undefined') {
         payload['phone'] = phone;
     }
@@ -541,10 +569,12 @@ const accountUpdatePhoneSession = async ({ userId, secret, parseOutput = true, s
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
@@ -640,6 +670,7 @@ const accountCreateVerification = async ({ url, parseOutput = true, sdk = undefi
     let payload = {};
     
     /** Body Params */
+
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
@@ -665,10 +696,12 @@ const accountUpdateVerification = async ({ userId, secret, parseOutput = true, s
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
@@ -711,10 +744,12 @@ const accountUpdatePhoneVerification = async ({ userId, secret, parseOutput = tr
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
@@ -740,9 +775,9 @@ account
 account
     .command(`create`)
     .description(`Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](/docs/client/account#accountCreateVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](/docs/client/account#accountCreateSession).`)
-    .requiredOption(`--userId <userId>`, `Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.`)
+    .requiredOption(`--userId <userId>`, `Unique 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.`)
     .requiredOption(`--email <email>`, `User email.`)
-    .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
+    .requiredOption(`--password <password>`, `New user password. Must be at least 8 chars.`)
     .option(`--name <name>`, `User name. Max length: 128 chars.`)
     .action(actionRunner(accountCreate))
 
@@ -761,7 +796,7 @@ account
 account
     .command(`listLogs`)
     .description(`Get currently logged in user list of latest security activity logs. Each log returns user IP address, location and date and time of log.`)
-    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Only supported methods are limit and offset`)
+    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
     .action(actionRunner(accountListLogs))
 
 account
@@ -828,15 +863,15 @@ account
 
 account
     .command(`createEmailSession`)
-    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.`)
+    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits).`)
     .requiredOption(`--email <email>`, `User email.`)
     .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
     .action(actionRunner(accountCreateEmailSession))
 
 account
     .command(`createMagicURLSession`)
-    .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.`)
-    .requiredOption(`--userId <userId>`, `Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.`)
+    .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits).`)
+    .requiredOption(`--userId <userId>`, `Unique 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.`)
     .requiredOption(`--email <email>`, `User email.`)
     .option(`--url <url>`, `URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .action(actionRunner(accountCreateMagicURLSession))
@@ -850,17 +885,17 @@ account
 
 account
     .command(`createOAuth2Session`)
-    .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.. `)
+    .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits). `)
     .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoom.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
-    .option(`--scopes <scopes...>`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.`)
+    .option(`--scopes [scopes...]`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.`)
     .action(actionRunner(accountCreateOAuth2Session))
 
 account
     .command(`createPhoneSession`)
-    .description(`Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.`)
-    .requiredOption(`--userId <userId>`, `Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.`)
+    .description(`Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits).`)
+    .requiredOption(`--userId <userId>`, `Unique 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.`)
     .requiredOption(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
     .action(actionRunner(accountCreatePhoneSession))
 

package/lib/commands/avatars.js

@@ -10,7 +10,9 @@ const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
 
-const avatars = new Command("avatars").description(commandDescriptions['avatars'])
+const avatars = new Command("avatars").description(commandDescriptions['avatars']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
 
 const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
     /* @param {string} code */

package/lib/commands/console.js

@@ -0,0 +1,44 @@
+const fs = require('fs');
+const pathLib = require('path');
+const tar = require("tar");
+const ignore = require("ignore");
+const { promisify } = require('util');
+const libClient = require('../client.js');
+const { getAllFiles } = require('../utils.js');
+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 console = new Command("console").description(commandDescriptions['console']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
+
+const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/console/variables';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+
+console
+    .command(`variables`)
+    .description(`Get all Environment Variables that are relevant for the console.`)
+    .action(actionRunner(consoleVariables))
+
+
+module.exports = {
+    console,
+    consoleVariables
+};