appwrite-cli 6.0.0-rc.1 → 6.0.0-rc.2

package/lib/config.js

@@ -4,6 +4,38 @@ const _path = require("path");
 const process = require("process");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 
+const KeysFunction = ["path", "$id", "execute", "name", "enabled", "logging", "runtime", "scopes", "events", "schedule", "timeout", "entrypoint", "commands"];
+const KeysDatabase = ["$id", "name", "enabled"];
+const KeysCollection = ["$id", "$permissions", "databaseId", "name", "enabled", "documentSecurity", "attributes", "indexes"];
+const KeysStorage = ["$id", "$permissions", "fileSecurity", "name", "enabled", "maximumFileSize", "allowedFileExtensions", "compression", "encryption", "antivirus"];
+const KeyTopics = ["$id", "name", "subscribe"];
+const KeyAttributes = ["key", "type", "required", "array", "size", "default"];
+const KeyIndexes = ["key", "type", "status", "attributes", "orders"];
+
+function whitelistKeys(value, keys, nestedKeys = []) {
+    if(Array.isArray(value)) {
+        const newValue = [];
+
+        for(const item of value) {
+            newValue.push(whitelistKeys(item, keys, nestedKeys));
+        }
+
+        return newValue;
+    }
+
+    const newValue = {};
+    Object.keys(value).forEach((key) => {
+        if(keys.includes(key)) {
+            if(nestedKeys[key]) {
+                newValue[key] = whitelistKeys(value[key], nestedKeys[key]);
+            } else {
+                newValue[key] = value[key];
+            }
+        }
+    });
+    return newValue;
+}
+
 class Config {
     constructor(path) {
         this.path = path;
@@ -94,6 +126,8 @@ class Local extends Config {
     }
 
     addFunction(props) {
+        props = whitelistKeys(props, KeysFunction);
+
         if (!this.has("functions")) {
             this.set("functions", []);
         }
@@ -101,21 +135,6 @@ class Local extends Config {
         let functions = this.get("functions");
         for (let i = 0; i < functions.length; i++) {
             if (functions[i]['$id'] == props['$id']) {
-                return;
-            }
-        }
-        functions.push(props);
-        this.set("functions", functions);
-    }
-
-    updateFunction(id, props) {
-        if (!this.has("functions")) {
-            return;
-        }
-
-        let functions = this.get("functions");
-        for (let i = 0; i < functions.length; i++) {
-            if (functions[i]['$id'] == id) {
                 functions[i] = {
                     ...functions[i],
                     ...props
@@ -124,6 +143,9 @@ class Local extends Config {
                 return;
             }
         }
+
+        functions.push(props);
+        this.set("functions", functions);
     }
 
     getCollections() {
@@ -149,6 +171,11 @@ class Local extends Config {
     }
 
     addCollection(props) {
+        props = whitelistKeys(props, KeysCollection, {
+            attributes: KeyAttributes,
+            indexes: KeyIndexes
+        });
+
         if (!this.has("collections")) {
             this.set("collections", []);
         }
@@ -188,6 +215,8 @@ class Local extends Config {
     }
 
     addBucket(props) {
+        props = whitelistKeys(props, KeysStorage);
+
         if (!this.has("buckets")) {
             this.set("buckets", []);
         }
@@ -227,6 +256,8 @@ class Local extends Config {
     }
 
     addMessagingTopic(props) {
+        props = whitelistKeys(props, KeyTopics);
+
         if (!this.has("topics")) {
             this.set("topics", []);
         }
@@ -266,6 +297,8 @@ class Local extends Config {
     }
 
     addDatabase(props) {
+        props = whitelistKeys(props, KeysDatabase);
+
         if (!this.has("databases")) {
             this.set("databases", []);
         }
@@ -329,7 +362,7 @@ class Local extends Config {
         return {
             projectId: this.get("projectId"),
             projectName: this.get("projectName"),
-            projectSettings: this.get('projectSettings')
+            projectSettings: this.get('settings')
         };
     }
 
@@ -357,7 +390,6 @@ class Local extends Config {
                 functions: projectSettings.serviceStatusForFunctions,
                 graphql: projectSettings.serviceStatusForGraphql,
                 messaging: projectSettings.serviceStatusForMessaging,
-
             },
             auth: {
                 methods: {
@@ -380,7 +412,7 @@ class Local extends Config {
             }
         };
 
-        this.set('projectSettings', settings)
+        this.set('settings', settings)
     }
 
 }
@@ -520,7 +552,7 @@ class Global extends Config {
         const current = this.getCurrentSession();
 
         if (current) {
-            const config = this.get(current);
+            const config = this.get(current) ?? {};
 
             return config[key] !== undefined;
         }
@@ -530,7 +562,7 @@ class Global extends Config {
         const current = this.getCurrentSession();
 
         if (current) {
-            const config = this.get(current);
+            const config = this.get(current) ?? {};
 
             return config[key];
         }

package/lib/emulation/docker.js

@@ -1,15 +1,12 @@
+const chalk = require('chalk');
 const childProcess = require('child_process');
 const { localConfig } = require("../config");
 const path = require('path');
 const fs = require('fs');
-const { log,success } = require("../parser");
+const { log, success, hint } = require("../parser");
 const { openRuntimesVersion, systemTools } = require("./utils");
-const ID = require("../id");
-
-const activeDockerIds = {};
 
 async function dockerStop(id) {
-    delete activeDockerIds[id];
     const stopProcess = childProcess.spawn('docker', ['rm', '--force', id], {
         stdio: 'pipe',
     });
@@ -18,20 +15,42 @@ async function dockerStop(id) {
 }
 
 async function dockerPull(func) {
-    log('Pulling Docker image of function runtime ...');
-
     const runtimeChunks = func.runtime.split("-");
     const runtimeVersion = runtimeChunks.pop();
     const runtimeName = runtimeChunks.join("-");
     const imageName = `openruntimes/${runtimeName}:${openRuntimesVersion}-${runtimeVersion}`;
 
-    const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
+    const checkProcess = childProcess.spawn('docker', ['images', '--format', 'json', imageName], {
         stdio: 'pipe',
         pwd: path.join(process.cwd(), func.path)
     });
 
-    pullProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}$ `);
+    let hasImage = false;
+
+    checkProcess.stdout.on('data', (data) => {
+        if(data) {
+            hasImage = false;
+        }
+    });
+
+    checkProcess.stderr.on('data', (data) => {
+        if(data) {
+            hasImage = false;
+        }
+    });
+
+    await new Promise((res) => { checkProcess.on('close', res) });
+
+    if(hasImage) {
+        return;
+    }
+
+    log('Pulling Docker image ...');
+    hint('This may take a few minutes, but we only need to do this once.');
+
+    const pullProcess = childProcess.spawn('docker', ['pull', imageName], {
+        stdio: 'pipe',
+        pwd: path.join(process.cwd(), func.path)
     });
 
     await new Promise((res) => { pullProcess.on('close', res) });
@@ -47,7 +66,7 @@ async function dockerBuild(func, variables) {
 
     const functionDir = path.join(process.cwd(), func.path);
 
-    const id = ID.unique();
+    const id = func.$id;
 
     const params = [ 'run' ];
     params.push('--name', id);
@@ -55,6 +74,7 @@ async function dockerBuild(func, variables) {
     params.push('-e', 'APPWRITE_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_SECRET=');
+    params.push('-l', 'appwrite-env=dev');
     params.push('-e', `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
 
     for(const k of Object.keys(variables)) {
@@ -69,11 +89,11 @@ async function dockerBuild(func, variables) {
     });
 
     buildProcess.stdout.on('data', (data) => {
-        process.stdout.write(`\n${data}`);
+        process.stdout.write(chalk.blackBright(`${data}\n`));
     });
 
     buildProcess.stderr.on('data', (data) => {
-        process.stderr.write(`\n${data}`);
+        process.stderr.write(chalk.blackBright(`${data}\n`));
     });
 
     await new Promise((res) => { buildProcess.on('close', res) });
@@ -91,14 +111,7 @@ async function dockerBuild(func, variables) {
 
     await new Promise((res) => { copyProcess.on('close', res) });
 
-    const cleanupProcess = childProcess.spawn('docker', ['rm', '--force', id], {
-        stdio: 'pipe',
-        pwd: functionDir
-    });
-
-    await new Promise((res) => { cleanupProcess.on('close', res) });
-
-    delete activeDockerIds[id];
+    await dockerStop(id);
 
     const tempPath = path.join(process.cwd(), func.path, 'code.tar.gz');
     if (fs.existsSync(tempPath)) {
@@ -107,15 +120,6 @@ async function dockerBuild(func, variables) {
 }
 
 async function dockerStart(func, variables, port) {
-   log('Starting function using Docker ...');
-
-   log("Permissions, events, CRON and timeouts dont apply when running locally.");
-
-   log('💡 Hint: Function automatically restarts when you edit your code.');
-
-   success(`Visit http://localhost:${port}/ to execute your function.`);
-
-
    const runtimeChunks = func.runtime.split("-");
    const runtimeVersion = runtimeChunks.pop();
    const runtimeName = runtimeChunks.join("-");
@@ -125,13 +129,14 @@ async function dockerStart(func, variables, port) {
 
     const functionDir = path.join(process.cwd(), func.path);
 
-    const id = ID.unique();
+    const id = func.$id;
 
     const params = [ 'run' ];
     params.push('--rm');
     params.push('-d');
     params.push('--name', id);
     params.push('-p', `${port}:3000`);
+    params.push('-l', 'appwrite-env=dev');
     params.push('-e', 'APPWRITE_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_ENV=development');
     params.push('-e', 'OPEN_RUNTIMES_SECRET=');
@@ -150,11 +155,11 @@ async function dockerStart(func, variables, port) {
         pwd: functionDir
     });
 
-    activeDockerIds[id] = true;
+    success(`Visit http://localhost:${port}/ to execute your function.`);
 }
 
 async function dockerCleanup() {
-    await dockerStop();
+    await dockerStopActive();
 
     const functions = localConfig.getFunctions();
     for(const func of functions) {
@@ -171,17 +176,40 @@ async function dockerCleanup() {
 }
 
 async function dockerStopActive() {
-    const ids = Object.keys(activeDockerIds);
-    for await (const id of ids) {
+    const listProcess = childProcess.spawn('docker', ['ps', '-a', '-q', '--filter', 'label=appwrite-env=dev'], {
+        stdio: 'pipe',
+    });
+
+    const ids = [];
+    function handleOutput(data) {
+        const list = data.toString().split('\n');
+        for(const id of list) {
+            if(id && !id.includes(' ')) {
+                ids.push(id);
+            }
+        }
+    }
+
+    listProcess.stdout.on('data', (data) => {
+        handleOutput(data);
+    });
+
+    listProcess.stderr.on('data', (data) => {
+        handleOutput(data);
+    });
+
+    await new Promise((res) => { listProcess.on('close', res) });
+
+    for(const id of ids) {
         await dockerStop(id);
     }
 }
 
 module.exports = {
-    dockerStop,
     dockerPull,
     dockerBuild,
     dockerStart,
     dockerCleanup,
     dockerStopActive,
+    dockerStop,
 }

package/lib/emulation/utils.js

@@ -2,8 +2,7 @@ const EventEmitter = require('node:events');
 const { projectsCreateJWT } = require('../commands/projects');
 const { localConfig } = require("../config");
 
-
-const openRuntimesVersion = 'v3';
+const openRuntimesVersion = 'v4';
 
 const runtimeNames = {
     'node': 'Node.js',
@@ -17,7 +16,8 @@ const runtimeNames = {
     'java': 'Java',
     'swift': 'Swift',
     'kotlin': 'Kotlin',
-    'bun': 'Bun'
+    'bun': 'Bun',
+    'go': 'Go',
 };
 
 const systemTools = {
@@ -81,6 +81,11 @@ const systemTools = {
         startCommand: "bun src/server.ts",
         dependencyFiles: [ "package.json", "package-lock.json", "bun.lockb" ]
     },
+    'go': {
+        isCompiled: true,
+        startCommand: "src/function/server",
+        dependencyFiles: [ ]
+    },
 };
 
 const JwtManager = {

package/lib/parser.js

@@ -131,7 +131,7 @@ const parseError = (err) => {
             } catch {
             }
 
-            const version = '6.0.0-rc.1';
+            const version = '6.0.0-rc.2';
             const stepsToReproduce = `Running \`appwrite ${cliConfig.reportData.data.args.join(' ')}\``;
             const yourEnvironment = `CLI version: ${version}\nOperation System: ${os.type()}\nAppwrite version: ${appwriteVersion}\nIs Cloud: ${isCloud}`;
 
@@ -189,15 +189,23 @@ const parseBool = (value) => {
 }
 
 const log = (message) => {
-    console.log(`${chalk.cyan.bold("ℹ Info")} ${chalk.cyan(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 ?? "")}`);
+    console.log(`${chalk.green.bold("✓ Success:")} ${chalk.green(message ?? "")}`);
 }
 
 const error = (message) => {
-    console.error(`${chalk.red.bold("✗ Error")} ${chalk.red(message ?? "")}`);
+    console.error(`${chalk.red.bold("✗ Error:")} ${chalk.red(message ?? "")}`);
 }
 
 const logo = "\n    _                            _ _           ___   __   _____\n   \/_\\  _ __  _ ____      ___ __(_) |_ ___    \/ __\\ \/ \/   \\_   \\\n  \/\/_\\\\| '_ \\| '_ \\ \\ \/\\ \/ \/ '__| | __\/ _ \\  \/ \/   \/ \/     \/ \/\\\/\n \/  _  \\ |_) | |_) \\ V  V \/| |  | | ||  __\/ \/ \/___\/ \/___\/\\\/ \/_\n \\_\/ \\_\/ .__\/| .__\/ \\_\/\\_\/ |_|  |_|\\__\\___| \\____\/\\____\/\\____\/\n       |_|   |_|\n\n";
@@ -221,8 +229,8 @@ const commandDescriptions = {
     "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 logout of your Appwrite account.`,
-    "whoami": `The whoami command gives information about the currently logged in user.`,
-    "register": `Outputs the link to create an Appwrite account..`,
+    "whoami": `The whoami command gives information about the currently signed in user.`,
+    "register": `Outputs the link to create an Appwrite account.`,
     "console" : `The console command allows gives you access to the APIs used by the Appwrite console.`,
     "assistant": `The assistant command allows you to interact with the Appwrite Assistant AI`,
     "messaging": `The messaging command allows you to send messages.`,
@@ -240,6 +248,8 @@ module.exports = {
     parseInteger,
     parseBool,
     log,
+    warn,
+    hint,
     success,
     error,
     commandDescriptions,

package/lib/questions.js

@@ -46,7 +46,7 @@ const getIgnores = (runtime) => {
             return ['.build', '.swiftpm'];
     }
 
-    return undefined;
+    return [];
 };
 
 const getEntrypoint = (runtime) => {
@@ -80,6 +80,8 @@ const getEntrypoint = (runtime) => {
             return 'src/Main.java';
         case 'kotlin':
             return 'src/Main.kt';
+        case 'go':
+            return 'main.go';
     }
 
     return undefined;
@@ -209,18 +211,26 @@ const questionsInitProject = [
         when: (answer) => answer.start === 'existing'
     }
 ];
+const questionsInitProjectAutopull = [
+    {
+        type: "confirm",
+        name: "autopull",
+        message:
+            `Would you like to pull all resources from project you just linked?`
+    },
+];
 const questionsPullResources = [
     {
         type: "list",
         name: "resource",
         message: "Which resources would you like to pull?",
         choices: [
-            { name: 'Project', value: 'project' },
-            { name: 'Functions', value: 'functions' },
-            { name: 'Collections', value: 'collections' },
-            { name: 'Buckets', value: 'buckets' },
-            { name: 'Teams', value: 'teams' },
-            { name: 'Topics', value: 'messages' }
+            { name: `Settings ${chalk.blackBright(`(Project)`)}`, value: 'settings' },
+            { name: `Functions ${chalk.blackBright(`(Deployment)`)}`, value: 'functions' },
+            { name: `Collections ${chalk.blackBright(`(Databases)`)}`, value: 'collections' },
+            { name: `Buckets ${chalk.blackBright(`(Storage)`)}`, value: 'buckets' },
+            { name: `Teams ${chalk.blackBright(`(Auth)`)}`, value: 'teams' },
+            { name: `Topics ${chalk.blackBright(`(Messaging)`)}`, value: 'messages' }
         ]
     }
 ]
@@ -283,8 +293,23 @@ const questionsCreateFunction = [
                 }
             })
             return choices;
-        }
-    }
+        },
+    },
+    {
+        type: "list",
+        name: "template",
+        message: "How would you like to start your function code?",
+        choices: [
+            {
+                name: `Start from scratch ${chalk.blackBright(`(starter)`)}`,
+                value: "starter"
+            },
+            {
+                name: "Pick a template",
+                value: "custom"
+            }
+        ]
+    },
 ];
 
 const questionsCreateFunctionSelectTemplate = (templates) => {
@@ -451,12 +476,12 @@ const questionsLogin = [
     {
         type: "list",
         name: "method",
-        message: "You're already logged in, what you like to do?",
+        message: "What you like to do?",
         choices: [
-            { name: 'Login to a different account', value: 'login' },
-            { name: 'Change to a different existed account', value: 'select' }
+            { name: 'Login to an account', value: 'login' },
+            { name: 'Switch to an account', value: 'select' }
         ],
-        when: () => globalConfig.getCurrentSession() !== ''
+        when: () => globalConfig.getSessions().length >= 2
     },
     {
         type: "input",
@@ -570,12 +595,12 @@ const questionsPushResources = [
         name: "resource",
         message: "Which resources would you like to push?",
         choices: [
-            { name: 'Project', value: 'project' },
-            { name: 'Functions', value: 'functions' },
-            { name: 'Collections', value: 'collections' },
-            { name: 'Buckets', value: 'buckets' },
-            { name: 'Teams', value: 'teams' },
-            { name: 'Topics', value: 'messages' }
+            { name: `Settings ${chalk.blackBright(`(Project)`)}`, value: 'settings' },
+            { name: `Functions ${chalk.blackBright(`(Deployment)`)}`, value: 'functions' },
+            { name: `Collections ${chalk.blackBright(`(Databases)`)}`, value: 'collections' },
+            { name: `Buckets ${chalk.blackBright(`(Storage)`)}`, value: 'buckets' },
+            { name: `Teams ${chalk.blackBright(`(Auth)`)}`, value: 'teams' },
+            { name: `Topics ${chalk.blackBright(`(Messaging)`)}`, value: 'messages' }
         ]
     }
 ];
@@ -605,7 +630,7 @@ const questionsPushFunctions = [
             let functions = localConfig.getFunctions();
             checkDeployConditions(localConfig)
             if (functions.length === 0) {
-                throw new Error("No functions found in the current directory Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.");
+                throw new Error("No functions found Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.");
             }
             let choices = functions.map((func, idx) => {
                 return {
@@ -794,7 +819,7 @@ const questionsRunFunctions = [
         choices: () => {
             let functions = localConfig.getFunctions();
             if (functions.length === 0) {
-                throw new Error("No functions found in the current directory. Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.");
+                throw new Error("No functions found. Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.");
             }
             let choices = functions.map((func, idx) => {
                 return {
@@ -809,6 +834,7 @@ const questionsRunFunctions = [
 
 module.exports = {
     questionsInitProject,
+    questionsInitProjectAutopull,
     questionsCreateFunction,
     questionsCreateFunctionSelectTemplate,
     questionsCreateBucket,

package/lib/sdks.js

@@ -1,44 +1,12 @@
-const inquirer = require("inquirer");
 const Client = require("./client");
 const { globalConfig, localConfig } = require("./config");
 
-const questionGetEndpoint = [
-  {
-    type: "input",
-    name: "endpoint",
-    message: "Enter the endpoint of your Appwrite server",
-    default: "http://localhost/v1",
-    async validate(value) {
-      if (!value) {
-        return "Please enter a valid endpoint.";
-      }
-      let client = new Client().setEndpoint(value);
-      try {
-        let response = await client.call('get', '/health/version');
-        if (response.version) {
-          return true;
-        } else {
-          throw new Error();
-        }
-      } catch (error) {
-        return "Invalid endpoint or your Appwrite server is not running as expected.";
-      }
-    }
-  }
-]
-
 const sdkForConsole = async (requiresAuth = true) => {
   let client = new Client();
   let endpoint = globalConfig.getEndpoint();
   let cookie = globalConfig.getCookie()
   let selfSigned = globalConfig.getSelfSigned()
 
-  if (!endpoint) {
-    const answers = await inquirer.prompt(questionGetEndpoint)
-    endpoint = answers.endpoint;
-    globalConfig.setEndpoint(endpoint);
-  }
-
   if (requiresAuth && cookie === "") {
     throw new Error("Session not found. Please run `appwrite login` to create a session");
   }
@@ -61,12 +29,6 @@ const sdkForProject = async () => {
   let cookie = globalConfig.getCookie()
   let selfSigned = globalConfig.getSelfSigned()
 
-  if (!endpoint) {
-    const answers = await inquirer.prompt(questionGetEndpoint)
-    endpoint = answers.endpoint;
-    globalConfig.setEndpoint(endpoint);
-  }
-
   if (!project) {
     throw new Error("Project is not set. Please run `appwrite init` to initialize the current directory with an Appwrite project.");
   }

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": "6.0.0-rc.1",
+  "version": "6.0.0-rc.2",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {

package/scoop/appwrite.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "6.0.0-rc.1",
+	"version": "6.0.0-rc.2",
 	"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/6.0.0-rc.1/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.2/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/6.0.0-rc.1/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.2/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",