velocious 1.0.101 → 1.0.102

package/package.json

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

package/src/configuration-types.js

@@ -21,9 +21,15 @@
  * @property {string} [host]
  * @property {boolean} [migrations]
  * @property {string} [password]
+ * @property {object} [record]
+ * @property {boolean} [record.transactions]
  * @property {string} [username]
  */
 
+/**
+ * @typedef {Record<string, string[]>} LocaleFallbacksType
+ */
+
 /**
  * @typedef {object} ConfigurationArgsType
  * @property {object} args
@@ -37,7 +43,7 @@
  * @property {InitializersType} initializers
  * @property {string | function() : string} locale
  * @property {string[]} locales
- * @property {object} localeFallbacks
+ * @property {LocaleFallbacksType} localeFallbacks
  * @property {string} testing
  */
 

package/src/configuration.js

@@ -162,12 +162,12 @@ export default class VelociousConfiguration {
   }
 
   /**
-   * @returns {object}
+   * @returns {import("./configuration-types.js").LocaleFallbacksType | undefined}
    */
   getLocaleFallbacks() { return this.localeFallbacks }
 
   /**
-   * @param {object} newLocaleFallbacks
+   * @param {import("./configuration-types.js").LocaleFallbacksType} newLocaleFallbacks
    * @returns {void}
    */
   setLocaleFallbacks(newLocaleFallbacks) { this.localeFallbacks = newLocaleFallbacks }

package/src/database/drivers/base.js

@@ -23,7 +23,7 @@
  * @property {string[]} [columns]
  * @property {{[key: string]: any}} [data]
  * @property {boolean} [multiple]
- * @property {boolean} [returnLastInsertedColumnNames]
+ * @property {boolean | string[]} [returnLastInsertedColumnNames]
  * @property {Array<Array<any>>} [rows]
  * @property {string} tableName
  */
