chirag-appwrite-cli 0.1.0

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

@@ -0,0 +1,125 @@
+/** @typedef {import('../attribute').Attribute} Attribute */
+/** @typedef {import('../collection').Collection} Collection */
+
+const fs = require("fs");
+const path = require("path");
+
+class LanguageMeta {
+  constructor() {
+    if (new.target === LanguageMeta) {
+      throw new TypeError("Abstract classes can't be instantiated.");
+    }
+  }
+
+  static toKebabCase(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
+      .replace(/([A-Z])([A-Z][a-z])/g, "$1-$2") // Add hyphen between PascalCase
+      .replace(/[_\s]+/g, "-") // Replace spaces and underscores with hyphens
+      .replace(/^-+|-+$/g, "") // Remove leading and trailing hyphens
+      .replace(/--+/g, "-") // Replace multiple hyphens with a single hyphen
+      .toLowerCase();
+  }
+
+  static toSnakeCase(string) {
+    return this.toKebabCase(string).replace(/-/g, "_");
+  }
+
+  static toUpperSnakeCase(string) {
+    return this.toSnakeCase(string).toUpperCase();
+  }
+
+  static toCamelCase(string) {
+    return this.toKebabCase(string).replace(/-([a-z0-9])/g, (g) =>
+      g[1].toUpperCase()
+    );
+  }
+
+  static toPascalCase(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.");
+  }
+
+  /**
+   * Returns true if the language uses a single file for all types.
+   *
+   * @returns {boolean}
+   */
+  isSingleFile() {
+    return false;
+  }
+
+  /**
+   * Get the EJS template used to generate the types for this language.
+   *
+   * @abstract
+   * @returns {string}
+   */
+  getTemplate() {
+    throw new TypeError("Stub.");
+  }
+
+  /**
+   * Get the file extension used by files of this language.
+   *
+   * @abstract
+   * @param {Collection|undefined} collection
+   * @returns {string}
+   */
+  getFileName(collection) {
+    throw new TypeError("Stub.");
+  }
+}
+
+const existsFiles = (...files) =>
+  files.some((file) => fs.existsSync(path.join(process.cwd(), file)));
+
+/**
+ * @returns {string}
+ */
+function detectLanguage() {
+  if (existsFiles("tsconfig.json", "deno.json")) {
+    return "ts";
+  }
+  if (existsFiles("package.json")) {
+    return "js";
+  }
+  if (existsFiles("composer.json")) {
+    return "php";
+  }
+  if (existsFiles("requirements.txt", "Pipfile", "pyproject.toml")) {
+    return "python";
+  }
+  if (existsFiles("Gemfile", "Rakefile")) {
+    return "ruby";
+  }
+  if (existsFiles("build.gradle.kts")) {
+    return "kotlin";
+  }
+  if (existsFiles("build.gradle", "pom.xml")) {
+    return "java";
+  }
+  if (existsFiles("*.csproj")) {
+    return "dotnet";
+  }
+  if (existsFiles("Package.swift")) {
+    return "swift";
+  }
+  if (existsFiles("pubspec.yaml")) {
+    return "dart";
+  }
+  throw new Error("Could not detect language, please specify with -l");
+}
+
+module.exports = { LanguageMeta, detectLanguage };

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

