payload 3.0.0-beta.13 → 3.0.0-beta.131

package/dist/queues/config/types/workflowJSONTypes.js

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

package/dist/queues/config/types/workflowJSONTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"sourcesContent":["import type { RunningJob, TaskHandlerResult, TypedJobs } from '../../../index.js'\nimport type { RetryConfig, TaskHandlerArgsNoInput } from './taskTypes.js'\n\nexport type WorkflowStep<\n  TTaskSlug extends keyof TypedJobs['tasks'],\n  TWorkflowSlug extends keyof TypedJobs['workflows'],\n> = {\n  /**\n   * If this step is completed, the workflow will be marked as completed\n   */\n  completesJob?: boolean\n  condition?: (args: { job: RunningJob<TWorkflowSlug> }) => boolean\n  /**\n   * Each task needs to have a unique ID to track its status\n   */\n  id: string\n  retries?: number | RetryConfig\n} & (\n  | {\n      inlineTask?: (\n        args: TaskHandlerArgsNoInput<TypedJobs['workflows'][TWorkflowSlug]['input']>,\n      ) => Promise<TaskHandlerResult<TTaskSlug>> | TaskHandlerResult<TTaskSlug>\n    }\n  | {\n      input: (args: { job: RunningJob<TWorkflowSlug> }) => TypedJobs['tasks'][TTaskSlug]['input']\n      task: TTaskSlug\n    }\n)\n\ntype AllWorkflowSteps<TWorkflowSlug extends keyof TypedJobs['workflows']> = {\n  [TTaskSlug in keyof TypedJobs['tasks']]: WorkflowStep<TTaskSlug, TWorkflowSlug>\n}[keyof TypedJobs['tasks']]\n\nexport type WorkflowJSON<TWorkflowSlug extends keyof TypedJobs['workflows']> = Array<\n  AllWorkflowSteps<TWorkflowSlug>\n>\n"],"names":[],"mappings":"AAiCA,WAEC"}

package/dist/queues/config/types/workflowTypes.d.ts

@@ -0,0 +1,99 @@
+import type { Field } from '../../../fields/config/types.js';
+import type { PayloadRequest, StringKeyOf, TypedCollection, TypedJobs } from '../../../index.js';
+import type { RetryConfig, RunInlineTaskFunction, RunTaskFunctions, TaskInput, TaskOutput, TaskType } from './taskTypes.js';
+import type { WorkflowJSON } from './workflowJSONTypes.js';
+export type JobLog = {
+    completedAt: string;
+    error?: unknown;
+    executedAt: string;
+    input?: any;
+    output?: any;
+    state: 'failed' | 'succeeded';
+    taskID: string;
+    taskSlug: string;
+};
+export type BaseJob = {
+    completedAt?: string;
+    error?: unknown;
+    hasError?: boolean;
+    id: number | string;
+    input?: any;
+    log: JobLog[];
+    processing?: boolean;
+    queue: string;
+    taskSlug?: string;
+    taskStatus?: JobTaskStatus;
+    totalTried: number;
+    waitUntil?: string;
+    workflowSlug?: string;
+};
+export type WorkflowTypes = StringKeyOf<TypedJobs['workflows']>;
+export type RunningJob<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> = {
+    input: TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TypedJobs['workflows'][TWorkflowSlugOrInput]['input'] : TWorkflowSlugOrInput;
+    taskStatus: JobTaskStatus;
+} & Omit<TypedCollection['payload-jobs'], 'input' | 'taskStatus'>;
+export type RunningJobSimple<TWorkflowInput extends object> = {
+    input: TWorkflowInput;
+} & TypedCollection['payload-jobs'];
+export type RunningJobFromTask<TTaskSlug extends keyof TypedJobs['tasks']> = {
+    input: TypedJobs['tasks'][TTaskSlug]['input'];
+} & TypedCollection['payload-jobs'];
+export type WorkflowHandler<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> = (args: {
+    inlineTask: RunInlineTaskFunction;
+    job: RunningJob<TWorkflowSlugOrInput>;
+    req: PayloadRequest;
+    tasks: RunTaskFunctions;
+}) => Promise<void>;
+export type SingleTaskStatus<T extends keyof TypedJobs['tasks']> = {
+    complete: boolean;
+    input: TaskInput<T>;
+    output: TaskOutput<T>;
+    taskSlug: TaskType;
+    totalTried: number;
+};
+/**
+ * Task IDs mapped to their status
+ */
+export type JobTaskStatus = {
+    [taskSlug in TaskType]: {
+        [taskID: string]: SingleTaskStatus<taskSlug>;
+    };
+};
+export type WorkflowConfig<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> = {
+    /**
+     * You can either pass a string-based path to the workflow function file, or the workflow function itself.
+     *
+     * If you are using large dependencies within your workflow control flow, you might prefer to pass the string path
+     * because that will avoid bundling large dependencies in your Next.js app.
+     *
+     *
+     */
+    handler: string | WorkflowHandler<TWorkflowSlugOrInput> | WorkflowJSON<TWorkflowSlugOrInput extends object ? string : TWorkflowSlugOrInput>;
+    /**
+     * Define the input field schema  - payload will generate a type for this schema.
+     */
+    inputSchema?: Field[];
+    /**
+     * You can use interfaceName to change the name of the interface that is generated for this workflow. By default, this is "Workflow" + the capitalized workflow slug.
+     */
+    interfaceName?: string;
+    /**
+     * Define a human-friendly label for this workflow.
+     */
+    label?: string;
+    /**
+     * Optionally, define the default queue name that this workflow should be tied to.
+     * Defaults to "default".
+     * Can be overridden when queuing jobs via Local API.
+     */
+    queue?: string;
+    /**
+     * Specify the number of times that this workflow should be retried if it fails for any reason.
+     */
+    retries?: number | RetryConfig;
+    /**
+     * Define a slug-based name for this job.
+     */
+    slug: TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TWorkflowSlugOrInput : string;
+};
+//# sourceMappingURL=workflowTypes.d.ts.map

package/dist/queues/config/types/workflowTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/workflowTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAA;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAChG,OAAO,KAAK,EACV,WAAW,EACX,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,QAAQ,EACT,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,KAAK,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,GAAG,EAAE,MAAM,EAAE,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAA;AAG/D,MAAM,MAAM,UAAU,CAAC,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI;IAC3F,KAAK,EAAE,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAC5D,SAAS,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,GACrD,oBAAoB,CAAA;IACxB,UAAU,EAAE,aAAa,CAAA;CAC1B,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC,CAAA;AAEjE,MAAM,MAAM,gBAAgB,CAAC,cAAc,SAAS,MAAM,IAAI;IAC5D,KAAK,EAAE,cAAc,CAAA;CACtB,GAAG,eAAe,CAAC,cAAc,CAAC,CAAA;AAGnC,MAAM,MAAM,kBAAkB,CAAC,SAAS,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI;IAC3E,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAA;CAC9C,GAAG,eAAe,CAAC,cAAc,CAAC,CAAA;AAEnC,MAAM,MAAM,eAAe,CAAC,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,IAC5F,CAAC,IAAI,EAAE;IACL,UAAU,EAAE,qBAAqB,CAAA;IACjC,GAAG,EAAE,UAAU,CAAC,oBAAoB,CAAC,CAAA;IACrC,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,gBAAgB,CAAA;CACxB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAErB,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI;IACjE,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACrB,QAAQ,EAAE,QAAQ,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;KAEzB,QAAQ,IAAI,QAAQ,GAAG;QACtB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAA;KAC7C;CACF,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,IAAI;IAC/F;;;;;;;OAOG;IACH,OAAO,EACH,MAAM,GACN,eAAe,CAAC,oBAAoB,CAAC,GACrC,YAAY,CAAC,oBAAoB,SAAS,MAAM,GAAG,MAAM,GAAG,oBAAoB,CAAC,CAAA;IACrF;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,EAAE,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IAC9B;;OAEG;IACH,IAAI,EAAE,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,oBAAoB,GAAG,MAAM,CAAA;CAChG,CAAA"}

