@deenruv/core 1.0.0

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

@@ -0,0 +1,116 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { InjectableJobQueueStrategy } from "./injectable-job-queue-strategy";
+import { Job } from "./job";
+import { QueueNameProcessStorage } from "./queue-name-process-storage";
+import { JobData } from "./types";
+/**
+ * @description
+ * Defines the backoff strategy used when retrying failed jobs. Returns the delay in
+ * ms that should pass before the failed job is retried.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export type BackoffStrategy = (queueName: string, attemptsMade: number, job: Job) => number;
+export interface PollingJobQueueStrategyConfig {
+    /**
+     * @description
+     * How many jobs from a given queue to process concurrently.
+     *
+     * @default 1
+     */
+    concurrency?: number;
+    /**
+     * @description
+     * The interval in ms between polling the database for new jobs.
+     *
+     * @description 200
+     */
+    pollInterval?: number | ((queueName: string) => number);
+    /**
+     * @description
+     * When a job is added to the JobQueue using `JobQueue.add()`, the calling
+     * code may specify the number of retries in case of failure. This option allows
+     * you to override that number and specify your own number of retries based on
+     * the job being added.
+     */
+    setRetries?: (queueName: string, job: Job) => number;
+    /**
+     * @description
+     * The strategy used to decide how long to wait before retrying a failed job.
+     *
+     * @default () => 1000
+     */
+    backoffStrategy?: BackoffStrategy;
+    /**
+     * @description
+     * The timeout in ms which the queue will use when attempting a graceful shutdown.
+     * That means, when the server is shut down but a job is running, the job queue will
+     * wait for the job to complete before allowing the server to shut down. If the job
+     * does not complete within this timeout window, the job will be forced to stop
+     * and the server will shut down anyway.
+     *
+     * @since 2.2.0
+     * @default 20_000
+     */
+    gracefulShutdownTimeout?: number;
+}
+declare class ActiveQueue<Data extends JobData<Data> = object> {
+    private readonly queueName;
+    private readonly process;
+    private readonly jobQueueStrategy;
+    private timer;
+    private running;
+    private activeJobs;
+    private errorNotifier$;
+    private queueStopped$;
+    private subscription;
+    private readonly pollInterval;
+    constructor(queueName: string, process: (job: Job<Data>) => Promise<any>, jobQueueStrategy: PollingJobQueueStrategy);
+    start(): void;
+    stop(stopActiveQueueTimeout?: number): Promise<void>;
+    private awaitRunningJobsOrTimeout;
+    private onFailOrComplete;
+    private removeJobFromActive;
+}
+/**
+ * @description
+ * This class allows easier implementation of {@link JobQueueStrategy} in a polling style.
+ * Instead of providing {@link JobQueueStrategy} `start()` you should provide a `next` method.
+ *
+ * This class should be extended by any strategy which does not support a push-based system
+ * to notify on new jobs. It is used by the {@link SqlJobQueueStrategy} and {@link InMemoryJobQueueStrategy}.
+ *
+ * @docsCategory JobQueue
+ */
+export declare abstract class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
+    concurrency: number;
+    pollInterval: number | ((queueName: string) => number);
+    setRetries: (queueName: string, job: Job) => number;
+    backOffStrategy?: BackoffStrategy;
+    gracefulShutdownTimeout: number;
+    protected activeQueues: QueueNameProcessStorage<ActiveQueue<any>>;
+    constructor(config?: PollingJobQueueStrategyConfig);
+    constructor(concurrency?: number, pollInterval?: number);
+    start<Data extends JobData<Data> = object>(queueName: string, process: (job: Job<Data>) => Promise<any>): Promise<void>;
+    stop<Data extends JobData<Data> = object>(queueName: string, process: (job: Job<Data>) => Promise<any>): Promise<void>;
+    cancelJob(jobId: ID): Promise<Job | undefined>;
+    /**
+     * @description
+     * Should return the next job in the given queue. The implementation is
+     * responsible for returning the correct job according to the time of
+     * creation.
+     */
+    abstract next(queueName: string): Promise<Job | undefined>;
+    /**
+     * @description
+     * Update the job details in the store.
+     */
+    abstract update(job: Job): Promise<void>;
+    /**
+     * @description
+     * Returns a job by its id.
+     */
+    abstract findOne(id: ID): Promise<Job | undefined>;
+}
+export {};

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

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollingJobQueueStrategy = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const deenruv_logger_1 = require("../config/logger/deenruv-logger");
+const injectable_job_queue_strategy_1 = require("./injectable-job-queue-strategy");
+const job_1 = require("./job");
+const queue_name_process_storage_1 = require("./queue-name-process-storage");
+const STOP_SIGNAL = Symbol("STOP_SIGNAL");
+class ActiveQueue {
+    constructor(queueName, process, jobQueueStrategy) {
+        this.queueName = queueName;
+        this.process = process;
+        this.jobQueueStrategy = jobQueueStrategy;
+        this.running = false;
+        this.activeJobs = [];
+        this.errorNotifier$ = new rxjs_1.Subject();
+        this.queueStopped$ = new rxjs_1.Subject();
+        this.pollInterval =
+            typeof this.jobQueueStrategy.pollInterval === "function"
+                ? this.jobQueueStrategy.pollInterval(queueName)
+                : this.jobQueueStrategy.pollInterval;
+    }
+    start() {
+        deenruv_logger_1.Logger.debug(`Starting JobQueue "${this.queueName}"`);
+        this.subscription = this.errorNotifier$
+            .pipe((0, operators_1.throttleTime)(3000))
+            .subscribe(([message, stack]) => {
+            deenruv_logger_1.Logger.error(message);
+            deenruv_logger_1.Logger.debug(stack);
+        });
+        this.running = true;
+        const runNextJobs = async () => {
+            try {
+                const runningJobsCount = this.activeJobs.length;
+                for (let i = runningJobsCount; i < this.jobQueueStrategy.concurrency; i++) {
+                    const nextJob = await this.jobQueueStrategy.next(this.queueName);
+                    if (nextJob) {
+                        this.activeJobs.push(nextJob);
+                        await this.jobQueueStrategy.update(nextJob);
+                        const onProgress = (job) => this.jobQueueStrategy.update(job);
+                        nextJob.on("progress", onProgress);
+                        const cancellationSub = (0, rxjs_1.interval)(this.pollInterval * 5)
+                            .pipe((0, operators_1.switchMap)(() => this.jobQueueStrategy.findOne(nextJob.id)), (0, operators_1.filter)((job) => (job === null || job === void 0 ? void 0 : job.state) === generated_types_1.JobState.CANCELLED), (0, operators_1.take)(1))
+                            .subscribe(() => {
+                            nextJob.cancel();
+                        });
+                        const stopSignal$ = this.queueStopped$.pipe((0, operators_1.take)(1));
+                        (0, rxjs_1.race)((0, rxjs_1.from)(this.process(nextJob)), stopSignal$)
+                            .toPromise()
+                            .then((result) => {
+                            if (result === STOP_SIGNAL) {
+                                nextJob.defer();
+                            }
+                            else if (result instanceof job_1.Job &&
+                                result.state === generated_types_1.JobState.CANCELLED) {
+                                nextJob.cancel();
+                            }
+                            else {
+                                nextJob.complete(result);
+                            }
+                        }, (err) => {
+                            nextJob.fail(err);
+                        })
+                            .finally(() => {
+                            // if (!this.running && nextJob.state !== JobState.PENDING) {
+                            //     return;
+                            // }
+                            nextJob.off("progress", onProgress);
+                            cancellationSub.unsubscribe();
+                            return this.onFailOrComplete(nextJob);
+                        })
+                            .catch((err) => {
+                            deenruv_logger_1.Logger.warn(`Error updating job info: ${JSON.stringify(err)}`);
+                        });
+                    }
+                }
+            }
+            catch (e) {
+                this.errorNotifier$.next([
+                    `Job queue "${this.queueName}" encountered an error (set log level to Debug for trace): ${JSON.stringify(e.message)}`,
+                    e.stack,
+                ]);
+            }
+            if (this.running) {
+                this.timer = setTimeout(runNextJobs, this.pollInterval);
+            }
+        };
+        void runNextJobs();
+    }
+    async stop(stopActiveQueueTimeout = 20000) {
+        this.running = false;
+        clearTimeout(this.timer);
+        await this.awaitRunningJobsOrTimeout(stopActiveQueueTimeout);
+        deenruv_logger_1.Logger.info(`Stopped queue: ${this.queueName}`);
+        this.subscription.unsubscribe();
+        // Allow any job status changes to be persisted
+        // before we permit the application shutdown to continue.
+        // Otherwise, the DB connection will close before our
+        // changes are persisted.
+        await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+    awaitRunningJobsOrTimeout(stopActiveQueueTimeout = 20000) {
+        const start = +new Date();
+        let timeout;
+        return new Promise((resolve) => {
+            let lastStatusUpdate = +new Date();
+            const pollActiveJobs = () => {
+                const now = +new Date();
+                const timedOut = stopActiveQueueTimeout === undefined
+                    ? false
+                    : now - start > stopActiveQueueTimeout;
+                if (this.activeJobs.length === 0) {
+                    clearTimeout(timeout);
+                    resolve();
+                    return;
+                }
+                if (timedOut) {
+                    deenruv_logger_1.Logger.warn(`Timed out (${stopActiveQueueTimeout}ms) waiting for ${this.activeJobs.length} active jobs in queue "${this.queueName}" to complete. Forcing stop...`);
+                    this.queueStopped$.next(STOP_SIGNAL);
+                    clearTimeout(timeout);
+                    resolve();
+                    return;
+                }
+                if (this.activeJobs.length > 0) {
+                    if (now - lastStatusUpdate > 2000) {
+                        deenruv_logger_1.Logger.info(`Stopping queue: ${this.queueName} - waiting for ${this.activeJobs.length} active jobs to complete...`);
+                        lastStatusUpdate = now;
+                    }
+                }
+                timeout = setTimeout(pollActiveJobs, 200);
+            };
+            void pollActiveJobs();
+        });
+    }
+    async onFailOrComplete(job) {
+        await this.jobQueueStrategy.update(job);
+        this.removeJobFromActive(job);
+    }
+    removeJobFromActive(job) {
+        const index = this.activeJobs.indexOf(job);
+        if (index !== -1) {
+            this.activeJobs.splice(index, 1);
+        }
+    }
+}
+/**
+ * @description
+ * This class allows easier implementation of {@link JobQueueStrategy} in a polling style.
+ * Instead of providing {@link JobQueueStrategy} `start()` you should provide a `next` method.
+ *
+ * This class should be extended by any strategy which does not support a push-based system
+ * to notify on new jobs. It is used by the {@link SqlJobQueueStrategy} and {@link InMemoryJobQueueStrategy}.
+ *
+ * @docsCategory JobQueue
+ */
+class PollingJobQueueStrategy extends injectable_job_queue_strategy_1.InjectableJobQueueStrategy {
+    constructor(concurrencyOrConfig, maybePollInterval) {
+        var _a, _b, _c, _d, _e;
+        super();
+        this.activeQueues = new queue_name_process_storage_1.QueueNameProcessStorage();
+        if (concurrencyOrConfig && (0, shared_utils_1.isObject)(concurrencyOrConfig)) {
+            this.concurrency = (_a = concurrencyOrConfig.concurrency) !== null && _a !== void 0 ? _a : 1;
+            this.pollInterval = (_b = concurrencyOrConfig.pollInterval) !== null && _b !== void 0 ? _b : 200;
+            this.backOffStrategy =
+                (_c = concurrencyOrConfig.backoffStrategy) !== null && _c !== void 0 ? _c : (() => 1000);
+            this.setRetries =
+                (_d = concurrencyOrConfig.setRetries) !== null && _d !== void 0 ? _d : ((_, job) => job.retries);
+            this.gracefulShutdownTimeout =
+                (_e = concurrencyOrConfig.gracefulShutdownTimeout) !== null && _e !== void 0 ? _e : 20000;
+        }
+        else {
+            this.concurrency = concurrencyOrConfig !== null && concurrencyOrConfig !== void 0 ? concurrencyOrConfig : 1;
+            this.pollInterval = maybePollInterval !== null && maybePollInterval !== void 0 ? maybePollInterval : 200;
+            this.setRetries = (_, job) => job.retries;
+            this.gracefulShutdownTimeout = 20000;
+        }
+    }
+    async start(queueName, process) {
+        if (!this.hasInitialized) {
+            this.started.set(queueName, process);
+            return;
+        }
+        if (this.activeQueues.has(queueName, process)) {
+            return;
+        }
+        const active = new ActiveQueue(queueName, process, this);
+        active.start();
+        this.activeQueues.set(queueName, process, active);
+    }
+    async stop(queueName, process) {
+        const active = this.activeQueues.getAndDelete(queueName, process);
+        if (!active) {
+            return;
+        }
+        await active.stop(this.gracefulShutdownTimeout);
+    }
+    async cancelJob(jobId) {
+        const job = await this.findOne(jobId);
+        if (job) {
+            job.cancel();
+            await this.update(job);
+            return job;
+        }
+    }
+}
+exports.PollingJobQueueStrategy = PollingJobQueueStrategy;
+//# sourceMappingURL=polling-job-queue-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"polling-job-queue-strategy.js","sourceRoot":"","sources":["../../src/job-queue/polling-job-queue-strategy.ts"],"names":[],"mappings":";;;AAAA,yEAA+D;AAE/D,mEAA4D;AAC5D,+BAA6E;AAC7E,8CAAuE;AAEvE,oEAAyD;AAEzD,mFAA6E;AAC7E,+BAA4B;AAC5B,6EAAuE;AA6DvE,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;AAE1C,MAAM,WAAW;IAUf,YACmB,SAAiB,EACjB,OAAyC,EACzC,gBAAyC;QAFzC,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAkC;QACzC,qBAAgB,GAAhB,gBAAgB,CAAyB;QAXpD,YAAO,GAAG,KAAK,CAAC;QAChB,eAAU,GAAqB,EAAE,CAAC;QAElC,mBAAc,GAAG,IAAI,cAAO,EAAoB,CAAC;QACjD,kBAAa,GAAG,IAAI,cAAO,EAAsB,CAAC;QASxD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,KAAK,UAAU;gBACtD,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC;gBAC/C,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED,KAAK;QACH,uBAAM,CAAC,KAAK,CAAC,sBAAsB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc;aACpC,IAAI,CAAC,IAAA,wBAAY,EAAC,IAAI,CAAC,CAAC;aACxB,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9B,uBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtB,uBAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;YAC7B,IAAI,CAAC;gBACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAChD,KACE,IAAI,CAAC,GAAG,gBAAgB,EACxB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EACrC,CAAC,EAAE,EACH,CAAC;oBACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACjE,IAAI,OAAO,EAAE,CAAC;wBACZ,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBAC9B,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAC5C,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACnE,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;wBACnC,MAAM,eAAe,GAAG,IAAA,eAAQ,EAAC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;6BACpD,IAAI,CACH,IAAA,qBAAS,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAG,CAAC,CAAC,EAC3D,IAAA,kBAAM,EAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,MAAK,0BAAQ,CAAC,SAAS,CAAC,EAClD,IAAA,gBAAI,EAAC,CAAC,CAAC,CACR;6BACA,SAAS,CAAC,GAAG,EAAE;4BACd,OAAO,CAAC,MAAM,EAAE,CAAC;wBACnB,CAAC,CAAC,CAAC;wBACL,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAA,gBAAI,EAAC,CAAC,CAAC,CAAC,CAAC;wBAErD,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC;6BAC3C,SAAS,EAAE;6BACX,IAAI,CACH,CAAC,MAAM,EAAE,EAAE;4BACT,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gCAC3B,OAAO,CAAC,KAAK,EAAE,CAAC;4BAClB,CAAC;iCAAM,IACL,MAAM,YAAY,SAAG;gCACrB,MAAM,CAAC,KAAK,KAAK,0BAAQ,CAAC,SAAS,EACnC,CAAC;gCACD,OAAO,CAAC,MAAM,EAAE,CAAC;4BACnB,CAAC;iCAAM,CAAC;gCACN,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;4BAC3B,CAAC;wBACH,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;4BACN,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBACpB,CAAC,CACF;6BACA,OAAO,CAAC,GAAG,EAAE;4BACZ,6DAA6D;4BAC7D,cAAc;4BACd,IAAI;4BACJ,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;4BACpC,eAAe,CAAC,WAAW,EAAE,CAAC;4BAC9B,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;wBACxC,CAAC,CAAC;6BACD,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;4BAClB,uBAAM,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;wBACjE,CAAC,CAAC,CAAC;oBACP,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;oBACvB,cACE,IAAI,CAAC,SACP,8DAA8D,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE;oBACzF,CAAC,CAAC,KAAK;iBACR,CAAC,CAAC;YACL,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC;QAEF,KAAK,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,sBAAsB,GAAG,KAAM;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,IAAI,CAAC,yBAAyB,CAAC,sBAAsB,CAAC,CAAC;QAC7D,uBAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAChC,+CAA+C;QAC/C,yDAAyD;QACzD,qDAAqD;QACrD,yBAAyB;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAEO,yBAAyB,CAC/B,sBAAsB,GAAG,KAAM;QAE/B,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QAC1B,IAAI,OAAsC,CAAC;QAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,gBAAgB,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YACnC,MAAM,cAAc,GAAG,GAAG,EAAE;gBAC1B,MAAM,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,QAAQ,GACZ,sBAAsB,KAAK,SAAS;oBAClC,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,GAAG,GAAG,KAAK,GAAG,sBAAsB,CAAC;gBAE3C,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACjC,YAAY,CAAC,OAAO,CAAC,CAAC;oBACtB,OAAO,EAAE,CAAC;oBACV,OAAO;gBACT,CAAC;gBAED,IAAI,QAAQ,EAAE,CAAC;oBACb,uBAAM,CAAC,IAAI,CACT,cAAc,sBAAsB,mBAAmB,IAAI,CAAC,UAAU,CAAC,MAAM,0BAA0B,IAAI,CAAC,SAAS,gCAAgC,CACtJ,CAAC;oBACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACrC,YAAY,CAAC,OAAO,CAAC,CAAC;oBACtB,OAAO,EAAE,CAAC;oBACV,OAAO;gBACT,CAAC;gBAED,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC/B,IAAI,GAAG,GAAG,gBAAgB,GAAG,IAAI,EAAE,CAAC;wBAClC,uBAAM,CAAC,IAAI,CACT,mBAAmB,IAAI,CAAC,SAAS,kBAAkB,IAAI,CAAC,UAAU,CAAC,MAAM,6BAA6B,CACvG,CAAC;wBACF,gBAAgB,GAAG,GAAG,CAAC;oBACzB,CAAC;gBACH,CAAC;gBAED,OAAO,GAAG,UAAU,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAC5C,CAAC,CAAC;YACF,KAAK,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,GAAc;QAC3C,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAEO,mBAAmB,CAAC,GAAc;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAsB,uBAAwB,SAAQ,0DAA0B;IAW9E,YACE,mBAA4D,EAC5D,iBAA0B;;QAE1B,KAAK,EAAE,CAAC;QARA,iBAAY,GAAG,IAAI,oDAAuB,EAAoB,CAAC;QAUvE,IAAI,mBAAmB,IAAI,IAAA,uBAAQ,EAAC,mBAAmB,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,MAAA,mBAAmB,CAAC,WAAW,mCAAI,CAAC,CAAC;YACxD,IAAI,CAAC,YAAY,GAAG,MAAA,mBAAmB,CAAC,YAAY,mCAAI,GAAG,CAAC;YAC5D,IAAI,CAAC,eAAe;gBAClB,MAAA,mBAAmB,CAAC,eAAe,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,UAAU;gBACb,MAAA,mBAAmB,CAAC,UAAU,mCAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC9D,IAAI,CAAC,uBAAuB;gBAC1B,MAAA,mBAAmB,CAAC,uBAAuB,mCAAI,KAAM,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,YAAY,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,GAAG,CAAC;YAC7C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC;YAC1C,IAAI,CAAC,uBAAuB,GAAG,KAAM,CAAC;QACxC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CACT,SAAiB,EACjB,OAAyC;QAEzC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACrC,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,WAAW,CAAO,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,IAAI,CACR,SAAiB,EACjB,OAAyC;QAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAS;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;CAqBF;AAzFD,0DAyFC"}

package/dist/job-queue/queue-name-process-storage.d.ts

@@ -0,0 +1,7 @@
+import { Job } from "./job";
+export declare class QueueNameProcessStorage<T> {
+    private items;
+    set(queueName: string, process: (job: Job) => Promise<any>, listener: T): void;
+    has(queueName: string, process: (job: Job) => Promise<any>): boolean;
+    getAndDelete(queueName: string, process: (job: Job) => Promise<any>): T | undefined;
+}

package/dist/job-queue/queue-name-process-storage.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueNameProcessStorage = void 0;
+class QueueNameProcessStorage {
+    constructor() {
+        this.items = new Map();
+    }
+    set(queueName, process, listener) {
+        let items = this.items.get(queueName);
+        if (!items) {
+            items = new Map();
+            this.items.set(queueName, items);
+        }
+        items.set(process, listener);
+    }
+    has(queueName, process) {
+        const items = this.items.get(queueName);
+        if (!items) {
+            return false;
+        }
+        return items.has(process);
+    }
+    getAndDelete(queueName, process) {
+        const items = this.items.get(queueName);
+        if (!items) {
+            return;
+        }
+        const item = items.get(process);
+        if (!item) {
+            return;
+        }
+        items.delete(process);
+        if (items.size === 0) {
+            this.items.delete(queueName);
+        }
+        return item;
+    }
+}
+exports.QueueNameProcessStorage = QueueNameProcessStorage;
+//# sourceMappingURL=queue-name-process-storage.js.map

package/dist/job-queue/queue-name-process-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue-name-process-storage.js","sourceRoot":"","sources":["../../src/job-queue/queue-name-process-storage.ts"],"names":[],"mappings":";;;AAEA,MAAa,uBAAuB;IAApC;QACU,UAAK,GAAG,IAAI,GAAG,EAA8C,CAAC;IAqCxE,CAAC;IAnCC,GAAG,CAAC,SAAiB,EAAE,OAAmC,EAAE,QAAW;QACrE,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED,GAAG,CAAC,SAAiB,EAAE,OAAmC;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,YAAY,CACV,SAAiB,EACjB,OAAmC;QAEnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO;QACT,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtCD,0DAsCC"}

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

@@ -0,0 +1,55 @@
+import { Observable } from "rxjs";
+import { JobQueueStrategy } from "../config/job-queue/job-queue-strategy";
+import { Job } from "./job";
+import { JobData } from "./types";
+/**
+ * @description
+ * Job update status as returned from the {@link SubscribableJob}'s `update()` method.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export type JobUpdate<T extends JobData<T>> = Pick<Job<T>, "id" | "state" | "progress" | "result" | "error" | "data">;
+/**
+ * @description
+ * Job update options, that you can specify by calling {@link SubscribableJob} `updates` method.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export type JobUpdateOptions = {
+    /**
+     * Polling interval. Defaults to 200ms
+     */
+    pollInterval?: number;
+    /**
+     * Polling timeout in milliseconds. Defaults to 1 hour
+     */
+    timeoutMs?: number;
+    /**
+     * Observable sequence will end with an error if true. Default to false
+     */
+    errorOnFail?: boolean;
+};
+/**
+ * @description
+ * This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
+ * by the {@link JobQueue}'s `add()` method. Note that the subscription capability is only supported
+ * if the {@link JobQueueStrategy} implements the {@link InspectableJobQueueStrategy} interface (e.g.
+ * the {@link SqlJobQueueStrategy} does support this).
+ *
+ * @docsCategory JobQueue
+ */
+export declare class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
+    private readonly jobQueueStrategy;
+    constructor(job: Job<T>, jobQueueStrategy: JobQueueStrategy);
+    /**
+     * @description
+     * Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
+     * to obtain updates. If this updates are not subscribed to, then no polling occurs.
+     *
+     * Polling interval, timeout and other options may be configured with an options arguments {@link JobUpdateOptions}.
+     *
+     */
+    updates(options?: JobUpdateOptions): Observable<JobUpdate<T>>;
+}

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

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscribableJob = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const pick_1 = require("@deenruv/common/lib/pick");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const ms_1 = __importDefault(require("ms"));
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const errors_1 = require("../common/error/errors");
+const inspectable_job_queue_strategy_1 = require("../config/job-queue/inspectable-job-queue-strategy");
+const job_1 = require("./job");
+/**
+ * @description
+ * This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
+ * by the {@link JobQueue}'s `add()` method. Note that the subscription capability is only supported
+ * if the {@link JobQueueStrategy} implements the {@link InspectableJobQueueStrategy} interface (e.g.
+ * the {@link SqlJobQueueStrategy} does support this).
+ *
+ * @docsCategory JobQueue
+ */
+class SubscribableJob extends job_1.Job {
+    constructor(job, jobQueueStrategy) {
+        const config = Object.assign(Object.assign({}, job), { state: job.state, data: job.data, id: job.id || undefined });
+        super(config);
+        this.jobQueueStrategy = jobQueueStrategy;
+    }
+    /**
+     * @description
+     * Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
+     * to obtain updates. If this updates are not subscribed to, then no polling occurs.
+     *
+     * Polling interval, timeout and other options may be configured with an options arguments {@link JobUpdateOptions}.
+     *
+     */
+    updates(options) {
+        var _a, _b;
+        const pollInterval = Math.max(50, (_a = options === null || options === void 0 ? void 0 : options.pollInterval) !== null && _a !== void 0 ? _a : 200);
+        const timeoutMs = Math.max(pollInterval, (_b = options === null || options === void 0 ? void 0 : options.timeoutMs) !== null && _b !== void 0 ? _b : (0, ms_1.default)("1h"));
+        const strategy = this.jobQueueStrategy;
+        if (!(0, inspectable_job_queue_strategy_1.isInspectableJobQueueStrategy)(strategy)) {
+            throw new errors_1.InternalServerError(`The configured JobQueueStrategy (${strategy.constructor.name}) is not inspectable, so Job updates cannot be subscribed to`);
+        }
+        else {
+            return (0, rxjs_1.interval)(pollInterval).pipe((0, operators_1.tap)((i) => {
+                var _a;
+                if (timeoutMs < i * pollInterval) {
+                    throw new Error(`Job ${(_a = this.id) !== null && _a !== void 0 ? _a : ""} SubscribableJob update polling timed out after ${timeoutMs}ms. The job may still be running.`);
+                }
+            }), (0, operators_1.switchMap)(() => {
+                const id = this.id;
+                if (!id) {
+                    throw new Error("Cannot subscribe to update: Job does not have an ID");
+                }
+                return strategy.findOne(id);
+            }), (0, operators_1.filter)(shared_utils_1.notNullOrUndefined), (0, operators_1.distinctUntilChanged)((a, b) => (a === null || a === void 0 ? void 0 : a.progress) === (b === null || b === void 0 ? void 0 : b.progress) && (a === null || a === void 0 ? void 0 : a.state) === (b === null || b === void 0 ? void 0 : b.state)), (0, operators_1.takeWhile)((job) => (job === null || job === void 0 ? void 0 : job.state) !== generated_types_1.JobState.FAILED &&
+                job.state !== generated_types_1.JobState.COMPLETED &&
+                job.state !== generated_types_1.JobState.CANCELLED, true), (0, operators_1.tap)((job) => {
+                var _a;
+                if (job.state === generated_types_1.JobState.FAILED && ((_a = options === null || options === void 0 ? void 0 : options.errorOnFail) !== null && _a !== void 0 ? _a : true)) {
+                    throw new Error(job.error);
+                }
+            }), (0, operators_1.map)((job) => (0, pick_1.pick)(job, ["id", "state", "progress", "result", "error", "data"])));
+        }
+    }
+}
+exports.SubscribableJob = SubscribableJob;
+//# sourceMappingURL=subscribable-job.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscribable-job.js","sourceRoot":"","sources":["../../src/job-queue/subscribable-job.ts"],"names":[],"mappings":";;;;;;AAAA,yEAA+D;AAC/D,mDAAgD;AAChD,mEAAsE;AACtE,4CAAoB;AACpB,+BAA4C;AAC5C,8CAOwB;AAExB,mDAA6D;AAC7D,uGAAmG;AAGnG,+BAA4B;AAqC5B;;;;;;;;GAQG;AACH,MAAa,eAA4C,SAAQ,SAAM;IAGrE,YAAY,GAAW,EAAE,gBAAkC;QACzD,MAAM,MAAM,mCACP,GAAG,KACN,KAAK,EAAE,GAAG,CAAC,KAAK,EAChB,IAAI,EAAE,GAAG,CAAC,IAAI,EACd,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,GACxB,CAAC;QACF,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,OAA0B;;QAChC,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,GAAG,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,IAAA,YAAE,EAAC,IAAI,CAAC,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACvC,IAAI,CAAC,IAAA,8DAA6B,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,4BAAmB,CAC3B,oCAAoC,QAAQ,CAAC,WAAW,CAAC,IAAI,8DAA8D,CAC5H,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,IAAA,eAAQ,EAAC,YAAY,CAAC,CAAC,IAAI,CAChC,IAAA,eAAG,EAAC,CAAC,CAAC,EAAE,EAAE;;gBACR,IAAI,SAAS,GAAG,CAAC,GAAG,YAAY,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CACb,OACE,MAAA,IAAI,CAAC,EAAE,mCAAI,EACb,mDAAmD,SAAS,mCAAmC,CAChG,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC,EACF,IAAA,qBAAS,EAAC,GAAG,EAAE;gBACb,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;gBACnB,IAAI,CAAC,EAAE,EAAE,CAAC;oBACR,MAAM,IAAI,KAAK,CACb,qDAAqD,CACtD,CAAC;gBACJ,CAAC;gBACD,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC9B,CAAC,CAAC,EACF,IAAA,kBAAM,EAAC,iCAAkB,CAAC,EAC1B,IAAA,gCAAoB,EAClB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,OAAK,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,CAAA,IAAI,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,OAAK,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,CAAA,CAC/D,EACD,IAAA,qBAAS,EACP,CAAC,GAAG,EAAE,EAAE,CACN,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,MAAK,0BAAQ,CAAC,MAAM;gBAC9B,GAAG,CAAC,KAAK,KAAK,0BAAQ,CAAC,SAAS;gBAChC,GAAG,CAAC,KAAK,KAAK,0BAAQ,CAAC,SAAS,EAClC,IAAI,CACL,EACD,IAAA,eAAG,EAAC,CAAC,GAAG,EAAE,EAAE;;gBACV,IAAI,GAAG,CAAC,KAAK,KAAK,0BAAQ,CAAC,MAAM,IAAI,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,IAAI,CAAC,EAAE,CAAC;oBACpE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC,CAAC,EACF,IAAA,eAAG,EAAC,CAAC,GAAG,EAAE,EAAE,CACV,IAAA,WAAI,EAAC,GAAG,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAClE,CACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAxED,0CAwEC"}

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

