chirag-appwrite-cli 0.1.0

package/index.js

@@ -0,0 +1,109 @@
+#! /usr/bin/env node
+
+/** Required to set max width of the help commands */
+const oldWidth = process.stdout.columns
+process.stdout.columns = 100
+/** ---------------------------------------------- */
+
+const program = require("commander");
+const chalk = require("chalk");
+const { version } = require("./package.json");
+const { commandDescriptions, cliConfig } = require("./lib/parser");
+const { client } = require("./lib/commands/generic");
+const inquirer = require("inquirer");
+const { login, logout, whoami, migrate, register } = require("./lib/commands/generic");
+const { init } = require("./lib/commands/init");
+const { types } = require("./lib/commands/types");
+const { pull } = require("./lib/commands/pull");
+const { run } = require("./lib/commands/run");
+const { push, deploy } = require("./lib/commands/push");
+const { account } = require("./lib/commands/account");
+const { avatars } = require("./lib/commands/avatars");
+const { console } = require("./lib/commands/console");
+const { databases } = require("./lib/commands/databases");
+const { functions } = require("./lib/commands/functions");
+const { graphql } = require("./lib/commands/graphql");
+const { health } = require("./lib/commands/health");
+const { locale } = require("./lib/commands/locale");
+const { messaging } = require("./lib/commands/messaging");
+const { migrations } = require("./lib/commands/migrations");
+const { project } = require("./lib/commands/project");
+const { projects } = require("./lib/commands/projects");
+const { proxy } = require("./lib/commands/proxy");
+const { sites } = require("./lib/commands/sites");
+const { storage } = require("./lib/commands/storage");
+const { teams } = require("./lib/commands/teams");
+const { tokens } = require("./lib/commands/tokens");
+const { users } = require("./lib/commands/users");
+const { vcs } = require("./lib/commands/vcs");
+
+inquirer.registerPrompt('search-list', require('inquirer-search-list'));
+
+program
+  .description(commandDescriptions['main'])
+  .configureHelp({
+    helpWidth: process.stdout.columns || 80,
+    sortSubcommands: true,
+  })
+  .helpOption('-h, --help', "Display help for command")
+  .version(version, "-v, --version", "Output the version number")
+  .option("-V, --verbose", "Show complete error log")
+  .option("-j, --json", "Output in JSON format")
+  .hook('preAction', migrate)
+  .option("-f,--force", "Flag to confirm all warnings")
+  .option("-a,--all", "Flag to push all resources")
+  .option("--id [id...]", "Flag to pass a list of ids for a given action")
+  .option("--report", "Enable reporting in case of CLI errors")
+  .on("option:json", () => {
+    cliConfig.json = true;
+  })
+  .on("option:verbose", () => {
+    cliConfig.verbose = true;
+  })
+  .on("option:report", function() {
+    cliConfig.report = true;
+    cliConfig.reportData = { data: this };
+  })
+  .on("option:force", () => {
+    cliConfig.force = true;
+  })
+  .on("option:all", () => {
+    cliConfig.all = true;
+  })
+  .on("option:id", function() {
+    cliConfig.ids = this.opts().id;
+  })
+  .showSuggestionAfterError()
+  .addCommand(whoami)
+  .addCommand(register)
+  .addCommand(login)
+  .addCommand(init)
+  .addCommand(pull)
+  .addCommand(push)
+  .addCommand(types)
+  .addCommand(deploy)
+  .addCommand(run)
+  .addCommand(logout)
+  .addCommand(account)
+  .addCommand(avatars)
+  .addCommand(console)
+  .addCommand(databases)
+  .addCommand(functions)
+  .addCommand(graphql)
+  .addCommand(health)
+  .addCommand(locale)
+  .addCommand(messaging)
+  .addCommand(migrations)
+  .addCommand(project)
+  .addCommand(projects)
+  .addCommand(proxy)
+  .addCommand(sites)
+  .addCommand(storage)
+  .addCommand(teams)
+  .addCommand(tokens)
+  .addCommand(users)
+  .addCommand(vcs)
+  .addCommand(client)
+  .parse(process.argv);
+
+process.stdout.columns = oldWidth;

package/install.ps1

