@sidequest/engine 1.0.0-next.10

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}

package/dist/job/constants.cjs

@@ -0,0 +1,30 @@
+'use strict';
+
+var backend = require('@sidequest/backend');
+
+/**
+ * Default configuration values for job builders.
+ *
+ * Provides fallback settings when specific job configuration options are not explicitly set.
+ *
+ * @remarks
+ * - Uses "default" queue for job processing
+ * - No timeout limit by default
+ * - Uniqueness checking disabled
+ * - Maximum of 5 retry attempts on failure
+ * - Jobs are immediately available for processing
+ * - No constructor arguments passed by default
+ */
+const JOB_BUILDER_FALLBACK = {
+    queue: "default",
+    timeout: undefined,
+    uniqueness: false,
+    maxAttempts: backend.JOB_FALLBACK.max_attempts,
+    get availableAt() {
+        return new Date();
+    },
+    constructorArgs: [],
+};
+
+exports.JOB_BUILDER_FALLBACK = JOB_BUILDER_FALLBACK;
+//# sourceMappingURL=constants.cjs.map

package/dist/job/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sources":["../../src/job/constants.ts"],"sourcesContent":[null],"names":["JOB_FALLBACK"],"mappings":";;;;AAGA;;;;;;;;;;;;AAYG;AACI,MAAM,oBAAoB,GAAwD;AACvF,IAAA,KAAK,EAAE,SAAS;AAChB,IAAA,OAAO,EAAE,SAAS;AAClB,IAAA,UAAU,EAAE,KAAK;IACjB,WAAW,EAAEA,oBAAY,CAAC,YAAY;AACtC,IAAA,IAAI,WAAW,GAAA;QACb,OAAO,IAAI,IAAI,EAAE;IACnB,CAAC;AACD,IAAA,eAAe,EAAE,EAAE;;;;;"}

package/dist/job/constants.d.ts

@@ -0,0 +1,20 @@
+import { JobBuilderDefaults } from './job-builder.js';
+
+/**
+ * Default configuration values for job builders.
+ *
+ * Provides fallback settings when specific job configuration options are not explicitly set.
+ *
+ * @remarks
+ * - Uses "default" queue for job processing
+ * - No timeout limit by default
+ * - Uniqueness checking disabled
+ * - Maximum of 5 retry attempts on failure
+ * - Jobs are immediately available for processing
+ * - No constructor arguments passed by default
+ */
+declare const JOB_BUILDER_FALLBACK: JobBuilderDefaults & {
+    constructorArgs: unknown[];
+};
+
+export { JOB_BUILDER_FALLBACK };

package/dist/job/constants.js

@@ -0,0 +1,28 @@
+import { JOB_FALLBACK } from '@sidequest/backend';
+
+/**
+ * Default configuration values for job builders.
+ *
+ * Provides fallback settings when specific job configuration options are not explicitly set.
+ *
+ * @remarks
+ * - Uses "default" queue for job processing
+ * - No timeout limit by default
+ * - Uniqueness checking disabled
+ * - Maximum of 5 retry attempts on failure
+ * - Jobs are immediately available for processing
+ * - No constructor arguments passed by default
+ */
+const JOB_BUILDER_FALLBACK = {
+    queue: "default",
+    timeout: undefined,
+    uniqueness: false,
+    maxAttempts: JOB_FALLBACK.max_attempts,
+    get availableAt() {
+        return new Date();
+    },
+    constructorArgs: [],
+};
+
+export { JOB_BUILDER_FALLBACK };
+//# sourceMappingURL=constants.js.map

package/dist/job/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../../src/job/constants.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;;;;;;;;;;;AAYG;AACI,MAAM,oBAAoB,GAAwD;AACvF,IAAA,KAAK,EAAE,SAAS;AAChB,IAAA,OAAO,EAAE,SAAS;AAClB,IAAA,UAAU,EAAE,KAAK;IACjB,WAAW,EAAE,YAAY,CAAC,YAAY;AACtC,IAAA,IAAI,WAAW,GAAA;QACb,OAAO,IAAI,IAAI,EAAE;IACnB,CAAC;AACD,IAAA,eAAe,EAAE,EAAE;;;;;"}

package/dist/job/job-builder.cjs

