velocious 1.0.92 → 1.0.94

package/src/logger.js

@@ -1,5 +1,10 @@
 import Configuration from "./configuration.js"
+import restArgsError from "./utils/rest-args-error.js"
 
+/**
+ * @param {string} message
+ * @returns {Promise<void>}
+ */
 function consoleLog(message) {
   return new Promise((resolve) => {
     if (process.stdout) {
@@ -10,6 +15,10 @@ function consoleLog(message) {
   })
 }
 
+/**
+ * @param {string} message
+ * @returns {Promise<void>}
+ */
 function consoleError(message) {
   return new Promise((resolve) => {
     if (process.stderr) {
@@ -20,6 +29,10 @@ function consoleError(message) {
   })
 }
 
+/**
+ * @param {string} message
+ * @returns {Promise<void>}
+ */
 function consoleWarn(message) {
   return new Promise((resolve) => {
     if (process.stderr) {
@@ -30,6 +43,9 @@ function consoleWarn(message) {
   })
 }
 
+/**
+ * @param {Array} messages
+ */
 function functionOrMessages(messages) {
   if (messages.length === 1 && typeof messages[0] == "function") {
     messages = messages[0]()
@@ -38,6 +54,11 @@ function functionOrMessages(messages) {
   return messages
 }
 
+/**
+ * Converts multiple message parts into a single string.
+ * @param {...any} messages - Parts to combine into a message
+ * @returns {string}
+ */
 function messagesToMessage(...messages) {
   let message = ""
 
@@ -59,8 +80,15 @@ function messagesToMessage(...messages) {
 }
 
 class Logger {
-  constructor(object, args) {
-    this._debug = args?.debug
+  /**
+   * @param {any} object
+   * @param {object} args
+   * @param {boolean} args.debug
+   */
+  constructor(object, {debug, ...restArgs} = {}) {
+    restArgsError(restArgs)
+
+    this._debug = debug
 
     if (typeof object == "string") {
       this._subject = object
@@ -85,20 +113,40 @@ class Logger {
     return this._configuration
   }
 
+  /**
+   * @param {...Parameters<typeof consoleLog>} messages - forwarded args
+   */
   async debug(...messages) {
     if (this._debug || this.getConfiguration()?.debug) {
       await this.log(...messages)
     }
   }
 
+  /**
+   * @param {...Parameters<typeof functionOrMessages>} messages - forwarded args
+   */
   async log(...messages) {
     await consoleLog(messagesToMessage(this._subject, ...functionOrMessages(messages)))
   }
 
+  /**
+   * @param {...Parameters<typeof functionOrMessages>} messages - forwarded args
+   */
   async error(...messages) {
     await consoleError(messagesToMessage(this._subject, ...functionOrMessages(messages)))
   }
 
+  /**
+   * @param {boolean} newValue
+   * @returns {void}
+   */
+  setDebug(newValue) {
+    this._debug = newValue
+  }
+
+  /**
+   * @param {...Parameters<typeof functionOrMessages>} messages - forwarded args
+   */
   async warn(...messages) {
     await consoleWarn(messagesToMessage(this._subject, ...functionOrMessages(messages)))
   }
@@ -106,6 +154,10 @@ class Logger {
 
 export {Logger}
 
+/**
+ * @param {any} object
+ * @param {...Parameters<typeof functionOrMessages>} messages - forwarded args
+ */
 export default async function logger(object, ...messages) {
   const className = object.constructor.name
   const configuration = object.configuration || Configuration.current()

package/src/routes/base-route.js

@@ -11,16 +11,28 @@ export function initBaseRoute() {
   VelociousBaseRoute = class VelociousBaseRoute {
     routes = []
 
-    get(name, args) {
-      const route = new GetRoute({name, args})
+    /**
+     * @param {string} name
+     */
+    get(name) {
+      const route = new GetRoute({name})
 
       this.routes.push(route)
     }
 
+    /**
+     * @interface
+     * @param {string} _path
+     */
     matchWithPath(_path) { // eslint-disable-line no-unused-vars
       throw new Error(`No 'matchWithPath' implemented on ${this.constructor.name}`)
     }
 
+    /**
+     * @param {string} name
+     * @param {function(NamespaceRoute) : void} callback
+     * @returns {void}
+     */
     namespace(name, callback) {
       const route = new NamespaceRoute({name})
 
@@ -31,12 +43,21 @@ export function initBaseRoute() {
       }
     }
 
-    post(name, args) {
-      const route = new PostRoute({name, args})
+    /**
+     * @param {string} name
+     * @returns {void}
+     */
+    post(name) {
+      const route = new PostRoute({name})
 
       this.routes.push(route)
     }
 
+    /**
+     * @param {string} name
+     * @param {function(ResourceRoute) : void} callback
+     * @returns {void}
+     */
     resources(name, callback) {
       const route = new ResourceRoute({name})
 

package/src/routes/get-route.js

@@ -1,11 +1,13 @@
 import BaseRoute, {initBaseRoute} from "./base-route.js"
 import escapeStringRegexp from "escape-string-regexp"
+import restArgsError from "../utils/rest-args-error.js"
 
 initBaseRoute()
 
 export default class VelociousRouteGetRoute extends BaseRoute {
-  constructor({name}) {
+  constructor({name, ...restArgs}) {
     super()
+    restArgsError(restArgs)
     this.name = name
     this.regExp = new RegExp(`^(${escapeStringRegexp(name)})(.*)$`)
   }

package/src/routes/namespace-route.js

@@ -1,11 +1,13 @@
+import restArgsError from "../utils/rest-args-error.js"
 import BaseRoute, {initBaseRoute} from "./base-route.js"
 import escapeStringRegexp from "escape-string-regexp"
 
 initBaseRoute()
 
 export default class VelociousRouteNamespaceRoute extends BaseRoute {
-  constructor({name}) {
+  constructor({name, ...restArgs}) {
     super()
+    restArgsError(restArgs)
     this.name = name
     this.regExp = new RegExp(`^(${escapeStringRegexp(name)})(.*)$`)
   }

package/src/routes/post-route.js

@@ -1,11 +1,13 @@
 import BaseRoute, {initBaseRoute} from "./base-route.js"
 import escapeStringRegexp from "escape-string-regexp"
+import restArgsError from "../utils/rest-args-error.js"
 
 initBaseRoute()
 
 export default class VelociousRoutePostRoute extends BaseRoute {
-  constructor({name}) {
+  constructor({name, ...restArgs}) {
     super()
+    restArgsError(restArgs)
     this.name = name
     this.regExp = new RegExp(`^(${escapeStringRegexp(name)})(.*)$`)
   }

package/src/routes/resource-route.js

@@ -1,11 +1,13 @@
 import BaseRoute, {initBaseRoute} from "./base-route.js"
 import escapeStringRegexp from "escape-string-regexp"
+import restArgsError from "../utils/rest-args-error.js"
 
 initBaseRoute()
 
 export default class VelociousRouteResourceRoute extends BaseRoute {
-  constructor({name}) {
+  constructor({name, ...restArgs}) {
     super()
+    restArgsError(restArgs)
     this.name = name
     this.regExp = new RegExp(`^(${escapeStringRegexp(name)})(.*)$`)
   }

package/src/utils/backtrace-cleaner.js

@@ -1,12 +1,22 @@
 export default class BacktraceCleaner {
+  /**
+   * @param {Error} error
+   * @returns {string}
+   */
   static getCleanedStack(error) {
     return new BacktraceCleaner(error).getCleanedStack()
   }
 
+  /**
+   * @param {Error} error
+   */
   constructor(error) {
     this.error = error
   }
 
+  /**
+   * @returns {string}
+   */
   getCleanedStack() {
     const backtrace = this.error.stack.split("\n")
 

package/src/database/drivers/mysql/connect-connection.js

@@ -1,12 +0,0 @@
-// Async function to connect a MySQL connection
-export default function connectConnection(connection) {
-  return new Promise((resolve, reject) => {
-    connection.connect((error) => {
-      if (error) {
-        reject(error)
-      } else {
-        resolve()
-      }
-    })
-  })
-}