@deenruv/core 1.0.0

package/dist/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.d.ts

@@ -0,0 +1,25 @@
+import { Job } from "../job";
+import { JobBufferStorageStrategy } from "./job-buffer-storage-strategy";
+/**
+ * @description
+ * A {@link JobBufferStorageStrategy} which keeps the buffered jobs in memory. Should
+ * _not_ be used in production, since it will lose data in the event of the server
+ * stopping.
+ *
+ * Instead, use the {@link DefaultJobQueuePlugin} with the `useDatabaseForBuffer: true` option set,
+ * or the {@link BullMQJobQueuePlugin} or another custom strategy with persistent storage.
+ *
+ * @since 1.3.0
+ * @docsCategory JobQueue
+ */
+export declare class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
+    protected bufferStorage: Map<string, Set<Job<any>>>;
+    add(bufferId: string, job: Job): Promise<Job>;
+    bufferSize(bufferIds?: string[]): Promise<{
+        [bufferId: string]: number;
+    }>;
+    flush(bufferIds?: string[]): Promise<{
+        [bufferId: string]: Job[];
+    }>;
+    private getSet;
+}

package/dist/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryJobBufferStorageStrategy = void 0;
+/**
+ * @description
+ * A {@link JobBufferStorageStrategy} which keeps the buffered jobs in memory. Should
+ * _not_ be used in production, since it will lose data in the event of the server
+ * stopping.
+ *
+ * Instead, use the {@link DefaultJobQueuePlugin} with the `useDatabaseForBuffer: true` option set,
+ * or the {@link BullMQJobQueuePlugin} or another custom strategy with persistent storage.
+ *
+ * @since 1.3.0
+ * @docsCategory JobQueue
+ */
+class InMemoryJobBufferStorageStrategy {
+    constructor() {
+        this.bufferStorage = new Map();
+    }
+    async add(bufferId, job) {
+        const set = this.getSet(bufferId);
+        set.add(job);
+        return job;
+    }
+    async bufferSize(bufferIds) {
+        var _a, _b;
+        const ids = bufferIds !== null && bufferIds !== void 0 ? bufferIds : Array.from(this.bufferStorage.keys());
+        const result = {};
+        for (const id of ids) {
+            const size = (_b = (_a = this.bufferStorage.get(id)) === null || _a === void 0 ? void 0 : _a.size) !== null && _b !== void 0 ? _b : 0;
+            result[id] = size;
+        }
+        return result;
+    }
+    async flush(bufferIds) {
+        var _a, _b;
+        const ids = bufferIds !== null && bufferIds !== void 0 ? bufferIds : Array.from(this.bufferStorage.keys());
+        const result = {};
+        for (const id of ids) {
+            const jobs = Array.from((_a = this.bufferStorage.get(id)) !== null && _a !== void 0 ? _a : []);
+            (_b = this.bufferStorage.get(id)) === null || _b === void 0 ? void 0 : _b.clear();
+            result[id] = jobs;
+        }
+        return result;
+    }
+    getSet(bufferId) {
+        const set = this.bufferStorage.get(bufferId);
+        if (set) {
+            return set;
+        }
+        else {
+            const newSet = new Set();
+            this.bufferStorage.set(bufferId, newSet);
+            return newSet;
+        }
+    }
+}
+exports.InMemoryJobBufferStorageStrategy = InMemoryJobBufferStorageStrategy;
+//# sourceMappingURL=in-memory-job-buffer-storage-strategy.js.map

package/dist/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-job-buffer-storage-strategy.js","sourceRoot":"","sources":["../../../src/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;;;GAWG;AACH,MAAa,gCAAgC;IAA7C;QACY,kBAAa,GAAG,IAAI,GAAG,EAAoB,CAAC;IAyCxD,CAAC;IAvCC,KAAK,CAAC,GAAG,CAAC,QAAgB,EAAE,GAAQ;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACb,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,UAAU,CACd,SAAoB;;QAEpB,MAAM,GAAG,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAmC,EAAE,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,MAAA,MAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,0CAAE,IAAI,mCAAI,CAAC,CAAC;YACnD,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,SAAoB;;QAC9B,MAAM,GAAG,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAqC,EAAE,CAAC;QACpD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,mCAAI,EAAE,CAAC,CAAC;YAC1D,MAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,0CAAE,KAAK,EAAE,CAAC;YACpC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,QAAgB;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,GAAG,EAAO,CAAC;YAC9B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACzC,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;CACF;AA1CD,4EA0CC"}

