@tachybase/plugin-adapter-bullmq 1.3.16 → 1.3.18

package/dist/node_modules/bullmq/dist/esm/interfaces/minimal-job.d.ts

@@ -1,26 +1,45 @@
-import { JobsOptions, JobJsonSandbox } from '../types';
+import { JobsOptions, JobJsonSandbox, JobProgress } from '../types';
 import { JobJson } from './job-json';
 import { ParentKeys } from './parent';
+import { ParentOptions } from './parent-options';
 export type BulkJobOptions = Omit<JobsOptions, 'repeat'>;
 export interface MoveToDelayedOpts {
     skipAttempt?: boolean;
     fieldsToUpdate?: Record<string, any>;
 }
+export interface RetryJobOpts {
+    fieldsToUpdate?: Record<string, any>;
+}
 export interface MoveToWaitingChildrenOpts {
-    child?: {
-        id: string;
-        queue: string;
-    };
+    child?: ParentOptions;
+}
+export interface DependencyOpts {
+    /**
+     * Cursor value to be passed for pagination
+     */
+    cursor?: number;
+    /**
+     * Max quantity of jobs to be retrieved
+     */
+    count?: number;
 }
 export interface DependenciesOpts {
-    processed?: {
-        cursor?: number;
-        count?: number;
-    };
-    unprocessed?: {
-        cursor?: number;
-        count?: number;
-    };
+    /**
+     * Options for failed child pagination
+     */
+    failed?: DependencyOpts;
+    /**
+     * Options for ignored child pagination
+     */
+    ignored?: DependencyOpts;
+    /**
+     * Options for processed child pagination
+     */
+    processed?: DependencyOpts;
+    /**
+     * Options for unprocessed child pagination
+     */
+    unprocessed?: DependencyOpts;
 }
 /**
  * MinimalJob
@@ -43,7 +62,7 @@ export interface MinimalJob<DataType = any, ReturnType = any, NameType extends s
      * The progress a job has performed so far.
      * @defaultValue 0
      */
-    progress: number | object;
+    progress: JobProgress;
     /**
      * The value returned by the processor when processing this job.
      * @defaultValue null
@@ -113,7 +132,7 @@ export interface MinimalJob<DataType = any, ReturnType = any, NameType extends s
      *
      * @param progress - number or object to be saved as progress.
      */
-    updateProgress(progress: number | object): Promise<void>;
+    updateProgress(progress: JobProgress): Promise<void>;
     /**
      * Logs one row of log data.
      *

package/dist/node_modules/bullmq/dist/esm/interfaces/parent-options.d.ts

@@ -0,0 +1,11 @@
+export type ParentOptions = {
+    /**
+     * Parent identifier.
+     */
+    id: string;
+    /**
+     * It includes the prefix, the namespace separator :, and queue name.
+     * @see {@link https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html}
+     */
+    queue: string;
+};

package/dist/node_modules/bullmq/dist/esm/interfaces/parent-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parent-options.js.map

package/dist/node_modules/bullmq/dist/esm/interfaces/parent.d.ts

@@ -10,10 +10,14 @@ export interface Parent<T> {
     opts?: JobsOptions;
 }
 export interface ParentKeys {
-    id: string;
+    id?: string;
     queueKey: string;
+    fpof?: boolean;
+    rdof?: boolean;
+    idof?: boolean;
+    cpof?: boolean;
 }
