@tsed/bullmq 7.79.4 → 7.80.0

package/lib/types-esm/BullMQModule.d.ts

@@ -0,0 +1,23 @@
+import { BeforeInit, OnDestroy } from "@tsed/common";
+import { InjectorService } from "@tsed/di";
+import { BullMQConfig } from "./config/config.js";
+import { JobDispatcher } from "./dispatchers/index.js";
+export declare class BullMQModule implements BeforeInit, OnDestroy {
+    private readonly injector;
+    private readonly dispatcher;
+    constructor(injector: InjectorService, dispatcher: JobDispatcher);
+    get config(): BullMQConfig;
+    $beforeInit(): void;
+    $onDestroy(): Promise<void>;
+    isEnabled(): boolean;
+    isWorkerEnabled(): boolean | undefined;
+    private buildQueues;
+    private buildWorkers;
+    /**
+     * Auto discover queue names from provider and merge it with queue names from global configuration.
+     * @private
+     */
+    private getUniqQueueNames;
+    private getJob;
+    private onProcess;
+}

package/lib/types-esm/config/config.d.ts

@@ -0,0 +1,54 @@
+import type { ConnectionOptions, DefaultJobOptions, QueueOptions, WorkerOptions } from "bullmq";
+export type BullMQConfig = {
+    /**
+     * Specify queue name's to create
+     */
+    queues?: string[];
+    /**
+     * Default connection to use for queue's and worker's
+     */
+    connection: ConnectionOptions;
+    /**
+     * @deprecated Use defaultQueueOptions instead. Will be removed in the next major release
+     */
+    defaultJobOptions?: DefaultJobOptions;
+    /**
+     * Default queue options which are applied to every queue
+     *
+     * Can be extended/overridden by `queueOptions`
+     */
+    defaultQueueOptions?: Partial<QueueOptions>;
+    /**
+     * Specify additional queue options by queue name
+     */
+    queueOptions?: Record<string, Partial<QueueOptions>>;
+    /**
+     * Disable the creation of any worker.
+     *
+     * All other worker configuration will be ignored
+     */
+    disableWorker?: boolean;
+    /**
+     * Specify for which queues to start a worker for.
+     *
+     * Defaultly for every queue added in the `queues` parameter
+     */
+    workerQueues?: string[];
+    /**
+     * Default worker options which are applied to every worker
+     *
+     * Can be extended/overridden by `workerOptions`
+     */
+    defaultWorkerOptions?: Partial<WorkerOptions>;
+    /**
+     * Specify additional worker options by queue name
+     */
+    workerOptions?: Record<string, Partial<WorkerOptions>>;
+};
+declare global {
+    namespace TsED {
+        interface Configuration {
+            bullmq?: BullMQConfig;
+        }
+    }
+}

package/lib/types-esm/constants/BullMQTypes.d.ts

@@ -0,0 +1,7 @@
+export declare enum BullMQTypes {
+    CRON = "bullmq:cron",
+    QUEUE = "bullmq:queue",
+    JOB = "bullmq:job",
+    WORKER = "bullmq:worker",
+    FALLBACK_JOB = "bullmq:fallback-job"
+}

package/lib/types-esm/constants/constants.d.ts

@@ -0,0 +1 @@
+export declare const BULLMQ = "bullmq";

package/lib/types-esm/contracts/JobMethods.d.ts

@@ -0,0 +1,5 @@
+import { Job } from "bullmq";
+export interface JobMethods<DataType = unknown, ReturnType = unknown> {
+    handle(payload: DataType, job: Job<DataType, ReturnType>): ReturnType | Promise<ReturnType>;
+    jobId?(payload: DataType): string | Promise<string>;
+}

package/lib/types-esm/contracts/JobStore.d.ts

@@ -0,0 +1,6 @@
+import { JobsOptions } from "bullmq";
+export interface JobStore {
+    name: string;
+    queue: string;
+    opts: JobsOptions;
+}

package/lib/types-esm/contracts/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./JobMethods.js";
+export * from "./JobStore.js";

package/lib/types-esm/decorators/InjectQueue.d.ts

@@ -0,0 +1 @@
+export declare function InjectQueue(name: string): Function;

package/lib/types-esm/decorators/InjectWorker.d.ts

@@ -0,0 +1 @@
+export declare function InjectWorker(name: string): Function;

package/lib/types-esm/decorators/JobController.d.ts

@@ -0,0 +1,3 @@
+import { JobsOptions } from "bullmq";
+export declare function JobController(name: string, queue?: string, opts?: JobsOptions): any;
+export declare function FallbackJobController(queue?: string): any;

package/lib/types-esm/decorators/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./InjectQueue.js";
+export * from "./InjectWorker.js";
+export * from "./JobController.js";

package/lib/types-esm/dispatchers/JobDispatcher.d.ts