@@ -0,0 +1,98 @@
+## <script src="/dist/scripts/cli-bash.js"></script>
+## <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/themes/prism-okaidia.min.css" rel="stylesheet" />
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-core.min.js" data-manual></script>
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-powershell.min.js"></script>
+## <style>body {color: #272822; background-color: #272822; font-size: 0.8em;} </style>
+# Love open-source, dev-tooling and passionate about code as much as we do?
+# ---
+# We're always looking for awesome hackers like you to join our 100% remote team!
+# Check and see if you find any relevant position @ https://appwrite.io/company/careers 👩‍💻 😎
+# (and let us know you found this message...)
+
+# This script contains hidden JS code to allow better readability and syntax highlighting
+# You can use "View source" of this page to see the full script.
+
+# REPO
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.16.0/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.16.0/appwrite-cli-win-arm64.exe"
+
+$APPWRITE_BINARY_NAME = "appwrite.exe"
+
+# Appwrite download directory
+$APPWRITE_DOWNLOAD_DIR = Join-Path -Path $env:TEMP -ChildPath $APPWRITE_BINARY_NAME
+
+# Appwrite CLI location
+$APPWRITE_INSTALL_DIR = Join-Path -Path $env:LOCALAPPDATA -ChildPath "Appwrite"
+$APPWRITE_INSTALL_PATH = Join-Path -Path "$APPWRITE_INSTALL_DIR" -ChildPath "$APPWRITE_BINARY_NAME"
+
+$USER_PATH_ENV_VAR = [Environment]::GetEnvironmentVariable("PATH", "User")
+
+function Greeting {
+    Write-Host @"
+
+     _                            _ _           ___   __   _____ 
+    /_\  _ __  _ ____      ___ __(_) |_ ___    / __\ / /   \_   \
+   //_\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \  / /   / /     / /\/
+  /  _  \ |_) | |_) \ V  V /| |  | | ||  __/ / /___/ /___/\/ /_  
+  \_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___| \____/\____/\____/  
+        |_|   |_|                                                
+
+"@ -ForegroundColor red
+    Write-Host "Welcome to the Appwrite CLI install shield."  
+}
+
+
+function CheckSystemInfo {
+    Write-Host "[1/4] Getting System Info ..."
+    if ((Get-ExecutionPolicy) -gt 'RemoteSigned' -or (Get-ExecutionPolicy) -eq 'ByPass') {
+        Write-Host "PowerShell requires an execution policy of 'RemoteSigned'."
+        Write-Host "To make this change please run:"
+        Write-Host "'Set-ExecutionPolicy RemoteSigned -scope CurrentUser'"
+        break
+    }
+}
+
+function DownloadBinary {
+    Write-Host "[2/4] Downloading Appwrite CLI binary ..."
+    Write-Host "🚦 Fetching latest version ... " -ForegroundColor green
+
+    if((Get-CimInstance Win32_operatingsystem).OSArchitecture -like '*ARM*') {
+      Invoke-WebRequest -Uri $GITHUB_arm64_URL -OutFile $APPWRITE_DOWNLOAD_DIR
+    } else {
+      Invoke-WebRequest -Uri $GITHUB_x64_URL -OutFile $APPWRITE_DOWNLOAD_DIR
+    }
+
+    New-Item -ItemType Directory -Path $APPWRITE_INSTALL_DIR
+    Move-Item $APPWRITE_DOWNLOAD_DIR $APPWRITE_INSTALL_PATH
+}
+
+
+function Install {
+    Write-Host "[3/4] Starting installation ..."
+
+    if ($USER_PATH_ENV_VAR -like '*Appwrite*') {
+        Write-Host "Skipping to add Appwrite to User Path."
+    } else {
+        [System.Environment]::SetEnvironmentVariable("PATH", $USER_PATH_ENV_VAR + ";$APPWRITE_INSTALL_DIR", "User")
+        $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") 
+    }
+}
+
+function CleanUp {
+    Write-Host "Cleaning up mess ..."
+}
+
+function InstallCompleted {
+    Write-Host "[4/4] Finishing Installation ... "
+    cleanup
+    Write-Host "To get started with Appwrite CLI, please visit https://appwrite.io/docs/command-line"
+    Write-Host "As first step, you can login to your Appwrite account using 'appwrite login'"
+}
+
+
+Greeting
+CheckSystemInfo
+DownloadBinary
+Install
+CleanUp
+InstallCompleted