@@ -0,0 +1,153 @@
+'use strict';
+
+var core = require('@sidequest/core');
+var constants = require('./constants.cjs');
+
+/**
+ * Builder for creating and enqueuing jobs with custom configuration.
+ * @template T The job class type.
+ */
+class JobBuilder {
+    backend;
+    JobClass;
+    defaults;
+    constructorArgs;
+    queueName;
+    jobTimeout;
+    uniquenessConfig;
+    jobMaxAttempts;
+    jobAvailableAt;
+    /**
+     * Creates a new JobBuilder for the given job class.
+     * @param JobClass The job class constructor.
+     */
+    constructor(backend, JobClass, defaults) {
+        this.backend = backend;
+        this.JobClass = JobClass;
+        this.defaults = defaults;
+        this.queue(this.defaults?.queue ?? constants.JOB_BUILDER_FALLBACK.queue);
+        this.maxAttempts(this.defaults?.maxAttempts ?? constants.JOB_BUILDER_FALLBACK.maxAttempts);
+        this.availableAt(this.defaults?.availableAt ?? constants.JOB_BUILDER_FALLBACK.availableAt);
+        this.timeout(this.defaults?.timeout ?? constants.JOB_BUILDER_FALLBACK.timeout);
+        this.unique(this.defaults?.uniqueness ?? constants.JOB_BUILDER_FALLBACK.uniqueness);
+        this.with(...constants.JOB_BUILDER_FALLBACK.constructorArgs);
+    }
+    /**
+     * Sets the constructor arguments for the job.
+     * @param args The constructor arguments.
+     * @returns This builder instance.
+     */
+    with(...args) {
+        this.constructorArgs = args;
+        return this;
+    }
+    /**
+     * Sets the queue name for the job.
+     * @param queue The queue name.
+     * @returns This builder instance.
+     */
+    queue(queue) {
+        this.queueName = queue;
+        return this;
+    }
+    /**
+     * Sets the timeout for the job in milliseconds.
+     * @param ms Timeout in milliseconds.
+     * @returns This builder instance.
+     */
+    timeout(ms) {
+        this.jobTimeout = ms;
+        return this;
+    }
+    /**
+     * Sets the uniqueness configuration for the job.
+     * @param value Boolean or uniqueness config object. If true, uses an alive job uniqueness strategy (see {@link AliveJobUniqueness}).
+     * If false, disables uniqueness. If an object, uses the custom uniqueness strategy.
+     * @param value.withArgs If true, uniqueness is based on job class and job arguments.
+     * If false, uniqueness is based only on the job class.
+     * @param value.period  If a period is provided, uses a fixed window uniqueness strategy (see {@link FixedWindowUniqueness}).
+     * @returns This builder instance.
+     * @see {@link UniquenessInput} for more details.
+     */
+    unique(value) {
+        if (typeof value === "boolean") {
+            if (value) {
+                const config = {
+                    type: "alive-job",
+                    withArgs: false,
+                };
+                this.uniquenessConfig = config;
+            }
+            else {
+                this.uniquenessConfig = undefined; // no uniqueness
+            }
+        }
+        else {
+            if (value.period) {
+                this.uniquenessConfig = {
+                    type: "fixed-window",
+                    period: value.period,
+                    withArgs: value.withArgs,
+                };
+            }
+            else {
+                this.uniquenessConfig = { type: "alive-job", withArgs: value.withArgs };
+            }
+        }
+        return this;
+    }
+    /**
+     * Sets the maximum number of attempts for the job.
+     * @param value The max attempts.
+     * @returns This builder instance.
+     */
+    maxAttempts(value) {
+        this.jobMaxAttempts = value;
+        return this;
+    }
+    /**
+     * Sets the time when the job becomes available.
+     * @param value The available date.
+     * @returns This builder instance.
+     */
+    availableAt(value) {
+        this.jobAvailableAt = value;
+        return this;
+    }
+    /**
+     * Enqueues the job with the specified arguments.
+     * @param args Arguments to pass to the job's run method.
+     * @returns A promise resolving to the created job data.
+     */
+    async enqueue(...args) {
+        const job = new this.JobClass(...this.constructorArgs);
+        await job.ready();
+        if (!job.script) {
+            throw new Error(`Error on starting job ${job.className} could not detect source file.`);
+        }
+        const jobData = {
+            queue: this.queueName,
+            script: job.script,
+            class: job.className,
+            state: "waiting",
+            args,
+            constructor_args: this.constructorArgs,
+            attempt: 0,
+            max_attempts: this.jobMaxAttempts,
+            available_at: this.jobAvailableAt,
+            timeout: this.jobTimeout,
+            uniqueness_config: this.uniquenessConfig,
+        };
+        core.logger("JobBuilder").debug(`Enqueuing job ${job.className} with args: ${JSON.stringify(args)}
+      and constructor args: ${JSON.stringify(this.constructorArgs)}`);
+        if (this.uniquenessConfig) {
+            const uniqueness = core.UniquenessFactory.create(this.uniquenessConfig);
+            jobData.unique_digest = uniqueness.digest(jobData);
+            core.logger("JobBuilder").debug(`Job ${job.className} uniqueness digest: ${jobData.unique_digest}`);
+        }
+        return this.backend.createNewJob(jobData);
+    }
+}
+
+exports.JobBuilder = JobBuilder;
+//# sourceMappingURL=job-builder.cjs.map

