velocious 1.0.106 → 1.0.107

package/src/cli/commands/db/create.js

@@ -59,7 +59,7 @@ export default class DbCreate extends BaseCommand{
 
     schemaMigrationsTable.string("version", {null: false, primaryKey: true})
 
-    const createSchemaMigrationsTableSqls = this.databaseConnection.createTableSql(schemaMigrationsTable)
+    const createSchemaMigrationsTableSqls = await this.databaseConnection.createTableSql(schemaMigrationsTable)
 
     for (const createSchemaMigrationsTableSql of createSchemaMigrationsTableSqls) {
       if (this.args.testing) {

package/src/cli/use-browser-cli.js

@@ -1,4 +1,6 @@
+// @ts-expect-error
 import React from "react"
+
 import BrowserCli from "./browser-cli.js"
 import restArgsError from "../utils/rest-args-error.js"
 

package/src/configuration-types.js

@@ -20,6 +20,9 @@
 
 /**
  * @typedef {object} DatabaseConfigurationType
+ * @property {string} [database]
+ * @property {typeof import("./database/drivers/base.js").default} [driver]
+ * @property {typeof import("./database/pool/base.js").default} [poolType]
  * @property {function() : void} [getConnection]
  * @property {string} [host]
  * @property {boolean} [migrations]
@@ -29,6 +32,9 @@
  * @property {object} [record]
  * @property {boolean} [record.transactions]
  * @property {boolean} [reset]
+ * @property {object} [sqlConfig]
+ * @property {string} [type]
+ * @property {string} [useDatabase]
  * @property {string} [username]
  */
 
@@ -38,19 +44,18 @@
 
 /**
  * @typedef {object} ConfigurationArgsType
- * @property {object} args
  * @property {CorsType} [cors]
- * @property {{[key: string]: DatabaseConfigurationType}} database
- * @property {boolean} debug
+ * @property {{[key: string]: {[key: string]: DatabaseConfigurationType}}} database
+ * @property {boolean} [debug]
  * @property {string} directory
- * @property {string} environment
+ * @property {string} [environment]
  * @property {import("./environment-handlers/base.js").default} environmentHandler
  * @property {function({configuration: import("./configuration.js").default, type: string}) : void} initializeModels
- * @property {InitializersType} initializers
+ * @property {InitializersType} [initializers]
  * @property {string | function() : string} locale
  * @property {string[]} locales
  * @property {LocaleFallbacksType} localeFallbacks
- * @property {string} testing
+ * @property {string} [testing]
  */
 
 export const nothing = {}

package/src/controller.js

@@ -84,7 +84,6 @@ export default class VelociousController {
 
       if (beforeActions) {
         for (const beforeActionName of beforeActions) {
-          // @ts-expect-error
           const beforeAction = currentControllerClass.prototype[beforeActionName]
 
           if (!beforeAction) throw new Error(`No such before action: ${beforeActionName}`)
@@ -111,7 +110,7 @@ export default class VelociousController {
   /**
    * @param {object} [args]
    * @param {object} [args.json]
-   * @param {number} [args.status]
+   * @param {number | string} [args.status]
    * @returns {Promise<void>}
    */
   async render({json, status, ...restArgs} = {}) {

package/src/database/drivers/base.js

@@ -54,7 +54,7 @@ export default class VelociousDatabaseDriversBase {
   idSeq = undefined
 
   /**
-   * @param {object} config
+   * @param {import("../../configuration-types.js").DatabaseConfigurationType} config
    * @param {import("../../configuration.js").default} configuration
    */
   constructor(config, configuration) {
@@ -125,9 +125,9 @@ export default class VelociousDatabaseDriversBase {
   /**
    * @abstract
    * @param {CreateIndexSqlArgs} indexData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createIndexSQLs(indexData) { // eslint-disable-line no-unused-vars
+  async createIndexSQLs(indexData) { // eslint-disable-line no-unused-vars
     throw new Error("'createIndexSQLs' not implemented")
   }
 
@@ -136,7 +136,7 @@ export default class VelociousDatabaseDriversBase {
    * @returns {Promise<void>}
    */
   async createTable(tableData) {
-    const sqls = this.createTableSql(tableData)
+    const sqls = await this.createTableSql(tableData)
 
     for (const sql of sqls) {
       await this.query(sql)
@@ -146,9 +146,9 @@ export default class VelociousDatabaseDriversBase {
   /**
    * @abstract
    * @param {import("../table-data/index.js").default} tableData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createTableSql(tableData) { // eslint-disable-line no-unused-vars
+  async createTableSql(tableData) { // eslint-disable-line no-unused-vars
     throw new Error("'createTableSql' not implemented")
   }
 
@@ -177,7 +177,7 @@ export default class VelociousDatabaseDriversBase {
    * @returns {Promise<void>}
    */
   async dropTable(tableName, args) {
-    const sqls = this.dropTableSQLs(tableName, args)
+    const sqls = await this.dropTableSQLs(tableName, args)
 
     for (const sql of sqls) {
       await this.query(sql)
@@ -188,9 +188,9 @@ export default class VelociousDatabaseDriversBase {
    * @abstract
    * @param {string} tableName
    * @param {DropTableSqlArgsType} [args]
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  dropTableSQLs(tableName, args) { // eslint-disable-line no-unused-vars
+  async dropTableSQLs(tableName, args) { // eslint-disable-line no-unused-vars
     throw new Error("dropTableSQLs not implemented")
   }
 

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

@@ -66,24 +66,24 @@ export default class VelociousDatabaseDriversMssql extends Base{
 
   /**
    * @param {import("../base.js").CreateIndexSqlArgs} indexData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createIndexSQLs(indexData) {
+  async createIndexSQLs(indexData) {
     const createArgs = Object.assign({driver: this}, indexData)
     const createIndex = new CreateIndex(createArgs)
 
-    return createIndex.toSQLs()
+    return await createIndex.toSQLs()
   }
 
   /**
    * @param {import("../../table-data/index.js").default} tableData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createTableSql(tableData) {
+  async createTableSql(tableData) {
     const createArgs = {tableData, driver: this, indexInCreateTable: false}
     const createTable = new CreateTable(createArgs)
 
-    return createTable.toSql()
+    return await createTable.toSql()
   }
 
   /**
@@ -106,13 +106,13 @@ export default class VelociousDatabaseDriversMssql extends Base{
   /**
    * @param {string} tableName
    * @param {import("../base.js").DropTableSqlArgsType} [args]
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  dropTableSQLs(tableName, args = {}) {
+  async dropTableSQLs(tableName, args = {}) {
     const dropArgs = Object.assign({tableName, driver: this}, args)
     const dropTable = new DropTable(dropArgs)
 
-    return dropTable.toSQLs()
+    return await dropTable.toSQLs()
   }
 
   /**
@@ -159,7 +159,6 @@ export default class VelociousDatabaseDriversMssql extends Base{
       }
     }
 
-    // @ts-expect-error
     return result.recordsets[0]
   }
 
@@ -210,7 +209,7 @@ export default class VelociousDatabaseDriversMssql extends Base{
   quoteColumn(string) { return this.options().quoteColumnName(string) }
 
   /**
-   * @param {string|number} string
+   * @param {string} string
    * @returns {string}
    */
   quoteTable(string) { return this.options().quoteTableName(string) }
@@ -287,6 +286,7 @@ export default class VelociousDatabaseDriversMssql extends Base{
     return lastInsertID
   }
 
+  /** @returns {Options} */
   options() {
     if (!this._options) this._options = new Options({driver: this})
 

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

@@ -4,13 +4,17 @@ import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversMssqlOptions extends QueryParserOptions {
   /**
-   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   * @param {object} args
+   * @param {import("../base.js").default} args.driver
    */
-  constructor(options) {
-    options.columnQuote = "\""
-    options.indexQuote = "\""
-    options.stringQuote = "'"
-    options.tableQuote = "\""
+  constructor({driver}) {
+    const options = {
+      driver,
+      columnQuote: "\"",
+      indexQuote: "\"",
+      stringQuote: "'",
+      tableQuote: "\""
+    }
 
     super(options)
   }

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

@@ -83,20 +83,20 @@ export default class VelociousDatabaseDriversMysql extends Base{
 
   /**
    * @param {import("../base.js").CreateIndexSqlArgs} indexData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createIndexSQLs(indexData) {
+  async createIndexSQLs(indexData) {
     const createArgs = Object.assign({driver: this}, indexData)
     const createIndex = new CreateIndex(createArgs)
 
-    return createIndex.toSQLs()
+    return await createIndex.toSQLs()
   }
 
   /**
    * @param {import("../../table-data/index.js").default} tableData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createTableSql(tableData) {
+  async createTableSql(tableData) {
     const createArgs = {tableData, driver: this}
     const createTable = new CreateTable(createArgs)
 
@@ -129,13 +129,13 @@ export default class VelociousDatabaseDriversMysql extends Base{
   /**
    * @param {string} tableName
    * @param {import("../base.js").DropTableSqlArgsType} [args]
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  dropTableSQLs(tableName, args = {}) {
+  async dropTableSQLs(tableName, args = {}) {
     const dropArgs = Object.assign({tableName, driver: this}, args)
     const dropTable = new DropTable(dropArgs)
 
-    return dropTable.toSQLs()
+    return await dropTable.toSQLs()
   }
 
   /**

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

@@ -4,13 +4,17 @@ import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversMysqlOptions extends QueryParserOptions {
   /**
-   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   * @param {object} args
+   * @param {import("../base.js").default} args.driver
    */
-  constructor(options) {
-    options.columnQuote = "`"
-    options.indexQuote = "`"
-    options.stringQuote = "'"
-    options.tableQuote = "`"
+  constructor({driver}) {
+    const options = {
+      driver,
+      columnQuote: "`",
+      indexQuote: "`",
+      stringQuote: "'",
+      tableQuote: "`"
+    }
 
     super(options)
   }

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

@@ -84,24 +84,24 @@ export default class VelociousDatabaseDriversPgsql extends Base{
 
   /**
    * @param {import("../base.js").CreateIndexSqlArgs} indexData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createIndexSQLs(indexData) {
+  async createIndexSQLs(indexData) {
     const createArgs = Object.assign({driver: this}, indexData)
     const createIndex = new CreateIndex(createArgs)
 
-    return createIndex.toSQLs()
+    return await createIndex.toSQLs()
   }
 
   /**
    * @param {import("../../table-data/index.js").default} tableData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createTableSql(tableData) {
+  async createTableSql(tableData) {
     const createArgs = {tableData, driver: this, indexInCreateTable: false}
     const createTable = new CreateTable(createArgs)
 
-    return createTable.toSql()
+    return await createTable.toSql()
   }
 
   async currentDatabase() {
@@ -121,13 +121,13 @@ export default class VelociousDatabaseDriversPgsql extends Base{
   /**
    * @param {string} tableName
    * @param {import("../base.js").DropTableSqlArgsType} [args]
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  dropTableSQLs(tableName, args = {}) {
+  async dropTableSQLs(tableName, args = {}) {
     const dropArgs = Object.assign({tableName, driver: this}, args)
     const dropTable = new DropTable(dropArgs)
 
-    return dropTable.toSQLs()
+    return await dropTable.toSQLs()
   }
 
   getType() { return "pgsql" }
@@ -228,7 +228,7 @@ export default class VelociousDatabaseDriversPgsql extends Base{
   }
 
   options() {
-    if (!this._options) this._options = new Options({driver: this})
+    if (!this._options) this._options = new Options(this)
 
     return this._options
   }

package/src/database/drivers/pgsql/options.js

@@ -4,13 +4,16 @@ import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversPgsqlOptions extends QueryParserOptions {
   /**
-   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   * @param {import("../base.js").default} driver
    */
-  constructor(options) {
-    options.columnQuote = "\""
-    options.indexQuote = "\""
-    options.stringQuote = "'"
-    options.tableQuote = "\""
+  constructor(driver) {
+    const options = {
+      driver,
+      columnQuote: "\"",
+      indexQuote: "\"",
+      stringQuote: "'",
+      tableQuote: "\""
+    }
 
     super(options)
   }

package/src/database/drivers/sqlite/base.js

@@ -29,25 +29,25 @@ export default class VelociousDatabaseDriversSqliteBase extends Base {
 
   /**
    * @param {import("../base.js").CreateIndexSqlArgs} indexData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createIndexSQLs(indexData) {
+  async createIndexSQLs(indexData) {
     const createArgs = Object.assign({driver: this}, indexData)
     const createIndex = new CreateIndex(createArgs)
 
-    return createIndex.toSQLs()
+    return await createIndex.toSQLs()
   }
 
   /**
    * @abstract
    * @param {import("../../table-data/index.js").default} tableData
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  createTableSql(tableData) {
+  async createTableSql(tableData) {
     const createArgs = {tableData, driver: this, indexInCreateTable: false}
     const createTable = new CreateTable(createArgs)
 
-    return createTable.toSql()
+    return await createTable.toSql()
   }
 
   currentDatabase() {
@@ -65,14 +65,14 @@ export default class VelociousDatabaseDriversSqliteBase extends Base {
   /**
    * @param {string} tableName
    * @param {import("../base.js").DropTableSqlArgsType} [args]
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
-  dropTableSQLs(tableName, args = {}) {
+  async dropTableSQLs(tableName, args = {}) {
     const driver = /** @type {import("../base.js").default} */ (this)
     const dropArgs = Object.assign({tableName, driver}, args)
     const dropTable = new DropTable(dropArgs)
 
-    return dropTable.toSQLs()
+    return await dropTable.toSQLs()
   }
 
   /**
@@ -217,7 +217,7 @@ export default class VelociousDatabaseDriversSqliteBase extends Base {
   }
 
   options() {
-    if (!this._options) this._options = new Options({driver: this})
+    if (!this._options) this._options = new Options(this)
 
     return this._options
   }

package/src/database/drivers/sqlite/connection-sql-js.js

@@ -1,6 +1,8 @@
 // @ts-check
 
 import debounce from "debounce"
+
+// @ts-expect-error
 import query from "./query"
 
 export default class VelociousDatabaseDriversSqliteConnectionSqlJs {

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

@@ -8,6 +8,9 @@ import {open} from "sqlite"
 import Base from "./base.js"
 
 export default class VelociousDatabaseDriversSqliteNode extends Base {
+  /** @type {import("sqlite3").Database | undefined} */
+  connection = undefined
+
   async connect() {
     const args = this.getArgs()
     const databasePath = `${this.getConfiguration().getDirectory()}/db/${this.localStorageName()}.sqlite`
@@ -16,10 +19,11 @@ export default class VelociousDatabaseDriversSqliteNode extends Base {
       await fs.unlink(databasePath)
     }
 
-    this.connection = await open({
+    // @ts-expect-error
+    this.connection = /** @type {import("sqlite3").Database} */ (await open({
       filename: databasePath,
       driver: sqlite3.Database
-    })
+    }))
     await this.registerVersion()
   }
 
@@ -41,6 +45,8 @@ export default class VelociousDatabaseDriversSqliteNode extends Base {
    * @returns {Promise<Record<string, any>[]>}
    */
   async _queryActual(sql) {
+    if (!this.connection) throw new Error("No connection")
+
     return await query(this.connection, sql)
   }
 }

package/src/database/drivers/sqlite/index.native.js

@@ -1,9 +1,13 @@
 import {digg} from "diggerize"
 import envSense from "env-sense/src/use-env-sense.js"
+
+// @ts-expect-error
 import query from "./query"
+
+// @ts-expect-error
 import * as SQLite from "expo-sqlite"
 
-import Base from "./base"
+import Base from "./base.js"
 
 export default class VelociousDatabaseDriversSqliteNative extends Base {
   async connect() {

package/src/database/drivers/sqlite/index.web.js

@@ -1,7 +1,7 @@
 // @ts-check
 
 import BetterLocalStorage from "better-localstorage"
-import ConnectionSqlJs from "./connection-sql-js"
+import ConnectionSqlJs from "./connection-sql-js.js"
 import initSqlJs from "sql.js"
 
 import Base from "./base.js"
@@ -36,6 +36,7 @@ export default class VelociousDatabaseDriversSqliteWeb extends Base {
     await this.getConnection().close()
   }
 
+  /** @returns {ConnectionSqlJs | any} */
   getConnection() {
     if (this.args?.getConnection) {
       return this.args.getConnection()

package/src/database/drivers/sqlite/options.js

@@ -4,15 +4,18 @@ import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversSqliteOptions extends QueryParserOptions {
   /**
-   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   * @param {import("../base.js").default} driver
    */
-  constructor(options) {
-    options.columnQuote = "`"
-    options.indexQuote = "`"
-    options.stringQuote = "'"
-    options.tableQuote = "`"
+  constructor(driver) {
+    const optionsArgs = {
+      driver,
+      columnQuote: "`",
+      indexQuote: "`",
+      stringQuote: "'",
+      tableQuote: "`"
+    }
 
-    super(options)
+    super(optionsArgs)
   }
 
   /**

package/src/database/drivers/sqlite/sql/alter-table.js

@@ -23,7 +23,7 @@ export default class VelociousDatabaseConnectionDriversSqliteSqlAlterTable exten
   }
 
   /**
-   * @returns {string[]}
+   * @returns {Promise<string[]>}
    */
   async toSQLs() {
     const {tableData} = this
@@ -108,7 +108,7 @@ export default class VelociousDatabaseConnectionDriversSqliteSqlAlterTable exten
       tableDataColumn.setForeignKey(foreignKey)
     }
 
-    const createNewTableSQL = this.getDriver().createTableSql(newTableData)
+    const createNewTableSQL = await this.getDriver().createTableSql(newTableData)
     const insertSQL = `INSERT INTO ${options.quoteTableName(tempTableName)} (${newColumnsSQL}) SELECT ${oldColumnsSQL} FROM ${options.quoteTableName(tableName)}`
     const dropTableSQLs = `DROP TABLE ${options.quoteTableName(tableName)}`
     const renameTableSQL = `ALTER TABLE ${options.quoteTableName(tempTableName)} RENAME TO ${options.quoteTableName(tableName)}`
@@ -141,7 +141,7 @@ export default class VelociousDatabaseConnectionDriversSqliteSqlAlterTable exten
         tableName,
         unique: actualTableIndex.getUnique()
       }
-      const createIndexSQLs = new CreateIndexBase(createIndexArgs).toSQLs()
+      const createIndexSQLs = await new CreateIndexBase(createIndexArgs).toSQLs()
 
       for (const createIndexSQL of createIndexSQLs) {
         sqls.push(createIndexSQL)

package/src/database/migration/index.js

@@ -135,7 +135,7 @@ export default class VelociousDatabaseMigration {
       },
       args
     )
-    const sqls = this.getDriver().createIndexSQLs(createIndexArgs)
+    const sqls = await this.getDriver().createIndexSQLs(createIndexArgs)
 
     for (const sql of sqls) {
       await this.getDriver().query(sql)
@@ -246,14 +246,25 @@ export default class VelociousDatabaseMigration {
    * @property {CreateTableIdArgsType | false} [id]
    */
   /**
+   * @typedef {(TableData) => void} CreateTableCallbackType
+   */
+  /**
+   * @overload
+   * @param {string} tableName
+   * @param {CreateTableCallbackType} callback
+   * @returns {Promise<void>}
+   */
+  /**
+   * @overload
    * @param {string} tableName
-   * @param {function(TableData) : void} arg1
+   * @param {CreateTableArgsType} args
+   * @param {CreateTableCallbackType} callback
    * @returns {Promise<void>}
    */
   /**
    * @param {string} tableName
-   * @param {CreateTableArgsType} arg1
-   * @param {function(TableData) : void} arg2
+   * @param {CreateTableArgsType | CreateTableCallbackType} arg1
+   * @param {CreateTableCallbackType | undefined} [arg2]
    * @returns {Promise<void>}
    */
   async createTable(tableName, arg1, arg2) {
@@ -297,7 +308,7 @@ export default class VelociousDatabaseMigration {
       callback(tableData)
     }
 
-    const sqls = this.getDriver().createTableSql(tableData)
+    const sqls = await this.getDriver().createTableSql(tableData)
 
     for (const sql of sqls) {
       await this._db.query(sql)

package/src/database/migrator.js

@@ -56,7 +56,7 @@ export default class VelociousDatabaseMigrator {
 
       schemaMigrationsTable.string("version", {null: false, primaryKey: true})
 
-      const createSchemaMigrationsTableSqls = db.createTableSql(schemaMigrationsTable)
+      const createSchemaMigrationsTableSqls = await db.createTableSql(schemaMigrationsTable)
 
       for (const createSchemaMigrationsTableSql of createSchemaMigrationsTableSqls) {
         await db.query(createSchemaMigrationsTableSql)
@@ -64,6 +64,10 @@ export default class VelociousDatabaseMigrator {
     }
   }
 
+  async dropDatabase() {
+    throw new Error("Not implemented yet")
+  }
+
   /**
    * @param {string} dbIdentifier
    * @param {number} version

package/src/database/pool/base-methods-forward.js

@@ -28,16 +28,12 @@ export default function baseMethodsForward(PoolBase) {
   ]
 
   for (const forwardMethod of forwardMethods) {
-    // @ts-expect-error
     PoolBase.prototype[forwardMethod] = function(...args) {
       const connection = this.getCurrentConnection()
-
-      // @ts-expect-error
       const connectionMethod = connection[forwardMethod]
 
       if (!connectionMethod) throw new Error(`${forwardMethod} isn't defined on driver`)
 
-        // @ts-expect-error
       return connection[forwardMethod](...args)
     }
   }