payload 4.0.0-internal.cd69eef → 4.0.0-internal.ce66a41

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/queues/config/collection.ts"],"sourcesContent":["import type { CollectionConfig } from '../../collections/config/types.js'\nimport type { SanitizedConfig } from '../../config/types.js'\nimport type { Field } from '../../fields/config/types.js'\nimport type { Job } from '../../index.js'\n\nimport { handleSchedulesJobsEndpoint } from '../endpoints/handleSchedules.js'\nimport { runJobsEndpoint } from '../endpoints/run.js'\nimport { getJobTaskStatus } from '../utilities/getJobTaskStatus.js'\n\nexport const jobsCollectionSlug = 'payload-jobs'\n\nexport const getDefaultJobsCollection: (jobsConfig: SanitizedConfig['jobs']) => CollectionConfig = (\n  jobsConfig,\n) => {\n  const workflowSlugs: Set<string> = new Set()\n  const taskSlugs: Set<string> = new Set(['inline'])\n\n  if (jobsConfig.workflows?.length) {\n    jobsConfig.workflows.forEach((workflow) => {\n      workflowSlugs.add(workflow.slug)\n\n      // Validate concurrency config requires enableConcurrencyControl flag\n      if (workflow.concurrency && !jobsConfig.enableConcurrencyControl) {\n        throw new Error(\n          `Workflow \"${workflow.slug}\" uses concurrency controls but \"jobs.enableConcurrencyControl\" is not enabled. ` +\n            `Set \"jobs.enableConcurrencyControl: true\" in your Payload config to use concurrency controls. ` +\n            `Note: This adds a new indexed field to the jobs collection schema and may require a database migration.`,\n        )\n      }\n    })\n  }\n\n  if (jobsConfig.tasks?.length) {\n    jobsConfig.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\n      // Validate concurrency config requires enableConcurrencyControl flag\n      if (task.concurrency && !jobsConfig.enableConcurrencyControl) {\n        throw new Error(\n          `Task \"${task.slug}\" uses concurrency controls but \"jobs.enableConcurrencyControl\" is not enabled. ` +\n            `Set \"jobs.enableConcurrencyControl: true\" in your Payload config to use concurrency controls. ` +\n            `Note: This adds a new indexed field to the jobs collection schema and may require a database migration.`,\n        )\n      }\n\n      taskSlugs.add(task.slug)\n    })\n  }\n\n  const logFields: Field[] = [\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     * @todo make required in 4.0\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  if (jobsConfig.addParentToTaskLog) {\n    logFields.push({\n      name: 'parent',\n      type: 'group',\n      fields: [\n        {\n          name: 'taskSlug',\n          type: 'select',\n          options: [...taskSlugs],\n        },\n        {\n          name: 'taskID',\n          type: 'text',\n        },\n      ],\n    })\n  }\n\n  const jobsCollection: CollectionConfig = {\n    slug: jobsCollectionSlug,\n    admin: {\n      group: 'System',\n      hidden: true,\n    },\n    endpoints: [runJobsEndpoint, handleSchedulesJobsEndpoint],\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: logFields,\n              },\n            ],\n            label: 'Status',\n          },\n        ],\n      },\n      // only include the workflowSlugs field if workflows exist\n      ...((workflowSlugs.size > 0\n        ? [\n            {\n              name: 'workflowSlug',\n              type: 'select',\n              admin: {\n                position: 'sidebar',\n              },\n              index: true,\n              options: [...workflowSlugs],\n            },\n          ]\n        : []) as Field[]),\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: 'text',\n        admin: {\n          position: 'sidebar',\n        },\n        defaultValue: 'default',\n        index: true,\n      },\n      {\n        name: 'waitUntil',\n        type: 'date',\n        admin: {\n          date: { pickerAppearance: 'dayAndTime' },\n        },\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      // Only add concurrencyKey field if concurrency control is enabled\n      ...(jobsConfig.enableConcurrencyControl\n        ? [\n            {\n              name: 'concurrencyKey',\n              type: 'text',\n              admin: {\n                description:\n                  'Used for concurrency control. Jobs with the same key are subject to exclusive/supersedes rules.',\n                position: 'sidebar',\n                readOnly: true,\n              },\n              index: true,\n            } as Field,\n          ]\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          return jobAfterRead({ config: req.payload.config, doc })\n        },\n      ],\n      /**\n       * If another update comes in after a job as already been cancelled, we need to make sure that update doesn't\n       * change the state of the job.\n       */\n      beforeChange: [\n        ({ data, originalDoc }) => {\n          if (originalDoc?.error?.cancelled) {\n            data.processing = false\n            data.hasError = true\n            delete data.completedAt\n            delete data.waitUntil\n          }\n          return data\n        },\n      ],\n    },\n    lockDocuments: false,\n    versions: false,\n  }\n\n  if (jobsConfig.stats) {\n    // TODO: In 4.0, this should be added by default.\n    // The meta field can be used to store arbitrary data about the job. The scheduling system uses this to store\n    // `scheduled: true` to indicate that the job was queued by the scheduling system.\n    jobsCollection.fields.push({\n      name: 'meta',\n      type: 'json',\n    })\n  }\n  return jobsCollection\n}\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function jobAfterRead({ config, doc }: { config: SanitizedConfig; doc: Job }): Job {\n  doc.taskStatus = getJobTaskStatus({\n    jobLog: doc.log || [],\n  })\n  doc.input = doc.input || {}\n  return doc\n}\n"],"names":["handleSchedulesJobsEndpoint","runJobsEndpoint","getJobTaskStatus","jobsCollectionSlug","getDefaultJobsCollection","jobsConfig","workflowSlugs","Set","taskSlugs","workflows","length","forEach","workflow","add","slug","concurrency","enableConcurrencyControl","Error","tasks","task","has","logFields","name","type","required","options","admin","condition","_","data","state","addParentToTaskLog","push","fields","jobsCollection","group","hidden","endpoints","description","virtual","tabs","index","defaultValue","hasError","label","size","position","date","pickerAppearance","readOnly","hooks","afterRead","doc","req","jobAfterRead","config","payload","beforeChange","originalDoc","error","cancelled","processing","completedAt","waitUntil","lockDocuments","versions","stats","taskStatus","jobLog","log","input"],"mappings":"AAKA,SAASA,2BAA2B,QAAQ,kCAAiC;AAC7E,SAASC,eAAe,QAAQ,sBAAqB;AACrD,SAASC,gBAAgB,QAAQ,mCAAkC;AAEnE,OAAO,MAAMC,qBAAqB,eAAc;AAEhD,OAAO,MAAMC,2BAAsF,CACjGC;IAEA,MAAMC,gBAA6B,IAAIC;IACvC,MAAMC,YAAyB,IAAID,IAAI;QAAC;KAAS;IAEjD,IAAIF,WAAWI,SAAS,EAAEC,QAAQ;QAChCL,WAAWI,SAAS,CAACE,OAAO,CAAC,CAACC;YAC5BN,cAAcO,GAAG,CAACD,SAASE,IAAI;YAE/B,qEAAqE;YACrE,IAAIF,SAASG,WAAW,IAAI,CAACV,WAAWW,wBAAwB,EAAE;gBAChE,MAAM,IAAIC,MACR,CAAC,UAAU,EAAEL,SAASE,IAAI,CAAC,gFAAgF,CAAC,GAC1G,CAAC,8FAA8F,CAAC,GAChG,CAAC,uGAAuG,CAAC;YAE/G;QACF;IACF;IAEA,IAAIT,WAAWa,KAAK,EAAER,QAAQ;QAC5BL,WAAWa,KAAK,CAACP,OAAO,CAAC,CAACQ;YACxB,IAAIb,cAAcc,GAAG,CAACD,KAAKL,IAAI,GAAG;gBAChC,MAAM,IAAIG,MACR,CAAC,WAAW,EAAEE,KAAKL,IAAI,CAAC,0FAA0F,CAAC;YAEvH;YAEA,qEAAqE;YACrE,IAAIK,KAAKJ,WAAW,IAAI,CAACV,WAAWW,wBAAwB,EAAE;gBAC5D,MAAM,IAAIC,MACR,CAAC,MAAM,EAAEE,KAAKL,IAAI,CAAC,gFAAgF,CAAC,GAClG,CAAC,8FAA8F,CAAC,GAChG,CAAC,uGAAuG,CAAC;YAE/G;YAEAN,UAAUK,GAAG,CAACM,KAAKL,IAAI;QACzB;IACF;IAEA,MAAMO,YAAqB;QACzB;YACEC,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNE,SAAS;mBAAIjB;aAAU;YACvBgB,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;;KAEC,GACD;YACEF,MAAM;YACNC,MAAM;QACR;QACA;YACED,MAAM;YACNC,MAAM;QACR;QACA;YACED,MAAM;YACNC,MAAM;YACNE,SAAS;gBAAC;gBAAU;aAAY;YAChCD,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNG,OAAO;gBACLC,WAAW,CAACC,GAAGC,OAASA,KAAKC,KAAK,KAAK;YACzC;YACAN,UAAU;QACZ;KACD;IAED,IAAInB,WAAW0B,kBAAkB,EAAE;QACjCV,UAAUW,IAAI,CAAC;YACbV,MAAM;YACNC,MAAM;YACNU,QAAQ;gBACN;oBACEX,MAAM;oBACNC,MAAM;oBACNE,SAAS;2BAAIjB;qBAAU;gBACzB;gBACA;oBACEc,MAAM;oBACNC,MAAM;gBACR;aACD;QACH;IACF;IAEA,MAAMW,iBAAmC;QACvCpB,MAAMX;QACNuB,OAAO;YACLS,OAAO;YACPC,QAAQ;QACV;QACAC,WAAW;YAACpC;YAAiBD;SAA4B;QACzDiC,QAAQ;YACN;gBACEX,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLY,aAAa;gBACf;YACF;YACA;gBACEhB,MAAM;gBACNC,MAAM;gBACNgB,SAAS;YACX;YACA;gBACEhB,MAAM;gBACNiB,MAAM;oBACJ;wBACEP,QAAQ;4BACN;gCACEX,MAAM;gCACNC,MAAM;gCACNkB,OAAO;4BACT;4BACA;gCACEnB,MAAM;gCACNC,MAAM;gCACNmB,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEnB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLY,aAAa;gCACf;gCACAI,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEnB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLC,WAAW,CAACE,OAASA,KAAKc,QAAQ;oCAClCL,aAAa;gCACf;4BACF;4BACA;gCACEhB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLY,aAAa;gCACf;gCACAL,QAAQZ;4BACV;yBACD;wBACDuB,OAAO;oBACT;iBACD;YACH;YACA,0DAA0D;eACrDtC,cAAcuC,IAAI,GAAG,IACtB;gBACE;oBACEvB,MAAM;oBACNC,MAAM;oBACNG,OAAO;wBACLoB,UAAU;oBACZ;oBACAL,OAAO;oBACPhB,SAAS;2BAAInB;qBAAc;gBAC7B;aACD,GACD,EAAE;YACN;gBACEgB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLoB,UAAU;gBACZ;gBACAL,OAAO;gBACPhB,SAAS;uBAAIjB;iBAAU;gBACvBgB,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLoB,UAAU;gBACZ;gBACAJ,cAAc;gBACdD,OAAO;YACT;YACA;gBACEnB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLqB,MAAM;wBAAEC,kBAAkB;oBAAa;gBACzC;gBACAP,OAAO;YACT;YACA;gBACEnB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLoB,UAAU;gBACZ;gBACAJ,cAAc;gBACdD,OAAO;YACT;YACA,kEAAkE;eAC9DpC,WAAWW,wBAAwB,GACnC;gBACE;oBACEM,MAAM;oBACNC,MAAM;oBACNG,OAAO;wBACLY,aACE;wBACFQ,UAAU;wBACVG,UAAU;oBACZ;oBACAR,OAAO;gBACT;aACD,GACD,EAAE;SACP;QACDS,OAAO;YACLC,WAAW;gBACT,CAAC,EAAEC,GAAG,EAAEC,GAAG,EAAE;oBACX,4GAA4G;oBAE5G,OAAOC,aAAa;wBAAEC,QAAQF,IAAIG,OAAO,CAACD,MAAM;wBAAEH;oBAAI;gBACxD;aACD;YACD;;;OAGC,GACDK,cAAc;gBACZ,CAAC,EAAE5B,IAAI,EAAE6B,WAAW,EAAE;oBACpB,IAAIA,aAAaC,OAAOC,WAAW;wBACjC/B,KAAKgC,UAAU,GAAG;wBAClBhC,KAAKc,QAAQ,GAAG;wBAChB,OAAOd,KAAKiC,WAAW;wBACvB,OAAOjC,KAAKkC,SAAS;oBACvB;oBACA,OAAOlC;gBACT;aACD;QACH;QACAmC,eAAe;QACfC,UAAU;IACZ;IAEA,IAAI5D,WAAW6D,KAAK,EAAE;QACpB,iDAAiD;QACjD,6GAA6G;QAC7G,kFAAkF;QAClFhC,eAAeD,MAAM,CAACD,IAAI,CAAC;YACzBV,MAAM;YACNC,MAAM;QACR;IACF;IACA,OAAOW;AACT,EAAC;AAED,6DAA6D;AAC7D,OAAO,SAASoB,aAAa,EAAEC,MAAM,EAAEH,GAAG,EAAyC;IACjFA,IAAIe,UAAU,GAAGjE,iBAAiB;QAChCkE,QAAQhB,IAAIiB,GAAG,IAAI,EAAE;IACvB;IACAjB,IAAIkB,KAAK,GAAGlB,IAAIkB,KAAK,IAAI,CAAC;IAC1B,OAAOlB;AACT"}
+{"version":3,"sources":["../../../src/queues/config/collection.ts"],"sourcesContent":["import type { CollectionConfig } from '../../collections/config/types.js'\nimport type { SanitizedConfig } from '../../config/types.js'\nimport type { Field } from '../../fields/config/types.js'\nimport type { Job } from '../../index.js'\n\nimport { handleSchedulesJobsEndpoint } from '../endpoints/handleSchedules.js'\nimport { runJobsEndpoint } from '../endpoints/run.js'\nimport { getJobTaskStatus } from '../utilities/getJobTaskStatus.js'\n\nexport const jobsCollectionSlug = 'payload-jobs'\n\nexport const getDefaultJobsCollection: (jobsConfig: SanitizedConfig['jobs']) => CollectionConfig = (\n  jobsConfig,\n) => {\n  const workflowSlugs: Set<string> = new Set()\n  const taskSlugs: Set<string> = new Set(['inline'])\n\n  if (jobsConfig.workflows?.length) {\n    jobsConfig.workflows.forEach((workflow) => {\n      workflowSlugs.add(workflow.slug)\n    })\n  }\n\n  if (jobsConfig.tasks?.length) {\n    jobsConfig.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\n      taskSlugs.add(task.slug)\n    })\n  }\n\n  const logFields: Field[] = [\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      required: true,\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      name: 'parent',\n      type: 'group',\n      fields: [\n        {\n          name: 'taskSlug',\n          type: 'select',\n          options: [...taskSlugs],\n        },\n        {\n          name: 'taskID',\n          type: 'text',\n        },\n      ],\n    },\n  ]\n\n  const jobsCollection: CollectionConfig = {\n    slug: jobsCollectionSlug,\n    access: {\n      create: () => false,\n      delete: () => false,\n      read: () => false,\n      update: () => false,\n    },\n    admin: {\n      group: 'System',\n      hidden: true,\n    },\n    authorship: false,\n    endpoints: [runJobsEndpoint, handleSchedulesJobsEndpoint],\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        // The meta field can be used to store arbitrary data about the job. The scheduling system\n        // uses `scheduled: true` to indicate that it queued the job.\n        name: 'meta',\n        type: 'json',\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: logFields,\n              },\n            ],\n            label: 'Status',\n          },\n        ],\n      },\n      // only include the workflowSlugs field if workflows exist\n      ...((workflowSlugs.size > 0\n        ? [\n            {\n              name: 'workflowSlug',\n              type: 'select',\n              admin: {\n                position: 'sidebar',\n              },\n              index: true,\n              options: [...workflowSlugs],\n            },\n          ]\n        : []) as Field[]),\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: 'text',\n        admin: {\n          position: 'sidebar',\n        },\n        defaultValue: 'default',\n        index: true,\n      },\n      {\n        name: 'waitUntil',\n        type: 'date',\n        admin: {\n          date: { pickerAppearance: 'dayAndTime' },\n        },\n        index: true,\n      },\n      {\n        name: 'processingUntil',\n        type: 'date',\n        admin: {\n          date: { pickerAppearance: 'dayAndTime' },\n          position: 'sidebar',\n        },\n        index: true,\n      },\n      {\n        name: 'processingToken',\n        type: 'text',\n        admin: {\n          hidden: true,\n          readOnly: true,\n        },\n      },\n      {\n        name: 'concurrencyKey',\n        type: 'text',\n        admin: {\n          description:\n            'Used for concurrency control. Jobs with the same key are subject to exclusive/supersedes rules.',\n          position: 'sidebar',\n          readOnly: true,\n        },\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          return jobAfterRead({ config: req.payload.config, doc })\n        },\n      ],\n      /**\n       * If another update comes in after a job as already been cancelled, we need to make sure that update doesn't\n       * change the state of the job.\n       */\n      beforeChange: [\n        ({ data, originalDoc }) => {\n          if (originalDoc?.error?.cancelled) {\n            data.processingToken = null\n            data.processingUntil = null\n            data.hasError = true\n            delete data.completedAt\n            delete data.waitUntil\n          }\n          return data\n        },\n      ],\n    },\n    lockDocuments: false,\n    versions: false,\n  }\n\n  return jobsCollection\n}\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function jobAfterRead({ config, doc }: { config: SanitizedConfig; doc: Job }): Job {\n  doc.taskStatus = getJobTaskStatus({\n    jobLog: doc.log || [],\n  })\n  doc.input = doc.input || {}\n  return doc\n}\n"],"names":["handleSchedulesJobsEndpoint","runJobsEndpoint","getJobTaskStatus","jobsCollectionSlug","getDefaultJobsCollection","jobsConfig","workflowSlugs","Set","taskSlugs","workflows","length","forEach","workflow","add","slug","tasks","task","has","Error","logFields","name","type","required","options","admin","condition","_","data","state","fields","jobsCollection","access","create","delete","read","update","group","hidden","authorship","endpoints","description","virtual","tabs","index","defaultValue","hasError","label","size","position","date","pickerAppearance","readOnly","hooks","afterRead","doc","req","jobAfterRead","config","payload","beforeChange","originalDoc","error","cancelled","processingToken","processingUntil","completedAt","waitUntil","lockDocuments","versions","taskStatus","jobLog","log","input"],"mappings":"AAKA,SAASA,2BAA2B,QAAQ,kCAAiC;AAC7E,SAASC,eAAe,QAAQ,sBAAqB;AACrD,SAASC,gBAAgB,QAAQ,mCAAkC;AAEnE,OAAO,MAAMC,qBAAqB,eAAc;AAEhD,OAAO,MAAMC,2BAAsF,CACjGC;IAEA,MAAMC,gBAA6B,IAAIC;IACvC,MAAMC,YAAyB,IAAID,IAAI;QAAC;KAAS;IAEjD,IAAIF,WAAWI,SAAS,EAAEC,QAAQ;QAChCL,WAAWI,SAAS,CAACE,OAAO,CAAC,CAACC;YAC5BN,cAAcO,GAAG,CAACD,SAASE,IAAI;QACjC;IACF;IAEA,IAAIT,WAAWU,KAAK,EAAEL,QAAQ;QAC5BL,WAAWU,KAAK,CAACJ,OAAO,CAAC,CAACK;YACxB,IAAIV,cAAcW,GAAG,CAACD,KAAKF,IAAI,GAAG;gBAChC,MAAM,IAAII,MACR,CAAC,WAAW,EAAEF,KAAKF,IAAI,CAAC,0FAA0F,CAAC;YAEvH;YAEAN,UAAUK,GAAG,CAACG,KAAKF,IAAI;QACzB;IACF;IAEA,MAAMK,YAAqB;QACzB;YACEC,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNE,SAAS;mBAAIf;aAAU;YACvBc,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNC,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;QACR;QACA;YACED,MAAM;YACNC,MAAM;YACNE,SAAS;gBAAC;gBAAU;aAAY;YAChCD,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNG,OAAO;gBACLC,WAAW,CAACC,GAAGC,OAASA,KAAKC,KAAK,KAAK;YACzC;YACAN,UAAU;QACZ;QACA;YACEF,MAAM;YACNC,MAAM;YACNQ,QAAQ;gBACN;oBACET,MAAM;oBACNC,MAAM;oBACNE,SAAS;2BAAIf;qBAAU;gBACzB;gBACA;oBACEY,MAAM;oBACNC,MAAM;gBACR;aACD;QACH;KACD;IAED,MAAMS,iBAAmC;QACvChB,MAAMX;QACN4B,QAAQ;YACNC,QAAQ,IAAM;YACdC,QAAQ,IAAM;YACdC,MAAM,IAAM;YACZC,QAAQ,IAAM;QAChB;QACAX,OAAO;YACLY,OAAO;YACPC,QAAQ;QACV;QACAC,YAAY;QACZC,WAAW;YAACtC;YAAiBD;SAA4B;QACzD6B,QAAQ;YACN;gBACET,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLgB,aAAa;gBACf;YACF;YACA;gBACEpB,MAAM;gBACNC,MAAM;gBACNoB,SAAS;YACX;YACA;gBACE,0FAA0F;gBAC1F,6DAA6D;gBAC7DrB,MAAM;gBACNC,MAAM;YACR;YACA;gBACEA,MAAM;gBACNqB,MAAM;oBACJ;wBACEb,QAAQ;4BACN;gCACET,MAAM;gCACNC,MAAM;gCACNsB,OAAO;4BACT;4BACA;gCACEvB,MAAM;gCACNC,MAAM;gCACNuB,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEvB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLgB,aAAa;gCACf;gCACAI,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACEvB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLC,WAAW,CAACE,OAASA,KAAKkB,QAAQ;oCAClCL,aAAa;gCACf;4BACF;4BACA;gCACEpB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLgB,aAAa;gCACf;gCACAX,QAAQV;4BACV;yBACD;wBACD2B,OAAO;oBACT;iBACD;YACH;YACA,0DAA0D;eACrDxC,cAAcyC,IAAI,GAAG,IACtB;gBACE;oBACE3B,MAAM;oBACNC,MAAM;oBACNG,OAAO;wBACLwB,UAAU;oBACZ;oBACAL,OAAO;oBACPpB,SAAS;2BAAIjB;qBAAc;gBAC7B;aACD,GACD,EAAE;YACN;gBACEc,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLwB,UAAU;gBACZ;gBACAL,OAAO;gBACPpB,SAAS;uBAAIf;iBAAU;gBACvBc,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLwB,UAAU;gBACZ;gBACAJ,cAAc;gBACdD,OAAO;YACT;YACA;gBACEvB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLyB,MAAM;wBAAEC,kBAAkB;oBAAa;gBACzC;gBACAP,OAAO;YACT;YACA;gBACEvB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLyB,MAAM;wBAAEC,kBAAkB;oBAAa;oBACvCF,UAAU;gBACZ;gBACAL,OAAO;YACT;YACA;gBACEvB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLa,QAAQ;oBACRc,UAAU;gBACZ;YACF;YACA;gBACE/B,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLgB,aACE;oBACFQ,UAAU;oBACVG,UAAU;gBACZ;gBACAR,OAAO;YACT;SACD;QACDS,OAAO;YACLC,WAAW;gBACT,CAAC,EAAEC,GAAG,EAAEC,GAAG,EAAE;oBACX,4GAA4G;oBAE5G,OAAOC,aAAa;wBAAEC,QAAQF,IAAIG,OAAO,CAACD,MAAM;wBAAEH;oBAAI;gBACxD;aACD;YACD;;;OAGC,GACDK,cAAc;gBACZ,CAAC,EAAEhC,IAAI,EAAEiC,WAAW,EAAE;oBACpB,IAAIA,aAAaC,OAAOC,WAAW;wBACjCnC,KAAKoC,eAAe,GAAG;wBACvBpC,KAAKqC,eAAe,GAAG;wBACvBrC,KAAKkB,QAAQ,GAAG;wBAChB,OAAOlB,KAAKsC,WAAW;wBACvB,OAAOtC,KAAKuC,SAAS;oBACvB;oBACA,OAAOvC;gBACT;aACD;QACH;QACAwC,eAAe;QACfC,UAAU;IACZ;IAEA,OAAOtC;AACT,EAAC;AAED,6DAA6D;AAC7D,OAAO,SAAS0B,aAAa,EAAEC,MAAM,EAAEH,GAAG,EAAyC;IACjFA,IAAIe,UAAU,GAAGnE,iBAAiB;QAChCoE,QAAQhB,IAAIiB,GAAG,IAAI,EAAE;IACvB;IACAjB,IAAIkB,KAAK,GAAGlB,IAAIkB,KAAK,IAAI,CAAC;IAC1B,OAAOlB;AACT"}

package/dist/queues/config/global.d.ts

@@ -1,7 +1,6 @@
-import type { Config } from '../../config/types.js';
 import type { GlobalConfig } from '../../globals/config/types.js';
-import type { TaskType } from './types/taskTypes.js';
-import type { WorkflowTypes } from './types/workflowTypes.js';
+import type { TaskSlug } from './types/taskTypes.js';
+import type { WorkflowSlug } from './types/workflowTypes.js';
 export declare const jobStatsGlobalSlug = "payload-jobs-stats";
 /**
  * Type for data stored in the payload-jobs-stats global.
@@ -12,12 +11,12 @@ export type JobStats = {
             queues?: {
                 [queueSlug: string]: {
                     tasks?: {
-                        [taskSlug: TaskType]: {
+                        [taskSlug: TaskSlug]: {
                             lastScheduledRun: string;
                         };
                     };
                     workflows?: {
-                        [workflowSlug: WorkflowTypes]: {
+                        [workflowSlug: WorkflowSlug]: {
                             lastScheduledRun: string;
                         };
                     };
@@ -29,5 +28,5 @@ export type JobStats = {
 /**
  * Global config for job statistics.
  */
-export declare const getJobStatsGlobal: (config: Config) => GlobalConfig;
+export declare const getJobStatsGlobal: () => GlobalConfig;
 //# sourceMappingURL=global.d.ts.map

package/dist/queues/config/global.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../../src/queues/config/global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D,eAAO,MAAM,kBAAkB,uBAAuB,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,EAAE;QACN,aAAa,CAAC,EAAE;YACd,MAAM,CAAC,EAAE;gBACP,CAAC,SAAS,EAAE,MAAM,GAAG;oBACnB,KAAK,CAAC,EAAE;wBACN,CAAC,QAAQ,EAAE,QAAQ,GAAG;4BACpB,gBAAgB,EAAE,MAAM,CAAA;yBACzB,CAAA;qBACF,CAAA;oBACD,SAAS,CAAC,EAAE;wBACV,CAAC,YAAY,EAAE,aAAa,GAAG;4BAC7B,gBAAgB,EAAE,MAAM,CAAA;yBACzB,CAAA;qBACF,CAAA;iBACF,CAAA;aACF,CAAA;SACF,CAAA;KACF,CAAA;CACF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,YAenD,CAAA"}
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../../src/queues/config/global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5D,eAAO,MAAM,kBAAkB,uBAAuB,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,EAAE;QACN,aAAa,CAAC,EAAE;YACd,MAAM,CAAC,EAAE;gBACP,CAAC,SAAS,EAAE,MAAM,GAAG;oBACnB,KAAK,CAAC,EAAE;wBACN,CAAC,QAAQ,EAAE,QAAQ,GAAG;4BACpB,gBAAgB,EAAE,MAAM,CAAA;yBACzB,CAAA;qBACF,CAAA;oBACD,SAAS,CAAC,EAAE;wBACV,CAAC,YAAY,EAAE,YAAY,GAAG;4BAC5B,gBAAgB,EAAE,MAAM,CAAA;yBACzB,CAAA;qBACF,CAAA;iBACF,CAAA;aACF,CAAA;SACF,CAAA;KACF,CAAA;CACF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,YAgBrC,CAAA"}

package/dist/queues/config/global.js

@@ -1,13 +1,14 @@
 export const jobStatsGlobalSlug = 'payload-jobs-stats';
 /**
  * Global config for job statistics.
- */ export const getJobStatsGlobal = (config)=>{
+ */ export const getJobStatsGlobal = ()=>{
     return {
         slug: jobStatsGlobalSlug,
         admin: {
             group: 'System',
             hidden: true
         },
+        authorship: false,
         fields: [
             {
                 name: 'stats',

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/queues/config/global.ts"],"sourcesContent":["import type { Config } from '../../config/types.js'\nimport type { GlobalConfig } from '../../globals/config/types.js'\nimport type { TaskType } from './types/taskTypes.js'\nimport type { WorkflowTypes } from './types/workflowTypes.js'\n\nexport const jobStatsGlobalSlug = 'payload-jobs-stats'\n\n/**\n * Type for data stored in the payload-jobs-stats global.\n */\nexport type JobStats = {\n  stats?: {\n    scheduledRuns?: {\n      queues?: {\n        [queueSlug: string]: {\n          tasks?: {\n            [taskSlug: TaskType]: {\n              lastScheduledRun: string\n            }\n          }\n          workflows?: {\n            [workflowSlug: WorkflowTypes]: {\n              lastScheduledRun: string\n            }\n          }\n        }\n      }\n    }\n  }\n}\n\n/**\n * Global config for job statistics.\n */\nexport const getJobStatsGlobal: (config: Config) => GlobalConfig = (config) => {\n  return {\n    slug: jobStatsGlobalSlug,\n    admin: {\n      group: 'System',\n      hidden: true,\n    },\n    fields: [\n      {\n        name: 'stats',\n        type: 'json',\n      },\n    ],\n    versions: false,\n  }\n}\n"],"names":["jobStatsGlobalSlug","getJobStatsGlobal","config","slug","admin","group","hidden","fields","name","type","versions"],"mappings":"AAKA,OAAO,MAAMA,qBAAqB,qBAAoB;AA0BtD;;CAEC,GACD,OAAO,MAAMC,oBAAsD,CAACC;IAClE,OAAO;QACLC,MAAMH;QACNI,OAAO;YACLC,OAAO;YACPC,QAAQ;QACV;QACAC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;YACR;SACD;QACDC,UAAU;IACZ;AACF,EAAC"}
+{"version":3,"sources":["../../../src/queues/config/global.ts"],"sourcesContent":["import type { GlobalConfig } from '../../globals/config/types.js'\nimport type { TaskSlug } from './types/taskTypes.js'\nimport type { WorkflowSlug } from './types/workflowTypes.js'\n\nexport const jobStatsGlobalSlug = 'payload-jobs-stats'\n\n/**\n * Type for data stored in the payload-jobs-stats global.\n */\nexport type JobStats = {\n  stats?: {\n    scheduledRuns?: {\n      queues?: {\n        [queueSlug: string]: {\n          tasks?: {\n            [taskSlug: TaskSlug]: {\n              lastScheduledRun: string\n            }\n          }\n          workflows?: {\n            [workflowSlug: WorkflowSlug]: {\n              lastScheduledRun: string\n            }\n          }\n        }\n      }\n    }\n  }\n}\n\n/**\n * Global config for job statistics.\n */\nexport const getJobStatsGlobal: () => GlobalConfig = () => {\n  return {\n    slug: jobStatsGlobalSlug,\n    admin: {\n      group: 'System',\n      hidden: true,\n    },\n    authorship: false,\n    fields: [\n      {\n        name: 'stats',\n        type: 'json',\n      },\n    ],\n    versions: false,\n  }\n}\n"],"names":["jobStatsGlobalSlug","getJobStatsGlobal","slug","admin","group","hidden","authorship","fields","name","type","versions"],"mappings":"AAIA,OAAO,MAAMA,qBAAqB,qBAAoB;AA0BtD;;CAEC,GACD,OAAO,MAAMC,oBAAwC;IACnD,OAAO;QACLC,MAAMF;QACNG,OAAO;YACLC,OAAO;YACPC,QAAQ;QACV;QACAC,YAAY;QACZC,QAAQ;YACN;gBACEC,MAAM;gBACNC,MAAM;YACR;SACD;QACDC,UAAU;IACZ;AACF,EAAC"}

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

@@ -75,6 +75,28 @@ export type CancelJobAccessArgs = {
 };
 export type CancelJobAccess = (args: CancelJobAccessArgs) => MaybePromise<boolean>;
 export type QueueJobAccess = (args: QueueJobAccessArgs) => MaybePromise<boolean>;
+export type ProcessingLeaseConfig = {
+    /**
+     * How long a job remains claimed without a successful lease renewal.
+     * This is not a maximum job runtime; active jobs renew their lease automatically.
+     *
+     * @default 1200000 (20 minutes)
+     */
+    duration?: number;
+    /**
+     * Minimum time that must remain on a lease before a worker **starts** an update. This gives the
+     * update time to finish before another worker can claim the job.
+     *
+     * Set this to `0` if your database adapter applies the ownership check and update atomically.
+     * If the database update itself is not atomic, increase this value, as another worker
+     * may claim the job before the update finishes.
+     *
+     * It must be less than `duration`.
+     *
+     * @default 30000 (30 seconds)
+     */
+    safetyBuffer?: number;
+};
 export type SanitizedJobsConfig = {
     /**
      * If set to `true`, the job system is enabled and a payload-jobs collection exists.
@@ -82,16 +104,17 @@ export type SanitizedJobsConfig = {
      */
     enabled?: boolean;
     /**
-     * If set to `true`, at least one task or workflow has scheduling enabled.
+     * If set to `true`, at least one task or workflow uses concurrency controls.
      * This property is automatically set during sanitization.
      */
-    scheduling?: boolean;
+    hasConcurrency?: boolean;
+    processingLease: Required<ProcessingLeaseConfig>;
     /**
-     * If set to `true`, a payload-job-stats global exists.
+     * If set to `true`, at least one task or workflow has scheduling enabled.
      * This property is automatically set during sanitization.
      */
-    stats?: boolean;
-} & JobsConfig;
+    scheduling?: boolean;
+} & Omit<JobsConfig, 'processingLease'>;
 export type JobsConfig = {
     /**
      * Specify access control to determine who can interact with jobs.
@@ -110,13 +133,6 @@ export type JobsConfig = {
          */
         run?: RunJobAccess;
     };
-    /** Adds information about the parent job to the task log. This is useful for debugging and tracking the flow of tasks.
-     *
-     * In 4.0, this will default to `true`.
-     *
-     * @default false
-     */
-    addParentToTaskLog?: boolean;
     /**
      * Allows you to configure cron jobs that automatically run queued jobs
      * at specified intervals. Note that this does not _queue_ new jobs - only
@@ -129,25 +145,16 @@ export type JobsConfig = {
      * Determine whether or not to delete a job after it has successfully completed.
      */
     deleteJobOnComplete?: boolean;
-    /**
-     * Enable concurrency controls for workflows and tasks.
-     * When enabled, adds a `concurrencyKey` field to the jobs collection schema.
-     * This allows workflows and tasks to use the `concurrency` option to prevent race conditions.
-     *
-     * **Important:** Enabling this may require a database migration depending on your database adapter,
-     * as it adds a new indexed field to the jobs collection schema.
-     *
-     * @default false
-     * @todo In 4.0, this will default to `true`.
-     */
-    enableConcurrencyControl?: boolean;
     /**
      * Override any settings on the default Jobs collection. Accepts the default collection and allows you to return
      * a new collection.
+     *
+     * @experimental
      */
     jobsCollectionOverrides?: (args: {
         defaultJobsCollection: CollectionConfig;
     }) => CollectionConfig;
+    processingLease?: ProcessingLeaseConfig;
     /**
      * Adjust the job processing order using a Payload sort string. This can be set globally or per queue.
      *
@@ -163,7 +170,8 @@ export type JobsConfig = {
     } | Sort;
     /**
      * A function that will be executed before Payload picks up jobs which are configured by the `jobs.autorun` function.
-     * If this function returns true, jobs will be queried and picked up. If it returns false, jobs will not be run.
+     * If this function returns true, jobs will be queried and picked up. If it returns false, jobs will not be run
+     * for that tick. The cron will check again on its next scheduled run.
      * @default undefined - if this function is not defined, jobs will be run - as if () => true was passed.
      * @param payload
      * @returns boolean

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAA;AAC1F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,gBAAgB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAClF,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAEhF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,GAAG,UAAU,CAAA;AACd,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,MAAM,CAAC,EAAE,eAAe,CAAA;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,cAAc,CAAA;QACtB;;WAEG;QACH,GAAG,CAAC,EAAE,YAAY,CAAA;KACnB,CAAA;IACD;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,iBAAiB,EAAE,CAAA;IACzF;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,qBAAqB,EAAE,gBAAgB,CAAA;KAAE,KAAK,gBAAgB,CAAA;IACjG;;;;;;OAMG;IACH,eAAe,CAAC,EACZ,CAAC,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAC7C;QACE,OAAO,CAAC,EAAE,IAAI,CAAA;QACd,MAAM,EAAE;YACN,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;SACtB,CAAA;KACF,GACD,IAAI,CAAA;IACR;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,cAAc,CAAA;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE;IACpC,qBAAqB,EAAE,gBAAgB,CAAA;IACvC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAClB,SAAS,EAAE,SAAS,CAAA;IACpB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,YAAY,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,OAAO,CAAA;IACvB,SAAS,CAAC,EAAE,IAAI,CAAA;CACjB,CAAC,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE;IACJ,oBAAoB,EAAE,eAAe,CAAA;IACrC;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,SAAS,CAAA;IACpB,GAAG,EAAE,cAAc,CAAA;CACpB,GAAG,CACA;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,GAAG,CAAC,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,OAAO,CAAA;CAChB,GACD;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,SAAS,CAAA;CAClB,GACD;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,GAAG,CAAC,EAAE,KAAK,CAAA;IACX;;OAEG;IACH,MAAM,EAAE,SAAS,CAAA;CAClB,CACJ,KACE,YAAY,CAAC,IAAI,CAAC,CAAA;AAEvB,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE;QACN;;;;WAIG;QACH,aAAa,CAAC,EAAE,eAAe,CAAA;QAC/B;;;;;;;;;WASG;QACH,cAAc,CAAC,EAAE,gBAAgB,CAAA;KAClC,CAAA;IACD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAA;AAC1F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,gBAAgB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAE5E,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAClF,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAEhF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAA;IAChD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAA;AACvC,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,MAAM,CAAC,EAAE,eAAe,CAAA;QACxB;;WAEG;QACH,KAAK,CAAC,EAAE,cAAc,CAAA;QACtB;;WAEG;QACH,GAAG,CAAC,EAAE,YAAY,CAAA;KACnB,CAAA;IACD;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,iBAAiB,EAAE,CAAA;IACzF;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,qBAAqB,EAAE,gBAAgB,CAAA;KAAE,KAAK,gBAAgB,CAAA;IACjG,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC;;;;;;OAMG;IACH,eAAe,CAAC,EACZ,CAAC,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAC7C;QACE,OAAO,CAAC,EAAE,IAAI,CAAA;QACd,MAAM,EAAE;YACN,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;SACtB,CAAA;KACF,GACD,IAAI,CAAA;IACR;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAA;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,cAAc,CAAA;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE;IACpC,qBAAqB,EAAE,gBAAgB,CAAA;IACvC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAClB,SAAS,EAAE,SAAS,CAAA;IACpB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,YAAY,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,OAAO,CAAA;IACvB,SAAS,CAAC,EAAE,IAAI,CAAA;CACjB,CAAC,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE;IACJ,oBAAoB,EAAE,eAAe,CAAA;IACrC;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,SAAS,CAAA;IACpB,GAAG,EAAE,cAAc,CAAA;CACpB,GAAG,CACA;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,GAAG,CAAC,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,OAAO,CAAA;CAChB,GACD;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,SAAS,CAAA;CAClB,GACD;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,GAAG,CAAC,EAAE,KAAK,CAAA;IACX;;OAEG;IACH,MAAM,EAAE,SAAS,CAAA;CAClB,CACJ,KACE,YAAY,CAAC,IAAI,CAAC,CAAA;AAEvB,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE;QACN;;;;WAIG;QACH,aAAa,CAAC,EAAE,eAAe,CAAA;QAC/B;;;;;;;;;WASG;QACH,cAAc,CAAC,EAAE,gBAAgB,CAAA;KAClC,CAAA;IACD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/queues/config/types/index.ts"],"sourcesContent":["import type { CollectionConfig, Job } from '../../../index.js'\nimport type { MaybePromise, Payload, PayloadRequest, Sort } from '../../../types/index.js'\nimport type { RunJobsSilent } from '../../localAPI.js'\nimport type { RunJobsArgs } from '../../operations/runJobs/index.js'\nimport type { JobStats } from '../global.js'\nimport type { TaskConfig } from './taskTypes.js'\nimport type { WorkflowConfig } from './workflowTypes.js'\n\nexport type AutorunCronConfig = {\n  /**\n   * If you want to autoRUn jobs from all queues, set this to true.\n   * If you set this to true, the `queue` property will be ignored.\n   *\n   * @default false\n   */\n  allQueues?: boolean\n  /**\n   * The cron schedule for the job.\n   * @default '* * * * *' (every minute).\n   *\n   * @example\n   *     ┌───────────── (optional) second (0 - 59)\n   *     │ ┌───────────── minute (0 - 59)\n   *     │ │ ┌───────────── hour (0 - 23)\n   *     │ │ │ ┌───────────── day of the month (1 - 31)\n   *     │ │ │ │ ┌───────────── month (1 - 12)\n   *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)\n   *     │ │ │ │ │ │\n   *     │ │ │ │ │ │\n   *  - '* 0 * * * *' every hour at minute 0\n   *  - '* 0 0 * * *' daily at midnight\n   *  - '* 0 0 * * 0' weekly at midnight on Sundays\n   *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month\n   *  - '* 0/5 * * * *' every 5 minutes\n   *  - '* * * * * *' every second\n   */\n  cron?: string\n  /**\n   * By default, the autorun will attempt to schedule jobs for tasks and workflows that have a `schedule` property, given\n   * the queue name is the same.\n   *\n   * Set this to `true` to disable the scheduling of jobs automatically.\n   *\n   * @default false\n   */\n  disableScheduling?: boolean\n  /**\n   * The limit for the job. This can be overridden by the user. Defaults to 10.\n   */\n  limit?: number\n  /**\n   * The queue name for the job.\n   *\n   * @default 'default'\n   */\n  queue?: string\n  /**\n   * If set to true, the job system will not log any output to the console (for both info and error logs).\n   * Can be an option for more granular control over logging.\n   *\n   * This will not automatically affect user-configured logs (e.g. if you call `console.log` or `payload.logger.info` in your job code).\n   *\n   * @default false\n   */\n  silent?: RunJobsSilent\n}\n\nexport type RunJobAccessArgs = {\n  req: PayloadRequest\n}\n\nexport type RunJobAccess = (args: RunJobAccessArgs) => MaybePromise<boolean>\n\nexport type QueueJobAccessArgs = {\n  req: PayloadRequest\n}\n\nexport type CancelJobAccessArgs = {\n  req: PayloadRequest\n}\nexport type CancelJobAccess = (args: CancelJobAccessArgs) => MaybePromise<boolean>\nexport type QueueJobAccess = (args: QueueJobAccessArgs) => MaybePromise<boolean>\n\nexport type SanitizedJobsConfig = {\n  /**\n   * If set to `true`, the job system is enabled and a payload-jobs collection exists.\n   * This property is automatically set during sanitization.\n   */\n  enabled?: boolean\n  /**\n   * If set to `true`, at least one task or workflow has scheduling enabled.\n   * This property is automatically set during sanitization.\n   */\n  scheduling?: boolean\n  /**\n   * If set to `true`, a payload-job-stats global exists.\n   * This property is automatically set during sanitization.\n   */\n  stats?: boolean\n} & JobsConfig\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 cancel jobs.\n     */\n    cancel?: CancelJobAccess\n    /**\n     * By default, all logged-in users can queue jobs.\n     */\n    queue?: QueueJobAccess\n    /**\n     * By default, all logged-in users can run jobs.\n     */\n    run?: RunJobAccess\n  }\n  /** Adds information about the parent job to the task log. This is useful for debugging and tracking the flow of tasks.\n   *\n   * In 4.0, this will default to `true`.\n   *\n   * @default false\n   */\n  addParentToTaskLog?: boolean\n  /**\n   * Allows you to configure cron jobs that automatically run queued jobs\n   * at specified intervals. Note that this does not _queue_ new jobs - only\n   * _runs_ jobs that are already in the specified queue.\n   *\n   * @remark this property should not be used on serverless platforms like Vercel\n   */\n  autoRun?: ((payload: Payload) => MaybePromise<AutorunCronConfig[]>) | AutorunCronConfig[]\n  /**\n   * Determine whether or not to delete a job after it has successfully completed.\n   */\n  deleteJobOnComplete?: boolean\n  /**\n   * Enable concurrency controls for workflows and tasks.\n   * When enabled, adds a `concurrencyKey` field to the jobs collection schema.\n   * This allows workflows and tasks to use the `concurrency` option to prevent race conditions.\n   *\n   * **Important:** Enabling this may require a database migration depending on your database adapter,\n   * as it adds a new indexed field to the jobs collection schema.\n   *\n   * @default false\n   * @todo In 4.0, this will default to `true`.\n   */\n  enableConcurrencyControl?: boolean\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   * Adjust the job processing order using a Payload sort string. This can be set globally or per queue.\n   *\n   * FIFO would equal `createdAt` and LIFO would equal `-createdAt`.\n   *\n   * @default all jobs for all queues will be executed in FIFO order.\n   */\n  processingOrder?:\n    | ((args: RunJobsArgs) => Promise<Sort> | Sort)\n    | {\n        default?: Sort\n        queues: {\n          [queue: string]: Sort\n        }\n      }\n    | Sort\n  /**\n   * A function that will be executed before Payload picks up jobs which are configured by the `jobs.autorun` function.\n   * If this function returns true, jobs will be queried and picked up. If it returns false, jobs will not be run.\n   * @default undefined - if this function is not defined, jobs will be run - as if () => true was passed.\n   * @param payload\n   * @returns boolean\n   */\n  shouldAutoRun?: (payload: Payload) => MaybePromise<boolean>\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\nexport type Queueable = {\n  scheduleConfig: ScheduleConfig\n  taskConfig?: TaskConfig\n  // If not set, queue it immediately\n  waitUntil?: Date\n  workflowConfig?: WorkflowConfig\n}\n\nexport type BeforeScheduleFn = (args: {\n  defaultBeforeSchedule: BeforeScheduleFn\n  /**\n   * payload-job-stats global data\n   */\n  jobStats: JobStats\n  queueable: Queueable\n  req: PayloadRequest\n}) => MaybePromise<{\n  input?: object\n  shouldSchedule: boolean\n  waitUntil?: Date\n}>\n\nexport type AfterScheduleFn = (\n  args: {\n    defaultAfterSchedule: AfterScheduleFn\n    /**\n     * payload-job-stats global data. If the global does not exist, it will be null.\n     */\n    jobStats: JobStats | null\n    queueable: Queueable\n    req: PayloadRequest\n  } & (\n    | {\n        error: Error\n        job?: never\n        status: 'error'\n      }\n    | {\n        error?: never\n        job: Job\n        status: 'success'\n      }\n    | {\n        error?: never\n        job?: never\n        /**\n         * If the beforeSchedule hook returned `shouldSchedule: false`, this will be called with status `skipped`.\n         */\n        status: 'skipped'\n      }\n  ),\n) => MaybePromise<void>\n\nexport type ScheduleConfig = {\n  /**\n   * The cron for scheduling the job.\n   *\n   * @example\n   *     ┌───────────── (optional) second (0 - 59)\n   *     │ ┌───────────── minute (0 - 59)\n   *     │ │ ┌───────────── hour (0 - 23)\n   *     │ │ │ ┌───────────── day of the month (1 - 31)\n   *     │ │ │ │ ┌───────────── month (1 - 12)\n   *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)\n   *     │ │ │ │ │ │\n   *     │ │ │ │ │ │\n   *  - '* 0 * * * *' every hour at minute 0\n   *  - '* 0 0 * * *' daily at midnight\n   *  - '* 0 0 * * 0' weekly at midnight on Sundays\n   *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month\n   *  - '* 0/5 * * * *' every 5 minutes\n   *  - '* * * * * *' every second\n   */\n  cron: string\n  hooks?: {\n    /**\n     * Functions that will be executed after the job has been successfully scheduled.\n     *\n     * @default By default, global update?? Unless global update should happen before\n     */\n    afterSchedule?: AfterScheduleFn\n    /**\n     * Functions that will be executed before the job is scheduled.\n     * You can use this to control whether or not the job should be scheduled, or what input\n     * data should be passed to the job.\n     *\n     * @default By default, this has one function that returns { shouldSchedule: true } if the following conditions are met:\n     * - There currently is no job of the same type in the specified queue that is currently running\n     * - There currently is no job of the same type in the specified queue that is scheduled to run in the future\n     * - There currently is no job of the same type in the specified queue that failed previously but can be retried\n     */\n    beforeSchedule?: BeforeScheduleFn\n  }\n  /**\n   * Queue to which the scheduled job will be added.\n   */\n  queue: string\n}\n"],"names":[],"mappings":"AAiPA,WA4CC"}
+{"version":3,"sources":["../../../../src/queues/config/types/index.ts"],"sourcesContent":["import type { CollectionConfig, Job } from '../../../index.js'\nimport type { MaybePromise, Payload, PayloadRequest, Sort } from '../../../types/index.js'\nimport type { RunJobsSilent } from '../../localAPI.js'\nimport type { RunJobsArgs } from '../../operations/runJobs/index.js'\nimport type { JobStats } from '../global.js'\nimport type { TaskConfig } from './taskTypes.js'\nimport type { WorkflowConfig } from './workflowTypes.js'\n\nexport type AutorunCronConfig = {\n  /**\n   * If you want to autoRUn jobs from all queues, set this to true.\n   * If you set this to true, the `queue` property will be ignored.\n   *\n   * @default false\n   */\n  allQueues?: boolean\n  /**\n   * The cron schedule for the job.\n   * @default '* * * * *' (every minute).\n   *\n   * @example\n   *     ┌───────────── (optional) second (0 - 59)\n   *     │ ┌───────────── minute (0 - 59)\n   *     │ │ ┌───────────── hour (0 - 23)\n   *     │ │ │ ┌───────────── day of the month (1 - 31)\n   *     │ │ │ │ ┌───────────── month (1 - 12)\n   *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)\n   *     │ │ │ │ │ │\n   *     │ │ │ │ │ │\n   *  - '* 0 * * * *' every hour at minute 0\n   *  - '* 0 0 * * *' daily at midnight\n   *  - '* 0 0 * * 0' weekly at midnight on Sundays\n   *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month\n   *  - '* 0/5 * * * *' every 5 minutes\n   *  - '* * * * * *' every second\n   */\n  cron?: string\n  /**\n   * By default, the autorun will attempt to schedule jobs for tasks and workflows that have a `schedule` property, given\n   * the queue name is the same.\n   *\n   * Set this to `true` to disable the scheduling of jobs automatically.\n   *\n   * @default false\n   */\n  disableScheduling?: boolean\n  /**\n   * The limit for the job. This can be overridden by the user. Defaults to 10.\n   */\n  limit?: number\n  /**\n   * The queue name for the job.\n   *\n   * @default 'default'\n   */\n  queue?: string\n  /**\n   * If set to true, the job system will not log any output to the console (for both info and error logs).\n   * Can be an option for more granular control over logging.\n   *\n   * This will not automatically affect user-configured logs (e.g. if you call `console.log` or `payload.logger.info` in your job code).\n   *\n   * @default false\n   */\n  silent?: RunJobsSilent\n}\n\nexport type RunJobAccessArgs = {\n  req: PayloadRequest\n}\n\nexport type RunJobAccess = (args: RunJobAccessArgs) => MaybePromise<boolean>\n\nexport type QueueJobAccessArgs = {\n  req: PayloadRequest\n}\n\nexport type CancelJobAccessArgs = {\n  req: PayloadRequest\n}\nexport type CancelJobAccess = (args: CancelJobAccessArgs) => MaybePromise<boolean>\nexport type QueueJobAccess = (args: QueueJobAccessArgs) => MaybePromise<boolean>\n\nexport type ProcessingLeaseConfig = {\n  /**\n   * How long a job remains claimed without a successful lease renewal.\n   * This is not a maximum job runtime; active jobs renew their lease automatically.\n   *\n   * @default 1200000 (20 minutes)\n   */\n  duration?: number\n  /**\n   * Minimum time that must remain on a lease before a worker **starts** an update. This gives the\n   * update time to finish before another worker can claim the job.\n   *\n   * Set this to `0` if your database adapter applies the ownership check and update atomically.\n   * If the database update itself is not atomic, increase this value, as another worker\n   * may claim the job before the update finishes.\n   *\n   * It must be less than `duration`.\n   *\n   * @default 30000 (30 seconds)\n   */\n  safetyBuffer?: number\n}\n\nexport type SanitizedJobsConfig = {\n  /**\n   * If set to `true`, the job system is enabled and a payload-jobs collection exists.\n   * This property is automatically set during sanitization.\n   */\n  enabled?: boolean\n  /**\n   * If set to `true`, at least one task or workflow uses concurrency controls.\n   * This property is automatically set during sanitization.\n   */\n  hasConcurrency?: boolean\n  processingLease: Required<ProcessingLeaseConfig>\n  /**\n   * If set to `true`, at least one task or workflow has scheduling enabled.\n   * This property is automatically set during sanitization.\n   */\n  scheduling?: boolean\n} & Omit<JobsConfig, 'processingLease'>\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 cancel jobs.\n     */\n    cancel?: CancelJobAccess\n    /**\n     * By default, all logged-in users can queue jobs.\n     */\n    queue?: QueueJobAccess\n    /**\n     * By default, all logged-in users can run jobs.\n     */\n    run?: RunJobAccess\n  }\n  /**\n   * Allows you to configure cron jobs that automatically run queued jobs\n   * at specified intervals. Note that this does not _queue_ new jobs - only\n   * _runs_ jobs that are already in the specified queue.\n   *\n   * @remark this property should not be used on serverless platforms like Vercel\n   */\n  autoRun?: ((payload: Payload) => MaybePromise<AutorunCronConfig[]>) | AutorunCronConfig[]\n  /**\n   * Determine whether or not to delete a job after it has successfully completed.\n   */\n  deleteJobOnComplete?: boolean\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   * @experimental\n   */\n  jobsCollectionOverrides?: (args: { defaultJobsCollection: CollectionConfig }) => CollectionConfig\n  processingLease?: ProcessingLeaseConfig\n  /**\n   * Adjust the job processing order using a Payload sort string. This can be set globally or per queue.\n   *\n   * FIFO would equal `createdAt` and LIFO would equal `-createdAt`.\n   *\n   * @default all jobs for all queues will be executed in FIFO order.\n   */\n  processingOrder?:\n    | ((args: RunJobsArgs) => Promise<Sort> | Sort)\n    | {\n        default?: Sort\n        queues: {\n          [queue: string]: Sort\n        }\n      }\n    | Sort\n  /**\n   * A function that will be executed before Payload picks up jobs which are configured by the `jobs.autorun` function.\n   * If this function returns true, jobs will be queried and picked up. If it returns false, jobs will not be run\n   * for that tick. The cron will check again on its next scheduled run.\n   * @default undefined - if this function is not defined, jobs will be run - as if () => true was passed.\n   * @param payload\n   * @returns boolean\n   */\n  shouldAutoRun?: (payload: Payload) => MaybePromise<boolean>\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\nexport type Queueable = {\n  scheduleConfig: ScheduleConfig\n  taskConfig?: TaskConfig\n  // If not set, queue it immediately\n  waitUntil?: Date\n  workflowConfig?: WorkflowConfig\n}\n\nexport type BeforeScheduleFn = (args: {\n  defaultBeforeSchedule: BeforeScheduleFn\n  /**\n   * payload-job-stats global data\n   */\n  jobStats: JobStats\n  queueable: Queueable\n  req: PayloadRequest\n}) => MaybePromise<{\n  input?: object\n  shouldSchedule: boolean\n  waitUntil?: Date\n}>\n\nexport type AfterScheduleFn = (\n  args: {\n    defaultAfterSchedule: AfterScheduleFn\n    /**\n     * payload-job-stats global data. If the global does not exist, it will be null.\n     */\n    jobStats: JobStats | null\n    queueable: Queueable\n    req: PayloadRequest\n  } & (\n    | {\n        error: Error\n        job?: never\n        status: 'error'\n      }\n    | {\n        error?: never\n        job: Job\n        status: 'success'\n      }\n    | {\n        error?: never\n        job?: never\n        /**\n         * If the beforeSchedule hook returned `shouldSchedule: false`, this will be called with status `skipped`.\n         */\n        status: 'skipped'\n      }\n  ),\n) => MaybePromise<void>\n\nexport type ScheduleConfig = {\n  /**\n   * The cron for scheduling the job.\n   *\n   * @example\n   *     ┌───────────── (optional) second (0 - 59)\n   *     │ ┌───────────── minute (0 - 59)\n   *     │ │ ┌───────────── hour (0 - 23)\n   *     │ │ │ ┌───────────── day of the month (1 - 31)\n   *     │ │ │ │ ┌───────────── month (1 - 12)\n   *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)\n   *     │ │ │ │ │ │\n   *     │ │ │ │ │ │\n   *  - '* 0 * * * *' every hour at minute 0\n   *  - '* 0 0 * * *' daily at midnight\n   *  - '* 0 0 * * 0' weekly at midnight on Sundays\n   *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month\n   *  - '* 0/5 * * * *' every 5 minutes\n   *  - '* * * * * *' every second\n   */\n  cron: string\n  hooks?: {\n    /**\n     * Functions that will be executed after the job has been successfully scheduled.\n     *\n     * @default By default, global update?? Unless global update should happen before\n     */\n    afterSchedule?: AfterScheduleFn\n    /**\n     * Functions that will be executed before the job is scheduled.\n     * You can use this to control whether or not the job should be scheduled, or what input\n     * data should be passed to the job.\n     *\n     * @default By default, this has one function that returns { shouldSchedule: true } if the following conditions are met:\n     * - There currently is no job of the same type in the specified queue that is currently running\n     * - There currently is no job of the same type in the specified queue that is scheduled to run in the future\n     * - There currently is no job of the same type in the specified queue that failed previously but can be retried\n     */\n    beforeSchedule?: BeforeScheduleFn\n  }\n  /**\n   * Queue to which the scheduled job will be added.\n   */\n  queue: string\n}\n"],"names":[],"mappings":"AA0PA,WA4CC"}

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

@@ -21,15 +21,12 @@ export type TaskHandlerArgs<TTaskSlugOrInputOutput extends keyof TypedJobs['task
 /**
  * Inline tasks in JSON workflows have no input, as they can just get the input from job.taskStatus
  */
-export type TaskHandlerArgsNoInput<TWorkflowInput extends false | object = false> = {
-    job: Job<TWorkflowInput>;
+export type TaskHandlerArgsNoInput<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object> = {
+    job: Job<TWorkflowSlugOrInput>;
     req: PayloadRequest;
 };
 export type TaskHandler<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput, TWorkflowSlug extends keyof TypedJobs['workflows'] = string> = (args: TaskHandlerArgs<TTaskSlugOrInputOutput, TWorkflowSlug>) => MaybePromise<TaskHandlerResult<TTaskSlugOrInputOutput>>;
-/**
- * @todo rename to TaskSlug in 4.0, similar to CollectionSlug
- */
-export type TaskType = StringKeyOf<TypedJobs['tasks']>;
+export type TaskSlug = 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 = {
@@ -140,7 +137,7 @@ export type RetryConfig = {
      */
     shouldRestore?: boolean | ShouldRestoreFn;
 };
-export type TaskConfig<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskType> = {
+export type TaskConfig<TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskSlug> = {
     /**
      * Job concurrency controls for preventing race conditions.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"taskTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/taskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,GAAG,EACH,YAAY,EACZ,cAAc,EACd,WAAW,EACX,SAAS,EACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE7E,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;CACZ,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;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAA;IACjC,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,GAAG,CAAC,aAAa,CAAC,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,gBAAgB,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,cAAc,SAAS,KAAK,GAAG,MAAM,GAAG,KAAK,IAAI;IAClF,GAAG,EAAE,GAAG,CAAC,cAAc,CAAC,CAAA;IACxB,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,YAAY,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAE5D;;GAEG;AACH,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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;CAC3C,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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;IAE1C,IAAI,EAAE,CAAC,IAAI,EAAE;QACX,UAAU,EAAE,qBAAqB,CAAA;QACjC,KAAK,EAAE,UAAU,CAAA;QACjB,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;QACb,GAAG,EAAE,cAAc,CAAA;QACnB,KAAK,EAAE,gBAAgB,CAAA;KACxB,KAAK,YAAY,CAAC;QACjB,MAAM,EAAE,WAAW,CAAA;KACpB,CAAC,CAAA;CACH,KACE,OAAO,CAAC,WAAW,CAAC,CAAA;AAEzB,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,GAAG,EAAE,cAAc,CAAA;IACnB,UAAU,EAAE,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE;IAAE,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,KAClF,YAAY,CAAC,OAAO,CAAC,CAAA;AAC1B,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAA;AAE3E,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,IAAI,EAAE,aAAa,GAAG,OAAO,CAAA;KAC9B,CAAA;IACD;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,GAAG,QAAQ,IAClF;IACF;;;;;OAKG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAC7B,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GACnD,SAAS,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,GACnD,sBAAsB,SAAS,eAAe,GAC5C,sBAAsB,CAAC,OAAO,CAAC,GAC/B,MAAM,CACb,CAAA;IACD;;;;;;;OAOG;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,cAAc,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,EAAE,CAAA;IACtB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B;;OAEG;IACH,IAAI,EAAE,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,sBAAsB,GAAG,MAAM,CAAA;CAChG,CAAA"}
+{"version":3,"file":"taskTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/taskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,GAAG,EACH,YAAY,EACZ,cAAc,EACd,WAAW,EACX,SAAS,EACV,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE7E,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;CACZ,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;;OAEG;IACH,UAAU,EAAE,qBAAqB,CAAA;IACjC,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,GAAG,CAAC,aAAa,CAAC,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,gBAAgB,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAChC,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,MAAM,IACzE;IACF,GAAG,EAAE,GAAG,CAAC,oBAAoB,CAAC,CAAA;IAC9B,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,YAAY,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,CAAA;AAE5D,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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;CAC3C,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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;IAE1C,IAAI,EAAE,CAAC,IAAI,EAAE;QACX,UAAU,EAAE,qBAAqB,CAAA;QACjC,KAAK,EAAE,UAAU,CAAA;QACjB,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;QACb,GAAG,EAAE,cAAc,CAAA;QACnB,KAAK,EAAE,gBAAgB,CAAA;KACxB,KAAK,YAAY,CAAC;QACjB,MAAM,EAAE,WAAW,CAAA;KACpB,CAAC,CAAA;CACH,KACE,OAAO,CAAC,WAAW,CAAC,CAAA;AAEzB,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,GAAG,EAAE,cAAc,CAAA;IACnB,UAAU,EAAE,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE;IAAE,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,KAClF,YAAY,CAAC,OAAO,CAAC,CAAA;AAC1B,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAA;AAE3E,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,IAAI,EAAE,aAAa,GAAG,OAAO,CAAA;KAC9B,CAAA;IACD;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,UAAU,CACpB,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,GAAG,QAAQ,IAClF;IACF;;;;;OAKG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAC7B,sBAAsB,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,GACnD,SAAS,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC,GACnD,sBAAsB,SAAS,eAAe,GAC5C,sBAAsB,CAAC,OAAO,CAAC,GAC/B,MAAM,CACb,CAAA;IACD;;;;;;;OAOG;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,cAAc,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,EAAE,CAAA;IACtB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B;;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.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/queues/config/types/taskTypes.ts"],"sourcesContent":["import type {\n  Field,\n  Job,\n  MaybePromise,\n  PayloadRequest,\n  StringKeyOf,\n  TypedJobs,\n} from '../../../index.js'\nimport type { ScheduleConfig } from './index.js'\nimport type { ConcurrencyConfig, SingleTaskStatus } 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}\n\nexport type TaskHandlerArgs<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput,\n  TWorkflowSlug extends keyof TypedJobs['workflows'] = string,\n> = {\n  /**\n   * Use this function to run a sub-task from within another task.\n   */\n  inlineTask: RunInlineTaskFunction\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: Job<TWorkflowSlug>\n  req: PayloadRequest\n  tasks: RunTaskFunctions\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 false | object = false> = {\n  job: Job<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) => MaybePromise<TaskHandlerResult<TTaskSlugOrInputOutput>>\n\n/**\n * @todo rename to TaskSlug in 4.0, similar to CollectionSlug\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  /**\n   * Specify the number of times that this task should be retried if it fails for any reason.\n   * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n   * If this is 0, the task will not be retried.\n   *\n   * @default By default, tasks are not retried and `retries` is `undefined`.\n   */\n  retries?: number | RetryConfig | undefined\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    /**\n     * Specify the number of times that this task should be retried if it fails for any reason.\n     * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n     * If this is 0, the task will not be retried.\n     *\n     * @default By default, tasks are not retried and `retries` is `undefined`.\n     */\n    retries?: number | RetryConfig | undefined\n    // This is the same as TaskHandler, but typed out explicitly in order to improve type inference\n    task: (args: {\n      inlineTask: RunInlineTaskFunction\n      input: TTaskInput\n      job: Job<any>\n      req: PayloadRequest\n      tasks: RunTaskFunctions\n    }) => MaybePromise<{\n      output: TTaskOutput\n    }>\n  },\n) => Promise<TTaskOutput>\n\nexport type TaskCallbackArgs = {\n  /**\n   * Input data passed to the task\n   */\n  input?: object\n  job: Job\n  req: PayloadRequest\n  taskStatus: null | SingleTaskStatus<string>\n}\n\nexport type ShouldRestoreFn = (\n  args: { taskStatus: SingleTaskStatus<string> } & Omit<TaskCallbackArgs, 'taskStatus'>,\n) => MaybePromise<boolean>\nexport type TaskCallbackFn = (args: TaskCallbackArgs) => MaybePromise<void>\n\nexport type RetryConfig = {\n  /**\n   * This controls how many times the task should be retried if it fails.\n   *\n   * @default undefined - attempts are either inherited from the workflow retry config or set to 0.\n   */\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   * This controls whether the task output should be restored if the task previously succeeded and the workflow is being retried.\n   *\n   * If this is set to false, the task will be re-run even if it previously succeeded, ignoring the maximum number of retries.\n   *\n   * If this is set to true, the task will only be re-run if it previously failed.\n   *\n   * If this is a function, the return value of the function will determine whether the task should be re-run. This can be used for more complex restore logic,\n   * e.g you may want to re-run a task up until a certain point and then restore it, or only re-run a task if the input has changed.\n   *\n   * @default true - the task output will be restored if the task previously succeeded.\n   */\n  shouldRestore?: boolean | ShouldRestoreFn\n}\n\nexport type TaskConfig<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskType,\n> = {\n  /**\n   * Job concurrency controls for preventing race conditions.\n   *\n   * Can be an object with full options, or a shorthand function that just returns the key\n   * (in which case exclusive defaults to true).\n   */\n  concurrency?: ConcurrencyConfig<\n    TTaskSlugOrInputOutput extends keyof TypedJobs['tasks']\n      ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['input']\n      : TTaskSlugOrInputOutput extends TaskInputOutput\n        ? TTaskSlugOrInputOutput['input']\n        : object\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. Passing a string path is an advanced feature\n   * that may require a sophisticated build pipeline in order to work.\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?: TaskCallbackFn\n  /**\n   * Function to be executed if the task succeeds.\n   */\n  onSuccess?: TaskCallbackFn\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   * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n   * If this is 0, the task will not be retried.\n   *\n   * @default By default, tasks are not retried and `retries` is `undefined`.\n   */\n  retries?: number | RetryConfig | undefined\n  /**\n   * Allows automatically scheduling this task to run regularly at a specified interval.\n   */\n  schedule?: ScheduleConfig[]\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":"AAgMA,WAiEC"}
+{"version":3,"sources":["../../../../src/queues/config/types/taskTypes.ts"],"sourcesContent":["import type {\n  Field,\n  Job,\n  MaybePromise,\n  PayloadRequest,\n  StringKeyOf,\n  TypedJobs,\n} from '../../../index.js'\nimport type { ScheduleConfig } from './index.js'\nimport type { ConcurrencyConfig, SingleTaskStatus } 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}\n\nexport type TaskHandlerArgs<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput,\n  TWorkflowSlug extends keyof TypedJobs['workflows'] = string,\n> = {\n  /**\n   * Use this function to run a sub-task from within another task.\n   */\n  inlineTask: RunInlineTaskFunction\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: Job<TWorkflowSlug>\n  req: PayloadRequest\n  tasks: RunTaskFunctions\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<\n  TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object,\n> = {\n  job: Job<TWorkflowSlugOrInput>\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) => MaybePromise<TaskHandlerResult<TTaskSlugOrInputOutput>>\n\nexport type TaskSlug = 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  /**\n   * Specify the number of times that this task should be retried if it fails for any reason.\n   * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n   * If this is 0, the task will not be retried.\n   *\n   * @default By default, tasks are not retried and `retries` is `undefined`.\n   */\n  retries?: number | RetryConfig | undefined\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    /**\n     * Specify the number of times that this task should be retried if it fails for any reason.\n     * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n     * If this is 0, the task will not be retried.\n     *\n     * @default By default, tasks are not retried and `retries` is `undefined`.\n     */\n    retries?: number | RetryConfig | undefined\n    // This is the same as TaskHandler, but typed out explicitly in order to improve type inference\n    task: (args: {\n      inlineTask: RunInlineTaskFunction\n      input: TTaskInput\n      job: Job<any>\n      req: PayloadRequest\n      tasks: RunTaskFunctions\n    }) => MaybePromise<{\n      output: TTaskOutput\n    }>\n  },\n) => Promise<TTaskOutput>\n\nexport type TaskCallbackArgs = {\n  /**\n   * Input data passed to the task\n   */\n  input?: object\n  job: Job\n  req: PayloadRequest\n  taskStatus: null | SingleTaskStatus<string>\n}\n\nexport type ShouldRestoreFn = (\n  args: { taskStatus: SingleTaskStatus<string> } & Omit<TaskCallbackArgs, 'taskStatus'>,\n) => MaybePromise<boolean>\nexport type TaskCallbackFn = (args: TaskCallbackArgs) => MaybePromise<void>\n\nexport type RetryConfig = {\n  /**\n   * This controls how many times the task should be retried if it fails.\n   *\n   * @default undefined - attempts are either inherited from the workflow retry config or set to 0.\n   */\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   * This controls whether the task output should be restored if the task previously succeeded and the workflow is being retried.\n   *\n   * If this is set to false, the task will be re-run even if it previously succeeded, ignoring the maximum number of retries.\n   *\n   * If this is set to true, the task will only be re-run if it previously failed.\n   *\n   * If this is a function, the return value of the function will determine whether the task should be re-run. This can be used for more complex restore logic,\n   * e.g you may want to re-run a task up until a certain point and then restore it, or only re-run a task if the input has changed.\n   *\n   * @default true - the task output will be restored if the task previously succeeded.\n   */\n  shouldRestore?: boolean | ShouldRestoreFn\n}\n\nexport type TaskConfig<\n  TTaskSlugOrInputOutput extends keyof TypedJobs['tasks'] | TaskInputOutput = TaskSlug,\n> = {\n  /**\n   * Job concurrency controls for preventing race conditions.\n   *\n   * Can be an object with full options, or a shorthand function that just returns the key\n   * (in which case exclusive defaults to true).\n   */\n  concurrency?: ConcurrencyConfig<\n    TTaskSlugOrInputOutput extends keyof TypedJobs['tasks']\n      ? TypedJobs['tasks'][TTaskSlugOrInputOutput]['input']\n      : TTaskSlugOrInputOutput extends TaskInputOutput\n        ? TTaskSlugOrInputOutput['input']\n        : object\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. Passing a string path is an advanced feature\n   * that may require a sophisticated build pipeline in order to work.\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?: TaskCallbackFn\n  /**\n   * Function to be executed if the task succeeds.\n   */\n  onSuccess?: TaskCallbackFn\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   * If this is undefined, the task will either inherit the retries from the workflow or have no retries.\n   * If this is 0, the task will not be retried.\n   *\n   * @default By default, tasks are not retried and `retries` is `undefined`.\n   */\n  retries?: number | RetryConfig | undefined\n  /**\n   * Allows automatically scheduling this task to run regularly at a specified interval.\n   */\n  schedule?: ScheduleConfig[]\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+LA,WAiEC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"workflowJSONTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC1E,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,KAAK,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,KAAK,IAChE;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,GAAG,CAAC,aAAa,CAAC,CAAA;KAAE,KAAK,OAAO,CAAA;IAC1D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC/B,GAAG,CACA;IACE,UAAU,CAAC,EAAE,CACX,IAAI,EAAE,aAAa,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GACpD,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,GACtE,sBAAsB,KACvB,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAA;CAC1E,GACD;IACE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,GAAG,CAAC,aAAa,CAAC,CAAA;KAAE,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAA;IACpF,IAAI,EAAE,SAAS,CAAA;CAChB,CACJ,CAAA;AAED,KAAK,gBAAgB,CAAC,aAAa,SAAS,KAAK,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,KAAK,IAAI;KACzF,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,KAAK,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,KAAK,IACzF,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAA"}
+{"version":3,"file":"workflowJSONTypes.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,KAAK,EACV,WAAW,EACX,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EAChB,MAAM,gBAAgB,CAAA;AAEvB,MAAM,MAAM,YAAY,CACtB,SAAS,SAAS,MAAM,SAAS,CAAC,OAAO,CAAC,EAC1C,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,MAAM,IACzE;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,GAAG,CAAC,oBAAoB,CAAC,CAAA;KAAE,KAAK,OAAO,CAAA;IACjE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;CAC/B,GAAG,CACA;IACE,UAAU,EAAE,CACV,IAAI,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,KAC/C,YAAY,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAA;CACtD,GACD;IACE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,GAAG,CAAC,oBAAoB,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,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,MAAM,IAC/F;KACG,SAAS,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,oBAAoB,CAAC;CACvF,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;AAE7B,MAAM,MAAM,YAAY,CACtB,oBAAoB,SAAS,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,MAAM,GAAG,MAAM,IACzE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"sourcesContent":["import type { Job, 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 false | keyof TypedJobs['workflows'] = false,\n> = {\n  /**\n   * If this step is completed, the workflow will be marked as completed\n   */\n  completesJob?: boolean\n  condition?: (args: { job: Job<TWorkflowSlug> }) => boolean\n  /**\n   * Each task needs to have a unique ID to track its status\n   */\n  id: string\n  /**\n   * Specify the number of times that this workflow should be retried if it fails for any reason.\n   *\n   * @default By default, workflows are not retried and `retries` is `0`.\n   */\n  retries?: number | RetryConfig\n} & (\n  | {\n      inlineTask?: (\n        args: TWorkflowSlug extends keyof TypedJobs['workflows']\n          ? TaskHandlerArgsNoInput<TypedJobs['workflows'][TWorkflowSlug]['input']>\n          : TaskHandlerArgsNoInput,\n      ) => Promise<TaskHandlerResult<TTaskSlug>> | TaskHandlerResult<TTaskSlug>\n    }\n  | {\n      input: (args: { job: Job<TWorkflowSlug> }) => TypedJobs['tasks'][TTaskSlug]['input']\n      task: TTaskSlug\n    }\n)\n\ntype AllWorkflowSteps<TWorkflowSlug extends false | keyof TypedJobs['workflows'] = false> = {\n  [TTaskSlug in keyof TypedJobs['tasks']]: WorkflowStep<TTaskSlug, TWorkflowSlug>\n}[keyof TypedJobs['tasks']]\n\nexport type WorkflowJSON<TWorkflowSlug extends false | keyof TypedJobs['workflows'] = false> =\n  Array<AllWorkflowSteps<TWorkflowSlug>>\n"],"names":[],"mappings":"AAwCA,WACwC"}
+{"version":3,"sources":["../../../../src/queues/config/types/workflowJSONTypes.ts"],"sourcesContent":["import type { Job, TypedJobs } from '../../../index.js'\nimport type { MaybePromise } from '../../../types/index.js'\nimport type {\n  RetryConfig,\n  TaskHandlerArgsNoInput,\n  TaskHandlerResult,\n  TaskInputOutput,\n} from './taskTypes.js'\n\nexport type WorkflowStep<\n  TTaskSlug extends keyof TypedJobs['tasks'],\n  TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object,\n> = {\n  /**\n   * If this step is completed, the workflow will be marked as completed\n   */\n  completesJob?: boolean\n  condition?: (args: { job: Job<TWorkflowSlugOrInput> }) => boolean\n  /**\n   * Each task needs to have a unique ID to track its status\n   */\n  id: string\n  /**\n   * Specify the number of times that this workflow should be retried if it fails for any reason.\n   *\n   * @default By default, workflows are not retried and `retries` is `0`.\n   */\n  retries?: number | RetryConfig\n} & (\n  | {\n      inlineTask: (\n        args: TaskHandlerArgsNoInput<TWorkflowSlugOrInput>,\n      ) => MaybePromise<TaskHandlerResult<TaskInputOutput>>\n    }\n  | {\n      input: (args: { job: Job<TWorkflowSlugOrInput> }) => TypedJobs['tasks'][TTaskSlug]['input']\n      task: TTaskSlug\n    }\n)\n\ntype AllWorkflowSteps<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object> =\n  {\n    [TTaskSlug in keyof TypedJobs['tasks']]: WorkflowStep<TTaskSlug, TWorkflowSlugOrInput>\n  }[keyof TypedJobs['tasks']]\n\nexport type WorkflowJSON<\n  TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object,\n> = Array<AllWorkflowSteps<TWorkflowSlugOrInput>>\n"],"names":[],"mappings":"AA6CA,WAEiD"}

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

@@ -2,7 +2,7 @@ import type { Field } from '../../../fields/config/types.js';
 import type { Job, MaybePromise, PayloadRequest, StringKeyOf, TypedCollection, TypedJobs } from '../../../index.js';
 import type { TaskParent } from '../../operations/runJobs/runJob/getRunTaskFunction.js';
 import type { ScheduleConfig } from './index.js';
-import type { RetryConfig, RunInlineTaskFunction, RunTaskFunctions, TaskInput, TaskOutput, TaskType } from './taskTypes.js';
+import type { RetryConfig, RunInlineTaskFunction, RunTaskFunctions, TaskInput, TaskOutput, TaskSlug } from './taskTypes.js';
 import type { WorkflowJSON } from './workflowJSONTypes.js';
 export type JobLog = {
     completedAt: string;
@@ -12,7 +12,7 @@ export type JobLog = {
      * ID added by the array field when the log is saved in the database
      */
     id: string;
-    input?: Record<string, any>;
+    input: Record<string, any>;
     output?: Record<string, any>;
     /**
      * Sub-tasks (tasks that are run within a task) will have a parent task ID
@@ -20,60 +20,13 @@ export type JobLog = {
     parent?: TaskParent;
     state: 'failed' | 'succeeded';
     taskID: string;
-    taskSlug: TaskType;
+    taskSlug: TaskSlug;
 };
-/**
- * @deprecated - will be made private in 4.0. Please use the `Job` type instead.
- */
-export type BaseJob<TWorkflowSlugOrInput extends false | keyof TypedJobs['workflows'] | object = false> = {
-    completedAt?: null | string;
-    /**
-     * Used for concurrency control. Jobs with the same key are subject to exclusive/supersedes rules.
-     */
-    concurrencyKey?: null | string;
-    createdAt: string;
-    error?: unknown;
-    hasError?: boolean;
-    id: number | string;
-    input: TWorkflowSlugOrInput extends false ? object : TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TypedJobs['workflows'][TWorkflowSlugOrInput]['input'] : TWorkflowSlugOrInput;
-    log?: JobLog[];
-    meta?: {
-        [key: string]: unknown;
-        /**
-         * If true, this job was queued by the scheduling system.
-         */
-        scheduled?: boolean;
-    };
-    processing?: boolean;
-    queue?: string;
-    taskSlug?: null | TaskType;
-    taskStatus: JobTaskStatus;
-    totalTried: number;
-    updatedAt: string;
-    waitUntil?: null | string;
-    workflowSlug?: null | WorkflowTypes;
-};
-/**
- * @todo rename to WorkflowSlug in 4.0, similar to CollectionSlug
- */
-export type WorkflowTypes = StringKeyOf<TypedJobs['workflows']>;
-/**
- * @deprecated - will be removed in 4.0. Use `Job` type instead.
- */
-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'>;
-/**
- * @deprecated - will be removed in 4.0. Use `Job` type instead.
- */
-export type RunningJobSimple<TWorkflowInput extends object> = {
-    input: TWorkflowInput;
-} & TypedCollection['payload-jobs'];
-export type RunningJobFromTask<TTaskSlug extends keyof TypedJobs['tasks']> = {
+export type WorkflowSlug = StringKeyOf<TypedJobs['workflows']>;
+export type JobFromTask<TTaskSlug extends keyof TypedJobs['tasks']> = {
     input: TypedJobs['tasks'][TTaskSlug]['input'];
 } & TypedCollection['payload-jobs'];
-export type WorkflowHandler<TWorkflowSlugOrInput extends false | keyof TypedJobs['workflows'] | object = false> = (args: {
+export type WorkflowHandler<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object> = (args: {
     inlineTask: RunInlineTaskFunction;
     job: Job<TWorkflowSlugOrInput>;
     req: PayloadRequest;
@@ -83,14 +36,14 @@ export type SingleTaskStatus<T extends keyof TypedJobs['tasks']> = {
     complete: boolean;
     input: TaskInput<T>;
     output: TaskOutput<T>;
-    taskSlug: TaskType;
+    taskSlug: TaskSlug;
     totalTried: number;
 };
 /**
  * Task IDs mapped to their status
  */
 export type JobTaskStatus = {
-    [taskSlug in TaskType]: {
+    [taskSlug in TaskSlug]: {
         [taskID: string]: SingleTaskStatus<taskSlug>;
     };
 };
@@ -125,14 +78,14 @@ export type ConcurrencyConfig<TInput = object> = ((args: {
      */
     supersedes?: boolean;
 };
-export type WorkflowConfig<TWorkflowSlugOrInput extends false | keyof TypedJobs['workflows'] | object = false> = {
+export type WorkflowConfig<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] | object = object> = {
     /**
      * Job concurrency controls for preventing race conditions.
      *
      * Can be an object with full options, or a shorthand function that just returns the key
      * (in which case exclusive defaults to true).
      */
-    concurrency?: ConcurrencyConfig<TWorkflowSlugOrInput extends false ? object : TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TypedJobs['workflows'][TWorkflowSlugOrInput]['input'] : TWorkflowSlugOrInput>;
+    concurrency?: ConcurrencyConfig<TWorkflowSlugOrInput extends keyof TypedJobs['workflows'] ? TypedJobs['workflows'][TWorkflowSlugOrInput]['input'] : TWorkflowSlugOrInput>;
     /**
      * You can either pass a string-based path to the workflow function file, or the workflow function itself.
      *
@@ -140,7 +93,7 @@ export type WorkflowConfig<TWorkflowSlugOrInput extends false | keyof TypedJobs[
      * because that will avoid bundling large dependencies in your Next.js app. Passing a string path is an advanced feature
      * that may require a sophisticated build pipeline in order to work.
      */
-    handler: string | WorkflowHandler<TWorkflowSlugOrInput> | WorkflowJSON<TWorkflowSlugOrInput extends object ? string : TWorkflowSlugOrInput>;
+    handler: string | WorkflowHandler<TWorkflowSlugOrInput> | WorkflowJSON<TWorkflowSlugOrInput>;
     /**
      * Define the input field schema  - payload will generate a type for this schema.
      */