appwrite-cli 12.0.1 → 13.0.0-rc.1

package/lib/commands/organizations.js

@@ -1,48 +0,0 @@
-const { sdkForProject } = require('../sdks')
-const { parse } = require('../parser')
-const { showConsoleLink } = require('../utils.js');
-
-/**
- * @typedef {Object} OrganizationsListRequestParams
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {OrganizationsListRequestParams} params
- */
-const organizationsList = async ({queries, search, parseOutput = true, sdk = undefined, console}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/organizations';
-    let payload = {};
-    if (typeof queries !== 'undefined') {
-        payload['queries'] = queries;
-    }
-    if (typeof search !== 'undefined') {
-        payload['search'] = search;
-    }
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        if(console) {
-            showConsoleLink('organizations', 'list');
-         } else {
-            parse(response)
-        }
-    }
-
-    return response;
-
-}
-
-module.exports = {
-    organizationsList
-}

package/lib/emulation/utils.js

@@ -1,186 +0,0 @@
-const EventEmitter = require('node:events');
-const { projectsCreateJWT } = require('../commands/projects');
-const { localConfig } = require("../config");
-const { usersGet, usersCreateJWT } = require("../commands/users");
-const { log } = require("../parser");
-
-const openRuntimesVersion = 'v4';
-
-const runtimeNames = {
-    'node': 'Node.js',
-    'php': 'PHP',
-    'ruby': 'Ruby',
-    'python': 'Python',
-    'python-ml': 'Python (ML)',
-    'deno': 'Deno',
-    'dart': 'Dart',
-    'dotnet': '.NET',
-    'java': 'Java',
-    'swift': 'Swift',
-    'kotlin': 'Kotlin',
-    'bun': 'Bun',
-    'go': 'Go',
-};
-
-const systemTools = {
-    'node': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "package.json", "package-lock.json" ]
-    },
-    'php': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "composer.json", "composer.lock" ]
-    },
-    'ruby': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "Gemfile", "Gemfile.lock" ]
-    },
-    'python': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "requirements.txt", "requirements.lock" ]
-    },
-    'python-ml': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "requirements.txt", "requirements.lock" ]
-    },
-    'deno': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'dart': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'dotnet': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'java': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'swift': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'kotlin': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-    'bun': {
-        isCompiled: false,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ "package.json", "package-lock.json", "bun.lockb" ]
-    },
-    'go': {
-        isCompiled: true,
-        startCommand: "sh helpers/server.sh",
-        dependencyFiles: [ ]
-    },
-};
-
-const JwtManager = {
-    userJwt: null,
-    functionJwt: null,
-
-    timerWarn: null,
-    timerError: null,
-
-    async setup(userId = null, projectScopes = []) {
-        if(this.timerWarn) {
-            clearTimeout(this.timerWarn);
-        }
-
-        if(this.timerError) {
-            clearTimeout(this.timerError);
-        }
-
-        this.timerWarn = setTimeout(() => {
-            log("Warning: Authorized JWT will expire in 5 minutes. Please stop and re-run the command to refresh tokens for 1 hour.");
-        }, 1000 * 60 * 55); // 55 mins
-
-        this.timerError = setTimeout(() => {
-            log("Warning: Authorized JWT just expired. Please stop and re-run the command to obtain new tokens with 1 hour validity.");
-            log("Some Appwrite API communication is not authorized now.")
-        }, 1000 * 60 * 60); // 60 mins
-
-        if(userId) {
-            await usersGet({
-                userId,
-                parseOutput: false
-            });
-            const userResponse = await usersCreateJWT({
-                userId,
-                duration: 60*60,
-                parseOutput: false
-            });
-            this.userJwt = userResponse.jwt;
-        }
-
-        const functionResponse = await projectsCreateJWT({
-            projectId: localConfig.getProject().projectId,
-            scopes: projectScopes,
-            duration: 60*60,
-            parseOutput: false
-        });
-        this.functionJwt = functionResponse.jwt;
-    }
-};
-
-const Queue = {
-    files: [],
-    locked: false,
-    events: new EventEmitter(),
-    debounce: null,
-    push(file) {
-        if(!this.files.includes(file)) {
-            this.files.push(file);
-        }
-
-        if(!this.locked) {
-            this._trigger();
-        }
-    },
-    lock() {
-        this.files = [];
-        this.locked = true;
-    },
-    isEmpty() {
-        return this.files.length === 0
-    },
-    unlock() {
-        this.locked = false;
-        if(this.files.length > 0) {
-            this._trigger();
-        }
-    },
-    _trigger() {
-        if(this.debounce) {
-            return;
-        }
-
-        this.debounce = setTimeout(() => {
-            this.events.emit('reload', { files: this.files });
-            this.debounce = null;
-        }, 300);
-    }
-};
-
-module.exports = {
-    openRuntimesVersion,
-    runtimeNames,
-    systemTools,
-    JwtManager,
-    Queue
-}

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/type-generation/attribute.js

