velocious 1.0.85 → 1.0.86

package/bin/velocious.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import Cli from "../src/cli/index.js"
+import configurationResolver from "../src/configuration-resolver.js"
 
 const processArgs = process.argv.slice(2)
 const parsedProcessArgs = {}
@@ -19,7 +20,15 @@ for (let i = 0; i < processArgs.length; i++) {
   }
 }
 
-const cli = new Cli({parsedProcessArgs, processArgs})
+const configuration = await configurationResolver()
+
+configuration.setCurrent()
+
+const cli = new Cli({
+  configuration,
+  parsedProcessArgs,
+  processArgs
+})
 
 await cli.execute()
 process.exit(0)

package/eslint.config.js

@@ -0,0 +1,33 @@
+import js from "@eslint/js"
+import {jsdoc} from 'eslint-plugin-jsdoc'
+import globals from "globals"
+import { defineConfig } from "eslint/config"
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs}"],
+    plugins: {js},
+    extends: ["js/recommended"],
+    languageOptions: {
+      globals: {...globals.browser, ...globals.node}
+    }
+  },
+  jsdoc({
+    config: "flat/recommended",
+    rules: {
+      "jsdoc/reject-any-type": "off",
+      "jsdoc/reject-function-type": "off",
+      "jsdoc/require-jsdoc": "off",
+      "jsdoc/require-param": "off",
+      "jsdoc/require-param-description": "off",
+      "jsdoc/require-returns": "off",
+      "jsdoc/require-returns-description": "off"
+    }
+  }),
+  {
+    files: ["spec/**/*.js"],
+    rules: {
+      "no-undef": "off"
+    }
+  }
+])

package/package.json

@@ -3,9 +3,10 @@
     "velocious": "bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.85",
+  "version": "1.0.86",
   "main": "index.js",
   "scripts": {
+    "lint": "eslint",
     "test": "VELOCIOUS_TEST_DIR=../ cd spec/dummy && npx velocious test",
     "velocious": "asd"
   },
@@ -40,6 +41,10 @@
     "strftime": "^0.10.2"
   },
   "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-jsdoc": "^61.4.1",
+    "globals": "^16.5.0",
     "mssql": "^12.0.0",
     "mysql": "^2.18.1",
     "node-fetch": "^3.3.1",
@@ -47,7 +52,7 @@
     "require-context": "^1.1.0",
     "sqlite": "^5.1.1",
     "sqlite3": "^5.1.7",
-    "tedious": "^18.6.1",
+    "tedious": "^19.1.3",
     "uniqunize": "^1.0.1"
   }
 }

package/peak_flow.yml

@@ -80,3 +80,9 @@ builds:
       - cd spec/dummy && npx velocious db:create
       - cd spec/dummy && npx velocious db:migrate
       - cd spec/dummy && npx velocious test
+  build_5:
+    name: ESLint
+    script:
+      - cp spec/dummy/src/config/configuration.peakflow.sqlite.js spec/dummy/src/config/configuration.js
+      - sleep 5
+      - npm run lint

package/spec/cli/commands/db/create-spec.js