package/install.sh

@@ -0,0 +1,157 @@
+#!/bin/bash
+
+## <script src="/dist/scripts/cli-bash.js"></script>
+## <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/themes/prism-okaidia.min.css" rel="stylesheet" />
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-core.min.js" data-manual></script>
+## <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-bash.min.js"></script>
+## <style>body {color: #272822; background-color: #272822; font-size: 0.8em;} </style>
+# Love open-source, dev-tooling and passionate about code as much as we do?
+# ---
+# We're always looking for awesome hackers like you to join our 100% remote team!
+# Check and see if you find any relevant position @ https://appwrite.io/company/careers 👩‍💻 😎
+# (and let us know you found this message...)
+
+# This script contains hidden JS code to allow better readability and syntax highlighting
+# You can use "View source" of this page to see the full script.
+
+# Appwrite CLI location
+APPWRITE_INSTALL_DIR="/usr/local/bin"
+
+# Appwrite CLI Executable name 
+APPWRITE_EXECUTABLE_NAME=appwrite
+
+# Appwrite executable file path 
+APPWRITE_EXECUTABLE_FILEPATH="$APPWRITE_INSTALL_DIR/$APPWRITE_EXECUTABLE_NAME"
+
+# Appwrite CLI temp name 
+APPWRITE_TEMP_NAME=temp-$(date +%s)
+
+# Appwrite CLI image name
+GITHUB_REPOSITORY_NAME=appwrite/sdk-for-cli
+
+# sudo is required to copy executable to APPWRITE_INSTALL_DIR for linux
+USE_SUDO="false"
+OS=""
+ARCH=""
+
+# Add some color to life
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m' # No Color
+
+
+greeting() {
+    echo -e "${RED}"
+    cat << "EOF"
+
+     _                            _ _           ___   __   _____ 
+    /_\  _ __  _ ____      ___ __(_) |_ ___    / __\ / /   \_   \
+   //_\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \  / /   / /     / /\/
+  /  _  \ |_) | |_) \ V  V /| |  | | ||  __/ / /___/ /___/\/ /_  
+  \_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___| \____/\____/\____/  
+        |_|   |_|                                                
+EOF
+    echo -e "${NC}\n"
+    echo "🔥 Welcome to the Appwrite CLI install shield 🛡"
+}
+
+getSystemInfo() {
+    echo "[1/4] Getting System Info ..."
+    
+    ARCH=$(uname -m)
+    case $ARCH in
+        i386|i686) ARCH="x64" ;;
+        x86_64) ARCH="x64";;
+        armv6*) ARCH="arm64" ;;
+        armv7*) ARCH="arm64" ;;
+        aarch64*) ARCH="arm64" ;;
+    esac
+
+    OS=$(echo `uname`|tr '[:upper:]' '[:lower:]')
+
+    # Need root access if its a linux system
+    if [ "$OS" == "linux" ] && [ "$APPWRITE_INSTALL_DIR" == "/usr/local/bin" ]; then
+        USE_SUDO="true"
+    fi
+    
+    # Need root access if its Apple Silicon
+    if [ "$OS" == "darwin" ] && [[ "$(uname -a)" = *ARM64* ]]; then
+        USE_SUDO="true"
+    fi
+
+    printf "${GREEN}\nOS : $OS \nARCH : $ARCH \nREQUIRES ROOT : $USE_SUDO\n\n${NC}"
+}
+
+runAsRoot() {
+    local CMD="$*"
+    if [ $EUID -ne 0 -a $USE_SUDO = "true" ]; then
+        CMD="sudo $CMD"
+    fi
+    $CMD
+}
+
+printSuccess() {
+    printf "${GREEN}✅ Done ... ${NC}\n\n"
+}
+
+downloadBinary() {
+    echo "[2/4] Downloading executable for $OS ($ARCH) ..."
+
+    GITHUB_LATEST_VERSION="0.16.0"
+    GITHUB_FILE="appwrite-cli-${OS}-${ARCH}"
+    GITHUB_URL="https://github.com/$GITHUB_REPOSITORY_NAME/releases/download/$GITHUB_LATEST_VERSION/$GITHUB_FILE"
+
+    printf "${GREEN}🚦 Downloading Appwrite CLI $GITHUB_LATEST_VERSION ... ${NC}\n"
+    res=$(curl -s $GITHUB_URL)
+    if [[ "$res" == *"Not Found"* ]]; then
+        printf "${RED}❌ Couldn't find executable for $OS ($ARCH). Please contact the Appwrite team ${NC} \n"
+        exit 1
+    fi
+    curl -L -o $APPWRITE_TEMP_NAME $GITHUB_URL
+    printSuccess
+}
+
+install() {
+    echo "[3/4] Installing ..."
+
+    printf "${GREEN}🚧 Setting Permissions ${NC}\n"
+    chmod +x $APPWRITE_TEMP_NAME
+    if [ $? -ne 0 ]; then
+        printf "${RED}❌ Failed to set permissions ... ${NC}\n"
+        exit 1
+    fi
+    printSuccess
+
+    printf "${GREEN}📝 Copying temporary file to $APPWRITE_EXECUTABLE_FILEPATH ... ${NC}\n"
+    runAsRoot cp $APPWRITE_TEMP_NAME $APPWRITE_EXECUTABLE_FILEPATH
+    if [ $? -ne 0 ]; then
+        printf "${RED}❌ Failed to copy temporary file to $APPWRITE_EXECUTABLE_FILEPATH ... ${NC}\n"
+        exit 1
+    fi
+    printSuccess
+}
+
+cleanup() {
+    printf "${GREEN}🧹 Cleaning up mess ... ${NC}\n"
+    rm $APPWRITE_TEMP_NAME 
+    if [ $? -ne 0 ]; then
+        printf "${RED}❌ Failed to remove temporary file ... ${NC}\n"
+        exit 1
+    fi
+    printSuccess
+
+}
+
+installCompleted() {
+    echo "[4/4] Wrapping up installation ... "
+    cleanup
+    echo "🚀 To get started with Appwrite CLI, please visit https://appwrite.io/docs/command-line"
+    echo "As first step, you can login to your Appwrite account using 'appwrite login'"
+}
+
+# Installation Starts here 
+greeting
+getSystemInfo
+downloadBinary
+install
+installCompleted

