payload 3.0.0-beta.120 → 3.0.0-beta.121

package/dist/queues/config/jobsCollection.js

@@ -0,0 +1,211 @@
+import { runJobsEndpoint } from '../restEndpointRun.js';
+import { getJobTaskStatus } from '../utilities/getJobTaskStatus.js';
+export const getDefaultJobsCollection = (config)=>{
+    if (!Array.isArray(config?.jobs?.workflows)) {
+        return null;
+    }
+    const workflowSlugs = new Set();
+    const taskSlugs = new Set([
+        'inline'
+    ]);
+    const queueNames = new Set([
+        'default'
+    ]);
+    config.jobs.workflows.forEach((workflow)=>{
+        workflowSlugs.add(workflow.slug);
+        if (workflow.queue) {
+            queueNames.add(workflow.queue);
+        }
+    });
+    config.jobs.tasks.forEach((task)=>{
+        if (workflowSlugs.has(task.slug)) {
+            throw new Error(`Task slug "${task.slug}" is already used by a workflow. No tasks are allowed to have the same slug as a workflow.`);
+        }
+        taskSlugs.add(task.slug);
+    });
+    const jobsCollection = {
+        slug: 'payload-jobs',
+        admin: {
+            group: 'System',
+            hidden: true
+        },
+        endpoints: [
+            runJobsEndpoint
+        ],
+        fields: [
+            {
+                name: 'input',
+                type: 'json',
+                admin: {
+                    description: 'Input data provided to the job'
+                }
+            },
+            {
+                name: 'taskStatus',
+                type: 'json',
+                virtual: true
+            },
+            {
+                type: 'tabs',
+                tabs: [
+                    {
+                        fields: [
+                            {
+                                name: 'completedAt',
+                                type: 'date',
+                                index: true
+                            },
+                            {
+                                name: 'totalTried',
+                                type: 'number',
+                                defaultValue: 0,
+                                index: true
+                            },
+                            {
+                                name: 'hasError',
+                                type: 'checkbox',
+                                admin: {
+                                    description: 'If hasError is true this job will not be retried'
+                                },
+                                defaultValue: false,
+                                index: true
+                            },
+                            {
+                                name: 'error',
+                                type: 'json',
+                                admin: {
+                                    condition: (data)=>data.hasError,
+                                    description: 'If hasError is true, this is the error that caused it'
+                                }
+                            },
+                            {
+                                name: 'log',
+                                type: 'array',
+                                admin: {
+                                    description: 'Task execution log'
+                                },
+                                fields: [
+                                    {
+                                        name: 'executedAt',
+                                        type: 'date',
+                                        required: true
+                                    },
+                                    {
+                                        name: 'completedAt',
+                                        type: 'date',
+                                        required: true
+                                    },
+                                    {
+                                        name: 'taskSlug',
+                                        type: 'select',
+                                        options: [
+                                            ...taskSlugs
+                                        ],
+                                        required: true
+                                    },
+                                    {
+                                        name: 'taskID',
+                                        type: 'text',
+                                        required: true
+                                    },
+                                    {
+                                        name: 'input',
+                                        type: 'json'
+                                    },
+                                    {
+                                        name: 'output',
+                                        type: 'json'
+                                    },
+                                    {
+                                        name: 'state',
+                                        type: 'radio',
+                                        options: [
+                                            'failed',
+                                            'succeeded'
+                                        ],
+                                        required: true
+                                    },
+                                    {
+                                        name: 'error',
+                                        type: 'json',
+                                        admin: {
+                                            condition: (_, data)=>data.state === 'failed'
+                                        },
+                                        required: true
+                                    }
+                                ]
+                            }
+                        ],
+                        label: 'Status'
+                    }
+                ]
+            },
+            {
+                name: 'workflowSlug',
+                type: 'select',
+                admin: {
+                    position: 'sidebar'
+                },
+                index: true,
+                options: [
+                    ...workflowSlugs
+                ],
+                required: false
+            },
+            {
+                name: 'taskSlug',
+                type: 'select',
+                admin: {
+                    position: 'sidebar'
+                },
+                index: true,
+                options: [
+                    ...taskSlugs
+                ],
+                required: false
+            },
+            {
+                name: 'queue',
+                type: 'select',
+                admin: {
+                    position: 'sidebar'
+                },
+                defaultValue: 'default',
+                index: true,
+                options: [
+                    ...queueNames
+                ]
+            },
+            {
+                name: 'waitUntil',
+                type: 'date',
+                index: true
+            },
+            {
+                name: 'processing',
+                type: 'checkbox',
+                admin: {
+                    position: 'sidebar'
+                },
+                defaultValue: false,
+                index: true
+            }
+        ],
+        hooks: {
+            afterRead: [
+                ({ doc, req })=>{
+                    // This hook is used to add the virtual `tasks` field to the document, that is computed from the `log` field
+                    doc.taskStatus = getJobTaskStatus({
+                        jobLog: doc.log,
+                        tasksConfig: req.payload.config.jobs.tasks
+                    });
+                    return doc;
+                }
+            ]
+        },
+        lockDocuments: false
+    };
+    return jobsCollection;
+};
+
+//# sourceMappingURL=jobsCollection.js.map

