appwrite-cli 0.14.0

package/lib/commands/generic.js

@@ -0,0 +1,106 @@
+const inquirer = require("inquirer");
+const { Command } = require("commander");
+const { sdkForConsole } = require("../sdks");
+const { globalConfig, localConfig } = require("../config");
+const { actionRunner, success, parseBool, commandDescriptions, log, parse } = require("../parser");
+const { questionsLogin } = require("../questions");
+const { accountCreateSession, accountDeleteSession } = require("./account");
+
+const login = new Command("login")
+    .description(commandDescriptions['login'])
+    .action(actionRunner(async () => {
+        const answers = await inquirer.prompt(questionsLogin)
+
+        let client = await sdkForConsole(false);
+
+        await accountCreateSession({
+            email: answers.email,
+            password: answers.password,
+            parseOutput: false,
+            sdk: client
+        })
+
+        success()
+    }));
+
+const logout = new Command("logout")
+    .description(commandDescriptions['logout'])
+    .action(actionRunner(async () => {
+        let client = await sdkForConsole();
+
+        await accountDeleteSession({
+            sessionId: 'current',
+            parseOutput: false,
+            sdk: client
+        })
+
+        globalConfig.setCookie("");
+        success()
+    }));
+
+const client = new Command("client")
+    .description(commandDescriptions['client'])
+    .option("--selfSigned <value>", "Configure the CLI to use a self-signed certificate ( true or false )", parseBool)
+    .option("--endpoint <endpoint>", "Set your Apwrite server endpoint")
+    .option("--projectId <projectId>", "Set your Apwrite project ID")
+    .option("--key <key>", "Set your Apwrite server's API key")
+    .option("--debug", "Print CLI debug information")
+    .option("--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()
+        }
+
+        if (debug) {
+            let config = {
+                endpoint: globalConfig.getEndpoint(),
+                key: globalConfig.getKey(),
+                cookie: globalConfig.getCookie(),
+                selfSigned: globalConfig.getSelfSigned(),
+                project: localConfig.getProject()
+            }
+            parse(config)
+        }
+
+        if (endpoint !== undefined) {
+            try {
+                let url = new URL(endpoint);
+                if (url.protocol === "http:" || url.protocol === "https:") {
+                    globalConfig.setEndpoint(endpoint);
+                } else {
+                    throw new Error();
+                }
+            } catch (_) {
+                throw new Error("Invalid endpoint");
+            }
+        }
+
+        if (key !== undefined) {
+            globalConfig.setKey(key)
+        }
+
+        if (projectId !== undefined) {
+            localConfig.setProject(projectId, '');
+        }
+
+        if (selfSigned == true || selfSigned == false) {
+            globalConfig.setSelfSigned(selfSigned);
+        }
+
+        if (reset !== undefined) {
+            globalConfig.setEndpoint("");
+            globalConfig.setKey("");
+            globalConfig.setCookie("");
+            globalConfig.setSelfSigned("");
+            localConfig.setProject("", "");
+        }
+
+        success()
+    }));
+
+
+module.exports = {
+    login,
+    logout,
+    client
+};

package/lib/commands/health.js