package/dist/queues/config/types/workflowTypes.js

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

package/dist/queues/config/types/workflowTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/config/types/workflowTypes.ts"],"sourcesContent":["import type { Field } from '../../../fields/config/types.js'\nimport type { PayloadRequest, StringKeyOf, TypedCollection, TypedJobs } from '../../../index.js'\nimport type {\n  RetryConfig,\n  RunInlineTaskFunction,\n  RunTaskFunctions,\n  TaskInput,\n  TaskOutput,\n  TaskType,\n} from './taskTypes.js'\nimport type { WorkflowJSON } from './workflowJSONTypes.js'\n\nexport type JobLog = {\n  completedAt: string\n  error?: unknown\n  executedAt: string\n  input?: any\n  output?: any\n  state: 'failed' | 'succeeded'\n  taskID: string\n  taskSlug: string\n}\n\nexport type BaseJob = {\n  completedAt?: string\n  error?: unknown\n  hasError?: boolean\n  id: number | string\n  input?: any\n  log: JobLog[]\n  processing?: boolean\n  queue: string\n  taskSlug?: string\n  taskStatus?: JobTaskStatus\n  totalTried: number\n  waitUntil?: string\n  workflowSlug?: string\n}\n\nexport type WorkflowTypes = StringKeyOf<TypedJobs['workflows']>\n\n// TODO: Type job.taskStatus once available - for JSON-defined workflows\nexport type RunningJob<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> = {\n  input: TWorkflowSlugOrInput extends keyof TypedJobs['workflows']\n    ? TypedJobs['workflows'][TWorkflowSlugOrInput]['input']\n    : TWorkflowSlugOrInput\n  taskStatus: JobTaskStatus\n} & Omit<TypedCollection['payload-jobs'], 'input' | 'taskStatus'>\n\nexport type RunningJobSimple<TWorkflowInput extends object> = {\n  input: TWorkflowInput\n} & TypedCollection['payload-jobs']\n\n// Simplified version of RunningJob that doesn't break TypeScript (TypeScript seems to stop evaluating RunningJob when it's too complex)\nexport type RunningJobFromTask<TTaskSlug extends keyof TypedJobs['tasks']> = {\n  input: TypedJobs['tasks'][TTaskSlug]['input']\n} & TypedCollection['payload-jobs']\n\nexport type WorkflowHandler<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> =\n  (args: {\n    inlineTask: RunInlineTaskFunction\n    job: RunningJob<TWorkflowSlugOrInput>\n    req: PayloadRequest\n    tasks: RunTaskFunctions\n  }) => Promise<void>\n\nexport type SingleTaskStatus<T extends keyof TypedJobs['tasks']> = {\n  complete: boolean\n  input: TaskInput<T>\n  output: TaskOutput<T>\n  taskSlug: TaskType\n  totalTried: number\n}\n\n/**\n * Task IDs mapped to their status\n */\nexport type JobTaskStatus = {\n  // Wrap in taskSlug to improve typing\n  [taskSlug in TaskType]: {\n    [taskID: string]: SingleTaskStatus<taskSlug>\n  }\n}\n\nexport type WorkflowConfig<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object> = {\n  /**\n   * You can either pass a string-based path to the workflow function file, or the workflow function itself.\n   *\n   * If you are using large dependencies within your workflow control flow, you might prefer to pass the string path\n   * because that will avoid bundling large dependencies in your Next.js app.\n   *\n   *\n   */\n  handler:\n    | string\n    | WorkflowHandler<TWorkflowSlugOrInput>\n    | WorkflowJSON<TWorkflowSlugOrInput extends object ? string : TWorkflowSlugOrInput>\n  /**\n   * Define the input field schema  - payload will generate a type for this schema.\n   */\n  inputSchema?: Field[]\n  /**\n   * You can use interfaceName to change the name of the interface that is generated for this workflow. By default, this is \"Workflow\" + the capitalized workflow slug.\n   */\n  interfaceName?: string\n  /**\n   * Define a human-friendly label for this workflow.\n   */\n  label?: string\n  /**\n   * Optionally, define the default queue name that this workflow should be tied to.\n   * Defaults to \"default\".\n   * Can be overridden when queuing jobs via Local API.\n   */\n  queue?: string\n  /**\n   * Specify the number of times that this workflow should be retried if it fails for any reason.\n   */\n  retries?: number | RetryConfig\n  /**\n   * Define a slug-based name for this job.\n   */\n  slug: TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TWorkflowSlugOrInput : string\n}\n\ntype AllWorkflowConfigs = {\n  [TWorkflowSlug in keyof TypedJobs['workflows']]: WorkflowConfig<TWorkflowSlug>\n}[keyof TypedJobs['workflows']]\n"],"names":[],"mappings":"AAoFA,WAuCC"}

package/dist/queues/localAPI.d.ts

@@ -0,0 +1,25 @@
+import type { RunningJobFromTask } from './config/types/workflowTypes.js';
+import { type Payload, type PayloadRequest, type RunningJob, type TypedJobs } from '../index.js';
+import { runJobs } from './operations/runJobs/index.js';
+export declare const getJobsLocalAPI: (payload: Payload) => {
+    queue: <TTaskOrWorkflowSlug extends keyof TypedJobs["tasks"] | keyof TypedJobs["workflows"]>(args: {
+        input: TypedJobs["tasks"][TTaskOrWorkflowSlug]["input"];
+        queue?: string;
+        req?: PayloadRequest;
+        task: TTaskOrWorkflowSlug extends keyof TypedJobs["tasks"] ? TTaskOrWorkflowSlug : never;
+        workflow?: never;
+    } | {
+        input: TypedJobs["workflows"][TTaskOrWorkflowSlug]["input"];
+        queue?: string;
+        req?: PayloadRequest;
+        task?: never;
+        workflow: TTaskOrWorkflowSlug extends keyof TypedJobs["workflows"] ? TTaskOrWorkflowSlug : never;
+    }) => Promise<TTaskOrWorkflowSlug extends keyof TypedJobs["workflows"] ? RunningJob<TTaskOrWorkflowSlug> : RunningJobFromTask<TTaskOrWorkflowSlug>>;
+    run: (args?: {
+        limit?: number;
+        overrideAccess?: boolean;
+        queue?: string;
+        req?: PayloadRequest;
+    }) => Promise<ReturnType<typeof runJobs>>;
+};
+//# sourceMappingURL=localAPI.d.ts.map

package/dist/queues/localAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localAPI.d.ts","sourceRoot":"","sources":["../../src/queues/localAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAEzE,OAAO,EAEL,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,SAAS,EACf,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAEvD,eAAO,MAAM,eAAe,YAAa,OAAO;YAG5C,mBAAmB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,QAG/E;QACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAA;QACvD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,GAAG,CAAC,EAAE,cAAc,CAAA;QAEpB,IAAI,EAAE,mBAAmB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,mBAAmB,GAAG,KAAK,CAAA;QACxF,QAAQ,CAAC,EAAE,KAAK,CAAA;KACjB,GACD;QACE,KAAK,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3D,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,GAAG,CAAC,EAAE,cAAc,CAAA;QACpB,IAAI,CAAC,EAAE,KAAK,CAAA;QACZ,QAAQ,EAAE,mBAAmB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAC9D,mBAAmB,GACnB,KAAK,CAAA;KACV,KACJ,OAAO,CACR,mBAAmB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GACpD,UAAU,CAAC,mBAAmB,CAAC,GAC/B,kBAAkB,CAAC,mBAAmB,CAAC,CAC5C;iBA6BkB;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,GAAG,CAAC,EAAE,cAAc,CAAA;KACrB,KAAG,OAAO,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC;CAUvC,CAAA"}

package/dist/queues/localAPI.js