package/dist/job/job-builder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-builder.cjs","sources":["../../src/job/job-builder.ts"],"sourcesContent":[null],"names":["JOB_BUILDER_FALLBACK","logger","UniquenessFactory"],"mappings":";;;;;AAyDA;;;AAGG;MACU,UAAU,CAAA;AAaX,IAAA,OAAA;AACA,IAAA,QAAA;AACA,IAAA,QAAA;AAdF,IAAA,eAAe;AACf,IAAA,SAAS;AACT,IAAA,UAAU;AACV,IAAA,gBAAgB;AAChB,IAAA,cAAc;AACd,IAAA,cAAc;AAEtB;;;AAGG;AACH,IAAA,WAAA,CACU,OAAgB,EAChB,QAAW,EACX,QAA6B,EAAA;QAF7B,IAAA,CAAA,OAAO,GAAP,OAAO;QACP,IAAA,CAAA,QAAQ,GAAR,QAAQ;QACR,IAAA,CAAA,QAAQ,GAAR,QAAQ;AAEhB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAIA,8BAAoB,CAAC,KAAM,CAAC;AAC/D,QAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,IAAIA,8BAAoB,CAAC,WAAY,CAAC;AACjF,QAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,IAAIA,8BAAoB,CAAC,WAAY,CAAC;AACjF,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,IAAIA,8BAAoB,CAAC,OAAQ,CAAC;AACrE,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,IAAIA,8BAAoB,CAAC,UAAW,CAAC;QAC1E,IAAI,CAAC,IAAI,CAAC,GAAIA,8BAAoB,CAAC,eAAuD,CAAC;IAC7F;AAEA;;;;AAIG;IACH,IAAI,CAAC,GAAG,IAA8B,EAAA;AACpC,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,KAAK,CAAC,KAAa,EAAA;AACjB,QAAA,IAAI,CAAC,SAAS,GAAG,KAAK;AACtB,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,OAAO,CAAC,EAAU,EAAA;AAChB,QAAA,IAAI,CAAC,UAAU,GAAG,EAAE;AACpB,QAAA,OAAO,IAAI;IACb;AAEA;;;;;;;;;AASG;AACH,IAAA,MAAM,CAAC,KAAsB,EAAA;AAC3B,QAAA,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAC9B,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,MAAM,GAAmB;AAC7B,oBAAA,IAAI,EAAE,WAAW;AACjB,oBAAA,QAAQ,EAAE,KAAK;iBAChB;AACD,gBAAA,IAAI,CAAC,gBAAgB,GAAG,MAAM;YAChC;iBAAO;AACL,gBAAA,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;YACpC;QACF;aAAO;AACL,YAAA,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,IAAI,CAAC,gBAAgB,GAAG;AACtB,oBAAA,IAAI,EAAE,cAAc;oBACpB,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;iBACJ;YACxB;iBAAO;AACL,gBAAA,IAAI,CAAC,gBAAgB,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAoB;YAC3F;QACF;AACA,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,WAAW,CAAC,KAAa,EAAA;AACvB,QAAA,IAAI,CAAC,cAAc,GAAG,KAAK;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,WAAW,CAAC,KAAW,EAAA;AACrB,QAAA,IAAI,CAAC,cAAc,GAAG,KAAK;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,MAAM,OAAO,CAAC,GAAG,IAAwC,EAAA;AACvD,QAAA,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAgB,CAAC;AAEvD,QAAA,MAAM,GAAG,CAAC,KAAK,EAAE;AAEjB,QAAA,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,CAAA,sBAAA,EAAyB,GAAG,CAAC,SAAS,CAAA,8BAAA,CAAgC,CAAC;QACzF;AAEA,QAAA,MAAM,OAAO,GAAe;YAC1B,KAAK,EAAE,IAAI,CAAC,SAAU;YACtB,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,GAAG,CAAC,SAAS;AACpB,YAAA,KAAK,EAAE,SAAS;YAChB,IAAI;YACJ,gBAAgB,EAAE,IAAI,CAAC,eAAgB;AACvC,YAAA,OAAO,EAAE,CAAC;YACV,YAAY,EAAE,IAAI,CAAC,cAAe;YAClC,YAAY,EAAE,IAAI,CAAC,cAAe;YAClC,OAAO,EAAE,IAAI,CAAC,UAAW;YACzB,iBAAiB,EAAE,IAAI,CAAC,gBAAiB;SAC1C;AACD,QAAAC,WAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CACxB,CAAA,cAAA,EAAiB,GAAG,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;8BACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA,CAAE,CAC/D;AAED,QAAA,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,MAAM,UAAU,GAAGC,sBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAClE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,OAAkB,CAAC;AAC7D,YAAAD,WAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAA,IAAA,EAAO,GAAG,CAAC,SAAS,uBAAuB,OAAO,CAAC,aAAa,CAAA,CAAE,CAAC;QAChG;QAEA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;IAC3C;AACD;;;;"}

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

