appwrite-cli 5.0.3 → 6.0.0-rc.1

package/lib/sdks.js

@@ -68,7 +68,7 @@ const sdkForProject = async () => {
   }
 
   if (!project) {
-    throw new Error("Project is not set. Please run `appwrite init project` to initialize the current directory with an Appwrite project.");
+    throw new Error("Project is not set. Please run `appwrite init` to initialize the current directory with an Appwrite project.");
   }
 
   client

package/lib/spinner.js

@@ -0,0 +1,103 @@
+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,
+            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
+}

package/lib/utils.js

@@ -1,9 +1,13 @@
 const fs = require("fs");
 const path = require("path");
+const net = require("net");
+const childProcess = require('child_process');
+const { localConfig, globalConfig } = require("./config");
+const { success } = require('./parser')
 
 function getAllFiles(folder) {
     const files = [];
-    for(const pathDir of fs.readdirSync(folder)) {
+    for (const pathDir of fs.readdirSync(folder)) {
         const pathAbsolute = path.join(folder, pathDir);
         if (fs.statSync(pathAbsolute).isDirectory()) {
             files.push(...getAllFiles(pathAbsolute));
@@ -14,6 +18,247 @@ function getAllFiles(folder) {
     return files;
 }
 
+async function isPortTaken(port) {
+    const taken = await new Promise((res, rej) => {
+        const tester = net.createServer()
+        .once('error', function (err) {
+            if (err.code != 'EADDRINUSE') return rej(err)
+                res(true)
+            })
+            .once('listening', function() {
+                tester.once('close', function() { res(false) })
+                .close()
+            })
+            .listen(port);
+    });
+
+    return taken;
+}
+
+function systemHasCommand(command) {
+    const isUsingWindows = process.platform == 'win32'
+
+     try {
+        if(isUsingWindows) {
+            childProcess.execSync('where ' + command, { stdio: 'pipe' })
+        } else {
+            childProcess.execSync(`[[ $(${command} --version) ]] || { exit 1; } && echo "OK"`, { stdio: 'pipe', shell: '/bin/bash' });
+        }
+    } catch (error) {
+        console.log(error);
+        return false;
+    }
+
+    return true;
+}
+
+const checkDeployConditions = (localConfig) => {
+    if (Object.keys(localConfig.data).length === 0) {
+        throw new Error("No appwrite.json file found in the current directory. Please run this command again in the folder containing your appwrite.json file, or run 'appwrite init project' to link current directory to an Appwrite project.");
+    }
+}
+
+function showConsoleLink(serviceName, action, ...ids) {
+    const projectId = localConfig.getProject().projectId;
+
+    const url = new URL(globalConfig.getEndpoint().replace('/v1', '/console'));
+    url.pathname += `/project-${projectId}`;
+    action = action.toLowerCase();
+
+    switch (serviceName) {
+        case "account":
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getAccountPath(action);
+            break;
+        case "databases":
+            url.pathname += getDatabasePath(action, ids);
+            break;
+        case "functions":
+            url.pathname += getFunctionsPath(action, ids);
+            break;
+        case "messaging":
+            url.pathname += getMessagingPath(action, ids);
+            break;
+        case "projects":
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getProjectsPath(action, ids);
+            break;
+        case "storage":
+            url.pathname += getBucketsPath(action, ids);
+            break;
+        case "teams":
+            url.pathname += getTeamsPath(action, ids);
+            break;
+        case "users":
+            url.pathname += getUsersPath(action, ids);
+            break;
+        default:
+            return;
+    }
+
+
+    success(url);
+}
+
+function getAccountPath(action) {
+    let path = '/account';
+
+    if (action === 'listsessions') {
+        path += '/sessions';
+    }
+
+    return path;
+}
+
+function getDatabasePath(action, ids) {
+    let path = '/databases';
+
+
+    if (['get', 'listcollections', 'getcollection', 'listattributes', 'listdocuments', 'getdocument', 'listindexes', 'getdatabaseusage'].includes(action)) {
+        path += `/database-${ids[0]}`;
+    }
+
+    if (action === 'getdatabaseusage') {
+        path += `/usage`;
+    }
+
+    if (['getcollection', 'listattributes', 'listdocuments', 'getdocument', 'listindexes'].includes(action)) {
+        path += `/collection-${ids[1]}`;
+    }
+
+    if (action === 'listattributes') {
+        path += '/attributes';
+    }
+    if (action === 'listindexes') {
+        path += '/indexes';
+    }
+    if (action === 'getdocument') {
+        path += `/document-${ids[2]}`;
+    }
+
+
+    return path;
+}
+
+function getFunctionsPath(action, ids) {
+    let path = '/functions';
+
+    if (action !== 'list') {
+        path += `/function-${ids[0]}`;
+    }
+
+    if (action === 'getdeployment') {
+        path += `/deployment-${ids[1]}`
+    }
+
+    if (action === 'getexecution' || action === 'listexecution') {
+        path += `/executions`
+    }
+    if (action === 'getfunctionusage') {
+        path += `/usage`
+    }
+
+    return path;
+}
+
+function getMessagingPath(action, ids) {
+    let path = '/messaging';
+
+    if (['getmessage', 'listmessagelogs'].includes(action)) {
+        path += `/message-${ids[0]}`;
+    }
+
+    if (['listproviders', 'getprovider'].includes(action)) {
+        path += `/providers`;
+    }
+
+    if (action === 'getprovider') {
+        path += `/provider-${ids[0]}`;
+    }
+
+    if (['listtopics', 'gettopic'].includes(action)) {
+        path += `/topics`;
+    }
+
+    if (action === 'gettopic') {
+        path += `/topic-${ids[0]}`;
+    }
+
+    return path;
+}
+
+function getProjectsPath(action, ids) {
+    let path = '';
+
+    if (action !== 'list') {
+        path += `/project-${ids[0]}`;
+    }
+
+    if (['listkeys', 'getkey'].includes(action)) {
+        path += '/overview/keys'
+    }
+
+    if (['listplatforms', 'getplatform'].includes(action)) {
+        path += '/overview/platforms'
+    }
+
+    if (['listwebhooks', 'getwebhook'].includes(action)) {
+        path += '/settings/webhooks'
+    }
+
+    if (['getplatform', 'getkey', 'getwebhook'].includes(action)) {
+        path += `/${ids[1]}`;
+    }
+
+    return path;
+}
+
+function getBucketsPath(action, ids) {
+    let path = '/storage';
+
+    if (action !== 'listbuckets') {
+        path += `/bucket-${ids[0]}`;
+    }
+
+    if (action === 'getbucketusage') {
+        path += `/usage`
+    }
+
+    if (action === 'getfile') {
+        path += `/file-${ids[1]}`
+    }
+
+    return path;
+}
+
+function getTeamsPath(action, ids) {
+    let path = '/auth/teams';
+
+    if (action !== 'list') {
+        path += `/team-${ids[0]}`;
+    }
+
+    return path;
+}
+
+function getUsersPath(action, ids) {
+    let path = '/auth';
+
+    if (action !== 'list') {
+        path += `/user-${ids[0]}`;
+    }
+
+    if (action === 'listsessions') {
+        path += 'sessions';
+    }
+
+    return path;
+}
+
 module.exports = {
-    getAllFiles
-};
+    getAllFiles,
+    isPortTaken,
+    systemHasCommand,
+    checkDeployConditions,
+    showConsoleLink
+};

package/lib/validations.js

@@ -0,0 +1,17 @@
+const validateRequired = (resource, value) => {
+    if (Array.isArray(value)) {
+        if (value.length <= 0) {
+            return `Please select at least one ${resource}`;
+        }
+    } else {
+        if (value === undefined || value === null || value === 0 || (typeof value === "string" && value.trim() === '')) {
+            return `${resource} is required`;
+        }
+    }
+
+    return true;
+}
+
+module.exports = {
+    validateRequired
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "appwrite-cli",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "5.0.3",
+  "version": "6.0.0-rc.1",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {
@@ -24,13 +24,17 @@
   "dependencies": {
     "undici": "^5.28.2",
     "chalk": "4.1.2",
+    "cli-progress": "^3.12.0",
     "cli-table3": "^0.6.2",
     "commander": "^9.2.0",
     "form-data": "^4.0.0",
     "json-bigint": "^1.0.0",
     "inquirer": "^8.2.4",
+    "inquirer-search-list": "^1.2.6",
     "tar": "^6.1.11",
-    "ignore": "^5.2.0"
+    "ignore": "^5.2.0",
+    "chokidar": "^3.6.0",
+    "tail": "^2.2.6"
   },
   "devDependencies": {
     "pkg": "5.8.1"

package/scoop/appwrite.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "5.0.3",
+	"version": "6.0.0-rc.1",
 	"description": "The Appwrite CLI is a command-line application that allows you to interact with Appwrite and perform server-side tasks using your terminal.",
 	"homepage": "https://github.com/appwrite/sdk-for-cli",
 	"license": "BSD-3-Clause",
 	"architecture": {
 		"64bit": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/5.0.3/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.1/appwrite-cli-win-x64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-x64.exe",
@@ -15,7 +15,7 @@
 			]
 		},
 		"arm64": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/5.0.3/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.1/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",