@tsed/agenda 8.11.2-rc.1 → 8.12.0-rc.1

package/lib/esm/decorators/agenda.js

@@ -1,8 +1,12 @@
 import { StoreMerge, useDecorators } from "@tsed/core";
 import { Injectable } from "@tsed/di";
 import { PROVIDER_TYPE_AGENDA } from "../constants/constants.js";
-export function Agenda(options) {
+export function JobsController(options) {
     return useDecorators(options?.namespace && StoreMerge("agenda", options), Injectable({
         type: PROVIDER_TYPE_AGENDA
     }));
 }
+/**
+ * @deprecated Use `JobsController` instead.
+ */
+export const Agenda = JobsController;

package/lib/esm/index.js

@@ -1,11 +1,10 @@
 /**
  * @file Automatically generated by @tsed/barrels.
  */
-export * from "./AgendaModule.js";
 export * from "./constants/constants.js";
 export * from "./decorators/agenda.js";
 export * from "./decorators/define.js";
 export * from "./decorators/every.js";
 export * from "./interfaces/AgendaStore.js";
 export * from "./interfaces/interfaces.js";
-export * from "./services/AgendaFactory.js";
+export * from "./services/AgendaService.js";

package/lib/esm/services/AgendaService.js

@@ -0,0 +1,121 @@
+import { constant, DIContext, injectable, injector, logger, runInContext } from "@tsed/di";
+import { $asyncEmit } from "@tsed/hooks";
+import { Agenda } from "agenda";
+import { v4 as uuid } from "uuid";
+import { PROVIDER_TYPE_AGENDA } from "../constants/constants.js";
+function getOpts() {
+    return constant("agenda", { enabled: false });
+}
+function addAgendaDefinitionsForProvider(agenda, provider) {
+    const store = provider.store.get("agenda", {});
+    if (!store.define) {
+        return;
+    }
+    Object.entries(store.define).forEach(([propertyKey, { name, ...options }]) => {
+        const instance = injector().get(provider.token);
+        const jobProcessor = instance[propertyKey].bind(instance);
+        const jobName = getNameForJob(propertyKey, store.namespace, name);
+        agenda.define(jobName, options, jobProcessor);
+    });
+}
+async function scheduleJobsForProvider(agenda, provider) {
+    const store = provider.store.get("agenda", {});
+    if (!store.every) {
+        return;
+    }
+    const promises = Object.entries(store.every).map(([propertyKey, { interval, name, ...options }]) => {
+        const jobName = getNameForJob(propertyKey, store.namespace, name);
+        return agenda.every(interval, jobName, {}, options);
+    });
+    await Promise.all(promises);
+}
+function getNameForJob(propertyKey, namespace, customName) {
+    const name = customName || propertyKey;
+    return namespace ? `${namespace}.${name}` : name;
+}
+async function afterListen(agenda) {
+    const opts = getOpts();
+    if (opts.enabled) {
+        const providers = injector().getProviders(PROVIDER_TYPE_AGENDA);
+        if (!opts.disableJobProcessing) {
+            logger().info({
+                event: "AGENDA_ADD_DEFINITIONS",
+                message: "Agenda add definitions"
+            });
+            providers.forEach((provider) => addAgendaDefinitionsForProvider(agenda, provider));
+            await $asyncEmit("$beforeAgendaStart");
+        }
+        await agenda.start();
+        if (!opts.disableJobProcessing) {
+            logger().info({
+                event: "AGENDA_ADD_JOBS",
+                message: "Agenda add scheduled jobs"
+            });
+            await Promise.all(providers.map((provider) => scheduleJobsForProvider(agenda, provider)));
+            await $asyncEmit("$afterAgendaStart");
+        }
+    }
+}
+async function onDestroy(agenda) {
+    const opts = getOpts();
+    if (opts.enabled) {
+        if (opts.drainJobsBeforeClose && "drain" in agenda) {
+            logger().info({
+                event: "AGENDA_DRAIN",
+                message: "Agenda is draining all jobs before close"
+            });
+            await agenda.drain();
+        }
+        else {
+            logger().info({
+                event: "AGENDA_STOP",
+                message: "Agenda is stopping"
+            });
+            await agenda.stop();
+        }
+        await agenda.close({ force: true });
+        logger().info({ event: "AGENDA_STOP", message: "Agenda stopped" });
+    }
+}
+export const AgendaService = injectable(Agenda)
+    .factory(() => {
+    const opts = getOpts();
+    if (opts.enabled) {
+        const agenda = new Agenda(opts);
+        return new Proxy(agenda, {
+            set(target, prop, value) {
+                return Reflect.set(target, prop, value);
+            },
+            get(target, prop) {
+                if (prop === "agenda") {
+                    return target;
+                }
+                if (prop === "$define") {
+                    return Reflect.get(target, "define", target);
+                }
+                if (prop === "define") {
+                    return (name, options, processor) => {
+                        return target["define"](name, options, (job) => {
+                            const $ctx = new DIContext({
+                                id: uuid()
+                            });
+                            $ctx.set("job", job);
+                            return runInContext($ctx, () => processor(job));
+                        });
+                    };
+                }
+                return Reflect.get(target, prop, target);
+            }
+        });
+    }
+    return new Proxy({}, { get: () => () => Promise.resolve() });
+})
+    .hooks({
+    $afterListen: afterListen,
+    $onDestroy: onDestroy
+})
+    .token();
+/**
+ * @deprecated Use `Agenda` from `agenda` instead.
+ */
+export const AgendaModule = Agenda;

package/lib/types/decorators/agenda.d.ts

@@ -1,5 +1,9 @@
 interface AgendaOptions {
     namespace?: string;
 }
-export declare function Agenda(options?: AgendaOptions): ClassDecorator;
+export declare function JobsController(options?: AgendaOptions): any;
+/**
+ * @deprecated Use `JobsController` instead.
+ */
+export declare const Agenda: typeof JobsController;
 export {};

package/lib/types/index.d.ts

@@ -1,11 +1,10 @@
 /**
  * @file Automatically generated by @tsed/barrels.
  */
-export * from "./AgendaModule.js";
 export * from "./constants/constants.js";
 export * from "./decorators/agenda.js";
 export * from "./decorators/define.js";
 export * from "./decorators/every.js";
 export * from "./interfaces/AgendaStore.js";
 export * from "./interfaces/interfaces.js";
-export * from "./services/AgendaFactory.js";
+export * from "./services/AgendaService.js";

package/lib/types/interfaces/interfaces.d.ts

@@ -1,15 +1,13 @@
 import { AgendaConfig } from "agenda";
+export type AgendaSettings = AgendaConfig & {
+    enabled?: boolean;
+    disableJobProcessing?: boolean;
+    drainJobsBeforeClose?: boolean;
+};
 declare global {
     namespace TsED {
         interface Configuration {
-            agenda?: {
-                /**
-                 * Enable Agenda jobs. Default false.
-                 */
-                enabled?: boolean;
-                disableJobProcessing?: boolean;
-                drainJobsBeforeClose?: boolean;
-            } & AgendaConfig;
+            agenda?: AgendaSettings;
         }
     }
 }

package/lib/types/services/AgendaService.d.ts

@@ -0,0 +1,13 @@
+import { Agenda } from "agenda";
+export declare const AgendaService: {
+    readonly __type: "token_factory";
+};
+/**
+ * @deprecated Use `Agenda` from `agenda` instead.
+ */
+export type AgendaService = Agenda;
+/**
+ * @deprecated Use `Agenda` from `agenda` instead.
+ */
+export declare const AgendaModule: typeof Agenda;
+export type AgendaModule = Agenda;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/agenda",
   "description": "Agenda package for Ts.ED framework",
   "type": "module",
-  "version": "8.11.2-rc.1",
+  "version": "8.12.0-rc.1",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -26,11 +26,11 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.11.2-rc.1",
-    "@tsed/core": "8.11.2-rc.1",
-    "@tsed/di": "8.11.2-rc.1",
-    "@tsed/platform-http": "8.11.2-rc.1",
-    "@tsed/typescript": "8.11.2-rc.1",
+    "@tsed/barrels": "8.12.0-rc.1",
+    "@tsed/core": "8.12.0-rc.1",
+    "@tsed/di": "8.12.0-rc.1",
+    "@tsed/platform-http": "8.12.0-rc.1",
+    "@tsed/typescript": "8.12.0-rc.1",
     "agenda": "^5.0.0",
     "eslint": "9.12.0",
     "typescript": "5.4.5",

package/readme.md

@@ -3,9 +3,9 @@
 </p>
 
 <div align="center">
- 
+
    <h1>Agenda</h1>
- 
+
 [![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
 [![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
 [![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
@@ -84,10 +84,10 @@ Use the `@Define` decorator on methods that you would like to schedule
 programmatically via the AgendaService and Agenda instance access.
 
 ```ts
-import {Agenda, Every, Define} from "@tsed/agenda";
+import {Every, Define, JobsController} from "@tsed/agenda";
 import {Job} from "agenda";
 
-@Agenda({namespace: "email"})
+@JobsController({namespace: "email"})
 export class EmailJobService {
   @Every("60 minutes", {
     name: "maintenanceJob"
@@ -114,15 +114,17 @@ export class EmailJobService {
 
 ## Define a job processor manually
 
-Since Ts.ED 7.53.0, AgendaModule exposes methods to manually define a job processor. It can be useful to define a job processor when you need to fetch data beforehand and dynamically build job name / options.
+Since Ts.ED 7.53.0, AgendaModule exposes methods to manually define a job processor. It can be useful to define a job
+processor when you need to fetch data beforehand and dynamically build job name / options.
 
 ```typescript
-import {Agenda, AgendaModule, Define} from "@tsed/agenda";
+import {Define, JobsController} from "@tsed/agenda";
+import {Agenda} from "agenda";
 
-@Agenda({namespace: "email"})
+@JobsController({namespace: "email"})
 export class EmailJobService {
   @Inject()
-  agenda: AgendaModule;
+  agenda: Agenda;
 
   @Inject()
   httpClient: HttpClient;
@@ -163,15 +165,15 @@ export class EmailJobService {
 Inject the AgendaService instance to interact with it directly, e.g. to schedule
 a job manually.
 
-```typescript
+```ts
 import {Service} from "@tsed/di";
 import {AfterRoutesInit} from "@tsed/platform-params";
-import {AgendaModule} from "@tsed/agenda";
+import {Agenda} from "agenda";
 
 @Service()
 export class UsersService {
   @Inject()
-  private agenda: AgendaModule;
+  private agenda: Agenda;
 
   async create(user: User): Promise<User> {
     // do something
@@ -187,7 +189,8 @@ export class UsersService {
 
 ## Using Agendash
 
-[Agendash](https://github.com/agenda/agendash) provides a job overview dashboard that makes it easy to manage, create and
+[Agendash](https://github.com/agenda/agendash) provides a job overview dashboard that makes it easy to manage, create
+and
 schedule your jobs.
 
 ::: tip Note
@@ -206,8 +209,7 @@ Afterward create the module `agendash.module.ts` in src/modules so that the dash
 import {AfterRoutesInit, PlatformApplication} from "@tsed/platform-http";
 import {Configuration, Inject, Module} from "@tsed/di";
 import {Agenda} from "agenda";
-
-const Agendash = require("agendash");
+import Agendash from "agendash";
 
 @Module()
 export class AgendashModule implements AfterRoutesInit {
@@ -240,7 +242,8 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
 
 ## Sponsors
 
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+Support this project by becoming a sponsor. Your logo will show up here with a link to your
+website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
 
 ## License
 
@@ -248,8 +251,15 @@ The MIT License (MIT)
 
 Copyright (c) 2016 - 2021 Romain Lenzotti
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/esm/AgendaModule.js

@@ -1,131 +0,0 @@
-import { __decorate, __metadata } from "tslib";
-import { Constant, DIContext, Inject, InjectorService, Module, runInContext } from "@tsed/di";
-import { Logger } from "@tsed/logger";
-import { v4 as uuid } from "uuid";
-import { PROVIDER_TYPE_AGENDA } from "./constants/constants.js";
-import { AgendaService } from "./services/AgendaFactory.js";
-let AgendaModule = class AgendaModule {
-    async $afterListen() {
-        if (this.enabled) {
-            const providers = this.getProviders();
-            if (!this.disableJobProcessing) {
-                this.logger.info({
-                    event: "AGENDA_ADD_DEFINITIONS",
-                    message: "Agenda add definitions"
-                });
-                providers.forEach((provider) => this.addAgendaDefinitionsForProvider(provider));
-                await this.injector.emit("$beforeAgendaStart");
-            }
-            await this.agenda.start();
-            if (!this.disableJobProcessing) {
-                this.logger.info({
-                    event: "AGENDA_ADD_JOBS",
-                    message: "Agenda add scheduled jobs"
-                });
-                await Promise.all(providers.map((provider) => this.scheduleJobsForProvider(provider)));
-                await this.injector.emit("$afterAgendaStart");
-            }
-        }
-    }
-    async $onDestroy() {
-        if (this.enabled) {
-            if (this.drainJobsBeforeClose && "drain" in this.agenda) {
-                this.logger.info({
-                    event: "AGENDA_DRAIN",
-                    message: "Agenda is draining all jobs before close"
-                });
-                await this.agenda.drain();
-            }
-            else {
-                this.logger.info({
-                    event: "AGENDA_STOP",
-                    message: "Agenda is stopping"
-                });
-                await this.agenda.stop();
-            }
-            await this.agenda.close({ force: true });
-            this.logger.info({ event: "AGENDA_STOP", message: "Agenda stopped" });
-        }
-    }
-    define(name, options, processor) {
-        return this.agenda.define(name, options, (job) => {
-            const $ctx = new DIContext({
-                injector: this.injector,
-                id: uuid(),
-                logger: this.injector.logger
-            });
-            $ctx.set("job", job);
-            return runInContext($ctx, () => processor(job));
-        });
-    }
-    every(interval, name, data, options) {
-        return this.agenda.every(interval, name, data, options);
-    }
-    schedule(when, name, data) {
-        return this.agenda.schedule(when, name, data);
-    }
-    now(name, data) {
-        return this.agenda.now(name, data);
-    }
-    create(name, data) {
-        return this.agenda.create(name, data);
-    }
-    getProviders() {
-        return this.injector.getProviders(PROVIDER_TYPE_AGENDA);
-    }
-    addAgendaDefinitionsForProvider(provider) {
-        const store = provider.store.get("agenda", {});
-        if (!store.define) {
-            return;
-        }
-        Object.entries(store.define).forEach(([propertyKey, { name, ...options }]) => {
-            const instance = this.injector.get(provider.token);
-            const jobProcessor = instance[propertyKey].bind(instance);
-            const jobName = this.getNameForJob(propertyKey, store.namespace, name);
-            this.define(jobName, options, jobProcessor);
-        });
-    }
-    async scheduleJobsForProvider(provider) {
-        const store = provider.store.get("agenda", {});
-        if (!store.every) {
-            return;
-        }
-        const promises = Object.entries(store.every).map(([propertyKey, { interval, name, ...options }]) => {
-            const jobName = this.getNameForJob(propertyKey, store.namespace, name);
-            return this.every(interval, jobName, {}, options);
-        });
-        await Promise.all(promises);
-    }
-    getNameForJob(propertyKey, namespace, customName) {
-        const name = customName || propertyKey;
-        return namespace ? `${namespace}.${name}` : name;
-    }
-};
-__decorate([
-    Inject(),
-    __metadata("design:type", Logger)
-], AgendaModule.prototype, "logger", void 0);
-__decorate([
-    Inject(),
-    __metadata("design:type", InjectorService)
-], AgendaModule.prototype, "injector", void 0);
-__decorate([
-    Inject(),
-    __metadata("design:type", AgendaService)
-], AgendaModule.prototype, "agenda", void 0);
-__decorate([
-    Constant("agenda.enabled", false),
-    __metadata("design:type", Boolean)
-], AgendaModule.prototype, "enabled", void 0);
-__decorate([
-    Constant("agenda.drainJobsBeforeClose", false),
-    __metadata("design:type", Boolean)
-], AgendaModule.prototype, "drainJobsBeforeClose", void 0);
-__decorate([
-    Constant("agenda.disableJobProcessing", false),
-    __metadata("design:type", Boolean)
-], AgendaModule.prototype, "disableJobProcessing", void 0);
-AgendaModule = __decorate([
-    Module()
-], AgendaModule);
-export { AgendaModule };

package/lib/esm/services/AgendaFactory.js

@@ -1,12 +0,0 @@
-import { Configuration, registerProvider } from "@tsed/di";
-import { Agenda } from "agenda";
-// create Alias to avoid confusing import between Agenda from "agenda" and Agenda decorator
-export const AgendaService = Agenda;
-registerProvider({
-    token: Agenda,
-    deps: [Configuration],
-    useFactory(settings) {
-        const opts = settings.get("agenda", { enabled: false });
-        return opts.enabled ? new Agenda(opts) : {};
-    }
-});

package/lib/types/AgendaModule.d.ts

@@ -1,24 +0,0 @@
-import { InjectorService, OnDestroy, Provider } from "@tsed/di";
-import { Logger } from "@tsed/logger";
-import { AfterListen } from "@tsed/platform-http";
-import { Job } from "agenda";
-import { AgendaService } from "./services/AgendaFactory.js";
-export declare class AgendaModule implements OnDestroy, AfterListen {
-    protected logger: Logger;
-    protected injector: InjectorService;
-    protected agenda: AgendaService;
-    private enabled;
-    private drainJobsBeforeClose;
-    private disableJobProcessing;
-    $afterListen(): Promise<any>;
-    $onDestroy(): Promise<any>;
-    define(name: string, options?: any, processor?: any): void;
-    every(interval: string, name: string, data?: any, options?: any): Promise<any>;
-    schedule(when: Date | string, name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;
-    now(name: string, data?: any): Promise<Job<import("agenda").JobAttributesData>>;
-    create(name: string, data?: any): Job<import("agenda").JobAttributesData>;
-    protected getProviders(): Provider<any>[];
-    protected addAgendaDefinitionsForProvider(provider: Provider): void;
-    protected scheduleJobsForProvider(provider: Provider<any>): Promise<void>;
-    protected getNameForJob(propertyKey: string, namespace?: string, customName?: string): string;
-}

package/lib/types/services/AgendaFactory.d.ts

@@ -1,3 +0,0 @@
-import { Agenda } from "agenda";
-export declare const AgendaService: typeof Agenda;
-export type AgendaService = Agenda;