@@ -0,0 +1,269 @@
+const fs = require('fs');
+const { promisify } = require('util');
+const libClient = require('../client.js');
+const childProcess = require('child_process');
+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 health = new Command("health").description(commandDescriptions['health'])
+
+const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/anti-virus';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/cache';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/db';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetQueueCertificates = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/queue/certificates';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetQueueFunctions = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/queue/functions';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetQueueLogs = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/queue/logs';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetQueueUsage = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/queue/usage';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetQueueWebhooks = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/queue/webhooks';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/storage/local';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/health/time';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+
+health
+    .command(`get`)
+    .description(`Check the Appwrite HTTP server is up and responsive.`)
+    .action(actionRunner(healthGet))
+
+health
+    .command(`getAntivirus`)
+    .description(`Check the Appwrite Antivirus server is up and connection is successful.`)
+    .action(actionRunner(healthGetAntivirus))
+
+health
+    .command(`getCache`)
+    .description(`Check the Appwrite in-memory cache server is up and connection is successful.`)
+    .action(actionRunner(healthGetCache))
+
+health
+    .command(`getDB`)
+    .description(`Check the Appwrite database server is up and connection is successful.`)
+    .action(actionRunner(healthGetDB))
+
+health
+    .command(`getQueueCertificates`)
+    .description(`Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.`)
+    .action(actionRunner(healthGetQueueCertificates))
+
+health
+    .command(`getQueueFunctions`)
+    .description(``)
+    .action(actionRunner(healthGetQueueFunctions))
+
+health
+    .command(`getQueueLogs`)
+    .description(`Get the number of logs that are waiting to be processed in the Appwrite internal queue server.`)
+    .action(actionRunner(healthGetQueueLogs))
+
+health
+    .command(`getQueueUsage`)
+    .description(`Get the number of usage stats that are waiting to be processed in the Appwrite internal queue server.`)
+    .action(actionRunner(healthGetQueueUsage))
+
+health
+    .command(`getQueueWebhooks`)
+    .description(`Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.`)
+    .action(actionRunner(healthGetQueueWebhooks))
+
+health
+    .command(`getStorageLocal`)
+    .description(`Check the Appwrite local storage device is up and connection is successful.`)
+    .action(actionRunner(healthGetStorageLocal))
+
+health
+    .command(`getTime`)
+    .description(`Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.`)
+    .action(actionRunner(healthGetTime))
+
+
+module.exports = {
+    health,
+    healthGet,
+    healthGetAntivirus,
+    healthGetCache,
+    healthGetDB,
+    healthGetQueueCertificates,
+    healthGetQueueFunctions,
+    healthGetQueueLogs,
+    healthGetQueueUsage,
+    healthGetQueueWebhooks,
+    healthGetStorageLocal,
+    healthGetTime
+};

package/lib/commands/init.js

@@ -0,0 +1,148 @@
+const fs = require("fs");
+const path = require("path");
+const childProcess = require('child_process');
+const { Command } = require("commander");
+const inquirer = require("inquirer");
+const { teamsCreate } = require("./teams");
+const { projectsCreate } = require("./projects");
+const { functionsCreate } = require("./functions");
+const { databaseListCollections } = require("./database");
+const { sdkForConsole } = require("../sdks");
+const { localConfig } = require("../config");
+const { questionsInitProject, questionsInitFunction } = require("../questions");
+const { success, log, actionRunner, commandDescriptions } = require("../parser");
+
+const init = new Command("init")
+  .description(commandDescriptions['init'])
+  .option("--all", "Flag to initialize projects and collection")
+  .action(actionRunner(async ({ all }, command) => {
+    if (all == undefined) {
+      command.help()
+    }
+
+    await initProject();
+    await initCollection()
+  }));
+
+const initProject = async () => {
+  let response = {}
+  let answers = await inquirer.prompt(questionsInitProject)
+  if (!answers.project) process.exit(1)
+
+  let sdk = await sdkForConsole();
+  if (answers.start == "new") {
+    response = await teamsCreate({
+      teamId: 'unique()',
+      name: answers.project,
+      sdk,
+      parseOutput: false
+    })
+
+    let teamId = response['$id'];
+    response = await projectsCreate({
+      projectId: 'unique()',
+      name: answers.project,
+      teamId,
+      parseOutput: false
+    })
+
+    localConfig.setProject(response['$id'], response.name);
+  } else {
+    localConfig.setProject(answers.project.id, answers.project.name);
+  }
+  success();
+}
+
+const initFunction = async () => {
+  let answers = await inquirer.prompt(questionsInitFunction)
+
+  if (fs.existsSync(path.join(process.cwd(), 'functions', answers.name))) {
+    throw new Error(`( ${answers.name} ) already exists in the current directory. Please choose another name.`);
+  }
+
+  if(!answers.runtime.entrypoint) {
+    log(`Entrypoint for this runtime not found. You will be asked to configure entrypoint when you first deploy the function.`);
+  }
+
+  let response = await functionsCreate({
+    functionId: 'unique()',
+    name: answers.name,
+    runtime: answers.runtime.id,
+    parseOutput: false
+  })
+
+  let command = `
+    mkdir -m 777 -p 'functions/${answers.name}' && \
+    cd 'functions/${answers.name}' && \
+    git init && \
+    git remote add -f origin https://github.com/appwrite/functions-starter && \
+    git config core.sparseCheckout true && \
+    echo '${answers.runtime.id}' >> .git/info/sparse-checkout && \ 
+    git pull origin main && \
+    rm -rf .git && \
+    mv ${answers.runtime.id}/* . && \
+    rm -rf ${answers.runtime.id}`;
+
+  // Execute the child process but do not print any std output
+  childProcess.execSync(command, { stdio: 'pipe' });
+
+  const readmePath = path.join(process.cwd(), 'functions', answers.name, 'README.md');
+  const readmeFile = fs.readFileSync(readmePath).toString();
+  const newReadmeFile = readmeFile.split('\n');
+  newReadmeFile[0] = `# ${answers.name}`;
+  newReadmeFile.splice(1, 2);
+  fs.writeFileSync(readmePath, newReadmeFile.join('\n'));
+
+  let data = {
+    $id: response['$id'],
+    name: response.name,
+    runtime: response.runtime,
+    path: `functions/${answers.name}`,
+    entrypoint: answers.runtime.entrypoint || '',
+    execute: response.execute,
+    vars: response.vars,
+    events: response.events,
+    schedule: response.schedule,
+    timeout: response.timeout,
+  };
+
+  localConfig.addFunction(data);
+  success();
+}
+
+const initCollection = async () => {
+  // TODO: Pagination?
+  let response = await databaseListCollections({
+    limit: 100,
+    parseOutput: false
+  })
+
+  let collections = response.collections;
+  log(`Found ${collections.length} collections`);
+
+  collections.forEach(async collection => {
+    log(`Fetching ${collection.name} ...`);
+    localConfig.addCollection(collection);
+  });
+
+  success();
+}
+
+init
+  .command("project")
+  .description("Initialise your Appwrite project")
+  .action(actionRunner(initProject));
+
+init
+  .command("function")
+  .description("Initialise your Appwrite cloud function")
+  .action(actionRunner(initFunction))
+
+init
+  .command("collection")
+  .description("Initialise your Appwrite collections")
+  .action(actionRunner(initCollection))
+
+module.exports = {
+  init,
+};

