@warlock.js/queue 5.13.0 → 5.15.0

package/esm/notifications/queue-notification-dispatcher.mjs

@@ -1,67 +0,0 @@
-import { toMilliseconds } from "../duration.mjs";
-import { defineJob } from "../define-job.mjs";
-import { UnrecoverableError } from "bullmq";
-import { getNotificationConfig } from "@warlock.js/notifications";
-
-//#region ../queue/src/notifications/queue-notification-dispatcher.ts
-/**
-* BullMQ-backed `QueueDispatcher` for `@warlock.js/notifications`.
-*
-* Notifications renders the payload and resolves the route BEFORE handing a
-* job to its dispatcher, so the job (`{ channel, route, payload, options }`)
-* is plain JSON. This adapter enqueues it as a queue job; the job's handler,
-* running in any worker process, looks the channel up by name in that
-* process's notifications config and calls `channel.send`.
-*
-* Notifications itself has no dependency on this package.
-*/
-/** The job name notification deliveries run under. */
-const NOTIFICATION_JOB_NAME = "warlock.notifications.deliver";
-/**
-* Create the dispatcher for `NotificationConfig.queue`.
-*
-* - `SendOptions.delay` is honoured: a number is SECONDS (notifications'
-*   convention), a string is a duration such as `"10m"`.
-* - A failing `channel.send` throws, so the delivery is retried per
-*   `attempts` / `backoff` and ends in `failedJobs()` when exhausted.
-* - A channel missing from the worker's notifications config fails at once,
-*   without retries.
-*
-* @example src/config/notifications.ts
-* import { queueNotificationDispatcher } from "@warlock.js/queue/notifications";
-*
-* const config: NotificationConfig = {
-*   channels: { mail: mailChannel() },
-*   queue: queueNotificationDispatcher({ attempts: 3, backoff: { type: "exponential", delay: 5000 } }),
-* };
-*/
-function queueNotificationDispatcher(options = {}) {
-	const deliver = defineNotificationJob(options);
-	return { async dispatch(job) {
-		await deliver.dispatch(job, { delay: job.options.delay === void 0 ? void 0 : notificationDelay(job.options.delay) });
-	} };
-}
-function defineNotificationJob(options) {
-	return defineJob({
-		name: NOTIFICATION_JOB_NAME,
-		queue: options.queue,
-		attempts: options.attempts,
-		backoff: options.backoff,
-		async handle(job) {
-			const channel = getNotificationConfig().channels[job.channel];
-			if (!channel) throw new UnrecoverableError(`Notification channel "${job.channel}" is not configured in this worker's notifications config.`);
-			await channel.send({
-				payload: job.payload,
-				route: job.route,
-				options: job.options
-			});
-		}
-	});
-}
-function notificationDelay(delay) {
-	return typeof delay === "number" ? delay * 1e3 : toMilliseconds(delay);
-}
-
-//#endregion
-export { NOTIFICATION_JOB_NAME, queueNotificationDispatcher };
-//# sourceMappingURL=queue-notification-dispatcher.mjs.map

