@hazeljs/cron 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,442 @@
+# @hazeljs/cron
+
+**Scheduled tasks as decorators. No `setInterval` hacks.**
+
+`@Cron('0 9 * * *')` for daily at 9am. `@Interval(60000)` for every minute. Real cron expressions, timezone support, overlap prevention. Background jobs that actually run when you expect.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/cron.svg)](https://www.npmjs.com/package/@hazeljs/cron)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/cron)](https://www.npmjs.com/package/@hazeljs/cron)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- ⏰ **Cron Expressions** - Standard cron syntax support
+- 🎨 **Decorator-Based API** - `@Cron`, `@Interval`, `@Timeout`
+- 🔄 **Job Management** - Start, stop, and manage scheduled jobs
+- 📊 **Job Monitoring** - Track execution history and status
+- 🛡️ **Error Handling** - Automatic retry and error recovery
+- 🎯 **Timezone Support** - Schedule jobs in specific timezones
+- 🔒 **Overlap Prevention** - Prevent concurrent executions
+- 📝 **Logging** - Built-in execution logging
+
+## Installation
+
+```bash
+npm install @hazeljs/cron
+```
+
+## Quick Start
+
+### 1. Import CronModule
+
+```typescript
+import { HazelModule } from '@hazeljs/core';
+import { CronModule } from '@hazeljs/cron';
+
+@HazelModule({
+  imports: [CronModule.forRoot()],
+})
+export class AppModule {}
+```
+
+### 2. Create Scheduled Tasks
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { Cron, CronExpression } from '@hazeljs/cron';
+
+@Injectable()
+export class TasksService {
+  @Cron(CronExpression.EVERY_MINUTE)
+  handleEveryMinute() {
+    console.log('This runs every minute');
+  }
+
+  @Cron('0 0 * * *') // Every day at midnight
+  handleMidnight() {
+    console.log('This runs at midnight every day');
+  }
+
+  @Cron('0 9 * * 1-5') // Weekdays at 9 AM
+  handleWeekdayMorning() {
+    console.log('This runs Monday-Friday at 9 AM');
+  }
+}
+```
+
+## Cron Expressions
+
+### Predefined Expressions
+
+```typescript
+import { CronExpression } from '@hazeljs/cron';
+
+@Cron(CronExpression.EVERY_SECOND)      // Every second
+@Cron(CronExpression.EVERY_5_SECONDS)   // Every 5 seconds
+@Cron(CronExpression.EVERY_10_SECONDS)  // Every 10 seconds
+@Cron(CronExpression.EVERY_30_SECONDS)  // Every 30 seconds
+@Cron(CronExpression.EVERY_MINUTE)      // Every minute
+@Cron(CronExpression.EVERY_5_MINUTES)   // Every 5 minutes
+@Cron(CronExpression.EVERY_10_MINUTES)  // Every 10 minutes
+@Cron(CronExpression.EVERY_30_MINUTES)  // Every 30 minutes
+@Cron(CronExpression.EVERY_HOUR)        // Every hour
+@Cron(CronExpression.EVERY_DAY_AT_MIDNIGHT) // Daily at 00:00
+@Cron(CronExpression.EVERY_DAY_AT_NOON)     // Daily at 12:00
+@Cron(CronExpression.EVERY_WEEK)        // Every Sunday at 00:00
+@Cron(CronExpression.EVERY_MONTH)       // First day of month at 00:00
+```
+
+### Custom Expressions
+
+```typescript
+// Format: second minute hour day month weekday
+// * * * * * *
+
+@Cron('0 */15 * * * *')    // Every 15 minutes
+@Cron('0 0 12 * * *')      // Every day at noon
+@Cron('0 0 0 1 * *')       // First day of every month
+@Cron('0 0 9 * * 1-5')     // Weekdays at 9 AM
+@Cron('0 30 11 * * 1,3,5') // Mon, Wed, Fri at 11:30 AM
+```
+
+## Decorators
+
+### @Cron()
+
+Schedule recurring tasks:
+
+```typescript
+@Injectable()
+export class TasksService {
+  @Cron('0 0 * * *', {
+    name: 'daily-cleanup',
+    timezone: 'America/New_York',
+  })
+  async dailyCleanup() {
+    console.log('Running daily cleanup');
+    await this.cleanupOldData();
+  }
+}
+```
+
+### @Interval()
+
+Run tasks at fixed intervals:
+
+```typescript
+@Injectable()
+export class MonitoringService {
+  @Interval(5000) // Every 5 seconds
+  checkHealth() {
+    console.log('Health check');
+  }
+
+  @Interval(60000, { name: 'metrics-collector' })
+  collectMetrics() {
+    console.log('Collecting metrics');
+  }
+}
+```
+
+### @Timeout()
+
+Run tasks once after a delay:
+
+```typescript
+@Injectable()
+export class StartupService {
+  @Timeout(5000) // After 5 seconds
+  async warmupCache() {
+    console.log('Warming up cache');
+    await this.cacheService.warmup();
+  }
+}
+```
+
+## Job Management
+
+### Manual Job Control
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { CronService, SchedulerRegistry } from '@hazeljs/cron';
+
+@Injectable()
+export class JobManager {
+  constructor(
+    private schedulerRegistry: SchedulerRegistry,
+    private cronService: CronService
+  ) {}
+
+  stopJob(name: string) {
+    const job = this.schedulerRegistry.getCronJob(name);
+    job.stop();
+    console.log(`Job ${name} stopped`);
+  }
+
+  startJob(name: string) {
+    const job = this.schedulerRegistry.getCronJob(name);
+    job.start();
+    console.log(`Job ${name} started`);
+  }
+
+  deleteJob(name: string) {
+    this.schedulerRegistry.deleteCronJob(name);
+    console.log(`Job ${name} deleted`);
+  }
+
+  getAllJobs() {
+    return this.schedulerRegistry.getCronJobs();
+  }
+}
+```
+
+### Dynamic Job Creation
+
+```typescript
+@Injectable()
+export class DynamicJobService {
+  constructor(private schedulerRegistry: SchedulerRegistry) {}
+
+  addJob(name: string, cronExpression: string, callback: () => void) {
+    const job = new CronJob(cronExpression, callback);
+    this.schedulerRegistry.addCronJob(name, job);
+    job.start();
+  }
+
+  removeJob(name: string) {
+    this.schedulerRegistry.deleteCronJob(name);
+  }
+}
+```
+
+## Configuration
+
+### Module Configuration
+
+```typescript
+CronModule.forRoot({
+  // Enable/disable all cron jobs
+  enabled: true,
+  
+  // Default timezone for all jobs
+  timezone: 'UTC',
+  
+  // Prevent overlapping executions
+  preventOverlap: true,
+  
+  // Retry failed jobs
+  retry: {
+    attempts: 3,
+    delay: 1000,
+  },
+  
+  // Logging
+  logging: {
+    enabled: true,
+    logSuccess: true,
+    logErrors: true,
+  },
+})
+```
+
+### Job-Level Configuration
+
+```typescript
+@Cron('0 0 * * *', {
+  name: 'backup-job',
+  timezone: 'America/New_York',
+  runOnInit: false,
+  preventOverlap: true,
+  retryAttempts: 3,
+  retryDelay: 5000,
+})
+async backupDatabase() {
+  await this.databaseService.backup();
+}
+```
+
+## Error Handling
+
+```typescript
+@Injectable()
+export class TasksService {
+  @Cron('0 0 * * *', {
+    name: 'risky-job',
+    retryAttempts: 3,
+    retryDelay: 5000,
+  })
+  async riskyJob() {
+    try {
+      await this.performRiskyOperation();
+    } catch (error) {
+      console.error('Job failed:', error);
+      // Error will be retried automatically
+      throw error;
+    }
+  }
+}
+```
+
+## Use Cases
+
+### Database Cleanup
+
+```typescript
+@Injectable()
+export class DatabaseCleanupService {
+  @Cron('0 2 * * *') // Every day at 2 AM
+  async cleanupOldRecords() {
+    const thirtyDaysAgo = new Date();
+    thirtyDaysAgo.setDate(thirtyDaysAgo.getDate() - 30);
+    
+    await this.db.logs.deleteMany({
+      where: { createdAt: { lt: thirtyDaysAgo } },
+    });
+    
+    console.log('Old records cleaned up');
+  }
+}
+```
+
+### Report Generation
+
+```typescript
+@Injectable()
+export class ReportService {
+  @Cron('0 0 9 * * 1') // Every Monday at 9 AM
+  async generateWeeklyReport() {
+    const report = await this.analytics.generateWeeklyReport();
+    await this.email.send({
+      to: 'admin@example.com',
+      subject: 'Weekly Report',
+      body: report,
+    });
+  }
+}
+```
+
+### Cache Warming
+
+```typescript
+@Injectable()
+export class CacheService {
+  @Cron('0 */30 * * * *') // Every 30 minutes
+  async warmupCache() {
+    const popularProducts = await this.db.products.findMany({
+      where: { popular: true },
+    });
+    
+    for (const product of popularProducts) {
+      await this.cache.set(`product:${product.id}`, product, 3600);
+    }
+  }
+}
+```
+
+### Health Monitoring
+
+```typescript
+@Injectable()
+export class HealthMonitor {
+  @Interval(30000) // Every 30 seconds
+  async checkServices() {
+    const services = ['database', 'redis', 'api'];
+    
+    for (const service of services) {
+      const isHealthy = await this.checkServiceHealth(service);
+      if (!isHealthy) {
+        await this.alertService.sendAlert(`${service} is down!`);
+      }
+    }
+  }
+}
+```
+
+### Data Synchronization
+
+```typescript
+@Injectable()
+export class SyncService {
+  @Cron('0 */5 * * * *') // Every 5 minutes
+  async syncData() {
+    const localData = await this.getLocalData();
+    const remoteData = await this.getRemoteData();
+    
+    const diff = this.calculateDiff(localData, remoteData);
+    await this.applyChanges(diff);
+  }
+}
+```
+
+## Best Practices
+
+1. **Use Named Jobs** - Always provide a name for easier management
+2. **Handle Errors** - Implement proper error handling and logging
+3. **Prevent Overlaps** - Enable `preventOverlap` for long-running jobs
+4. **Set Appropriate Timezones** - Specify timezone for time-sensitive jobs
+5. **Monitor Execution** - Track job execution and failures
+6. **Test Thoroughly** - Test cron expressions before deploying
+7. **Use Intervals for Simple Tasks** - Use `@Interval` for fixed-interval tasks
+8. **Cleanup Resources** - Properly cleanup resources in job handlers
+
+## API Reference
+
+### Decorators
+
+```typescript
+@Cron(expression: string, options?: CronOptions)
+@Interval(milliseconds: number, options?: IntervalOptions)
+@Timeout(milliseconds: number, options?: TimeoutOptions)
+```
+
+### CronService
+
+```typescript
+class CronService {
+  addCronJob(name: string, expression: string, callback: () => void): void;
+  getCronJob(name: string): CronJob;
+  deleteCronJob(name: string): void;
+  getCronJobs(): Map<string, CronJob>;
+}
+```
+
+### SchedulerRegistry
+
+```typescript
+class SchedulerRegistry {
+  addCronJob(name: string, job: CronJob): void;
+  getCronJob(name: string): CronJob;
+  deleteCronJob(name: string): void;
+  getCronJobs(): Map<string, CronJob>;
+  addInterval(name: string, intervalId: NodeJS.Timeout): void;
+  deleteInterval(name: string): void;
+  addTimeout(name: string, timeoutId: NodeJS.Timeout): void;
+  deleteTimeout(name: string): void;
+}
+```
+
+## Examples
+
+See the [examples](../../example/src/cron) directory for complete working examples.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 © [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs/packages/cron)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)