@@ -0,0 +1,41 @@
+import { createLocalReq } from '../index.js';
+import { runJobs } from './operations/runJobs/index.js';
+export const getJobsLocalAPI = (payload)=>({
+        queue: async (args)=>{
+            let queue;
+            // If user specifies queue, use that
+            if (args.queue) {
+                queue = args.queue;
+            } else if (args.workflow) {
+                // Otherwise, if there is a workflow specified, and it has a default queue to use,
+                // use that
+                const workflow = payload.config.jobs?.workflows?.find(({ slug })=>slug === args.workflow);
+                if (workflow?.queue) {
+                    queue = workflow.queue;
+                }
+            }
+            return await payload.create({
+                collection: 'payload-jobs',
+                data: {
+                    input: args.input,
+                    queue,
+                    taskSlug: 'task' in args ? args.task : undefined,
+                    workflowSlug: 'workflow' in args ? args.workflow : undefined
+                },
+                req: args.req
+            });
+        // Type assertion is still needed here
+        },
+        run: async (args)=>{
+            const newReq = args?.req ?? await createLocalReq({}, payload);
+            const result = await runJobs({
+                limit: args?.limit,
+                overrideAccess: args?.overrideAccess !== false,
+                queue: args?.queue,
+                req: newReq
+            });
+            return result;
+        }
+    });
+
+//# sourceMappingURL=localAPI.js.map

