velocious 1.0.463 → 1.0.465

package/build/src/jobs/mail-delivery.d.ts

@@ -1,13 +1,9 @@
 /**
  * Background job for delivering mailer payloads.
+ * @augments {VelociousJob<[import("../mailer.js").MailerDeliveryPayload]>}
  */
-export default class MailDeliveryJob extends VelociousJob {
-    /**
-     * Runs perform.
-     * @param {import("../mailer.js").MailerDeliveryPayload} [payload] - Mail delivery payload.
-     * @returns {Promise<void>} - Resolves when complete.
-     */
-    perform(payload?: import("../mailer.js").MailerDeliveryPayload): Promise<void>;
+export default class MailDeliveryJob extends VelociousJob<[import("../mailer.js").MailerDeliveryPayload]> {
+    constructor();
 }
 import VelociousJob from "../background-jobs/job.js";
 //# sourceMappingURL=mail-delivery.d.ts.map

package/build/src/jobs/mail-delivery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mail-delivery.d.ts","sourceRoot":"","sources":["../../../src/jobs/mail-delivery.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IACE;;;;OAIG;IACH,kBAHW,OAAO,cAAc,EAAE,qBAAqB,GAC1C,OAAO,CAAC,IAAI,CAAC,CAQzB;CACF;yBAnBwB,2BAA2B"}
+{"version":3,"file":"mail-delivery.d.ts","sourceRoot":"","sources":["../../../src/jobs/mail-delivery.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;;CASC;yBAhBwB,2BAA2B"}

package/build/src/jobs/mail-delivery.js

@@ -3,18 +3,16 @@ import VelociousJob from "../background-jobs/job.js";
 import { deliverPayload } from "../mailer.js";
 /**
  * Background job for delivering mailer payloads.
+ * @augments {VelociousJob<[import("../mailer.js").MailerDeliveryPayload]>}
  */
 export default class MailDeliveryJob extends VelociousJob {
     /**
      * Runs perform.
-     * @param {import("../mailer.js").MailerDeliveryPayload} [payload] - Mail delivery payload.
+     * @param {import("../mailer.js").MailerDeliveryPayload} payload - Mail delivery payload.
      * @returns {Promise<void>} - Resolves when complete.
      */
     async perform(payload) {
-        if (!payload) {
-            throw new Error(`Missing mail delivery payload. Got: ${String(payload)}`);
-        }
         await deliverPayload(payload);
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFpbC1kZWxpdmVyeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9qb2JzL21haWwtZGVsaXZlcnkuanMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsWUFBWTtBQUVaLE9BQU8sWUFBWSxNQUFNLDJCQUEyQixDQUFBO0FBQ3BELE9BQU8sRUFBQyxjQUFjLEVBQUMsTUFBTSxjQUFjLENBQUE7QUFFM0M7O0dBRUc7QUFDSCxNQUFNLENBQUMsT0FBTyxPQUFPLGVBQWdCLFNBQVEsWUFBWTtJQUN2RDs7OztPQUlHO0lBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFPO1FBQ25CLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNiLE1BQU0sSUFBSSxLQUFLLENBQUMsdUNBQXVDLE1BQU0sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUE7UUFDM0UsQ0FBQztRQUVELE1BQU0sY0FBYyxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQy9CLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbIi8vIEB0cy1jaGVja1xuXG5pbXBvcnQgVmVsb2Npb3VzSm9iIGZyb20gXCIuLi9iYWNrZ3JvdW5kLWpvYnMvam9iLmpzXCJcbmltcG9ydCB7ZGVsaXZlclBheWxvYWR9IGZyb20gXCIuLi9tYWlsZXIuanNcIlxuXG4vKipcbiAqIEJhY2tncm91bmQgam9iIGZvciBkZWxpdmVyaW5nIG1haWxlciBwYXlsb2Fkcy5cbiAqL1xuZXhwb3J0IGRlZmF1bHQgY2xhc3MgTWFpbERlbGl2ZXJ5Sm9iIGV4dGVuZHMgVmVsb2Npb3VzSm9iIHtcbiAgLyoqXG4gICAqIFJ1bnMgcGVyZm9ybS5cbiAgICogQHBhcmFtIHtpbXBvcnQoXCIuLi9tYWlsZXIuanNcIikuTWFpbGVyRGVsaXZlcnlQYXlsb2FkfSBbcGF5bG9hZF0gLSBNYWlsIGRlbGl2ZXJ5IHBheWxvYWQuXG4gICAqIEByZXR1cm5zIHtQcm9taXNlPHZvaWQ+fSAtIFJlc29sdmVzIHdoZW4gY29tcGxldGUuXG4gICAqL1xuICBhc3luYyBwZXJmb3JtKHBheWxvYWQpIHtcbiAgICBpZiAoIXBheWxvYWQpIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcihgTWlzc2luZyBtYWlsIGRlbGl2ZXJ5IHBheWxvYWQuIEdvdDogJHtTdHJpbmcocGF5bG9hZCl9YClcbiAgICB9XG5cbiAgICBhd2FpdCBkZWxpdmVyUGF5bG9hZChwYXlsb2FkKVxuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFpbC1kZWxpdmVyeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9qb2JzL21haWwtZGVsaXZlcnkuanMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsWUFBWTtBQUVaLE9BQU8sWUFBWSxNQUFNLDJCQUEyQixDQUFBO0FBQ3BELE9BQU8sRUFBQyxjQUFjLEVBQUMsTUFBTSxjQUFjLENBQUE7QUFFM0M7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE9BQU8sT0FBTyxlQUFnQixTQUFRLFlBQVk7SUFDdkQ7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBTztRQUNuQixNQUFNLGNBQWMsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUMvQixDQUFDO0NBQ0YiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBAdHMtY2hlY2tcblxuaW1wb3J0IFZlbG9jaW91c0pvYiBmcm9tIFwiLi4vYmFja2dyb3VuZC1qb2JzL2pvYi5qc1wiXG5pbXBvcnQge2RlbGl2ZXJQYXlsb2FkfSBmcm9tIFwiLi4vbWFpbGVyLmpzXCJcblxuLyoqXG4gKiBCYWNrZ3JvdW5kIGpvYiBmb3IgZGVsaXZlcmluZyBtYWlsZXIgcGF5bG9hZHMuXG4gKiBAYXVnbWVudHMge1ZlbG9jaW91c0pvYjxbaW1wb3J0KFwiLi4vbWFpbGVyLmpzXCIpLk1haWxlckRlbGl2ZXJ5UGF5bG9hZF0+fVxuICovXG5leHBvcnQgZGVmYXVsdCBjbGFzcyBNYWlsRGVsaXZlcnlKb2IgZXh0ZW5kcyBWZWxvY2lvdXNKb2Ige1xuICAvKipcbiAgICogUnVucyBwZXJmb3JtLlxuICAgKiBAcGFyYW0ge2ltcG9ydChcIi4uL21haWxlci5qc1wiKS5NYWlsZXJEZWxpdmVyeVBheWxvYWR9IHBheWxvYWQgLSBNYWlsIGRlbGl2ZXJ5IHBheWxvYWQuXG4gICAqIEByZXR1cm5zIHtQcm9taXNlPHZvaWQ+fSAtIFJlc29sdmVzIHdoZW4gY29tcGxldGUuXG4gICAqL1xuICBhc3luYyBwZXJmb3JtKHBheWxvYWQpIHtcbiAgICBhd2FpdCBkZWxpdmVyUGF5bG9hZChwYXlsb2FkKVxuICB9XG59XG4iXX0=

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "build/bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.463",
+  "version": "1.0.465",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [
@@ -101,7 +101,7 @@
     "eslint-plugin-jsdoc": "^63.0.0",
     "eslint-plugin-jsdoc-inline-type-casts": "https://github.com/kaspernj/eslint-plugin-jsdoc-inline-type-casts/archive/refs/heads/master.tar.gz",
     "eslint-plugin-jsdoc-tag-lines": "^1.0.1",
-    "fallow": "2.92.1",
+    "fallow": "2.98.0",
     "globals": "^17.0.0",
     "mssql": "^12.0.0",
     "mysql": "^2.18.1",

package/src/background-jobs/job.js

@@ -2,6 +2,16 @@
 
 import BackgroundJobsClient from "./client.js"
 
+/**
+ * Base class for background jobs.
+ *
+ * `TArgs` is the tuple of arguments the subclass's `perform` accepts, so a job that
+ * needs arguments declares them as required and typed — for example
+ * `class RunBuildJob extends VelociousJob<[string]>` with `async perform(buildId)`.
+ * The default empty tuple keeps argument-less jobs (`extends VelociousJob`,
+ * `async perform()`) working unchanged.
+ * @template {Array<?>} [TArgs=[]]
+ */
 export default class VelociousJob {
   /**
    * Runs job name.
@@ -67,9 +77,10 @@ export default class VelociousJob {
 
   /**
    * Override in subclasses.
+   * @param {TArgs} _args - Job args (the tuple this job class was parameterized with).
    * @returns {Promise<void>} - Resolves when complete.
    */
-  async perform() {
+  async perform(..._args) {
     throw new Error("perform not implemented")
   }
 }

package/src/frontend-models/base.js

@@ -4254,7 +4254,7 @@ export default class FrontendModelBase {
    * @param {string | number | null} [args.memberId] - Optional member id for member-scoped commands.
    * @param {Record<string, ?>} args.payload - Request payload.
    * @param {string} args.resourcePath - Direct resource path.
-   * @returns {Promise<Record<string, ?>>} - Decoded response payload.
+   * @returns {Promise<Record<string, FrontendModelAttributeValue>>} - Decoded response payload.
    */
   static async executeCustomCommand({commandName, commandType, memberId = null, payload, resourcePath}) {
     const serializedPayload = /** @type {Record<string, ?>} */ (serializeFrontendModelTransportValue(payload))
@@ -4279,7 +4279,7 @@ export default class FrontendModelBase {
       scheduleSharedFrontendModelRequestFlush()
     })
 
-    const decodedBatchResponse = /** @type {Record<string, ?>} */ (batchResponse)
+    const decodedBatchResponse = /** @type {Record<string, FrontendModelAttributeValue>} */ (batchResponse)
 
     this.throwOnErrorFrontendModelResponse({
       commandType,

package/src/jobs/mail-delivery.js

@@ -5,18 +5,15 @@ import {deliverPayload} from "../mailer.js"
 
 /**
  * Background job for delivering mailer payloads.
+ * @augments {VelociousJob<[import("../mailer.js").MailerDeliveryPayload]>}
  */
 export default class MailDeliveryJob extends VelociousJob {
   /**
    * Runs perform.
-   * @param {import("../mailer.js").MailerDeliveryPayload} [payload] - Mail delivery payload.
+   * @param {import("../mailer.js").MailerDeliveryPayload} payload - Mail delivery payload.
    * @returns {Promise<void>} - Resolves when complete.
    */
   async perform(payload) {
-    if (!payload) {
-      throw new Error(`Missing mail delivery payload. Got: ${String(payload)}`)
-    }
-
     await deliverPayload(payload)
   }
 }