velocious 1.0.106 → 1.0.108

package/src/environment-handlers/node/cli/commands/generate/model.js

@@ -3,9 +3,13 @@ import fileExists from "../../../../../utils/file-exists.js"
 import fs from "fs/promises"
 import * as inflection from "inflection"
 
+/**
+ * @typedef {{date: Date, modelContent: string, modelName: string, modelNameCamelized: string, modelPath: string}} DbGenerateModelResult
+ */
+
 export default class DbGenerateModel extends BaseCommand {
   /**
-   * @returns {Promise<void>}
+   * @returns {Promise<void | DbGenerateModelResult>}
    */
   async execute() {
     const modelName = this.processArgs[1]

package/src/environment-handlers/node/cli/commands/init.js

@@ -2,9 +2,13 @@ import BaseCommand from "../../../../cli/base-command.js"
 import fileExists from "../../../../utils/file-exists.js"
 import fs from "fs/promises"
 
+/**
+ * @typedef {{source: string, target: string}} FileMappingType
+ */
+
 export default class VelociousCliCommandsInit extends BaseCommand {
   /**
-   * @returns {Promise<void>}
+   * @returns {Promise<void | {fileMappings: FileMappingType[]}>}
    */
   async execute() {
     const velociousPath = await this.getEnvironmentHandler().getVelociousPath()

package/src/environment-handlers/node.js

@@ -115,7 +115,7 @@ export default class VelociousEnvironmentHandlerNode extends Base{
   /**
    * @param {object} args
    * @param {string[]} args.commandParts
-   * @returns {Promise<import ("../cli/base-command.js").default>}
+   * @returns {Promise<typeof import ("../cli/base-command.js").default>}
    */
   async requireCommand({commandParts}) {
     const commands = await this.findCommands()

package/src/http-server/client/index.js

@@ -46,7 +46,8 @@ export default class VeoliciousHttpServerClient {
   }
 
   /**
-   * @param {string} data
+   * @param {Buffer} data
+   * @returns {void}
    */
   onWrite(data) {
     if (this.state == "initial") {

package/src/http-server/client/params-to-object.js

@@ -36,21 +36,17 @@ export default class ParamsToObject {
       let newResult
 
       if (inputName in result) {
-        // @ts-expect-error
         newResult = result[inputName]
       } else if (rest == "[]") {
         newResult = []
-        // @ts-expect-error
         result[inputName] = newResult
       } else {
         newResult = {}
-        // @ts-expect-error
         result[inputName] = newResult
       }
 
       this.treatSecond(value, rest, newResult)
     } else {
-      // @ts-expect-error
       result[key] = value
     }
   }
@@ -74,19 +70,15 @@ export default class ParamsToObject {
     if (rest == "[]") {
       result.push(value)
     } else if (newRest == "") {
-      // @ts-expect-error
       result[key] = value
     } else {
       if (typeof result == "object" && key in result) {
-        // @ts-expect-error
         newResult = result[key]
       } else if (newRest == "[]") {
         newResult = []
-        // @ts-expect-error
         result[key] = newResult
       } else {
         newResult = {}
-        // @ts-expect-error
         result[key] = newResult
       }
 

package/src/http-server/client/request-buffer/index.js

@@ -334,6 +334,7 @@ export default class RequestBuffer {
 
   parseQueryStringPostParams() {
     if (this.postBody) {
+      /** @type {Record<string, any>} */
       const unparsedParams = querystring.parse(this.postBody)
       const paramsToObject = new ParamsToObject(unparsedParams)
       const newParams = paramsToObject.toObject()

package/src/routes/basic-route.js

@@ -57,7 +57,7 @@ export default class VelociousBasicRoute extends BaseRoute {
 
   /**
    * @param {string} name
-   * @param {function(import("./resource-route.js").default) : void} callback
+   * @param {function(import("./resource-route.js").default) : void} [callback]
    * @returns {void}
    */
   resources(name, callback) {

package/src/routes/namespace-route.js

@@ -2,7 +2,7 @@
 
 import restArgsError from "../utils/rest-args-error.js"
 import BaseRoute from "./base-route.js"
-import BasicRoute from "./base-route.js"
+import BasicRoute from "./basic-route.js"
 import escapeStringRegexp from "escape-string-regexp"
 
 class VelociousRouteNamespaceRoute extends BasicRoute {

package/src/testing/test-files-finder.js

@@ -13,7 +13,7 @@ export default class TestFilesFinder {
   /**
    * @param {object} args
    * @param {string} args.directory
-   * @param {string[]} args.directories
+   * @param {string[]} [args.directories]
    * @param {string[]} args.processArgs
    */
   constructor({directory, directories, processArgs, ...restArgs}) {

package/src/testing/test-runner.js

@@ -11,6 +11,9 @@ import {tests} from "./test.js"
  * @typedef {object} TestArgs
  * @property {Application} [application]
  * @property {RequestClient} [client]
+ * @property {object} [databaseCleaning]
+ * @property {boolean} [databaseCleaning.transaction]
+ * @property {boolean} [databaseCleaning.truncate]
  * @property {boolean} [focus]
  * @property {() => Promise<void>} [function]
  * @property {string} [type]

package/src/testing/test.js

@@ -412,7 +412,6 @@ function it(description, arg1, arg2) {
   let testFunction
 
   if (typeof arg1 == "function") {
-    // @ts-expect-error
     testFunction = arg1
     testArgs = {}
   } else if (typeof arg2 == "function") {
@@ -440,7 +439,6 @@ function fit(description, arg1, arg2) {
   let testFunction
 
   if (typeof arg1 == "function") {
-    // @ts-expect-error
     testFunction = arg1
     testArgs = {focus: true}
   } else if (typeof arg2 == "function") {

package/src/utils/with-tracked-stack-async-hooks.js

@@ -76,11 +76,9 @@ async function withTrackedStack(arg1, arg2) {
   })
 }
 
-// @ts-expect-error
 if (globalThis.withTrackedStack) {
   console.warn("globalThis.withTrackedStack was already defined")
 } else {
-  // @ts-expect-error
   globalThis.withTrackedStack = {addTrackedStackToError, withTrackedStack}
 }
 

package/src/utils/with-tracked-stack.js

@@ -2,7 +2,6 @@
 
 /** @param {Error} error */
 function addTrackedStackToError(error) {
-  // @ts-expect-error
   globalThis.withTrackedStack?.addTrackedStackToError(error)
 }
 
@@ -11,7 +10,6 @@ function addTrackedStackToError(error) {
  * @returns {Promise<any>}
  */
 async function withTrackedStack(...args) {
-  // @ts-expect-error
   const withTrackedStack = globalThis.withTrackedStack?.withTrackedStack
 
   let callback

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+
+    "noEmit": true,
+    "target": "ES2024",
+
+    "moduleResolution": "nodenext",
+    "module": "nodenext",
+
+    "lib": ["dom", "ES2024"],
+    "types": ["node"]
+  },
+  "exclude": ["src/templates/**"]
+}