appwrite-cli 12.0.1 → 13.0.0-rc.1

package/lib/type-generation/languages/typescript.ts

@@ -0,0 +1,116 @@
+import fs = require('fs');
+import path = require('path');
+import { AttributeType } from '../attribute';
+import { LanguageMeta, Attribute, Collection } from './language';
+
+export class TypeScript extends LanguageMeta {
+    getType(attribute: Attribute, collections?: Collection[], collectionName?: string): string {
+        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(collectionName!) + 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 = 'Array<number>';
+                break;
+            case AttributeType.LINESTRING:
+                type = 'Array<Array<number>>';
+                break;
+            case AttributeType.POLYGON:
+                type = 'Array<Array<Array<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(): boolean {
+        return true;
+    }
+
+    private _getAppwriteDependency(): string {
+        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 && packageJson.dependencies['node-appwrite'] ? 'node-appwrite' : 'appwrite';
+        }
+
+        if (fs.existsSync(path.resolve(process.cwd(), 'deno.json'))) {
+            return 'https://deno.land/x/appwrite/mod.ts';
+        }
+
+        return 'appwrite';
+    }
+
+    getTemplate(): string {
+        return `import type { Models } from '${this._getAppwriteDependency()}';
+
+// 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') { -%>
+export enum <%- toPascalCase(collection.name) %><%- toPascalCase(attribute.key) %> {
+<% const entries = Object.entries(attribute.elements); -%>
+<% for (let i = 0; i < entries.length; i++) { -%>
+    <%- toUpperSnakeCase(entries[i][1]) %> = "<%- entries[i][1] %>"<% if (i !== entries.length - 1) { %>,<% } %>
+<% } -%>
+}
+
+<% } -%>
+<% } -%>
+<% } -%>
+<% for (const [index, collection] of Object.entries(collections)) { -%>
+export type <%- toPascalCase(collection.name) %> = Models.Row & {
+<% for (const attribute of collection.attributes) { -%>
+<% const propertyName = strict ? toCamelCase(attribute.key) : attribute.key; -%>
+<% const isValidIdentifier = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(propertyName); -%>
+    <% if (isValidIdentifier) { %><%- propertyName %><% } else { %>"<%- propertyName %>"<% } %>: <%- getType(attribute, collections, collection.name) %>;
+<% } -%>
+}<% if (index < collections.length - 1) { %>
+<% } %>
+<% } -%>`;
+    }
+
+    getFileName(_: Collection | undefined): string {
+        return 'appwrite.d.ts';
+    }
+}

package/lib/types.ts

@@ -0,0 +1,150 @@
+export interface CliConfig {
+    verbose: boolean;
+    json: boolean;
+    force: boolean;
+    all: boolean;
+    ids: string[];
+    report: boolean;
+    reportData: Record<string, unknown>;
+}
+
+export interface Headers {
+    [key: string]: string;
+}
+
+export interface RequestParams {
+    [key: string]: unknown;
+}
+
+export interface FileUpload {
+    type: 'file';
+    file: Buffer | ReadableStream;
+    filename: string;
+}
+
+export type ResponseType = 'json' | 'arraybuffer';
+
+export interface ConfigData {
+    [key: string]: unknown;
+}
+
+export interface SessionData {
+    endpoint: string;
+    email?: string;
+    phone?: string;
+    cookie?: string;
+}
+
+export interface GlobalConfigData {
+    sessions: {
+        [key: string]: SessionData;
+    };
+    current: string;
+    cookie?: string;
+}
+
+export interface ProjectConfigData {
+    projectId?: string;
+    projectName?: string;
+    functions?: FunctionConfig[];
+    collections?: CollectionConfig[];
+    databases?: DatabaseConfig[];
+    buckets?: BucketConfig[];
+    teams?: TeamConfig[];
+    topics?: TopicConfig[];
+}
+
+export interface FunctionConfig {
+    $id: string;
+    name: string;
+    runtime: string;
+    path: string;
+    entrypoint: string;
+    execute?: string[];
+    enabled?: boolean;
+    logging?: boolean;
+    events?: string[];
+    schedule?: string;
+    timeout?: number;
+    vars?: Record<string, string>;
+    commands?: string;
+    scopes?: string[];
+    specification?: string;
+}
+
+export interface CollectionConfig {
+    $id: string;
+    $permissions?: string[];
+    databaseId: string;
+    name: string;
+    enabled?: boolean;
+    documentSecurity?: boolean;
+    attributes?: AttributeConfig[];
+    indexes?: IndexConfig[];
+}
+
+export interface AttributeConfig {
+    key: string;
+    type: string;
+    required?: boolean;
+    array?: boolean;
+    size?: number;
+    default?: unknown;
+    min?: number;
+    max?: number;
+    format?: string;
+    elements?: string[];
+    relatedCollection?: string;
+    relationType?: string;
+    twoWay?: boolean;
+    twoWayKey?: string;
+    onDelete?: string;
+    side?: string;
+    encrypt?: boolean;
+}
+
+export interface IndexConfig {
+    key: string;
+    type: string;
+    status?: string;
+    attributes?: string[];
+    orders?: string[];
+}
+
+export interface DatabaseConfig {
+    $id: string;
+    name: string;
+    enabled?: boolean;
+}
+
+export interface BucketConfig {
+    $id: string;
+    $permissions?: string[];
+    name: string;
+    enabled?: boolean;
+    fileSecurity?: boolean;
+    maximumFileSize?: number;
+    allowedFileExtensions?: string[];
+    compression?: string;
+    encryption?: boolean;
+    antivirus?: boolean;
+}
+
+export interface TeamConfig {
+    $id: string;
+    name: string;
+}
+
+export interface TopicConfig {
+    $id: string;
+    name: string;
+    subscribe?: string[];
+}
+
+export interface CommandDescription {
+    [key: string]: string;
+}
+
+export interface ParsedData {
+    [key: string]: unknown;
+}