@@ -1,10 +1,14 @@
 import Cli from "../../../../src/cli/index.js"
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
 import dummyDirectory from "../../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../../src/environment-handlers/node.js"
 
 describe("Cli - Commands - db:create", () => {
   it("generates SQL to create a new database", async () => {
     const cli = new Cli({
+      configuration: dummyConfiguration,
       directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
       processArgs: ["db:create"],
       testing: true
     })

package/spec/cli/commands/db/migrate-spec.js

@@ -1,18 +1,20 @@
 import Cli from "../../../../src/cli/index.js"
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
 import dummyDirectory from "../../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../../src/environment-handlers/node.js"
 import uniqunize from "uniqunize"
 
 describe("Cli - Commands - db:migrate", () => {
   it("runs migrations", {databaseCleaning: {transaction: false}}, async () => {
     const directory = dummyDirectory()
     const cli = new Cli({
+      configuration: dummyConfiguration,
       directory,
+      environmentHandler: new EnvironmentHandlerNode(),
       processArgs: ["db:migrate"],
       testing: true
     })
 
-    await cli.loadConfiguration()
-
     let defaultDatabaseType, defaultSchemaMigrations = [], projectForeignKey = [], tablesResult = []
 
     await cli.configuration.ensureConnections(async (dbs) => {

package/spec/cli/commands/db/rollback-spec.js

@@ -0,0 +1,179 @@
+import Cli from "../../../../src/cli/index.js"
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
+import dummyDirectory from "../../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../../src/environment-handlers/node.js"
+import uniqunize from "uniqunize"
+
+describe("Cli - Commands - db:rollback", () => {
+  const runMigrations = async () => {
+    const cliMigrate = new Cli({
+      configuration: dummyConfiguration,
+      directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
+      processArgs: ["db:migrate"],
+      testing: true
+    })
+
+    await cliMigrate.execute()
+  }
+
+  const getTestData = async () => {
+    const cliRollback = new Cli({
+      configuration: dummyConfiguration,
+      directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
+      processArgs: ["db:rollback"],
+      testing: true
+    })
+
+    let defaultDatabaseType, defaultSchemaMigrations = [], tablesResult = []
+
+    await cliRollback.configuration.ensureConnections(async (dbs) => {
+      defaultDatabaseType = dbs.default.getType()
+
+      for (const dbIdentifier in dbs) {
+        const db = dbs[dbIdentifier]
+        const tables = await db.getTables()
+
+        for (const table of tables) {
+          tablesResult.push(table.getName())
+        }
+
+        const schemaMigrationsResult = await db.select("schema_migrations")
+
+        for (const schemaMigrationResult of schemaMigrationsResult) {
+          defaultSchemaMigrations.push(schemaMigrationResult.version)
+        }
+      }
+    })
+
+    return {defaultDatabaseType, defaultSchemaMigrations, tablesResult}
+  }
+
+  it("runs migrations", {databaseCleaning: {transaction: false}}, async () => {
+    const directory = dummyDirectory()
+
+    await runMigrations()
+
+    const cliRollback = new Cli({
+      configuration: dummyConfiguration,
+      directory,
+      environmentHandler: new EnvironmentHandlerNode(),
+      processArgs: ["db:rollback"],
+      testing: true
+    })
+
+    await cliRollback.configuration.ensureConnections(async () => {
+      await runMigrations()
+      await cliRollback.execute()
+    })
+
+    const {defaultDatabaseType, defaultSchemaMigrations, tablesResult} = await getTestData()
+
+    if (defaultDatabaseType == "mssql") {
+      expect(uniqunize(tablesResult.sort())).toEqual(
+        [
+          "accounts",
+          "authentication_tokens",
+          "project_translations",
+          "projects",
+          "schema_migrations",
+          "tasks",
+          "users"
+        ]
+      )
+
+      expect(uniqunize(defaultSchemaMigrations.sort())).toEqual([
+        "20230728075328",
+        "20230728075329",
+        "20250605133926",
+        "20250903112845",
+        "20250912183605",
+        "20250912183606",
+        "20250915085450",
+        "20250916111330"
+      ])
+    } else {
+      expect(tablesResult.sort()).toEqual(
+        [
+          "accounts",
+          "authentication_tokens",
+          "project_translations",
+          "projects",
+          "schema_migrations",
+          "schema_migrations",
+          "tasks",
+          "users"
+        ]
+      )
+
+      expect(defaultSchemaMigrations.sort()).toEqual([
+        "20230728075328",
+        "20230728075329",
+        "20250605133926",
+        "20250903112845",
+        "20250912183605",
+        "20250912183606",
+        "20250915085450",
+        "20250916111330"
+      ])
+    }
+
+    await runMigrations()
+
+    const {defaultSchemaMigrations: newDefaultSchemaMigrations, tablesResult: newTablesResult} = await getTestData()
+
+    if (defaultDatabaseType == "mssql") {
+      expect(uniqunize(newTablesResult.sort())).toEqual(
+        [
+          "accounts",
+          "authentication_tokens",
+          "project_details",
+          "project_translations",
+          "projects",
+          "schema_migrations",
+          "tasks",
+          "users"
+        ]
+      )
+
+      expect(uniqunize(newDefaultSchemaMigrations.sort())).toEqual([
+        "20230728075328",
+        "20230728075329",
+        "20250605133926",
+        "20250903112845",
+        "20250912183605",
+        "20250912183606",
+        "20250915085450",
+        "20250916111330",
+        "20250921121002"
+      ])
+    } else {
+      expect(newTablesResult.sort()).toEqual(
+        [
+          "accounts",
+          "authentication_tokens",
+          "project_details",
+          "project_translations",
+          "projects",
+          "schema_migrations",
+          "schema_migrations",
+          "tasks",
+          "users"
+        ]
+      )
+
+      expect(newDefaultSchemaMigrations.sort()).toEqual([
+        "20230728075328",
+        "20230728075329",
+        "20250605133926",
+        "20250903112845",
+        "20250912183605",
+        "20250912183606",
+        "20250915085450",
+        "20250916111330",
+        "20250921121002"
+      ])
+    }
+  })
+})

package/spec/cli/commands/destroy/migration-spec.js

@@ -1,10 +1,14 @@
 import Cli from "../../../../src/cli/index.js"
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
 import dummyDirectory from "../../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../../src/environment-handlers/node.js"
 
 describe("Cli - destroy - migration", () => {
   it("destroys an existing migration", async () => {
     const cli = new Cli({
+      configuration: dummyConfiguration,
       directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
       processArgs: ["d:migration", "create-tasks"],
       testing: true
     })

package/spec/cli/commands/generate/migration-spec.js

@@ -1,10 +1,14 @@
 import Cli from "../../../../src/cli/index.js"
+import dummyConfiguration from "../../../dummy/src/config/configuration.js"
 import dummyDirectory from "../../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../../src/environment-handlers/node.js"
 
 describe("Cli - generate - migration", () => {
   it("generates a new migration", async () => {
     const cli = new Cli({
+      configuration: dummyConfiguration,
       directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
       processArgs: ["g:migration", "create-tasks"],
       testing: true
     })

package/spec/cli/commands/init-spec.js

@@ -1,10 +1,14 @@
 import Cli from "../../../src/cli/index.js"
+import dummyConfiguration from "../../dummy/src/config/configuration.js"
 import dummyDirectory from "../../dummy/dummy-directory.js"
+import EnvironmentHandlerNode from "../../../src/environment-handlers/node.js"
 
 describe("Cli - Commands - init", () => {
   it("inits files and dirs", async () => {
     const cli = new Cli({
+      configuration: dummyConfiguration,
       directory: dummyDirectory(),
+      environmentHandler: new EnvironmentHandlerNode(),
       processArgs: ["init"],
       testing: true
     })

package/spec/dummy/index.js

@@ -1,6 +1,7 @@
 import Application from "../../src/application.js"
+import {digg} from "diggerize"
 import dummyConfiguration from "./src/config/configuration.js"
-import FilesFinder from "../../src/database/migrator/files-finder.js"
+import EnvironmentHandlerNode from "../../src/environment-handlers/node.js"
 import Migrator from "../../src/database/migrator.js"
 
 export default class Dummy {
@@ -25,12 +26,14 @@ export default class Dummy {
   }
 
   static async runMigrations() {
-    const migrationsPath = `${import.meta.dirname}/src/database/migrations`
-    const files = await new FilesFinder({path: migrationsPath}).findFiles()
+    const environmentHandlerNode = new EnvironmentHandlerNode()
+
+    environmentHandlerNode.setConfiguration(dummyConfiguration)
+
     const migrator = new Migrator({configuration: dummyConfiguration})
 
     await migrator.prepare()
-    await migrator.migrateFiles(files, async (path) => await import(path))
+    await migrator.migrateFiles(await environmentHandlerNode.findMigrations(), digg(environmentHandlerNode, "requireMigration"))
   }
 
   static async run(callback) {

package/spec/dummy/src/config/configuration.example.js

@@ -5,6 +5,7 @@ import dummyDirectory from "../../dummy-directory.js"
 import fs from "fs/promises"
 import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
 import MysqlDriver from "../../../../src/database/drivers/mysql/index.js"
+import NodeEnvironmentHandler from "../../../../src/environment-handlers/node.js"
 import path from "path"
 import requireContext from "require-context"
 
@@ -48,6 +49,7 @@ export default new Configuration({
     }
   },
   directory: dummyDirectory(),
+  environmentHandler: new NodeEnvironmentHandler(),
   initializeModels: async ({configuration}) => {
     const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
     const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)

package/spec/dummy/src/config/configuration.peakflow.mariadb.js

@@ -6,6 +6,7 @@ import fs from "fs/promises"
 import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
 import MssqlDriver from "../../../../src/database/drivers/mssql/index.js"
 import MysqlDriver from "../../../../src/database/drivers/mysql/index.js"
+import NodeEnvironmentHandler from "../../../../src/environment-handlers/node.js"
 import path from "path"
 import requireContext from "require-context"
 
@@ -44,6 +45,7 @@ export default new Configuration({
     }
   },
   directory: dummyDirectory(),
+  environmentHandler: new NodeEnvironmentHandler(),
   initializeModels: async ({configuration}) => {
     const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
     const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)

package/spec/dummy/src/config/configuration.peakflow.mssql.js

@@ -5,6 +5,7 @@ import dummyDirectory from "../../dummy-directory.js"
 import fs from "fs/promises"
 import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
 import MssqlDriver from "../../../../src/database/drivers/mssql/index.js"
+import NodeEnvironmentHandler from "../../../../src/environment-handlers/node.js"
 import path from "path"
 import requireContext from "require-context"
 
@@ -50,6 +51,7 @@ export default new Configuration({
     }
   },
   directory: dummyDirectory(),
+  environmentHandler: new NodeEnvironmentHandler(),
   initializeModels: async ({configuration}) => {
     const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
     const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)

package/spec/dummy/src/config/configuration.peakflow.pgsql.js

@@ -5,6 +5,7 @@ import dummyDirectory from "../../dummy-directory.js"
 import fs from "fs/promises"
 import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
 import MssqlDriver from "../../../../src/database/drivers/mssql/index.js"
+import NodeEnvironmentHandler from "../../../../src/environment-handlers/node.js"
 import path from "path"
 import PgsqlDriver from "../../../../src/database/drivers/pgsql/index.js"
 import requireContext from "require-context"
@@ -44,6 +45,7 @@ export default new Configuration({
     }
   },
   directory: dummyDirectory(),
+  environmentHandler: new NodeEnvironmentHandler(),
   initializeModels: async ({configuration}) => {
     const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
     const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)

package/spec/dummy/src/config/configuration.peakflow.sqlite.js

@@ -5,6 +5,7 @@ import dummyDirectory from "../../dummy-directory.js"
 import fs from "fs/promises"
 import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
 import MssqlDriver from "../../../../src/database/drivers/mssql/index.js"
+import NodeEnvironmentHandler from "../../../../src/environment-handlers/node.js"
 import SqliteDriver from "../../../../src/database/drivers/sqlite/index.js"
 import path from "path"
 import requireContext from "require-context"
@@ -41,6 +42,7 @@ export default new Configuration({
     }
   },
   directory: dummyDirectory(),
+  environmentHandler: new NodeEnvironmentHandler(),
   initializeModels: async ({configuration}) => {
     const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
     const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)

package/spec/dummy/src/database/migrations/20250921121002-create-project-details.js

@@ -10,6 +10,8 @@ export default class CreateProjectDetails extends Migration {
   }
 
   async down() {
-    await this.dropTable("project_details")
+    if (await this.tableExists("project_details")) {
+      await this.dropTable("project_details")
+    }
   }
 }

package/src/application.js

@@ -4,6 +4,12 @@ import {Logger} from "./logger.js"
 import HttpServer from "./http-server/index.js"
 
 export default class VelociousApplication {
+  /**
+   * @param {object} args
+   * @param {import("./http-server/index.js").default} args.httpServer
+   * @param {import("./configuration.js").default} args.configuration
+   * @param {string} args.type
+   */
   constructor({configuration, httpServer, type}) {
     this.configuration = configuration
     this.httpServerConfiguration = httpServer ?? {}
@@ -11,6 +17,9 @@ export default class VelociousApplication {
     this._type = type
   }
 
+  /**
+   * @returns {string}
+   */
   getType() { return this._type }
 
   async initialize() {
@@ -25,6 +34,9 @@ export default class VelociousApplication {
     }
   }
 
+  /**
+   * @returns {boolean}
+   */
   isActive() {
     return this.httpServer?.isActive()
   }

package/src/cli/base-command.js

@@ -1,12 +1,16 @@
-import {digg} from "diggerize"
+import restArgsError from "../utils/rest-args-error.js"
 
 export default class VelociousCliBaseCommand {
-  constructor(args) {
+  constructor({args = {}, environmentHandler, ...restArgs}) {
+    restArgsError(restArgs)
+
     this.args = args
-    this.configuration = this.args.configuration
+    this._configuration = args.configuration
+    this._environmentHandler = environmentHandler
     this.processArgs = args.processArgs
   }
 
-  directory() { return digg(this, "configuration").getDirectory() }
-  getConfiguration() { return this.configuration }
+  directory() { return this.getConfiguration().getDirectory() }
+  getConfiguration() { return this._configuration }
+  getEnvironmentHandler() { return this._environmentHandler }
 }

package/src/cli/browser-cli.js

@@ -0,0 +1,37 @@
+import Cli from "./index.js"
+import restArgsError from "../utils/rest-args-error.js"
+
+export default class VelociousBrowserCli {
+  /**
+   * @param {object} args
+   * @param {import("../configuration.js").default} args.configuration
+   */
+  constructor({configuration, ...restArgs}) {
+    restArgsError(restArgs)
+
+    this.configuration = configuration
+  }
+
+  /**
+   * @description Enable the CLI in the global scope. This is useful for debugging and testing.
+   * @returns {void}
+   */
+  enable() {
+    globalThis.velociousCLI = this
+  }
+
+  /**
+   * @description Run a command. This is useful for debugging and testing. This is a wrapper around the Cli class.
+   * @param {string} command
+   * @returns {Promise<void>}
+   */
+  async run(command) {
+    const processArgs = command.split(/\s+/)
+    const cli = new Cli({
+      configuration: this.configuration,
+      processArgs
+    })
+
+    await cli.execute()
+  }
+}

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

@@ -5,9 +5,9 @@ import TableData from "../../../database/table-data/index.js"
 
 export default class DbCreate extends BaseCommand{
   async execute() {
-    for (const databaseIdentifier of this.configuration.getDatabaseIdentifiers()) {
-      const databaseType = this.configuration.getDatabaseType(databaseIdentifier)
-      const databasePool = this.configuration.getDatabasePool(databaseIdentifier)
+    for (const databaseIdentifier of this.getConfiguration().getDatabaseIdentifiers()) {
+      const databaseType = this.getConfiguration().getDatabaseType(databaseIdentifier)
+      const databasePool = this.getConfiguration().getDatabasePool(databaseIdentifier)
       const newConfiguration = incorporate({}, databasePool.getConfiguration())
       const DriverClass = digg(newConfiguration, "driver")
 
@@ -21,7 +21,7 @@ export default class DbCreate extends BaseCommand{
         delete newConfiguration.sqlConfig.database
       }
 
-      this.databaseConnection = new DriverClass(newConfiguration, this.configuration)
+      this.databaseConnection = new DriverClass(newConfiguration, this.getConfiguration())
 
       await this.databaseConnection.connect()
 
@@ -42,7 +42,7 @@ export default class DbCreate extends BaseCommand{
   }
 
   async createDatabase(databaseIdentifier) {
-    const databaseName = digg(this.configuration.getDatabaseConfiguration(), databaseIdentifier, "database")
+    const databaseName = digg(this.getConfiguration().getDatabaseConfiguration(), databaseIdentifier, "database")
     const sqls = this.databaseConnection.createDatabaseSql(databaseName, {ifNotExists: true})
 
     for (const sql of sqls) {

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

@@ -1,19 +1,18 @@
 import BaseCommand from "../../base-command.js"
-import FilesFinder from "../../../database/migrator/files-finder.js"
 import Migrator from "../../../database/migrator.js"
 
 export default class DbDrop extends BaseCommand {
   async execute() {
-    const environment = this.configuration.getEnvironment()
+    const environment = this.getConfiguration().getEnvironment()
 
     if (environment != "development" && environment != "test") {
       throw new Error(`This command should only be executed on development and test environments and not: ${environment}`)
     }
 
-    this.migrator = new Migrator({configuration: this.configuration})
+    const migrator = new Migrator({configuration: this.getConfiguration()})
 
-    await this.configuration.ensureConnections(async () => {
-      await this.migrator.dropDatabase()
+    await this.getConfiguration().ensureConnections(async () => {
+      await migrator.dropDatabase()
     })
   }
 }

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

@@ -1,19 +1,15 @@
 import BaseCommand from "../../base-command.js"
-import FilesFinder from "../../../database/migrator/files-finder.js"
+import {digg} from "diggerize"
 import Migrator from "../../../database/migrator.js"
 
 export default class DbMigrate extends BaseCommand {
   async execute() {
-    const projectPath = this.configuration.getDirectory()
-    const migrationsPath = `${projectPath}/src/database/migrations`
-    const filesFinder = new FilesFinder({path: migrationsPath})
-    const files = await filesFinder.findFiles()
+    const migrations = await this.getEnvironmentHandler().findMigrations()
+    const migrator = new Migrator({configuration: this.getConfiguration()})
 
-    this.migrator = new Migrator({configuration: this.configuration})
-
-    await this.configuration.ensureConnections(async () => {
-      await this.migrator.prepare()
-      await this.migrator.migrateFiles(files, async (importPath) => await import(importPath))
+    await this.getConfiguration().ensureConnections(async () => {
+      await migrator.prepare()
+      await migrator.migrateFiles(migrations, digg(this.getEnvironmentHandler(), "requireMigration"))
     })
   }
 }