@@ -0,0 +1,58 @@
+import { JobState } from "@deenruv/common/lib/generated-types";
+import { ID, JsonCompatible } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../api/common/request-context";
+import { Job } from "./job";
+/**
+ * @description
+ * Used to configure a new {@link JobQueue} instance.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export interface CreateQueueOptions<T extends JobData<T>> {
+    /**
+     * @description
+     * The name of the queue, e.g. "image processing", "re-indexing" etc.
+     */
+    name: string;
+    /**
+     * @description
+     * Defines the work to be done for each job in the queue. The returned promise
+     * should resolve when the job is complete, or be rejected in case of an error.
+     */
+    process: (job: Job<T>) => Promise<any>;
+}
+/**
+ * @description
+ * A JSON-serializable data type which provides a {@link Job}
+ * with the data it needs to be processed.
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export type JobData<T> = JsonCompatible<T>;
+/**
+ * @description
+ * Used to instantiate a new {@link Job}
+ *
+ * @docsCategory JobQueue
+ * @docsPage types
+ */
+export interface JobConfig<T extends JobData<T>> {
+    queueName: string;
+    data: T;
+    retries?: number;
+    attempts?: number;
+    id?: ID;
+    state?: JobState;
+    progress?: number;
+    result?: any;
+    error?: any;
+    createdAt?: Date;
+    startedAt?: Date;
+    settledAt?: Date;
+}
+export type JobOptions<Data extends JsonCompatible<Data>> = Pick<JobConfig<Data>, "retries"> & {
+    ctx?: RequestContext;
+};
+export type JobQueueStrategyJobOptions<Data extends JsonCompatible<Data>> = Omit<JobOptions<Data>, "retries">;

