chore: add javascript jsdocs

Author: ChiragAgg5k

src/SDK/Language/CLI.php

@@ -201,6 +201,11 @@ public function getFiles(): array
                 'destination'   => 'lib/type-generation/languages/typescript.js',
                 'template'      => 'cli/lib/type-generation/languages/typescript.js.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/type-generation/languages/javascript.js',
+                'template'      => 'cli/lib/type-generation/languages/javascript.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'lib/type-generation/languages/kotlin.js',

templates/cli/lib/commands/types.js.twig

@@ -11,6 +11,7 @@ const { Kotlin } = require("../type-generation/languages/kotlin");
 const { Swift } = require("../type-generation/languages/swift");
 const { Java } = require("../type-generation/languages/java");
 const { Dart } = require("../type-generation/languages/dart");
+const { JavaScript } = require("../type-generation/languages/javascript");
 
 /**
  * @param {string} language
@@ -20,6 +21,8 @@ function createLanguageMeta(language) {
   switch (language) {
     case "ts":
       return new TypeScript();
+    case "js":
+      return new JavaScript();
     case "php":
       return new PHP();
     case "kotlin":
@@ -52,7 +55,7 @@ const typesLanguageOption = new Option(
   "-l, --language <language>",
   "The language of the types"
 )
-  .choices(["auto", "ts", "php", "kotlin", "swift", "java", "dart"])
+  .choices(["auto", "ts", "js", "php", "kotlin", "swift", "java", "dart"])
   .default("auto");
 
 const typesCommand = actionRunner(async (rawOutputDirectory, {language}) => {

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

@@ -0,0 +1,79 @@
+/** @typedef {import('../attribute').Attribute} Attribute */
+const fs = require("fs");
+const path = require("path");
+
+const { AttributeType } = require('../attribute');
+const { LanguageMeta } = require("./language");
+
+class JavaScript extends LanguageMeta {
+  getType(attribute) {
+    let type = ""
+    switch (attribute.type) {
+      case AttributeType.STRING:
+      case AttributeType.EMAIL:
+      case AttributeType.DATETIME:
+      case AttributeType.ENUM:
+      case AttributeType.IP:
+      case AttributeType.___URL:
+        type = "string";
+        break;
+      case AttributeType.INTEGER:
+        type = "number";
+        break;
+      case AttributeType.FLOAT:
+        type = "number";
+        break;
+      case AttributeType.BOOLEAN:
+        type = "boolean";
+        break;
+      case AttributeType.RELATIONSHIP:
+        type = "any";
+        break;
+      default:
+        throw new Error(`Unknown attribute type: ${attribute.type}`);
+    }
+    if (attribute.array) {
+      type += "[]";
+    }
+    if (!attribute.required) {
+      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';
+    }
+
+    return "appwrite";
+  }
+
+  getTemplate() {
+    return `/**
+ * @typedef {import('${this._getAppwriteDependency()}').Models.Document} Document
+ */
+
+<% for (const collection of collections) { %>
+/**
+ * @typedef {Object} <%- toPascalCase(collection.name) %>
+<% for (const attribute of collection.attributes) { -%>
+ * @property {<%- getType(attribute) %>} <%- toCamelCase(attribute.key) %>
+<% } -%>
+ */
+
+<% } %>`;
+  }
+
+  getFileName(_) {
+    return "appwrite-types.js";
+  }
+}
+
+module.exports = { JavaScript }; 

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

@@ -89,9 +89,12 @@ const existsFiles = (...files) =>
  * @returns {string}
  */
 function detectLanguage() {
-  if (existsFiles("package.json", "tsconfig.json", "deno.json")) {
+  if (existsFiles("tsconfig.json", "deno.json")) {
     return "ts";
   }
+  if (existsFiles("package.json")) {
+    return "js";
+  }
   if (existsFiles("composer.json")) {
     return "php";
   }