@@ -0,0 +1,115 @@
+import { Backend } from '@sidequest/backend';
+import { TimePeriod, JobData } from '@sidequest/core';
+import { JobClassType } from './job.js';
+
+/**
+ * Configuration for job uniqueness constraints.
+ *
+ * @remarks
+ * Controls how jobs are deduplicated to prevent multiple instances of the same job from running.
+ *
+ * - When `true`: Jobs are made unique based on their type/name only
+ * - When `false`: No uniqueness constraint is applied
+ * - When an object: Provides fine-grained control over uniqueness behavior
+ *
+ * @example
+ * ```typescript
+ * // Simple uniqueness
+ * const unique: UniquenessInput = true;
+ *
+ * // No uniqueness
+ * const notUnique: UniquenessInput = false;
+ *
+ * // Advanced uniqueness with arguments consideration
+ * const advancedUnique: UniquenessInput = {
+ *   withArgs: true,
+ *   period: { hours: 1 }
+ * };
+ * ```
+ */
+type UniquenessInput = boolean | {
+    withArgs?: boolean;
+    period?: TimePeriod;
+};
+interface JobBuilderDefaults {
+    /** Default queue name for jobs built with the JobBuilder */
+    queue?: string;
+    /** Default timeout in milliseconds for jobs built with the JobBuilder */
+    timeout?: number;
+    /** Default uniqueness configuration for jobs built with the JobBuilder */
+    uniqueness?: UniquenessInput;
+    /** Default maximum attempts for jobs built with the JobBuilder */
+    maxAttempts?: number;
+    /** Default available at date for jobs built with the JobBuilder */
+    availableAt?: Date;
+}
+/**
+ * Builder for creating and enqueuing jobs with custom configuration.
+ * @template T The job class type.
+ */
+declare class JobBuilder<T extends JobClassType> {
+    private backend;
+    private JobClass;
+    private defaults?;
+    private constructorArgs?;
+    private queueName?;
+    private jobTimeout?;
+    private uniquenessConfig?;
+    private jobMaxAttempts?;
+    private jobAvailableAt?;
+    /**
+     * Creates a new JobBuilder for the given job class.
+     * @param JobClass The job class constructor.
+     */
+    constructor(backend: Backend, JobClass: T, defaults?: JobBuilderDefaults | undefined);
+    /**
+     * Sets the constructor arguments for the job.
+     * @param args The constructor arguments.
+     * @returns This builder instance.
+     */
+    with(...args: ConstructorParameters<T>): this;
+    /**
+     * Sets the queue name for the job.
+     * @param queue The queue name.
+     * @returns This builder instance.
+     */
+    queue(queue: string): this;
+    /**
+     * Sets the timeout for the job in milliseconds.
+     * @param ms Timeout in milliseconds.
+     * @returns This builder instance.
+     */
+    timeout(ms: number): this;
+    /**
+     * Sets the uniqueness configuration for the job.
+     * @param value Boolean or uniqueness config object. If true, uses an alive job uniqueness strategy (see {@link AliveJobUniqueness}).
+     * If false, disables uniqueness. If an object, uses the custom uniqueness strategy.
+     * @param value.withArgs If true, uniqueness is based on job class and job arguments.
+     * If false, uniqueness is based only on the job class.
+     * @param value.period  If a period is provided, uses a fixed window uniqueness strategy (see {@link FixedWindowUniqueness}).
+     * @returns This builder instance.
+     * @see {@link UniquenessInput} for more details.
+     */
+    unique(value: UniquenessInput): this;
+    /**
+     * Sets the maximum number of attempts for the job.
+     * @param value The max attempts.
+     * @returns This builder instance.
+     */
+    maxAttempts(value: number): this;
+    /**
+     * Sets the time when the job becomes available.
+     * @param value The available date.
+     * @returns This builder instance.
+     */
+    availableAt(value: Date): this;
+    /**
+     * Enqueues the job with the specified arguments.
+     * @param args Arguments to pass to the job's run method.
+     * @returns A promise resolving to the created job data.
+     */
+    enqueue(...args: Parameters<InstanceType<T>["run"]>): Promise<JobData>;
+}
+
+export { JobBuilder };
+export type { JobBuilderDefaults, UniquenessInput };

