appwrite-cli 13.0.0-rc.1 → 13.0.0-rc.3

package/lib/sdks.ts

@@ -1,55 +1,88 @@
-import Client = require('./client');
-import { globalConfig, localConfig } from './config';
-
-export const sdkForConsole = async (requiresAuth: boolean = true): Promise<Client> => {
-    const client = new Client();
-    const endpoint = globalConfig.getEndpoint();
-    const cookie = globalConfig.getCookie();
-    const 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;
+import { globalConfig, localConfig } from "./config.js";
+import { Client } from "@appwrite.io/console";
+import os from "os";
+import {
+  DEFAULT_ENDPOINT,
+  EXECUTABLE_NAME,
+  SDK_TITLE,
+  SDK_VERSION,
+} from "./constants.js";
+
+export const sdkForConsole = async (
+  requiresAuth: boolean = true,
+): Promise<Client> => {
+  const client = new Client();
+  const endpoint = globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
+  const cookie = globalConfig.getCookie();
+  const selfSigned = globalConfig.getSelfSigned();
+
+  if (requiresAuth && cookie === "") {
+    throw new Error(
+      `Session not found. Please run \`${EXECUTABLE_NAME} login\` to create a session`,
+    );
+  }
+
+  client.headers = {
+    "x-sdk-name": "Command Line",
+    "x-sdk-platform": "console",
+    "x-sdk-language": "cli",
+    "x-sdk-version": SDK_VERSION,
+    "user-agent": `AppwriteCLI/${SDK_VERSION} (${os.type()} ${os.version()}; ${os.arch()})`,
+  };
+
+  client
+    .setEndpoint(endpoint)
+    .setProject("console")
+    .setCookie(cookie)
+    .setSelfSigned(selfSigned)
+    .setLocale("en-US");
+
+  return client;
 };
 
 export const sdkForProject = async (): Promise<Client> => {
-    const client = new Client();
-    const endpoint = localConfig.getEndpoint() || globalConfig.getEndpoint();
-    const project = localConfig.getProject().projectId ? localConfig.getProject().projectId : globalConfig.getProject();
-    const key = globalConfig.getKey();
-    const cookie = globalConfig.getCookie();
-    const 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.');
+  const client = new Client();
+
+  const endpoint =
+    localConfig.getEndpoint() || globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
+
+  const project = localConfig.getProject().projectId
+    ? localConfig.getProject().projectId
+    : globalConfig.getProject();
+
+  const key = globalConfig.getKey();
+  const cookie = globalConfig.getCookie();
+  const selfSigned = globalConfig.getSelfSigned();
+
+  if (!project) {
+    throw new Error(
+      `Project is not set. Please run \`${EXECUTABLE_NAME} init project\` to initialize the current directory with an ${SDK_TITLE} project.`,
+    );
+  }
+
+  client.headers = {
+    "x-sdk-name": "Command Line",
+    "x-sdk-platform": "console",
+    "x-sdk-language": "cli",
+    "x-sdk-version": SDK_VERSION,
+    "user-agent": `AppwriteCLI/${SDK_VERSION} (${os.type()} ${os.version()}; ${os.arch()})`,
+  };
+
+  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 \`${EXECUTABLE_NAME} login\` to create a session.`,
+  );
 };

package/lib/services.ts

@@ -0,0 +1,72 @@
+import { sdkForConsole, sdkForProject } from "./sdks.js";
+import {
+  Client,
+  Console,
+  Databases,
+  Functions,
+  Messaging,
+  Organizations,
+  Projects,
+  Proxy,
+  Sites,
+  Storage,
+  TablesDB,
+  Teams,
+} from "@appwrite.io/console";
+
+export const getConsoleService = async (sdk?: Client): Promise<Console> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Console(client);
+};
+
+export const getDatabasesService = async (sdk?: Client): Promise<Databases> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Databases(client);
+};
+
+export const getFunctionsService = async (sdk?: Client): Promise<Functions> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Functions(client);
+};
+
+export const getMessagingService = async (sdk?: Client): Promise<Messaging> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Messaging(client);
+};
+
+export const getOrganizationsService = async (
+  sdk?: Client,
+): Promise<Organizations> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Organizations(client);
+};
+
+export const getProjectsService = async (sdk?: Client): Promise<Projects> => {
+  const client = !sdk ? await sdkForConsole() : sdk;
+  return new Projects(client);
+};
+
+export const getProxyService = async (sdk?: Client): Promise<Proxy> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Proxy(client);
+};
+
+export const getSitesService = async (sdk?: Client): Promise<Sites> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Sites(client);
+};
+
+export const getStorageService = async (sdk?: Client): Promise<Storage> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Storage(client);
+};
+
+export const getTablesDBService = async (sdk?: Client): Promise<TablesDB> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new TablesDB(client);
+};
+
+export const getTeamsService = async (sdk?: Client): Promise<Teams> => {
+  const client = !sdk ? await sdkForProject() : sdk;
+  return new Teams(client);
+};

