appwrite-cli 12.0.1 → 13.0.0-rc.2

package/lib/emulation/docker.js

@@ -1,264 +0,0 @@
-const tar = require("tar");
-const ignore = require("ignore");
-const net = require('net');
-const chalk = require('chalk');
-const childProcess = require('child_process');
-const { localConfig } = require("../config");
-const path = require('path');
-const fs = require('fs');
-const { log, error, success, hint } = require("../parser");
-const { openRuntimesVersion, systemTools, Queue } = require("./utils");
-const { getAllFiles } = require("../utils");
-
-async function dockerStop(id) {
-    const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
-        stdio: 'pipe',
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    await new Promise((res) => { stopProcess.on('close', res) });
-}
-
-async function dockerPull(func) {
-    const runtimeChunks = func.runtime.split("-");
-    const runtimeVersion = runtimeChunks.pop();
-    const runtimeName = runtimeChunks.join("-");
-    const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
-
-    log('Verifying Docker image ...');
-
-    const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
-        stdio: 'pipe',
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    await new Promise((res) => { pullProcess.on('close', res) });
-}
-
-async function dockerBuild(func, variables) {
-    const runtimeChunks = func.runtime.split("-");
-    const runtimeVersion = runtimeChunks.pop();
-    const runtimeName = runtimeChunks.join("-");
-    const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
-
-    const functionDir = path.join(localConfig.getDirname(), func.path);
-
-    const id = func.$id;
-
-    const ignorer = ignore();
-    ignorer.add('.appwrite');
-    if (func.ignore) {
-        ignorer.add(func.ignore);
-    } else if (fs.existsSync(path.join(functionDir, '.gitignore'))) {
-        ignorer.add(fs.readFileSync(path.join(functionDir, '.gitignore')).toString());
-    }
-    
-    const files = getAllFiles(functionDir).map((file) => path.relative(functionDir, file)).filter((file) => !ignorer.ignores(file));
-    const tmpBuildPath = path.join(functionDir, '.appwrite/tmp-build');
-    if (!fs.existsSync(tmpBuildPath)) {
-        fs.mkdirSync(tmpBuildPath, { recursive: true });
-    }
-
-    for(const f of files) {
-        const filePath = path.join(tmpBuildPath, f);
-        const fileDir = path.dirname(filePath);
-        if (!fs.existsSync(fileDir)) {
-            fs.mkdirSync(fileDir, { recursive: true });
-        }
-
-        const sourcePath = path.join(functionDir, f);
-        fs.copyFileSync(sourcePath, filePath);
-    }
-
-    const params = [ 'run' ];
-    params.push('--name', id);
-    params.push('-v', `${tmpBuildPath}/:/mnt/code:rw`);
-    params.push('-e', 'OPEN_RUNTIMES_ENV=development');
-    params.push('-e', 'OPEN_RUNTIMES_SECRET=');
-    params.push('-e', `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
-
-    for(const k of Object.keys(variables)) {
-        params.push('-e', `${k}=${variables[k]}`);
-    }
-
-    params.push(imageName, 'sh', '-c', `helpers/build.sh "${func.commands}"`);
-
-    const buildProcess = childProcess.spawn('docker', params, {
-        stdio: 'pipe',
-        pwd: functionDir,
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    buildProcess.stdout.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(`${data}\n`));
-    });
-
-    buildProcess.stderr.on('data', (data) => {
-        process.stderr.write(chalk.blackBright(`${data}\n`));
-    });
-
-    const killInterval = setInterval(() => {
-        if(!Queue.isEmpty()) {
-            log('Cancelling build ...');
-            buildProcess.stdout.destroy();
-            buildProcess.stdin.destroy();
-            buildProcess.stderr.destroy();
-            buildProcess.kill("SIGKILL");
-            clearInterval(killInterval);
-        }
-    }, 100);
-
-    await new Promise((res) => { buildProcess.on('close', res) });
-
-    clearInterval(killInterval);
-    if(!Queue.isEmpty()) {
-        return;
-    }
-
-    const copyPath = path.join(localConfig.getDirname(), func.path, '.appwrite', 'build.tar.gz');
-    const copyDir = path.dirname(copyPath);
-    if (!fs.existsSync(copyDir)) {
-        fs.mkdirSync(copyDir, { recursive: true });
-    }
-
-    const copyProcess = childProcess.spawn('docker', ['cp', `${id}:/mnt/code/code.tar.gz`, copyPath], {
-        stdio: 'pipe',
-        pwd: functionDir,
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    await new Promise((res) => { copyProcess.on('close', res) });
-
-    await dockerStop(id);
-
-    const tempPath = path.join(localConfig.getDirname(), func.path, 'code.tar.gz');
-    if (fs.existsSync(tempPath)) {
-        fs.rmSync(tempPath, { force: true });
-    }
-
-    fs.rmSync(tmpBuildPath, { recursive: true, force: true });
-}
-
-async function dockerStart(func, variables, port) {
-    // Pack function files
-    const functionDir = path.join(localConfig.getDirname(), func.path);
-
-    const runtimeChunks = func.runtime.split("-");
-    const runtimeVersion = runtimeChunks.pop();
-    const runtimeName = runtimeChunks.join("-");
-    const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
-
-    const tool = systemTools[runtimeName];
-
-    const id = func.$id;
-
-    const params = [ 'run' ];
-    params.push('--rm');
-    params.push('--name', id);
-    params.push('-p', `${port}:3000`);
-    params.push('-e', 'OPEN_RUNTIMES_ENV=development');
-    params.push('-e', 'OPEN_RUNTIMES_SECRET=');
-
-   for(const k of Object.keys(variables)) {
-        params.push('-e', `${k}=${variables[k]}`);
-    }
-
-    params.push('-v', `${functionDir}/.appwrite/logs.txt:/mnt/logs/dev_logs.log:rw`);
-    params.push('-v', `${functionDir}/.appwrite/errors.txt:/mnt/logs/dev_errors.log:rw`);
-    params.push('-v', `${functionDir}/.appwrite/build.tar.gz:/mnt/code/code.tar.gz:ro`);
-    params.push(imageName, 'sh', '-c', `helpers/start.sh "${tool.startCommand}"`);
-
-    const startProcess = childProcess.spawn('docker', params, {
-        stdio: 'pipe',
-        pwd: functionDir,
-        env: {
-            ...process.env,
-            DOCKER_CLI_HINTS: 'false'
-        }
-    });
-
-    startProcess.stdout.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(data));
-    });
-
-    startProcess.stderr.on('data', (data) => {
-        process.stdout.write(chalk.blackBright(data));
-    });
-
-    try {
-        await waitUntilPortOpen(port);
-    } catch(err) {
-        error("Failed to start function with error: " + err.message ? err.message : err.toString());
-        return;
-    }
-
-    success(`Visit http://localhost:${port}/ to execute your function.`);
-}
-
-async function dockerCleanup(functionId) {
-    await dockerStop(functionId);
-
-    const func = localConfig.getFunction(functionId);
-    const appwritePath = path.join(localConfig.getDirname(), func.path, '.appwrite');
-    if (fs.existsSync(appwritePath)) {
-        fs.rmSync(appwritePath, { recursive: true, force: true });
-    }
-
-    const tempPath = path.join(localConfig.getDirname(), func.path, 'code.tar.gz');
-    if (fs.existsSync(tempPath)) {
-        fs.rmSync(tempPath, { force: true });
-    }
-}
-
-function waitUntilPortOpen(port, iteration = 0) {
-    return new Promise((resolve, reject) => {
-        const client = new net.Socket();
-
-        client.once('connect', () => {
-            client.removeAllListeners('connect');
-            client.removeAllListeners('error');
-            client.end();
-            client.destroy();
-            client.unref();
-
-            resolve();
-        });
-
-        client.once('error', async (err) => {
-            client.removeAllListeners('connect');
-            client.removeAllListeners('error');
-            client.end();
-            client.destroy();
-            client.unref();
-
-            if(iteration > 100) {
-                reject(err);
-            } else {
-                await new Promise((res) => setTimeout(res, 100));
-                waitUntilPortOpen(port, iteration + 1).then(resolve).catch(reject);
-            }
-        });
-
-        client.connect({port, host: '127.0.0.1'}, function() {});
-    });
-}
-
-module.exports = {
-    dockerPull,
-    dockerBuild,
-    dockerStart,
-    dockerCleanup,
-    dockerStop,
-}

package/lib/exception.js

@@ -1,9 +0,0 @@
-class AppwriteException extends Error {
-  constructor(message, code, response) {
-    super(message);
-    this.code = code;
-    this.response = response;
-  }
-}
-
-module.exports = AppwriteException;

package/lib/parser.js

@@ -1,250 +0,0 @@
-const chalk = require('chalk');
-const commander = require('commander');
-const Table = require('cli-table3');
-const { description } = require('../package.json');
-const { globalConfig } = require("./config.js");
-const os = require('os');
-const Client = require("./client");
-const { isCloud } = require("./utils");
-
-const cliConfig = {
-    verbose: false,
-    json: false,
-    force: false,
-    all: false,
-    ids: [],
-    report: false,
-    reportData: {}
-};
-
-const parse = (data) => {
-    if (cliConfig.json) {
-        drawJSON(data);
-        return;
-    }
-
-    for (let key in data) {
-        if (data[key] === null) {
-            console.log(`${chalk.yellow.bold(key)} : null`);
-        } else if (Array.isArray(data[key])) {
-            console.log(`${chalk.yellow.bold.underline(key)}`);
-            if (typeof data[key][0] === 'object') {
-                drawTable(data[key]);
-            } else {
-                drawJSON(data[key]);
-            }
-        } else if (typeof data[key] === 'object') {
-            if (data[key]?.constructor?.name === 'BigNumber') {
-                console.log(`${chalk.yellow.bold(key)} : ${data[key]}`);
-            } else {
-                console.log(`${chalk.yellow.bold.underline(key)}`)
-                drawTable([data[key]]);
-            }
-        } else {
-            console.log(`${chalk.yellow.bold(key)} : ${data[key]}`);
-        }
-    }
-}
-
-const drawTable = (data) => {
-    if (data.length == 0) {
-        console.log("[]")
-        return;
-    }
-
-    // Create an object with all the keys in it
-    let obj = data.reduce((res, item) => ({ ...res, ...item }));
-    // Get those keys as an array
-    let keys = Object.keys(obj);
-    // Create an object with all keys set to the default value ''
-    let def = keys.reduce((result, key) => {
-        result[key] = '-'
-        return result;
-    }, {});
-    // Use object destrucuring to replace all default values with the ones we have
-    data = data.map((item) => ({ ...def, ...item }));
-
-    let columns = Object.keys(data[0]);
-
-    let table = new Table({
-        head: columns.map(c => chalk.cyan.italic.bold(c)),
-        chars: {
-            'top': ' ',
-            'top-mid': ' ',
-            'top-left': ' ',
-            'top-right': ' ',
-            'bottom': ' ',
-            'bottom-mid': ' ',
-            'bottom-left': ' ',
-            'bottom-right': ' ',
-            'left': ' ',
-            'left-mid': ' ',
-            'mid': chalk.cyan('─'),
-            'mid-mid': chalk.cyan('┼'),
-            'right': ' ',
-            'right-mid': ' ',
-            'middle': chalk.cyan('│')
-        }
-    });
-
-    data.forEach(row => {
-        let rowValues = [];
-        for (let key in row) {
-            if (row[key] === null) {
-                rowValues.push("-");
-            } else if (Array.isArray(row[key])) {
-                rowValues.push(JSON.stringify(row[key]));
-            } else if (typeof row[key] === 'object') {
-                rowValues.push(JSON.stringify(row[key]));
-            } else {
-                rowValues.push(row[key]);
-            }
-        }
-        table.push(rowValues);
-    });
-    console.log(table.toString());
-}
-
-const drawJSON = (data) => {
-    console.log(JSON.stringify(data, null, 2));
-}
-
-const parseError = (err) => {
-    if (cliConfig.report) {
-        (async () => {
-            let appwriteVersion = 'unknown';
-            const endpoint = globalConfig.getEndpoint();
-
-            try {
-                const client = new Client().setEndpoint(endpoint);
-                const res = await client.call('get', '/health/version');
-                appwriteVersion = res.version;
-            } catch {
-            }
-
-            const version = '12.0.1';
-            const stepsToReproduce = `Running \`appwrite ${cliConfig.reportData.data.args.join(' ')}\``;
-            const yourEnvironment = `CLI version: ${version}\nOperation System: ${os.type()}\nAppwrite version: ${appwriteVersion}\nIs Cloud: ${isCloud()}`;
-
-            const stack = '```\n' + err.stack + '\n```';
-
-            const githubIssueUrl = new URL('https://github.com/appwrite/appwrite/issues/new');
-            githubIssueUrl.searchParams.append('labels', 'bug');
-            githubIssueUrl.searchParams.append('template', 'bug.yaml');
-            githubIssueUrl.searchParams.append('title', `🐛 Bug Report: ${err.message}`);
-            githubIssueUrl.searchParams.append('actual-behavior', `CLI Error:\n${stack}`);
-            githubIssueUrl.searchParams.append('steps-to-reproduce', stepsToReproduce);
-            githubIssueUrl.searchParams.append('environment', yourEnvironment);
-
-            log(`To report this error you can:\n - Create a support ticket in our Discord server https://appwrite.io/discord \n - Create an issue in our Github\n   ${githubIssueUrl.href}\n`);
-
-
-            error('\n Stack Trace: \n');
-            console.error(err);
-            process.exit(1);
-        })()
-    } else {
-        if (cliConfig.verbose) {
-            console.error(err);
-        } else {
-            log('For detailed error pass the --verbose or --report flag');
-            error(err.message);
-        }
-        process.exit(1);
-    }
-
-}
-
-const actionRunner = (fn) => {
-    return (...args) => {
-        if (cliConfig.all && (Array.isArray(cliConfig.ids) && cliConfig.ids.length !== 0)) {
-            error(`The '--all' and '--id' flags cannot be used together.`);
-            process.exit(1);
-        }
-        return fn(...args).catch(parseError)
-    };
-}
-
-const parseInteger = (value) => {
-    const parsedValue = parseInt(value, 10);
-    if (isNaN(parsedValue)) {
-        throw new commander.InvalidArgumentError('Not a number.');
-    }
-    return parsedValue;
-}
-
-const parseBool = (value) => {
-    if (value === 'true') return true;
-    if (value === 'false') return false;
-    throw new commander.InvalidArgumentError('Not a boolean.');
-}
-
-const log = (message) => {
-    console.log(`${chalk.cyan.bold("ℹ Info:")} ${chalk.cyan(message ?? "")}`);
-}
-
-const warn = (message) => {
-    console.log(`${chalk.yellow.bold("ℹ Warning:")} ${chalk.yellow(message ?? "")}`);
-}
-
-const hint = (message) => {
-    console.log(`${chalk.cyan.bold("♥ Hint:")} ${chalk.cyan(message ?? "")}`);
-}
-
-const success = (message) => {
-    console.log(`${chalk.green.bold("✓ Success:")} ${chalk.green(message ?? "")}`);
-}
-
-const error = (message) => {
-    console.error(`${chalk.red.bold("✗ Error:")} ${chalk.red(message ?? "")}`);
-}
-
-const logo = "\n    _                            _ _           ___   __   _____\n   \/_\\  _ __  _ ____      ___ __(_) |_ ___    \/ __\\ \/ \/   \\_   \\\n  \/\/_\\\\| '_ \\| '_ \\ \\ \/\\ \/ \/ '__| | __\/ _ \\  \/ \/   \/ \/     \/ \/\\\/\n \/  _  \\ |_) | |_) \\ V  V \/| |  | | ||  __\/ \/ \/___\/ \/___\/\\\/ \/_\n \\_\/ \\_\/ .__\/| .__\/ \\_\/\\_\/ |_|  |_|\\__\\___| \\____\/\\____\/\\____\/\n       |_|   |_|\n\n";
-
-const commandDescriptions = {
-    "account": `The account command allows you to authenticate and manage a user account.`,
-    "graphql": `The graphql command allows you to query and mutate any resource type on your Appwrite server.`,
-    "avatars": `The avatars command aims to help you complete everyday tasks related to your app image, icons, and avatars.`,
-    "databases": `(Legacy) The databases command allows you to create structured collections of documents and query and filter lists of documents.`,
-    'tables-db': `The tables-db command allows you to create structured tables of columns and query and filter lists of rows.`,
-    "init": `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, and messaging-topics in  Appwrite.`,
-    "push": `The push command provides a convenient wrapper for pushing your functions, collections, buckets, teams, and messaging-topics.`,
-    "run": `The run command allows you to run the project locally to allow easy development and quick debugging.`,
-    "functions": `The functions command allows you to view, create, and manage your Cloud Functions.`,
-    "health": `The health command allows you to both validate and monitor your Appwrite server's health.`,
-    "pull": `The pull command helps you pull your Appwrite project, functions, collections, buckets, teams, and messaging-topics`,
-    "locale": `The locale command allows you to customize your app based on your users' location.`,
-    "sites": `The sites command allows you to view, create and manage your Appwrite Sites.`,
-    "storage": `The storage command allows you to manage your project files.`,
-    "teams": `The teams command allows you to group users of your project to enable them to share read and write access to your project resources.`,
-    "update": `The update command allows you to update the Appwrite CLI to the latest version.`,
-    "users": `The users command allows you to manage your project users.`,
-    "projects": `The projects command allows you to manage your projects, add platforms, manage API keys, Dev Keys etc.`,
-    "project": `The project command allows you to manage project related resources like usage, variables, etc.`,
-    "client": `The client command allows you to configure your CLI`,
-    "login": `The login command allows you to authenticate and manage a user account.`,
-    "logout": `The logout command allows you to log out of your Appwrite account.`,
-    "whoami": `The whomai command gives information about the currently logged-in user.`,
-    "register": `Outputs the link to create an Appwrite account.`,
-    "console" : `The console command gives you access to the APIs used by the Appwrite Console.`,
-    "messaging": `The messaging command allows you to manage topics and targets and send messages.`,
-    "migrations": `The migrations command allows you to migrate data between services.`,
-    "vcs": `The vcs command allows you to interact with VCS providers and manage your code repositories.`,
-    "main": chalk.redBright(`${logo}${description}`),
-}
-
-module.exports = {
-    drawTable,
-    parse,
-    actionRunner,
-    parseInteger,
-    parseBool,
-    log,
-    warn,
-    hint,
-    success,
-    error,
-    commandDescriptions,
-    cliConfig,
-    drawTable
-}

package/lib/sdks.js

@@ -1,60 +0,0 @@
-const Client = require("./client");
-const { globalConfig, localConfig } = require("./config");
-
-const sdkForConsole = async (requiresAuth = true) => {
-  let client = new Client();
-  let endpoint = globalConfig.getEndpoint();
-  let cookie = globalConfig.getCookie()
-  let selfSigned = globalConfig.getSelfSigned()
-
-  if (requiresAuth && cookie === "") {
-    throw new Error("Session not found. Please run `appwrite login` to create a session");
-  }
-
-  client
-    .setEndpoint(endpoint)
-    .setCookie(cookie)
-    .setProject("console")
-    .setSelfSigned(selfSigned)
-    .setLocale("en-US");
-
-  return client;
-};
-
-const sdkForProject = async () => {
-  let client = new Client();
-  let endpoint = localConfig.getEndpoint() || globalConfig.getEndpoint();
-  let project = localConfig.getProject().projectId ? localConfig.getProject().projectId : globalConfig.getProject();
-  let key = globalConfig.getKey();
-  let cookie = globalConfig.getCookie()
-  let selfSigned = globalConfig.getSelfSigned()
-
-  if (!project) {
-    throw new Error("Project is not set. Please run `appwrite init project` to initialize the current directory with an Appwrite project.");
-  }
-
-  client
-    .setEndpoint(endpoint)
-    .setProject(project)
-    .setSelfSigned(selfSigned)
-    .setLocale("en-US");
-
-  if (cookie) {
-    return client
-      .setCookie(cookie)
-      .setMode("admin");
-  }
-
-  if (key) {
-    return client
-      .setKey(key)
-      .setMode("default");
-  }
-
-  throw new Error("Session not found. Please run `appwrite login` to create a session.");
-};
-
-module.exports = {
-  sdkForConsole,
-  sdkForProject,
-};

package/lib/spinner.js

@@ -1,104 +0,0 @@
-const progress = require('cli-progress');
-const chalk = require('chalk');
-
-const SPINNER_ARC = 'arc';
-const SPINNER_DOTS = 'dots';
-
-const spinners = {
-    [SPINNER_ARC]: {
-        "interval": 100,
-        "frames": ["◜", "◠", "◝", "◞", "◡", "◟"]
-    },
-    [SPINNER_DOTS]: {
-        "interval": 80,
-        "frames": ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
-    }
-}
-
-class Spinner {
-    static start(clearOnComplete = true, hideCursor = true) {
-        Spinner.updatesBar = new progress.MultiBar({
-            format: this.#formatter,
-            hideCursor,
-            clearOnComplete,
-            stopOnComplete: true,
-            linewrap: true,
-            noTTYOutput: true
-        });
-    }
-
-    static stop() {
-        Spinner.updatesBar.stop();
-    }
-
-    static #formatter(options, params, payload) {
-        const status = payload.status.padEnd(12);
-        const middle = `${payload.resource} (${payload.id})`.padEnd(40);
-
-        let prefix = chalk.cyan(payload.prefix ?? '⧗');
-        let start = chalk.cyan(status);
-        let end = chalk.yellow(payload.end);
-
-        if (status.toLowerCase().trim() === 'pushed') {
-            start = chalk.greenBright.bold(status);
-            prefix = chalk.greenBright.bold('✓');
-            end = '';
-        } else if (status.toLowerCase().trim() === 'deploying') {
-            start = chalk.cyanBright.bold(status);
-        } else if (status.toLowerCase().trim() === 'deployed') {
-            start = chalk.green.bold(status);
-            prefix = chalk.green.bold('✓');
-        } else if (status.toLowerCase().trim() === 'error') {
-            start = chalk.red.bold(status);
-            prefix = chalk.red.bold('✗');
-            end = chalk.red(payload.errorMessage);
-        }
-
-        return Spinner.#line(prefix, start, middle, end);
-    }
-
-    static #line(prefix, start, middle, end, separator = '•') {
-        return `${prefix} ${start} ${separator} ${middle} ${!end ? '' : separator} ${end}`;
-
-    }
-
-    constructor(payload, total = 100, startValue = 0) {
-        this.bar = Spinner.updatesBar.create(total, startValue, payload)
-    }
-
-    update(payload) {
-        this.bar.update(payload);
-        return this;
-    }
-
-    fail(payload) {
-        this.stopSpinner();
-        this.update({ status: 'Error', ...payload });
-    }
-
-    startSpinner(name) {
-        let spinnerFrame = 1;
-        const spinner = spinners[name] ?? spinners['dots'];
-
-        this.spinnerInterval = setInterval(() => {
-            if (spinnerFrame === spinner.frames.length) spinnerFrame = 1;
-            this.bar.update({ prefix: spinner.frames[spinnerFrame++] });
-        }, spinner.interval);
-    }
-
-    stopSpinner() {
-        clearInterval(this.spinnerInterval);
-    }
-
-    replaceSpinner(name) {
-        this.stopSpinner();
-        this.startSpinner(name);
-    }
-}
-
-
-module.exports = {
-    Spinner,
-    SPINNER_ARC,
-    SPINNER_DOTS
-}