package/dist/job/job-builder.js

@@ -0,0 +1,151 @@
+import { logger, UniquenessFactory } from '@sidequest/core';
+import { JOB_BUILDER_FALLBACK } from './constants.js';
+
+/**
+ * Builder for creating and enqueuing jobs with custom configuration.
+ * @template T The job class type.
+ */
+class JobBuilder {
+    backend;
+    JobClass;
+    defaults;
+    constructorArgs;
+    queueName;
+    jobTimeout;
+    uniquenessConfig;
+    jobMaxAttempts;
+    jobAvailableAt;
+    /**
+     * Creates a new JobBuilder for the given job class.
+     * @param JobClass The job class constructor.
+     */
+    constructor(backend, JobClass, defaults) {
+        this.backend = backend;
+        this.JobClass = JobClass;
+        this.defaults = defaults;
+        this.queue(this.defaults?.queue ?? JOB_BUILDER_FALLBACK.queue);
+        this.maxAttempts(this.defaults?.maxAttempts ?? JOB_BUILDER_FALLBACK.maxAttempts);
+        this.availableAt(this.defaults?.availableAt ?? JOB_BUILDER_FALLBACK.availableAt);
+        this.timeout(this.defaults?.timeout ?? JOB_BUILDER_FALLBACK.timeout);
+        this.unique(this.defaults?.uniqueness ?? JOB_BUILDER_FALLBACK.uniqueness);
+        this.with(...JOB_BUILDER_FALLBACK.constructorArgs);
+    }
+    /**
+     * Sets the constructor arguments for the job.
+     * @param args The constructor arguments.
+     * @returns This builder instance.
+     */
+    with(...args) {
+        this.constructorArgs = args;
+        return this;
+    }
+    /**
+     * Sets the queue name for the job.
+     * @param queue The queue name.
+     * @returns This builder instance.
+     */
+    queue(queue) {
+        this.queueName = queue;
+        return this;
+    }
+    /**
+     * Sets the timeout for the job in milliseconds.
+     * @param ms Timeout in milliseconds.
+     * @returns This builder instance.
+     */
+    timeout(ms) {
+        this.jobTimeout = ms;
+        return this;
+    }
+    /**
+     * Sets the uniqueness configuration for the job.
+     * @param value Boolean or uniqueness config object. If true, uses an alive job uniqueness strategy (see {@link AliveJobUniqueness}).
+     * If false, disables uniqueness. If an object, uses the custom uniqueness strategy.
+     * @param value.withArgs If true, uniqueness is based on job class and job arguments.
+     * If false, uniqueness is based only on the job class.
+     * @param value.period  If a period is provided, uses a fixed window uniqueness strategy (see {@link FixedWindowUniqueness}).
+     * @returns This builder instance.
+     * @see {@link UniquenessInput} for more details.
+     */
+    unique(value) {
+        if (typeof value === "boolean") {
+            if (value) {
+                const config = {
+                    type: "alive-job",
+                    withArgs: false,
+                };
+                this.uniquenessConfig = config;
+            }
+            else {
+                this.uniquenessConfig = undefined; // no uniqueness
+            }
+        }
+        else {
+            if (value.period) {
+                this.uniquenessConfig = {
+                    type: "fixed-window",
+                    period: value.period,
+                    withArgs: value.withArgs,
+                };
+            }
+            else {
+                this.uniquenessConfig = { type: "alive-job", withArgs: value.withArgs };
+            }
+        }
+        return this;
+    }
+    /**
+     * Sets the maximum number of attempts for the job.
+     * @param value The max attempts.
+     * @returns This builder instance.
+     */
+    maxAttempts(value) {
+        this.jobMaxAttempts = value;
+        return this;
+    }
+    /**
+     * Sets the time when the job becomes available.
+     * @param value The available date.
+     * @returns This builder instance.
+     */
+    availableAt(value) {
+        this.jobAvailableAt = value;
+        return this;
+    }
+    /**
+     * Enqueues the job with the specified arguments.
+     * @param args Arguments to pass to the job's run method.
+     * @returns A promise resolving to the created job data.
+     */
+    async enqueue(...args) {
+        const job = new this.JobClass(...this.constructorArgs);
+        await job.ready();
+        if (!job.script) {
+            throw new Error(`Error on starting job ${job.className} could not detect source file.`);
+        }
+        const jobData = {
+            queue: this.queueName,
+            script: job.script,
+            class: job.className,
+            state: "waiting",
+            args,
+            constructor_args: this.constructorArgs,
+            attempt: 0,
+            max_attempts: this.jobMaxAttempts,
+            available_at: this.jobAvailableAt,
+            timeout: this.jobTimeout,
+            uniqueness_config: this.uniquenessConfig,
+        };
+        logger("JobBuilder").debug(`Enqueuing job ${job.className} with args: ${JSON.stringify(args)}
+      and constructor args: ${JSON.stringify(this.constructorArgs)}`);
+        if (this.uniquenessConfig) {
+            const uniqueness = UniquenessFactory.create(this.uniquenessConfig);
+            jobData.unique_digest = uniqueness.digest(jobData);
+            logger("JobBuilder").debug(`Job ${job.className} uniqueness digest: ${jobData.unique_digest}`);
+        }
+        return this.backend.createNewJob(jobData);
+    }
+}
+
+export { JobBuilder };
+//# sourceMappingURL=job-builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"job-builder.js","sources":["../../src/job/job-builder.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAyDA;;;AAGG;MACU,UAAU,CAAA;AAaX,IAAA,OAAA;AACA,IAAA,QAAA;AACA,IAAA,QAAA;AAdF,IAAA,eAAe;AACf,IAAA,SAAS;AACT,IAAA,UAAU;AACV,IAAA,gBAAgB;AAChB,IAAA,cAAc;AACd,IAAA,cAAc;AAEtB;;;AAGG;AACH,IAAA,WAAA,CACU,OAAgB,EAChB,QAAW,EACX,QAA6B,EAAA;QAF7B,IAAA,CAAA,OAAO,GAAP,OAAO;QACP,IAAA,CAAA,QAAQ,GAAR,QAAQ;QACR,IAAA,CAAA,QAAQ,GAAR,QAAQ;AAEhB,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,oBAAoB,CAAC,KAAM,CAAC;AAC/D,QAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,IAAI,oBAAoB,CAAC,WAAY,CAAC;AACjF,QAAA,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,IAAI,oBAAoB,CAAC,WAAY,CAAC;AACjF,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,IAAI,oBAAoB,CAAC,OAAQ,CAAC;AACrE,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,IAAI,oBAAoB,CAAC,UAAW,CAAC;QAC1E,IAAI,CAAC,IAAI,CAAC,GAAI,oBAAoB,CAAC,eAAuD,CAAC;IAC7F;AAEA;;;;AAIG;IACH,IAAI,CAAC,GAAG,IAA8B,EAAA;AACpC,QAAA,IAAI,CAAC,eAAe,GAAG,IAAI;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,KAAK,CAAC,KAAa,EAAA;AACjB,QAAA,IAAI,CAAC,SAAS,GAAG,KAAK;AACtB,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,OAAO,CAAC,EAAU,EAAA;AAChB,QAAA,IAAI,CAAC,UAAU,GAAG,EAAE;AACpB,QAAA,OAAO,IAAI;IACb;AAEA;;;;;;;;;AASG;AACH,IAAA,MAAM,CAAC,KAAsB,EAAA;AAC3B,QAAA,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;YAC9B,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,MAAM,GAAmB;AAC7B,oBAAA,IAAI,EAAE,WAAW;AACjB,oBAAA,QAAQ,EAAE,KAAK;iBAChB;AACD,gBAAA,IAAI,CAAC,gBAAgB,GAAG,MAAM;YAChC;iBAAO;AACL,gBAAA,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;YACpC;QACF;aAAO;AACL,YAAA,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,IAAI,CAAC,gBAAgB,GAAG;AACtB,oBAAA,IAAI,EAAE,cAAc;oBACpB,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;iBACJ;YACxB;iBAAO;AACL,gBAAA,IAAI,CAAC,gBAAgB,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAoB;YAC3F;QACF;AACA,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,WAAW,CAAC,KAAa,EAAA;AACvB,QAAA,IAAI,CAAC,cAAc,GAAG,KAAK;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,WAAW,CAAC,KAAW,EAAA;AACrB,QAAA,IAAI,CAAC,cAAc,GAAG,KAAK;AAC3B,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,MAAM,OAAO,CAAC,GAAG,IAAwC,EAAA;AACvD,QAAA,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAgB,CAAC;AAEvD,QAAA,MAAM,GAAG,CAAC,KAAK,EAAE;AAEjB,QAAA,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,CAAA,sBAAA,EAAyB,GAAG,CAAC,SAAS,CAAA,8BAAA,CAAgC,CAAC;QACzF;AAEA,QAAA,MAAM,OAAO,GAAe;YAC1B,KAAK,EAAE,IAAI,CAAC,SAAU;YACtB,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,GAAG,CAAC,SAAS;AACpB,YAAA,KAAK,EAAE,SAAS;YAChB,IAAI;YACJ,gBAAgB,EAAE,IAAI,CAAC,eAAgB;AACvC,YAAA,OAAO,EAAE,CAAC;YACV,YAAY,EAAE,IAAI,CAAC,cAAe;YAClC,YAAY,EAAE,IAAI,CAAC,cAAe;YAClC,OAAO,EAAE,IAAI,CAAC,UAAW;YACzB,iBAAiB,EAAE,IAAI,CAAC,gBAAiB;SAC1C;AACD,QAAA,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CACxB,CAAA,cAAA,EAAiB,GAAG,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;8BACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA,CAAE,CAC/D;AAED,QAAA,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAClE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,OAAkB,CAAC;AAC7D,YAAA,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAA,IAAA,EAAO,GAAG,CAAC,SAAS,uBAAuB,OAAO,CAAC,aAAa,CAAA,CAAE,CAAC;QAChG;QAEA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;IAC3C;AACD;;;;"}

