velocious 1.0.93 → 1.0.95

package/package.json

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

package/src/application.js

@@ -22,6 +22,9 @@ export default class VelociousApplication {
    */
   getType() { return this._type }
 
+  /**
+   * @returns {Promise<void>}
+   */
   async initialize() {
     const routes = await AppRoutes.getRoutes(this.configuration)
 
@@ -41,6 +44,10 @@ export default class VelociousApplication {
     return this.httpServer?.isActive()
   }
 
+  /**
+   * @param {function() : void} callback
+   * @returns {Promise<void>}
+   */
   async run(callback) {
     await this.start()
 
@@ -51,6 +58,9 @@ export default class VelociousApplication {
     }
   }
 
+  /**
+   * @returns {Promise<void>}
+   */
   async startHttpServer() {
     const {configuration, httpServerConfiguration} = digs(this, "configuration", "httpServerConfiguration")
     const port = httpServerConfiguration.port || 3006
@@ -63,11 +73,17 @@ export default class VelociousApplication {
     await this.httpServer.start()
   }
 
+  /**
+   * @returns {Promise<void>}
+   */
   async stop() {
     await this.logger.debug("Stopping server")
     await this.httpServer.stop()
   }
 
+  /**
+   * @returns {void}
+   */
   onHttpServerClose = () => {
     this.logger.debug("HTTP server closed")
 
@@ -76,6 +92,9 @@ export default class VelociousApplication {
     }
   }
 
+  /**
+   * @returns {Promise<void>}
+   */
   wait() {
     return new Promise((resolve) => {
       this.waitResolve = resolve

package/src/cli/base-command.js

@@ -21,6 +21,7 @@ export default class VelociousCliBaseCommand {
 
   /**
    * @interface
+   * @returns {Promise<void>}
    */
   execute() {
     throw new Error("execute not implemented")

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

@@ -7,6 +7,8 @@ export default class DbMigrate extends BaseCommand {
     const migrations = await this.getEnvironmentHandler().findMigrations()
     const migrator = new Migrator({configuration: this.getConfiguration()})
 
+    console.log(`Running ${migrations.length} migrations`)
+
     await this.getConfiguration().ensureConnections(async () => {
       await migrator.prepare()
       await migrator.migrateFiles(migrations, digg(this.getEnvironmentHandler(), "requireMigration"))

package/src/cli/commands/generate/base-models.js

@@ -0,0 +1,7 @@
+import BaseCommand from "../../base-command.js"
+
+export default class DbGenerateBaseModels extends BaseCommand {
+  async execute() {
+    return await this.getConfiguration().getEnvironmentHandler().cliCommandsGenerateBaseModels(this)
+  }
+}

package/src/cli/commands/generate/model.js

@@ -2,6 +2,6 @@ import BaseCommand from "../../base-command.js"
 
 export default class DbGenerateModel extends BaseCommand {
   async execute() {
-    return await this.getConfiguration().getEnvironmentHandler().cliCommandsModelGenerate(this)
+    return await this.getConfiguration().getEnvironmentHandler().cliCommandsGenerateModel(this)
   }
 }

package/src/configuration-resolver.js

@@ -2,7 +2,12 @@ import Configuration from "./configuration.js"
 import envSense from "env-sense/src/use-env-sense.js"
 import fileExists from "./utils/file-exists.js"
 
-const configurationResolver = async (args = {}) => {
+/**
+ * @param {object} args
+ * @param {string} args.directory
+ * @returns {Promise<Configuration>}
+ */
+export default async function configurationResolver(args = {}) {
   if (Configuration.current(false)) {
     return Configuration.current()
   }
@@ -35,5 +40,3 @@ const configurationResolver = async (args = {}) => {
 
   return configuration
 }
-
-export default configurationResolver

package/src/configuration.js

@@ -50,10 +50,13 @@ export default class VelociousConfiguration {
   }
 
   /**
-   * @returns {object}
+   * @returns {Record<string, any>}
    */
   getDatabaseConfiguration() {
     if (!this.database) throw new Error("No database configuration")
+    if (!this.database[this.getEnvironment()]) {
+      throw new Error(`No database configuration for environment: ${this.getEnvironment()} - ${Object.keys(this.database).join(", ")}`)
+    }
 
     return digg(this, "database", this.getEnvironment())
   }
@@ -174,6 +177,13 @@ export default class VelociousConfiguration {
     return modelClass
   }
 
+  /**
+   * @returns {Record<string, typeof import("./database/record/index.js").default>} A hash of all model classes, keyed by model name, as they were defined in the configuration. This is a direct reference to the model classes, not a copy.
+   */
+  getModelClasses() {
+    return this.modelClasses
+  }
+
   /**
    * @returns {string} The path to a config file that should be used for testing.
    */
@@ -199,13 +209,26 @@ export default class VelociousConfiguration {
    */
   isInitialized() { return this._isInitialized }
 
+  /**
+   * @param {object} args
+   * @param {string} args.type
+   * @returns {void}
+   */
+  async initializeModels(args = {type: "server"}) {
+    if (!this._modelsInitialized) {
+      this._modelsInitialized = true
+
+      if (this._initializeModels) {
+        await this._initializeModels({configuration: this, type: args.type})
+      }
+    }
+  }
+
   async initialize({type} = {}) {
     if (!this.isInitialized()) {
       this._isInitialized = true
 
-      if (this._initializeModels) {
-        await this._initializeModels({configuration: this, type})
-      }
+      await this.initializeModels({type})
 
       if (this._initializers) {
         const initializers = await this._initializers({configuration: this})

package/src/database/drivers/base-column.js

@@ -2,6 +2,21 @@ import TableColumn from "../table-data/table-column.js"
 import TableData from "../table-data/index.js"
 
 export default class VelociousDatabaseDriversBaseColumn {
+  /**
+   * @interface
+   * @returns {boolean}
+   */
+  getAutoIncrement() {
+    throw new Error("getAutoIncrement not implemented")
+  }
+
+  /**
+   * @returns {any}
+   */
+  getDefault() {
+    throw new Error("getDefault not implemented")
+  }
+
   /**
    * @param {string} indexName
    * @returns {Promise<import('../table-data/table-index.js').default>}
@@ -32,10 +47,45 @@ export default class VelociousDatabaseDriversBaseColumn {
     }
   }
 
+  /**
+   * @returns {import("./base.js").default}
+   */
   getDriver() {
     return this.getTable().getDriver()
   }
 
+  /**
+   * @interface
+   * @returns {Promise<Array<import("./base-columns-index.js").default>>}
+   */
+  getIndexes() {
+    throw new Error("getIndexes not implemented")
+  }
+
+  /**
+   * @interface
+   * @returns {number}
+   */
+  getMaxLength() {
+    throw new Error("getMaxLength not implemented")
+  }
+
+  /**
+   * @interface
+   * @returns {string}
+   */
+  getName() {
+    throw new Error("getName not implemented")
+  }
+
+  /**
+   * @interface
+   * @returns {boolean}
+   */
+  getNull() {
+    throw new Error("getNull not implemented")
+  }
+
   /**
    * @returns {import("../query-parser/options.js").default}
    */
@@ -43,6 +93,17 @@ export default class VelociousDatabaseDriversBaseColumn {
     return this.getDriver().options()
   }
 
+  /**
+   * @interface
+   * @returns {boolean}
+   */
+  getPrimaryKey() {
+    throw new Error("getPrimaryKey not implemented")
+  }
+
+  /**
+   * @returns {import("./base-table.js").default}
+   */
   getTable() {
     if (!this.table) throw new Error("No table set on column")
 
@@ -63,4 +124,12 @@ export default class VelociousDatabaseDriversBaseColumn {
       type: this.getType()
     })
   }
+
+  /**
+   * @interface
+   * @returns {string}
+   */
+  getType() {
+    throw new Error("getType not implemented")
+  }
 }

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

@@ -1,15 +1,25 @@
 import { digg } from "diggerize"
 
 export default class VelociousDatabaseDriversBaseColumnsIndex {
+  /**
+   * @param {import("./base-table.js").default} table
+   * @param {object} data
+   */
   constructor(table, data) {
     this.data = data
     this.table = table
   }
 
+  /**
+   * @returns {import("./base.js").default}
+   */
   getDriver() {
     return this.getTable().getDriver()
   }
 
+  /**
+   * @returns {string}
+   */
   getName()  {
     return digg(this, "data", "index_name")
   }
@@ -21,16 +31,25 @@ export default class VelociousDatabaseDriversBaseColumnsIndex {
     return this.getDriver().options()
   }
 
+  /**
+   * @returns {import("./base-table.js").default}
+   */
   getTable() {
     if (!this.table) throw new Error("No table set on column")
 
     return this.table
   }
 
+  /**
+   * @returns {boolean}
+   */
   isPrimaryKey() {
     return digg(this, "data", "is_primary_key")
   }
 
+  /**
+   * @returns {boolean}
+   */
   isUnique() {
     return digg(this, "data", "is_unique")
   }

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

@@ -1,10 +1,16 @@
 import TableForeignKey from "../table-data/table-foreign-key.js"
 
 export default class VelociousDatabaseDriversBaseForeignKey {
+  /**
+   * @param {object} data
+   */
   constructor(data) {
     this.data = data
   }
 
+  /**
+   * @returns {import("./base.js").default}
+   */
   getDriver() {
     return this.getTable().getDriver()
   }
@@ -16,12 +22,18 @@ export default class VelociousDatabaseDriversBaseForeignKey {
     return this.getDriver().options()
   }
 
+  /**
+   * @returns {import("./base-table.js").default}
+   */
   getTable() {
     if (!this.table) throw new Error("No table set on column")
 
     return this.table
   }
 
+  /**
+   * @returns {TableForeignKey}
+   */
   getTableDataForeignKey() {
     return new TableForeignKey({
       columnName: this.getColumnName(),

package/src/database/drivers/base-table.js

@@ -2,6 +2,10 @@ import {digg} from "diggerize"
 import TableData from "../table-data/index.js"
 
 export default class VelociousDatabaseDriversBaseTable {
+  /**
+   * @param {string} columnName
+   * @returns {import("./base-column.js").default}
+   */
   async getColumnByName(columnName) {
     const columnes = await this.getColumns()
     const column = columnes.find((column) => column.getName() == columnName)
@@ -9,12 +13,31 @@ export default class VelociousDatabaseDriversBaseTable {
     return column
   }
 
+  /**
+   * @interface
+   * @returns {Promise<Array<import("./base-column.js").default>>}
+   */
+  getColumns() {
+    throw new Error("getColumns not implemented")
+  }
+
+  /**
+   * @returns {import("./base.js").default}
+   */
   getDriver() {
     if (!this.driver) throw new Error("No driver set on table")
 
     return this.driver
   }
 
+  /**
+   * @interface
+   * @returns {string}
+   */
+  getName() {
+    throw new Error("getName not implemented")
+  }
+
   /**
    * @returns {import("../query-parser/options.js").default}
    */
@@ -22,6 +45,9 @@ export default class VelociousDatabaseDriversBaseTable {
     return this.getDriver().options()
   }
 
+  /**
+   * @returns {Promise<TableData>}
+   */
   async getTableData() {
     const tableData = new TableData(this.getName())
     const tableDataColumns = []
@@ -50,12 +76,18 @@ export default class VelociousDatabaseDriversBaseTable {
     return tableData
   }
 
+  /**
+   * @returns {Promise<number>}
+   */
   async rowsCount() {
     const result = await this.getDriver().query(`SELECT COUNT(*) AS count FROM ${this.getOptions().quoteTableName(this.getName())}`)
 
     return digg(result, 0, "count")
   }
 
+  /**
+   * @returns {Promise<Array<Record<string, any>>>}
+   */
   async truncate(args) {
     const databaseType = this.getDriver().getType()
     let sql