velocious 1.0.94 → 1.0.95

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.94",
+  "version": "1.0.95",
   "main": "index.js",
   "scripts": {
     "lint": "eslint",

package/src/database/record/index.js

@@ -44,8 +44,7 @@ class ValidationError extends Error {
 
 class VelociousDatabaseRecord {
   /**
-   * @template T extends import("./validators/base.js").default
-   * @returns {Record<string, T>}
+   * @returns {Record<string, import("./validators/base.js").default>}
    */
   static validatorTypes() {
     if (!this._validatorTypes) this._validatorTypes = {}
@@ -55,16 +54,14 @@ class VelociousDatabaseRecord {
 
   /**
    * @param {string} name
-   * @template T extends import("./validators/base.js").default
-   * @param {T} validatorClass
+   * @param {import("./validators/base.js").default} validatorClass
    */
   static registerValidatorType(name, validatorClass) {
     this.validatorTypes()[name] = validatorClass
   }
 
   /**
-   * @template T extends import("./validators/base.js").default
-   * @returns {T}
+   * @returns {import("./validators/base.js").default}
    */
   static getValidatorType(validatorName) {
     if (!(validatorName in this.validatorTypes())) throw new Error(`Validator type ${validatorName} not found`)
@@ -189,8 +186,7 @@ class VelociousDatabaseRecord {
   }
 
   /**
-   * @template T extends import("./relationships/index.js").default
-   * @returns {T}
+   * @returns {import("./relationships/base.js").default}
    */
   static getRelationshipByName(relationshipName) {
     if (!this._relationships) this._relationships = {}
@@ -203,7 +199,7 @@ class VelociousDatabaseRecord {
   }
 
   /**
-   * @returns {Array}
+   * @returns {Array<import("./relationships/base.js").default>}
    */
   static getRelationships() {
     if (this._relationships) return Object.values(this._relationships)
@@ -269,7 +265,7 @@ class VelociousDatabaseRecord {
   }
 
   /**
-   * @param {object} attributes
+   * @param {Record<string, any>} attributes
    * @returns {Promise<InstanceType<typeof this>>}
    */
   static async create(attributes) {
@@ -1050,7 +1046,7 @@ class VelociousDatabaseRecord {
 
   /**
    * Assigns the given attributes to the record.
-   * @param {object} attributesToAssign
+   * @param {Record<string, any>} attributesToAssign
    * @returns {void}
    */
   assign(attributesToAssign) {

package/src/database/record/relationships/base.js

@@ -67,6 +67,13 @@ export default class VelociousDatabaseRecordBaseRelationship {
    */
   getRelationshipName() { return this.relationshipName }
 
+  /**
+   * @returns {boolean}
+   */
+  getPolymorphic() {
+    return this._polymorphic
+  }
+
   /**
    * @returns {string} The name of the foreign key, e.g. "id" etc.
    */
@@ -78,11 +85,12 @@ export default class VelociousDatabaseRecordBaseRelationship {
   getType() { return this.type }
 
   /**
-   * @template T extends import("../index.js").default
-   * @returns {typeof T} The target model class for this relationship, e.g. if the relationship is "posts" then the target model class is the Post class.
+   * @returns {typeof import("../index.js").default} The target model class for this relationship, e.g. if the relationship is "posts" then the target model class is the Post class.
    */
   getTargetModelClass() {
-    if (this.className) {
+    if (this.getPolymorphic()) {
+      return null
+    } else if (this.className) {
       return this.modelClass._getConfiguration().getModelClass(this.className)
     } else if (this.klass) {
       return this.klass

package/src/environment-handlers/node/cli/commands/generate/base-models.js

@@ -25,7 +25,7 @@ export default class DbGenerateModel extends BaseCommand {
 
       let fileContent = `import Record from "velocious/src/database/record/index.js"\n\n`
 
-      fileContent += `export default class ${modelNameCamelized} extends Record {\n`
+      fileContent += `export default class ${modelNameCamelized}Base extends Record {\n`
 
       const columns = await modelClass._getTable().getColumns()
       let methodsCount = 0
@@ -72,6 +72,49 @@ export default class DbGenerateModel extends BaseCommand {
         methodsCount++
       }
 
+      for (const relationship of modelClass.getRelationships()) {
+        let fileName, fullFilePath
+
+        if (relationship.getPolymorphic()) {
+          fileName = "velocious/src/database/record/index.js"
+        } else {
+          fileName = inflection.dasherize(inflection.underscore(relationship.getTargetModelClass().name))
+          fullFilePath = `src/models/${fileName}.js`
+        }
+
+        if (methodsCount > 0) {
+          fileContent += "\n"
+        }
+
+        if (relationship.getType() == "belongsTo" || relationship.getType() == "hasOne") {
+          fileContent += "  /**\n"
+
+          if (fullFilePath && await fileExists(fullFilePath)) {
+            fileContent += `   * @returns {import("../models/${fileName}.js").default}\n`
+          } else {
+            fileContent += `   * @returns {import("velocious/src/database/record/index.js").default}\n`
+          }
+
+          fileContent += "   */\n"
+          fileContent += `  ${relationship.getRelationshipName()}() { return this.getRelationshipByName("${relationship.getRelationshipName()}").loaded() }\n`
+        } else if (relationship.getType() == "hasMany") {
+          fileContent += "  /**\n"
+
+          if (fullFilePath && await fileExists(fullFilePath)) {
+            fileContent += `   * @returns {Array<import("../models/${fileName}.js").default>}\n`
+          } else {
+            fileContent += `   * @returns {Array<import("velocious/src/database/record/index.js").default>}\n`
+          }
+
+          fileContent += "   */\n"
+          fileContent += `  ${relationship.getRelationshipName()}() { return this.getRelationshipByName("${relationship.getRelationshipName()}").loaded() }\n`
+        } else {
+          throw new Error(`Unknown relationship type: ${relationship.getType()}`)
+        }
+
+        methodsCount++
+      }
+
       fileContent += "}\n"
 
       await fs.writeFile(modelPath, fileContent)