@veloxts/scheduler 0.6.55 → 0.6.57

package/dist/index.d.ts

@@ -61,3 +61,26 @@ export { createScheduler, scheduler } from './manager.js';
 export { _resetStandaloneScheduler, getScheduler, getSchedulerFromInstance, schedulerPlugin, } from './plugin.js';
 export { defineSchedule, task } from './task.js';
 export type { DayOfWeek, DayOfWeekNumber, ScheduleConstraint, ScheduledTask, SchedulerManager, SchedulerOptions, SchedulerPluginOptions, TaskBuilder, TaskContext, TaskExecution, TaskFailureCallback, TaskHandler, TaskSkipCallback, TaskSuccessCallback, } from './types.js';
+/**
+ * DI tokens and providers for @veloxts/scheduler
+ *
+ * Use these to integrate scheduler services with the @veloxts/core DI container.
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().build(),
+ *   ],
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+export { registerSchedulerProviders } from './providers.js';
+export { SCHEDULER_CONFIG, SCHEDULER_MANAGER } from './tokens.js';

package/dist/index.js

@@ -63,3 +63,31 @@ export { createScheduler, scheduler } from './manager.js';
 export { _resetStandaloneScheduler, getScheduler, getSchedulerFromInstance, schedulerPlugin, } from './plugin.js';
 // Task builder
 export { defineSchedule, task } from './task.js';
+// ============================================================================
+// Dependency Injection
+// ============================================================================
+/**
+ * DI tokens and providers for @veloxts/scheduler
+ *
+ * Use these to integrate scheduler services with the @veloxts/core DI container.
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().build(),
+ *   ],
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+// Provider exports - factory functions for registering services
+export { registerSchedulerProviders } from './providers.js';
+// Token exports - unique identifiers for DI resolution
+export { SCHEDULER_CONFIG, SCHEDULER_MANAGER } from './tokens.js';

package/dist/providers.d.ts

@@ -0,0 +1,64 @@
+/**
+ * DI Providers for @veloxts/scheduler
+ *
+ * Factory provider functions for registering scheduler services with the DI container.
+ * These providers allow services to be managed by the container for testability and flexibility.
+ *
+ * @module scheduler/providers
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().at('02:00').build(),
+ *   ],
+ *   timezone: 'America/New_York',
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+import type { Container } from '@veloxts/core';
+import type { SchedulerPluginOptions } from './types.js';
+/**
+ * Registers scheduler providers with a container
+ *
+ * Unlike other VeloxTS packages, the scheduler manager is created synchronously.
+ *
+ * @param container - The DI container to register providers with
+ * @param config - Scheduler plugin options (tasks, timezone, callbacks, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ *
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup-expired-tokens', async () => {
+ *       await db.token.deleteMany({ where: { expiresAt: { lt: new Date() } } });
+ *     }).daily().at('02:00').build(),
+ *
+ *     task('send-daily-digest', async () => {
+ *       await sendDigest();
+ *     }).daily().at('09:00').weekdays().build(),
+ *   ],
+ *   timezone: 'UTC',
+ *   debug: false,
+ *   onTaskComplete: (task, ctx, duration) => {
+ *     console.log(`Task ${task.name} completed in ${duration}ms`);
+ *   },
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+export declare function registerSchedulerProviders(container: Container, config: SchedulerPluginOptions): void;

package/dist/providers.js

@@ -0,0 +1,82 @@
+/**
+ * DI Providers for @veloxts/scheduler
+ *
+ * Factory provider functions for registering scheduler services with the DI container.
+ * These providers allow services to be managed by the container for testability and flexibility.
+ *
+ * @module scheduler/providers
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().at('02:00').build(),
+ *   ],
+ *   timezone: 'America/New_York',
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+import { createScheduler } from './manager.js';
+import { SCHEDULER_CONFIG, SCHEDULER_MANAGER } from './tokens.js';
+// ============================================================================
+// Bulk Registration Helpers
+// ============================================================================
+/**
+ * Registers scheduler providers with a container
+ *
+ * Unlike other VeloxTS packages, the scheduler manager is created synchronously.
+ *
+ * @param container - The DI container to register providers with
+ * @param config - Scheduler plugin options (tasks, timezone, callbacks, etc.)
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { registerSchedulerProviders, SCHEDULER_MANAGER, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ *
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup-expired-tokens', async () => {
+ *       await db.token.deleteMany({ where: { expiresAt: { lt: new Date() } } });
+ *     }).daily().at('02:00').build(),
+ *
+ *     task('send-daily-digest', async () => {
+ *       await sendDigest();
+ *     }).daily().at('09:00').weekdays().build(),
+ *   ],
+ *   timezone: 'UTC',
+ *   debug: false,
+ *   onTaskComplete: (task, ctx, duration) => {
+ *     console.log(`Task ${task.name} completed in ${duration}ms`);
+ *   },
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+export function registerSchedulerProviders(container, config) {
+    // Register config
+    container.register({
+        provide: SCHEDULER_CONFIG,
+        useValue: config,
+    });
+    // Extract tasks and options from config
+    const { tasks, autoStart: _autoStart, ...options } = config;
+    // Create scheduler manager (synchronous operation)
+    const schedulerManager = createScheduler(tasks, options);
+    // Register the scheduler manager instance
+    container.register({
+        provide: SCHEDULER_MANAGER,
+        useValue: schedulerManager,
+    });
+}

package/dist/tokens.d.ts

@@ -0,0 +1,52 @@
+/**
+ * DI Tokens for @veloxts/scheduler
+ *
+ * Symbol-based tokens for type-safe dependency injection.
+ * These tokens allow scheduler services to be registered, resolved, and mocked via the DI container.
+ *
+ * @module scheduler/tokens
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { SCHEDULER_MANAGER, registerSchedulerProviders, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().build(),
+ *   ],
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+import type { SchedulerManager, SchedulerPluginOptions } from './types.js';
+/**
+ * Scheduler manager token
+ *
+ * The main scheduler manager instance for scheduling and managing tasks.
+ *
+ * @example
+ * ```typescript
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * const tasks = scheduler.getTasks();
+ * await scheduler.runTask('cleanup');
+ * ```
+ */
+export declare const SCHEDULER_MANAGER: import("@veloxts/core").SymbolToken<SchedulerManager>;
+/**
+ * Scheduler configuration token
+ *
+ * Contains scheduler plugin options including tasks, timezone, and callbacks.
+ *
+ * @example
+ * ```typescript
+ * const config = container.resolve(SCHEDULER_CONFIG);
+ * console.log(config.timezone); // 'UTC'
+ * console.log(config.tasks.length); // 3
+ * ```
+ */
+export declare const SCHEDULER_CONFIG: import("@veloxts/core").SymbolToken<SchedulerPluginOptions>;