package/lib/commands/locale.js

@@ -0,0 +1,177 @@
+const fs = require('fs');
+const { promisify } = require('util');
+const libClient = require('../client.js');
+const childProcess = require('child_process');
+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 locale = new Command("locale").description(commandDescriptions['locale'])
+
+const localeGet = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetContinents = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/continents';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetCountries = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/countries';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetCountriesEU = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/countries/eu';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetCountriesPhones = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/countries/phones';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetCurrencies = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/currencies';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const localeGetLanguages = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/locale/languages';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+
+locale
+    .command(`get`)
+    .description(`Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.  ([IP Geolocation by DB-IP](https://db-ip.com))`)
+    .action(actionRunner(localeGet))
+
+locale
+    .command(`getContinents`)
+    .description(`List of all continents. You can use the locale header to get the data in a supported language.`)
+    .action(actionRunner(localeGetContinents))
+
+locale
+    .command(`getCountries`)
+    .description(`List of all countries. You can use the locale header to get the data in a supported language.`)
+    .action(actionRunner(localeGetCountries))
+
+locale
+    .command(`getCountriesEU`)
+    .description(`List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.`)
+    .action(actionRunner(localeGetCountriesEU))
+
+locale
+    .command(`getCountriesPhones`)
+    .description(`List of all countries phone codes. You can use the locale header to get the data in a supported language.`)
+    .action(actionRunner(localeGetCountriesPhones))
+
+locale
+    .command(`getCurrencies`)
+    .description(`List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.`)
+    .action(actionRunner(localeGetCurrencies))
+
+locale
+    .command(`getLanguages`)
+    .description(`List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.`)
+    .action(actionRunner(localeGetLanguages))
+
+
+module.exports = {
+    locale,
+    localeGet,
+    localeGetContinents,
+    localeGetCountries,
+    localeGetCountriesEU,
+    localeGetCountriesPhones,
+    localeGetCurrencies,
+    localeGetLanguages
+};