@shrub/queue 0.5.70 → 0.5.73

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./manager";
 export * from "./module";
 export * from "./queue";
 export * from "./service";

package/dist/index.js

@@ -10,7 +10,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./manager"), exports);
 __exportStar(require("./module"), exports);
 __exportStar(require("./queue"), exports);
 __exportStar(require("./service"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCO0FBQ3pCLDBDQUF3QjtBQUN4Qiw0Q0FBMEIifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsNENBQTBCO0FBQzFCLDJDQUF5QjtBQUN6QiwwQ0FBd0I7QUFDeEIsNENBQTBCIn0=

package/dist/manager.d.ts

@@ -0,0 +1,28 @@
+import { IJob, IJobRepeatOptions, IWorker, WorkerCallback } from "./queue";
+import { IQueueService } from "./service";
+export declare type JobData<T> = T extends JobType<infer TData> ? TData : never;
+export declare type JobReturnValue<T> = T extends JobType<any, infer TReturnValue> ? TReturnValue : never;
+export declare type JobType<TData = any, TReturnValue = void> = {};
+export declare type JobTypes = {
+    [key: string]: JobType<any>;
+};
+/** Defines the contract for the queue manager. */
+export interface IQueueManager<TJobTypes extends JobTypes> {
+    add<T extends keyof TJobTypes>(name: T, data: JobData<TJobTypes[T]>, repeat?: IJobRepeatOptions): Promise<IJob<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>> | undefined>;
+    close<T extends keyof TJobTypes>(name?: T): Promise<void>;
+    dispose(): Promise<void>;
+    process<T extends keyof TJobTypes>(name: T, callback: WorkerCallback<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>>): IWorker<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>> | undefined;
+}
+/** A helper class responsible for managing multiple queues. The manager will maintain a single instance of each queue as they are referenced. */
+export declare class QueueManager<TJobTypes extends JobTypes> implements IQueueManager<TJobTypes> {
+    private readonly queueService;
+    private readonly queuePrefix;
+    private readonly queues;
+    private isDisposed;
+    constructor(queueService: IQueueService, queuePrefix?: string);
+    add<T extends keyof TJobTypes>(name: T, data: JobData<TJobTypes[T]>, repeat?: IJobRepeatOptions): Promise<IJob<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>> | undefined>;
+    close<T extends keyof TJobTypes>(name?: T): Promise<void>;
+    dispose(): Promise<void>;
+    process<T extends keyof TJobTypes>(name: T, callback: WorkerCallback<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>>): IWorker<JobData<TJobTypes[T]>, JobReturnValue<TJobTypes[T]>> | undefined;
+    private getQueue;
+}

package/dist/manager.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueManager = void 0;
+/** A helper class responsible for managing multiple queues. The manager will maintain a single instance of each queue as they are referenced. */
+class QueueManager {
+    constructor(queueService, queuePrefix = "") {
+        this.queueService = queueService;
+        this.queuePrefix = queuePrefix;
+        this.queues = new Map();
+        this.isDisposed = false;
+    }
+    add(name, data, repeat) {
+        return !this.isDisposed ? this.getQueue(name).add({ name: name.toString(), data, repeat }) : Promise.resolve(undefined);
+    }
+    async close(name) {
+        if (name) {
+            const queue = this.queues.get(name);
+            this.queues.delete(name);
+            return queue ? queue.close() : Promise.resolve();
+        }
+        const queues = Array.from(this.queues.values());
+        this.queues.clear();
+        await Promise.all(queues.map(queue => queue.close()));
+    }
+    dispose() {
+        if (!this.isDisposed) {
+            this.isDisposed = true;
+            return this.close();
+        }
+        return Promise.resolve();
+    }
+    process(name, callback) {
+        return !this.isDisposed ? this.getQueue(name).createWorker(callback) : undefined;
+    }
+    getQueue(jobName) {
+        const queueName = this.queuePrefix + jobName;
+        let queue = this.queues.get(queueName);
+        if (!queue) {
+            queue = this.queueService.getQueue(queueName);
+            this.queues.set(queueName, queue);
+        }
+        return queue;
+    }
+}
+exports.QueueManager = QueueManager;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFuYWdlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9tYW5hZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQWdCQSxpSkFBaUo7QUFDakosTUFBYSxZQUFZO0lBSXJCLFlBQ3FCLFlBQTJCLEVBQzNCLGNBQWMsRUFBRTtRQURoQixpQkFBWSxHQUFaLFlBQVksQ0FBZTtRQUMzQixnQkFBVyxHQUFYLFdBQVcsQ0FBSztRQUxwQixXQUFNLEdBQUcsSUFBSSxHQUFHLEVBQTJCLENBQUM7UUFDckQsZUFBVSxHQUFHLEtBQUssQ0FBQztJQUszQixDQUFDO0lBRUQsR0FBRyxDQUE0QixJQUFPLEVBQUUsSUFBMkIsRUFBRSxNQUEwQjtRQUMzRixPQUFPLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFHLENBQUMsRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLFFBQVEsRUFBRSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzVILENBQUM7SUFFRCxLQUFLLENBQUMsS0FBSyxDQUE0QixJQUFRO1FBQzNDLElBQUksSUFBSSxFQUFFO1lBQ04sTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDcEMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDekIsT0FBTyxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO1NBQ3BEO1FBRUQsTUFBTSxNQUFNLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7UUFDaEQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNwQixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDMUQsQ0FBQztJQUVELE9BQU87UUFDSCxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtZQUNsQixJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksQ0FBQztZQUN2QixPQUFPLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztTQUN2QjtRQUVELE9BQU8sT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQzdCLENBQUM7SUFFRCxPQUFPLENBQTRCLElBQU8sRUFBRSxRQUE2RTtRQUNySCxPQUFPLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztJQUNyRixDQUFDO0lBRU8sUUFBUSxDQUFDLE9BQXdCO1FBQ3JDLE1BQU0sU0FBUyxHQUFHLElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDO1FBQzdDLElBQUksS0FBSyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBRXZDLElBQUksQ0FBQyxLQUFLLEVBQUU7WUFDUixLQUFLLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxRQUFRLENBQUMsU0FBUyxDQUFDLENBQUM7WUFDOUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQ3JDO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztDQUNKO0FBakRELG9DQWlEQyJ9

package/dist/queue.d.ts

@@ -1,15 +1,15 @@
 import { IEvent } from "@sprig/event-emitter";
-export declare type WorkerCallback<TData = any> = (job: IJob<TData>) => Promise<void | any>;
+export declare type WorkerCallback<TData = any, TReturnValue = void> = (job: IJob<TData, TReturnValue>) => Promise<TReturnValue>;
 /** Defines the API for a queue. */
-export interface IQueue {
+export interface IQueue<TData = any, TReturnValue = any> {
     /** The name of the queue. */
     readonly name: string;
     /** Adds a job to the queue. */
-    add<TData = any>(options: IJobOptions<TData>): Promise<IJob<TData>>;
+    add(options: IJobOptions<TData>): Promise<IJob<TData, TReturnValue>>;
     /** Closes the queue and all workers associated with the queue. */
     close(): Promise<void>;
     /** Creates a new worker for handling/processing jobs. */
-    createWorker<TData = any>(optionsOrCallback: IWorkerOptions<TData> | WorkerCallback<TData>): IWorker;
+    createWorker(optionsOrCallback: IWorkerOptions<TData> | WorkerCallback<TData, TReturnValue>): IWorker;
     /** Waits until the queue is ready for processing. */
     waitUntilReady(): Promise<void>;
 }
@@ -19,7 +19,7 @@ export interface IQueueAdapter {
     getQueue(name: string): IQueue | undefined;
 }
 /** Represents a specific instance of a job in the queue. */
-export interface IJob<TData = any> {
+export interface IJob<TData = any, TReturnValue = any> {
     readonly id: string;
     readonly name: string;
     readonly data: TData;
@@ -28,7 +28,7 @@ export interface IJob<TData = any> {
     readonly isFailed: Promise<boolean>;
     readonly progress: number | object;
     updateProgress(progress: number | object): Promise<void>;
-    waitUntilFinished(): Promise<any>;
+    waitUntilFinished(): Promise<TReturnValue>;
 }
 /** Defines options for creating jobs. */
 export interface IJobOptions<TData = any> {
@@ -51,40 +51,40 @@ export interface IJobRepeatOptions {
     readonly immediate?: boolean;
 }
 /** Defines options for registering a process for handling jobs. */
-export interface IWorkerOptions<TData = any> {
+export interface IWorkerOptions<TData = any, TReturnValue = any> {
     /** A callback for handling jobs. */
-    readonly callback: WorkerCallback<TData>;
+    readonly callback: WorkerCallback<TData, TReturnValue>;
     /** Optionally specifies the maximum number of parallel jobs that can be processed at once; if not specified, the underlying queue's default will be used. */
     readonly concurrency?: number;
 }
 /** Defines a worker responsible for processing jobs. */
-export interface IWorker {
+export interface IWorker<TData = any, TReturnValue = any> {
     /** An event that is raised when a job has becomes active. */
-    readonly onJobActive: IEvent<IJobActiveEventArgs>;
+    readonly onJobActive: IEvent<IJobActiveEventArgs<TData, TReturnValue>>;
     /** An event that is raised when a job has completed. */
-    readonly onJobCompleted: IEvent<IJobCompletedEventArgs>;
+    readonly onJobCompleted: IEvent<IJobCompletedEventArgs<TData, TReturnValue>>;
     /** An event that is raised when a job has failed. */
-    readonly onJobFailed: IEvent<IJobFailedEventArgs>;
+    readonly onJobFailed: IEvent<IJobFailedEventArgs<TData, TReturnValue>>;
     /** An event that is raised when a job has reported progress. */
-    readonly onJobProgress: IEvent<IJobProgressEventArgs>;
+    readonly onJobProgress: IEvent<IJobProgressEventArgs<TData, TReturnValue>>;
     /** Closes the worker and all underlying connections. */
     close(): Promise<void>;
     /** Waits until the worker is ready for processing. */
     waitUntilReady(): Promise<void>;
 }
-export interface IJobActiveEventArgs {
-    readonly job: IJob;
+export interface IJobActiveEventArgs<TData = any, TReturnValue = any> {
+    readonly job: IJob<TData, TReturnValue>;
 }
-export interface IJobCompletedEventArgs {
-    readonly job: IJob;
+export interface IJobCompletedEventArgs<TData = any, TReturnValue = any> {
+    readonly job: IJob<TData, TReturnValue>;
     readonly returnValue: any;
 }
-export interface IJobFailedEventArgs {
-    readonly job: IJob;
+export interface IJobFailedEventArgs<TData = any, TReturnValue = any> {
+    readonly job: IJob<TData, TReturnValue>;
     readonly error: Error;
 }
-export interface IJobProgressEventArgs {
-    readonly job: IJob;
+export interface IJobProgressEventArgs<TData = any, TReturnValue = any> {
+    readonly job: IJob<TData, TReturnValue>;
     readonly progress: number | object;
 }
 /** Base class for a queue adapter that accepts a set of names/patterns defining the queue(s) the adapter supports. */

package/dist/service.d.ts

@@ -1,5 +1,9 @@
 import { IQueue } from "./queue";
 export interface IQueueService {
-    getQueue(name: string): IQueue;
+    getQueue<TData = any, TReturnValue = any>(name: string | IQueueName<TData, TReturnValue>): IQueue<TData, TReturnValue>;
 }
+export interface IQueueName<TData = any, TReturnValue = any> {
+    readonly name: string;
+}
+export declare const createQueueName: <TData = any, TReturnValue = any>(name: string) => IQueueName<TData, TReturnValue>;
 export declare const IQueueService: import("@shrub/core").IService<IQueueService>;

package/dist/service.js

@@ -6,9 +6,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueueService = exports.IQueueAdapterService = exports.IQueueService = void 0;
+exports.QueueService = exports.IQueueAdapterService = exports.IQueueService = exports.createQueueName = void 0;
 const core_1 = require("@shrub/core");
 const queue_1 = require("./queue");
+const createQueueName = (name) => ({ name });
+exports.createQueueName = createQueueName;
 exports.IQueueService = core_1.createService("queue-service");
 /** @internal */
 exports.IQueueAdapterService = core_1.createService("queue-adapter-service");
@@ -17,7 +19,8 @@ let QueueService = class QueueService {
     constructor() {
         this.adapters = new queue_1.QueueAdapterCollection();
     }
-    getQueue(name) {
+    getQueue(queueName) {
+        const name = typeof queueName === "string" ? queueName : queueName.name;
         const queue = this.adapters.asQueueAdapter().getQueue(name);
         if (!queue) {
             throw new Error(`No queue adapter found to handle queue with name (${name}).`);
@@ -32,4 +35,4 @@ QueueService = __decorate([
     core_1.Singleton
 ], QueueService);
 exports.QueueService = QueueService;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLHNDQUF1RDtBQUN2RCxtQ0FBd0U7QUFZM0QsUUFBQSxhQUFhLEdBQUcsb0JBQWEsQ0FBZ0IsZUFBZSxDQUFDLENBQUM7QUFFM0UsZ0JBQWdCO0FBQ0gsUUFBQSxvQkFBb0IsR0FBRyxvQkFBYSxDQUF1Qix1QkFBdUIsQ0FBQyxDQUFDO0FBRWpHLGdCQUFnQjtBQUVoQixJQUFhLFlBQVksR0FBekIsTUFBYSxZQUFZO0lBQXpCO1FBQ3FCLGFBQVEsR0FBRyxJQUFJLDhCQUFzQixFQUFFLENBQUM7SUFlN0QsQ0FBQztJQWJHLFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMsY0FBYyxFQUFFLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRTVELElBQUksQ0FBQyxLQUFLLEVBQUU7WUFDUixNQUFNLElBQUksS0FBSyxDQUFDLHFEQUFxRCxJQUFJLElBQUksQ0FBQyxDQUFDO1NBQ2xGO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztJQUVELFFBQVEsQ0FBQyxPQUFzQjtRQUMzQixJQUFJLENBQUMsUUFBUSxDQUFDLGVBQWUsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUMzQyxDQUFDO0NBQ0osQ0FBQTtBQWhCWSxZQUFZO0lBRHhCLGdCQUFTO0dBQ0csWUFBWSxDQWdCeEI7QUFoQlksb0NBQVkifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLHNDQUF1RDtBQUN2RCxtQ0FBd0U7QUFnQmpFLE1BQU0sZUFBZSxHQUFHLENBQWtDLElBQVksRUFBbUMsRUFBRSxDQUFDLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0FBQWpILFFBQUEsZUFBZSxtQkFBa0c7QUFFakgsUUFBQSxhQUFhLEdBQUcsb0JBQWEsQ0FBZ0IsZUFBZSxDQUFDLENBQUM7QUFFM0UsZ0JBQWdCO0FBQ0gsUUFBQSxvQkFBb0IsR0FBRyxvQkFBYSxDQUF1Qix1QkFBdUIsQ0FBQyxDQUFDO0FBRWpHLGdCQUFnQjtBQUVoQixJQUFhLFlBQVksR0FBekIsTUFBYSxZQUFZO0lBQXpCO1FBQ3FCLGFBQVEsR0FBRyxJQUFJLDhCQUFzQixFQUFFLENBQUM7SUFnQjdELENBQUM7SUFkRyxRQUFRLENBQUMsU0FBOEI7UUFDbkMsTUFBTSxJQUFJLEdBQUcsT0FBTyxTQUFTLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUM7UUFDeEUsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxjQUFjLEVBQUUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFNUQsSUFBSSxDQUFDLEtBQUssRUFBRTtZQUNSLE1BQU0sSUFBSSxLQUFLLENBQUMscURBQXFELElBQUksSUFBSSxDQUFDLENBQUM7U0FDbEY7UUFFRCxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRUQsUUFBUSxDQUFDLE9BQXNCO1FBQzNCLElBQUksQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzNDLENBQUM7Q0FDSixDQUFBO0FBakJZLFlBQVk7SUFEeEIsZ0JBQVM7R0FDRyxZQUFZLENBaUJ4QjtBQWpCWSxvQ0FBWSJ9

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@shrub/queue",
     "description": "Provides a basic abstraction and support for job/task queues.",
-    "version": "0.5.70",
+    "version": "0.5.73",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -25,9 +25,9 @@
         "test": "jest"
     },
     "dependencies": {
-        "@shrub/core": "0.5.70",
-        "@shrub/logging": "0.5.70",
+        "@shrub/core": "0.5.73",
+        "@shrub/logging": "0.5.73",
         "@sprig/event-emitter": "^0.2.2"
     },
-    "gitHead": "995c9292a868038d8af7ecf67b0a928b6967ad0f"
+    "gitHead": "4b72fb6f2fbff3de73759c4f4228d24b3e553cb4"
 }