package/lib/spinner.ts

@@ -1,118 +1,131 @@
-import progress = require('cli-progress');
-import chalk = require('chalk');
+import progress from "cli-progress";
+import chalk from "chalk";
 
-const SPINNER_ARC = 'arc';
-const SPINNER_DOTS = 'dots';
+const SPINNER_ARC = "arc";
+const SPINNER_DOTS = "dots";
 
 interface SpinnerConfig {
-    interval: number;
-    frames: string[];
+  interval: number;
+  frames: string[];
 }
 
 interface SpinnerPayload {
-    status: string;
-    resource: string;
-    id: string;
-    prefix?: string;
-    end?: string;
-    errorMessage?: string;
+  status: string;
+  resource: string;
+  id: string;
+  prefix?: string;
+  end?: string;
+  errorMessage?: string;
 }
 
 const spinners: Record<string, SpinnerConfig> = {
-    [SPINNER_ARC]: {
-        interval: 100,
-        frames: ['◜', '◠', '◝', '◞', '◡', '◟'],
-    },
-    [SPINNER_DOTS]: {
-        interval: 80,
-        frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
-    },
+  [SPINNER_ARC]: {
+    interval: 100,
+    frames: ["◜", "◠", "◝", "◞", "◡", "◟"],
+  },
+  [SPINNER_DOTS]: {
+    interval: 80,
+    frames: ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
+  },
 };
 
 class Spinner {
-    static updatesBar: progress.MultiBar;
-    private bar: progress.SingleBar;
-    private spinnerInterval?: NodeJS.Timeout;
-
-    static start(clearOnComplete: boolean = true, hideCursor: boolean = true): void {
-        Spinner.updatesBar = new progress.MultiBar({
-            format: this.formatter,
-            hideCursor,
-            clearOnComplete,
-            stopOnComplete: true,
-            linewrap: true,
-            noTTYOutput: true,
-        });
+  static updatesBar: progress.MultiBar;
+  private bar: progress.SingleBar;
+  private spinnerInterval?: NodeJS.Timeout;
+
+  static start(
+    clearOnComplete: boolean = true,
+    hideCursor: boolean = true,
+  ): void {
+    Spinner.updatesBar = new progress.MultiBar({
+      format: this.formatter,
+      hideCursor,
+      clearOnComplete,
+      stopOnComplete: true,
+      linewrap: true,
+      noTTYOutput: true,
+    });
+  }
+
+  static stop(): void {
+    Spinner.updatesBar.stop();
+  }
+
+  static formatter(options: any, params: any, payload: SpinnerPayload): string {
+    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 ?? "");
     }
 
-    static stop(): void {
-        Spinner.updatesBar.stop();
+    return Spinner.line(prefix, start, middle, end);
+  }
+
+  static line(
+    prefix: string,
+    start: string,
+    middle: string,
+    end: string,
+    separator: string = "•",
+  ): string {
+    return `${prefix} ${start} ${separator} ${middle} ${!end ? "" : separator} ${end}`;
+  }
+
+  constructor(
+    payload: SpinnerPayload,
+    total: number = 100,
+    startValue: number = 0,
+  ) {
+    this.bar = Spinner.updatesBar.create(total, startValue, payload);
+  }
+
+  update(payload: Partial<SpinnerPayload>): this {
+    this.bar.update(payload);
+    return this;
+  }
+
+  fail(payload: Partial<SpinnerPayload>): void {
+    this.stopSpinner();
+    this.update({ status: "Error", ...payload });
+  }
+
+  startSpinner(name: string): void {
+    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(): void {
+    if (this.spinnerInterval) {
+      clearInterval(this.spinnerInterval);
     }
+  }
 
-    static formatter(options: any, params: any, payload: SpinnerPayload): string {
-        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: string, start: string, middle: string, end: string, separator: string = '•'): string {
-        return `${prefix} ${start} ${separator} ${middle} ${!end ? '' : separator} ${end}`;
-    }
-
-    constructor(payload: SpinnerPayload, total: number = 100, startValue: number = 0) {
-        this.bar = Spinner.updatesBar.create(total, startValue, payload);
-    }
-
-    update(payload: Partial<SpinnerPayload>): this {
-        this.bar.update(payload);
-        return this;
-    }
-
-    fail(payload: Partial<SpinnerPayload>): void {
-        this.stopSpinner();
-        this.update({ status: 'Error', ...payload });
-    }
-
-    startSpinner(name: string): void {
-        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(): void {
-        if (this.spinnerInterval) {
-            clearInterval(this.spinnerInterval);
-        }
-    }
-
-    replaceSpinner(name: string): void {
-        this.stopSpinner();
-        this.startSpinner(name);
-    }
+  replaceSpinner(name: string): void {
+    this.stopSpinner();
+    this.startSpinner(name);
+  }
 }
 
 export { Spinner, SPINNER_ARC, SPINNER_DOTS };

package/lib/type-generation/attribute.ts

@@ -1,17 +1,18 @@
 export 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',
+  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",
 } as const;
 
-export type AttributeTypeValue = typeof AttributeType[keyof typeof AttributeType];
+export type AttributeTypeValue =
+  (typeof AttributeType)[keyof typeof AttributeType];

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

@@ -1,65 +1,77 @@
-import { AttributeType } from '../attribute';
-import { LanguageMeta, Attribute, Collection } from './language';
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
 
 export class CSharp extends LanguageMeta {
-    getType(attribute: Attribute, collections?: Collection[], collectionName?: string): string {
-        let type = '';
-        switch (attribute.type) {
-            case AttributeType.STRING:
-            case AttributeType.EMAIL:
-            case AttributeType.DATETIME:
-                type = 'string';
-                if (attribute.format === AttributeType.ENUM) {
-                    type = LanguageMeta.toPascalCase(collectionName!) + LanguageMeta.toPascalCase(attribute.key);
-                }
-                break;
-            case AttributeType.INTEGER:
-                type = 'long';
-                break;
-            case AttributeType.FLOAT:
-                type = 'double';
-                break;
-            case AttributeType.BOOLEAN:
-                type = 'bool';
-                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 = `List<${type}>`;
-                }
-                break;
-            case AttributeType.POINT:
-                type = 'List<double>';
-                break;
-            case AttributeType.LINESTRING:
-                type = 'List<List<double>>';
-                break;
-            case AttributeType.POLYGON:
-                type = 'List<List<List<double>>>';
-                break;
-            default:
-                throw new Error(`Unknown attribute type: ${attribute.type}`);
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
+    let type = "";
+    switch (attribute.type) {
+      case AttributeType.STRING:
+      case AttributeType.EMAIL:
+      case AttributeType.DATETIME:
+        type = "string";
+        if (attribute.format === AttributeType.ENUM) {
+          type =
+            LanguageMeta.toPascalCase(collectionName!) +
+            LanguageMeta.toPascalCase(attribute.key);
         }
-        if (attribute.array) {
-            type = `List<${type}>`;
+        break;
+      case AttributeType.INTEGER:
+        type = "long";
+        break;
+      case AttributeType.FLOAT:
+        type = "double";
+        break;
+      case AttributeType.BOOLEAN:
+        type = "bool";
+        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.`,
+          );
         }
-        if (!attribute.required) {
-            type += '?';
+        type = LanguageMeta.toPascalCase(relatedCollection.name);
+        if (
+          (attribute.relationType === "oneToMany" &&
+            attribute.side === "parent") ||
+          (attribute.relationType === "manyToOne" &&
+            attribute.side === "child") ||
+          attribute.relationType === "manyToMany"
+        ) {
+          type = `List<${type}>`;
         }
-        return type;
+        break;
+      case AttributeType.POINT:
+        type = "List<double>";
+        break;
+      case AttributeType.LINESTRING:
+        type = "List<List<double>>";
+        break;
+      case AttributeType.POLYGON:
+        type = "List<List<List<double>>>";
+        break;
+      default:
+        throw new Error(`Unknown attribute type: ${attribute.type}`);
+    }
+    if (attribute.array) {
+      type = `List<${type}>`;
     }
+    if (!attribute.required) {
+      type += "?";
+    }
+    return type;
+  }
 
-    getTemplate(): string {
-        return `/// This file is auto-generated by the Appwrite CLI. 
-/// You can regenerate it by running \`appwrite ${process.argv.slice(2).join(' ')}\`.
+  getTemplate(): string {
+    return `/// This file is auto-generated by the Appwrite CLI. 
+/// You can regenerate it by running \`appwrite ${process.argv.slice(2).join(" ")}\`.
 
 #nullable enable
 using System;
@@ -172,10 +184,9 @@ public class <%= toPascalCase(collection.name) %>
 }
 }
 `;
-    }
+  }
 
-    getFileName(collection: Collection): string {
-        return LanguageMeta.toPascalCase(collection.name) + '.cs';
-    }
+  getFileName(collection: Collection): string {
+    return LanguageMeta.toPascalCase(collection.name) + ".cs";
+  }
 }
-