@outloud/adonis-scheduler 1.0.6 → 1.0.7

package/README.md

@@ -23,6 +23,7 @@
 - Cancellation support for long-running tasks.
 - Graceful shutdown.
 - Global and task-level error handling.
+- Auto-discovery of tasks.
 
 ## Getting Started
 
@@ -57,8 +58,12 @@ export default class TestTask extends Task {
 ```
 
 ### Register a task
+For task to run it must be registered in the scheduler.
 
-For task to run it must be registered in the scheduler. You can register tasks in two ways: using the `start/scheduler.ts` preloaded file or in a provider's `start` method.
+> [!NOTE]
+> By default tasks are auto-discovered using the locations defined in config.
+
+If you want to register tasks manually, you can register tasks in two ways: using the `start/scheduler.ts` preloaded file or in a provider's `start` method.
 
 Using `start/scheduler.ts` file.
 

package/build/{chunk-FOVOD6FP.js → chunk-6VW5PUDE.js}

@@ -1,4 +1,7 @@
+import { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
+import { glob } from 'fs/promises';
+import { resolve } from 'path';
 import { Cron } from 'croner';
 import timers from 'timers/promises';
 
@@ -40,15 +43,18 @@ var Scheduler = class {
         options.command
       ];
       Object.assign(definition, options);
-      definition.loader = () => import('./command.task-GUNK3QFY.js').then((module) => {
+      definition.loader = () => import('./command.task-GALKWNLQ.js').then((module) => {
         return class extends module.CommandTask {
           static command = command;
         };
       });
+    } else if (Task.isTask(options)) {
+      definition.task = options;
+      Object.assign(definition, options.options ?? {});
     } else {
       definition.loader = options;
     }
-    if (!definition.loader) {
+    if (!definition.task && !definition.loader) {
       throw new Error("Task definition must have either a command or a task defined.");
     }
     this.definitions.push(definition);
@@ -69,6 +75,9 @@ var Scheduler = class {
       return;
     }
     this.setState("starting");
+    if (this.config.locations) {
+      await Promise.all(this.config.locations.map((location) => this.registerFromGlob(location)));
+    }
     await Promise.all(this.definitions.map((definition) => this.schedule(definition)));
     if (!this.definitions.length) {
       this.logger.warn("No tasks registered, scheduler will not run any jobs.");
@@ -94,6 +103,20 @@ var Scheduler = class {
     this.errorHandler = callback;
     return this;
   }
+  async registerFromGlob(pattern) {
+    const normalizedPattern = pattern.replace(/\.(?:js|ts)$/, ".{js,ts}");
+    for await (const file of glob(normalizedPattern)) {
+      try {
+        const absolutePath = resolve(file);
+        const module = await import(`file://${absolutePath}`);
+        if (Task.isTask(module.default)) {
+          this.register(module.default);
+        }
+      } catch (error) {
+        console.warn(`Failed to load task from ${file}:`, error);
+      }
+    }
+  }
   async load(definition) {
     if (definition.loader) {
       const module = await definition.loader();

package/build/{chunk-7P6J5U6O.js → chunk-OIXFFNQU.js}

@@ -1,13 +1,16 @@
 import { __name } from './chunk-SHUYVCID.js';
 
 // src/task.ts
-var Task = class {
+var Task = class _Task {
   static {
     __name(this, "Task");
   }
   isCanceled = false;
   promise;
   static options;
+  static isTask(obj) {
+    return typeof obj === "function" && obj.prototype instanceof _Task;
+  }
   // eslint-disable-next-line @typescript-eslint/no-useless-constructor
   constructor(..._) {
   }

package/build/{command.task-GUNK3QFY.js → command.task-GALKWNLQ.js}

@@ -1,4 +1,4 @@
-import { Task } from './chunk-7P6J5U6O.js';
+import { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
 import ace from '@adonisjs/core/services/ace';
 

package/build/commands/scheduler_run.d.ts

@@ -1,6 +1,6 @@
 import { BaseCommand } from '@adonisjs/core/ace';
 import { CommandOptions } from '@adonisjs/core/types/ace';
-import { a as Scheduler } from '../scheduler-DO35E0Fu.js';
+import { a as Scheduler } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';
 import '@adonisjs/lock/types';

package/build/commands/scheduler_run.js

@@ -1,4 +1,5 @@
-import { Scheduler } from '../chunk-FOVOD6FP.js';
+import { Scheduler } from '../chunk-6VW5PUDE.js';
+import '../chunk-OIXFFNQU.js';
 import { __name } from '../chunk-SHUYVCID.js';
 import 'reflect-metadata';
 import { inject } from '@adonisjs/core';

package/build/index.d.ts

@@ -1,5 +1,5 @@
-import { S as SchedulerConfig } from './scheduler-DO35E0Fu.js';
-export { a as Scheduler, T as Task, b as TaskOptions } from './scheduler-DO35E0Fu.js';
+import { S as SchedulerConfig } from './scheduler-vBDqaysB.js';
+export { a as Scheduler, T as Task, b as TaskOptions } from './scheduler-vBDqaysB.js';
 import Configure from '@adonisjs/core/commands/configure';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';

package/build/index.js

@@ -1,5 +1,5 @@
-export { Scheduler } from './chunk-FOVOD6FP.js';
-export { Task } from './chunk-7P6J5U6O.js';
+export { Scheduler } from './chunk-6VW5PUDE.js';
+export { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
 
 // configure.ts

package/build/providers/scheduler.provider.d.ts

@@ -1,5 +1,5 @@
 import { ApplicationService } from '@adonisjs/core/types';
-import { a as Scheduler, c as SchedulerEvents } from '../scheduler-DO35E0Fu.js';
+import { a as Scheduler, c as SchedulerEvents } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/lock/types';
 import '@adonisjs/core/logger';

package/build/providers/scheduler.provider.js

@@ -1,4 +1,5 @@
-import { Scheduler } from '../chunk-FOVOD6FP.js';
+import { Scheduler } from '../chunk-6VW5PUDE.js';
+import '../chunk-OIXFFNQU.js';
 import { __name } from '../chunk-SHUYVCID.js';
 
 // providers/scheduler.provider.ts

package/build/{scheduler-DO35E0Fu.d.ts → scheduler-vBDqaysB.d.ts}

@@ -17,6 +17,8 @@ interface SchedulerConfig {
      * The default ttl for the lock.
      */
     lockDuration: number | string;
+    /** Locations for task auto-discovery */
+    locations?: string[];
 }
 interface TaskOptions {
     /**
@@ -61,6 +63,7 @@ declare abstract class Task {
     isCanceled: boolean;
     promise?: Promise<any>;
     static options: TaskOptions;
+    static isTask(obj: unknown): obj is typeof Task;
     constructor(..._: any[]);
     get name(): string;
     abstract run(...args: any[]): Promise<void>;
@@ -81,10 +84,11 @@ declare class Scheduler {
     private state;
     private errorHandler?;
     constructor(config: SchedulerConfig, resolver: ContainerResolver<ContainerBindings>, logger: Logger, emitter: Emitter<any>, locks?: LockService | undefined);
-    register(options: TaskRegisterOptions | Factory<typeof Task>): this;
+    register(options: TaskRegisterOptions | typeof Task | Factory<typeof Task>): this;
     start(wait?: boolean): Promise<void>;
     stop(): Promise<void>;
     onError(callback: ErrorHandler): this;
+    private registerFromGlob;
     private load;
     private make;
     private run;

package/build/services/main.d.ts

@@ -1,4 +1,4 @@
-import { a as Scheduler } from '../scheduler-DO35E0Fu.js';
+import { a as Scheduler } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';
 import '@adonisjs/lock/types';

package/build/stubs/config/scheduler.stub

@@ -9,6 +9,7 @@ const schedulerConfig = defineConfig({
   httpServer: env.get('SCHEDULER_HTTP_SERVER', false),
   warnWhenLocked: false,
   lockDuration: '10m',
+  locations: ['./app/**/*.task.js'],
 })
 
 export default schedulerConfig

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outloud/adonis-scheduler",
   "type": "module",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Schedule cron jobs in AdonisJS.",
   "author": "Outloud <hello@outloud.co>",
   "contributors": [
@@ -66,7 +66,6 @@
     "postcompile": "pnpm run copy:templates && pnpm run index:commands",
     "build": "rm -rf build && pnpm run compile",
     "release": "release-it",
-    "index:commands": "adonis-kit index build/commands",
-    "version": "pnpm run build"
+    "index:commands": "adonis-kit index build/commands"
   }
 }