@@ -0,0 +1,109 @@
+/** @typedef {import('../attribute').Attribute} Attribute */
+const { AttributeType } = require('../attribute');
+const { LanguageMeta } = require("./language");
+
+class PHP extends LanguageMeta {
+  getType(attribute) {
+    if (attribute.array) {
+      return "array";
+    }
+    let type = ""
+    switch (attribute.type) {
+      case AttributeType.STRING:
+      case AttributeType.EMAIL:
+      case AttributeType.DATETIME:
+        type = "string";
+        if (attribute.format === AttributeType.ENUM) {
+          type = LanguageMeta.toPascalCase(attribute.key);
+        }
+        break;
+      case AttributeType.INTEGER:
+        type = "int";
+        break;
+      case AttributeType.FLOAT:
+        type = "float";
+        break;
+      case AttributeType.BOOLEAN:
+        type = "bool";
+        break;
+      case AttributeType.RELATIONSHIP:
+        type = LanguageMeta.toPascalCase(attribute.relatedCollection);
+        if ((attribute.relationType === 'oneToMany' && attribute.side === 'parent') || (attribute.relationType === 'manyToOne' && attribute.side === 'child') || attribute.relationType === 'manyToMany') {
+          type = "array";
+        }
+        break;
+      default:
+        throw new Error(`Unknown attribute type: ${attribute.type}`);
+    }
+    if (!attribute.required && attribute.default === null) {
+      type += "|null";
+    }
+    return type;
+  }
+
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
+  getTemplate() {
+    return `<?php
+namespace Appwrite\\Models;
+
+// This file is auto-generated by the Appwrite CLI. 
+// You can regenerate it by running \`appwrite types -l <%- strict ? '--strict ' : '' %>php <%- path %>\`.
+
+<% for (const attribute of collection.attributes) { -%>
+<% if (attribute.type === 'relationship' && !(attribute.relationType === 'manyToMany') && !(attribute.relationType === 'oneToMany' && attribute.side === 'parent')) { -%>
+use Appwrite\\Models\\<%- toPascalCase(attribute.relatedCollection) %>;
+
+<% } -%>
+<% } -%>
+<% for (const attribute of collection.attributes) { -%>
+<% if (attribute.format === 'enum') { -%>
+enum <%- toPascalCase(attribute.key) %>: string {
+<% for (const [index, element] of Object.entries(attribute.elements)) { -%>
+    case <%- strict ? toUpperSnakeCase(element) : element %> = '<%- element %>';
+<% } -%>
+}
+
+<% } -%>
+<% } -%>
+class <%- toPascalCase(collection.name) %> {
+<% for (const attribute of collection.attributes ){ -%>
+    private <%- getType(attribute) %> $<%- strict ? toCamelCase(attribute.key) : attribute.key %>;
+<% } -%>
+
+    public function __construct(
+<% for (const attribute of collection.attributes ){ -%>
+<% if (attribute.required) { -%>
+        <%- getType(attribute).replace('|null', '') %> $<%- strict ? toCamelCase(attribute.key) : attribute.key %><% if (collection.attributes.indexOf(attribute) < collection.attributes.length - 1) { %>,<% } %>
+<% } else { -%>
+        ?<%- getType(attribute).replace('|null', '') %> $<%- strict ? toCamelCase(attribute.key) : attribute.key %> = null<% if (collection.attributes.indexOf(attribute) < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+<% } -%>
+    ) {
+<% for (const attribute of collection.attributes ){ -%>
+        $this-><%- strict ? toCamelCase(attribute.key) : attribute.key %> = $<%- strict ? toCamelCase(attribute.key) : attribute.key %>;
+<% } -%>
+    }
+
+<% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
+    public function get<%- toPascalCase(attribute.key) %>(): <%- getType(attribute) %> {
+        return $this-><%- strict ? toCamelCase(attribute.key) : attribute.key %>;
+    }
+
+    public function set<%- toPascalCase(attribute.key) %>(<%- getType(attribute) %> $<%- strict ? toCamelCase(attribute.key) : attribute.key %>): void {
+        $this-><%- strict ? toCamelCase(attribute.key) : attribute.key %> = $<%- strict ? toCamelCase(attribute.key) : attribute.key %>;
+    }
+<% if (index < collection.attributes.length - 1) { %>
+<% } -%>
+<% } -%>
+}`;
+  }
+
+  getFileName(collection) {
+    return LanguageMeta.toPascalCase(collection.name) + ".php";
+  }
+}
+
+module.exports = { PHP };

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