package/lib/utils.ts

@@ -0,0 +1,322 @@
+import fs = require('fs');
+import path = require('path');
+import net = require('net');
+import childProcess = require('child_process');
+import chalk = require('chalk');
+import { fetch } from 'undici';
+import { localConfig, globalConfig } from './config';
+
+/**
+ * Get the latest version from npm registry
+ */
+export async function getLatestVersion(): Promise<string> {
+    try {
+        const response = await fetch('https://registry.npmjs.org/appwrite-cli/latest');
+        if (!response.ok) {
+            throw new Error(`HTTP ${response.status}`);
+        }
+        const data = await response.json() as { version: string };
+        return data.version;
+    } catch (e) {
+        throw new Error(`Failed to fetch latest version: ${(e as Error).message}`);
+    }
+}
+
+/**
+ * Compare versions using semantic versioning
+ */
+export function compareVersions(current: string, latest: string): number {
+    const currentParts = current.split('.').map(Number);
+    const latestParts = latest.split('.').map(Number);
+
+    for (let i = 0; i < Math.max(currentParts.length, latestParts.length); i++) {
+        const currentPart = currentParts[i] || 0;
+        const latestPart = latestParts[i] || 0;
+
+        if (latestPart > currentPart) return 1; // Latest is newer
+        if (latestPart < currentPart) return -1; // Current is newer
+    }
+
+    return 0; // Same version
+}
+
+export function getAllFiles(folder: string): string[] {
+    const files: string[] = [];
+    for (const pathDir of fs.readdirSync(folder)) {
+        const pathAbsolute = path.join(folder, pathDir);
+        let stats: fs.Stats;
+        try {
+            stats = fs.statSync(pathAbsolute);
+        } catch (error) {
+            continue;
+        }
+        if (stats.isDirectory()) {
+            files.push(...getAllFiles(pathAbsolute));
+        } else {
+            files.push(pathAbsolute);
+        }
+    }
+    return files;
+}
+
+export async function isPortTaken(port: number): Promise<boolean> {
+    const taken = await new Promise<boolean>((res, rej) => {
+        const tester = net
+            .createServer()
+            .once('error', function (err: NodeJS.ErrnoException) {
+                if (err.code != 'EADDRINUSE') return rej(err);
+                res(true);
+            })
+            .once('listening', function () {
+                tester
+                    .once('close', function () {
+                        res(false);
+                    })
+                    .close();
+            })
+            .listen(port);
+    });
+
+    return taken;
+}
+
+export function systemHasCommand(command: string): boolean {
+    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;
+}
+
+export const checkDeployConditions = (localConfig: any): void => {
+    if (Object.keys(localConfig.data).length === 0) {
+        throw new Error(
+            "No appwrite.config.json file found in the current directory. Please run this command again in the folder containing your appwrite.config.json file, or run 'appwrite init project' to link current directory to an Appwrite project."
+        );
+    }
+};
+
+export function showConsoleLink(serviceName: string, action: string, ...ids: string[]): void {
+    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 'organizations':
+            url.pathname += getOrganizationsPath(action, ids);
+            break;
+        case 'users':
+            url.pathname += getUsersPath(action, ids);
+            break;
+        default:
+            return;
+    }
+
+    console.log(`${chalk.green.bold('✓ Success:')} ${chalk.green(url.toString())}`);
+}
+
+function getAccountPath(action: string): string {
+    let path = '/account';
+
+    if (action === 'listsessions') {
+        path += '/sessions';
+    }
+
+    return path;
+}
+
+function getDatabasePath(action: string, ids: string[]): string {
+    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: string, ids: string[]): string {
+    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: string, ids: string[]): string {
+    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: string, ids: string[]): string {
+    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: string, ids: string[]): string {
+    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: string, ids: string[]): string {
+    let path = '/auth/teams';
+
+    if (action !== 'list') {
+        path += `/team-${ids[0]}`;
+    }
+
+    return path;
+}
+
+function getOrganizationsPath(action: string, ids: string[]): string {
+    let path = `/organization-${ids[0]}`;
+
+    if (action === 'list') {
+        path = '/account/organizations';
+    }
+
+    return path;
+}
+
+function getUsersPath(action: string, ids: string[]): string {
+    let path = '/auth';
+
+    if (action !== 'list') {
+        path += `/user-${ids[0]}`;
+    }
+
+    if (action === 'listsessions') {
+        path += 'sessions';
+    }
+
+    return path;
+}
+
+export function isCloud(): boolean {
+    const endpoint = globalConfig.getEndpoint() || 'https://cloud.appwrite.io/v1';
+    const hostname = new URL(endpoint).hostname;
+    return hostname.endsWith('appwrite.io');
+}

