velocious 1.0.104 → 1.0.106

package/package.json

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

package/spec/dummy/dummy-directory.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import {dirname} from "path"
 import {fileURLToPath} from "url"
 

package/spec/dummy/index.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import Application from "../../src/application.js"
 import {digg} from "diggerize"
 import dummyConfiguration from "./src/config/configuration.js"
@@ -36,10 +38,12 @@ export default class Dummy {
     await migrator.migrateFiles(await environmentHandlerNode.findMigrations(), digg(environmentHandlerNode, "requireMigration"))
   }
 
+  /** @param {function(): Promise<any>} callback */
   static async run(callback) {
     await this.current().run(callback)
   }
 
+  /** @param {function(): Promise<void>} callback */
   async run(callback) {
     await dummyConfiguration.ensureConnections(async () => {
       await Dummy.prepare()
@@ -72,7 +76,7 @@ export default class Dummy {
   }
 
   async stop() {
-    if (this.application.isActive()) {
+    if (this.application?.isActive()) {
       await this.application.stop()
     }
   }

package/src/application.js

@@ -7,6 +7,7 @@ import restArgsError from "./utils/rest-args-error.js"
 
 /**
  * @typedef {object} HttpServerConfiguration
+ * @property {number} [maxWorkers]
  * @property {number} [port]
  */
 

package/src/configuration-types.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * @module types
  */
@@ -18,11 +20,15 @@
 
 /**
  * @typedef {object} DatabaseConfigurationType
+ * @property {function() : void} [getConnection]
  * @property {string} [host]
  * @property {boolean} [migrations]
  * @property {string} [password]
+ * @property {number} [port]
+ * @property {string} [name]
  * @property {object} [record]
  * @property {boolean} [record.transactions]
+ * @property {boolean} [reset]
  * @property {string} [username]
  */
 

package/src/controller.js

@@ -1,4 +1,5 @@
-import {digs} from "diggerize"
+// @ts-check
+
 import ejs from "ejs"
 import {incorporate} from "incorporator"
 import * as inflection from "inflection"
@@ -11,11 +12,24 @@ export default class VelociousController {
    * @returns {void}
    */
   static beforeAction(methodName) {
-    if (!this._beforeActions) this._beforeActions = []
+    if (!this._beforeActions) {
+      /** @type {Array<string>}  */
+      this._beforeActions = []
+    }
 
     this._beforeActions.push(methodName)
   }
 
+  /**
+   * @param {object} args
+   * @param {string} args.action
+   * @param {import("./configuration.js").default} args.configuration
+   * @param {string} args.controller
+   * @param {object} args.params
+   * @param {import("./http-server/client/request.js").default} args.request
+   * @param {import("./http-server/client/response.js").default} args.response
+   * @param {string} args.viewPath
+   */
   constructor({action, configuration, controller, params, request, response, viewPath}) {
     if (!action) throw new Error("No action given")
     if (!configuration) throw new Error("No configuration given")
@@ -36,30 +50,32 @@ export default class VelociousController {
     this._viewPath = viewPath
   }
 
-  /**
-   * @returns {string}
-   */
+  /** @returns {string} */
   getAction() { return this._action }
 
-  /**
-   * @returns {import("./configuration.js").default}
-   */
+  /** @returns {import("./configuration.js").default} */
   getConfiguration() { return this._configuration }
 
-  /**
-   * @returns {object}
-   */
+  /** @returns {object} */
   getParams() { return this._params }
 
+  /** @returns {import("./http-server/client/request.js").default} */
+  getRequest() { return this._request }
+
   /**
-   * @returns {import("./http-server/client/request.js").default}
+   * @private
+   * @returns {typeof VelociousController}
    */
-  getRequest() { return this._request }
+  _getControllerClass() {
+    const controllerClass = /** @type {typeof VelociousController} */ (this.constructor)
+
+    return controllerClass
+  }
 
   async _runBeforeCallbacks() {
     await this.logger.debug("_runBeforeCallbacks")
 
-    let currentControllerClass = this.constructor
+    let currentControllerClass = this._getControllerClass()
 
     while (currentControllerClass) {
       await this.logger.debug(`Running callbacks for ${currentControllerClass.name}`)
@@ -68,6 +84,7 @@ 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}`)
@@ -91,7 +108,13 @@ export default class VelociousController {
    */
   params() { return this._params }
 
-  render({json, status, ...restArgs} = {}) {
+  /**
+   * @param {object} [args]
+   * @param {object} [args.json]
+   * @param {number} [args.status]
+   * @returns {Promise<void>}
+   */
+  async render({json, status, ...restArgs} = {}) {
     restArgsError(restArgs)
 
     if (json) {
@@ -102,9 +125,10 @@ export default class VelociousController {
       this._response.setStatus(status)
     }
 
-    return this.renderView()
+    return await this.renderView()
   }
 
+  /** @param {object} json */
   renderJsonArg(json) {
     const body = JSON.stringify(json)
 
@@ -115,7 +139,7 @@ export default class VelociousController {
   renderView() {
     return new Promise((resolve, reject) => {
       const viewPath = `${this._viewPath}/${inflection.dasherize(inflection.underscore(this._action))}.ejs`
-      const {viewParams} = digs(this, "viewParams")
+      const {viewParams} = this
       const actualViewParams = incorporate({controller: this}, viewParams)
 
       ejs.renderFile(viewPath, actualViewParams, {}, (err, str) => {
@@ -125,7 +149,7 @@ export default class VelociousController {
           this._response.setHeader("Content-Type", "text/html; charset=UTF-8")
           this._response.setBody(str)
 
-          resolve()
+          resolve(null)
         }
       })
     })
@@ -135,13 +159,9 @@ export default class VelociousController {
     throw new Error("renderText stub")
   }
 
-  /**
-   * @returns {import("./http-server/client/request.js").default}
-   */
+  /** @returns {import("./http-server/client/request.js").default} */
   request() { return this._request }
 
-  /**
-   * @returns {import("./http-server/client/response.js").default}
-   */
+  /** @returns {import("./http-server/client/response.js").default} */
   response() { return this._response }
 }

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

@@ -7,7 +7,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   table = undefined
 
   /**
-   * @param {object} data
+   * @param {Record<string, any>} data
    */
   constructor(data) {
     this.data = data

package/src/database/drivers/base.js

@@ -328,8 +328,8 @@ export default class VelociousDatabaseDriversBase {
   }
 
   /**
-   * @param {string} value
-   * @returns {string}
+   * @param {any} value
+   * @returns {number | string}
    */
   quote(value) {
     if (typeof value == "number") return value

package/src/database/drivers/mssql/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 VelociousDatabaseDriversMssqlColumn 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/mssql/columns-index.js

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

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

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

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

@@ -1,6 +1,11 @@
+// @ts-check
+
 import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversMssqlOptions extends QueryParserOptions {
+  /**
+   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   */
   constructor(options) {
     options.columnQuote = "\""
     options.indexQuote = "\""
@@ -10,18 +15,30 @@ export default class VelociousDatabaseDriversMssqlOptions extends QueryParserOpt
     super(options)
   }
 
+  /**
+   * @param {any} string
+   * @returns {number | string}
+   */
   quote(string) {
     if (!this.driver) throw new Error("Driver not set")
 
     return this.driver.quote(string)
   }
 
+  /**
+   * @param {string} string
+   * @returns {string}
+   */
   quoteColumnName(string) {
     if (string.includes("[") || string.includes("]")) throw new Error(`Possible SQL injection in column name: ${string}`)
 
     return `[${string}]`
   }
 
+  /**
+   * @param {string} databaseName
+   * @returns {string}
+   */
   quoteDatabaseName(databaseName) {
     if (typeof databaseName != "string") throw new Error(`Invalid database name given: ${databaseName}`)
     if (databaseName.includes("[") || databaseName.includes("]")) throw new Error(`Possible SQL injection in database name: ${databaseName}`)
@@ -29,12 +46,20 @@ export default class VelociousDatabaseDriversMssqlOptions extends QueryParserOpt
     return `[${databaseName}]`
   }
 
+  /**
+   * @param {string} string
+   * @returns {string}
+   */
   quoteIndexName(string) {
     if (string.includes("[") || string.includes("]")) throw new Error(`Possible SQL injection in index name: ${string}`)
 
     return `[${string}]`
   }
 
+  /**
+   * @param {string} string
+   * @returns {string}
+   */
   quoteTableName(string) {
     if (string.includes("[") || string.includes("]")) throw new Error(`Possible SQL injection in table name: ${string}`)
 

package/src/database/drivers/mssql/query-parser.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import BaseQueryParser from "../../query-parser/base-query-parser.js"
 
 export default class VelociousDatabaseConnectionDriversMssqlQueryParser extends BaseQueryParser {

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

@@ -1,6 +1,11 @@
+// @ts-check
+
 import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversMysqlOptions extends QueryParserOptions {
+  /**
+   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   */
   constructor(options) {
     options.columnQuote = "`"
     options.indexQuote = "`"
@@ -10,6 +15,10 @@ export default class VelociousDatabaseDriversMysqlOptions extends QueryParserOpt
     super(options)
   }
 
+  /**
+   * @param {any} string
+   * @returns {number | string}
+   */
   quote(string) {
     if (!this.driver) throw new Error("Driver not set")
 

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

@@ -1,3 +1,5 @@
+// @ts-check
+
 import AlterTableBase from "../../../query/alter-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlAlterTable extends AlterTableBase {

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

@@ -1,3 +1,5 @@
+// @ts-check
+
 import CreateDatabaseBase from "../../../query/create-database-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlCreateDatabase extends CreateDatabaseBase {

package/src/database/drivers/mysql/sql/create-index.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import CreateIndexBase from "../../../query/create-index-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlCreateIndex extends CreateIndexBase {

package/src/database/drivers/mysql/sql/create-table.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import CreateTableBase from "../../../query/create-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlCreateTable extends CreateTableBase {

package/src/database/drivers/mysql/sql/delete.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import DeleteBase from "../../../query/delete-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlDelete extends DeleteBase {

package/src/database/drivers/mysql/sql/drop-table.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import DropTableBase from "../../../query/drop-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlDropTable extends DropTableBase {

package/src/database/drivers/mysql/sql/insert.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import InsertBase from "../../../query/insert-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlInsert extends InsertBase {

package/src/database/drivers/mysql/sql/update.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import UpdateBase from "../../../query/update-base.js"
 
 export default class VelociousDatabaseConnectionDriversMysqlSqlUpdate extends UpdateBase {

package/src/database/drivers/pgsql/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 VelociousDatabaseDriversPgsqlColumn 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/pgsql/columns-index.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import BaseColumnsIndex from "../base-columns-index.js"
 
 export default class VelociousDatabaseDriversPgsqlColumn extends BaseColumnsIndex {

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

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

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

@@ -1,6 +1,11 @@
+// @ts-check
+
 import QueryParserOptions from "../../query-parser/options.js"
 
 export default class VelociousDatabaseDriversPgsqlOptions extends QueryParserOptions {
+  /**
+   * @param {import("../../query-parser/options.js").OptionsObjectArgsType} options
+   */
   constructor(options) {
     options.columnQuote = "\""
     options.indexQuote = "\""
@@ -10,6 +15,10 @@ export default class VelociousDatabaseDriversPgsqlOptions extends QueryParserOpt
     super(options)
   }
 
+  /**
+   * @param {string} string
+   * @returns {number | string}
+   */
   quote(string) {
     if (!this.driver) throw new Error("Driver not set")
 

package/src/database/drivers/pgsql/query-parser.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import BaseQueryParser from "../../query-parser/base-query-parser.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlQueryParser extends BaseQueryParser {

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

@@ -1,3 +1,5 @@
+// @ts-check
+
 import AlterTableBase from "../../../query/alter-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlAlterTable extends AlterTableBase {

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

@@ -1,5 +1,6 @@
+// @ts-check
+
 import CreateDatabaseBase from "../../../query/create-database-base.js"
-import {digs} from "diggerize"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlCreateDatabase extends CreateDatabaseBase {
   toSql() {
@@ -10,8 +11,8 @@ export default class VelociousDatabaseConnectionDriversPgsqlSqlCreateDatabase ex
     if (this.ifNotExists) {
       sqls.push("CREATE EXTENSION IF NOT EXISTS dblink")
 
-      const connectArgs = this._driver.connectArgs()
-      const {password, user} = digs(connectArgs, "password", "user")
+      const connectArgs = this._driver.getArgs()
+      const {password, username} = connectArgs
       const port = connectArgs.port || 5432
       const sql = `
         DO
@@ -20,7 +21,7 @@ export default class VelociousDatabaseConnectionDriversPgsqlSqlCreateDatabase ex
           IF EXISTS (SELECT FROM ${options.quoteTableName("pg_database")} WHERE ${options.quoteColumnName("datname")} = ${options.quote(databaseName)}) THEN
             RAISE NOTICE 'Database already exists';  -- optional
           ELSE
-            PERFORM dblink_connect('host=localhost port=' || ${port} || ' user=' || ${options.quote(user)} || ' password=' || ${options.quote(password)} || ' dbname=' || current_database());
+            PERFORM dblink_connect('host=localhost port=' || ${port} || ' user=' || ${options.quote(username)} || ' password=' || ${options.quote(password)} || ' dbname=' || current_database());
             PERFORM dblink_exec('CREATE DATABASE ' || ${options.quote(databaseName)});
           END IF;
         END

package/src/database/drivers/pgsql/sql/create-index.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import CreateIndexBase from "../../../query/create-index-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlCreateIndex extends CreateIndexBase {

package/src/database/drivers/pgsql/sql/create-table.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import CreateTableBase from "../../../query/create-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlCreateTable extends CreateTableBase {

package/src/database/drivers/pgsql/sql/delete.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import DeleteBase from "../../../query/delete-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlDelete extends DeleteBase {

package/src/database/drivers/pgsql/sql/drop-table.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import DropTableBase from "../../../query/drop-table-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlDropTable extends DropTableBase {

package/src/database/drivers/pgsql/sql/insert.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import InsertBase from "../../../query/insert-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlInsert extends InsertBase {

package/src/database/drivers/pgsql/sql/update.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import UpdateBase from "../../../query/update-base.js"
 
 export default class VelociousDatabaseConnectionDriversPgsqlSqlUpdate extends UpdateBase {

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

@@ -1,9 +1,15 @@
+// @ts-check
+
 import BaseTable from "../base-table.js"
 import Column from "./column.js"
 import ColumnsIndex from "./columns-index.js"
 import ForeignKey from "./foreign-key.js"
 
 export default class VelociousDatabaseDriversPgsqlTable extends BaseTable {
+  /**
+   * @param {import("../base.js").default} driver
+   * @param {Record<string, any>} data
+   */
   constructor(driver, data) {
     super()
     this.data = data

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

@@ -1,14 +1,10 @@
+// @ts-check
+
 import BaseColumnsIndex from "../base-columns-index.js"
 import {digg} from "diggerize"
 import TableIndex from "../../table-data/table-index.js"
 
 export default class VelociousDatabaseDriversSqliteColumnsIndex extends BaseColumnsIndex {
-  constructor(table, data) {
-    super()
-    this.data = data
-    this.table = table
-  }
-
   getColumnNames() {
     return digg(this, "data", "columnNames")
   }

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

@@ -1,4 +1,11 @@
+// @ts-check
+
 export default class VelociousDatabaseDriversSqliteConnectionRemote {
+  /**
+   * @abstract
+   * @param {string} sql
+   * @returns {Promise<any[]>}
+   */
   async query(sql) { // eslint-disable-line no-unused-vars
     throw new Error("stub")
   }

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

@@ -1,7 +1,13 @@
+// @ts-check
+
 import debounce from "debounce"
 import query from "./query"
 
 export default class VelociousDatabaseDriversSqliteConnectionSqlJs {
+  /**
+   * @param {import("../base.js").default} driver
+   * @param {import("sql.js").Database} connection
+   */
   constructor(driver, connection) {
     this.connection = connection
     this.driver = driver
@@ -9,12 +15,15 @@ export default class VelociousDatabaseDriversSqliteConnectionSqlJs {
 
   async close() {
     await this.saveDatabase()
-    await this.connection.end()
-    this.connection = undefined
+    await this.connection.close()
   }
 
   async disconnect() { await this.saveDatabase() }
 
+  /**
+   * @param {string} sql
+   * @returns {Promise<Record<string, any>[]>}
+   */
   async query(sql) {
     const result = await query(this.connection, sql)
     const downcasedSQL = sql.toLowerCase().trim()
@@ -30,6 +39,7 @@ export default class VelociousDatabaseDriversSqliteConnectionSqlJs {
   saveDatabase = async () => {
     const localStorageContent = this.connection.export()
 
+    // @ts-expect-error
     await this.driver.betterLocalStorage.set(this.driver.localStorageName(), localStorageContent)
   }