feat: add docblocks to generated types

Author: ChiragAgg5k

templates/cli/lib/type-generation/languages/dart.js.twig

@@ -41,18 +41,27 @@ class Dart extends LanguageMeta {
     return type;
   }
 
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
   getTemplate() {
     return `<% for (const attribute of collection.attributes) { -%>
 <% if (attribute.type === 'relationship') { -%>
 import '<%- attribute.relatedCollection.toLowerCase() %>.dart';
 
 <% } -%>
 <% } -%>
+/**
+ * This file is auto-generated by the Appwrite CLI. 
+ * You can regenerate it by running \`appwrite types -l dart ${this.getCurrentDirectory()}\`.
+ */
+
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.format === 'enum') { -%>
 enum <%- toPascalCase(attribute.key) %> {
-<% for (const element of attribute.elements) { -%>
-  <%- toSnakeCase(element) %>,
+<% for (const [index, element] of Object.entries(attribute.elements)) { -%>
+  <%- toSnakeCase(element) %><% if (index < attribute.elements.length - 1) { %>,<% } %>
 <% } -%>
 }
 
@@ -65,7 +74,7 @@ class <%= toPascalCase(collection.name) %> {
 
   <%= toPascalCase(collection.name) %>({
   <% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
-  <% if (attribute.required) { %>required <% } %>this.<%= toCamelCase(attribute.key) %>,
+  <% if (attribute.required) { %>required <% } %>this.<%= toCamelCase(attribute.key) %><% if (index < collection.attributes.length - 1) { %>,<% } %>
   <% } -%>
 });
 
@@ -114,7 +123,7 @@ map['<%= attribute.key %>']<% if (!attribute.required) { %> ?? null<% } -%>
 map['<%= attribute.key %>'] != null ? <%- toPascalCase(attribute.relatedCollection) %>.fromMap(map['<%= attribute.key %>']) : null<% } else { -%>
 <%- toPascalCase(attribute.relatedCollection) %>.fromMap(map['<%= attribute.key %>'])<% } -%>
 <% } -%>
-<% } -%>,
+<% } -%><% if (index < collection.attributes.length - 1) { %>,<% } %>
 <% } -%>
     );
   }
@@ -136,7 +145,7 @@ map['<%= attribute.key %>'] != null ? <%- toPascalCase(attribute.relatedCollecti
 <% } -%>
 <% } else { -%>
 <%= toCamelCase(attribute.key) -%>
-<% } -%>,
+<% } -%><% if (index < collection.attributes.length - 1) { %>,<% } %>
 <% } -%>
     };
   }

templates/cli/lib/type-generation/languages/java.js.twig

@@ -38,9 +38,18 @@ class Java extends LanguageMeta {
     return type;
   }
 
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
   getTemplate() {
     return `package io.appwrite.models;
 
+/**
+ * This file is auto-generated by the Appwrite CLI. 
+ * You can regenerate it by running \`appwrite types -l java ${this.getCurrentDirectory()}\`.
+ */
+
 import java.util.*;
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.type === 'relationship') { -%>

templates/cli/lib/type-generation/languages/javascript.js.twig

@@ -40,7 +40,7 @@ class JavaScript extends LanguageMeta {
     if (attribute.array) {
       type += "[]";
     }
-    if (!attribute.required) {
+    if (!attribute.required && attribute.default === null) {
       type += "|null|undefined";
     }
     return type;
@@ -60,19 +60,26 @@ class JavaScript extends LanguageMeta {
     return "appwrite";
   }
 
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
   getTemplate() {
     return `/**
  * @typedef {import('${this._getAppwriteDependency()}').Models.Document} Document
  */
 
+/**
+ * This file is auto-generated by the Appwrite CLI. 
+ * You can regenerate it by running \`appwrite types -l js ${this.getCurrentDirectory()}\`.
+ */
 <% for (const collection of collections) { %>
 /**
  * @typedef {Object} <%- toPascalCase(collection.name) %>
 <% for (const attribute of collection.attributes) { -%>
  * @property {<%- getType(attribute) %>} <%- toCamelCase(attribute.key) %>
 <% } -%>
  */
-
 <% } %>`;
   }
 

templates/cli/lib/type-generation/languages/kotlin.js.twig

@@ -35,12 +35,16 @@ class Kotlin extends LanguageMeta {
     if (attribute.array) {
       type = "List<" + type + ">";
     }
-    if (!attribute.required) {
+    if (!attribute.required && attribute.default === null) {
       type += "?";
     }
     return type;
   }
 
+  getCurrentDirectory() {
+    return process.cwd();
+  }
+
   getTemplate() {
     return `package io.appwrite.models
 
@@ -50,6 +54,11 @@ import <%- toPascalCase(attribute.relatedCollection) %>
 
 <% } -%>
 <% } -%>
+/**
+ * This file is auto-generated by the Appwrite CLI. 
+ * You can regenerate it by running \`appwrite types -l kotlin ${this.getCurrentDirectory()}\`.
+ */
+
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.format === 'enum') { -%>
 enum class <%- toPascalCase(attribute.key) %> {
@@ -61,8 +70,8 @@ enum class <%- toPascalCase(attribute.key) %> {
 <% } -%>
 <% } -%>
 data class <%- toPascalCase(collection.name) %>(
-<% for (const attribute of collection.attributes) { -%>
-    val <%- toCamelCase(attribute.key) %>: <%- getType(attribute) %>,
+<% for (const [index, attribute] of Object.entries(collection.attributes)) { -%>
+    val <%- toCamelCase(attribute.key) %>: <%- getType(attribute) %><% if (index < collection.attributes.length - 1) { %>,<% } %>
 <% } -%>
 )`;
   }

templates/cli/lib/type-generation/languages/php.js.twig

@@ -35,16 +35,25 @@ class PHP extends LanguageMeta {
       default:
         throw new Error(`Unknown attribute type: ${attribute.type}`);
     }
-    if (!attribute.required) {
+    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 php ${this.getCurrentDirectory()}\`.
+ */
+
 <% 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) %>;

templates/cli/lib/type-generation/languages/swift.js.twig

@@ -35,15 +35,22 @@ class Swift extends LanguageMeta {
     if (attribute.array) {
       type = "[" + type + "]";
     }
-    if (!attribute.required) {
+    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 swift ${this.getCurrentDirectory()}\`.
+
 <% for (const attribute of collection.attributes) { -%>
 <% if (attribute.format === 'enum') { -%>
 public enum <%- toPascalCase(attribute.key) %>: String, Codable, CaseIterable {

templates/cli/lib/type-generation/languages/typescript.js.twig

@@ -71,8 +71,10 @@ class TypeScript extends LanguageMeta {
   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 ts ${this.getCurrentDirectory()}\`.
+/**
+ * This file is auto-generated by the Appwrite CLI. 
+ * You can regenerate it by running \`appwrite types -l ts ${this.getCurrentDirectory()}\`.
+ */
 
 <% for (const collection of collections) { -%>
 <% for (const attribute of collection.attributes) { -%>