@@ -0,0 +1,169 @@
+/** @typedef {import('../attribute').Attribute} Attribute */
+const { AttributeType } = require('../attribute');
+const { LanguageMeta } = require("./language");
+
+class Swift extends LanguageMeta {
+  getType(attribute) {
+    let type = "";
+    switch (attribute.type) {
+      case AttributeType.STRING:
+      case AttributeType.EMAIL:
+      case AttributeType.DATETIME:
+        type = "String";
+        if (attribute.format === AttributeType.ENUM) {
+          type = LanguageMeta.toPascalCase(attribute.key);
+        }
+        break;
+      case AttributeType.INTEGER:
+        type = "Int";
+        break;
+      case AttributeType.FLOAT:
+        type = "Double";
+        break;
+      case AttributeType.BOOLEAN:
+        type = "Bool";
+        break;
+      case AttributeType.RELATIONSHIP:
+        type = LanguageMeta.toPascalCase(attribute.relatedCollection);
+        if ((attribute.relationType === 'oneToMany' && attribute.side === 'parent') || (attribute.relationType === 'manyToOne' && attribute.side === 'child') || attribute.relationType === 'manyToMany') {
+          type = `[${type}]`;
+        }
+        break;
+      default:
+        throw new Error(`Unknown attribute type: ${attribute.type}`);
+    }
+    if (attribute.array) {
+      type = "[" + type + "]";
+    }
+    if (!attribute.required && attribute.default === null) {
+      type += "?";
+    }
+    return type;
+  }
+
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
+  getTemplate() {
+    return `import Foundation
+
+/// This file is auto-generated by the Appwrite CLI. 
+/// You can regenerate it by running \`appwrite types -l <%- strict ? '--strict ' : '' %>swift <%- path %>\`.
+
+<% for (const attribute of collection.attributes) { -%>
+<% if (attribute.format === 'enum') { -%>
+public enum <%- toPascalCase(attribute.key) %>: String, Codable, CaseIterable {
+<% for (const [index, element] of Object.entries(attribute.elements)) { -%>
+    case <%- strict ? toCamelCase(element) : element %> = "<%- element %>"
+<% } -%>
+}
+
+<% } -%>
+<% } -%>
+public class <%- toPascalCase(collection.name) %>: Codable {
+<% for (const attribute of collection.attributes) { -%>
+    public let <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- getType(attribute) %>
+<% } %>
+    enum CodingKeys: String, CodingKey {
+<% for (const attribute of collection.attributes) { -%>
+        case <%- strict ? toCamelCase(attribute.key) : attribute.key %> = "<%- attribute.key %>"
+<% } -%>
+    }
+
+    public init(
+<% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
+        <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- getType(attribute) %><% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+    ) {
+<% for (const attribute of collection.attributes) { -%>
+        self.<%- strict ? toCamelCase(attribute.key) : attribute.key %> = <%- strict ? toCamelCase(attribute.key) : attribute.key %>
+<% } -%>
+    }
+
+    public required init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+<% for (const attribute of collection.attributes) { -%>
+<% if (!(!attribute.required && attribute.default === null)) { -%>
+        self.<%- strict ? toCamelCase(attribute.key) : attribute.key %> = try container.decode(<%- getType(attribute).replace('?', '') %>.self, forKey: .<%- strict ? toCamelCase(attribute.key) : attribute.key %>)
+<% } else { -%>
+        self.<%- strict ? toCamelCase(attribute.key) : attribute.key %> = try container.decodeIfPresent(<%- getType(attribute).replace('?', '') %>.self, forKey: .<%- strict ? toCamelCase(attribute.key) : attribute.key %>)
+<% } -%>
+<% } -%>
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+<% for (const attribute of collection.attributes) { -%>
+<% if (!(!attribute.required && attribute.default === null)) { -%>
+        try container.encode(<%- strict ? toCamelCase(attribute.key) : attribute.key %>, forKey: .<%- strict ? toCamelCase(attribute.key) : attribute.key %>)
+<% } else { -%>
+        try container.encodeIfPresent(<%- strict ? toCamelCase(attribute.key) : attribute.key %>, forKey: .<%- strict ? toCamelCase(attribute.key) : attribute.key %>)
+<% } -%>
+<% } -%>
+    }
+
+    public func toMap() -> [String: Any] {
+        return [
+<% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
+<% if (attribute.type === 'relationship') { -%>
+            "<%- attribute.key %>": <%- strict ? toCamelCase(attribute.key) : attribute.key %> as Any<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.array && attribute.type !== 'string' && attribute.type !== 'integer' && attribute.type !== 'float' && attribute.type !== 'boolean') { -%>
+            "<%- attribute.key %>": <%- strict ? toCamelCase(attribute.key) : attribute.key %>?.map { $0.toMap() } as Any<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else { -%>
+            "<%- attribute.key %>": <%- strict ? toCamelCase(attribute.key) : attribute.key %> as Any<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+<% } -%>
+        ]
+    }
+
+    public static func from(map: [String: Any]) -> <%- toPascalCase(collection.name) %> {
+        return <%- toPascalCase(collection.name) %>(
+<% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
+<% if (attribute.type === 'relationship') { -%>
+<% if ((attribute.relationType === 'oneToMany' && attribute.side === 'parent') || (attribute.relationType === 'manyToOne' && attribute.side === 'child') || attribute.relationType === 'manyToMany') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [<%- toPascalCase(attribute.relatedCollection) %>]<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> <%- toPascalCase(attribute.relatedCollection) %><% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+<% } else if (attribute.array) { -%>
+<% if (attribute.type === 'string') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [String]<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'integer') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [Int]<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'float') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [Double]<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'boolean') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [Bool]<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: (map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> [[String: Any]])<% if (!attribute.required) { %>?<% } %>.map { <%- toPascalCase(attribute.type) %>.from(map: $0) }<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+<% } else { -%>
+<% if ((attribute.type === 'string' || attribute.type === 'email' || attribute.type === 'datetime') && attribute.format !== 'enum') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> String<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'string' && attribute.format === 'enum') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- toPascalCase(attribute.key) %>(rawValue: map["<%- attribute.key %>"] as! String)!<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'integer') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> Int<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'float') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> Double<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else if (attribute.type === 'boolean') { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: map["<%- attribute.key %>"] as<% if (!attribute.required) { %>?<% } else { %>!<% } %> Bool<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } else { -%>
+            <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- toPascalCase(attribute.type) %>.from(map: map["<%- attribute.key %>"] as! [String: Any])<% if (index < collection.attributes.length - 1) { %>,<% } %>
+<% } -%>
+<% } -%>
+<% } -%>
+        )
+    }
+}`;
+  }
+
+  getFileName(collection) {
+    return LanguageMeta.toPascalCase(collection.name) + ".swift";
+  }
+}
+
+module.exports = { Swift };

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