package/dist/cron.decorator.d.ts

@@ -0,0 +1,20 @@
+import 'reflect-metadata';
+import { CronOptions } from './cron.types';
+/**
+ * Metadata key for cron jobs
+ */
+export declare const CRON_METADATA_KEY: unique symbol;
+/**
+ * Decorator to mark a method as a cron job
+ * @param options - Cron job options
+ */
+export declare function Cron(options: CronOptions): MethodDecorator;
+/**
+ * Get cron job metadata from a class
+ */
+export declare function getCronMetadata(target: object): Array<{
+    target: object;
+    methodName: string;
+    options: CronOptions;
+}>;
+//# sourceMappingURL=cron.decorator.d.ts.map

package/dist/cron.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.decorator.d.ts","sourceRoot":"","sources":["../src/cron.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAsB,CAAC;AAErD;;;GAGG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,eAAe,CAoB1D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;CACtB,CAAC,CAED"}

package/dist/cron.decorator.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRON_METADATA_KEY = void 0;
+exports.Cron = Cron;
+exports.getCronMetadata = getCronMetadata;
+require("reflect-metadata");
+/**
+ * Metadata key for cron jobs
+ */
+exports.CRON_METADATA_KEY = Symbol('cron:jobs');
+/**
+ * Decorator to mark a method as a cron job
+ * @param options - Cron job options
+ */
+function Cron(options) {
+    return (target, propertyKey, _descriptor) => {
+        // Get existing cron jobs or initialize empty array
+        const existingJobs = Reflect.getMetadata(exports.CRON_METADATA_KEY, target.constructor) || [];
+        // Add this job to the list
+        const jobMetadata = {
+            target,
+            methodName: propertyKey.toString(),
+            options: {
+                name: options.name || `${target.constructor.name}.${propertyKey.toString()}`,
+                ...options,
+            },
+        };
+        existingJobs.push(jobMetadata);
+        // Store metadata
+        Reflect.defineMetadata(exports.CRON_METADATA_KEY, existingJobs, target.constructor);
+    };
+}
+/**
+ * Get cron job metadata from a class
+ */
+function getCronMetadata(target) {
+    return Reflect.getMetadata(exports.CRON_METADATA_KEY, target.constructor) || [];
+}