package/dist/queues/localAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/queues/localAPI.ts"],"sourcesContent":["import type { RunningJobFromTask } from './config/types/workflowTypes.js'\n\nimport {\n  createLocalReq,\n  type Payload,\n  type PayloadRequest,\n  type RunningJob,\n  type TypedJobs,\n} from '../index.js'\nimport { runJobs } from './operations/runJobs/index.js'\n\nexport const getJobsLocalAPI = (payload: Payload) => ({\n  queue: async <\n    // eslint-disable-next-line @typescript-eslint/no-duplicate-type-constituents\n    TTaskOrWorkflowSlug extends keyof TypedJobs['tasks'] | keyof TypedJobs['workflows'],\n  >(\n    args:\n      | {\n          input: TypedJobs['tasks'][TTaskOrWorkflowSlug]['input']\n          queue?: string\n          req?: PayloadRequest\n          // TTaskOrWorkflowlug with keyof TypedJobs['workflows'] removed:\n          task: TTaskOrWorkflowSlug extends keyof TypedJobs['tasks'] ? TTaskOrWorkflowSlug : never\n          workflow?: never\n        }\n      | {\n          input: TypedJobs['workflows'][TTaskOrWorkflowSlug]['input']\n          queue?: string\n          req?: PayloadRequest\n          task?: never\n          workflow: TTaskOrWorkflowSlug extends keyof TypedJobs['workflows']\n            ? TTaskOrWorkflowSlug\n            : never\n        },\n  ): Promise<\n    TTaskOrWorkflowSlug extends keyof TypedJobs['workflows']\n      ? RunningJob<TTaskOrWorkflowSlug>\n      : RunningJobFromTask<TTaskOrWorkflowSlug>\n  > => {\n    let queue: string\n\n    // If user specifies queue, use that\n    if (args.queue) {\n      queue = args.queue\n    } else if (args.workflow) {\n      // Otherwise, if there is a workflow specified, and it has a default queue to use,\n      // use that\n      const workflow = payload.config.jobs?.workflows?.find(({ slug }) => slug === args.workflow)\n      if (workflow?.queue) {\n        queue = workflow.queue\n      }\n    }\n\n    return (await payload.create({\n      collection: 'payload-jobs',\n      data: {\n        input: args.input,\n        queue,\n        taskSlug: 'task' in args ? args.task : undefined,\n        workflowSlug: 'workflow' in args ? args.workflow : undefined,\n      },\n      req: args.req,\n    })) as TTaskOrWorkflowSlug extends keyof TypedJobs['workflows']\n      ? RunningJob<TTaskOrWorkflowSlug>\n      : RunningJobFromTask<TTaskOrWorkflowSlug> // Type assertion is still needed here\n  },\n\n  run: async (args?: {\n    limit?: number\n    overrideAccess?: boolean\n    queue?: string\n    req?: PayloadRequest\n  }): Promise<ReturnType<typeof runJobs>> => {\n    const newReq: PayloadRequest = args?.req ?? (await createLocalReq({}, payload))\n    const result = await runJobs({\n      limit: args?.limit,\n      overrideAccess: args?.overrideAccess !== false,\n      queue: args?.queue,\n      req: newReq,\n    })\n    return result\n  },\n})\n"],"names":["createLocalReq","runJobs","getJobsLocalAPI","payload","queue","args","workflow","config","jobs","workflows","find","slug","create","collection","data","input","taskSlug","task","undefined","workflowSlug","req","run","newReq","result","limit","overrideAccess"],"mappings":"AAEA,SACEA,cAAc,QAKT,cAAa;AACpB,SAASC,OAAO,QAAQ,gCAA+B;AAEvD,OAAO,MAAMC,kBAAkB,CAACC,UAAsB,CAAA;QACpDC,OAAO,OAILC;YAuBA,IAAID;YAEJ,oCAAoC;YACpC,IAAIC,KAAKD,KAAK,EAAE;gBACdA,QAAQC,KAAKD,KAAK;YACpB,OAAO,IAAIC,KAAKC,QAAQ,EAAE;gBACxB,kFAAkF;gBAClF,WAAW;gBACX,MAAMA,WAAWH,QAAQI,MAAM,CAACC,IAAI,EAAEC,WAAWC,KAAK,CAAC,EAAEC,IAAI,EAAE,GAAKA,SAASN,KAAKC,QAAQ;gBAC1F,IAAIA,UAAUF,OAAO;oBACnBA,QAAQE,SAASF,KAAK;gBACxB;YACF;YAEA,OAAQ,MAAMD,QAAQS,MAAM,CAAC;gBAC3BC,YAAY;gBACZC,MAAM;oBACJC,OAAOV,KAAKU,KAAK;oBACjBX;oBACAY,UAAU,UAAUX,OAAOA,KAAKY,IAAI,GAAGC;oBACvCC,cAAc,cAAcd,OAAOA,KAAKC,QAAQ,GAAGY;gBACrD;gBACAE,KAAKf,KAAKe,GAAG;YACf;QAE4C,sCAAsC;QACpF;QAEAC,KAAK,OAAOhB;YAMV,MAAMiB,SAAyBjB,MAAMe,OAAQ,MAAMpB,eAAe,CAAC,GAAGG;YACtE,MAAMoB,SAAS,MAAMtB,QAAQ;gBAC3BuB,OAAOnB,MAAMmB;gBACbC,gBAAgBpB,MAAMoB,mBAAmB;gBACzCrB,OAAOC,MAAMD;gBACbgB,KAAKE;YACP;YACA,OAAOC;QACT;IACF,CAAA,EAAE"}

package/dist/queues/operations/runJobs/index.d.ts

@@ -0,0 +1,21 @@
+import type { PayloadRequest } from '../../../types/index.js';
+import type { RunJobResult } from './runJob/index.js';
+export type RunJobsArgs = {
+    limit?: number;
+    overrideAccess?: boolean;
+    queue?: string;
+    req: PayloadRequest;
+};
+export type RunJobsResult = {
+    jobStatus?: Record<string, RunJobResult>;
+    /**
+     * If this is false, there for sure are no jobs remaining, regardless of the limit
+     */
+    noJobsRemaining?: boolean;
+    /**
+     * Out of the jobs that were queried & processed (within the set limit), how many are remaining and retryable?
+     */
+    remainingJobsFromQueried: number;
+};
+export declare const runJobs: ({ limit, overrideAccess, queue, req, }: RunJobsArgs) => Promise<RunJobsResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/queues/operations/runJobs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/queues/operations/runJobs/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAS,MAAM,yBAAyB,CAAA;AAQpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AASrD,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAA;CACjC,CAAA;AAED,eAAO,MAAM,OAAO,2CAKjB,WAAW,KAAG,OAAO,CAAC,aAAa,CAyLrC,CAAA"}

package/dist/queues/operations/runJobs/index.js

@@ -0,0 +1,180 @@
+import { Forbidden } from '../../../errors/Forbidden.js';
+import isolateObjectProperty from '../../../utilities/isolateObjectProperty.js';
+import { getUpdateJobFunction } from './runJob/getUpdateJobFunction.js';
+import { importHandlerPath } from './runJob/importHandlerPath.js';
+import { runJob } from './runJob/index.js';
+import { runJSONJob } from './runJSONJob/index.js';
+export const runJobs = async ({ limit = 10, overrideAccess, queue, req })=>{
+    if (!overrideAccess) {
+        const hasAccess = await req.payload.config.jobs.access.run({
+            req
+        });
+        if (!hasAccess) {
+            throw new Forbidden(req.t);
+        }
+    }
+    const where = {
+        and: [
+            {
+                completedAt: {
+                    exists: false
+                }
+            },
+            {
+                hasError: {
+                    not_equals: true
+                }
+            },
+            {
+                processing: {
+                    equals: false
+                }
+            },
+            {
+                or: [
+                    {
+                        waitUntil: {
+                            exists: false
+                        }
+                    },
+                    {
+                        waitUntil: {
+                            less_than: new Date().toISOString()
+                        }
+                    }
+                ]
+            }
+        ]
+    };
+    if (queue) {
+        where.and.push({
+            queue: {
+                equals: queue
+            }
+        });
+    }
+    // Find all jobs and ensure we set job to processing: true as early as possible to reduce the chance of
+    // the same job being picked up by another worker
+    const jobsQuery = await req.payload.update({
+        collection: 'payload-jobs',
+        data: {
+            processing: true,
+            seenByWorker: true
+        },
+        depth: req.payload.config.jobs.depth,
+        disableTransaction: true,
+        limit,
+        showHiddenFields: true,
+        where
+    });
+    /**
+   * Just for logging purposes, we want to know how many jobs are new and how many are existing (= already been tried).
+   * This is only for logs - in the end we still want to run all jobs, regardless of whether they are new or existing.
+   */ const { newJobs } = jobsQuery.docs.reduce((acc, job)=>{
+        if (job.totalTried > 0) {
+            acc.existingJobs.push(job);
+        } else {
+            acc.newJobs.push(job);
+        }
+        return acc;
+    }, {
+        existingJobs: [],
+        newJobs: []
+    });
+    if (!jobsQuery.docs.length) {
+        return {
+            noJobsRemaining: true,
+            remainingJobsFromQueried: 0
+        };
+    }
+    if (jobsQuery?.docs?.length) {
+        req.payload.logger.info(`Running ${jobsQuery.docs.length} jobs.`);
+    }
+    const jobPromises = jobsQuery.docs.map(async (job)=>{
+        if (!job.workflowSlug && !job.taskSlug) {
+            throw new Error('Job must have either a workflowSlug or a taskSlug');
+        }
+        const jobReq = isolateObjectProperty(req, 'transactionID');
+        const workflowConfig = job.workflowSlug ? req.payload.config.jobs?.workflows.find(({ slug })=>slug === job.workflowSlug) : {
+            slug: 'singleTask',
+            handler: async ({ job, tasks })=>{
+                await tasks[job.taskSlug]('1', {
+                    input: job.input
+                });
+            }
+        };
+        if (!workflowConfig) {
+            return null // Skip jobs with no workflow configuration
+            ;
+        }
+        const updateJob = getUpdateJobFunction(job, jobReq);
+        // the runner will either be passed to the config
+        // OR it will be a path, which we will need to import via eval to avoid
+        // Next.js compiler dynamic import expression errors
+        let workflowHandler;
+        if (typeof workflowConfig.handler === 'function' || typeof workflowConfig.handler === 'object' && Array.isArray(workflowConfig.handler)) {
+            workflowHandler = workflowConfig.handler;
+        } else {
+            workflowHandler = await importHandlerPath(workflowConfig.handler);
+            if (!workflowHandler) {
+                const errorMessage = `Can't find runner while importing with the path ${workflowConfig.handler} in job type ${job.workflowSlug}.`;
+                req.payload.logger.error(errorMessage);
+                await updateJob({
+                    error: {
+                        error: errorMessage
+                    },
+                    hasError: true,
+                    processing: false
+                });
+                return;
+            }
+        }
+        if (typeof workflowHandler === 'function') {
+            const result = await runJob({
+                job,
+                req: jobReq,
+                updateJob,
+                workflowConfig,
+                workflowHandler
+            });
+            return {
+                id: job.id,
+                result
+            };
+        } else {
+            const result = await runJSONJob({
+                job,
+                req: jobReq,
+                updateJob,
+                workflowConfig,
+                workflowHandler
+            });
+            return {
+                id: job.id,
+                result
+            };
+        }
+    });
+    const resultsArray = await Promise.all(jobPromises);
+    const resultsObject = resultsArray.reduce((acc, cur)=>{
+        if (cur !== null) {
+            // Check if there's a valid result to include
+            acc[cur.id] = cur.result;
+        }
+        return acc;
+    }, {});
+    let remainingJobsFromQueried = 0;
+    for(const jobID in resultsObject){
+        const jobResult = resultsObject[jobID];
+        if (jobResult.status === 'error') {
+            remainingJobsFromQueried++ // Can be retried
+            ;
+        }
+    }
+    return {
+        jobStatus: resultsObject,
+        remainingJobsFromQueried
+    };
+};
+
+//# sourceMappingURL=index.js.map

package/dist/queues/operations/runJobs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/operations/runJobs/index.ts"],"sourcesContent":["import type { PaginatedDocs } from '../../../database/types.js'\nimport type { PayloadRequest, Where } from '../../../types/index.js'\nimport type { WorkflowJSON } from '../../config/types/workflowJSONTypes.js'\nimport type {\n  BaseJob,\n  WorkflowConfig,\n  WorkflowHandler,\n  WorkflowTypes,\n} from '../../config/types/workflowTypes.js'\nimport type { RunJobResult } from './runJob/index.js'\n\nimport { Forbidden } from '../../../errors/Forbidden.js'\nimport isolateObjectProperty from '../../../utilities/isolateObjectProperty.js'\nimport { getUpdateJobFunction } from './runJob/getUpdateJobFunction.js'\nimport { importHandlerPath } from './runJob/importHandlerPath.js'\nimport { runJob } from './runJob/index.js'\nimport { runJSONJob } from './runJSONJob/index.js'\n\nexport type RunJobsArgs = {\n  limit?: number\n  overrideAccess?: boolean\n  queue?: string\n  req: PayloadRequest\n}\n\nexport type RunJobsResult = {\n  jobStatus?: Record<string, RunJobResult>\n  /**\n   * If this is false, there for sure are no jobs remaining, regardless of the limit\n   */\n  noJobsRemaining?: boolean\n  /**\n   * Out of the jobs that were queried & processed (within the set limit), how many are remaining and retryable?\n   */\n  remainingJobsFromQueried: number\n}\n\nexport const runJobs = async ({\n  limit = 10,\n  overrideAccess,\n  queue,\n  req,\n}: RunJobsArgs): Promise<RunJobsResult> => {\n  if (!overrideAccess) {\n    const hasAccess = await req.payload.config.jobs.access.run({ req })\n    if (!hasAccess) {\n      throw new Forbidden(req.t)\n    }\n  }\n  const where: Where = {\n    and: [\n      {\n        completedAt: {\n          exists: false,\n        },\n      },\n      {\n        hasError: {\n          not_equals: true,\n        },\n      },\n      {\n        processing: {\n          equals: false,\n        },\n      },\n      {\n        or: [\n          {\n            waitUntil: {\n              exists: false,\n            },\n          },\n          {\n            waitUntil: {\n              less_than: new Date().toISOString(),\n            },\n          },\n        ],\n      },\n    ],\n  }\n\n  if (queue) {\n    where.and.push({\n      queue: {\n        equals: queue,\n      },\n    })\n  }\n\n  // Find all jobs and ensure we set job to processing: true as early as possible to reduce the chance of\n  // the same job being picked up by another worker\n  const jobsQuery = (await req.payload.update({\n    collection: 'payload-jobs',\n    data: {\n      processing: true,\n      seenByWorker: true,\n    },\n    depth: req.payload.config.jobs.depth,\n    disableTransaction: true,\n    limit,\n    showHiddenFields: true,\n    where,\n  })) as unknown as PaginatedDocs<BaseJob>\n\n  /**\n   * Just for logging purposes, we want to know how many jobs are new and how many are existing (= already been tried).\n   * This is only for logs - in the end we still want to run all jobs, regardless of whether they are new or existing.\n   */\n  const { newJobs } = jobsQuery.docs.reduce(\n    (acc, job) => {\n      if (job.totalTried > 0) {\n        acc.existingJobs.push(job)\n      } else {\n        acc.newJobs.push(job)\n      }\n      return acc\n    },\n    { existingJobs: [], newJobs: [] },\n  )\n\n  if (!jobsQuery.docs.length) {\n    return {\n      noJobsRemaining: true,\n      remainingJobsFromQueried: 0,\n    }\n  }\n\n  if (jobsQuery?.docs?.length) {\n    req.payload.logger.info(`Running ${jobsQuery.docs.length} jobs.`)\n  }\n\n  const jobPromises = jobsQuery.docs.map(async (job) => {\n    if (!job.workflowSlug && !job.taskSlug) {\n      throw new Error('Job must have either a workflowSlug or a taskSlug')\n    }\n    const jobReq = isolateObjectProperty(req, 'transactionID')\n\n    const workflowConfig: WorkflowConfig<WorkflowTypes> = job.workflowSlug\n      ? req.payload.config.jobs?.workflows.find(({ slug }) => slug === job.workflowSlug)\n      : {\n          slug: 'singleTask',\n          handler: async ({ job, tasks }) => {\n            await tasks[job.taskSlug as string]('1', {\n              input: job.input,\n            })\n          },\n        }\n\n    if (!workflowConfig) {\n      return null // Skip jobs with no workflow configuration\n    }\n\n    const updateJob = getUpdateJobFunction(job, jobReq)\n\n    // the runner will either be passed to the config\n    // OR it will be a path, which we will need to import via eval to avoid\n    // Next.js compiler dynamic import expression errors\n    let workflowHandler: WorkflowHandler<WorkflowTypes> | WorkflowJSON<WorkflowTypes>\n\n    if (\n      typeof workflowConfig.handler === 'function' ||\n      (typeof workflowConfig.handler === 'object' && Array.isArray(workflowConfig.handler))\n    ) {\n      workflowHandler = workflowConfig.handler\n    } else {\n      workflowHandler = await importHandlerPath<typeof workflowHandler>(workflowConfig.handler)\n\n      if (!workflowHandler) {\n        const errorMessage = `Can't find runner while importing with the path ${workflowConfig.handler} in job type ${job.workflowSlug}.`\n        req.payload.logger.error(errorMessage)\n\n        await updateJob({\n          error: {\n            error: errorMessage,\n          },\n          hasError: true,\n          processing: false,\n        })\n\n        return\n      }\n    }\n\n    if (typeof workflowHandler === 'function') {\n      const result = await runJob({\n        job,\n        req: jobReq,\n        updateJob,\n        workflowConfig,\n        workflowHandler,\n      })\n      return { id: job.id, result }\n    } else {\n      const result = await runJSONJob({\n        job,\n        req: jobReq,\n        updateJob,\n        workflowConfig,\n        workflowHandler,\n      })\n      return { id: job.id, result }\n    }\n  })\n\n  const resultsArray = await Promise.all(jobPromises)\n  const resultsObject: RunJobsResult['jobStatus'] = resultsArray.reduce((acc, cur) => {\n    if (cur !== null) {\n      // Check if there's a valid result to include\n      acc[cur.id] = cur.result\n    }\n    return acc\n  }, {})\n\n  let remainingJobsFromQueried = 0\n  for (const jobID in resultsObject) {\n    const jobResult = resultsObject[jobID]\n    if (jobResult.status === 'error') {\n      remainingJobsFromQueried++ // Can be retried\n    }\n  }\n\n  return {\n    jobStatus: resultsObject,\n    remainingJobsFromQueried,\n  }\n}\n"],"names":["Forbidden","isolateObjectProperty","getUpdateJobFunction","importHandlerPath","runJob","runJSONJob","runJobs","limit","overrideAccess","queue","req","hasAccess","payload","config","jobs","access","run","t","where","and","completedAt","exists","hasError","not_equals","processing","equals","or","waitUntil","less_than","Date","toISOString","push","jobsQuery","update","collection","data","seenByWorker","depth","disableTransaction","showHiddenFields","newJobs","docs","reduce","acc","job","totalTried","existingJobs","length","noJobsRemaining","remainingJobsFromQueried","logger","info","jobPromises","map","workflowSlug","taskSlug","Error","jobReq","workflowConfig","workflows","find","slug","handler","tasks","input","updateJob","workflowHandler","Array","isArray","errorMessage","error","result","id","resultsArray","Promise","all","resultsObject","cur","jobID","jobResult","status","jobStatus"],"mappings":"AAWA,SAASA,SAAS,QAAQ,+BAA8B;AACxD,OAAOC,2BAA2B,8CAA6C;AAC/E,SAASC,oBAAoB,QAAQ,mCAAkC;AACvE,SAASC,iBAAiB,QAAQ,gCAA+B;AACjE,SAASC,MAAM,QAAQ,oBAAmB;AAC1C,SAASC,UAAU,QAAQ,wBAAuB;AAqBlD,OAAO,MAAMC,UAAU,OAAO,EAC5BC,QAAQ,EAAE,EACVC,cAAc,EACdC,KAAK,EACLC,GAAG,EACS;IACZ,IAAI,CAACF,gBAAgB;QACnB,MAAMG,YAAY,MAAMD,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI,CAACC,MAAM,CAACC,GAAG,CAAC;YAAEN;QAAI;QACjE,IAAI,CAACC,WAAW;YACd,MAAM,IAAIX,UAAUU,IAAIO,CAAC;QAC3B;IACF;IACA,MAAMC,QAAe;QACnBC,KAAK;YACH;gBACEC,aAAa;oBACXC,QAAQ;gBACV;YACF;YACA;gBACEC,UAAU;oBACRC,YAAY;gBACd;YACF;YACA;gBACEC,YAAY;oBACVC,QAAQ;gBACV;YACF;YACA;gBACEC,IAAI;oBACF;wBACEC,WAAW;4BACTN,QAAQ;wBACV;oBACF;oBACA;wBACEM,WAAW;4BACTC,WAAW,IAAIC,OAAOC,WAAW;wBACnC;oBACF;iBACD;YACH;SACD;IACH;IAEA,IAAIrB,OAAO;QACTS,MAAMC,GAAG,CAACY,IAAI,CAAC;YACbtB,OAAO;gBACLgB,QAAQhB;YACV;QACF;IACF;IAEA,uGAAuG;IACvG,iDAAiD;IACjD,MAAMuB,YAAa,MAAMtB,IAAIE,OAAO,CAACqB,MAAM,CAAC;QAC1CC,YAAY;QACZC,MAAM;YACJX,YAAY;YACZY,cAAc;QAChB;QACAC,OAAO3B,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI,CAACuB,KAAK;QACpCC,oBAAoB;QACpB/B;QACAgC,kBAAkB;QAClBrB;IACF;IAEA;;;GAGC,GACD,MAAM,EAAEsB,OAAO,EAAE,GAAGR,UAAUS,IAAI,CAACC,MAAM,CACvC,CAACC,KAAKC;QACJ,IAAIA,IAAIC,UAAU,GAAG,GAAG;YACtBF,IAAIG,YAAY,CAACf,IAAI,CAACa;QACxB,OAAO;YACLD,IAAIH,OAAO,CAACT,IAAI,CAACa;QACnB;QACA,OAAOD;IACT,GACA;QAAEG,cAAc,EAAE;QAAEN,SAAS,EAAE;IAAC;IAGlC,IAAI,CAACR,UAAUS,IAAI,CAACM,MAAM,EAAE;QAC1B,OAAO;YACLC,iBAAiB;YACjBC,0BAA0B;QAC5B;IACF;IAEA,IAAIjB,WAAWS,MAAMM,QAAQ;QAC3BrC,IAAIE,OAAO,CAACsC,MAAM,CAACC,IAAI,CAAC,CAAC,QAAQ,EAAEnB,UAAUS,IAAI,CAACM,MAAM,CAAC,MAAM,CAAC;IAClE;IAEA,MAAMK,cAAcpB,UAAUS,IAAI,CAACY,GAAG,CAAC,OAAOT;QAC5C,IAAI,CAACA,IAAIU,YAAY,IAAI,CAACV,IAAIW,QAAQ,EAAE;YACtC,MAAM,IAAIC,MAAM;QAClB;QACA,MAAMC,SAASxD,sBAAsBS,KAAK;QAE1C,MAAMgD,iBAAgDd,IAAIU,YAAY,GAClE5C,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI,EAAE6C,UAAUC,KAAK,CAAC,EAAEC,IAAI,EAAE,GAAKA,SAASjB,IAAIU,YAAY,IAC/E;YACEO,MAAM;YACNC,SAAS,OAAO,EAAElB,GAAG,EAAEmB,KAAK,EAAE;gBAC5B,MAAMA,KAAK,CAACnB,IAAIW,QAAQ,CAAW,CAAC,KAAK;oBACvCS,OAAOpB,IAAIoB,KAAK;gBAClB;YACF;QACF;QAEJ,IAAI,CAACN,gBAAgB;YACnB,OAAO,KAAK,2CAA2C;;QACzD;QAEA,MAAMO,YAAY/D,qBAAqB0C,KAAKa;QAE5C,iDAAiD;QACjD,uEAAuE;QACvE,oDAAoD;QACpD,IAAIS;QAEJ,IACE,OAAOR,eAAeI,OAAO,KAAK,cACjC,OAAOJ,eAAeI,OAAO,KAAK,YAAYK,MAAMC,OAAO,CAACV,eAAeI,OAAO,GACnF;YACAI,kBAAkBR,eAAeI,OAAO;QAC1C,OAAO;YACLI,kBAAkB,MAAM/D,kBAA0CuD,eAAeI,OAAO;YAExF,IAAI,CAACI,iBAAiB;gBACpB,MAAMG,eAAe,CAAC,gDAAgD,EAAEX,eAAeI,OAAO,CAAC,aAAa,EAAElB,IAAIU,YAAY,CAAC,CAAC,CAAC;gBACjI5C,IAAIE,OAAO,CAACsC,MAAM,CAACoB,KAAK,CAACD;gBAEzB,MAAMJ,UAAU;oBACdK,OAAO;wBACLA,OAAOD;oBACT;oBACA/C,UAAU;oBACVE,YAAY;gBACd;gBAEA;YACF;QACF;QAEA,IAAI,OAAO0C,oBAAoB,YAAY;YACzC,MAAMK,SAAS,MAAMnE,OAAO;gBAC1BwC;gBACAlC,KAAK+C;gBACLQ;gBACAP;gBACAQ;YACF;YACA,OAAO;gBAAEM,IAAI5B,IAAI4B,EAAE;gBAAED;YAAO;QAC9B,OAAO;YACL,MAAMA,SAAS,MAAMlE,WAAW;gBAC9BuC;gBACAlC,KAAK+C;gBACLQ;gBACAP;gBACAQ;YACF;YACA,OAAO;gBAAEM,IAAI5B,IAAI4B,EAAE;gBAAED;YAAO;QAC9B;IACF;IAEA,MAAME,eAAe,MAAMC,QAAQC,GAAG,CAACvB;IACvC,MAAMwB,gBAA4CH,aAAa/B,MAAM,CAAC,CAACC,KAAKkC;QAC1E,IAAIA,QAAQ,MAAM;YAChB,6CAA6C;YAC7ClC,GAAG,CAACkC,IAAIL,EAAE,CAAC,GAAGK,IAAIN,MAAM;QAC1B;QACA,OAAO5B;IACT,GAAG,CAAC;IAEJ,IAAIM,2BAA2B;IAC/B,IAAK,MAAM6B,SAASF,cAAe;QACjC,MAAMG,YAAYH,aAAa,CAACE,MAAM;QACtC,IAAIC,UAAUC,MAAM,KAAK,SAAS;YAChC/B,2BAA2B,iBAAiB;;QAC9C;IACF;IAEA,OAAO;QACLgC,WAAWL;QACX3B;IACF;AACF,EAAC"}

package/dist/queues/operations/runJobs/runJSONJob/index.d.ts

@@ -0,0 +1,18 @@
+import type { PayloadRequest } from '../../../../types/index.js';
+import type { WorkflowJSON } from '../../../config/types/workflowJSONTypes.js';
+import type { BaseJob, WorkflowConfig, WorkflowTypes } from '../../../config/types/workflowTypes.js';
+import type { UpdateJobFunction } from '../runJob/getUpdateJobFunction.js';
+import type { JobRunStatus } from '../runJob/index.js';
+type Args = {
+    job: BaseJob;
+    req: PayloadRequest;
+    updateJob: UpdateJobFunction;
+    workflowConfig: WorkflowConfig<WorkflowTypes>;
+    workflowHandler: WorkflowJSON<WorkflowTypes>;
+};
+export type RunJSONJobResult = {
+    status: JobRunStatus;
+};
+export declare const runJSONJob: ({ job, req, updateJob, workflowConfig, workflowHandler, }: Args) => Promise<RunJSONJobResult>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/queues/operations/runJobs/runJSONJob/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/queues/operations/runJobs/runJSONJob/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,KAAK,EAAE,YAAY,EAAgB,MAAM,4CAA4C,CAAA;AAC5F,OAAO,KAAK,EACV,OAAO,EAEP,cAAc,EACd,aAAa,EACd,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AAC1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,KAAK,IAAI,GAAG;IACV,GAAG,EAAE,OAAO,CAAA;IACZ,GAAG,EAAE,cAAc,CAAA;IACnB,SAAS,EAAE,iBAAiB,CAAA;IAC5B,cAAc,EAAE,cAAc,CAAC,aAAa,CAAC,CAAA;IAC7C,eAAe,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,YAAY,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,UAAU,8DAMpB,IAAI,KAAG,OAAO,CAAC,gBAAgB,CA8HjC,CAAA"}

package/dist/queues/operations/runJobs/runJSONJob/index.js

@@ -0,0 +1,125 @@
+import { getRunTaskFunction } from '../runJob/getRunTaskFunction.js';
+import { handleWorkflowError } from '../runJob/handleWorkflowError.js';
+export const runJSONJob = async ({ job, req, updateJob, workflowConfig, workflowHandler })=>{
+    // Object so that we can pass contents by reference, not value.
+    // We want any mutations to be reflected in here.
+    const state = {
+        reachedMaxRetries: false
+    };
+    const stepsToRun = [];
+    for (const step of workflowHandler){
+        if ('task' in step) {
+            if (job?.taskStatus?.[step.task]?.[step.id]?.complete) {
+                continue;
+            }
+        } else {
+            if (job?.taskStatus?.['inline']?.[step.id]?.complete) {
+                continue;
+            }
+        }
+        if (step.condition && !step.condition({
+            job: job
+        })) {
+            continue;
+        }
+        stepsToRun.push(step);
+    }
+    const tasks = getRunTaskFunction(state, job, workflowConfig, req, false, updateJob);
+    const inlineTask = getRunTaskFunction(state, job, workflowConfig, req, true, updateJob);
+    // Run the job
+    let hasFinalError = false;
+    let error;
+    try {
+        await Promise.all(stepsToRun.map(async (step)=>{
+            if ('task' in step) {
+                await tasks[step.task](step.id, {
+                    input: step.input ? step.input({
+                        job: job
+                    }) : {},
+                    retries: step.retries
+                });
+            } else {
+                await inlineTask(step.id, {
+                    retries: step.retries,
+                    task: step.inlineTask
+                });
+            }
+        }));
+    } catch (err) {
+        const errorResult = handleWorkflowError({
+            error: err,
+            job,
+            req,
+            state,
+            workflowConfig
+        });
+        error = err;
+        hasFinalError = errorResult.hasFinalError;
+    }
+    // Check if workflow has completed
+    let workflowCompleted = false;
+    for (const [slug, map] of Object.entries(job.taskStatus)){
+        for (const [id, taskStatus] of Object.entries(map)){
+            if (taskStatus.complete) {
+                const step = workflowHandler.find((step)=>{
+                    if ('task' in step) {
+                        return step.task === slug && step.id === id;
+                    } else {
+                        return step.id === id && slug === 'inline';
+                    }
+                });
+                if (step.completesJob) {
+                    workflowCompleted = true;
+                    break;
+                }
+            }
+        }
+    }
+    if (workflowCompleted) {
+        if (error) {
+            // Tasks update the job if they error - but in case there is an unhandled error (e.g. in the workflow itself, not in a task)
+            // we need to ensure the job is updated to reflect the error
+            await updateJob({
+                completedAt: new Date().toISOString(),
+                error: hasFinalError ? error : undefined,
+                hasError: hasFinalError,
+                processing: false,
+                totalTried: (job.totalTried ?? 0) + 1
+            });
+        } else {
+            await updateJob({
+                completedAt: new Date().toISOString(),
+                processing: false,
+                totalTried: (job.totalTried ?? 0) + 1
+            });
+        }
+        return {
+            status: 'success'
+        };
+    } else {
+        if (error) {
+            // Tasks update the job if they error - but in case there is an unhandled error (e.g. in the workflow itself, not in a task)
+            // we need to ensure the job is updated to reflect the error
+            await updateJob({
+                error: hasFinalError ? error : undefined,
+                hasError: hasFinalError,
+                processing: false,
+                totalTried: (job.totalTried ?? 0) + 1
+            });
+            return {
+                status: hasFinalError ? 'error-reached-max-retries' : 'error'
+            };
+        } else {
+            // Retry the job - no need to bump processing or totalTried as this does not count as a retry. A condition of a different task might have just opened up!
+            return await runJSONJob({
+                job,
+                req,
+                updateJob,
+                workflowConfig,
+                workflowHandler
+            });
+        }
+    }
+};
+
+//# sourceMappingURL=index.js.map

package/dist/queues/operations/runJobs/runJSONJob/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/queues/operations/runJobs/runJSONJob/index.ts"],"sourcesContent":["import type { PayloadRequest } from '../../../../types/index.js'\nimport type { WorkflowJSON, WorkflowStep } from '../../../config/types/workflowJSONTypes.js'\nimport type {\n  BaseJob,\n  RunningJob,\n  WorkflowConfig,\n  WorkflowTypes,\n} from '../../../config/types/workflowTypes.js'\nimport type { UpdateJobFunction } from '../runJob/getUpdateJobFunction.js'\nimport type { JobRunStatus } from '../runJob/index.js'\n\nimport { getRunTaskFunction, type RunTaskFunctionState } from '../runJob/getRunTaskFunction.js'\nimport { handleWorkflowError } from '../runJob/handleWorkflowError.js'\n\ntype Args = {\n  job: BaseJob\n  req: PayloadRequest\n  updateJob: UpdateJobFunction\n  workflowConfig: WorkflowConfig<WorkflowTypes>\n  workflowHandler: WorkflowJSON<WorkflowTypes>\n}\n\nexport type RunJSONJobResult = {\n  status: JobRunStatus\n}\n\nexport const runJSONJob = async ({\n  job,\n  req,\n  updateJob,\n  workflowConfig,\n  workflowHandler,\n}: Args): Promise<RunJSONJobResult> => {\n  // Object so that we can pass contents by reference, not value.\n  // We want any mutations to be reflected in here.\n  const state: RunTaskFunctionState = {\n    reachedMaxRetries: false,\n  }\n\n  const stepsToRun: WorkflowStep<string, string>[] = []\n\n  for (const step of workflowHandler) {\n    if ('task' in step) {\n      if (job?.taskStatus?.[step.task]?.[step.id]?.complete) {\n        continue\n      }\n    } else {\n      if (job?.taskStatus?.['inline']?.[step.id]?.complete) {\n        continue\n      }\n    }\n    if (step.condition && !step.condition({ job: job as RunningJob<any> })) {\n      // TODO: Improve RunningJob type see todo below\n      continue\n    }\n    stepsToRun.push(step)\n  }\n\n  const tasks = getRunTaskFunction(state, job, workflowConfig, req, false, updateJob)\n  const inlineTask = getRunTaskFunction(state, job, workflowConfig, req, true, updateJob)\n\n  // Run the job\n  let hasFinalError = false\n  let error: Error | undefined\n  try {\n    await Promise.all(\n      stepsToRun.map(async (step) => {\n        if ('task' in step) {\n          await tasks[step.task](step.id, {\n            input: step.input ? step.input({ job: job as RunningJob<any> }) : {}, // TODO: Type better. We should use RunningJob anywhere and make TypedCollection['payload-jobs'] be BaseJob if type not generated\n            retries: step.retries,\n          })\n        } else {\n          await inlineTask(step.id, {\n            retries: step.retries,\n            task: step.inlineTask as any, // TODO: Fix type\n          })\n        }\n      }),\n    )\n  } catch (err) {\n    const errorResult = handleWorkflowError({\n      error: err,\n      job,\n      req,\n      state,\n      workflowConfig,\n    })\n    error = err\n    hasFinalError = errorResult.hasFinalError\n  }\n\n  // Check if workflow has completed\n  let workflowCompleted = false\n  for (const [slug, map] of Object.entries(job.taskStatus)) {\n    for (const [id, taskStatus] of Object.entries(map)) {\n      if (taskStatus.complete) {\n        const step = workflowHandler.find((step) => {\n          if ('task' in step) {\n            return step.task === slug && step.id === id\n          } else {\n            return step.id === id && slug === 'inline'\n          }\n        })\n        if (step.completesJob) {\n          workflowCompleted = true\n          break\n        }\n      }\n    }\n  }\n\n  if (workflowCompleted) {\n    if (error) {\n      // Tasks update the job if they error - but in case there is an unhandled error (e.g. in the workflow itself, not in a task)\n      // we need to ensure the job is updated to reflect the error\n      await updateJob({\n        completedAt: new Date().toISOString(),\n        error: hasFinalError ? error : undefined,\n        hasError: hasFinalError, // If reached max retries => final error. If hasError is true this job will not be retried\n        processing: false,\n        totalTried: (job.totalTried ?? 0) + 1,\n      })\n    } else {\n      await updateJob({\n        completedAt: new Date().toISOString(),\n        processing: false,\n        totalTried: (job.totalTried ?? 0) + 1,\n      })\n    }\n\n    return {\n      status: 'success',\n    }\n  } else {\n    if (error) {\n      // Tasks update the job if they error - but in case there is an unhandled error (e.g. in the workflow itself, not in a task)\n      // we need to ensure the job is updated to reflect the error\n      await updateJob({\n        error: hasFinalError ? error : undefined,\n        hasError: hasFinalError, // If reached max retries => final error. If hasError is true this job will not be retried\n        processing: false,\n        totalTried: (job.totalTried ?? 0) + 1,\n      })\n      return {\n        status: hasFinalError ? 'error-reached-max-retries' : 'error',\n      }\n    } else {\n      // Retry the job - no need to bump processing or totalTried as this does not count as a retry. A condition of a different task might have just opened up!\n      return await runJSONJob({\n        job,\n        req,\n        updateJob,\n        workflowConfig,\n        workflowHandler,\n      })\n    }\n  }\n}\n"],"names":["getRunTaskFunction","handleWorkflowError","runJSONJob","job","req","updateJob","workflowConfig","workflowHandler","state","reachedMaxRetries","stepsToRun","step","taskStatus","task","id","complete","condition","push","tasks","inlineTask","hasFinalError","error","Promise","all","map","input","retries","err","errorResult","workflowCompleted","slug","Object","entries","find","completesJob","completedAt","Date","toISOString","undefined","hasError","processing","totalTried","status"],"mappings":"AAWA,SAASA,kBAAkB,QAAmC,kCAAiC;AAC/F,SAASC,mBAAmB,QAAQ,mCAAkC;AActE,OAAO,MAAMC,aAAa,OAAO,EAC/BC,GAAG,EACHC,GAAG,EACHC,SAAS,EACTC,cAAc,EACdC,eAAe,EACV;IACL,+DAA+D;IAC/D,iDAAiD;IACjD,MAAMC,QAA8B;QAClCC,mBAAmB;IACrB;IAEA,MAAMC,aAA6C,EAAE;IAErD,KAAK,MAAMC,QAAQJ,gBAAiB;QAClC,IAAI,UAAUI,MAAM;YAClB,IAAIR,KAAKS,YAAY,CAACD,KAAKE,IAAI,CAAC,EAAE,CAACF,KAAKG,EAAE,CAAC,EAAEC,UAAU;gBACrD;YACF;QACF,OAAO;YACL,IAAIZ,KAAKS,YAAY,CAAC,SAAS,EAAE,CAACD,KAAKG,EAAE,CAAC,EAAEC,UAAU;gBACpD;YACF;QACF;QACA,IAAIJ,KAAKK,SAAS,IAAI,CAACL,KAAKK,SAAS,CAAC;YAAEb,KAAKA;QAAuB,IAAI;YAEtE;QACF;QACAO,WAAWO,IAAI,CAACN;IAClB;IAEA,MAAMO,QAAQlB,mBAAmBQ,OAAOL,KAAKG,gBAAgBF,KAAK,OAAOC;IACzE,MAAMc,aAAanB,mBAAmBQ,OAAOL,KAAKG,gBAAgBF,KAAK,MAAMC;IAE7E,cAAc;IACd,IAAIe,gBAAgB;IACpB,IAAIC;IACJ,IAAI;QACF,MAAMC,QAAQC,GAAG,CACfb,WAAWc,GAAG,CAAC,OAAOb;YACpB,IAAI,UAAUA,MAAM;gBAClB,MAAMO,KAAK,CAACP,KAAKE,IAAI,CAAC,CAACF,KAAKG,EAAE,EAAE;oBAC9BW,OAAOd,KAAKc,KAAK,GAAGd,KAAKc,KAAK,CAAC;wBAAEtB,KAAKA;oBAAuB,KAAK,CAAC;oBACnEuB,SAASf,KAAKe,OAAO;gBACvB;YACF,OAAO;gBACL,MAAMP,WAAWR,KAAKG,EAAE,EAAE;oBACxBY,SAASf,KAAKe,OAAO;oBACrBb,MAAMF,KAAKQ,UAAU;gBACvB;YACF;QACF;IAEJ,EAAE,OAAOQ,KAAK;QACZ,MAAMC,cAAc3B,oBAAoB;YACtCoB,OAAOM;YACPxB;YACAC;YACAI;YACAF;QACF;QACAe,QAAQM;QACRP,gBAAgBQ,YAAYR,aAAa;IAC3C;IAEA,kCAAkC;IAClC,IAAIS,oBAAoB;IACxB,KAAK,MAAM,CAACC,MAAMN,IAAI,IAAIO,OAAOC,OAAO,CAAC7B,IAAIS,UAAU,EAAG;QACxD,KAAK,MAAM,CAACE,IAAIF,WAAW,IAAImB,OAAOC,OAAO,CAACR,KAAM;YAClD,IAAIZ,WAAWG,QAAQ,EAAE;gBACvB,MAAMJ,OAAOJ,gBAAgB0B,IAAI,CAAC,CAACtB;oBACjC,IAAI,UAAUA,MAAM;wBAClB,OAAOA,KAAKE,IAAI,KAAKiB,QAAQnB,KAAKG,EAAE,KAAKA;oBAC3C,OAAO;wBACL,OAAOH,KAAKG,EAAE,KAAKA,MAAMgB,SAAS;oBACpC;gBACF;gBACA,IAAInB,KAAKuB,YAAY,EAAE;oBACrBL,oBAAoB;oBACpB;gBACF;YACF;QACF;IACF;IAEA,IAAIA,mBAAmB;QACrB,IAAIR,OAAO;YACT,4HAA4H;YAC5H,4DAA4D;YAC5D,MAAMhB,UAAU;gBACd8B,aAAa,IAAIC,OAAOC,WAAW;gBACnChB,OAAOD,gBAAgBC,QAAQiB;gBAC/BC,UAAUnB;gBACVoB,YAAY;gBACZC,YAAY,AAACtC,CAAAA,IAAIsC,UAAU,IAAI,CAAA,IAAK;YACtC;QACF,OAAO;YACL,MAAMpC,UAAU;gBACd8B,aAAa,IAAIC,OAAOC,WAAW;gBACnCG,YAAY;gBACZC,YAAY,AAACtC,CAAAA,IAAIsC,UAAU,IAAI,CAAA,IAAK;YACtC;QACF;QAEA,OAAO;YACLC,QAAQ;QACV;IACF,OAAO;QACL,IAAIrB,OAAO;YACT,4HAA4H;YAC5H,4DAA4D;YAC5D,MAAMhB,UAAU;gBACdgB,OAAOD,gBAAgBC,QAAQiB;gBAC/BC,UAAUnB;gBACVoB,YAAY;gBACZC,YAAY,AAACtC,CAAAA,IAAIsC,UAAU,IAAI,CAAA,IAAK;YACtC;YACA,OAAO;gBACLC,QAAQtB,gBAAgB,8BAA8B;YACxD;QACF,OAAO;YACL,yJAAyJ;YACzJ,OAAO,MAAMlB,WAAW;gBACtBC;gBACAC;gBACAC;gBACAC;gBACAC;YACF;QACF;IACF;AACF,EAAC"}

package/dist/queues/operations/runJobs/runJob/calculateBackoffWaitUntil.d.ts

@@ -0,0 +1,6 @@
+import type { RetryConfig } from '../../../config/types/taskTypes.js';
+export declare function calculateBackoffWaitUntil({ retriesConfig, totalTried, }: {
+    retriesConfig: number | RetryConfig;
+    totalTried: number;
+}): Date;
+//# sourceMappingURL=calculateBackoffWaitUntil.d.ts.map

package/dist/queues/operations/runJobs/runJob/calculateBackoffWaitUntil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateBackoffWaitUntil.d.ts","sourceRoot":"","sources":["../../../../../src/queues/operations/runJobs/runJob/calculateBackoffWaitUntil.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAErE,wBAAgB,yBAAyB,CAAC,EACxC,aAAa,EACb,UAAU,GACX,EAAE;IACD,aAAa,EAAE,MAAM,GAAG,WAAW,CAAA;IACnC,UAAU,EAAE,MAAM,CAAA;CACnB,GAAG,IAAI,CA2BP"}