package/dist/tokens.js

@@ -0,0 +1,58 @@
+/**
+ * DI Tokens for @veloxts/scheduler
+ *
+ * Symbol-based tokens for type-safe dependency injection.
+ * These tokens allow scheduler services to be registered, resolved, and mocked via the DI container.
+ *
+ * @module scheduler/tokens
+ *
+ * @example
+ * ```typescript
+ * import { Container } from '@veloxts/core';
+ * import { SCHEDULER_MANAGER, registerSchedulerProviders, task } from '@veloxts/scheduler';
+ *
+ * const container = new Container();
+ * registerSchedulerProviders(container, {
+ *   tasks: [
+ *     task('cleanup', () => db.cleanup()).daily().build(),
+ *   ],
+ * });
+ *
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * ```
+ */
+import { token } from '@veloxts/core';
+// ============================================================================
+// Core Scheduler Tokens
+// ============================================================================
+/**
+ * Scheduler manager token
+ *
+ * The main scheduler manager instance for scheduling and managing tasks.
+ *
+ * @example
+ * ```typescript
+ * const scheduler = container.resolve(SCHEDULER_MANAGER);
+ * scheduler.start();
+ * const tasks = scheduler.getTasks();
+ * await scheduler.runTask('cleanup');
+ * ```
+ */
+export const SCHEDULER_MANAGER = token.symbol('SCHEDULER_MANAGER');
+// ============================================================================
+// Configuration Tokens
+// ============================================================================
+/**
+ * Scheduler configuration token
+ *
+ * Contains scheduler plugin options including tasks, timezone, and callbacks.
+ *
+ * @example
+ * ```typescript
+ * const config = container.resolve(SCHEDULER_CONFIG);
+ * console.log(config.timezone); // 'UTC'
+ * console.log(config.tasks.length); // 3
+ * ```
+ */
+export const SCHEDULER_CONFIG = token.symbol('SCHEDULER_CONFIG');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/scheduler",
-  "version": "0.6.55",
+  "version": "0.6.57",
   "description": "Task scheduling for VeloxTS framework",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,7 +20,7 @@
   "dependencies": {
     "cron": "3.5.0",
     "fastify-plugin": "5.1.0",
-    "@veloxts/core": "0.6.55"
+    "@veloxts/core": "0.6.57"
   },
   "peerDependencies": {
     "fastify": "^5.0.0"