package/dist/queues/config/jobsCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/queues/config/jobsCollection.ts"],"sourcesContent":["import type { CollectionConfig } from '../../collections/config/types.js'\nimport type { Config } from '../../config/types.js'\n\nimport { runJobsEndpoint } from '../restEndpointRun.js'\nimport { getJobTaskStatus } from '../utilities/getJobTaskStatus.js'\n\nexport const getDefaultJobsCollection: (config: Config) => CollectionConfig | null = (config) => {\n  if (!Array.isArray(config?.jobs?.workflows)) {\n    return null\n  }\n\n  const workflowSlugs: Set<string> = new Set()\n  const taskSlugs: Set<string> = new Set(['inline'])\n\n  const queueNames: Set<string> = new Set(['default'])\n\n  config.jobs.workflows.forEach((workflow) => {\n    workflowSlugs.add(workflow.slug)\n\n    if (workflow.queue) {\n      queueNames.add(workflow.queue)\n    }\n  })\n\n  config.jobs.tasks.forEach((task) => {\n    if (workflowSlugs.has(task.slug)) {\n      throw new Error(\n        `Task slug \"${task.slug}\" is already used by a workflow. No tasks are allowed to have the same slug as a workflow.`,\n      )\n    }\n    taskSlugs.add(task.slug)\n  })\n\n  const jobsCollection: CollectionConfig = {\n    slug: 'payload-jobs',\n    admin: {\n      group: 'System',\n      hidden: true,\n    },\n    endpoints: [runJobsEndpoint],\n    fields: [\n      {\n        name: 'input',\n        type: 'json',\n        admin: {\n          description: 'Input data provided to the job',\n        },\n      },\n      {\n        name: 'taskStatus',\n        type: 'json',\n        virtual: true,\n      },\n      {\n        type: 'tabs',\n        tabs: [\n          {\n            fields: [\n              {\n                name: 'completedAt',\n                type: 'date',\n                index: true,\n              },\n              {\n                name: 'totalTried',\n                type: 'number',\n                defaultValue: 0,\n                index: true,\n              },\n              {\n                name: 'hasError',\n                type: 'checkbox',\n                admin: {\n                  description: 'If hasError is true this job will not be retried',\n                },\n                defaultValue: false,\n                index: true,\n              },\n              {\n                name: 'error',\n                type: 'json',\n                admin: {\n                  condition: (data) => data.hasError,\n                  description: 'If hasError is true, this is the error that caused it',\n                },\n              },\n              {\n                name: 'log',\n                type: 'array',\n                admin: {\n                  description: 'Task execution log',\n                },\n                fields: [\n                  {\n                    name: 'executedAt',\n                    type: 'date',\n                    required: true,\n                  },\n                  {\n                    name: 'completedAt',\n                    type: 'date',\n                    required: true,\n                  },\n                  {\n                    name: 'taskSlug',\n                    type: 'select',\n                    options: [...taskSlugs],\n                    required: true,\n                  },\n                  {\n                    name: 'taskID',\n                    type: 'text',\n                    required: true,\n                  },\n                  {\n                    name: 'input',\n                    type: 'json',\n                  },\n                  {\n                    name: 'output',\n                    type: 'json',\n                  },\n                  {\n                    name: 'state',\n                    type: 'radio',\n                    options: ['failed', 'succeeded'],\n                    required: true,\n                  },\n                  {\n                    name: 'error',\n                    type: 'json',\n                    admin: {\n                      condition: (_, data) => data.state === 'failed',\n                    },\n                    required: true,\n                  },\n                ],\n              },\n            ],\n            label: 'Status',\n          },\n        ],\n      },\n      {\n        name: 'workflowSlug',\n        type: 'select',\n        admin: {\n          position: 'sidebar',\n        },\n        index: true,\n        options: [...workflowSlugs],\n        required: false,\n      },\n      {\n        name: 'taskSlug',\n        type: 'select',\n        admin: {\n          position: 'sidebar',\n        },\n        index: true,\n        options: [...taskSlugs],\n        required: false,\n      },\n      {\n        name: 'queue',\n        type: 'select',\n        admin: {\n          position: 'sidebar',\n        },\n        defaultValue: 'default',\n        index: true,\n        options: [...queueNames],\n      },\n      {\n        name: 'waitUntil',\n        type: 'date',\n        index: true,\n      },\n      {\n        name: 'processing',\n        type: 'checkbox',\n        admin: {\n          position: 'sidebar',\n        },\n        defaultValue: false,\n        index: true,\n      },\n    ],\n    hooks: {\n      afterRead: [\n        ({ doc, req }) => {\n          // This hook is used to add the virtual `tasks` field to the document, that is computed from the `log` field\n\n          doc.taskStatus = getJobTaskStatus({\n            jobLog: doc.log,\n            tasksConfig: req.payload.config.jobs.tasks,\n          })\n\n          return doc\n        },\n      ],\n    },\n    lockDocuments: false,\n  }\n  return jobsCollection\n}\n"],"names":["runJobsEndpoint","getJobTaskStatus","getDefaultJobsCollection","config","Array","isArray","jobs","workflows","workflowSlugs","Set","taskSlugs","queueNames","forEach","workflow","add","slug","queue","tasks","task","has","Error","jobsCollection","admin","group","hidden","endpoints","fields","name","type","description","virtual","tabs","index","defaultValue","condition","data","hasError","required","options","_","state","label","position","hooks","afterRead","doc","req","taskStatus","jobLog","log","tasksConfig","payload","lockDocuments"],"mappings":"AAGA,SAASA,eAAe,QAAQ,wBAAuB;AACvD,SAASC,gBAAgB,QAAQ,mCAAkC;AAEnE,OAAO,MAAMC,2BAAwE,CAACC;IACpF,IAAI,CAACC,MAAMC,OAAO,CAACF,QAAQG,MAAMC,YAAY;QAC3C,OAAO;IACT;IAEA,MAAMC,gBAA6B,IAAIC;IACvC,MAAMC,YAAyB,IAAID,IAAI;QAAC;KAAS;IAEjD,MAAME,aAA0B,IAAIF,IAAI;QAAC;KAAU;IAEnDN,OAAOG,IAAI,CAACC,SAAS,CAACK,OAAO,CAAC,CAACC;QAC7BL,cAAcM,GAAG,CAACD,SAASE,IAAI;QAE/B,IAAIF,SAASG,KAAK,EAAE;YAClBL,WAAWG,GAAG,CAACD,SAASG,KAAK;QAC/B;IACF;IAEAb,OAAOG,IAAI,CAACW,KAAK,CAACL,OAAO,CAAC,CAACM;QACzB,IAAIV,cAAcW,GAAG,CAACD,KAAKH,IAAI,GAAG;YAChC,MAAM,IAAIK,MACR,CAAC,WAAW,EAAEF,KAAKH,IAAI,CAAC,0FAA0F,CAAC;QAEvH;QACAL,UAAUI,GAAG,CAACI,KAAKH,IAAI;IACzB;IAEA,MAAMM,iBAAmC;QACvCN,MAAM;QACNO,OAAO;YACLC,OAAO;YACPC,QAAQ;QACV;QACAC,WAAW;YAACzB;SAAgB;QAC5B0B,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLO,aAAa;gBACf;YACF;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNE,SAAS;YACX;YACA;gBACEF,MAAM;gBACNG,MAAM;oBACJ;wBACEL,QAAQ;4BACN;gCACEC,MAAM;gCACNC,MAAM;gCACNI,OAAO;4BACT;4BACA;gCACEL,MAAM;gCACNC,MAAM;gCACNK,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEL,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLO,aAAa;gCACf;gCACAI,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEL,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLY,WAAW,CAACC,OAASA,KAAKC,QAAQ;oCAClCP,aAAa;gCACf;4BACF;4BACA;gCACEF,MAAM;gCACNC,MAAM;gCACNN,OAAO;oCACLO,aAAa;gCACf;gCACAH,QAAQ;oCACN;wCACEC,MAAM;wCACNC,MAAM;wCACNS,UAAU;oCACZ;oCACA;wCACEV,MAAM;wCACNC,MAAM;wCACNS,UAAU;oCACZ;oCACA;wCACEV,MAAM;wCACNC,MAAM;wCACNU,SAAS;+CAAI5B;yCAAU;wCACvB2B,UAAU;oCACZ;oCACA;wCACEV,MAAM;wCACNC,MAAM;wCACNS,UAAU;oCACZ;oCACA;wCACEV,MAAM;wCACNC,MAAM;oCACR;oCACA;wCACED,MAAM;wCACNC,MAAM;oCACR;oCACA;wCACED,MAAM;wCACNC,MAAM;wCACNU,SAAS;4CAAC;4CAAU;yCAAY;wCAChCD,UAAU;oCACZ;oCACA;wCACEV,MAAM;wCACNC,MAAM;wCACNN,OAAO;4CACLY,WAAW,CAACK,GAAGJ,OAASA,KAAKK,KAAK,KAAK;wCACzC;wCACAH,UAAU;oCACZ;iCACD;4BACH;yBACD;wBACDI,OAAO;oBACT;iBACD;YACH;YACA;gBACEd,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLoB,UAAU;gBACZ;gBACAV,OAAO;gBACPM,SAAS;uBAAI9B;iBAAc;gBAC3B6B,UAAU;YACZ;YACA;gBACEV,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLoB,UAAU;gBACZ;gBACAV,OAAO;gBACPM,SAAS;uBAAI5B;iBAAU;gBACvB2B,UAAU;YACZ;YACA;gBACEV,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLoB,UAAU;gBACZ;gBACAT,cAAc;gBACdD,OAAO;gBACPM,SAAS;uBAAI3B;iBAAW;YAC1B;YACA;gBACEgB,MAAM;gBACNC,MAAM;gBACNI,OAAO;YACT;YACA;gBACEL,MAAM;gBACNC,MAAM;gBACNN,OAAO;oBACLoB,UAAU;gBACZ;gBACAT,cAAc;gBACdD,OAAO;YACT;SACD;QACDW,OAAO;YACLC,WAAW;gBACT,CAAC,EAAEC,GAAG,EAAEC,GAAG,EAAE;oBACX,4GAA4G;oBAE5GD,IAAIE,UAAU,GAAG9C,iBAAiB;wBAChC+C,QAAQH,IAAII,GAAG;wBACfC,aAAaJ,IAAIK,OAAO,CAAChD,MAAM,CAACG,IAAI,CAACW,KAAK;oBAC5C;oBAEA,OAAO4B;gBACT;aACD;QACH;QACAO,eAAe;IACjB;IACA,OAAO/B;AACT,EAAC"}

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

@@ -0,0 +1,45 @@
+import type { CollectionConfig } from '../../../index.js';
+import type { PayloadRequest } from '../../../types/index.js';
+import type { TaskConfig } from './taskTypes.js';
+import type { WorkflowConfig } from './workflowTypes.js';
+export type RunJobAccessArgs = {
+    req: PayloadRequest;
+};
+export type RunJobAccess = (args: RunJobAccessArgs) => boolean | Promise<boolean>;
+export type JobsConfig = {
+    /**
+     * Specify access control to determine who can interact with jobs.
+     */
+    access?: {
+        /**
+         * By default, all logged-in users can trigger jobs.
+         */
+        run?: RunJobAccess;
+    };
+    /**
+     * Determine whether or not to delete a job after it has successfully completed.
+     */
+    deleteJobOnComplete?: boolean;
+    /**
+     * Specify depth for retrieving jobs from the queue.
+     * This should be as low as possible in order for job retrieval
+     * to be as efficient as possible. Defaults to 0.
+     */
+    depth?: number;
+    /**
+     * Override any settings on the default Jobs collection. Accepts the default collection and allows you to return
+     * a new collection.
+     */
+    jobsCollectionOverrides?: (args: {
+        defaultJobsCollection: CollectionConfig;
+    }) => CollectionConfig;
+    /**
+     * Define all possible tasks here
+     */
+    tasks: TaskConfig<any>[];
+    /**
+     * Define all the workflows here. Workflows orchestrate the flow of multiple tasks.
+     */
+    workflows: WorkflowConfig<any>[];
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,gBAAgB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAEjF,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,GAAG,CAAC,EAAE,YAAY,CAAA;KACnB,CAAA;IACD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,qBAAqB,EAAE,gBAAgB,CAAA;KAAE,KAAK,gBAAgB,CAAA;IACjG;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAA;IACxB;;OAEG;IACH,SAAS,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;CACjC,CAAA"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/config/types/index.ts"],"sourcesContent":["import type { CollectionConfig } from '../../../index.js'\nimport type { PayloadRequest } from '../../../types/index.js'\nimport type { TaskConfig } from './taskTypes.js'\nimport type { WorkflowConfig } from './workflowTypes.js'\n\nexport type RunJobAccessArgs = {\n  req: PayloadRequest\n}\n\nexport type RunJobAccess = (args: RunJobAccessArgs) => boolean | Promise<boolean>\n\nexport type JobsConfig = {\n  /**\n   * Specify access control to determine who can interact with jobs.\n   */\n  access?: {\n    /**\n     * By default, all logged-in users can trigger jobs.\n     */\n    run?: RunJobAccess\n  }\n  /**\n   * Determine whether or not to delete a job after it has successfully completed.\n   */\n  deleteJobOnComplete?: boolean\n  /**\n   * Specify depth for retrieving jobs from the queue.\n   * This should be as low as possible in order for job retrieval\n   * to be as efficient as possible. Defaults to 0.\n   */\n  depth?: number\n  /**\n   * Override any settings on the default Jobs collection. Accepts the default collection and allows you to return\n   * a new collection.\n   */\n  jobsCollectionOverrides?: (args: { defaultJobsCollection: CollectionConfig }) => CollectionConfig\n  /**\n   * Define all possible tasks here\n   */\n  tasks: TaskConfig<any>[]\n  /**\n   * Define all the workflows here. Workflows orchestrate the flow of multiple tasks.\n   */\n  workflows: WorkflowConfig<any>[]\n}\n"],"names":[],"mappings":"AAWA,WAiCC"}

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

@@ -0,0 +1,134 @@
+import type { Field, PayloadRequest, StringKeyOf, TypedJobs } from '../../../index.js';
+import type { RunningJob, RunningJobSimple } from './workflowTypes.js';
+export type TaskInputOutput = {
+    input: object;
+    output: object;
+};
+export type TaskHandlerResult<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput> = {
+    output: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['output'] : TTaskSlugOrInputOutput extends TaskInputOutput ? TTaskSlugOrInputOutput['output'] : never;
+    state?: 'failed' | 'succeeded';
+};
+export type TaskHandlerArgs<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput, TWorkflowSlug extends keyof TypedJobs['workflows'] = string> = {
+    input: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['input'] : TTaskSlugOrInputOutput extends TaskInputOutput ? TTaskSlugOrInputOutput['input'] : never;
+    job: RunningJob<TWorkflowSlug>;
+    req: PayloadRequest;
+};
+/**
+ * Inline tasks in JSON workflows have no input, as they can just get the input from job.taskStatus
+ */
+export type TaskHandlerArgsNoInput<TWorkflowInput extends object> = {
+    job: RunningJobSimple<TWorkflowInput>;
+    req: PayloadRequest;
+};
+export type TaskHandler<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput, TWorkflowSlug extends keyof TypedJobs['workflows'] = string> = (args: TaskHandlerArgs<TTaskSlugOrInputOutput, TWorkflowSlug>) => Promise<TaskHandlerResult<TTaskSlugOrInputOutput>> | TaskHandlerResult<TTaskSlugOrInputOutput>;
+export type TaskType = StringKeyOf<TypedJobs['tasks']>;
+export type TaskInput<T extends keyof TypedJobs['tasks']> = TypedJobs['tasks'][T]['input'];
+export type TaskOutput<T extends keyof TypedJobs['tasks']> = TypedJobs['tasks'][T]['output'];
+export type TaskHandlerResults = {
+    [TTaskSlug in keyof TypedJobs['tasks']]: {
+        [id: string]: TaskHandlerResult<TTaskSlug>;
+    };
+};
+export type RunTaskFunctionArgs<TTaskSlug extends keyof TypedJobs['tasks']> = {
+    input?: TaskInput<TTaskSlug>;
+    retries?: number | RetryConfig;
+};
+export type RunTaskFunction<TTaskSlug extends keyof TypedJobs['tasks']> = (taskID: string, taskArgs?: RunTaskFunctionArgs<TTaskSlug>) => Promise<TaskOutput<TTaskSlug>>;
+export type RunTaskFunctions = {
+    [TTaskSlug in keyof TypedJobs['tasks']]: RunTaskFunction<TTaskSlug>;
+};
+export type RunInlineTaskFunction = <TTaskInput extends object, TTaskOutput extends object>(taskID: string, taskArgs: {
+    input?: TTaskInput;
+    retries?: number | RetryConfig;
+    task: (args: {
+        input: TTaskInput;
+        job: RunningJob<any>;
+        req: PayloadRequest;
+    }) => {
+        output: TTaskOutput;
+        state?: 'failed' | 'succeeded';
+    } | Promise<{
+        output: TTaskOutput;
+        state?: 'failed' | 'succeeded';
+    }>;
+}) => Promise<TTaskOutput>;
+export type RetryConfig = {
+    attempts: number;
+    /**
+     * The backoff strategy to use when retrying the task. This determines how long to wait before retrying the task.
+     *
+     * If this is set on a single task, the longest backoff time of a task will determine the time until the entire workflow is retried.
+     */
+    backoff?: {
+        /**
+         * Base delay between running jobs in ms
+         */
+        delay?: number;
+        /**
+         * @default fixed
+         *
+         * The backoff strategy to use when retrying the task. This determines how long to wait before retrying the task.
+         * If fixed (default) is used, the delay will be the same between each retry.
+         *
+         * If exponential is used, the delay will increase exponentially with each retry.
+         *
+         * @example
+         * delay = 1000
+         * attempts = 3
+         * type = 'fixed'
+         *
+         * The task will be retried 3 times with a delay of 1000ms between each retry.
+         *
+         * @example
+         * delay = 1000
+         * attempts = 3
+         * type = 'exponential'
+         *
+         * The task will be retried 3 times with a delay of 1000ms, 2000ms, and 4000ms between each retry.
+         */
+        type: 'exponential' | 'fixed';
+    };
+};
+export type TaskConfig<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskType> = {
+    /**
+     * The function that should be responsible for running the job.
+     * You can either pass a string-based path to the job function file, or the job function itself.
+     *
+     * If you are using large dependencies within your job, you might prefer to pass the string path
+     * because that will avoid bundling large dependencies in your Next.js app.
+     */
+    handler: string | TaskHandler<TTaskSlugOrInputOutput>;
+    /**
+     * 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 task. By default, this is "Task" + the capitalized task slug.
+     */
+    interfaceName?: string;
+    /**
+     * Define a human-friendly label for this task.
+     */
+    label?: string;
+    /**
+     * Function to be executed if the task fails.
+     */
+    onFail?: () => Promise<void> | void;
+    /**
+     * Function to be executed if the task succeeds.
+     */
+    onSuccess?: () => Promise<void> | void;
+    /**
+     * Define the output field schema - payload will generate a type for this schema.
+     */
+    outputSchema?: Field[];
+    /**
+     * Specify the number of times that this step should be retried if it fails.
+     */
+    retries?: number | RetryConfig;
+    /**
+     * Define a slug-based name for this job. This slug needs to be unique among both tasks and workflows.
+     */
+    slug: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] ? TTaskSlugOrInputOutput : string;
+};
+//# sourceMappingURL=taskTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"taskTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/taskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACtF,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AACD,MAAM,MAAM,iBAAiB,CAC3B,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,IACvE;IACF,MAAM,EAAE,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAC3D,SAAS,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,CAAC,QAAQ,CAAC,GACpD,sBAAsB,SAAS,eAAe,GAC5C,sBAAsB,CAAC,QAAQ,CAAC,GAChC,KAAK,CAAA;IACX,KAAK,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,CACzB,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,EACzE,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,IACzD;IACF,KAAK,EAAE,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAC1D,SAAS,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,GACnD,sBAAsB,SAAS,eAAe,GAC5C,sBAAsB,CAAC,OAAO,CAAC,GAC/B,KAAK,CAAA;IACX,GAAG,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IAC9B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,cAAc,SAAS,MAAM,IAAI;IAClE,GAAG,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAA;IACrC,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,WAAW,CACrB,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,EACzE,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,IACzD,CACF,IAAI,EAAE,eAAe,CAAC,sBAAsB,EAAE,aAAa,CAAC,KACzD,OAAO,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,GAAG,iBAAiB,CAAC,sBAAsB,CAAC,CAAA;AAEnG,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;AAGtD,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AAE1F,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;AAE5F,MAAM,MAAM,kBAAkB,GAAG;KAC9B,SAAS,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG;QACvC,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAA;KAC3C;CACF,CAAA;AAGD,MAAM,MAAM,mBAAmB,CAAC,SAAS,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI;IAC5E,KAAK,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,CACxE,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,KACtC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;AAEnC,MAAM,MAAM,gBAAgB,GAAG;KAC5B,SAAS,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,SAAS,CAAC;CACpE,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,CAAC,UAAU,SAAS,MAAM,EAAE,WAAW,SAAS,MAAM,EACxF,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE;IACR,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IAE9B,IAAI,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;QAAC,GAAG,EAAE,cAAc,CAAA;KAAE,KACzE;QACE,MAAM,EAAE,WAAW,CAAA;QACnB,KAAK,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;KAC/B,GACD,OAAO,CAAC;QAAE,MAAM,EAAE,WAAW,CAAC;QAAC,KAAK,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;KAAE,CAAC,CAAA;CACrE,KACE,OAAO,CAAC,WAAW,CAAC,CAAA;AAEzB,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,IAAI,EAAE,aAAa,GAAG,OAAO,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,GAAG,QAAQ,IAClF;IACF;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAA;IACrD;;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;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,EAAE,CAAA;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IAC9B;;OAEG;IACH,IAAI,EAAE,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,sBAAsB,GAAG,MAAM,CAAA;CAChG,CAAA"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/config/types/taskTypes.ts"],"sourcesContent":["import type { Field, PayloadRequest, StringKeyOf, TypedJobs } from '../../../index.js'\nimport type { RunningJob, RunningJobSimple } from './workflowTypes.js'\n\nexport type TaskInputOutput = {\n  input: object\n  output: object\n}\nexport type TaskHandlerResult<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput,\n> = {\n  output: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks']\n    ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['output']\n    : TTaskSlugOrInputOutput extends TaskInputOutput // Check if it's actually TaskInputOutput type\n      ? TTaskSlugOrInputOutput['output']\n      : never\n  state?: 'failed' | 'succeeded'\n}\n\nexport type TaskHandlerArgs<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput,\n  TWorkflowSlug extends keyof TypedJobs['workflows'] = string,\n> = {\n  input: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks']\n    ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['input']\n    : TTaskSlugOrInputOutput extends TaskInputOutput // Check if it's actually TaskInputOutput type\n      ? TTaskSlugOrInputOutput['input']\n      : never\n  job: RunningJob<TWorkflowSlug>\n  req: PayloadRequest\n}\n\n/**\n * Inline tasks in JSON workflows have no input, as they can just get the input from job.taskStatus\n */\nexport type TaskHandlerArgsNoInput<TWorkflowInput extends object> = {\n  job: RunningJobSimple<TWorkflowInput>\n  req: PayloadRequest\n}\n\nexport type TaskHandler<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput,\n  TWorkflowSlug extends keyof TypedJobs['workflows'] = string,\n> = (\n  args: TaskHandlerArgs<TTaskSlugOrInputOutput, TWorkflowSlug>,\n) => Promise<TaskHandlerResult<TTaskSlugOrInputOutput>> | TaskHandlerResult<TTaskSlugOrInputOutput>\n\nexport type TaskType = StringKeyOf<TypedJobs['tasks']>\n\n// Extracts the type of `input` corresponding to each task\nexport type TaskInput<T extends keyof TypedJobs['tasks']> = TypedJobs['tasks'][T]['input']\n\nexport type TaskOutput<T extends keyof TypedJobs['tasks']> = TypedJobs['tasks'][T]['output']\n\nexport type TaskHandlerResults = {\n  [TTaskSlug in keyof TypedJobs['tasks']]: {\n    [id: string]: TaskHandlerResult<TTaskSlug>\n  }\n}\n\n// Helper type to create correct argument type for the function corresponding to each task.\nexport type RunTaskFunctionArgs<TTaskSlug extends keyof TypedJobs['tasks']> = {\n  input?: TaskInput<TTaskSlug>\n  retries?: number | RetryConfig\n}\n\nexport type RunTaskFunction<TTaskSlug extends keyof TypedJobs['tasks']> = (\n  taskID: string,\n  taskArgs?: RunTaskFunctionArgs<TTaskSlug>,\n) => Promise<TaskOutput<TTaskSlug>>\n\nexport type RunTaskFunctions = {\n  [TTaskSlug in keyof TypedJobs['tasks']]: RunTaskFunction<TTaskSlug>\n}\n\nexport type RunInlineTaskFunction = <TTaskInput extends object, TTaskOutput extends object>(\n  taskID: string,\n  taskArgs: {\n    input?: TTaskInput\n    retries?: number | RetryConfig\n    // This is the same as TaskHandler, but typed out explicitly in order to improve type inference\n    task: (args: { input: TTaskInput; job: RunningJob<any>; req: PayloadRequest }) =>\n      | {\n          output: TTaskOutput\n          state?: 'failed' | 'succeeded'\n        }\n      | Promise<{ output: TTaskOutput; state?: 'failed' | 'succeeded' }>\n  },\n) => Promise<TTaskOutput>\n\nexport type RetryConfig = {\n  attempts: number\n  /**\n   * The backoff strategy to use when retrying the task. This determines how long to wait before retrying the task.\n   *\n   * If this is set on a single task, the longest backoff time of a task will determine the time until the entire workflow is retried.\n   */\n  backoff?: {\n    /**\n     * Base delay between running jobs in ms\n     */\n    delay?: number\n    /**\n     * @default fixed\n     *\n     * The backoff strategy to use when retrying the task. This determines how long to wait before retrying the task.\n     * If fixed (default) is used, the delay will be the same between each retry.\n     *\n     * If exponential is used, the delay will increase exponentially with each retry.\n     *\n     * @example\n     * delay = 1000\n     * attempts = 3\n     * type = 'fixed'\n     *\n     * The task will be retried 3 times with a delay of 1000ms between each retry.\n     *\n     * @example\n     * delay = 1000\n     * attempts = 3\n     * type = 'exponential'\n     *\n     * The task will be retried 3 times with a delay of 1000ms, 2000ms, and 4000ms between each retry.\n     */\n    type: 'exponential' | 'fixed'\n  }\n}\n\nexport type TaskConfig<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskType,\n> = {\n  /**\n   * The function that should be responsible for running the job.\n   * You can either pass a string-based path to the job function file, or the job function itself.\n   *\n   * If you are using large dependencies within your job, you might prefer to pass the string path\n   * because that will avoid bundling large dependencies in your Next.js app.\n   */\n  handler: string | TaskHandler<TTaskSlugOrInputOutput>\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 task. By default, this is \"Task\" + the capitalized task slug.\n   */\n  interfaceName?: string\n  /**\n   * Define a human-friendly label for this task.\n   */\n  label?: string\n  /**\n   * Function to be executed if the task fails.\n   */\n  onFail?: () => Promise<void> | void\n  /**\n   * Function to be executed if the task succeeds.\n   */\n  onSuccess?: () => Promise<void> | void\n  /**\n   * Define the output field schema - payload will generate a type for this schema.\n   */\n  outputSchema?: Field[]\n  /**\n   * Specify the number of times that this step should be retried if it fails.\n   */\n  retries?: number | RetryConfig\n  /**\n   * Define a slug-based name for this job. This slug needs to be unique among both tasks and workflows.\n   */\n  slug: TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] ? TTaskSlugOrInputOutput : string\n}\n"],"names":[],"mappings":"AA+HA,WA2CC"}

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

@@ -0,0 +1,29 @@
+import type { RunningJob, TaskHandlerResult, TypedJobs } from '../../../index.js';
+import type { RetryConfig, TaskHandlerArgsNoInput } from './taskTypes.js';
+export type WorkflowStep<TTaskSlug extends keyof TypedJobs['tasks'], TWorkflowSlug extends keyof TypedJobs['workflows']> = {
+    /**
+     * If this step is completed, the workflow will be marked as completed
+     */
+    completesJob?: boolean;
+    condition?: (args: {
+        job: RunningJob<TWorkflowSlug>;
+    }) => boolean;
+    /**
+     * Each task needs to have a unique ID to track its status
+     */
+    id: string;
+    retries?: number | RetryConfig;
+} & ({
+    inlineTask?: (args: TaskHandlerArgsNoInput<TypedJobs['workflows'][TWorkflowSlug]['input']>) => Promise<TaskHandlerResult<TTaskSlug>> | TaskHandlerResult<TTaskSlug>;
+} | {
+    input: (args: {
+        job: RunningJob<TWorkflowSlug>;
+    }) => TypedJobs['tasks'][TTaskSlug]['input'];
+    task: TTaskSlug;
+});
+type AllWorkflowSteps<TWorkflowSlug extends keyof TypedJobs['workflows']> = {
+    [TTaskSlug in keyof TypedJobs['tasks']]: WorkflowStep<TTaskSlug, TWorkflowSlug>;
+}[keyof TypedJobs['tasks']];
+export type WorkflowJSON<TWorkflowSlug extends keyof TypedJobs['workflows']> = Array<AllWorkflowSteps<TWorkflowSlug>>;
+export {};
+//# sourceMappingURL=workflowJSONTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflowJSONTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACjF,OAAO,KAAK,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAA;AAEzE,MAAM,MAAM,YAAY,CACtB,SAAS,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,EAC1C,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,IAChD;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;KAAE,KAAK,OAAO,CAAA;IACjE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC/B,GAAG,CACA;IACE,UAAU,CAAC,EAAE,CACX,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,KACzE,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAA;CAC1E,GACD;IACE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;KAAE,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAA;IAC3F,IAAI,EAAE,SAAS,CAAA;CAChB,CACJ,CAAA;AAED,KAAK,gBAAgB,CAAC,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,IAAI;KACzE,SAAS,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC;CAChF,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;AAE3B,MAAM,MAAM,YAAY,CAAC,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,IAAI,KAAK,CAClF,gBAAgB,CAAC,aAAa,CAAC,CAChC,CAAA"}

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,98 @@
+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 queue name that this workflow should be tied to.
+     * Defaults to "default".
+     */
+    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;;;OAGG;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 queue name that this workflow should be tied to.\n   * Defaults to \"default\".\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,WAsCC"}