package/dist/job-queue/job-buffer/job-buffer-storage-strategy.d.ts

@@ -0,0 +1,62 @@
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { Job } from "../job";
+/**
+ * @description
+ * This strategy defines where to store jobs that have been collected by a
+ * {@link JobBuffer}.
+ *
+ * :::info
+ *
+ * This is configured via the `jobQueueOptions.jobBufferStorageStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @since 1.3.0
+ * @docsCategory job-queue
+ */
+export interface JobBufferStorageStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Persist a job to the storage medium. The storage format should
+     * take into account the `bufferId` argument, as it is necessary to be
+     * able to later retrieve jobs by that id.
+     */
+    add(bufferId: string, job: Job): Promise<Job>;
+    /**
+     * @description
+     * Returns an object containing the number of buffered jobs arranged by bufferId.
+     *
+     * Passing bufferIds limits the results to the specified bufferIds.
+     * If the array is empty, sizes will be returned for _all_ bufferIds.
+     *
+     * @example
+     * ```ts
+     * const sizes = await myJobBufferStrategy.bufferSize(['buffer-1', 'buffer-2']);
+     *
+     * // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
+     * ```
+     */
+    bufferSize(bufferIds?: string[]): Promise<{
+        [bufferId: string]: number;
+    }>;
+    /**
+     * @description
+     * Clears all jobs from the storage medium which match the specified bufferIds (if the
+     * array is empty, clear for _all_ bufferIds), and returns those jobs in an object
+     * arranged by bufferId
+     *
+     * @example
+     * ```ts
+     * const result = await myJobBufferStrategy.flush(['buffer-1', 'buffer-2']);
+     *
+     * // result = {
+     * //   'buffer-1': [Job, Job, Job, ...],
+     * //   'buffer-2': [Job, Job, Job, ...],
+     * // };
+     * ```
+     */
+    flush(bufferIds?: string[]): Promise<{
+        [bufferId: string]: Job[];
+    }>;
+}

package/dist/job-queue/job-buffer/job-buffer-storage-strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=job-buffer-storage-strategy.js.map

package/dist/job-queue/job-buffer/job-buffer-storage-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-buffer-storage-strategy.js","sourceRoot":"","sources":["../../../src/job-queue/job-buffer/job-buffer-storage-strategy.ts"],"names":[],"mappings":""}

package/dist/job-queue/job-buffer/job-buffer.d.ts