package/lib/client.js

@@ -0,0 +1,259 @@
+const os = require('os');
+const https = require("https");
+const { fetch, FormData, Agent } = require("undici");
+const JSONbig = require("json-bigint")({ storeAsString: false });
+const AppwriteException = require("./exception.js");
+const { globalConfig } = require("./config.js");
+const chalk = require("chalk");
+
+class Client {
+  CHUNK_SIZE = 5*1024*1024; // 5MB
+
+  constructor() {
+    this.endpoint = 'https://cloud.appwrite.io/v1';
+    this.headers = {
+      'content-type': '',
+      'x-sdk-name': 'NAME',
+      'x-sdk-platform': '',
+      'x-sdk-language': 'cli',
+      'x-sdk-version': '0.16.0',
+      'user-agent' : `AppwriteCLI/0.16.0 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'X-Appwrite-Response-Format' : '1.7.0',
+    };
+  }
+
+  /**
+   * Set Cookie
+   *
+   * Your cookie
+   *
+   * @param {string} cookie
+   *
+   * @return self
+   */
+  setCookie(cookie) {
+    this.addHeader("cookie", cookie);
+
+    return this;
+  }
+
+    /**
+     * Set Project
+     *
+     * Your project ID
+     *
+     * @param {string} project
+     *
+     * @return self
+     */
+    setProject(project) {
+        this.addHeader('X-Appwrite-Project', project);
+
+        return this;
+    }
+
+    /**
+     * Set Key
+     *
+     * Your secret API key
+     *
+     * @param {string} key
+     *
+     * @return self
+     */
+    setKey(key) {
+        this.addHeader('X-Appwrite-Key', key);
+
+        return this;
+    }
+
+    /**
+     * Set JWT
+     *
+     * Your secret JSON Web Token
+     *
+     * @param {string} jwt
+     *
+     * @return self
+     */
+    setJWT(jwt) {
+        this.addHeader('X-Appwrite-JWT', jwt);
+
+        return this;
+    }
+
+    /**
+     * Set Locale
+     *
+     * @param {string} locale
+     *
+     * @return self
+     */
+    setLocale(locale) {
+        this.addHeader('X-Appwrite-Locale', locale);
+
+        return this;
+    }
+
+    /**
+     * Set Mode
+     *
+     * @param {string} mode
+     *
+     * @return self
+     */
+    setMode(mode) {
+        this.addHeader('X-Appwrite-Mode', mode);
+
+        return this;
+    }
+
+  /**
+   * Set self signed.
+   *
+   * @param {bool} status
+   *
+   * @return this
+   */
+  setSelfSigned(status) {
+    this.selfSigned = status;
+
+    return this;
+  }
+
+  /**
+   * Set endpoint.
+   *
+   * @param {string} endpoint
+   *
+   * @return this
+   */
+  setEndpoint(endpoint) {
+    if (!endpoint.startsWith('http://') && !endpoint.startsWith('https://')) {
+      throw new AppwriteException('Invalid endpoint URL: ' + endpoint);
+    }
+
+    this.endpoint = endpoint;
+    return this;
+  }
+
+  /**
+   * @param {string} key
+   * @param {string} value
+   */
+  addHeader(key, value) {
+    this.headers[key.toLowerCase()] = value;
+
+    return this;
+  }
+
+  async call(method, path = "", headers = {}, params = {}, responseType = "json") {
+    headers = {...this.headers, ...headers};
+    const url = new URL(this.endpoint + path);
+
+    let body = undefined;
+
+    if (method.toUpperCase() === "GET") {
+      url.search = new URLSearchParams(Client.flatten(params)).toString();
+    } else if (headers["content-type"]?.toLowerCase().startsWith("multipart/form-data")) {
+      delete headers["content-type"];
+      const formData = new FormData();
+
+      const flatParams = Client.flatten(params);
+
+      for (const [key, value] of Object.entries(flatParams)) {
+          if (value && value.type && value.type === "file") {
+              formData.append(key, value.file, value.filename);
+          } else {
+              formData.append(key, value);
+          }
+      }
+
+      body = formData;
+    } else {
+      body = JSONbig.stringify(params);
+    }
+
+    let response = undefined;
+    try {
+      response = await fetch(url.toString(), {
+        method: method.toUpperCase(),
+        headers,
+        body,
+        dispatcher: new Agent({
+            connect: {
+                rejectUnauthorized: !this.selfSigned,
+            },
+        }),
+      });
+
+      const warnings = response.headers.get('x-appwrite-warning');
+      if (warnings) {
+          warnings.split(';').forEach((warning) => console.warn(warning));
+      }
+    } catch (error) {
+      throw new AppwriteException(error.message);
+    }
+
+    if (response.status >= 400) {
+      const text = await response.text();
+      let json = undefined;
+      try {
+        json = JSON.parse(text);
+      } catch (error) {
+        throw new AppwriteException(text, response.status, "", text);
+      }
+
+      if (path !== '/account' && json.code === 401 && json.type === 'user_more_factors_required') {
+        console.log(`${chalk.cyan.bold("ℹ Info")} ${chalk.cyan("Unusable account found, removing...")}`);
+
+        const current = globalConfig.getCurrentSession();
+        globalConfig.setCurrentSession('');
+        globalConfig.removeSession(current);
+      }
+      throw new AppwriteException(json.message, json.code, json.type, text);
+    }
+
+    if (responseType === "arraybuffer") {
+      const data = await response.arrayBuffer();
+      return data;
+    }
+
+    let cookies = response.headers.getSetCookie();
+    if (cookies && cookies.length > 0) {
+      for (const cookie of cookies) {
+        if (cookie.startsWith('a_session_console=')) {
+          globalConfig.setCookie(cookie);
+        }
+      }
+    }
+
+    const text = await response.text();
+    let json = undefined;
+    try {
+      json = JSONbig.parse(text);
+    } catch (error) {
+      return text;
+    }
+    return json;
+  }
+
+  static flatten(data, prefix = '') {
+    let output = {};
+
+    for (const key in data) {
+      let value = data[key];
+      let finalKey = prefix ? prefix + '[' + key +']' : key;
+
+      if (Array.isArray(value)) {
+        output = Object.assign(output, Client.flatten(value, finalKey)); // @todo: handle name collision here if needed
+      } else {
+        output[finalKey] = value;
+      }
+    }
+
+    return output;
+  }
+}
+
+module.exports = Client;