package/esm/notifications/queue-notification-dispatcher.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"queue-notification-dispatcher.mjs","names":[],"sources":["../../../../../../../queue/src/notifications/queue-notification-dispatcher.ts"],"sourcesContent":["/**\n * BullMQ-backed `QueueDispatcher` for `@warlock.js/notifications`.\n *\n * Notifications renders the payload and resolves the route BEFORE handing a\n * job to its dispatcher, so the job (`{ channel, route, payload, options }`)\n * is plain JSON. This adapter enqueues it as a queue job; the job's handler,\n * running in any worker process, looks the channel up by name in that\n * process's notifications config and calls `channel.send`.\n *\n * Notifications itself has no dependency on this package.\n */\nimport { getNotificationConfig, type QueueDispatcher } from \"@warlock.js/notifications\";\nimport { UnrecoverableError } from \"bullmq\";\nimport { defineJob } from \"../define-job\";\nimport { toMilliseconds } from \"../duration\";\nimport type { Duration, JobBackoff, QueueJob } from \"../types\";\n\n/** The job name notification deliveries run under. */\nexport const NOTIFICATION_JOB_NAME = \"warlock.notifications.deliver\";\n\nexport type NotificationJobPayload = Parameters<QueueDispatcher[\"dispatch\"]>[0];\n\nexport type QueueNotificationDispatcherOptions = {\n  /** Queue to deliver on. Default: the default queue. */\n  queue?: string;\n  /** Attempts per delivery. Default: `queue.defaultJobOptions.attempts`, else `1`. */\n  attempts?: number;\n  /** Backoff between attempts. */\n  backoff?: JobBackoff;\n};\n\n/**\n * Create the dispatcher for `NotificationConfig.queue`.\n *\n * - `SendOptions.delay` is honoured: a number is SECONDS (notifications'\n *   convention), a string is a duration such as `\"10m\"`.\n * - A failing `channel.send` throws, so the delivery is retried per\n *   `attempts` / `backoff` and ends in `failedJobs()` when exhausted.\n * - A channel missing from the worker's notifications config fails at once,\n *   without retries.\n *\n * @example src/config/notifications.ts\n * import { queueNotificationDispatcher } from \"@warlock.js/queue/notifications\";\n *\n * const config: NotificationConfig = {\n *   channels: { mail: mailChannel() },\n *   queue: queueNotificationDispatcher({ attempts: 3, backoff: { type: \"exponential\", delay: 5000 } }),\n * };\n */\nexport function queueNotificationDispatcher(\n  options: QueueNotificationDispatcherOptions = {},\n): QueueDispatcher {\n  const deliver = defineNotificationJob(options);\n\n  return {\n    async dispatch(job) {\n      await deliver.dispatch(job, {\n        delay: job.options.delay === undefined ? undefined : notificationDelay(job.options.delay),\n      });\n    },\n  };\n}\n\nfunction defineNotificationJob(\n  options: QueueNotificationDispatcherOptions,\n): QueueJob<NotificationJobPayload, void> {\n  return defineJob<NotificationJobPayload, void>({\n    name: NOTIFICATION_JOB_NAME,\n    queue: options.queue,\n    attempts: options.attempts,\n    backoff: options.backoff,\n    async handle(job) {\n      const channels = getNotificationConfig().channels as Record<\n        string,\n        { send(context: never): Promise<void> } | undefined\n      >;\n      const channel = channels[job.channel];\n\n      if (!channel) {\n        throw new UnrecoverableError(\n          `Notification channel \"${job.channel}\" is not configured in this worker's notifications config.`,\n        );\n      }\n\n      await channel.send({ payload: job.payload, route: job.route, options: job.options } as never);\n    },\n  });\n}\n\nfunction notificationDelay(delay: number | string): Duration {\n  return typeof delay === \"number\" ? delay * 1_000 : toMilliseconds(delay);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAa,wBAAwB;;;;;;;;;;;;;;;;;;;AA+BrC,SAAgB,4BACd,UAA8C,CAAC,GAC9B;CACjB,MAAM,UAAU,sBAAsB,OAAO;CAE7C,OAAO,EACL,MAAM,SAAS,KAAK;EAClB,MAAM,QAAQ,SAAS,KAAK,EAC1B,OAAO,IAAI,QAAQ,UAAU,SAAY,SAAY,kBAAkB,IAAI,QAAQ,KAAK,EAC1F,CAAC;CACH,EACF;AACF;AAEA,SAAS,sBACP,SACwC;CACxC,OAAO,UAAwC;EAC7C,MAAM;EACN,OAAO,QAAQ;EACf,UAAU,QAAQ;EAClB,SAAS,QAAQ;EACjB,MAAM,OAAO,KAAK;GAKhB,MAAM,UAJW,sBAAsB,CAAC,CAAC,SAIhB,IAAI;GAE7B,IAAI,CAAC,SACH,MAAM,IAAI,mBACR,yBAAyB,IAAI,QAAQ,2DACvC;GAGF,MAAM,QAAQ,KAAK;IAAE,SAAS,IAAI;IAAS,OAAO,IAAI;IAAO,SAAS,IAAI;GAAQ,CAAU;EAC9F;CACF,CAAC;AACH;AAEA,SAAS,kBAAkB,OAAkC;CAC3D,OAAO,OAAO,UAAU,WAAW,QAAQ,MAAQ,eAAe,KAAK;AACzE"}