velocious 1.0.101 → 1.0.103

package/package.json

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

package/spec/database/drivers/create-sql/create-index-sql-spec.js

@@ -0,0 +1,24 @@
+// @ts-check
+
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
+
+describe("database - create sql - create index sql", () => {
+  it("runs migrations", {databaseCleaning: {transaction: false}}, async () => {
+    await dummyConfiguration.ensureConnections(async (dbs) => {
+      const createIndexSQLs = await dbs.default.createIndexSQLs({
+        columns: ["id", "created_at"],
+        tableName: "projects"
+      })
+
+      if (dbs.default.getType() == "sqlite") {
+        expect(createIndexSQLs).toEqual("CREATE INDEX `index_on_projects_id_and_created_at` ON `projects` (`id`, `created_at`)")
+      } else if (dbs.default.getType() == "mssql") {
+        expect(createIndexSQLs).toEqual("CREATE INDEX [index_on_id_and_created_at] ON [projects] ([id], [created_at])")
+      } else if (dbs.default.getType() == "pgsql") {
+        expect(createIndexSQLs).toEqual(`CREATE INDEX "index_on_id_and_created_at" ON "projects" ("id", "created_at")`)
+      } else {
+        expect(createIndexSQLs).toEqual("CREATE INDEX `index_on_id_and_created_at` ON `projects` (`id`, `created_at`)")
+      }
+    })
+  })
+})

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-column.js

