stratal 0.0.21 → 0.0.23

package/dist/queue/index.mjs

@@ -1,60 +1,69 @@
-import { a as __decorate, f as DI_TOKENS, o as __decorateParam, p as Transient, s as __decorateMetadata } from "../logger-DlV7NtvD.mjs";
-import { a as QueueProviderNotSupportedError, c as QUEUE_TOKENS, i as CloudflareQueueProvider, l as QueueSender, n as QueueProviderFactory, o as QueueBindingNotFoundError, r as SyncQueueProvider, s as QueueRegistry, t as QueueModule, u as ConsumerRegistry } from "../queue.module-BhCjZp6H.mjs";
-import { inject } from "tsyringe";
-//#region src/queue/queue-manager.ts
-let QueueManager = class QueueManager {
-	registry;
-	constructor(registry) {
-		this.registry = registry;
+import { c as Transient, d as inject } from "../di-DseMn-z9.mjs";
+import { n as __decorateParam, t as __decorate } from "../decorate-CuAoSZvs.mjs";
+import { LOGGER_TOKENS } from "../logger/index.mjs";
+import { a as CloudflareQueueProvider, c as QueueRegistry, d as QueueManager, f as QueueError, i as SyncQueueProvider, l as QueueSender, o as DEFAULT_STORE_BINDING, r as QueueProviderFactory, s as QueueStore, t as QueueModule, u as ConsumerRegistry } from "../queue.module-nddvxzCB.mjs";
+import { t as QUEUE_TOKENS } from "../queue.tokens-DjHnFmre.mjs";
+//#region src/queue/jobs/failed-job-cleanup.job.ts
+/** Retention applied when `failedJobs.retention` is not configured. */
+const DEFAULT_RETENTION_SECONDS = 604800;
+let FailedJobCleanupJob = class FailedJobCleanupJob {
+	store;
+	options;
+	logger;
+	static schedule = "0 0 * * *";
+	constructor(store, options, logger) {
+		this.store = store;
+		this.options = options;
+		this.logger = logger;
 	}
-	/**
-	* Process a batch of queue messages
-	*
-	* Routes messages to registered consumers based on message type.
-	* Uses ConsumerRegistry to find matching consumers.
-	*
-	* @param _queueName - Name of the queue (for logging, not used for routing)
-	* @param batch - Batch of messages from Cloudflare Queue
-	*/
-	async processBatch(_queueName, batch) {
-		for (const message of batch.messages) {
-			const queueMessage = message.body;
-			const consumers = this.registry.getConsumers(queueMessage.type);
-			for (const consumer of consumers) try {
-				await consumer.handle(queueMessage);
-				message.ack();
-			} catch (error) {
-				const errorInstance = error instanceof Error ? error : new Error(String(error));
-				if (consumer.onError) await consumer.onError(errorInstance, queueMessage);
-				message.retry();
-			}
-		}
+	async execute() {
+		const retention = this.options.failedJobs?.retention ?? DEFAULT_RETENTION_SECONDS;
+		const removed = await this.store.purgeFailedJobsOlderThan(retention);
+		this.logger.info("Failed-job cleanup complete", {
+			removed,
+			retentionSeconds: retention
+		});
 	}
 };
-QueueManager = __decorate([
-	Transient(DI_TOKENS.Queue),
-	__decorateParam(0, inject(DI_TOKENS.ConsumerRegistry)),
-	__decorateMetadata("design:paramtypes", [Object])
-], QueueManager);
+FailedJobCleanupJob = __decorate([
+	Transient(),
+	__decorateParam(0, inject(QUEUE_TOKENS.QueueStore)),
+	__decorateParam(1, inject(QUEUE_TOKENS.QueueModuleOptions)),
+	__decorateParam(2, inject(LOGGER_TOKENS.LoggerService))
+], FailedJobCleanupJob);
+/**
+* Create a {@link FailedJobCleanupJob} bound to a custom cron schedule (which
+* must match a `wrangler.jsonc` trigger). Use when the default daily schedule
+* isn't desired:
+*
+* ```ts
+* @Module({ jobs: [failedJobCleanupJob('0 3 * * 0')] }) // weekly, Sundays 03:00
+* ```
+*/
+function failedJobCleanupJob(schedule) {
+	return class extends FailedJobCleanupJob {
+		static schedule = schedule;
+	};
+}
 //#endregion
 //#region src/queue/decorators/inject-queue.decorator.ts
 /**
-* Inject a queue sender by name.
+* Inject a queue sender by binding name.
 *
-* Queue names are typed via module augmentation of QueueNames interface.
-* The queue name serves as both the identifier and the DI injection token.
+* The binding name matches the `binding` field declared under `queues.producers`
+* in `wrangler.jsonc` (e.g. `BACKGROUND_QUEUE`). Stratal looks the binding up
+* directly on the worker's `env`; the underlying Cloudflare queue can be any
+* env-specific name (e.g. `background-queue-dev`) without affecting code.
 *
-* @param name - Queue name (typed with autocomplete if QueueNames is augmented)
+* @param binding - Queue binding identifier (typed against `StratalEnv`).
 * @returns Parameter decorator for constructor injection
 *
 * @example
 * ```typescript
-* // Direct injection by queue name
 * constructor(
-*   @InjectQueue('notifications-queue') private queue: IQueueSender
+*   @InjectQueue('NOTIFICATIONS_QUEUE') private queue: IQueueSender
 * ) {}
 *
-* // Usage
 * await this.queue.dispatch({
 *   type: 'email.send',
 *   payload: { to: 'user@example.com', subject: 'Hello' }
@@ -62,14 +71,14 @@ QueueManager = __decorate([
 * ```
 *
 * @remarks
-* The queue must be registered via `QueueModule.registerQueue(name)` before injection.
-* For module-internal queue bindings (e.g., EmailModule), use `@inject(TOKEN)` with
-* `useExisting` provider binding instead.
+* The binding must be registered via `QueueModule.registerQueue(binding)`
+* before injection. For module-internal bindings (e.g. EmailModule),
+* use `@inject(TOKEN)` with `useExisting` provider binding instead.
 */
-function InjectQueue(name) {
-	return inject(name);
+function InjectQueue(binding) {
+	return inject(binding);
 }
 //#endregion
-export { CloudflareQueueProvider, ConsumerRegistry, InjectQueue, QUEUE_TOKENS, QueueBindingNotFoundError, QueueManager, QueueModule, QueueProviderFactory, QueueProviderNotSupportedError, QueueRegistry, QueueSender, SyncQueueProvider };
+export { CloudflareQueueProvider, ConsumerRegistry, DEFAULT_STORE_BINDING, FailedJobCleanupJob, InjectQueue, QUEUE_TOKENS, QueueError, QueueManager, QueueModule, QueueProviderFactory, QueueRegistry, QueueSender, QueueStore, SyncQueueProvider, failedJobCleanupJob };
 
 //# sourceMappingURL=index.mjs.map

package/dist/queue/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/queue/queue-manager.ts","../../src/queue/decorators/inject-queue.decorator.ts"],"sourcesContent":["import { inject } from 'tsyringe'\nimport { Transient } from '../di/decorators'\nimport { DI_TOKENS } from '../di/tokens'\nimport { type ConsumerRegistry } from './consumer-registry'\nimport type { QueueMessage } from './queue-consumer'\n\n/**\n * Queue Manager\n *\n * Singleton service for processing queue message batches.\n * Routes messages to consumers based on message type.\n *\n * **Message Routing:**\n * - Consumers declare message types they handle (e.g., ['email.send'])\n * - When a message arrives, consumers matching the message type are invoked\n * - A consumer can handle messages from ANY queue (routing is by type, not queue)\n *\n * **Note:** For sending messages to queues, use IQueueSender instances\n * obtained via @InjectQueue('queue-name') or module bindings.\n *\n * @example Processing a queue batch\n * ```typescript\n * // In Cloudflare Worker queue handler\n * await queueManager.processBatch('notifications-queue', batch)\n * ```\n */\n@Transient(DI_TOKENS.Queue)\nexport class QueueManager {\n  constructor(\n    @inject(DI_TOKENS.ConsumerRegistry) private readonly registry: ConsumerRegistry\n  ) {}\n\n  /**\n   * Process a batch of queue messages\n   *\n   * Routes messages to registered consumers based on message type.\n   * Uses ConsumerRegistry to find matching consumers.\n   *\n   * @param _queueName - Name of the queue (for logging, not used for routing)\n   * @param batch - Batch of messages from Cloudflare Queue\n   */\n  async processBatch(_queueName: string, batch: MessageBatch): Promise<void> {\n    for (const message of batch.messages) {\n      const queueMessage = message.body as QueueMessage\n\n      // Find consumers by message type (not by queue name)\n      const consumers = this.registry.getConsumers(queueMessage.type)\n\n      for (const consumer of consumers) {\n        try {\n          await consumer.handle(queueMessage)\n          message.ack()\n        } catch (error) {\n          const errorInstance = error instanceof Error\n            ? error\n            : new Error(String(error))\n\n          if (consumer.onError) {\n            await consumer.onError(errorInstance, queueMessage)\n          }\n          message.retry()\n        }\n      }\n    }\n  }\n}\n","import { inject } from 'tsyringe'\nimport type { QueueName } from '../queue-name'\n\n/**\n * Inject a queue sender by name.\n *\n * Queue names are typed via module augmentation of QueueNames interface.\n * The queue name serves as both the identifier and the DI injection token.\n *\n * @param name - Queue name (typed with autocomplete if QueueNames is augmented)\n * @returns Parameter decorator for constructor injection\n *\n * @example\n * ```typescript\n * // Direct injection by queue name\n * constructor(\n *   @InjectQueue('notifications-queue') private queue: IQueueSender\n * ) {}\n *\n * // Usage\n * await this.queue.dispatch({\n *   type: 'email.send',\n *   payload: { to: 'user@example.com', subject: 'Hello' }\n * })\n * ```\n *\n * @remarks\n * The queue must be registered via `QueueModule.registerQueue(name)` before injection.\n * For module-internal queue bindings (e.g., EmailModule), use `@inject(TOKEN)` with\n * `useExisting` provider binding instead.\n */\nexport function InjectQueue(name: QueueName): ParameterDecorator {\n  return inject(name)\n}\n"],"mappings":";;;;AA2BO,IAAA,eAAA,MAAM,aAAa;CAE+B;CADvD,YACE,UACA;EADqD,KAAA,WAAA;;;;;;;;;;;CAYvD,MAAM,aAAa,YAAoB,OAAoC;EACzE,KAAK,MAAM,WAAW,MAAM,UAAU;GACpC,MAAM,eAAe,QAAQ;GAG7B,MAAM,YAAY,KAAK,SAAS,aAAa,aAAa,KAAK;GAE/D,KAAK,MAAM,YAAY,WACrB,IAAI;IACF,MAAM,SAAS,OAAO,aAAa;IACnC,QAAQ,KAAK;YACN,OAAO;IACd,MAAM,gBAAgB,iBAAiB,QACnC,QACA,IAAI,MAAM,OAAO,MAAM,CAAC;IAE5B,IAAI,SAAS,SACX,MAAM,SAAS,QAAQ,eAAe,aAAa;IAErD,QAAQ,OAAO;;;;;;CAlCxB,UAAU,UAAU,MAAM;oBAGtB,OAAO,UAAU,iBAAiB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEvC,SAAgB,YAAY,MAAqC;CAC/D,OAAO,OAAO,KAAK"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/queue/jobs/failed-job-cleanup.job.ts","../../src/queue/decorators/inject-queue.decorator.ts"],"sourcesContent":["import type { CronJob } from '../../cron/cron-job'\nimport { inject } from '../../di'\nimport { Transient } from '../../di/decorators'\nimport { LOGGER_TOKENS, type LoggerService } from '../../logger'\nimport type { Constructor } from '../../types'\nimport type { QueueModuleOptions } from '../queue.module'\nimport type { QueueStore } from '../queue-store'\nimport { QUEUE_TOKENS } from '../queue.tokens'\n\n/** Retention applied when `failedJobs.retention` is not configured. */\nconst DEFAULT_RETENTION_SECONDS = 604800 // 7 days\n\n/**\n * Opt-in cron job that deletes failed jobs older than `failedJobs.retention`\n * (default 7 days). Failed jobs are persisted indefinitely by default; register\n * this job only if you want automatic cleanup.\n *\n * ```ts\n * @Module({\n *   imports: [\n *     QueueModule.forRoot({ provider: 'cloudflare', failedJobs: { retention: 1209600 } }),\n *   ],\n *   jobs: [FailedJobCleanupJob], // daily at 00:00 UTC\n * })\n * export class AppModule {}\n * ```\n *\n * Add a matching cron trigger to `wrangler.jsonc` (`\"0 0 * * *\"` for the\n * default schedule), or use {@link failedJobCleanupJob} for a custom one.\n */\n@Transient()\nexport class FailedJobCleanupJob implements CronJob {\n  static schedule = '0 0 * * *' // daily at 00:00 UTC\n\n  constructor(\n    @inject(QUEUE_TOKENS.QueueStore) private readonly store: QueueStore,\n    @inject(QUEUE_TOKENS.QueueModuleOptions) private readonly options: QueueModuleOptions,\n    @inject(LOGGER_TOKENS.LoggerService) private readonly logger: LoggerService,\n  ) {}\n\n  async execute(): Promise<void> {\n    const retention = this.options.failedJobs?.retention ?? DEFAULT_RETENTION_SECONDS\n    const removed = await this.store.purgeFailedJobsOlderThan(retention)\n    this.logger.info('Failed-job cleanup complete', { removed, retentionSeconds: retention })\n  }\n}\n\n/**\n * Create a {@link FailedJobCleanupJob} bound to a custom cron schedule (which\n * must match a `wrangler.jsonc` trigger). Use when the default daily schedule\n * isn't desired:\n *\n * ```ts\n * @Module({ jobs: [failedJobCleanupJob('0 3 * * 0')] }) // weekly, Sundays 03:00\n * ```\n */\nexport function failedJobCleanupJob(schedule: string): Constructor<CronJob> {\n  return class extends FailedJobCleanupJob {\n    static schedule = schedule\n  }\n}\n","import { inject } from '../../di'\nimport type { QueueBinding } from '../queue-binding'\n\n/**\n * Inject a queue sender by binding name.\n *\n * The binding name matches the `binding` field declared under `queues.producers`\n * in `wrangler.jsonc` (e.g. `BACKGROUND_QUEUE`). Stratal looks the binding up\n * directly on the worker's `env`; the underlying Cloudflare queue can be any\n * env-specific name (e.g. `background-queue-dev`) without affecting code.\n *\n * @param binding - Queue binding identifier (typed against `StratalEnv`).\n * @returns Parameter decorator for constructor injection\n *\n * @example\n * ```typescript\n * constructor(\n *   @InjectQueue('NOTIFICATIONS_QUEUE') private queue: IQueueSender\n * ) {}\n *\n * await this.queue.dispatch({\n *   type: 'email.send',\n *   payload: { to: 'user@example.com', subject: 'Hello' }\n * })\n * ```\n *\n * @remarks\n * The binding must be registered via `QueueModule.registerQueue(binding)`\n * before injection. For module-internal bindings (e.g. EmailModule),\n * use `@inject(TOKEN)` with `useExisting` provider binding instead.\n */\nexport function InjectQueue(binding: QueueBinding): ParameterDecorator {\n  return inject(binding)\n}\n"],"mappings":";;;;;;;AAUA,MAAM,4BAA4B;AAqB3B,IAAA,sBAAA,MAAM,oBAAuC;CAIE;CACQ;CACJ;CALxD,OAAO,WAAW;CAElB,YACE,OACA,SACA,QACA;EAHkD,KAAA,QAAA;EACQ,KAAA,UAAA;EACJ,KAAA,SAAA;CACrD;CAEH,MAAM,UAAyB;EAC7B,MAAM,YAAY,KAAK,QAAQ,YAAY,aAAa;EACxD,MAAM,UAAU,MAAM,KAAK,MAAM,yBAAyB,SAAS;EACnE,KAAK,OAAO,KAAK,+BAA+B;GAAE;GAAS,kBAAkB;EAAU,CAAC;CAC1F;AACF;;CAfC,UAAU;oBAKN,OAAO,aAAa,UAAU,CAAA;oBAC9B,OAAO,aAAa,kBAAkB,CAAA;oBACtC,OAAO,cAAc,aAAa,CAAA;;;;;;;;;;;AAmBvC,SAAgB,oBAAoB,UAAwC;CAC1E,OAAO,cAAc,oBAAoB;EACvC,OAAO,WAAW;CACpB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC7BA,SAAgB,YAAY,SAA2C;CACrE,OAAO,OAAO,OAAO;AACvB"}