appwrite-cli 12.0.1 → 13.0.0-rc.2

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

@@ -1,13 +1,11 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const fs = require("fs");
-const path = require("path");
+import fs from "fs";
+import path from "path";
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
 
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
-
-class JavaScript extends LanguageMeta {
-  getType(attribute, collections) {
-    let type = ""
+export class JavaScript extends LanguageMeta {
+  getType(attribute: Attribute, collections?: Collection[]): string {
+    let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
       case AttributeType.EMAIL:
@@ -29,12 +27,22 @@ class JavaScript extends LanguageMeta {
         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 = `${type}[]`;
         }
         break;
@@ -59,27 +67,32 @@ class JavaScript extends LanguageMeta {
     return type;
   }
 
-  isSingleFile() {
+  isSingleFile(): boolean {
     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';
+  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";
     }
 
     return "appwrite";
   }
 
-  getTemplate() {
+  getTemplate(): string {
     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(' ')}\`.
+// 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) { -%>
@@ -103,9 +116,7 @@ class JavaScript extends LanguageMeta {
 <% } %>`;
   }
 
-  getFileName(_) {
+  getFileName(_: Collection | undefined): string {
     return "appwrite-types.js";
   }
 }
-
-module.exports = { JavaScript }; 

package/lib/type-generation/languages/{kotlin.js → kotlin.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 Kotlin extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
+export class Kotlin extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
@@ -11,7 +14,9 @@ class Kotlin 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 Kotlin extends LanguageMeta {
         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;
@@ -54,7 +69,7 @@ class Kotlin extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
+  getTemplate(): string {
     return `package io.appwrite.models
 
 <% for (const attribute of collection.attributes) { -%>
@@ -65,7 +80,7 @@ import <%- toPascalCase(collections.find(c => c.$id === attribute.relatedCollect
 <% } -%>
 /**
  * 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(" ")}\`.
  */
 
 <% for (const attribute of collection.attributes) { -%>
@@ -86,9 +101,7 @@ data class <%- toPascalCase(collection.name) %>(
 `;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toPascalCase(collection.name) + ".kt";
   }
 }
-
-module.exports = { Kotlin };

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

@@ -1,17 +1,33 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-/** @typedef {import('../collection').Collection} Collection */
+import fs from "fs";
+import path from "path";
 
-const fs = require("fs");
-const path = require("path");
+export interface Attribute {
+  key: string;
+  type: string;
+  required?: boolean;
+  array?: boolean;
+  default?: any;
+  format?: string;
+  elements?: string[];
+  relatedCollection?: string;
+  relationType?: string;
+  side?: string;
+}
+
+export interface Collection {
+  $id: string;
+  name: string;
+  attributes: Attribute[];
+}
 
-class LanguageMeta {
+export abstract class LanguageMeta {
   constructor() {
     if (new.target === LanguageMeta) {
       throw new TypeError("Abstract classes can't be instantiated.");
     }
   }
 
-  static toKebabCase(string) {
+  static toKebabCase(string: string): string {
     return string
       .replace(/[^a-zA-Z0-9\s-_]/g, "") // Remove invalid characters
       .replace(/([a-z])([A-Z])/g, "$1-$2") // Add hyphen between camelCase
@@ -22,73 +38,55 @@ class LanguageMeta {
       .toLowerCase();
   }
 
-  static toSnakeCase(string) {
+  static toSnakeCase(string: string): string {
     return this.toKebabCase(string).replace(/-/g, "_");
   }
 
-  static toUpperSnakeCase(string) {
+  static toUpperSnakeCase(string: string): string {
     return this.toSnakeCase(string).toUpperCase();
   }
 
-  static toCamelCase(string) {
+  static toCamelCase(string: string): string {
     return this.toKebabCase(string).replace(/-([a-z0-9])/g, (g) =>
-      g[1].toUpperCase()
+      g[1].toUpperCase(),
     );
   }
 
-  static toPascalCase(string) {
+  static toPascalCase(string: string): string {
     return this.toCamelCase(string).replace(/^./, (g) => g.toUpperCase());
   }
 
   /**
    * Get the type literal of the given attribute.
-   *
-   * @abstract
-   * @param {Attribute} attribute
-   * @return {string}
    */
-  getType(attribute) {
-    throw new TypeError("Stub.");
-  }
+  abstract getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string;
 
   /**
    * Returns true if the language uses a single file for all types.
-   *
-   * @returns {boolean}
    */
-  isSingleFile() {
+  isSingleFile(): boolean {
     return false;
   }
 
   /**
    * Get the EJS template used to generate the types for this language.
-   *
-   * @abstract
-   * @returns {string}
    */
-  getTemplate() {
-    throw new TypeError("Stub.");
-  }
+  abstract getTemplate(): string;
 
   /**
    * Get the file extension used by files of this language.
-   *
-   * @abstract
-   * @param {Collection|undefined} collection
-   * @returns {string}
    */
-  getFileName(collection) {
-    throw new TypeError("Stub.");
-  }
+  abstract getFileName(collection?: Collection): string;
 }
 
-const existsFiles = (...files) =>
+const existsFiles = (...files: string[]): boolean =>
   files.some((file) => fs.existsSync(path.join(process.cwd(), file)));
 
-/**
- * @returns {string}
- */
-function detectLanguage() {
+export function detectLanguage(): string {
   if (existsFiles("tsconfig.json", "deno.json")) {
     return "ts";
   }
@@ -110,8 +108,14 @@ function detectLanguage() {
   if (existsFiles("build.gradle", "pom.xml")) {
     return "java";
   }
-  if (existsFiles("*.csproj")) {
-    return "dotnet";
+  try {
+    if (
+      fs.readdirSync(process.cwd()).some((file) => file.endsWith(".csproj"))
+    ) {
+      return "dotnet";
+    }
+  } catch {
+    // Directory not readable, skip .csproj detection
   }
   if (existsFiles("Package.swift")) {
     return "swift";
@@ -121,5 +125,3 @@ function detectLanguage() {
   }
   throw new Error("Could not detect language, please specify with -l");
 }
-
-module.exports = { LanguageMeta, detectLanguage };

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

@@ -1,20 +1,25 @@
-/** @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 PHP extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
+export class PHP extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     if (attribute.array) {
       return "array";
     }
-    let type = ""
+    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);
+          type =
+            LanguageMeta.toPascalCase(collectionName!) +
+            LanguageMeta.toPascalCase(attribute.key);
         }
         break;
       case AttributeType.INTEGER:
@@ -27,12 +32,22 @@ class PHP 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 = "array";
         }
         break;
@@ -50,12 +65,12 @@ class PHP extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
+  getTemplate(): string {
     return `<?php
 namespace 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(" ")}\`.
 
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.type === 'relationship' && !(attribute.relationType === 'manyToMany') && !(attribute.relationType === 'oneToMany' && attribute.side === 'parent')) { -%>
@@ -107,9 +122,7 @@ class <%- toPascalCase(collection.name) %> {
 `;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toPascalCase(collection.name) + ".php";
   }
 }
-
-module.exports = { PHP };

package/lib/type-generation/languages/{swift.js → swift.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 Swift extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
+export class Swift extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
     let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
@@ -11,7 +14,9 @@ class Swift 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 Swift 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 = `[${type}]`;
         }
         break;
@@ -54,11 +69,11 @@ class Swift extends LanguageMeta {
     return type;
   }
 
-  getTemplate() {
+  getTemplate(): string {
     return `import Foundation
 
 /// 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(" ")}\`.
 
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.format === 'enum') { -%>
@@ -170,9 +185,7 @@ public class <%- toPascalCase(collection.name) %>: Codable {
 }`;
   }
 
-  getFileName(collection) {
+  getFileName(collection: Collection): string {
     return LanguageMeta.toPascalCase(collection.name) + ".swift";
   }
 }
-
-module.exports = { Swift };

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

@@ -1,13 +1,15 @@
-/** @typedef {import('../attribute').Attribute} Attribute */
-const fs = require("fs");
-const path = require("path");
+import fs from "fs";
+import path from "path";
+import { AttributeType } from "../attribute.js";
+import { LanguageMeta, Attribute, Collection } from "./language.js";
 
-const { AttributeType } = require('../attribute');
-const { LanguageMeta } = require("./language");
-
-class TypeScript extends LanguageMeta {
-  getType(attribute, collections, collectionName) {
-    let type = ""
+export class TypeScript extends LanguageMeta {
+  getType(
+    attribute: Attribute,
+    collections?: Collection[],
+    collectionName?: string,
+  ): string {
+    let type = "";
     switch (attribute.type) {
       case AttributeType.STRING:
       case AttributeType.EMAIL:
@@ -16,7 +18,9 @@ class TypeScript extends LanguageMeta {
       case AttributeType.URL:
         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:
@@ -29,12 +33,22 @@ class TypeScript extends LanguageMeta {
         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 = `${type}[]`;
         }
         break;
@@ -59,29 +73,34 @@ class TypeScript extends LanguageMeta {
     return type;
   }
 
-  isSingleFile() {
+  isSingleFile(): boolean {
     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';
+  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'))) {
+    if (fs.existsSync(path.resolve(process.cwd(), "deno.json"))) {
       return "https://deno.land/x/appwrite/mod.ts";
     }
 
     return "appwrite";
   }
 
-  getTemplate() {
+  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(' ')}\`.
+// 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) { -%>
@@ -108,9 +127,7 @@ export type <%- toPascalCase(collection.name) %> = Models.Row & {
 <% } -%>`;
   }
 
-  getFileName(_) {
+  getFileName(_: Collection | undefined): string {
     return "appwrite.d.ts";
   }
 }
-
-module.exports = { TypeScript };