package/lib/validations.ts

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

package/package.json

@@ -2,24 +2,27 @@
   "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": "12.0.1",
+  "version": "13.0.0-rc.1",
   "license": "BSD-3-Clause",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
-    "appwrite": "index.js"
+    "appwrite": "dist/index.js"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/appwrite/sdk-for-cli"
   },
   "scripts": {
+    "build": "tsc || true",
+    "prepublishOnly": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "linux-x64": "pkg -t node18-linux-x64 -o build/appwrite-cli-linux-x64 package.json",
-    "linux-arm64": "pkg -t node18-linux-arm64 -o build/appwrite-cli-linux-arm64 package.json",
-    "mac-x64": "pkg -t node18-macos-x64 -o build/appwrite-cli-darwin-x64 package.json",
-    "mac-arm64": "pkg -t node18-macos-arm64 -o build/appwrite-cli-darwin-arm64 package.json",
-    "windows-x64": "pkg -t node18-win-x64 -o build/appwrite-cli-win-x64.exe package.json",
-    "windows-arm64": "pkg -t node18-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
+    "linux-x64": "npm run build && pkg -t node18-linux-x64 -o build/appwrite-cli-linux-x64 package.json",
+    "linux-arm64": "npm run build && pkg -t node18-linux-arm64 -o build/appwrite-cli-linux-arm64 package.json",
+    "mac-x64": "npm run build && pkg -t node18-macos-x64 -o build/appwrite-cli-darwin-x64 package.json",
+    "mac-arm64": "npm run build && pkg -t node18-macos-arm64 -o build/appwrite-cli-darwin-arm64 package.json",
+    "windows-x64": "npm run build && pkg -t node18-win-x64 -o build/appwrite-cli-win-x64.exe package.json",
+    "windows-arm64": "npm run build && pkg -t node18-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
   },
   "dependencies": {
     "undici": "^5.28.2",
@@ -39,12 +42,18 @@
     "dotenv": "^16.4.5"
   },
   "devDependencies": {
-    "@yao-pkg/pkg": "^6.9.0"
+    "@yao-pkg/pkg": "^6.9.0",
+    "@types/node": "^18.19.0",
+    "@types/inquirer": "^8.2.10",
+    "@types/cli-progress": "^3.11.5",
+    "@types/tar": "^6.1.11",
+    "@types/json-bigint": "^1.0.4",
+    "typescript": "^5.3.3"
   },
   "pkg": {
     "scripts": [
-      "index.js",
-      "lib/**/*.js"
+      "dist/index.js",
+      "dist/lib/**/*.js"
     ]
   }
 }

package/scoop/appwrite.config.json

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