package/dist/job/job-transitioner.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+var core = require('@sidequest/core');
+
+/**
+ * Handles applying job transitions and updating jobs in the backend.
+ */
+class JobTransitioner {
+    /**
+     * Applies a transition to a job and updates it in the backend.
+     *
+     * This method checks if the transition should run based on the job's current state.
+     * If applicable, it applies the transition and updates the job in the backend.
+     *
+     * @param jobData The job data to update.
+     * @param transition The job transition to apply.
+     * @returns A promise resolving to the updated job data.
+     */
+    static apply(backend, jobData, transition) {
+        if (!transition.shouldRun(jobData)) {
+            core.logger("JobTransitioner").debug(`Transition ${transition.constructor.name} not applicable for job ${jobData.id}. Returning original job data.`);
+            return jobData;
+        }
+        core.logger("JobTransitioner").info(`Applying transition ${transition.constructor.name} to job ${jobData.id}`);
+        const newData = transition.apply(jobData);
+        if (newData.uniqueness_config) {
+            const uniqueness = core.UniquenessFactory.create(newData.uniqueness_config);
+            newData.unique_digest = uniqueness.digest(jobData);
+        }
+        core.logger("JobTransitioner").debug(`Updating with new job data: ${JSON.stringify(newData)}`);
+        return backend.updateJob(newData);
+    }
+}
+
+exports.JobTransitioner = JobTransitioner;
+//# sourceMappingURL=job-transitioner.cjs.map