@@ -0,0 +1,102 @@
+/** @typedef {import('../attribute').Attribute} Attribute */
+const fs = require("fs");
+const path = require("path");
+
+const { AttributeType } = require('../attribute');
+const { LanguageMeta } = require("./language");
+
+class TypeScript 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);
+        type = LanguageMeta.toPascalCase(relatedCollection.name);
+        if ((attribute.relationType === 'oneToMany' && attribute.side === 'parent') || (attribute.relationType === 'manyToOne' && attribute.side === 'child') || attribute.relationType === 'manyToMany') {
+          type = `${type}[]`;
+        }
+        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';
+    }
+
+    if (fs.existsSync(path.resolve(process.cwd(), 'deno.json'))) {
+      return "https://deno.land/x/appwrite/mod.ts";
+    }
+
+    return "appwrite";
+  }
+
+  getTemplate() {
+    return `import { type Models } from '${this._getAppwriteDependency()}';
+
+// This file is auto-generated by the Appwrite CLI. 
+// You can regenerate it by running \`appwrite types -l <%- strict ? '--strict ' : '' %>ts <%- path %>\`.
+
+<% for (const collection of collections) { -%>
+<% for (const attribute of collection.attributes) { -%>
+<% if (attribute.format === 'enum') { -%>
+export enum <%- 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.Document & {
+<% for (const attribute of collection.attributes) { -%>
+    <%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- getType(attribute, collections) %>;
+<% } -%>
+}<% if (index < collections.length - 1) { %>
+<% } %>
+<% } -%>`;
+  }
+
+  getFileName(_) {
+    return "appwrite.d.ts";
+  }
+}
+
+module.exports = { TypeScript };