-export type ParentOpts = {
+export type ParentKeyOpts = {
     waitChildrenKey?: string;
     parentDependenciesKey?: string;
     parentKey?: string;

package/dist/node_modules/bullmq/dist/esm/interfaces/queue-options.d.ts

@@ -16,7 +16,7 @@ export interface QueueBaseOptions {
     connection: ConnectionOptions;
     /**
      * Denotes commands should retry indefinitely.
-     * @deprecated
+     * @deprecated not in use anymore.
      */
     blockingConnection?: boolean;
     /**
@@ -32,6 +32,15 @@ export interface QueueBaseOptions {
      * Telemetry client
      */
     telemetry?: Telemetry;
+    /**
+     * Skip waiting for connection ready.
+     *
+     * In some instances if you want the queue to fail fast if the connection is
+     * not ready you can set this to true. This could be useful for testing and when
+     * adding jobs via HTTP endpoints for example.
+     *
+     */
+    skipWaitingForReady?: boolean;
 }
 /**
  * Options for the Queue class.
@@ -65,10 +74,6 @@ export interface QueueOptions extends QueueBaseOptions {
      * Advanced options for the repeatable jobs.
      */
     settings?: AdvancedRepeatOptions;
-    /**
-     * Telemetry client
-     */
-    telemetry?: Telemetry;
 }
 /**
  * Options for the Repeat class.
@@ -79,7 +84,7 @@ export interface RepeatBaseOptions extends QueueBaseOptions {
 /**
  * Options for QueueEvents
  */
-export interface QueueEventsOptions extends QueueBaseOptions {
+export interface QueueEventsOptions extends Omit<QueueBaseOptions, 'telemetry'> {
     /**
      * Condition to start listening to events at instance creation.
      */
@@ -95,3 +100,7 @@ export interface QueueEventsOptions extends QueueBaseOptions {
      */
     blockingTimeout?: number;
 }
+/**
+ * Options for QueueEventsProducer
+ */
+export type QueueEventsProducerOptions = Omit<QueueBaseOptions, 'telemetry'>;

package/dist/node_modules/bullmq/dist/esm/interfaces/receiver.d.ts

@@ -0,0 +1,4 @@
+export interface Receiver {
+    on: (evt: 'message', cb: (msg: any) => void) => void;
+    off: (evt: 'message', cb: (msg: any) => void) => void;
+}

package/dist/node_modules/bullmq/dist/esm/interfaces/receiver.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=receiver.js.map

package/dist/node_modules/bullmq/dist/esm/interfaces/repeat-options.d.ts

@@ -36,7 +36,6 @@ export interface RepeatOptions extends Omit<ParserOptions, 'iterator'> {
     count?: number;
     /**
      * Offset in milliseconds to affect the next iteration time
-     *
      * */
     offset?: number;
     /**
@@ -45,7 +44,7 @@ export interface RepeatOptions extends Omit<ParserOptions, 'iterator'> {
     prevMillis?: number;
     /**
      * Internal property to store de job id
-     * @deprecated
+     * @deprecated not in use anymore
      */
     jobId?: string;
 }

package/dist/node_modules/bullmq/dist/esm/interfaces/repeatable-options.d.ts

@@ -2,6 +2,8 @@ export type RepeatableOptions = {
     name: string;
     endDate?: number;
     tz?: string;
+    limit?: number;
     pattern?: string;
     every?: number;
+    offset?: number;
 };

package/dist/node_modules/bullmq/dist/esm/interfaces/sandboxed-job.d.ts

@@ -1,4 +1,4 @@
-import { JobJsonSandbox, JobsOptions } from '../types';
+import { JobJsonSandbox, JobProgress, JobsOptions } from '../types';
 /**
  * @see {@link https://docs.bullmq.io/guide/workers/sandboxed-processors}
  */
@@ -6,8 +6,9 @@ export interface SandboxedJob<T = any, R = any> extends Omit<JobJsonSandbox, 'da
     data: T;
     opts: JobsOptions;
     moveToDelayed: (timestamp: number, token?: string) => Promise<void>;
+    moveToWait: (token?: string) => Promise<void>;
     log: (row: any) => void;
     updateData: (data: any) => Promise<void>;
-    updateProgress: (value: object | number) => Promise<void>;
+    updateProgress: (value: JobProgress) => Promise<void>;
     returnValue: R;
 }

package/dist/node_modules/bullmq/dist/esm/interfaces/sandboxed-options.d.ts

@@ -8,7 +8,7 @@ export interface SandboxedOptions {
      * Note: This option can only be used when specifying
      * a file for the processor argument.
      *
-     * @default false
+     * @defaultValue false
      */
     useWorkerThreads?: boolean;
     /**

package/dist/node_modules/bullmq/dist/esm/interfaces/telemetry.d.ts

@@ -33,8 +33,8 @@ export interface ContextManager<Context = any> {
     /**
      * Creates a new context and sets it as active for the fn passed as last argument
      *
-     * @param context -
-     * @param fn -
+     * @param context - the context to set as active
+     * @param fn - the function to execute with the context
      */
     with<A extends (...args: any[]) => any>(context: Context, fn: A): ReturnType<A>;
     /**
@@ -46,15 +46,15 @@ export interface ContextManager<Context = any> {
      * is the mechanism used to propagate the context across a distributed
      * application.
      *
-     * @param context -
+     * @param context - the current context
      */
     getMetadata(context: Context): string;
     /**
      * Creates a new context from a serialized version effectively
      * linking the new context to the parent context.
      *
-     * @param activeContext -
-     * @param metadata -
+     * @param activeContext - the current active context
+     * @param metadata - the serialized version of the context
      */
     fromMetadata(activeContext: Context, metadata: string): Context;
 }
@@ -68,9 +68,10 @@ export interface Tracer<Context = any> {
      * context. If the context is not provided, the current active context should be
      * used.
      *
-     * @param name -
-     * @param options -
-     * @param context -
+     * @param name - span name
+     * @param options - span options
+     * @param context - optional context
+     * @returns - the created span
      */
     startSpan(name: string, options?: SpanOptions, context?: Context): Span;
 }
@@ -85,33 +86,35 @@ export interface Span<Context = any> {
      * setSpanOnContext sets the span on the context. This is useful when you want
      * to propagate the span across the application.
      *
-     * @param ctx
+     * @param ctx - context to set the span on
+     * @returns - the context with the span set on it
      */
     setSpanOnContext(ctx: Context): Context;
     /**
      * setAttribute sets an attribute on the span.
      *
-     * @param ctx
+     * @param key - attribute key
+     * @param value - attribute value
      */
     setAttribute(key: string, value: AttributeValue): void;
     /**
      * setAttributes sets multiple attributes on the span.
      *
-     * @param attributes
+     * @param attributes - attributes to set
      */
     setAttributes(attributes: Attributes): void;
     /**
      * addEvent adds an event to the span.
      *
-     * @param name
-     * @param attributes
+     * @param name - event name
+     * @param attributes - event attributes
      */
     addEvent(name: string, attributes?: Attributes): void;
     /**
      * recordException records an exception on the span.
      *
-     * @param exception
-     * @param time
+     * @param exception - exception to record
+     * @param time - time to record the exception
      */
     recordException(exception: Exception, time?: Time): void;
     /**

package/dist/node_modules/bullmq/dist/esm/interfaces/worker-options.d.ts

@@ -20,14 +20,14 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
     /**
      * Condition to start processor at instance creation.
      *
-     * @default true
+     * @defaultValue true
      */
     autorun?: boolean;
     /**
      * Amount of jobs that a single worker is allowed to work on
      * in parallel.
      *
-     * @default 1
+     * @defaultValue 1
      * @see {@link https://docs.bullmq.io/guide/workers/concurrency}
      */
     concurrency?: number;
@@ -46,13 +46,13 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * to the `wait` state. If this is exceeded, the job is moved
      * to `failed`.
      *
-     * @default 1
+     * @defaultValue 1
      */
     maxStalledCount?: number;
     /**
      * Number of milliseconds between stallness checks.
      *
-     * @default 30000
+     * @defaultValue 30000
      */
     stalledInterval?: number;
     /**
@@ -72,7 +72,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      *  perform stalled checkd and move jobs back to wait for jobs being processed
      *  by this worker.
      *
-     *  @default false
+     *  @defaultValue false
      */
     skipStalledCheck?: boolean;
     /**
@@ -80,13 +80,13 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      *  after lockDuration and moved back to the wait queue (if the stalled check is
      *  not disabled)
      *
-     *  @default false
+     *  @defaultValue false
      */
     skipLockRenewal?: boolean;
     /**
      * Number of seconds to long poll for jobs when the queue is empty.
      *
-     * @default 5
+     * @defaultValue 5
      */
     drainDelay?: number;
     /**
@@ -95,7 +95,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * be picked up by the stalled checker and move back to wait so that another worker
      * can process it again.
      *
-     * @default 30000
+     * @defaultValue 30000
      */
     lockDuration?: number;
     /**
@@ -108,7 +108,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
     /**
      * This is an internal option that should not be modified.
      *
-     * @default 15000
+     * @defaultValue 15000
      */
     runRetryDelay?: number;
     /**
@@ -120,7 +120,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * Note: This option can only be used when specifying
      * a file for the processor argument.
      *
-     * @default false
+     * @defaultValue false
      */
     useWorkerThreads?: boolean;
     /**