@@ -189,7 +189,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @returns {object}
+   * @returns {import("../../configuration-types.js").DatabaseConfigurationType}
    */
   getArgs() {
     return this._args
@@ -227,9 +227,21 @@ export default class VelociousDatabaseDriversBase {
    */
   async getTableByName(name, args) {
     const tables = await this.getTables()
-    const table = tables.find((table) => table.getName() == name)
+    const tableNames = []
+    let table
 
-    if (!table && args?.throwError !== false) throw new Error(`Couldn't find a table by that name: ${name}`)
+    for (const candidate of tables) {
+      const candidateName = candidate.getName()
+
+      if (candidateName == name) {
+        table = candidate
+        break
+      }
+
+      tableNames.push(candidateName)
+    }
+
+    if (!table && args?.throwError !== false) throw new Error(`Couldn't find a table by that name "${name}" in: ${tableNames.join(", ")}`)
 
     return table
   }
@@ -252,6 +264,17 @@ export default class VelociousDatabaseDriversBase {
     await this.query(sql)
   }
 
+  /**
+   * @abstract
+   * @param {string} tableName
+   * @param {Array<string>} columns
+   * @param {Array<Array<string>>} rows
+   * @returns {Promise<void>}
+   */
+  async insertMultiple(tableName, columns, rows) { // eslint-disable-line no-unused-vars
+    throw new Error("'insertMultiple' not implemented")
+  }
+
   /**
    * @abstract
    * @param {InsertSqlArgsType} args

package/src/database/query/index.js

@@ -1,5 +1,11 @@
 // @ts-check
 
+/**
+ * @typedef {{[key: string]: boolean | NestedPreloadRecord }} NestedPreloadRecord
+ * @typedef {string|SelectPlain} SelectArgumentType
+ * @typedef {object|string} WhereArgumentType
+ */
+
 import FromPlain from "./from-plain.js"
 import {incorporate} from "incorporator"
 import * as inflection from "inflection"
@@ -16,10 +22,6 @@ import WhereHash from "./where-hash.js"
 import WherePlain from "./where-plain.js"
 import restArgsError from "../../utils/rest-args-error.js"
 
-/**
- * @typedef {{[key: string]: boolean | NestedPreloadRecord }} NestedPreloadRecord
- */
-
 /**
  * A generic query over some model type.
  */
@@ -112,7 +114,7 @@ export default class VelociousDatabaseQuery {
    */
   async count() {
     // Generate count SQL
-    let sql = `COUNT(${this.driver.quoteTable(this.modelClass.tableName())}.${this.driver.quoteColumn(this.modelClass.primaryKey())})`
+    let sql = `COUNT(${this.driver.quoteTable(this.getModelClass().tableName())}.${this.driver.quoteColumn(this.getModelClass().primaryKey())})`
 
     if (this.driver.getType() == "pgsql") sql += "::int"
 
@@ -162,6 +164,15 @@ export default class VelociousDatabaseQuery {
     return this._groups
   }
 
+  /**
+   * @returns {typeof import("../record/index.js").default}
+   */
+  getModelClass() {
+    if (!this.modelClass) throw new Error("modelClass not set")
+
+    return this.modelClass
+  }
+
   /**
    * @returns {import("../query-parser/options.js").default}
    */
@@ -191,13 +202,13 @@ export default class VelociousDatabaseQuery {
     /** @type {{[key: string]: number | string}} */
     const conditions = {}
 
-    conditions[this.modelClass.primaryKey()] = recordId
+    conditions[this.getModelClass().primaryKey()] = recordId
 
     const query = this.clone().where(conditions)
     const record = await query.first()
 
     if (!record) {
-      throw new RecordNotFoundError(`Couldn't find ${this.modelClass.name} with '${this.modelClass.primaryKey()}'=${recordId}`)
+      throw new RecordNotFoundError(`Couldn't find ${this.getModelClass().name} with '${this.getModelClass().primaryKey()}'=${recordId}`)
     }
 
     return record
@@ -268,7 +279,8 @@ export default class VelociousDatabaseQuery {
 
     if (record) return record
 
-    const newRecord = new this.modelClass(conditions)
+    const ModelClass = this.getModelClass()
+    const newRecord = new ModelClass(conditions)
 
     if (callback) {
       callback(newRecord)
@@ -281,14 +293,14 @@ export default class VelociousDatabaseQuery {
    * @returns {Promise<import("../record/index.js").default>}
    */
   async first() {
-    const newQuery = this.clone().limit(1).reorder(`${this.driver.quoteTable(this.modelClass.tableName())}.${this.driver.quoteColumn(this.modelClass.orderableColumn())}`)
+    const newQuery = this.clone().limit(1).reorder(`${this.driver.quoteTable(this.getModelClass().tableName())}.${this.driver.quoteColumn(this.getModelClass().orderableColumn())}`)
     const results = await newQuery.toArray()
 
     return results[0]
   }
 
   /**
-   * @param {string|FromPlain} from
+   * @param {string|import("./from-base.js").default} from
    * @returns {this}
    */
   from(from) {
@@ -327,8 +339,8 @@ export default class VelociousDatabaseQuery {
    * @returns {Promise<import("../record/index.js").default>}
    */
   async last() {
-    const primaryKey = this.modelClass.primaryKey()
-    const tableName = this.modelClass.tableName()
+    const primaryKey = this.getModelClass().primaryKey()
+    const tableName = this.getModelClass().tableName()
     const results = await this.clone().reorder(`${this.driver.quoteTable(tableName)}.${this.driver.quoteColumn(primaryKey)} DESC`).limit(1).toArray()
 
     return results[0]
@@ -353,7 +365,7 @@ export default class VelociousDatabaseQuery {
   }
 
   /**
-   * @param {*} order
+   * @param {string | number} order
    * @returns {this}
    */
   order(order) {
@@ -393,7 +405,7 @@ export default class VelociousDatabaseQuery {
   }
 
   /**
-   * @param {string} data
+   * @param {NestedPreloadRecord} data
    * @returns {this}
    */
   preload(data) {
@@ -402,7 +414,7 @@ export default class VelociousDatabaseQuery {
   }
 
   /**
-   * @param {string|OrderPlain} order
+   * @param {string | number} order
    * @returns {this}
    */
   reorder(order) {
@@ -423,7 +435,7 @@ export default class VelociousDatabaseQuery {
   }
 
   /**
-   * @param {string|SelectPlain} select
+   * @param {SelectArgumentType} select
    * @returns {this}
    */
   select(select) {
@@ -474,7 +486,8 @@ export default class VelociousDatabaseQuery {
     const results = await this.results()
 
     for (const result of results) {
-      const model = new this.modelClass()
+      const ModelClass = this.getModelClass()
+      const model = new ModelClass()
 
       model.loadExistingRecord(result)
       models.push(model)
@@ -500,7 +513,7 @@ export default class VelociousDatabaseQuery {
   toSql() { return this.driver.queryToSql(this) }
 
   /**
-   * @param {object|string} where
+   * @param {WhereArgumentType} where
    * @returns {VelociousDatabaseQuery} This query instance
    */
   where(where) {