velocious 1.0.449 → 1.0.450

package/build/utils/ransack.js

@@ -81,7 +81,7 @@ export function normalizeRansackGroup(modelClass, params) {
 
   /**
    * Normalized.
-    @type {RansackGroup} */
+   * @type {RansackGroup} */
   const normalized = {
     combinator: normalizeRansackCombinator(params.m, "and"),
     conditions: [],
@@ -154,7 +154,7 @@ function normalizeSimpleRansackCondition({key, modelClass, rawValue}) {
 function normalizeAdvancedRansackConditions({modelClass, value}) {
   /**
    * Conditions.
-    @type {RansackCondition[]} */
+   * @type {RansackCondition[]} */
   const conditions = []
 
   for (const entry of normalizeRansackCollection(value, "conditions")) {
@@ -174,7 +174,7 @@ function normalizeAdvancedRansackConditions({modelClass, value}) {
 
     const predicate = /**
                        * Narrows the runtime value to the documented type.
-                        @type {RansackPredicate} */ (predicateValue)
+                       * @type {RansackPredicate} */ (predicateValue)
     const rawValue = advancedRansackConditionValue({predicate, value: entry.v})
     const normalizedValue = normalizeRansackValue({predicate, value: rawValue})
 
@@ -203,7 +203,7 @@ function normalizeAdvancedRansackConditions({modelClass, value}) {
 function normalizeAdvancedRansackGroups({modelClass, value}) {
   /**
    * Groupings.
-    @type {RansackGroup[]} */
+   * @type {RansackGroup[]} */
   const groupings = []
 
   for (const entry of normalizeRansackCollection(value, "groupings")) {
@@ -286,7 +286,7 @@ function resolveRansackAttributesFromAdvancedValue({modelClass, value}) {
   const values = normalizeAdvancedAttributeValues(value)
   /**
    * Attributes.
-    @type {RansackAttribute[]} */
+   * @type {RansackAttribute[]} */
   const attributes = []
 
   for (const attributeValue of values) {
@@ -391,7 +391,7 @@ function modelClassAtPath({modelClass, path}) {
 function resolveRansackPath({modelClass, value}) {
   /**
    * Path.
-    @type {string[]} */
+   * @type {string[]} */
   const path = []
   let currentModelClass = modelClass
   let remainingValue = value
@@ -525,16 +525,16 @@ function resolveAttributeName({modelClass, value}) {
 function relationshipEntries(modelClass) {
   if (typeof /**
               * Narrows the runtime value to the documented type.
-               @type {?} */ (modelClass).getRelationshipsMap === "function") {
+              * @type {?} */ (modelClass).getRelationshipsMap === "function") {
     return backendRelationshipEntries(modelClass)
   }
 
   if (typeof /**
               * Narrows the runtime value to the documented type.
-               @type {?} */ (modelClass).relationshipDefinitions === "function" &&
+              * @type {?} */ (modelClass).relationshipDefinitions === "function" &&
     typeof /**
             * Narrows the runtime value to the documented type.
-             @type {?} */ (modelClass).relationshipModelClasses === "function") {
+            * @type {?} */ (modelClass).relationshipModelClasses === "function") {
     return frontendRelationshipEntries(modelClass)
   }
 
@@ -549,11 +549,11 @@ function relationshipEntries(modelClass) {
 function backendRelationshipEntries(modelClass) {
   /**
    * Entries.
-    @type {Record<string, {targetModelClass: RansackModelClass}>} */
+   * @type {Record<string, {targetModelClass: RansackModelClass}>} */
   const entries = {}
   const relationshipsMap = /**
                             * Narrows the runtime value to the documented type.
-                             @type {?} */ (modelClass).getRelationshipsMap()
+                            * @type {?} */ (modelClass).getRelationshipsMap()
 
   for (const relationshipName of Object.keys(relationshipsMap)) {
     const relationship = relationshipsMap[relationshipName]
@@ -578,14 +578,14 @@ function backendRelationshipEntries(modelClass) {
 function frontendRelationshipEntries(modelClass) {
   /**
    * Entries.
-    @type {Record<string, {targetModelClass: RansackModelClass}>} */
+   * @type {Record<string, {targetModelClass: RansackModelClass}>} */
   const entries = {}
   const definitions = /**
                        * Narrows the runtime value to the documented type.
-                        @type {?} */ (modelClass).relationshipDefinitions()
+                       * @type {?} */ (modelClass).relationshipDefinitions()
   const relationshipModelClasses = /**
                                     * Narrows the runtime value to the documented type.
-                                     @type {?} */ (modelClass).relationshipModelClasses()
+                                    * @type {?} */ (modelClass).relationshipModelClasses()
 
   for (const relationshipName of Object.keys(definitions)) {
     const targetModelClass = resolveFrontendModelClass(relationshipModelClasses[relationshipName])
@@ -606,23 +606,23 @@ function frontendRelationshipEntries(modelClass) {
 function attributeEntries(modelClass) {
   if (typeof /**
               * Narrows the runtime value to the documented type.
-               @type {?} */ (modelClass).getAttributeNameToColumnNameMap === "function") {
-    return /** Narrows the runtime value to the documented type. @type {Record<string, string>} */ ((/**
-                                                                                                      * Narrows the runtime value to the documented type.
-                                                                                                       @type {?} */ (modelClass).getAttributeNameToColumnNameMap()))
+              * @type {?} */ (modelClass).getAttributeNameToColumnNameMap === "function") {
+    return /** @type {Record<string, string>} */ ((/**
+                                                    * Narrows the runtime value to the documented type.
+                                                    * @type {?} */ (modelClass).getAttributeNameToColumnNameMap()))
   }
 
   const resourceConfig = typeof /**
                                  * Narrows the runtime value to the documented type.
-                                  @type {?} */ (modelClass).resourceConfig === "function"
+                                 * @type {?} */ (modelClass).resourceConfig === "function"
     ? /**
        * Narrows the runtime value to the documented type.
-        @type {?} */ (modelClass).resourceConfig()
+       * @type {?} */ (modelClass).resourceConfig()
     : {}
   const attributes = resourceConfig.attributes
   /**
    * Entries.
-    @type {Record<string, string>} */
+   * @type {Record<string, string>} */
   const entries = {}
 
   if (Array.isArray(attributes)) {
@@ -677,7 +677,7 @@ function parseRansackKey(key) {
       pathValue,
       predicate: /**
                   * Narrows the runtime value to the documented type.
-                   @type {RansackPredicate} */ (predicate)
+                  * @type {RansackPredicate} */ (predicate)
     }
   }
 
@@ -696,7 +696,7 @@ function parseRansackKey(key) {
       pathValue,
       predicate: /**
                   * Narrows the runtime value to the documented type.
-                   @type {RansackPredicate} */ (predicate)
+                  * @type {RansackPredicate} */ (predicate)
     }
   }
 
@@ -759,11 +759,11 @@ function normalizeRansackListValue(value) {
 
 /**
  * Ransack true values.
-  @type {Set<?>} */
+ * @type {Set<?>} */
 const ransackTrueValues = new Set([true, 1, "1", "true"])
 /**
  * Ransack false values.
-  @type {Set<?>} */
+ * @type {Set<?>} */
 const ransackFalseValues = new Set([false, 0, "0", "false"])
 
 /**
@@ -825,7 +825,7 @@ export function parseRansackSort(modelClass, sortString) {
 
   /**
    * Sorts.
-    @type {RansackSort[]} */
+   * @type {RansackSort[]} */
   const sorts = []
 
   for (const segment of segments) {

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

@@ -4,15 +4,15 @@ import {AsyncLocalStorage} from "node:async_hooks"
 
 /**
  * Defines asyncLocalStorage.
-  @type {import("node:async_hooks").AsyncLocalStorage<Array<string[]>> | undefined} */
+ * @type {import("node:async_hooks").AsyncLocalStorage<Array<string[]>> | undefined} */
 let asyncLocalStorage
 
 /**
  * Tracked stack global.
-  @type {{withTrackedStack?: {addTrackedStackToError: (error: Error) => void, withTrackedStack: (arg1: string | (() => Promise<?>), arg2?: (() => Promise<?>) | Error) => Promise<?>}}} */
+ * @type {{withTrackedStack?: {addTrackedStackToError: (error: Error) => void, withTrackedStack: (arg1: string | (() => Promise<?>), arg2?: (() => Promise<?>) | Error) => Promise<?>}}} */
 const trackedStackGlobal = /**
                             * Narrows the runtime value to the documented type.
-                             @type {?} */ (globalThis)
+                            * @type {?} */ (globalThis)
 
 if (AsyncLocalStorage) {
   asyncLocalStorage = new AsyncLocalStorage()
@@ -48,23 +48,23 @@ function addTrackedStackToError(error) {
 async function withTrackedStack(arg1, arg2) {
   /**
    * Defines callback.
-    @type {() => Promise<?>} */
+   * @type {() => Promise<?>} */
   let callback
 
   /**
    * Defines stack.
-    @type {string} */
+   * @type {string} */
   let stack
 
   if (typeof arg2 == "function" && typeof arg1 == "string") {
     callback = /**
                 * Narrows the runtime value to the documented type.
-                 @type {() => Promise<?>} */ (arg2)
+                * @type {() => Promise<?>} */ (arg2)
     stack = arg1
   } else {
     callback = /**
                 * Narrows the runtime value to the documented type.
-                 @type {() => Promise<?>} */ (arg1)
+                * @type {() => Promise<?>} */ (arg1)
     stack = Error().stack || ""
   }
 

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

@@ -2,10 +2,10 @@
 
 /**
  * Tracked stack global.
-  @type {{withTrackedStack?: {withTrackedStack?: (stack: string | undefined, fn: () => Promise<?>) => Promise<?>, addTrackedStackToError?: (error: Error) => void}}} */
+ * @type {{withTrackedStack?: {withTrackedStack?: (stack: string | undefined, fn: () => Promise<?>) => Promise<?>, addTrackedStackToError?: (error: Error) => void}}} */
 const trackedStackGlobal = /**
                             * Narrows the runtime value to the documented type.
-                             @type {?} */ (globalThis)
+                            * @type {?} */ (globalThis)
 
 /**
  * Runs add tracked stack to error.
@@ -25,7 +25,7 @@ async function withTrackedStack(stackOrCallback, callback) {
   const tracked = trackedStackGlobal.withTrackedStack?.withTrackedStack
   const resolvedCallback = callback ?? /**
                                         * Narrows the runtime value to the documented type.
-                                         @type {() => Promise<?>} */ (stackOrCallback)
+                                        * @type {() => Promise<?>} */ (stackOrCallback)
   const stack = typeof stackOrCallback == "string" ? stackOrCallback : undefined
 
   if (tracked) {

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "build/bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.449",
+  "version": "1.0.450",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [
@@ -98,6 +98,7 @@
     "esbuild": "^0.28.0",
     "eslint": "^10.0.1",
     "eslint-plugin-jsdoc": "^63.0.0",
+    "eslint-plugin-jsdoc-tag-lines": "^1.0.1",
     "fallow": "2.92.1",
     "globals": "^17.0.0",
     "mssql": "^12.0.0",

package/src/application.js

@@ -9,7 +9,7 @@ import restArgsError from "./utils/rest-args-error.js"
 
 /**
  * HttpServerConfiguration type.
-  @typedef {import("./configuration-types.js").HttpServerConfiguration} HttpServerConfiguration */
+ * @typedef {import("./configuration-types.js").HttpServerConfiguration} HttpServerConfiguration */
 
 export default class VelociousApplication {
   /**
@@ -28,14 +28,14 @@ export default class VelociousApplication {
 
     /**
      * Stores the http server configuration value.
-      @type {HttpServerConfiguration} */
+     * @type {HttpServerConfiguration} */
     this.httpServerConfiguration = httpServer ?? {}
 
     this.logger = new Logger(this)
     this._type = type
     /**
      * Stores the http server lock value.
-      @type {HttpServerLock | undefined} */
+     * @type {HttpServerLock | undefined} */
     this.httpServerLock = undefined
   }
 
@@ -121,7 +121,7 @@ export default class VelociousApplication {
       if (!configuration.getWebsocketEvents()) {
         configuration.setWebsocketEvents(/**
                                           * Types the following value.
-                                           @type {?} */ (websocketEventsHost))
+                                          * @type {?} */ (websocketEventsHost))
       }
 
       await configuration.connectBeacon({peerType: "server"})

package/src/authorization/ability.js

@@ -19,27 +19,27 @@
 export default class VelociousAuthorizationAbility {
   /**
    * Create.
-    @type {string[]} */
+   * @type {string[]} */
   static CREATE = ["create"]
 
   /**
    * Read.
-    @type {string[]} */
+   * @type {string[]} */
   static READ = ["read"]
 
   /**
    * Update.
-    @type {string[]} */
+   * @type {string[]} */
   static UPDATE = ["update"]
 
   /**
    * Destroy.
-    @type {string[]} */
+   * @type {string[]} */
   static DESTROY = ["destroy"]
 
   /**
    * Crud.
-    @type {string[]} */
+   * @type {string[]} */
   static CRUD = ["create", "read", "update", "destroy"]
 
   /**
@@ -56,12 +56,12 @@ export default class VelociousAuthorizationAbility {
 
     /**
      * Narrows the runtime value to the documented type.
-      @type {AbilityRuleType[]} */
+     * @type {AbilityRuleType[]} */
     this.rules = []
 
     /**
      * Narrows the runtime value to the documented type.
-      @type {Record<string, boolean>} */
+     * @type {Record<string, boolean>} */
     this.loadedModelClassAbilities = {}
   }
 
@@ -78,7 +78,7 @@ export default class VelociousAuthorizationAbility {
 
     /**
      * Resolved.
-      @type {Array<typeof import("./base-resource.js").default>} */
+     * @type {Array<typeof import("./base-resource.js").default>} */
     const resolved = []
     const backendProjects = configuration.getBackendProjects()
 

package/src/authorization/base-resource.js

@@ -4,7 +4,7 @@
 export default class AuthorizationBaseResource {
   /**
    * Model class.
-    @type {typeof import("../database/record/index.js").default | undefined} */
+   * @type {typeof import("../database/record/index.js").default | undefined} */
   static ModelClass = undefined
 
   /**
@@ -37,7 +37,7 @@ export default class AuthorizationBaseResource {
    */
   can(actions, conditions) {
     this.assertResourceConditionsSignature({conditions, methodName: "can"})
-    this.requiredAbility().can(actions, this.requiredModelClass(), /** Narrows conditions to the runtime resource model class. @type {import("./ability.js").AbilityConditionsType<typeof import("../database/record/index.js").default> | undefined} */ (conditions))
+    this.requiredAbility().can(actions, this.requiredModelClass(), /** @type {import("./ability.js").AbilityConditionsType<typeof import("../database/record/index.js").default> | undefined} */ (conditions))
   }
 
   /**
@@ -49,7 +49,7 @@ export default class AuthorizationBaseResource {
    */
   cannot(actions, conditions) {
     this.assertResourceConditionsSignature({conditions, methodName: "cannot"})
-    this.requiredAbility().cannot(actions, this.requiredModelClass(), /** Narrows conditions to the runtime resource model class. @type {import("./ability.js").AbilityConditionsType<typeof import("../database/record/index.js").default> | undefined} */ (conditions))
+    this.requiredAbility().cannot(actions, this.requiredModelClass(), /** @type {import("./ability.js").AbilityConditionsType<typeof import("../database/record/index.js").default> | undefined} */ (conditions))
   }
 
   /**
@@ -71,7 +71,7 @@ export default class AuthorizationBaseResource {
   requiredModelClass() {
     const modelClass = /**
                         * Narrows the runtime value to the documented type.
-                         @type {typeof AuthorizationBaseResource} */ (this.constructor).modelClass()
+                        * @type {typeof AuthorizationBaseResource} */ (this.constructor).modelClass()
 
     if (!modelClass) {
       throw new Error(`${this.constructor.name} must define static ModelClass before calling ability helpers.`)

package/src/background-jobs/cron-expression.js

@@ -62,7 +62,7 @@ export function parseCronExpression(expression) {
   const trimmed = expression.trim().toLowerCase()
   const expanded = SHORTCUTS[/**
                               * Narrows the runtime value to the documented type.
-                               @type {keyof typeof SHORTCUTS} */ (trimmed)] || trimmed
+                              * @type {keyof typeof SHORTCUTS} */ (trimmed)] || trimmed
   const fields = expanded.split(/\s+/)
 
   if (fields.length !== 5) {

package/src/background-jobs/forked-runner-child.js

@@ -14,7 +14,7 @@ function isJobMessage(message) {
 
   const messageRecord = /**
                          * Narrows the runtime value to the documented type.
-                          @type {{type?: ?, payload?: ?}} */ (message)
+                         * @type {{type?: ?, payload?: ?}} */ (message)
 
   return messageRecord.type === "job" && Object.hasOwn(messageRecord, "payload")
 }

package/src/background-jobs/job-registry.js

@@ -15,7 +15,7 @@ export default class BackgroundJobRegistry {
     this.configuration = configuration
     /**
      * Narrows the runtime value to the documented type.
-      @type {Map<string, typeof VelociousJob>} */
+     * @type {Map<string, typeof VelociousJob>} */
     this.jobsByName = new Map()
   }
 

package/src/background-jobs/job-runner.js

@@ -65,7 +65,7 @@ export default async function runJobPayload(payload) {
   const jobInstance = new JobClass()
   /**
    * Perform.
-    @type {(...args: Array<?>) => Promise<void>} */
+   * @type {(...args: Array<?>) => Promise<void>} */
   const perform = jobInstance.perform
 
   try {

package/src/background-jobs/job.js

@@ -60,7 +60,7 @@ export default class VelociousJob {
     if (isOptionsArg) {
       const {jobOptions} = /**
                             * Narrows the runtime value to the documented type.
-                             @type {{jobOptions: import("./types.js").BackgroundJobOptions}} */ (lastArg)
+                            * @type {{jobOptions: import("./types.js").BackgroundJobOptions}} */ (lastArg)
       return {jobArgs: args.slice(0, -1), jobOptions: jobOptions || {}}
     }
 

package/src/background-jobs/json-socket.js

@@ -12,19 +12,19 @@ export default class JsonSocket extends EventEmitter {
     this.socket = socket
     /**
      * Narrows the runtime value to the documented type.
-      @type {string | undefined} */
+     * @type {string | undefined} */
     this.workerId = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {boolean} */
+     * @type {boolean} */
     this.acceptsSpawnedJobs = true
     /**
      * Narrows the runtime value to the documented type.
-      @type {boolean} */
+     * @type {boolean} */
     this.acceptsForkedJobs = true
     /**
      * Narrows the runtime value to the documented type.
-      @type {boolean} */
+     * @type {boolean} */
     this.acceptsInlineJobs = true
     this.buffer = ""
     this.socket.setEncoding("utf8")

package/src/background-jobs/main.js

@@ -29,7 +29,7 @@ const MAX_TIMER_MS = 2_147_483_647 // ~24.8 days
  */
 /**
  * Worker execution mode capabilities.
-  @type {WorkerExecutionModeCapability[]} */
+ * @type {WorkerExecutionModeCapability[]} */
 const WORKER_EXECUTION_MODE_CAPABILITIES = [
   {executionMode: "inline", accepts: (worker) => worker.acceptsInlineJobs !== false},
   {executionMode: "forked", accepts: (worker) => worker.acceptsForkedJobs !== false},
@@ -58,50 +58,50 @@ export default class BackgroundJobsMain {
     this.logger = new Logger(this)
     /**
      * Narrows the runtime value to the documented type.
-      @type {Set<JsonSocket>} */
+     * @type {Set<JsonSocket>} */
     this.workers = new Set()
     /**
      * Narrows the runtime value to the documented type.
-      @type {Set<JsonSocket>} */
+     * @type {Set<JsonSocket>} */
     this.readyWorkers = new Set()
     /**
      * Narrows the runtime value to the documented type.
-      @type {net.Server | undefined} */
+     * @type {net.Server | undefined} */
     this.server = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {NodeJS.Timeout | undefined} */
+     * @type {NodeJS.Timeout | undefined} */
     this._pollTimer = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {NodeJS.Timeout | undefined} */
+     * @type {NodeJS.Timeout | undefined} */
     this._scheduledTimer = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {NodeJS.Timeout | undefined} */
+     * @type {NodeJS.Timeout | undefined} */
     this._errorRetryTimer = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {NodeJS.Timeout | undefined} */
+     * @type {NodeJS.Timeout | undefined} */
     this._orphanTimer = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {BackgroundJobsScheduler | undefined} */
+     * @type {BackgroundJobsScheduler | undefined} */
     this.scheduler = undefined
     this._draining = false
     this._redrainQueued = false
     this._stopped = false
     /**
      * Narrows the runtime value to the documented type.
-      @type {(() => void) | undefined} */
+     * @type {(() => void) | undefined} */
     this._unsubscribeBeacon = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {((...args: Array<?>) => void) | undefined} */
+     * @type {((...args: Array<?>) => void) | undefined} */
     this._beaconConnectHandler = undefined
     /**
      * Narrows the runtime value to the documented type.
-      @type {import("../beacon/client.js").default | import("../beacon/in-process-client.js").default | undefined} */
+     * @type {import("../beacon/client.js").default | import("../beacon/in-process-client.js").default | undefined} */
     this._beaconClient = undefined
   }
 
@@ -178,7 +178,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs close workers.
-    @returns {void} */
+   * @returns {void} */
   _closeWorkers() {
     for (const worker of this.workers) {
       worker.close()
@@ -187,7 +187,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs clear timers.
-    @returns {void} */
+   * @returns {void} */
   _clearTimers() {
     if (this._pollTimer) clearInterval(this._pollTimer)
     if (this._scheduledTimer) clearTimeout(this._scheduledTimer)
@@ -201,7 +201,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs disconnect beacon handlers.
-    @returns {void} */
+   * @returns {void} */
   _disconnectBeaconHandlers() {
     if (this._unsubscribeBeacon) {
       this._unsubscribeBeacon()
@@ -217,7 +217,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs stop beacon and server.
-    @returns {Promise<void>} */
+   * @returns {Promise<void>} */
   async _stopBeaconAndServer() {
     try {
       await this.configuration.disconnectBeacon()
@@ -228,7 +228,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs close server and database connections.
-    @returns {Promise<void>} */
+   * @returns {Promise<void>} */
   async _closeServerAndDatabaseConnections() {
     try {
       await this._closeServer()
@@ -239,7 +239,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs close server.
-    @returns {Promise<void>} */
+   * @returns {Promise<void>} */
   async _closeServer() {
     if (!this.server) return
 
@@ -327,7 +327,7 @@ export default class BackgroundJobsMain {
     const jsonSocket = new JsonSocket(socket)
     /**
      * Role.
-      @type {import("./types.js").BackgroundJobSocketRole | null} */
+     * @type {import("./types.js").BackgroundJobSocketRole | null} */
     let role = null
 
     const cleanup = () => {
@@ -697,7 +697,7 @@ export default class BackgroundJobsMain {
 
   /**
    * Runs clear error retry timer.
-    @returns {void} */
+   * @returns {void} */
   _clearErrorRetryTimer() {
     if (this._errorRetryTimer) {
       clearTimeout(this._errorRetryTimer)
@@ -839,7 +839,7 @@ export default class BackgroundJobsMain {
       this._addAcceptedExecutionModes({executionModes, worker})
     }
 
-    return /** Narrows the runtime value to the documented type. @type {import("./types.js").BackgroundJobExecutionMode[]} */ ([...executionModes])
+    return /** @type {import("./types.js").BackgroundJobExecutionMode[]} */ ([...executionModes])
   }
 
   /**