package/dist/job/job-transitioner.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-transitioner.cjs","sources":["../../src/job/job-transitioner.ts"],"sourcesContent":[null],"names":["logger","UniquenessFactory"],"mappings":";;;;AAGA;;AAEG;MACU,eAAe,CAAA;AAC1B;;;;;;;;;AASG;AACH,IAAA,OAAO,KAAK,CAAC,OAAgB,EAAE,OAAgB,EAAE,UAAyB,EAAA;QACxE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;AAClC,YAAAA,WAAM,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAC7B,cAAc,UAAU,CAAC,WAAW,CAAC,IAAI,CAAA,wBAAA,EAA2B,OAAO,CAAC,EAAE,CAAA,8BAAA,CAAgC,CAC/G;AACD,YAAA,OAAO,OAAO;QAChB;AAEA,QAAAA,WAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,uBAAuB,UAAU,CAAC,WAAW,CAAC,IAAI,CAAA,QAAA,EAAW,OAAO,CAAC,EAAE,CAAA,CAAE,CAAC;QACzG,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC;AACzC,QAAA,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,MAAM,UAAU,GAAGC,sBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACtE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;QACpD;AACA,QAAAD,WAAM,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAA,4BAAA,EAA+B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA,CAAE,CAAC;AACzF,QAAA,OAAO,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACnC;AACD;;;;"}

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