@@ -0,0 +1,14 @@
+import { Type } from "@tsed/core";
+import { InjectorService } from "@tsed/di";
+import { Job as BullMQJob, JobsOptions } from "bullmq";
+import { JobMethods } from "../contracts/index.js";
+import type { JobDispatcherOptions } from "./JobDispatcherOptions.js";
+export declare class JobDispatcher {
+    private readonly injector;
+    constructor(injector: InjectorService);
+    dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0], options?: JobsOptions): Promise<BullMQJob>;
+    dispatch<P = unknown>(job: JobDispatcherOptions, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
+    dispatch<P = unknown>(job: string, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
+    private resolveDispatchArgs;
+    private retrieveJobOptionsFromClassBasedJob;
+}

package/lib/types-esm/dispatchers/JobDispatcherOptions.d.ts

@@ -0,0 +1,4 @@
+export interface JobDispatcherOptions {
+    queue: string;
+    name: string;
+}

package/lib/types-esm/dispatchers/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./JobDispatcher.js";
+export * from "./JobDispatcherOptions.js";

package/lib/types-esm/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./BullMQModule.js";
+export * from "./config/config.js";
+export * from "./constants/BullMQTypes.js";
+export * from "./constants/constants.js";
+export * from "./contracts/index.js";
+export * from "./contracts/JobMethods.js";
+export * from "./contracts/JobStore.js";
+export * from "./decorators/index.js";
+export * from "./decorators/InjectQueue.js";
+export * from "./decorators/InjectWorker.js";
+export * from "./decorators/JobController.js";
+export * from "./dispatchers/index.js";
+export * from "./dispatchers/JobDispatcher.js";
+export * from "./dispatchers/JobDispatcherOptions.js";
+export * from "./utils/createQueueProvider.js";
+export * from "./utils/createWorkerProvider.js";
+export * from "./utils/getJobToken.js";
+export * from "./utils/getQueueToken.js";
+export * from "./utils/getWorkerToken.js";
+export * from "./utils/mapQueueOptions.js";
+export * from "./utils/mapWorkerOptions.js";

package/lib/types-esm/utils/createQueueProvider.d.ts

@@ -0,0 +1,3 @@
+import { InjectorService } from "@tsed/di";
+import { Queue, QueueOptions } from "bullmq";
+export declare function createQueueProvider(injector: InjectorService, queue: string, opts: QueueOptions): Queue<any, any, string>;

package/lib/types-esm/utils/createWorkerProvider.d.ts

@@ -0,0 +1,3 @@
+import { InjectorService } from "@tsed/di";
+import { Job, Worker, WorkerOptions } from "bullmq";
+export declare function createWorkerProvider(injector: InjectorService, worker: string, process: (job: Job) => any, opts: WorkerOptions): Worker<any, any, string>;

package/lib/types-esm/utils/getJobToken.d.ts

@@ -0,0 +1,2 @@
+export declare function getJobToken(queue: string, name: string): string;
+export declare function getFallbackJobToken(queue?: string): string;

package/lib/types-esm/utils/getQueueToken.d.ts

@@ -0,0 +1 @@
+export declare function getQueueToken(queue: string): string;

package/lib/types-esm/utils/getWorkerToken.d.ts

@@ -0,0 +1 @@
+export declare function getWorkerToken(worker: string): string;

package/lib/types-esm/utils/mapQueueOptions.d.ts

@@ -0,0 +1,3 @@
+import type { QueueOptions } from "bullmq";
+import { BullMQConfig } from "../config/config.js";
+export declare function mapQueueOptions(queue: string, bullMQConfig: BullMQConfig): QueueOptions;

package/lib/types-esm/utils/mapWorkerOptions.d.ts

@@ -0,0 +1,3 @@
+import type { WorkerOptions } from "bullmq";
+import { BullMQConfig } from "../config/config.js";
+export declare function mapWorkerOptions(queue: string, bullMQConfig: BullMQConfig): WorkerOptions;

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@tsed/bullmq",
-  "version": "7.79.4",
   "description": "BullMQ integration for Ts.ED",
+  "type": "commonjs",
+  "version": "7.80.0",
   "keywords": [
     "Ts.ED",
     "BullMQ"
@@ -11,32 +12,34 @@
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js",
-    "default": "./lib/esm/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/cjs/index.js"
+    }
   },
   "scripts": {
     "build": "yarn barrels && yarn build:ts",
     "barrels": "barrels",
-    "test": "jest --runInBand && jest-coverage-thresholds-bumper",
-    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "dependencies": {
     "tslib": "2.6.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "7.79.4",
-    "@tsed/common": "7.79.4",
-    "@tsed/core": "7.79.4",
-    "@tsed/di": "7.79.4",
-    "@tsed/schema": "7.79.4",
-    "@tsed/typescript": "7.79.4",
+    "@tsed/barrels": "7.80.0",
+    "@tsed/common": "7.80.0",
+    "@tsed/core": "7.80.0",
+    "@tsed/di": "7.80.0",
+    "@tsed/schema": "7.80.0",
+    "@tsed/typescript": "7.80.0",
     "bullmq": "^4.12.3 || ^5.1.1",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
     "ts-mockito": "^2.6.1",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "vitest": "2.0.4"
   },
   "peerDependencies": {
     "bullmq": "^4.12.3 || ^5.1.1"

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);

package/lib/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}