@@ -0,0 +1,98 @@
+import { Job } from "../job";
+import { JobData } from "../types";
+/**
+ * @description
+ * A JobBuffer is used to temporarily prevent jobs from being sent to the job queue for processing.
+ * Instead, it collects certain jobs (as specified by the `collect()` method), and stores them.
+ *
+ * How these buffered jobs are stored is determined by the configured {@link JobBufferStorageStrategy}.
+ *
+ * The JobBuffer can be thought of as a kind of "interceptor" of jobs. That is, when a JobBuffer is active,
+ * it sits in between calls to `JobQueue.add()` and the actual adding of the job to the queue.
+ *
+ * At some later point, the buffer can be flushed (by calling `JobQueue.flush()`), at which point all the jobs
+ * that were collected into the buffer will be removed from the buffer and passed to the `JobBuffer.reduce()` method.
+ * This method is able to perform additional logic to e.g. aggregate many jobs into a single job in order to de-duplicate
+ * work.
+ *
+ * @example
+ * ```ts
+ * // This is a buffer which will collect all the
+ * // 'apply-collection-filters' jobs and buffer them.
+ * export class CollectionJobBuffer implements JobBuffer<ApplyCollectionFiltersJobData> {
+ *   readonly id = 'apply-collection-filters-buffer';
+ *
+ *   collect(job: Job): boolean {
+ *     return job.queueName === 'apply-collection-filters';
+ *   }
+ *
+ *
+ *   // When the buffer gets flushed, this function will be passed all the collected jobs
+ *   // and will reduce them down to a single job that has aggregated all of the collectionIds.
+ *   reduce(collectedJobs: Array<Job<ApplyCollectionFiltersJobData>>): Array<Job<any>> {
+ *     // Concatenate all the collectionIds from all the events that were buffered
+ *     const collectionIdsToUpdate = collectedJobs.reduce((result, job) => {
+ *       return [...result, ...job.data.collectionIds];
+ *     }, [] as ID[]);
+ *
+ *     const referenceJob = collectedJobs[0];
+ *
+ *     // Create a new Job containing all the concatenated collectionIds,
+ *     // de-duplicated to include each collectionId only once.
+ *     const batchedCollectionJob = new Job<ApplyCollectionFiltersJobData>({
+ *       ...referenceJob,
+ *       id: undefined,
+ *       data: {
+ *         collectionIds: unique(collectionIdsToUpdate),
+ *         ctx: referenceJob.data.ctx,
+ *         applyToChangedVariantsOnly: referenceJob.data.applyToChangedVariantsOnly,
+ *       },
+ *     });
+ *
+ *     // Only this single job will get added to the job queue
+ *     return [batchedCollectionJob];
+ *   }
+ * }
+ * ```
+ *
+ * A JobBuffer is used by adding it to the {@link JobQueueService}, at which point it will become active
+ * and start collecting jobs.
+ *
+ * At some later point, the buffer can be flushed, causing the buffered jobs to be passed through the
+ * `reduce()` method and sent to the job queue.
+ *
+ * @example
+ * ```ts
+ * const collectionBuffer = new CollectionJobBuffer();
+ *
+ * await this.jobQueueService.addBuffer(collectionBuffer);
+ *
+ * // Here you can perform some work which would ordinarily
+ * // trigger the 'apply-collection-filters' job, such as updating
+ * // collection filters or changing ProductVariant prices.
+ *
+ * await this.jobQueueService.flush(collectionBuffer);
+ *
+ * await this.jobQueueService.removeBuffer(collectionBuffer);
+ * ```
+ *
+ * @docsCategory JobQueue
+ * @since 1.3.0
+ */
+export interface JobBuffer<Data extends JobData<Data> = object> {
+    readonly id: string;
+    /**
+     * @description
+     * This method is called whenever a job is added to the job queue. If it returns `true`, then
+     * the job will be _buffered_ and _not_ added to the job queue. If it returns `false`, the job
+     * will be added to the job queue as normal.
+     */
+    collect(job: Job<Data>): boolean | Promise<boolean>;
+    /**
+     * @description
+     * This method is called whenever the buffer gets flushed via a call to `JobQueueService.flush()`.
+     * It allows logic to be run on the buffered jobs which enables optimizations such as
+     * aggregating and de-duplicating the work of many jobs into one job.
+     */
+    reduce(collectedJobs: Array<Job<Data>>): Array<Job<Data>> | Promise<Array<Job<Data>>>;
+}

package/dist/job-queue/job-buffer/job-buffer.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=job-buffer.js.map

package/dist/job-queue/job-buffer/job-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-buffer.js","sourceRoot":"","sources":["../../../src/job-queue/job-buffer/job-buffer.ts"],"names":[],"mappings":""}

package/dist/job-queue/job-buffer/job-buffer.service.d.ts

@@ -0,0 +1,21 @@
+import { ConfigService } from "../../config/config.service";
+import { Job } from "../job";
+import { JobBuffer } from "./job-buffer";
+/**
+ * @description
+ * Used to manage {@link JobBuffer}s.Primarily intended to be used internally by the {@link JobQueueService}, which
+ * exposes its public-facing functionality.
+ */
+export declare class JobBufferService {
+    private configService;
+    private buffers;
+    private storageStrategy;
+    constructor(configService: ConfigService);
+    addBuffer(buffer: JobBuffer<any>): void;
+    removeBuffer(buffer: JobBuffer<any>): void;
+    add(job: Job): Promise<boolean>;
+    bufferSize(forBuffers?: Array<JobBuffer | string>): Promise<{
+        [bufferId: string]: number;
+    }>;
+    flush(forBuffers?: Array<JobBuffer | string>): Promise<Job[]>;
+}

package/dist/job-queue/job-buffer/job-buffer.service.js