@@ -0,0 +1,21 @@
+import { Backend } from '@sidequest/backend';
+import { JobData, JobTransition } from '@sidequest/core';
+
+/**
+ * Handles applying job transitions and updating jobs in the backend.
+ */
+declare class JobTransitioner {
+    /**
+     * Applies a transition to a job and updates it in the backend.
+     *
+     * This method checks if the transition should run based on the job's current state.
+     * If applicable, it applies the transition and updates the job in the backend.
+     *
+     * @param jobData The job data to update.
+     * @param transition The job transition to apply.
+     * @returns A promise resolving to the updated job data.
+     */
+    static apply(backend: Backend, jobData: JobData, transition: JobTransition): JobData | Promise<JobData>;
+}
+
+export { JobTransitioner };

package/dist/job/job-transitioner.js

@@ -0,0 +1,34 @@
+import { logger, UniquenessFactory } from '@sidequest/core';
+
+/**
+ * Handles applying job transitions and updating jobs in the backend.
+ */
+class JobTransitioner {
+    /**
+     * Applies a transition to a job and updates it in the backend.
+     *
+     * This method checks if the transition should run based on the job's current state.
+     * If applicable, it applies the transition and updates the job in the backend.
+     *
+     * @param jobData The job data to update.
+     * @param transition The job transition to apply.
+     * @returns A promise resolving to the updated job data.
+     */
+    static apply(backend, jobData, transition) {
+        if (!transition.shouldRun(jobData)) {
+            logger("JobTransitioner").debug(`Transition ${transition.constructor.name} not applicable for job ${jobData.id}. Returning original job data.`);
+            return jobData;
+        }
+        logger("JobTransitioner").info(`Applying transition ${transition.constructor.name} to job ${jobData.id}`);
+        const newData = transition.apply(jobData);
+        if (newData.uniqueness_config) {
+            const uniqueness = UniquenessFactory.create(newData.uniqueness_config);
+            newData.unique_digest = uniqueness.digest(jobData);
+        }
+        logger("JobTransitioner").debug(`Updating with new job data: ${JSON.stringify(newData)}`);
+        return backend.updateJob(newData);
+    }
+}
+
+export { JobTransitioner };
+//# sourceMappingURL=job-transitioner.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"job-transitioner.js","sources":["../../src/job/job-transitioner.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;MACU,eAAe,CAAA;AAC1B;;;;;;;;;AASG;AACH,IAAA,OAAO,KAAK,CAAC,OAAgB,EAAE,OAAgB,EAAE,UAAyB,EAAA;QACxE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;AAClC,YAAA,MAAM,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAC7B,cAAc,UAAU,CAAC,WAAW,CAAC,IAAI,CAAA,wBAAA,EAA2B,OAAO,CAAC,EAAE,CAAA,8BAAA,CAAgC,CAC/G;AACD,YAAA,OAAO,OAAO;QAChB;AAEA,QAAA,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,uBAAuB,UAAU,CAAC,WAAW,CAAC,IAAI,CAAA,QAAA,EAAW,OAAO,CAAC,EAAE,CAAA,CAAE,CAAC;QACzG,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC;AACzC,QAAA,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACtE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;QACpD;AACA,QAAA,MAAM,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAA,4BAAA,EAA+B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA,CAAE,CAAC;AACzF,QAAA,OAAO,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;IACnC;AACD;;;;"}