@lssm/lib.jobs 0.0.0-canary-20251217052941 → 0.0.0-canary-20251217060433

package/dist/scheduler/index.d.ts

@@ -0,0 +1,92 @@
+import { types_d_exports } from "../queue/types.js";
+
+//#region src/scheduler/index.d.ts
+
+/**
+ * Scheduled job configuration.
+ */
+interface ScheduledJobConfig {
+  /** Unique name for the schedule */
+  name: string;
+  /** Cron expression (e.g., '0 0 * * *' for daily at midnight) */
+  cronExpression: string;
+  /** Job type to enqueue */
+  jobType: string;
+  /** Job payload (can be a function for dynamic payloads) */
+  payload?: unknown | (() => unknown | Promise<unknown>);
+  /** Enqueue options */
+  options?: types_d_exports.EnqueueOptions;
+  /** Timezone for cron evaluation (default: UTC) */
+  timezone?: string;
+  /** Whether the schedule is enabled */
+  enabled?: boolean;
+  /** Description */
+  description?: string;
+}
+/**
+ * Active scheduled job with next run time.
+ */
+interface ActiveSchedule extends ScheduledJobConfig {
+  nextRun: Date | null;
+  lastRun: Date | null;
+}
+/**
+ * Job scheduler for recurring jobs.
+ */
+declare class JobScheduler {
+  private readonly queue;
+  private readonly schedules;
+  private timer?;
+  private readonly checkIntervalMs;
+  constructor(queue: types_d_exports.JobQueue, options?: {
+    checkIntervalMs?: number;
+  });
+  /**
+   * Add a scheduled job.
+   */
+  schedule(config: ScheduledJobConfig): void;
+  /**
+   * Remove a scheduled job.
+   */
+  unschedule(name: string): boolean;
+  /**
+   * Enable a scheduled job.
+   */
+  enable(name: string): boolean;
+  /**
+   * Disable a scheduled job.
+   */
+  disable(name: string): boolean;
+  /**
+   * Get all schedules.
+   */
+  getSchedules(): ActiveSchedule[];
+  /**
+   * Get a specific schedule.
+   */
+  getSchedule(name: string): ActiveSchedule | undefined;
+  /**
+   * Start the scheduler.
+   */
+  start(): void;
+  /**
+   * Stop the scheduler.
+   */
+  stop(): void;
+  /**
+   * Check and enqueue due schedules.
+   */
+  private checkSchedules;
+}
+/**
+ * Create a job scheduler instance.
+ */
+declare function createScheduler(queue: types_d_exports.JobQueue, options?: {
+  checkIntervalMs?: number;
+}): JobScheduler;
+/**
+ * Helper to define a scheduled job configuration.
+ */
+declare function defineSchedule(config: ScheduledJobConfig): ScheduledJobConfig;
+//#endregion
+export { ActiveSchedule, JobScheduler, ScheduledJobConfig, createScheduler, defineSchedule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lssm/lib.jobs",
-  "version": "0.0.0-canary-20251217052941",
+  "version": "0.0.0-canary-20251217060433",
   "description": "Background jobs and scheduler module for ContractSpec applications",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,36 +18,36 @@
     "lint:check": "eslint src"
   },
   "dependencies": {
-    "@lssm/lib.schema": "0.0.0-canary-20251217052941",
-    "@lssm/lib.contracts": "0.0.0-canary-20251217052941",
-    "@lssm/lib.logger": "0.0.0-canary-20251217052941",
+    "@lssm/lib.schema": "0.0.0-canary-20251217060433",
+    "@lssm/lib.contracts": "0.0.0-canary-20251217060433",
+    "@lssm/lib.logger": "0.0.0-canary-20251217060433",
     "@aws-sdk/client-sqs": "^3.948.0",
     "zod": "^4.1.13",
     "cron-parser": "^5.4.0"
   },
   "devDependencies": {
-    "@lssm/tool.typescript": "0.0.0-canary-20251217052941",
-    "@lssm/tool.tsdown": "0.0.0-canary-20251217052941",
+    "@lssm/tool.typescript": "0.0.0-canary-20251217060433",
+    "@lssm/tool.tsdown": "0.0.0-canary-20251217060433",
     "typescript": "^5.9.3"
   },
   "exports": {
-    ".": "./src/index.ts",
-    "./contracts": "./src/contracts/index.ts",
-    "./entities": "./src/entities/index.ts",
-    "./events": "./src/events.ts",
-    "./handlers": "./src/handlers/index.ts",
-    "./handlers/gmail-sync-handler": "./src/handlers/gmail-sync-handler.ts",
-    "./handlers/ping-job": "./src/handlers/ping-job.ts",
-    "./handlers/storage-document-handler": "./src/handlers/storage-document-handler.ts",
-    "./jobs.feature": "./src/jobs.feature.ts",
-    "./queue": "./src/queue/index.ts",
-    "./queue/gcp-cloud-tasks": "./src/queue/gcp-cloud-tasks.ts",
-    "./queue/gcp-pubsub": "./src/queue/gcp-pubsub.ts",
-    "./queue/memory-queue": "./src/queue/memory-queue.ts",
-    "./queue/register-defined-job": "./src/queue/register-defined-job.ts",
-    "./queue/scaleway-sqs-queue": "./src/queue/scaleway-sqs-queue.ts",
-    "./queue/types": "./src/queue/types.ts",
-    "./scheduler": "./src/scheduler/index.ts",
+    ".": "./dist/index.js",
+    "./contracts": "./dist/contracts/index.js",
+    "./entities": "./dist/entities/index.js",
+    "./events": "./dist/events.js",
+    "./handlers": "./dist/handlers/index.js",
+    "./handlers/gmail-sync-handler": "./dist/handlers/gmail-sync-handler.js",
+    "./handlers/ping-job": "./dist/handlers/ping-job.js",
+    "./handlers/storage-document-handler": "./dist/handlers/storage-document-handler.js",
+    "./jobs.feature": "./dist/jobs.feature.js",
+    "./queue": "./dist/queue/index.js",
+    "./queue/gcp-cloud-tasks": "./dist/queue/gcp-cloud-tasks.js",
+    "./queue/gcp-pubsub": "./dist/queue/gcp-pubsub.js",
+    "./queue/memory-queue": "./dist/queue/memory-queue.js",
+    "./queue/register-defined-job": "./dist/queue/register-defined-job.js",
+    "./queue/scaleway-sqs-queue": "./dist/queue/scaleway-sqs-queue.js",
+    "./queue/types": "./dist/queue/types.js",
+    "./scheduler": "./dist/scheduler/index.js",
     "./*": "./*"
   },
   "module": "./dist/index.js",