@@ -0,0 +1,82 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobBufferService = void 0;
+const common_1 = require("@nestjs/common");
+const errors_1 = require("../../common/error/errors");
+const config_service_1 = require("../../config/config.service");
+const deenruv_logger_1 = require("../../config/logger/deenruv-logger");
+/**
+ * @description
+ * Used to manage {@link JobBuffer}s.Primarily intended to be used internally by the {@link JobQueueService}, which
+ * exposes its public-facing functionality.
+ */
+let JobBufferService = class JobBufferService {
+    constructor(configService) {
+        this.configService = configService;
+        this.buffers = new Set();
+        this.storageStrategy =
+            configService.jobQueueOptions.jobBufferStorageStrategy;
+    }
+    addBuffer(buffer) {
+        const idAlreadyExists = Array.from(this.buffers).find((p) => p.id === buffer.id);
+        if (idAlreadyExists) {
+            throw new errors_1.InternalServerError(`There is already a JobBufferProcessor with the id "${buffer.id}". Ids must be unique`);
+        }
+        this.buffers.add(buffer);
+    }
+    removeBuffer(buffer) {
+        this.buffers.delete(buffer);
+    }
+    async add(job) {
+        let collected = false;
+        for (const buffer of this.buffers) {
+            const shouldCollect = await buffer.collect(job);
+            if (shouldCollect) {
+                collected = true;
+                await this.storageStrategy.add(buffer.id, job);
+            }
+        }
+        return collected;
+    }
+    bufferSize(forBuffers) {
+        const buffer = forBuffers !== null && forBuffers !== void 0 ? forBuffers : Array.from(this.buffers);
+        return this.storageStrategy.bufferSize(buffer.map((p) => (typeof p === "string" ? p : p.id)));
+    }
+    async flush(forBuffers) {
+        const { jobQueueStrategy } = this.configService.jobQueueOptions;
+        const buffers = forBuffers !== null && forBuffers !== void 0 ? forBuffers : Array.from(this.buffers);
+        const flushResult = await this.storageStrategy.flush(buffers.map((p) => (typeof p === "string" ? p : p.id)));
+        const result = [];
+        for (const buffer of this.buffers) {
+            const jobsForBuffer = flushResult[buffer.id];
+            if (jobsForBuffer === null || jobsForBuffer === void 0 ? void 0 : jobsForBuffer.length) {
+                let jobsToAdd = jobsForBuffer;
+                try {
+                    jobsToAdd = await buffer.reduce(jobsForBuffer);
+                }
+                catch (e) {
+                    deenruv_logger_1.Logger.error(`Error encountered processing jobs in JobBuffer "${buffer.id}":\n${JSON.stringify(e.message)}`, undefined, e.stack);
+                }
+                for (const job of jobsToAdd) {
+                    result.push(await jobQueueStrategy.add(job));
+                }
+            }
+        }
+        return result;
+    }
+};
+exports.JobBufferService = JobBufferService;
+exports.JobBufferService = JobBufferService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [config_service_1.ConfigService])
+], JobBufferService);
+//# sourceMappingURL=job-buffer.service.js.map

package/dist/job-queue/job-buffer/job-buffer.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-buffer.service.js","sourceRoot":"","sources":["../../../src/job-queue/job-buffer/job-buffer.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAE5C,sDAAgE;AAChE,gEAA4D;AAC5D,uEAA4D;AAM5D;;;;GAIG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAI3B,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QAHxC,YAAO,GAAG,IAAI,GAAG,EAAa,CAAC;QAIrC,IAAI,CAAC,eAAe;YAClB,aAAa,CAAC,eAAe,CAAC,wBAAwB,CAAC;IAC3D,CAAC;IAED,SAAS,CAAC,MAAsB;QAC9B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CACnD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAC1B,CAAC;QACF,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,IAAI,4BAAmB,CAC3B,sDAAsD,MAAM,CAAC,EAAE,uBAAuB,CACvF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,YAAY,CAAC,MAAsB;QACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAQ;QAChB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChD,IAAI,aAAa,EAAE,CAAC;gBAClB,SAAS,GAAG,IAAI,CAAC;gBACjB,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,UAAU,CACR,UAAsC;QAEtC,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CACpC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACtD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,UAAsC;QAChD,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC;QAChE,MAAM,OAAO,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAClD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACvD,CAAC;QACF,MAAM,MAAM,GAAU,EAAE,CAAC;QACzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,EAAE,CAAC;gBAC1B,IAAI,SAAS,GAAG,aAAa,CAAC;gBAC9B,IAAI,CAAC;oBACH,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBACjD,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,uBAAM,CAAC,KAAK,CACV,mDAAmD,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,SAAS,CAC/E,CAAC,CAAC,OAAO,CACV,EAAE,EACH,SAAS,EACT,CAAC,CAAC,KAAK,CACR,CAAC;gBACJ,CAAC;gBACD,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;oBAC5B,MAAM,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AA3EY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,mBAAU,GAAE;qCAKwB,8BAAa;GAJrC,gBAAgB,CA2E5B"}