@@ -46,7 +46,7 @@ export default class VelociousDatabaseDriversBaseColumn {
 
     tableData.addColumn(column)
 
-    const sqls = await this.getDriver().alterTableSql(tableData)
+    const sqls = await this.getDriver().alterTableSQLs(tableData)
 
     for (const sql of sqls) {
       await this.getDriver().query(sql)
@@ -70,7 +70,7 @@ export default class VelociousDatabaseDriversBaseColumn {
 
   /**
    * @abstract
-   * @returns {number}
+   * @returns {number | undefined}
    */
   getMaxLength() {
     throw new Error("getMaxLength not implemented")

package/src/database/drivers/base-columns-index.js

@@ -12,6 +12,12 @@ export default class VelociousDatabaseDriversBaseColumnsIndex {
     this.table = table
   }
 
+  /**
+   * @abstract
+   * @returns {string[]}
+   */
+  getColumnNames() { throw new Error("'getColumnNames' not implemented") }
+
   /**
    * @returns {import("./base.js").default}
    */

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 {string[]} [returnLastInsertedColumnNames]
  * @property {Array<Array<any>>} [rows]
  * @property {string} tableName
  */
@@ -31,6 +31,12 @@
  * @typedef {Record<string, any>} QueryRowType
  * @typedef {Array<QueryRowType>} QueryResultType
  */
+/**
+ * @typedef {object}UpdateSqlArgsType
+ * @property {object} conditions
+ * @property {object} data
+ * @property {string} tableName
+ */
 
 import {Logger} from "../../logger.js"
 import Query from "../query/index.js"
@@ -83,7 +89,7 @@ export default class VelociousDatabaseDriversBase {
 
     tableData.addForeignKey(tableForeignKey)
 
-    const alterTableSQLs = await this.alterTableSql(tableData)
+    const alterTableSQLs = await this.alterTableSQLs(tableData)
 
     for (const alterTableSQL of alterTableSQLs) {
       await this.query(alterTableSQL)
@@ -95,8 +101,8 @@ export default class VelociousDatabaseDriversBase {
    * @param {import("../table-data/index.js").default} _tableData
    * @returns {Promise<string[]>}
    */
-  alterTableSql(_tableData) { // eslint-disable-line no-unused-vars
-    throw new Error("alterTableSql not implemented")
+  alterTableSQLs(_tableData) { // eslint-disable-line no-unused-vars
+    throw new Error("alterTableSQLs not implemented")
   }
 
   /**
@@ -107,13 +113,22 @@ export default class VelociousDatabaseDriversBase {
     throw new Error("'connect' not implemented")
   }
 
+  /**
+   * @abstract
+   * @param {string} databaseName
+   * @param {object} [args]
+   * @param {boolean} [args.ifNotExists]
+   * @returns {string[]}
+   */
+  createDatabaseSql(databaseName, args) { throw new Error("'createDatabaseSql' not implemented") } // eslint-disable-line no-unused-vars
+
   /**
    * @abstract
    * @param {CreateIndexSqlArgs} indexData
-   * @returns {string}
+   * @returns {string[]}
    */
-  createIndexSql(indexData) { // eslint-disable-line no-unused-vars
-    throw new Error("'createIndexSql' not implemented")
+  createIndexSQLs(indexData) { // eslint-disable-line no-unused-vars
+    throw new Error("'createIndexSQLs' not implemented")
   }
 
   /**
@@ -162,7 +177,7 @@ export default class VelociousDatabaseDriversBase {
    * @returns {Promise<void>}
    */
   async dropTable(tableName, args) {
-    const sqls = this.dropTableSql(tableName, args)
+    const sqls = this.dropTableSQLs(tableName, args)
 
     for (const sql of sqls) {
       await this.query(sql)
@@ -173,10 +188,10 @@ export default class VelociousDatabaseDriversBase {
    * @abstract
    * @param {string} tableName
    * @param {DropTableSqlArgsType} [args]
-   * @returns {string}
+   * @returns {string[]}
    */
-  dropTableSql(tableName, args) { // eslint-disable-line no-unused-vars
-    throw new Error("dropTableSql not implemented")
+  dropTableSQLs(tableName, args) { // eslint-disable-line no-unused-vars
+    throw new Error("dropTableSQLs not implemented")
   }
 
   /**
@@ -189,7 +204,7 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @returns {object}
+   * @returns {import("../../configuration-types.js").DatabaseConfigurationType}
    */
   getArgs() {
     return this._args
@@ -213,7 +228,7 @@ export default class VelociousDatabaseDriversBase {
 
   /**
    * @abstract
-   * @returns {Array<import("./base-table.js").default>}
+   * @returns {Promise<Array<import("./base-table.js").default>>}
    */
   getTables() {
     throw new Error(`${this.constructor.name}#getTables not implemented`)
@@ -227,9 +242,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
+
+    for (const candidate of tables) {
+      const candidateName = candidate.getName()
+
+      if (candidateName == name) {
+        table = candidate
+        break
+      }
 
-    if (!table && args?.throwError !== false) throw new Error(`Couldn't find a table by that name: ${name}`)
+      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 +279,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
@@ -368,6 +406,12 @@ export default class VelociousDatabaseDriversBase {
     throw new Error(`'shouldSetAutoIncrementWhenPrimaryKey' not implemented`)
   }
 
+  /**
+   * @abstract
+   * @returns {boolean}
+   */
+  supportsInsertIntoReturning() { return false }
+
   /**
    * @param {string} tableName
    * @returns {Promise<boolean>}
@@ -578,7 +622,7 @@ export default class VelociousDatabaseDriversBase {
 
     tableData.addColumn(tableColumn)
 
-    const alterTableSQLs = await this.alterTableSql(tableData)
+    const alterTableSQLs = await this.alterTableSQLs(tableData)
 
     for (const alterTableSQL of alterTableSQLs) {
       await this.query(alterTableSQL)
@@ -656,12 +700,6 @@ export default class VelociousDatabaseDriversBase {
     })
   }
 
-  /**
-   * @typedef {object}UpdateSqlArgsType
-   * @property {object} conditions
-   * @property {object} data
-   * @property {string} tableName
-   */
   /**
    * @param {UpdateSqlArgsType} args
    * @returns {Promise<void>}

package/src/database/drivers/mssql/index.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import AlterTable from "./sql/alter-table.js"
 import Base from "../base.js"
 import CreateDatabase from "./sql/create-database.js"
@@ -24,27 +26,36 @@ export default class VelociousDatabaseDriversMssql extends Base{
       this.connection = new mssql.ConnectionPool(sqlConfig)
       await this.connection.connect()
     } catch (error) {
-      throw new Error(`Couldn't connect to database: ${error.message}`) // Re-throw to fix unuseable stack trace.
+      // Re-throw to fix unuseable stack trace.
+      if (error instanceof Error) {
+        throw new Error(`Couldn't connect to database: ${error.message}`)
+      } else {
+        throw new Error(`Couldn't connect to database: ${error}`)
+      }
     }
   }
 
   async close() {
-    await this.connection.close()
+    await this.connection?.close()
     this.connection = undefined
   }
 
   /**
-   * @returns {string}
+   * @param {import("../../table-data/index.js").default} tableData
+   * @returns {Promise<string[]>}
    */
-  async alterTableSql(tableData) {
+  async alterTableSQLs(tableData) {
     const alterArgs = {tableData, driver: this}
     const alterTable = new AlterTable(alterArgs)
 
-    return await alterTable.toSqls()
+    return await alterTable.toSQLs()
   }
 
   /**
-   * @returns {string}
+   * @param {string} databaseName
+   * @param {object} [args]
+   * @param {boolean} [args.ifNotExists]
+   * @returns {string[]}
    */
   createDatabaseSql(databaseName, args) {
     const createArgs = Object.assign({databaseName, driver: this}, args)
@@ -54,17 +65,19 @@ export default class VelociousDatabaseDriversMssql extends Base{
   }
 
   /**
-   * @returns {string}
+   * @param {import("../base.js").CreateIndexSqlArgs} indexData
+   * @returns {string[]}
    */
-  createIndexSql(indexData) {
+  createIndexSQLs(indexData) {
     const createArgs = Object.assign({driver: this}, indexData)
     const createIndex = new CreateIndex(createArgs)
 
-    return createIndex.toSql()
+    return createIndex.toSQLs()
   }
 
   /**
-   * @returns {string}
+   * @param {import("../../table-data/index.js").default} tableData
+   * @returns {string[]}
    */
   createTableSql(tableData) {
     const createArgs = {tableData, driver: this, indexInCreateTable: false}
@@ -91,13 +104,15 @@ export default class VelociousDatabaseDriversMssql extends Base{
   }
 
   /**
-   * @returns {string}
+   * @param {string} tableName
+   * @param {import("../base.js").DropTableSqlArgsType} [args]
+   * @returns {string[]}
    */
-  dropTableSql(tableName, args = {}) {
+  dropTableSQLs(tableName, args = {}) {
     const dropArgs = Object.assign({tableName, driver: this}, args)
     const dropTable = new DropTable(dropArgs)
 
-    return dropTable.toSql()
+    return dropTable.toSQLs()
   }
 
   /**
@@ -110,8 +125,13 @@ export default class VelociousDatabaseDriversMssql extends Base{
    */
   primaryKeyType() { return "bigint" }
 
+  /**
+   * @param {string} sql
+   * @returns {Promise<import("../base.js").QueryResultType>}
+   */
   async _queryActual(sql) {
-    let result, request, tries = 0
+    let result
+    let request, tries = 0
 
     if (this._currentTransaction) {
       request = new mssql.Request(this._currentTransaction)
@@ -126,21 +146,25 @@ export default class VelociousDatabaseDriversMssql extends Base{
         result = await request.query(sql)
         break
       } catch (error) {
-        if (error.message == "No connection is specified for that request." && tries <= 3) {
+        if (error instanceof Error && error.message == "No connection is specified for that request." && tries <= 3) {
           this.logger.log("Reconnecting to database")
           await this.connect()
           // Retry
-        } else {
+        } else if (error instanceof Error) {
           // Re-throw error because the stack-trace is broken and can't be used for app-development.
           throw new Error(`Query failed '${error.message}': ${sql}`)
+        } else {
+          throw new Error(`Query failed '${error}': ${sql}`)
         }
       }
     }
 
+    // @ts-expect-error
     return result.recordsets[0]
   }
 
   /**
+   * @param {import("../../query/index.js").default} query
    * @returns {string}
    */
   queryToSql(query) { return new QueryParser({query}).toSql() }
@@ -158,7 +182,7 @@ export default class VelociousDatabaseDriversMssql extends Base{
 
     if (type != "string") value = `${value}`
 
-    const resultWithQuotes = escapeString(value)
+    const resultWithQuotes = escapeString(value, null)
     const result = resultWithQuotes.substring(1, resultWithQuotes.length - 1)
 
     return result
@@ -176,7 +200,7 @@ export default class VelociousDatabaseDriversMssql extends Base{
     if (type == "number") return value
     if (type != "string") value = `${value}`
 
-    return escapeString(value)
+    return escapeString(value, null)
   }
 
   /**
@@ -211,7 +235,9 @@ export default class VelociousDatabaseDriversMssql extends Base{
   }
 
   /**
-   * @returns {string} SQL statement
+   * @abstract
+   * @param {import("../base.js").InsertSqlArgsType} args
+   * @returns {string}
    */
   insertSql(args) {
     const insertArgs = Object.assign({driver: this}, args)
@@ -220,6 +246,9 @@ export default class VelociousDatabaseDriversMssql extends Base{
     return insert.toSql()
   }
 
+  /**
+   * @returns {Promise<Array<import("../base-table.js").default>>}
+   */
   async getTables() {
     const result = await this.query(`SELECT [TABLE_NAME] FROM [INFORMATION_SCHEMA].[TABLES] WHERE [TABLE_CATALOG] = DB_NAME() AND [TABLE_SCHEMA] = 'dbo'`)
     const tables = []
@@ -233,14 +262,20 @@ export default class VelociousDatabaseDriversMssql extends Base{
     return tables
   }
 
-  async getTableByName(tableName, args) {
-    const result = await this.query(`SELECT [TABLE_NAME] FROM [INFORMATION_SCHEMA].[TABLES] WHERE [TABLE_CATALOG] = DB_NAME() AND [TABLE_SCHEMA] = 'dbo' AND [TABLE_NAME] = ${this.quote(tableName)}`)
+  /**
+   * @param {string} name
+   * @param {object} [args]
+   * @param {boolean} args.throwError
+   * @returns {Promise<import("../base-table.js").default | undefined>}
+   */
+  async getTableByName(name, args) {
+    const result = await this.query(`SELECT [TABLE_NAME] FROM [INFORMATION_SCHEMA].[TABLES] WHERE [TABLE_CATALOG] = DB_NAME() AND [TABLE_SCHEMA] = 'dbo' AND [TABLE_NAME] = ${this.quote(name)}`)
 
     if (result[0]) {
       return new Table(this, result[0])
     }
 
-    if (args?.throwError !== false) throw new Error(`Couldn't find a table by that name: ${tableName}`)
+    if (args?.throwError !== false) throw new Error(`Couldn't find a table by that name: ${name}`)
   }
 
   async lastInsertID() {
@@ -282,14 +317,26 @@ export default class VelociousDatabaseDriversMssql extends Base{
     this._currentTransaction = null
   }
 
+  /**
+   * @param {string} savePointName
+   * @returns {Promise<void>}
+   */
   async _startSavePointAction(savePointName) {
     await this.query(`SAVE TRANSACTION [${savePointName}]`)
   }
 
+  /**
+   * @param {string} savePointName
+   * @returns {Promise<void>}
+   */
   async _releaseSavePointAction(savePointName) { // eslint-disable-line no-unused-vars
     // Do nothing in MS-SQL.
   }
 
+  /**
+   * @param {string} savePointName
+   * @returns {Promise<void>}
+   */
   async _rollbackSavePointAction(savePointName) {
     await this.query(`ROLLBACK TRANSACTION [${savePointName}]`)
   }
@@ -299,6 +346,7 @@ export default class VelociousDatabaseDriversMssql extends Base{
   }
 
   /**
+   * @param {import("../base.js").UpdateSqlArgsType} args
    * @returns {string}
    */
   updateSql({conditions, data, tableName}) {

package/src/database/drivers/mssql/sql/create-database.js

@@ -1,9 +1,16 @@
+// @ts-check
+
 import CreateDatabaseBase from "../../../query/create-database-base.js"
 
 export default class VelociousDatabaseConnectionDriversMssqlSqlCreateDatabase extends CreateDatabaseBase {
+  /**
+   * @param {object} args
+   * @param {import("../../base.js").default} args.driver
+   * @param {string} args.databaseName
+   * @param {boolean} [args.ifNotExists]
+   */
   constructor({driver, databaseName, ifNotExists}) {
-    super({driver})
-    this.databaseName = databaseName
+    super({databaseName, driver})
     this.ifNotExists = ifNotExists
   }
 

package/src/database/drivers/mssql/table.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import BaseTable from "../base-table.js"
 import Column from "./column.js"
 import ColumnsIndex from "./columns-index.js"
@@ -5,6 +7,10 @@ import {digg} from "diggerize"
 import ForeignKey from "./foreign-key.js"
 
 export default class VelociousDatabaseDriversMssqlTable extends BaseTable {
+  /**
+   * @param {import("../base.js").default} driver
+   * @param {Record<string, any>} data
+   */
   constructor(driver, data) {
     super()
     this.data = data
@@ -107,13 +113,17 @@ export default class VelociousDatabaseDriversMssqlTable extends BaseTable {
     return digg(this.data, "TABLE_NAME")
   }
 
-  async truncate() {
+  /**
+   * @param {{cascade: boolean}} [args]
+   * @returns {Promise<Array<Record<string, any>>>}
+   */
+  async truncate(args) { // eslint-disable-line no-unused-vars
     try {
-      await this.getDriver().query(`TRUNCATE TABLE ${this.getOptions().quoteTableName(this.getName())}`)
+      return await this.getDriver().query(`TRUNCATE TABLE ${this.getOptions().quoteTableName(this.getName())}`)
     } catch (error) {
-      if (error.message.startsWith("Query failed 'Cannot truncate table")) {
+      if (error instanceof Error && error.message.startsWith("Query failed 'Cannot truncate table")) {
         // Truncate table is really buggy for some reason - fall back to delete all rows instead
-        await this.getDriver().query(`DELETE FROM ${this.getOptions().quoteTableName(this.getName())}`)
+        return await this.getDriver().query(`DELETE FROM ${this.getOptions().quoteTableName(this.getName())}`)
       } else {
         throw error
       }

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

@@ -1,8 +1,14 @@
+// @ts-check
+
 import BaseColumn from "../base-column.js"
 import ColumnsIndex from "./columns-index.js"
 import {digg} from "diggerize"
 
 export default class VelociousDatabaseDriversMysqlColumn extends BaseColumn {
+  /**
+   * @param {import("../base-table.js").default} table
+   * @param {Record<string, any>} data
+   */
   constructor(table, data) {
     super()
     this.data = data

package/src/database/drivers/mysql/columns-index.js

@@ -1,9 +1,6 @@
+// @ts-check
+
 import BaseColumnsIndex from "../base-columns-index.js"
 
-export default class VelociousDatabaseDriversMysqlColumn extends BaseColumnsIndex {
-  constructor(table, data) {
-    super()
-    this.data = data
-    this.table = table
-  }
+export default class VelociousDatabaseDriversMysqlColumnsIndex extends BaseColumnsIndex {
 }

package/src/database/drivers/mysql/foreign-key.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import BaseForeignKey from "../base-foreign-key.js"
 import {digg} from "diggerize"