appwrite-cli 5.0.3 → 6.0.0-rc.1

package/lib/commands/generic.js

@@ -3,20 +3,44 @@ const { Command } = require("commander");
 const Client = require("../client");
 const { sdkForConsole } = require("../sdks");
 const { globalConfig, localConfig } = require("../config");
-const { actionRunner, success, parseBool, commandDescriptions, log, parse } = require("../parser");
-const { questionsLogin, questionsListFactors, questionsMfaChallenge } = require("../questions");
-const { accountUpdateMfaChallenge, accountCreateMfaChallenge, accountGet, accountCreateEmailPasswordSession, accountDeleteSession } = require("./account");
+const { actionRunner, success, parseBool, commandDescriptions, error, parse, 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 login = new Command("login")
-    .description(commandDescriptions['login'])
-    .configureHelp({
-        helpWidth: process.stdout.columns || 80
-    })
-    .action(actionRunner(async () => {
-        const answers = await inquirer.prompt(questionsLogin)
+const DEFAULT_ENDPOINT = 'https://cloud.appwrite.io/v1';
 
-        let client = await sdkForConsole(false);
+const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
+    const oldCurrent = globalConfig.getCurrentSession();
+    let configEndpoint = endpoint ?? DEFAULT_ENDPOINT;
+
+    const answers = email && password ? { email, password } : await inquirer.prompt(questionsLogin);
+
+    if (answers.method === 'select') {
+        const accountId = answers.accountId;
+
+        if (!globalConfig.getSessionIds().includes(accountId)) {
+            throw Error('Session ID not found');
+        }
+
+        globalConfig.setCurrentSession(accountId);
+        success(`Current account is ${accountId}`);
+
+        return;
+    }
+
+    const id = ID.unique();
+
+    globalConfig.addSession(id, {});
+    globalConfig.setCurrentSession(id);
+    globalConfig.setEndpoint(configEndpoint);
+    globalConfig.setEmail(answers.email);
 
+    let client = await sdkForConsole(false);
+
+    let account;
+
+    try {
         await accountCreateEmailPasswordSession({
             email: answers.email,
             password: answers.password,
@@ -26,6 +50,57 @@ const login = new Command("login")
 
         client.setCookie(globalConfig.getCookie());
 
+        account = await accountGet({
+            sdk: client,
+            parseOutput: false
+        });
+    } catch (error) {
+        if (error.response === 'user_more_factors_required') {
+            const { factor } = mfa ? { factor: mfa } : await inquirer.prompt(questionsListFactors);
+
+            const challenge = await accountCreateMfaChallenge({
+                factor,
+                parseOutput: false,
+                sdk: client
+            });
+
+            const { otp } = code ? { otp: code } : await inquirer.prompt(questionsMfaChallenge);
+
+            await accountUpdateMfaChallenge({
+                challengeId: challenge.$id,
+                otp,
+                parseOutput: false,
+                sdk: client
+            });
+
+            account = await accountGet({
+                sdk: client,
+                parseOutput: false
+            });
+        } else {
+            globalConfig.removeSession(id);
+            globalConfig.setCurrentSession(oldCurrent);
+            if(endpoint !== DEFAULT_ENDPOINT && error.response === 'user_invalid_credentials'){
+                log('Use the --endpoint option for self-hosted instances')
+            }
+            throw error;
+        }
+    }
+
+    success("Signed in as user with ID: " + account.$id);
+    log("Next you can create or link to your project using 'appwrite init project'");
+};
+
+const whoami = new Command("whoami")
+    .description(commandDescriptions['whoami'])
+    .action(actionRunner(async () => {
+        if (globalConfig.getEndpoint() === '' || globalConfig.getCookie() === '') {
+            error("No user is signed in. To sign in, run: appwrite login ");
+            return;
+        }
+
+        let client = await sdkForConsole(false);
+
         let account;
 
         try {
@@ -33,43 +108,49 @@ const login = new Command("login")
                 sdk: client,
                 parseOutput: false
             });
-        } catch(error) {
-            if (error.response === 'user_more_factors_required') {
-                const { factor } = await inquirer.prompt(questionsListFactors);
-
-                const challenge = await accountCreateMfaChallenge({
-                    factor,
-                    parseOutput: false,
-                    sdk: client
-                });
-
-                const { otp } = await inquirer.prompt(questionsMfaChallenge);
-
-                await accountUpdateMfaChallenge({
-                    challengeId: challenge.$id,
-                    otp,
-                    parseOutput: false,
-                    sdk: client
-                });
-
-                account = await accountGet({
-                    sdk: client,
-                    parseOutput: false
-                });
-            } else {
-                throw error;
+        } catch (error) {
+            error("No user is signed in. To sign in, run: appwrite login");
+            return;
+        }
+
+        const data = [
+            {
+                'ID': account.$id,
+                'Name': account.name,
+                'Email': account.email,
+                'MFA enabled': account.mfa ? 'Yes' : 'No',
+                'Endpoint': globalConfig.getEndpoint()
             }
+        ];
+
+        if(cliConfig.json) {
+            console.log(data);
+            return;
         }
 
-        success("Signed in as user with ID: " + account.$id);
+        drawTable(data)
     }));
 
-const logout = new Command("logout")
-    .description(commandDescriptions['logout'])
+const register = new Command("register")
+    .description(commandDescriptions['register'])
+    .action(actionRunner(async () => {
+        log('Visit https://cloud.appwrite.io/register to create an account')
+    }));
+
+const login = new Command("login")
+    .description(commandDescriptions['login'])
+    .option(`--email [email]`, `User email`)
+    .option(`--password [password]`, `User password`)
+    .option(`--endpoint [endpoint]`, `Appwrite endpoint for self hosted instances`)
+    .option(`--mfa [factor]`, `Multi-factor authentication login factor: totp, email, phone or recoveryCode`)
+    .option(`--code [code]`, `Multi-factor code`)
     .configureHelp({
         helpWidth: process.stdout.columns || 80
     })
-    .action(actionRunner(async () => {
+    .action(actionRunner(loginCommand));
+
+const deleteSession = async (accountId) => {
+    try {
         let client = await sdkForConsole();
 
         await accountDeleteSession({
@@ -78,8 +159,51 @@ const logout = new Command("logout")
             sdk: client
         })
 
-        globalConfig.setCookie("");
-        success()
+        globalConfig.removeSession(accountId);
+    } catch (e) {
+        error('Unable to log out, removing locally saved session information')
+    }
+    globalConfig.removeSession(accountId);
+}
+
+const logout = new Command("logout")
+    .description(commandDescriptions['logout'])
+    .configureHelp({
+        helpWidth: process.stdout.columns || 80
+    })
+    .action(actionRunner(async () => {
+        const sessions = globalConfig.getSessions();
+        const current = globalConfig.getCurrentSession();
+
+        if (current === '') {
+            return;
+        }
+        if (sessions.length === 1) {
+            await deleteSession(current);
+            success();
+
+            return;
+        }
+
+        const answers = await inquirer.prompt(questionsLogout);
+
+        if (answers.accounts) {
+            for (let accountId of answers.accounts) {
+                globalConfig.setCurrentSession(accountId);
+                await deleteSession(accountId);
+            }
+        }
+
+        const remainingSessions  = globalConfig.getSessions();
+
+        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();
     }));
 
 const client = new Command("client")
@@ -87,12 +211,12 @@ const client = new Command("client")
     .configureHelp({
         helpWidth: process.stdout.columns || 80
     })
-    .option("--selfSigned <value>", "Configure the CLI to use a self-signed certificate ( true or false )", parseBool)
-    .option("--endpoint <endpoint>", "Set your Appwrite server endpoint")
-    .option("--projectId <projectId>", "Set your Appwrite project ID")
-    .option("--key <key>", "Set your Appwrite server's API key")
-    .option("--debug", "Print CLI debug information")
-    .option("--reset", "Reset the CLI configuration")
+    .option("-ss, --selfSigned <value>", "Configure the CLI to use a self-signed certificate ( true or false )", parseBool)
+    .option("-e, --endpoint <endpoint>", "Set your Appwrite server endpoint")
+    .option("-p, --projectId <projectId>", "Set your Appwrite project ID")
+    .option("-k, --key <key>", "Set your Appwrite server's API key")
+    .option("-d, --debug", "Print CLI debug information")
+    .option("-r, --reset", "Reset the CLI configuration")
     .action(actionRunner(async ({ selfSigned, endpoint, projectId, key, debug, reset }, command) => {
         if (selfSigned == undefined && endpoint == undefined && projectId == undefined && key == undefined && debug == undefined && reset == undefined) {
             command.help()
@@ -111,6 +235,7 @@ const client = new Command("client")
 
         if (endpoint !== undefined) {
             try {
+                const id = ID.unique();
                 let url = new URL(endpoint);
                 if (url.protocol !== "http:" && url.protocol !== "https:") {
                     throw new Error();
@@ -125,7 +250,8 @@ const client = new Command("client")
                 if (!response.version) {
                     throw new Error();
                 }
-
+                globalConfig.setCurrentSession(id);
+                globalConfig.addSession(id, {});
                 globalConfig.setEndpoint(endpoint);
             } catch (_) {
                 throw new Error("Invalid endpoint or your Appwrite server is not running as expected.");
@@ -145,18 +271,44 @@ const client = new Command("client")
         }
 
         if (reset !== undefined) {
-            globalConfig.setEndpoint("");
-            globalConfig.setKey("");
-            globalConfig.setCookie("");
-            globalConfig.setSelfSigned("");
-            localConfig.setProject("", "");
+            const sessions = globalConfig.getSessions();
+
+            for (let accountId of sessions.map(session => session.id)) {
+                globalConfig.setCurrentSession(accountId);
+                await deleteSession(accountId);
+            }
         }
 
         success()
     }));
 
+const migrate = async () => {
+    if (!globalConfig.has('endpoint') || !globalConfig.has('cookie')) {
+        return;
+    }
+
+    const endpoint = globalConfig.get('endpoint');
+    const cookie = globalConfig.get('cookie');
+
+    const id = ID.unique();
+    const data = {
+        endpoint,
+        cookie,
+        email: 'legacy'
+    };
+
+    globalConfig.addSession(id, data);
+    globalConfig.setCurrentSession(id);
+    globalConfig.delete('endpoint');
+    globalConfig.delete('cookie');
+
+}
 module.exports = {
+        loginCommand,
+    whoami,
+    register,
     login,
     logout,
+        migrate,
     client
 };

package/lib/commands/graphql.js

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -42,6 +42,7 @@ const graphql = new Command("graphql").description(commandDescriptions['graphql'
 /**
  * @typedef {Object} GraphqlQueryRequestParams
  * @property {object} query The query or queries to execute.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -49,8 +50,9 @@ const graphql = new Command("graphql").description(commandDescriptions['graphql'
 /**
  * @param {GraphqlQueryRequestParams} params
  */
-const graphqlQuery = async ({ query, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const graphqlQuery = async ({query,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/graphql';
     let payload = {};
     if (typeof query !== 'undefined') {
@@ -68,13 +70,15 @@ const graphqlQuery = async ({ query, parseOutput = true, sdk = undefined}) => {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} GraphqlMutationRequestParams
  * @property {object} query The query or queries to execute.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -82,8 +86,9 @@ const graphqlQuery = async ({ query, parseOutput = true, sdk = undefined}) => {
 /**
  * @param {GraphqlMutationRequestParams} params
  */
-const graphqlMutation = async ({ query, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const graphqlMutation = async ({query,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/graphql/mutation';
     let payload = {};
     if (typeof query !== 'undefined') {
@@ -101,8 +106,9 @@ const graphqlMutation = async ({ query, parseOutput = true, sdk = undefined}) =>
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 graphql
@@ -121,4 +127,4 @@ module.exports = {
     graphql,
     graphqlQuery,
     graphqlMutation
-};
+};