package/dist/job-queue/job-queue.d.ts

@@ -0,0 +1,63 @@
+import { JobQueueStrategy } from "../config";
+import { JobBufferService } from "./job-buffer/job-buffer.service";
+import { SubscribableJob } from "./subscribable-job";
+import { CreateQueueOptions, JobData, JobOptions } from "./types";
+/**
+ * @description
+ * A JobQueue is used to process {@link Job}s. A job is added to the queue via the
+ * `.add()` method, and the configured {@link JobQueueStrategy} will check for new jobs and process each
+ * according to the defined `process` function.
+ *
+ * *Note*: JobQueue instances should not be directly instantiated. Rather, the
+ * {@link JobQueueService} `createQueue()` method should be used (see that service
+ * for example usage).
+ *
+ * @docsCategory JobQueue
+ */
+export declare class JobQueue<Data extends JobData<Data> = object> {
+    private options;
+    private jobQueueStrategy;
+    private jobBufferService;
+    private running;
+    get name(): string;
+    get started(): boolean;
+    constructor(options: CreateQueueOptions<Data>, jobQueueStrategy: JobQueueStrategy, jobBufferService: JobBufferService);
+    /** @internal */
+    start(): Promise<void>;
+    /** @internal */
+    stop(): Promise<void>;
+    /**
+     * @description
+     * Adds a new {@link Job} to the queue. The resolved {@link SubscribableJob} allows the
+     * calling code to subscribe to updates to the Job:
+     *
+     * @example
+     * ```ts
+     * const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+     * return job.updates().pipe(
+     *   map(update => {
+     *     // The returned Observable will emit a value for every update to the job
+     *     // such as when the `progress` or `status` value changes.
+     *     Logger.info(`Job ${update.id}: progress: ${update.progress}`);
+     *     if (update.state === JobState.COMPLETED) {
+     *       Logger.info(`COMPLETED ${update.id}: ${update.result}`);
+     *     }
+     *     return update.result;
+     *   }),
+     *   catchError(err => of(err.message)),
+     * );
+     * ```
+     *
+     * Alternatively, if you aren't interested in the intermediate
+     * `progress` changes, you can convert to a Promise like this:
+     *
+     * @example
+     * ```ts
+     * const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+     * return job.updates().toPromise()
+     *   .then(update => update.result),
+     *   .catch(err => err.message);
+     * ```
+     */
+    add(data: Data, options?: JobOptions<Data>): Promise<SubscribableJob<Data>>;
+}

package/dist/job-queue/job-queue.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobQueue = void 0;
+const job_1 = require("./job");
+const subscribable_job_1 = require("./subscribable-job");
+/**
+ * @description
+ * A JobQueue is used to process {@link Job}s. A job is added to the queue via the
+ * `.add()` method, and the configured {@link JobQueueStrategy} will check for new jobs and process each
+ * according to the defined `process` function.
+ *
+ * *Note*: JobQueue instances should not be directly instantiated. Rather, the
+ * {@link JobQueueService} `createQueue()` method should be used (see that service
+ * for example usage).
+ *
+ * @docsCategory JobQueue
+ */
+class JobQueue {
+    get name() {
+        return this.options.name;
+    }
+    get started() {
+        return this.running;
+    }
+    constructor(options, jobQueueStrategy, jobBufferService) {
+        this.options = options;
+        this.jobQueueStrategy = jobQueueStrategy;
+        this.jobBufferService = jobBufferService;
+        this.running = false;
+    }
+    /** @internal */
+    async start() {
+        if (this.running) {
+            return;
+        }
+        this.running = true;
+        await this.jobQueueStrategy.start(this.options.name, this.options.process);
+    }
+    /** @internal */
+    async stop() {
+        if (!this.running) {
+            return;
+        }
+        this.running = false;
+        return this.jobQueueStrategy.stop(this.options.name, this.options.process);
+    }
+    /**
+     * @description
+     * Adds a new {@link Job} to the queue. The resolved {@link SubscribableJob} allows the
+     * calling code to subscribe to updates to the Job:
+     *
+     * @example
+     * ```ts
+     * const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+     * return job.updates().pipe(
+     *   map(update => {
+     *     // The returned Observable will emit a value for every update to the job
+     *     // such as when the `progress` or `status` value changes.
+     *     Logger.info(`Job ${update.id}: progress: ${update.progress}`);
+     *     if (update.state === JobState.COMPLETED) {
+     *       Logger.info(`COMPLETED ${update.id}: ${update.result}`);
+     *     }
+     *     return update.result;
+     *   }),
+     *   catchError(err => of(err.message)),
+     * );
+     * ```
+     *
+     * Alternatively, if you aren't interested in the intermediate
+     * `progress` changes, you can convert to a Promise like this:
+     *
+     * @example
+     * ```ts
+     * const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+     * return job.updates().toPromise()
+     *   .then(update => update.result),
+     *   .catch(err => err.message);
+     * ```
+     */
+    async add(data, options) {
+        var _a;
+        const job = new job_1.Job({
+            data,
+            queueName: this.options.name,
+            retries: (_a = options === null || options === void 0 ? void 0 : options.retries) !== null && _a !== void 0 ? _a : 0,
+        });
+        const isBuffered = await this.jobBufferService.add(job);
+        if (!isBuffered) {
+            const addedJob = await this.jobQueueStrategy.add(job, options);
+            return new subscribable_job_1.SubscribableJob(addedJob, this.jobQueueStrategy);
+        }
+        else {
+            const bufferedJob = new job_1.Job(Object.assign(Object.assign({}, job), { data: job.data, id: "buffered" }));
+            return new subscribable_job_1.SubscribableJob(bufferedJob, this.jobQueueStrategy);
+        }
+    }
+}
+exports.JobQueue = JobQueue;
+//# sourceMappingURL=job-queue.js.map

