appwrite-cli 12.0.1 → 13.0.0-rc.2

package/lib/sdks.ts

@@ -0,0 +1,84 @@
+import { globalConfig, localConfig } from "./config.js";
+import { Client } from "@appwrite.io/console";
+import os from "os";
+
+export const sdkForConsole = async (
+  requiresAuth: boolean = true,
+): Promise<Client> => {
+  const client = new Client();
+  const endpoint = globalConfig.getEndpoint() || "https://cloud.appwrite.io/v1";
+  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.headers = {
+    "x-sdk-name": "Command Line",
+    "x-sdk-platform": "console",
+    "x-sdk-language": "cli",
+    "x-sdk-version": "13.0.0-rc.2",
+    "user-agent": `AppwriteCLI/13.0.0-rc.2 (${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() ||
+    "https://cloud.appwrite.io/v1";
+
+  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.headers = {
+    "x-sdk-name": "Command Line",
+    "x-sdk-platform": "console",
+    "x-sdk-language": "cli",
+    "x-sdk-version": "13.0.0-rc.2",
+    "user-agent": `AppwriteCLI/13.0.0-rc.2 (${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 `appwrite 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

@@ -0,0 +1,131 @@
+import progress from "cli-progress";
+import chalk from "chalk";
+
+const SPINNER_ARC = "arc";
+const SPINNER_DOTS = "dots";
+
+interface SpinnerConfig {
+  interval: number;
+  frames: string[];
+}
+
+interface SpinnerPayload {
+  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: ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
+  },
+};
+
+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 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 ?? "");
+    }
+
+    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);
+  }
+}
+
+export { Spinner, SPINNER_ARC, SPINNER_DOTS };

package/lib/type-generation/attribute.ts

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

package/lib/type-generation/languages/{csharp.js → csharp.ts}

@@ -1,9 +1,12 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
 
-class CSharp extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
+export class CSharp extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
@@ -11,7 +14,9 @@ class CSharp extends LanguageMeta {
       case AttributeType.DATETIME:
         type = "string";
         if (attribute.format === AttributeType.ENUM) {
-          type = LanguageMeta.toPascalCase(collectionName) + LanguageMeta.toPascalCase(attribute.key);
+          type =
+            LanguageMeta.toPascalCase(collectionName!) +
+            LanguageMeta.toPascalCase(attribute.key);
         }
         break;
       case AttributeType.INTEGER:
@@ -24,12 +29,22 @@ class CSharp extends LanguageMeta {
         type = "bool";
         break;
       case AttributeType.RELATIONSHIP:
-        const relatedCollection = collections.find(c => c.$id === attribute.relatedCollection);
+        const relatedCollection = collections?.find(
+          (c) => c.$id === attribute.relatedCollection,
+        );
         if (!relatedCollection) {
-          throw new Error(`Related collection with ID '${attribute.relatedCollection}' not found.`);
+          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') {
+        if (
+          (attribute.relationType === "oneToMany" &&
+            attribute.side === "parent") ||
+          (attribute.relationType === "manyToOne" &&
+            attribute.side === "child") ||
+          attribute.relationType === "manyToMany"
+        ) {
           type = `List<${type}>`;
         }
         break;
@@ -54,9 +69,9 @@ class CSharp extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
+  getTemplate(): string {
     return `/// This file is auto-generated by the Appwrite CLI. 
-/// You can regenerate it by running \`appwrite ${process.argv.slice(2).join(' ')}\`.
+/// You can regenerate it by running \`appwrite ${process.argv.slice(2).join(" ")}\`.
 
 #nullable enable
 using System;
@@ -171,9 +186,7 @@ public class <%= toPascalCase(collection.name) %>
 `;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toPascalCase(collection.name) + ".cs";
   }
 }
-
-module.exports = { CSharp };

package/lib/type-generation/languages/{dart.js → dart.ts}

@@ -1,46 +1,51 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
-const fs = require('fs');
-const path = require('path');
-
-class Dart extends LanguageMeta {
-  getPackageName() {
-    const pubspecPath = path.join(process.cwd(), 'pubspec.yaml');
+import fs from "fs";
+import path from "path";
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
+
+export class Dart extends LanguageMeta {
+  getPackageName(): string {
+    const pubspecPath = path.join(process.cwd(), "pubspec.yaml");
     if (fs.existsSync(pubspecPath)) {
-        const pubspecContent = fs.readFileSync(pubspecPath, 'utf8');
-        const lines = pubspecContent.split('\n');
-
-        const dependenciesIndex = lines.findIndex(line => line.trim() === 'dependencies:');
-
-        if (dependenciesIndex !== -1) {
-            const indent = lines[dependenciesIndex].search(/\S|$/);
-            const dependencies = [];
-            for (let i = dependenciesIndex + 1; i < lines.length; i++) {
-                const line = lines[i];
-                if (line.trim() === '') continue;
-
-                const lineIndent = line.search(/\S|$/);
-                if (lineIndent <= indent && line.trim() !== '') {
-                    break;
-                }
-
-                dependencies.push(line.trim());
-            }
+      const pubspecContent = fs.readFileSync(pubspecPath, "utf8");
+      const lines = pubspecContent.split("\n");
+
+      const dependenciesIndex = lines.findIndex(
+        (line) => line.trim() === "dependencies:",
+      );
+
+      if (dependenciesIndex !== -1) {
+        const indent = lines[dependenciesIndex].search(/\S|$/);
+        const dependencies: string[] = [];
+        for (let i = dependenciesIndex + 1; i < lines.length; i++) {
+          const line = lines[i];
+          if (line.trim() === "") continue;
+
+          const lineIndent = line.search(/\S|$/);
+          if (lineIndent <= indent && line.trim() !== "") {
+            break;
+          }
+
+          dependencies.push(line.trim());
+        }
 
-            if (dependencies.some(dep => dep.startsWith('dart_appwrite:'))) {
-                return 'dart_appwrite';
-            }
-            if (dependencies.some(dep => dep.startsWith('appwrite:'))) {
-                return 'appwrite';
-            }
+        if (dependencies.some((dep) => dep.startsWith("dart_appwrite:"))) {
+          return "dart_appwrite";
         }
+        if (dependencies.some((dep) => dep.startsWith("appwrite:"))) {
+          return "appwrite";
+        }
+      }
     }
 
-    return 'appwrite';
+    return "appwrite";
   }
 
-  getType(attribute, collections, collectionName) {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
@@ -48,7 +53,9 @@ class Dart extends LanguageMeta {
       case AttributeType.DATETIME:
         type = "String";
         if (attribute.format === AttributeType.ENUM) {
-          type = LanguageMeta.toPascalCase(collectionName) + LanguageMeta.toPascalCase(attribute.key);
+          type =
+            LanguageMeta.toPascalCase(collectionName!) +
+            LanguageMeta.toPascalCase(attribute.key);
         }
         break;
       case AttributeType.INTEGER:
@@ -61,12 +68,22 @@ class Dart extends LanguageMeta {
         type = "bool";
         break;
       case AttributeType.RELATIONSHIP:
-        const relatedCollection = collections.find(c => c.$id === attribute.relatedCollection);
+        const relatedCollection = collections?.find(
+          (c) => c.$id === attribute.relatedCollection,
+        );
         if (!relatedCollection) {
-          throw new Error(`Related collection with ID '${attribute.relatedCollection}' not found.`);
+          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') {
+        if (
+          (attribute.relationType === "oneToMany" &&
+            attribute.side === "parent") ||
+          (attribute.relationType === "manyToOne" &&
+            attribute.side === "child") ||
+          attribute.relationType === "manyToMany"
+        ) {
           type = `List<${type}>`;
         }
         break;
@@ -91,9 +108,9 @@ class Dart extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
-  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(" ")}\`.
 <% const __relatedImportsSeen = new Set();
    const sortedAttributes = collection.attributes.slice().sort((a, b) => {
      if (a.required === b.required) return 0;
@@ -194,9 +211,7 @@ map['<%= attribute.key %>'] != null ? <%- toPascalCase(collections.find(c => c.$
 `;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toSnakeCase(collection.name) + ".dart";
   }
 }
-
-module.exports = { Dart };

package/lib/type-generation/languages/{java.js → java.ts}

@@ -1,9 +1,12 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
-
-class Java extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
+
+export class Java extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
@@ -11,25 +14,37 @@ class Java extends LanguageMeta {
       case AttributeType.DATETIME:
         type = "String";
         if (attribute.format === AttributeType.ENUM) {
-          type = LanguageMeta.toPascalCase(collectionName) + LanguageMeta.toPascalCase(attribute.key);
+          type =
+            LanguageMeta.toPascalCase(collectionName!) +
+            LanguageMeta.toPascalCase(attribute.key);
         }
         break;
       case AttributeType.INTEGER:
-        type = "int";
+        type = "Integer";
         break;
       case AttributeType.FLOAT:
-        type = "double";
+        type = "Double";
         break;
       case AttributeType.BOOLEAN:
-        type = "boolean";
+        type = "Boolean";
         break;
       case AttributeType.RELATIONSHIP:
-        const relatedCollection = collections.find(c => c.$id === attribute.relatedCollection);
+        const relatedCollection = collections?.find(
+          (c) => c.$id === attribute.relatedCollection,
+        );
         if (!relatedCollection) {
-          throw new Error(`Related collection with ID '${attribute.relatedCollection}' not found.`);
+          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') {
+        if (
+          (attribute.relationType === "oneToMany" &&
+            attribute.side === "parent") ||
+          (attribute.relationType === "manyToOne" &&
+            attribute.side === "child") ||
+          attribute.relationType === "manyToMany"
+        ) {
           type = "List<" + type + ">";
         }
         break;
@@ -51,12 +66,12 @@ class Java extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
+  getTemplate(): string {
     return `package io.appwrite.models;
 
 /**
  * This file is auto-generated by the Appwrite CLI. 
- * You can regenerate it by running \`appwrite ${process.argv.slice(2).join(' ')}\`.
+ * You can regenerate it by running \`appwrite ${process.argv.slice(2).join(" ")}\`.
  */
 
 import java.util.Objects;
@@ -131,9 +146,7 @@ public class <%- toPascalCase(collection.name) %> {
 `;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toPascalCase(collection.name) + ".java";
   }
 }
-
-module.exports = { Java };