package/dist/job-queue/types.js

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

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

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

package/dist/migrate.d.ts

@@ -0,0 +1,45 @@
+import { DeenruvConfig } from "./config/deenruv-config";
+/**
+ * @description
+ * Configuration for generating a new migration script via {@link generateMigration}.
+ *
+ * @docsCategory migration
+ */
+export interface MigrationOptions {
+    /**
+     * @description
+     * The name of the migration. The resulting migration script will be named
+     * `{TIMESTAMP}-{name}.ts`.
+     */
+    name: string;
+    /**
+     * @description
+     * The output directory of the generated migration scripts.
+     */
+    outputDir?: string;
+}
+/**
+ * @description
+ * Runs any pending database migrations. See [TypeORM migration docs](https://typeorm.io/#/migrations)
+ * for more information about the underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+export declare function runMigrations(userConfig: Partial<DeenruvConfig>): Promise<string[]>;
+/**
+ * @description
+ * Reverts the last applied database migration. See [TypeORM migration docs](https://typeorm.io/#/migrations)
+ * for more information about the underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+export declare function revertLastMigration(userConfig: Partial<DeenruvConfig>): Promise<void>;
+/**
+ * @description
+ * Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields).
+ * See [TypeORM migration docs](https://typeorm.io/#/migrations) for more information about the
+ * underlying migration mechanism.
+ *
+ * @docsCategory migration
+ */
+export declare function generateMigration(userConfig: Partial<DeenruvConfig>, options: MigrationOptions): Promise<string | undefined>;