package/dist/job-queue/job-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-queue.js","sourceRoot":"","sources":["../../src/job-queue/job-queue.ts"],"names":[],"mappings":";;;AAOA,+BAA4B;AAE5B,yDAAqD;AAGrD;;;;;;;;;;;GAWG;AACH,MAAa,QAAQ;IAGnB,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,YACU,OAAiC,EACjC,gBAAkC,EAClC,gBAAkC;QAFlC,YAAO,GAAP,OAAO,CAA0B;QACjC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAbpC,YAAO,GAAG,KAAK,CAAC;IAcrB,CAAC;IAEJ,gBAAgB;IAChB,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,IAAI,CAAC,OAAO,CAAC,OAAO,CACrB,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,GAAG,CACP,IAAU,EACV,OAA0B;;QAE1B,MAAM,GAAG,GAAG,IAAI,SAAG,CAAM;YACvB,IAAI;YACJ,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YAC5B,OAAO,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,CAAC;SAC/B,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC/D,OAAO,IAAI,kCAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,IAAI,SAAG,iCACtB,GAAG,KACN,IAAI,EAAE,GAAG,CAAC,IAAI,EACd,EAAE,EAAE,UAAU,IACd,CAAC;YACH,OAAO,IAAI,kCAAe,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF;AA9FD,4BA8FC"}

package/dist/job-queue/job-queue.module.d.ts

@@ -0,0 +1,2 @@
+export declare class JobQueueModule {
+}

package/dist/job-queue/job-queue.module.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobQueueModule = void 0;
+const common_1 = require("@nestjs/common");
+const config_module_1 = require("../config/config.module");
+const job_buffer_service_1 = require("./job-buffer/job-buffer.service");
+const job_queue_service_1 = require("./job-queue.service");
+let JobQueueModule = class JobQueueModule {
+};
+exports.JobQueueModule = JobQueueModule;
+exports.JobQueueModule = JobQueueModule = __decorate([
+    (0, common_1.Module)({
+        imports: [config_module_1.ConfigModule],
+        providers: [job_queue_service_1.JobQueueService, job_buffer_service_1.JobBufferService],
+        exports: [job_queue_service_1.JobQueueService, job_buffer_service_1.JobBufferService],
+    })
+], JobQueueModule);
+//# sourceMappingURL=job-queue.module.js.map

package/dist/job-queue/job-queue.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-queue.module.js","sourceRoot":"","sources":["../../src/job-queue/job-queue.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AAExC,2DAAuD;AAEvD,wEAAmE;AACnE,2DAAsD;AAO/C,IAAM,cAAc,GAApB,MAAM,cAAc;CAAG,CAAA;AAAjB,wCAAc;yBAAd,cAAc;IAL1B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,4BAAY,CAAC;QACvB,SAAS,EAAE,CAAC,mCAAe,EAAE,qCAAgB,CAAC;QAC9C,OAAO,EAAE,CAAC,mCAAe,EAAE,qCAAgB,CAAC;KAC7C,CAAC;GACW,cAAc,CAAG"}