@shrub/queue 0.5.71 → 0.5.74

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,5 +1,5 @@
 import { IEvent } from "@sprig/event-emitter";
-export declare type WorkerCallback<TData = any, TReturnValue = any> = (job: IJob<TData, TReturnValue>) => Promise<void | TReturnValue>;
+export declare type WorkerCallback<TData = any, TReturnValue = void> = (job: IJob<TData, TReturnValue>) => Promise<TReturnValue>;
 /** Defines the API for a queue. */
 export interface IQueue<TData = any, TReturnValue = any> {
     /** The name of the queue. */
@@ -15,6 +15,8 @@ export interface IQueue<TData = any, TReturnValue = any> {
 }
 /** Responsible for providing access to a queue. */
 export interface IQueueAdapter {
+    /** Optional callback to dispose the adapter. */
+    readonly dispose?: () => Promise<void>;
     /** Gets a queue with the specified name or undefined if the adapter does not support/recognize the given queue name. */
     getQueue(name: string): IQueue | undefined;
 }
@@ -101,4 +103,5 @@ export declare class QueueAdapterCollection {
     private readonly adapters;
     addQueueAdapter(adapter: IQueueAdapter): void;
     asQueueAdapter(): IQueueAdapter;
+    dispose(): Promise<void>;
 }

package/dist/queue.js

@@ -39,6 +39,15 @@ class QueueAdapterCollection {
             }
         };
     }
+    async dispose() {
+        const promises = [];
+        for (const adapter of this.adapters.splice(0)) {
+            if (adapter.dispose) {
+                promises.push(adapter.dispose());
+            }
+        }
+        await Promise.all(promises);
+    }
 }
 exports.QueueAdapterCollection = QueueAdapterCollection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBc0dwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGdCQUFnQixDQUFDLGlCQUFrRDtRQUN6RSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDO0FBRUQseUhBQXlIO0FBQ3pILE1BQWEsc0JBQXNCO0lBQW5DO1FBQ3FCLGFBQVEsR0FBb0IsRUFBRSxDQUFDO0lBb0JwRCxDQUFDO0lBbEJHLGVBQWUsQ0FBQyxPQUFzQjtRQUNsQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBRUQsY0FBYztRQUNWLE9BQU87WUFDSCxRQUFRLEVBQUUsSUFBSSxDQUFDLEVBQUU7Z0JBQ2IsS0FBSyxNQUFNLE9BQU8sSUFBSSxJQUFJLENBQUMsUUFBUSxFQUFFO29CQUNqQyxNQUFNLEtBQUssR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNyQyxJQUFJLEtBQUssRUFBRTt3QkFDUCxPQUFPLEtBQUssQ0FBQztxQkFDaEI7aUJBQ0o7Z0JBRUQsT0FBTyxTQUFTLENBQUM7WUFDckIsQ0FBQztTQUNKLENBQUM7SUFDTixDQUFDO0NBQ0o7QUFyQkQsd0RBcUJDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVldWUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcXVldWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsMkNBQW9EO0FBd0dwRCxzSEFBc0g7QUFDdEgsTUFBc0IsWUFBWTtJQUc5QixZQUFZLGlCQUEyQjtRQUNuQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksaUNBQXFCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNsRSxDQUFDO0lBRUQsb0JBQW9CLENBQUMsaUJBQTJCO1FBQzVDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVELFFBQVEsQ0FBQyxJQUFZO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDM0YsQ0FBQztJQUlTLGdCQUFnQixDQUFDLGlCQUFrRDtRQUN6RSxPQUFPLE9BQU8saUJBQWlCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxpQkFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUN6RyxDQUFDO0NBQ0o7QUFwQkQsb0NBb0JDO0FBRUQseUhBQXlIO0FBQ3pILE1BQWEsc0JBQXNCO0lBQW5DO1FBQ3FCLGFBQVEsR0FBb0IsRUFBRSxDQUFDO0lBZ0NwRCxDQUFDO0lBOUJHLGVBQWUsQ0FBQyxPQUFzQjtRQUNsQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBRUQsY0FBYztRQUNWLE9BQU87WUFDSCxRQUFRLEVBQUUsSUFBSSxDQUFDLEVBQUU7Z0JBQ2IsS0FBSyxNQUFNLE9BQU8sSUFBSSxJQUFJLENBQUMsUUFBUSxFQUFFO29CQUNqQyxNQUFNLEtBQUssR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNyQyxJQUFJLEtBQUssRUFBRTt3QkFDUCxPQUFPLEtBQUssQ0FBQztxQkFDaEI7aUJBQ0o7Z0JBRUQsT0FBTyxTQUFTLENBQUM7WUFDckIsQ0FBQztTQUNKLENBQUM7SUFDTixDQUFDO0lBRUQsS0FBSyxDQUFDLE9BQU87UUFDVCxNQUFNLFFBQVEsR0FBb0IsRUFBRSxDQUFDO1FBRXJDLEtBQUssTUFBTSxPQUFPLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUU7WUFDM0MsSUFBSSxPQUFPLENBQUMsT0FBTyxFQUFFO2dCQUNqQixRQUFRLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO2FBQ3BDO1NBQ0o7UUFFRCxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDaEMsQ0FBQztDQUNKO0FBakNELHdEQWlDQyJ9

package/package.json

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