velocious 1.0.99 → 1.0.101

package/src/database/drivers/base.js

@@ -91,7 +91,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {import("../table-data/index.js").default} _tableData
    * @returns {Promise<string[]>}
    */
@@ -100,7 +100,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   connect() {
@@ -108,7 +108,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {CreateIndexSqlArgs} indexData
    * @returns {string}
    */
@@ -129,7 +129,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {import("../table-data/index.js").default} tableData
    * @returns {string[]}
    */
@@ -148,7 +148,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {DeleteSqlArgsType} args
    * @returns {string}
    */
@@ -170,7 +170,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {string} tableName
    * @param {DropTableSqlArgsType} [args]
    * @returns {string}
@@ -180,7 +180,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {any} value
    * @returns {any}
    */
@@ -212,7 +212,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Array<import("./base-table.js").default>}
    */
   getTables() {
@@ -235,7 +235,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getType() {
@@ -253,7 +253,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {InsertSqlArgsType} args
    * @returns {string}
    */
@@ -262,7 +262,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<number>}
    */
   lastInsertID() {
@@ -282,7 +282,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {import("../query-parser/options.js").default}
    */
   options() {
@@ -361,7 +361,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {boolean}
    */
   shouldSetAutoIncrementWhenPrimaryKey() {
@@ -498,7 +498,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {string} sql
    * @returns {Promise<QueryResultType>}
    */
@@ -507,14 +507,13 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {Query} _query
    * @returns {string}
    */
   queryToSql(_query) { throw new Error("queryToSql not implemented") } // eslint-disable-line no-unused-vars
 
   /**
-   * @interface
    * @param {Error} _error
    * @returns {boolean}
    */
@@ -674,7 +673,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {UpdateSqlArgsType} args
    * @returns {string}
    */
@@ -683,7 +682,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   disableForeignKeys() {
@@ -691,7 +690,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   enableForeignKeys() {

package/src/database/drivers/mysql/column.js

@@ -83,7 +83,15 @@ export default class VelociousDatabaseDriversMysqlColumn extends BaseColumn {
 
   getType() {
     const type = digg(this, "data", "Type")
+
+    if (type.match(/^[a-z]+$/)) {
+      return type
+    }
+
     const match = type.match(/^(.+)\((\d+)\)$/)
+
+    if (!match) throw new Error(`Couldn't match column type from: ${type}`)
+
     const columnType = match[1]
 
     return columnType

package/src/database/migration/index.js

@@ -223,13 +223,15 @@ export default class VelociousDatabaseMigration {
   async columnExists(tableName, columnName) {
     const table = await this.getDriver().getTableByName(tableName)
 
-    if (!table) throw new Error(`Table ${tableName} does not exist`)
-
-    const column = await table.getColumnByName(columnName)
+    if (table) {
+      const column = await table.getColumnByName(columnName)
 
-    if (!column) throw new Error(`Column ${columnName} does not exist in table ${tableName}`)
+      if (column) {
+        return true
+      }
+    }
 
-    return Boolean(column)
+    return Boolean(false)
   }
 
   /**

package/src/database/pool/base.js

@@ -36,7 +36,7 @@ class VelociousDatabasePoolBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {import("../drivers/base.js").default} _connection
    */
   checkin(_connection) { // eslint-disable-line no-unused-vars
@@ -44,7 +44,7 @@ class VelociousDatabasePoolBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<import("../drivers/base.js").default>}
    */
   checkout() {
@@ -52,7 +52,7 @@ class VelociousDatabasePoolBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {import("../drivers/base.js").default}
    */
   getCurrentConnection() {
@@ -67,7 +67,7 @@ class VelociousDatabasePoolBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   primaryKeyType() {
@@ -119,7 +119,7 @@ class VelociousDatabasePoolBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {function(import("../drivers/base.js").default) : void} _callback
    * @returns {Promise<void>}
    */

package/src/database/query/base.js

@@ -37,7 +37,7 @@ export default class VelociousDatabaseQueryBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string[]}
    */
   toSqls() {

package/src/database/query/from-base.js

@@ -1,9 +1,7 @@
 // @ts-check
 
-import Query from "./index.js"
-
 export default class VelociousDatabaseQueryFromBase {
-  /** @type {Query | null} */
+  /** @type {import("./index.js").default  | null} */
   query = null
 
   /**
@@ -24,7 +22,7 @@ export default class VelociousDatabaseQueryFromBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string[]}
    */
   toSql() {

package/src/database/query/order-base.js

@@ -16,7 +16,7 @@ export default class VelociousDatabaseQueryOrderBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @param {boolean} _reverseOrder
    * @returns {void}
    */

package/src/database/query/select-base.js

@@ -18,7 +18,7 @@ export default class VelociousDatabaseQuerySelectBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   toSql() {

package/src/database/query/where-base.js

@@ -25,7 +25,7 @@ export default class VelociousDatabaseQueryWhereBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   toSql() {

package/src/database/record/index.js

@@ -269,7 +269,7 @@ class VelociousDatabaseRecord {
   }
 
   /**
-   * @param {Record<string, any>} attributes
+   * @param {Record<string, any>} [attributes]
    * @returns {Promise<InstanceType<typeof this>>}
    */
   static async create(attributes) {
@@ -511,6 +511,9 @@ class VelociousDatabaseRecord {
     }
   }
 
+  /**
+   * @returns {import("../drivers/base-column.js").default[]}
+   */
   static getColumns() {
     if (!this._columns) throw new Error(`${this.name} hasn't been initialized yet`)
 
@@ -763,7 +766,7 @@ class VelociousDatabaseRecord {
   }
 
   /**
-   * @returns {VelociousDatabaseRecord}
+   * @returns {typeof VelociousDatabaseRecord}
    */
   static getTranslationClass() {
     if (this._translationClass) return this._translationClass

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

@@ -42,7 +42,7 @@ export default class VelociousDatabaseRecordBaseRelationship {
   getDependent() { return this._dependent }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string} The name of the foreign key, e.g. "user_id", "post_id" etc.
    */
   getForeignKey() {
@@ -50,7 +50,7 @@ export default class VelociousDatabaseRecordBaseRelationship {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string} The name of the inverse relationship, e.g. "posts", "comments" etc.
    */
   getInverseOf() {

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

@@ -1,6 +1,6 @@
 export default class VelociousDatabaseRecordValidatorsBase {
   /**
-   * @interface
+   * @abstract
    * @template T extends import("../index.js").default
    * @param {object} args
    * @param {T} args.model

package/src/environment-handlers/base.js

@@ -72,13 +72,13 @@ export default class VelociousEnvironmentHandlerBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<CommandFileObjectType[]>}
    */
   async findCommands() { throw new Error("findCommands not implemented") }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<Array<MigrationObjectType>>}
    */
   async findMigrations() { throw new Error("findMigrations not implemneted") }
@@ -97,26 +97,26 @@ export default class VelociousEnvironmentHandlerBase {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<string>}
    */
   getVelociousPath() { throw new Error("getVelociousPath not implemented") }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<import("../routes/index.js").default>}
    */
   async importApplicationRoutes() { throw new Error("importApplicationRoutes not implemented") }
 
   /**
-   * @interface
+   * @abstract
    * @param {string[]} _testFiles
    * @returns {Promise<void>}
    */
   importTestFiles(_testFiles) { throw new Error("'importTestFiles' not implemented") } // eslint-disable-line no-unused-vars
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   importTestingConfigPath() { throw new Error(`'importTestingConfigPath' not implemented`) }
@@ -125,7 +125,7 @@ export default class VelociousEnvironmentHandlerBase {
    * @param {object} args
    * @param {string[]} args.commandParts
    * @returns {Promise<import ("../cli/base-command.js").default>}
-   * @interface
+   * @abstract
    */
   async requireCommand({commandParts}) { throw new Error("'requireCommand' not implemented") } // eslint-disable-line no-unused-vars
 

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

@@ -9,6 +9,11 @@ export default class DbGenerateModel extends BaseCommand {
 
     const modelsDir = `${process.cwd()}/src/model-bases`
     const modelClasses = this.getConfiguration().getModelClasses()
+    let devMode = false
+
+    if (modelsDir.endsWith("velocious/spec/dummy/src/model-bases")) {
+      devMode = true
+    }
 
     if (!await fileExists(modelsDir)) {
       await fs.mkdir(modelsDir, {recursive: true})
@@ -23,7 +28,13 @@ export default class DbGenerateModel extends BaseCommand {
 
       console.log(`create src/model-bases/${modelBaseFileName}`)
 
-      let fileContent = `import Record from "velocious/src/database/record/index.js"\n\n`
+      let fileContent = ""
+
+      if (devMode) {
+        fileContent += `import Record from "../../../../src/database/record/index.js"\n\n`
+      } else {
+        fileContent += `import Record from "velocious/src/database/record/index.js"\n\n`
+      }
 
       fileContent += `export default class ${modelNameCamelized}Base extends Record {\n`
 
@@ -33,15 +44,7 @@ export default class DbGenerateModel extends BaseCommand {
       for (const column of columns) {
         const camelizedColumnName = inflection.camelize(column.getName(), true)
         const camelizedColumnNameBigFirst = inflection.camelize(column.getName())
-        let jsdocType
-
-        if (column.getType() == "varchar") {
-          jsdocType = "string"
-        } else if (["bigint", "int", "integer", "smallint"].includes(column.getType())) {
-          jsdocType = "number"
-        } else if (["date", "datetime"].includes(column.getType())) {
-          jsdocType = "Date"
-        }
+        const jsdocType = this.jsDocTypeFromColumn(column)
 
         if (methodsCount > 0) {
           fileContent += "\n"
@@ -49,7 +52,7 @@ export default class DbGenerateModel extends BaseCommand {
 
         if (jsdocType) {
           fileContent += "  /**\n"
-          fileContent += `   * @returns {${jsdocType}}\n`
+          fileContent += `   * @returns {${jsdocType}${column.getNull() ? " | null" : ""}}\n`
           fileContent += "   */\n"
         }
 
@@ -57,7 +60,7 @@ export default class DbGenerateModel extends BaseCommand {
 
         if (jsdocType) {
           fileContent += "  /**\n"
-          fileContent += `   * @param {${jsdocType}} newValue\n`
+          fileContent += `   * @param {${jsdocType}${column.getNull() ? " | null" : ""}} newValue\n`
           fileContent += "   * @returns {void}\n"
           fileContent += "   */\n"
         }
@@ -72,6 +75,46 @@ export default class DbGenerateModel extends BaseCommand {
         methodsCount++
       }
 
+      if (modelClass._translations) {
+        const TranslationClass = modelClass.getTranslationClass()
+        const translationColumns = TranslationClass.getColumns()
+
+        for (const name in modelClass._translations) {
+          const nameUnderscore = inflection.underscore(name)
+          const column = translationColumns.find((translationColumn) => translationColumn.getName() === nameUnderscore)
+          let translationJsdocType
+
+          if (column) {
+            translationJsdocType = this.jsDocTypeFromColumn(column)
+          }
+
+          if (translationJsdocType) {
+            fileContent += `\n`
+            fileContent += "  /**\n"
+            fileContent += `   * @returns {${translationJsdocType}${column.getNull() ? " | null" : ""}}\n`
+            fileContent += "   */\n"
+          }
+
+          fileContent += `  ${name}() { return this._getTranslatedAttributeWithFallback("${name}", this._getConfiguration().getLocale()) }\n`
+          methodsCount++
+
+          for (const locale of this.getConfiguration().getLocales()) {
+            const localeMethodName = `${name}${inflection.camelize(locale)}`
+
+            if (translationJsdocType) {
+              fileContent += `\n`
+              fileContent += "  /**\n"
+              fileContent += `   * @returns {${translationJsdocType}${column.getNull() ? " | null" : ""}}\n`
+              fileContent += "   */\n"
+            }
+
+            fileContent += `  ${localeMethodName}() { return this._getTranslatedAttributeWithFallback("${name}", "${locale}") }\n`
+
+            methodsCount++
+          }
+        }
+      }
+
       for (const relationship of modelClass.getRelationships()) {
         let fileName, fullFilePath
 
@@ -96,32 +139,32 @@ export default class DbGenerateModel extends BaseCommand {
           }
 
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
           fileContent += `   * @returns {import("${modelFilePath}").default}\n`
           fileContent += "   */\n"
           fileContent += `  ${relationship.getRelationshipName()}() { return this.getRelationshipByName("${relationship.getRelationshipName()}").loaded() }\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
+          fileContent += "   * @abstract\n"
+          fileContent += "   * @param {Record<string, any>} attributes\n"
           fileContent += `   * @returns {import("${modelFilePath}").default}\n`
           fileContent += "   */\n"
-          fileContent += `  build${inflection.camelize(relationship.getRelationshipName())}() { throw new Error("Not implemented") }\n`
+          fileContent += `  build${inflection.camelize(relationship.getRelationshipName())}(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
+          fileContent += "   * @abstract\n"
           fileContent += "   * @returns {Promise<void>}\n"
           fileContent += "   */\n"
           fileContent += `  load${inflection.camelize(relationship.getRelationshipName())}() { throw new Error("Not implemented") }\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
+          fileContent += "   * @abstract\n"
           fileContent += `   * @param {import("${modelFilePath}").default} newModel\n`
           fileContent += `   * @returns {void}\n`
           fileContent += "   */\n"
-          fileContent += `  set${inflection.camelize(relationship.getRelationshipName())}() { throw new Error("Not implemented") }\n`
+          fileContent += `  set${inflection.camelize(relationship.getRelationshipName())}(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars\n`
         } else if (relationship.getType() == "hasMany") {
           let recordImport
 
@@ -132,32 +175,30 @@ export default class DbGenerateModel extends BaseCommand {
           }
 
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
           fileContent += `   * @returns {import("velocious/src/database/query/index.js").default<import("${recordImport}").default>}\n`
           fileContent += "   */\n"
           fileContent += `  ${relationship.getRelationshipName()}() { return this.getRelationshipByName("${relationship.getRelationshipName()}") }\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
           fileContent += `   * @returns {Array<import("${recordImport}").default>}\n`
           fileContent += "   */\n"
           fileContent += `  ${relationship.getRelationshipName()}Loaded() { return this.getRelationshipByName("${relationship.getRelationshipName()}").loaded() }\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
+          fileContent += "   * @abstract\n"
           fileContent += "   * @returns {Promise<void>}\n"
           fileContent += "   */\n"
           fileContent += `  load${inflection.camelize(relationship.getRelationshipName())}() { throw new Error("Not implemented") }\n`
 
           fileContent += "\n"
           fileContent += "  /**\n"
-          fileContent += "   * @interface\n"
+          fileContent += "   * @abstract\n"
           fileContent += `   * @param {Array<import("${recordImport}").default>} newModels\n`
-          fileContent += "   * @returns {void>}\n"
+          fileContent += "   * @returns {void}\n"
           fileContent += "   */\n"
-          fileContent += `  set${inflection.camelize(relationship.getRelationshipName())}() { throw new Error("Not implemented") }\n`
+          fileContent += `  set${inflection.camelize(relationship.getRelationshipName())}(newModels) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars\n`
         } else {
           throw new Error(`Unknown relationship type: ${relationship.getType()}`)
         }
@@ -170,4 +211,18 @@ export default class DbGenerateModel extends BaseCommand {
       await fs.writeFile(modelPath, fileContent)
     }
   }
+
+  /**
+   * @param {import("../../../../../database/drivers/base-column.js").default} column
+   * @returns {string | undefined}
+   */
+  jsDocTypeFromColumn(column) {
+    if (column.getType() == "varchar") {
+      return "string"
+    } else if (["bigint", "int", "integer", "smallint"].includes(column.getType())) {
+      return "number"
+    } else if (["date", "datetime"].includes(column.getType())) {
+      return "Date"
+    }
+  }
 }

package/src/initializer.js

@@ -24,7 +24,7 @@ export default class VelociousInitializer {
   getType() { return this._type }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   run() {

package/src/routes/base-route.js

@@ -21,7 +21,7 @@ export function initBaseRoute() {
     }
 
     /**
-     * @interface
+     * @abstract
      * @param {string} _path
      */
     matchWithPath(_path) { // eslint-disable-line no-unused-vars

package/src/testing/test.js

@@ -315,7 +315,7 @@ class Expect {
 /**
  * @param {string} description
  * @param {object|() => Promise<void>} arg1
- * @param {undefined|() => Promise<void>} arg2
+ * @param {undefined|() => Promise<void>} [arg2]
  * @returns {void}
  */
 async function describe(description, arg1, arg2) {
@@ -361,7 +361,7 @@ function expect(arg) {
 /**
  * @param {string} description
  * @param {object|() => Promise<void>} arg1
- * @param {undefined|() => Promise<void>} arg2
+ * @param {undefined|() => Promise<void>} [arg2]
  * @returns {void}
  */
 function it(description, arg1, arg2) {
@@ -386,7 +386,7 @@ function it(description, arg1, arg2) {
 /**
  * @param {string} description
  * @param {object|() => Promise<void>} arg1
- * @param {undefined|() => Promise<void>} arg2
+ * @param {undefined|() => Promise<void>} [arg2]
  * @returns {void}
  */
 function fit(description, arg1, arg2) {