mongo-job-scheduler 0.1.0 → 0.1.1

package/README.md

@@ -56,13 +56,16 @@ await scheduler.start();
 ## Cron with Timezone
 
 ```typescript
-await scheduler.schedule({
-  name: "daily-report",
-  repeat: {
-    cron: "0 9 * * *",
-    timezone: "Asia/Kolkata", // default is UTC
-  },
-});
+await scheduler.schedule(
+  "daily-report",
+  { type: "report" }, // payload
+  {
+    repeat: {
+      cron: "0 9 * * *",
+      timezone: "Asia/Kolkata", // default is UTC
+    },
+  }
+);
 ```
 
 ## Documentation

package/dist/core/scheduler.d.ts

@@ -1,6 +1,7 @@
 import { SchedulerEventMap } from "../types/events";
 import { JobStore } from "../store";
 import { Job } from "../types/job";
+import { ScheduleOptions } from "../types/schedule";
 export interface SchedulerOptions {
     id?: string;
     store?: JobStore;
@@ -23,6 +24,7 @@ export declare class Scheduler {
     private readonly defaultTimezone?;
     constructor(options?: SchedulerOptions);
     on<K extends keyof SchedulerEventMap>(event: K, listener: (payload: SchedulerEventMap[K]) => void): this;
+    schedule<T = unknown>(options: ScheduleOptions<T>): Promise<Job<T>>;
     start(): Promise<void>;
     stop(): Promise<void>;
     isRunning(): boolean;

package/dist/core/scheduler.js

@@ -17,6 +17,38 @@ export class Scheduler {
         this.emitter.on(event, listener);
         return this;
     }
+    async schedule(options) {
+        if (!this.store) {
+            throw new Error("Scheduler has no JobStore configured");
+        }
+        const now = new Date();
+        // ------------------------
+        // Validation
+        // ------------------------
+        if (!options.name) {
+            throw new Error("Job name is required");
+        }
+        if (options.repeat?.cron && options.repeat?.every != null) {
+            throw new Error("Use either cron or every, not both");
+        }
+        // ------------------------
+        // Normalize run time
+        // ------------------------
+        const nextRunAt = options.runAt ?? now;
+        const job = {
+            name: options.name,
+            data: options.data,
+            status: "pending",
+            attempts: 0,
+            nextRunAt,
+            retry: options.retry,
+            repeat: options.repeat,
+            createdAt: now,
+            updatedAt: now,
+        };
+        const created = await this.store.create(job);
+        return created;
+    }
     async start() {
         if (this.started)
             return;

package/dist/types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./retry";
 export * from "./repeat";
 export * from "./lifecycle";
 export * from "./events";
+export * from "./schedule";

package/dist/types/index.js

@@ -3,3 +3,4 @@ export * from "./retry";
 export * from "./repeat";
 export * from "./lifecycle";
 export * from "./events";
+export * from "./schedule";

package/dist/types/schedule.d.ts

@@ -0,0 +1,19 @@
+import { RetryOptions } from "./retry";
+import { RepeatOptions } from "./repeat";
+export interface ScheduleOptions<T = unknown> {
+    name: string;
+    data: T;
+    /**
+     * When the job should first run.
+     * Defaults to now.
+     */
+    runAt?: Date;
+    /**
+     * Retry configuration
+     */
+    retry?: RetryOptions;
+    /**
+     * Repeat configuration (cron or every)
+     */
+    repeat?: RepeatOptions;
+}

package/dist/types/schedule.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongo-job-scheduler",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Production-grade MongoDB-backed job scheduler with retries, cron, timezone support, and crash recovery",
   "license": "MIT",
   "author": "Darshan Bhut",