@@ -1,19 +0,0 @@
-const AttributeType = {
-    STRING: "string",
-    INTEGER: "integer",
-    FLOAT: "double",
-    BOOLEAN: "boolean",
-    DATETIME: "datetime",
-    EMAIL: "email",
-    IP: "ip",
-    URL: "url",
-    ENUM: "enum",
-    RELATIONSHIP: "relationship",
-    POINT: "point",
-    LINESTRING: "linestring",
-    POLYGON: "polygon",
-};
-
- module.exports = {
-    AttributeType,
- };

package/lib/type-generation/languages/javascript.js

@@ -1,111 +0,0 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const fs = require("fs");
-const path = require("path");
-
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
-
-class JavaScript extends LanguageMeta {
-  getType(attribute, collections) {
-    let type = ""
-    switch (attribute.type) {
-      case AttributeType.STRING:
-      case AttributeType.EMAIL:
-      case AttributeType.DATETIME:
-      case AttributeType.IP:
-      case AttributeType.URL:
-        type = "string";
-        if (attribute.format === AttributeType.ENUM) {
-          type = LanguageMeta.toPascalCase(attribute.key);
-        }
-        break;
-      case AttributeType.INTEGER:
-        type = "number";
-        break;
-      case AttributeType.FLOAT:
-        type = "number";
-        break;
-      case AttributeType.BOOLEAN:
-        type = "boolean";
-        break;
-      case AttributeType.RELATIONSHIP:
-        const relatedCollection = collections.find(c => c.$id === attribute.relatedCollection);
-        if (!relatedCollection) {
-          throw new Error(`Related collection with ID '${attribute.relatedCollection}' not found.`);
-        }
-        type = LanguageMeta.toPascalCase(relatedCollection.name);
-        if ((attribute.relationType === 'oneToMany' && attribute.side === 'parent') || (attribute.relationType === 'manyToOne' && attribute.side === 'child') || attribute.relationType === 'manyToMany') {
-          type = `${type}[]`;
-        }
-        break;
-      case AttributeType.POINT:
-        type = "number[]";
-        break;
-      case AttributeType.LINESTRING:
-        type = "number[][]";
-        break;
-      case AttributeType.POLYGON:
-        type = "number[][][]";
-        break;
-      default:
-        throw new Error(`Unknown attribute type: ${attribute.type}`);
-    }
-    if (attribute.array) {
-      type += "[]";
-    }
-    if (!attribute.required && attribute.default === null) {
-      type += " | null";
-    }
-    return type;
-  }
-
-  isSingleFile() {
-    return true;
-  }
-
-  _getAppwriteDependency() {
-    if (fs.existsSync(path.resolve(process.cwd(), 'package.json'))) {
-      const packageJsonRaw = fs.readFileSync(path.resolve(process.cwd(), 'package.json'));
-      const packageJson = JSON.parse(packageJsonRaw.toString('utf-8'));
-      return packageJson.dependencies['node-appwrite'] ? 'node-appwrite' : 'appwrite';
-    }
-
-    return "appwrite";
-  }
-
-  getTemplate() {
-    return `/**
- * @typedef {import('${this._getAppwriteDependency()}').Models.Row} Row
- */
-
-// This file is auto-generated by the Appwrite CLI. 
-// You can regenerate it by running \`appwrite ${process.argv.slice(2).join(' ')}\`.
-
-<% for (const collection of collections) { -%>
-<% for (const attribute of collection.attributes) { -%>
-<% if (attribute.format === 'enum') { -%>
-/**
- * @typedef {"<%- attribute.elements.join('"|"') %>"} <%- toPascalCase(attribute.key) %>
- */
-
-<% } -%>
-<% } -%>
-<% } -%>
-<% for (const [index, collection] of Object.entries(collections)) { %>/**
- * @typedef {Row & {
-<% for (const attribute of collection.attributes) { -%>
- *   <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- getType(attribute, collections) %>;
-<% } -%>
- * }} <%- toPascalCase(collection.name) %>
- */
-<% if (index < collections.length - 1) { %>
-<% } -%>
-<% } %>`;
-  }
-
-  getFileName(_) {
-    return "appwrite-types.js";
-  }
-}
-
-module.exports = { JavaScript };