payload 3.89.0-internal.95c9cba → 3.90.0

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

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/queues/config/collection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAE5D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAMzC,eAAO,MAAM,kBAAkB,iBAAiB,CAAA;AAEhD,eAAO,MAAM,wBAAwB,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,gBAuR/E,CAAA;AAGD,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,GAAG,EAAE,GAAG,CAAA;CAAE,GAAG,GAAG,CAMxF"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/queues/config/collection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAE5D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAMzC,eAAO,MAAM,kBAAkB,iBAAiB,CAAA;AAEhD,eAAO,MAAM,wBAAwB,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,gBA6R/E,CAAA;AAGD,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,GAAG,EAAE,GAAG,CAAA;CAAE,GAAG,GAAG,CAMxF"}

package/dist/queues/config/collection.js

@@ -101,6 +101,12 @@ export const getDefaultJobsCollection = (jobsConfig)=>{
     }
     const jobsCollection = {
         slug: jobsCollectionSlug,
+        access: {
+            create: ()=>false,
+            delete: ()=>false,
+            read: ()=>false,
+            update: ()=>false
+        },
         admin: {
             group: 'System',
             hidden: true

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  }\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","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;IACjB;IAEA,IAAI3D,WAAW4D,KAAK,EAAE;QACpB,iDAAiD;QACjD,6GAA6G;QAC7G,kFAAkF;QAClF/B,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,IAAIc,UAAU,GAAGhE,iBAAiB;QAChCiE,QAAQf,IAAIgB,GAAG,IAAI,EAAE;IACvB;IACAhB,IAAIiB,KAAK,GAAGjB,IAAIiB,KAAK,IAAI,CAAC;IAC1B,OAAOjB;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      // 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    access: {\n      create: () => false,\n      delete: () => false,\n      read: () => false,\n      update: () => false,\n    },\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  }\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","access","create","delete","read","update","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","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;QACNgC,QAAQ;YACNC,QAAQ,IAAM;YACdC,QAAQ,IAAM;YACdC,MAAM,IAAM;YACZC,QAAQ,IAAM;QAChB;QACAb,OAAO;YACLc,OAAO;YACPC,QAAQ;QACV;QACAC,WAAW;YAACzC;YAAiBD;SAA4B;QACzDiC,QAAQ;YACN;gBACEX,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLiB,aAAa;gBACf;YACF;YACA;gBACErB,MAAM;gBACNC,MAAM;gBACNqB,SAAS;YACX;YACA;gBACErB,MAAM;gBACNsB,MAAM;oBACJ;wBACEZ,QAAQ;4BACN;gCACEX,MAAM;gCACNC,MAAM;gCACNuB,OAAO;4BACT;4BACA;gCACExB,MAAM;gCACNC,MAAM;gCACNwB,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACExB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLiB,aAAa;gCACf;gCACAI,cAAc;gCACdD,OAAO;4BACT;4BACA;gCACExB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLC,WAAW,CAACE,OAASA,KAAKmB,QAAQ;oCAClCL,aAAa;gCACf;4BACF;4BACA;gCACErB,MAAM;gCACNC,MAAM;gCACNG,OAAO;oCACLiB,aAAa;gCACf;gCACAV,QAAQZ;4BACV;yBACD;wBACD4B,OAAO;oBACT;iBACD;YACH;YACA,0DAA0D;eACrD3C,cAAc4C,IAAI,GAAG,IACtB;gBACE;oBACE5B,MAAM;oBACNC,MAAM;oBACNG,OAAO;wBACLyB,UAAU;oBACZ;oBACAL,OAAO;oBACPrB,SAAS;2BAAInB;qBAAc;gBAC7B;aACD,GACD,EAAE;YACN;gBACEgB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLyB,UAAU;gBACZ;gBACAL,OAAO;gBACPrB,SAAS;uBAAIjB;iBAAU;gBACvBgB,UAAU;YACZ;YACA;gBACEF,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLyB,UAAU;gBACZ;gBACAJ,cAAc;gBACdD,OAAO;YACT;YACA;gBACExB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACL0B,MAAM;wBAAEC,kBAAkB;oBAAa;gBACzC;gBACAP,OAAO;YACT;YACA;gBACExB,MAAM;gBACNC,MAAM;gBACNG,OAAO;oBACLyB,UAAU;gBACZ;gBACAJ,cAAc;gBACdD,OAAO;YACT;YACA,kEAAkE;eAC9DzC,WAAWW,wBAAwB,GACnC;gBACE;oBACEM,MAAM;oBACNC,MAAM;oBACNG,OAAO;wBACLiB,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,EAAEjC,IAAI,EAAEkC,WAAW,EAAE;oBACpB,IAAIA,aAAaC,OAAOC,WAAW;wBACjCpC,KAAKqC,UAAU,GAAG;wBAClBrC,KAAKmB,QAAQ,GAAG;wBAChB,OAAOnB,KAAKsC,WAAW;wBACvB,OAAOtC,KAAKuC,SAAS;oBACvB;oBACA,OAAOvC;gBACT;aACD;QACH;QACAwC,eAAe;IACjB;IAEA,IAAIhE,WAAWiE,KAAK,EAAE;QACpB,iDAAiD;QACjD,6GAA6G;QAC7G,kFAAkF;QAClFpC,eAAeD,MAAM,CAACD,IAAI,CAAC;YACzBV,MAAM;YACNC,MAAM;QACR;IACF;IACA,OAAOW;AACT,EAAC;AAED,6DAA6D;AAC7D,OAAO,SAASyB,aAAa,EAAEC,MAAM,EAAEH,GAAG,EAAyC;IACjFA,IAAIc,UAAU,GAAGrE,iBAAiB;QAChCsE,QAAQf,IAAIgB,GAAG,IAAI,EAAE;IACvB;IACAhB,IAAIiB,KAAK,GAAGjB,IAAIiB,KAAK,IAAI,CAAC;IAC1B,OAAOjB;AACT"}

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

@@ -155,6 +155,8 @@ export type JobsConfig = {
     /**
      * 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;
@@ -184,7 +186,8 @@ export type JobsConfig = {
     runHooks?: boolean;
     /**
      * 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;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;;;;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;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;;;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,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;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;;;OAKG;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;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;;;;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   * Specify depth for retrieving jobs from the queue.\n   * This should be as low as possible in order for job retrieval\n   * to be as efficient as possible. Setting it to anything higher than\n   * 0 will drastically affect performance, as less efficient database\n   * queries will be used.\n   *\n   * @default 0\n   * @deprecated - this will be removed in 4.0\n   */\n  depth?: number\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   * By default, the job system uses direct database calls for optimal performance.\n   * If you added custom hooks to your jobs collection, you can set this to true to\n   * use the standard Payload API for all job operations. This is discouraged, as it will\n   * drastically affect performance.\n   *\n   * @default false\n   * @deprecated - this will be removed in 4.0\n   */\n  runHooks?: boolean\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":"AAsQA,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 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   * Specify depth for retrieving jobs from the queue.\n   * This should be as low as possible in order for job retrieval\n   * to be as efficient as possible. Setting it to anything higher than\n   * 0 will drastically affect performance, as less efficient database\n   * queries will be used.\n   *\n   * @default 0\n   * @deprecated - this will be removed in 4.0\n   */\n  depth?: number\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   * @experimental\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   * By default, the job system uses direct database calls for optimal performance.\n   * If you added custom hooks to your jobs collection, you can set this to true to\n   * use the standard Payload API for all job operations. This is discouraged, as it will\n   * drastically affect performance.\n   *\n   * @default false\n   * @deprecated - this will be removed in 4.0\n   */\n  runHooks?: boolean\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":"AAyQA,WA4CC"}

package/dist/queues/endpoints/handleSchedules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handleSchedules.d.ts","sourceRoot":"","sources":["../../../src/queues/endpoints/handleSchedules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAKrD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,QA8DzC,CAAA"}
+{"version":3,"file":"handleSchedules.d.ts","sourceRoot":"","sources":["../../../src/queues/endpoints/handleSchedules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAMrD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,QA8DzC,CAAA"}

package/dist/queues/endpoints/handleSchedules.js

@@ -1,3 +1,4 @@
+import { defaultAccess } from '../../auth/defaultAccess.js';
 import { handleSchedules } from '../operations/handleSchedules/index.js';
 import { configHasJobs } from './run.js';
 /**
@@ -14,7 +15,7 @@ import { configHasJobs } from './run.js';
                 status: 200
             });
         }
-        const accessFn = jobsConfig.access?.run ?? (()=>true);
+        const accessFn = jobsConfig.access?.run ?? defaultAccess;
         const hasAccess = await accessFn({
             req
         });

package/dist/queues/endpoints/handleSchedules.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/queues/endpoints/handleSchedules.ts"],"sourcesContent":["import type { Endpoint } from '../../config/types.js'\n\nimport { handleSchedules } from '../operations/handleSchedules/index.js'\nimport { configHasJobs } from './run.js'\n\n/**\n * GET /api/payload-jobs/handle-schedules endpoint\n *\n * This endpoint is GET instead of POST to allow it to be used in a Vercel Cron.\n */\nexport const handleSchedulesJobsEndpoint: Endpoint = {\n  handler: async (req) => {\n    const jobsConfig = req.payload.config.jobs\n\n    if (!configHasJobs(jobsConfig)) {\n      return Response.json(\n        {\n          message: 'No jobs to schedule.',\n        },\n        { status: 200 },\n      )\n    }\n\n    const accessFn = jobsConfig.access?.run ?? (() => true)\n\n    const hasAccess = await accessFn({ req })\n\n    if (!hasAccess) {\n      return Response.json(\n        {\n          message: req.i18n.t('error:unauthorized'),\n        },\n        { status: 401 },\n      )\n    }\n\n    if (!jobsConfig.scheduling) {\n      // There is no reason to call the handleSchedules endpoint if the stats global is not enabled (= no schedules defined)\n      return Response.json(\n        {\n          message:\n            'Cannot handle schedules because no tasks or workflows with schedules are defined.',\n        },\n        { status: 500 },\n      )\n    }\n\n    const { allQueues, queue } = req.query as {\n      allQueues?: 'false' | 'true'\n      queue?: string\n    }\n\n    const runAllQueues = allQueues && !(typeof allQueues === 'string' && allQueues === 'false')\n\n    const { errored, queued, skipped } = await handleSchedules({\n      allQueues: runAllQueues,\n      queue,\n      req,\n    })\n\n    return Response.json(\n      {\n        errored,\n        message: req.i18n.t('general:success'),\n        queued,\n        skipped,\n      },\n      { status: 200 },\n    )\n  },\n  method: 'get',\n  path: '/handle-schedules',\n}\n"],"names":["handleSchedules","configHasJobs","handleSchedulesJobsEndpoint","handler","req","jobsConfig","payload","config","jobs","Response","json","message","status","accessFn","access","run","hasAccess","i18n","t","scheduling","allQueues","queue","query","runAllQueues","errored","queued","skipped","method","path"],"mappings":"AAEA,SAASA,eAAe,QAAQ,yCAAwC;AACxE,SAASC,aAAa,QAAQ,WAAU;AAExC;;;;CAIC,GACD,OAAO,MAAMC,8BAAwC;IACnDC,SAAS,OAAOC;QACd,MAAMC,aAAaD,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI;QAE1C,IAAI,CAACP,cAAcI,aAAa;YAC9B,OAAOI,SAASC,IAAI,CAClB;gBACEC,SAAS;YACX,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMC,WAAWR,WAAWS,MAAM,EAAEC,OAAQ,CAAA,IAAM,IAAG;QAErD,MAAMC,YAAY,MAAMH,SAAS;YAAET;QAAI;QAEvC,IAAI,CAACY,WAAW;YACd,OAAOP,SAASC,IAAI,CAClB;gBACEC,SAASP,IAAIa,IAAI,CAACC,CAAC,CAAC;YACtB,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,IAAI,CAACP,WAAWc,UAAU,EAAE;YAC1B,sHAAsH;YACtH,OAAOV,SAASC,IAAI,CAClB;gBACEC,SACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAM,EAAEQ,SAAS,EAAEC,KAAK,EAAE,GAAGjB,IAAIkB,KAAK;QAKtC,MAAMC,eAAeH,aAAa,CAAE,CAAA,OAAOA,cAAc,YAAYA,cAAc,OAAM;QAEzF,MAAM,EAAEI,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAM1B,gBAAgB;YACzDoB,WAAWG;YACXF;YACAjB;QACF;QAEA,OAAOK,SAASC,IAAI,CAClB;YACEc;YACAb,SAASP,IAAIa,IAAI,CAACC,CAAC,CAAC;YACpBO;YACAC;QACF,GACA;YAAEd,QAAQ;QAAI;IAElB;IACAe,QAAQ;IACRC,MAAM;AACR,EAAC"}
+{"version":3,"sources":["../../../src/queues/endpoints/handleSchedules.ts"],"sourcesContent":["import type { Endpoint } from '../../config/types.js'\n\nimport { defaultAccess } from '../../auth/defaultAccess.js'\nimport { handleSchedules } from '../operations/handleSchedules/index.js'\nimport { configHasJobs } from './run.js'\n\n/**\n * GET /api/payload-jobs/handle-schedules endpoint\n *\n * This endpoint is GET instead of POST to allow it to be used in a Vercel Cron.\n */\nexport const handleSchedulesJobsEndpoint: Endpoint = {\n  handler: async (req) => {\n    const jobsConfig = req.payload.config.jobs\n\n    if (!configHasJobs(jobsConfig)) {\n      return Response.json(\n        {\n          message: 'No jobs to schedule.',\n        },\n        { status: 200 },\n      )\n    }\n\n    const accessFn = jobsConfig.access?.run ?? defaultAccess\n\n    const hasAccess = await accessFn({ req })\n\n    if (!hasAccess) {\n      return Response.json(\n        {\n          message: req.i18n.t('error:unauthorized'),\n        },\n        { status: 401 },\n      )\n    }\n\n    if (!jobsConfig.scheduling) {\n      // There is no reason to call the handleSchedules endpoint if the stats global is not enabled (= no schedules defined)\n      return Response.json(\n        {\n          message:\n            'Cannot handle schedules because no tasks or workflows with schedules are defined.',\n        },\n        { status: 500 },\n      )\n    }\n\n    const { allQueues, queue } = req.query as {\n      allQueues?: 'false' | 'true'\n      queue?: string\n    }\n\n    const runAllQueues = allQueues && !(typeof allQueues === 'string' && allQueues === 'false')\n\n    const { errored, queued, skipped } = await handleSchedules({\n      allQueues: runAllQueues,\n      queue,\n      req,\n    })\n\n    return Response.json(\n      {\n        errored,\n        message: req.i18n.t('general:success'),\n        queued,\n        skipped,\n      },\n      { status: 200 },\n    )\n  },\n  method: 'get',\n  path: '/handle-schedules',\n}\n"],"names":["defaultAccess","handleSchedules","configHasJobs","handleSchedulesJobsEndpoint","handler","req","jobsConfig","payload","config","jobs","Response","json","message","status","accessFn","access","run","hasAccess","i18n","t","scheduling","allQueues","queue","query","runAllQueues","errored","queued","skipped","method","path"],"mappings":"AAEA,SAASA,aAAa,QAAQ,8BAA6B;AAC3D,SAASC,eAAe,QAAQ,yCAAwC;AACxE,SAASC,aAAa,QAAQ,WAAU;AAExC;;;;CAIC,GACD,OAAO,MAAMC,8BAAwC;IACnDC,SAAS,OAAOC;QACd,MAAMC,aAAaD,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI;QAE1C,IAAI,CAACP,cAAcI,aAAa;YAC9B,OAAOI,SAASC,IAAI,CAClB;gBACEC,SAAS;YACX,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMC,WAAWR,WAAWS,MAAM,EAAEC,OAAOhB;QAE3C,MAAMiB,YAAY,MAAMH,SAAS;YAAET;QAAI;QAEvC,IAAI,CAACY,WAAW;YACd,OAAOP,SAASC,IAAI,CAClB;gBACEC,SAASP,IAAIa,IAAI,CAACC,CAAC,CAAC;YACtB,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,IAAI,CAACP,WAAWc,UAAU,EAAE;YAC1B,sHAAsH;YACtH,OAAOV,SAASC,IAAI,CAClB;gBACEC,SACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAM,EAAEQ,SAAS,EAAEC,KAAK,EAAE,GAAGjB,IAAIkB,KAAK;QAKtC,MAAMC,eAAeH,aAAa,CAAE,CAAA,OAAOA,cAAc,YAAYA,cAAc,OAAM;QAEzF,MAAM,EAAEI,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAM1B,gBAAgB;YACzDoB,WAAWG;YACXF;YACAjB;QACF;QAEA,OAAOK,SAASC,IAAI,CAClB;YACEc;YACAb,SAASP,IAAIa,IAAI,CAACC,CAAC,CAAC;YACpBO;YACAC;QACF,GACA;YAAEd,QAAQ;QAAI;IAElB;IACAe,QAAQ;IACRC,MAAM;AACR,EAAC"}

package/dist/queues/endpoints/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/queues/endpoints/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAInE;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,QAmG7B,CAAA;AAED,eAAO,MAAM,aAAa,eAAgB,mBAAmB,KAAG,OAE/D,CAAA"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/queues/endpoints/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAKnE;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,QAmG7B,CAAA;AAED,eAAO,MAAM,aAAa,eAAgB,mBAAmB,KAAG,OAE/D,CAAA"}

package/dist/queues/endpoints/run.js

@@ -1,3 +1,4 @@
+import { defaultAccess } from '../../auth/defaultAccess.js';
 import { runJobs } from '../operations/runJobs/index.js';
 /**
  * /api/payload-jobs/run endpoint
@@ -13,7 +14,7 @@ import { runJobs } from '../operations/runJobs/index.js';
                 status: 200
             });
         }
-        const accessFn = jobsConfig.access?.run ?? (()=>true);
+        const accessFn = jobsConfig.access?.run ?? defaultAccess;
         const hasAccess = await accessFn({
             req
         });

package/dist/queues/endpoints/run.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/queues/endpoints/run.ts"],"sourcesContent":["import type { Endpoint } from '../../config/types.js'\nimport type { SanitizedJobsConfig } from '../config/types/index.js'\n\nimport { runJobs, type RunJobsArgs } from '../operations/runJobs/index.js'\n\n/**\n * /api/payload-jobs/run endpoint\n *\n * This endpoint is GET instead of POST to allow it to be used in a Vercel Cron.\n */\nexport const runJobsEndpoint: Endpoint = {\n  handler: async (req) => {\n    const jobsConfig = req.payload.config.jobs\n\n    if (!configHasJobs(jobsConfig)) {\n      return Response.json(\n        {\n          message: 'No jobs to run.',\n        },\n        { status: 200 },\n      )\n    }\n\n    const accessFn = jobsConfig.access?.run ?? (() => true)\n\n    const hasAccess = await accessFn({ req })\n\n    if (!hasAccess) {\n      return Response.json(\n        {\n          message: req.i18n.t('error:unauthorized'),\n        },\n        { status: 401 },\n      )\n    }\n\n    const {\n      allQueues,\n      disableScheduling: disableSchedulingParam,\n      limit,\n      queue,\n      silent: silentParam,\n    } = req.query as {\n      allQueues?: 'false' | 'true'\n      disableScheduling?: 'false' | 'true'\n      limit?: number\n      queue?: string\n      silent?: string\n    }\n\n    const silent = silentParam === 'true'\n\n    const shouldHandleSchedules = disableSchedulingParam !== 'true'\n\n    const runAllQueues = allQueues && !(typeof allQueues === 'string' && allQueues === 'false')\n\n    if (shouldHandleSchedules && jobsConfig.scheduling) {\n      // If should handle schedules and schedules are defined\n      await req.payload.jobs.handleSchedules({ allQueues: runAllQueues, queue, req })\n    }\n\n    const runJobsArgs: RunJobsArgs = {\n      queue,\n      req,\n      // Access is validated above, so it's safe to override here\n      allQueues: runAllQueues,\n      overrideAccess: true,\n      silent,\n    }\n\n    const parsedLimit = Number(limit)\n    if (!isNaN(parsedLimit)) {\n      runJobsArgs.limit = parsedLimit\n    }\n\n    let noJobsRemaining = false\n    let remainingJobsFromQueried = 0\n    try {\n      const result = await runJobs(runJobsArgs)\n      noJobsRemaining = !!result.noJobsRemaining\n      remainingJobsFromQueried = result.remainingJobsFromQueried\n    } catch (err) {\n      req.payload.logger.error({\n        err,\n        msg: 'There was an error running jobs:',\n        queue: runJobsArgs.queue,\n      })\n\n      return Response.json(\n        {\n          message: req.i18n.t('error:unknown'),\n          noJobsRemaining: true,\n          remainingJobsFromQueried,\n        },\n        { status: 500 },\n      )\n    }\n\n    return Response.json(\n      {\n        message: req.i18n.t('general:success'),\n        noJobsRemaining,\n        remainingJobsFromQueried,\n      },\n      { status: 200 },\n    )\n  },\n  method: 'get',\n  path: '/run',\n}\n\nexport const configHasJobs = (jobsConfig: SanitizedJobsConfig): boolean => {\n  return Boolean(jobsConfig.tasks?.length || jobsConfig.workflows?.length)\n}\n"],"names":["runJobs","runJobsEndpoint","handler","req","jobsConfig","payload","config","jobs","configHasJobs","Response","json","message","status","accessFn","access","run","hasAccess","i18n","t","allQueues","disableScheduling","disableSchedulingParam","limit","queue","silent","silentParam","query","shouldHandleSchedules","runAllQueues","scheduling","handleSchedules","runJobsArgs","overrideAccess","parsedLimit","Number","isNaN","noJobsRemaining","remainingJobsFromQueried","result","err","logger","error","msg","method","path","Boolean","tasks","length","workflows"],"mappings":"AAGA,SAASA,OAAO,QAA0B,iCAAgC;AAE1E;;;;CAIC,GACD,OAAO,MAAMC,kBAA4B;IACvCC,SAAS,OAAOC;QACd,MAAMC,aAAaD,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI;QAE1C,IAAI,CAACC,cAAcJ,aAAa;YAC9B,OAAOK,SAASC,IAAI,CAClB;gBACEC,SAAS;YACX,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMC,WAAWT,WAAWU,MAAM,EAAEC,OAAQ,CAAA,IAAM,IAAG;QAErD,MAAMC,YAAY,MAAMH,SAAS;YAAEV;QAAI;QAEvC,IAAI,CAACa,WAAW;YACd,OAAOP,SAASC,IAAI,CAClB;gBACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;YACtB,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,MAAM,EACJO,SAAS,EACTC,mBAAmBC,sBAAsB,EACzCC,KAAK,EACLC,KAAK,EACLC,QAAQC,WAAW,EACpB,GAAGtB,IAAIuB,KAAK;QAQb,MAAMF,SAASC,gBAAgB;QAE/B,MAAME,wBAAwBN,2BAA2B;QAEzD,MAAMO,eAAeT,aAAa,CAAE,CAAA,OAAOA,cAAc,YAAYA,cAAc,OAAM;QAEzF,IAAIQ,yBAAyBvB,WAAWyB,UAAU,EAAE;YAClD,uDAAuD;YACvD,MAAM1B,IAAIE,OAAO,CAACE,IAAI,CAACuB,eAAe,CAAC;gBAAEX,WAAWS;gBAAcL;gBAAOpB;YAAI;QAC/E;QAEA,MAAM4B,cAA2B;YAC/BR;YACApB;YACA,2DAA2D;YAC3DgB,WAAWS;YACXI,gBAAgB;YAChBR;QACF;QAEA,MAAMS,cAAcC,OAAOZ;QAC3B,IAAI,CAACa,MAAMF,cAAc;YACvBF,YAAYT,KAAK,GAAGW;QACtB;QAEA,IAAIG,kBAAkB;QACtB,IAAIC,2BAA2B;QAC/B,IAAI;YACF,MAAMC,SAAS,MAAMtC,QAAQ+B;YAC7BK,kBAAkB,CAAC,CAACE,OAAOF,eAAe;YAC1CC,2BAA2BC,OAAOD,wBAAwB;QAC5D,EAAE,OAAOE,KAAK;YACZpC,IAAIE,OAAO,CAACmC,MAAM,CAACC,KAAK,CAAC;gBACvBF;gBACAG,KAAK;gBACLnB,OAAOQ,YAAYR,KAAK;YAC1B;YAEA,OAAOd,SAASC,IAAI,CAClB;gBACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;gBACpBkB,iBAAiB;gBACjBC;YACF,GACA;gBAAEzB,QAAQ;YAAI;QAElB;QAEA,OAAOH,SAASC,IAAI,CAClB;YACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;YACpBkB;YACAC;QACF,GACA;YAAEzB,QAAQ;QAAI;IAElB;IACA+B,QAAQ;IACRC,MAAM;AACR,EAAC;AAED,OAAO,MAAMpC,gBAAgB,CAACJ;IAC5B,OAAOyC,QAAQzC,WAAW0C,KAAK,EAAEC,UAAU3C,WAAW4C,SAAS,EAAED;AACnE,EAAC"}
+{"version":3,"sources":["../../../src/queues/endpoints/run.ts"],"sourcesContent":["import type { Endpoint } from '../../config/types.js'\nimport type { SanitizedJobsConfig } from '../config/types/index.js'\n\nimport { defaultAccess } from '../../auth/defaultAccess.js'\nimport { runJobs, type RunJobsArgs } from '../operations/runJobs/index.js'\n\n/**\n * /api/payload-jobs/run endpoint\n *\n * This endpoint is GET instead of POST to allow it to be used in a Vercel Cron.\n */\nexport const runJobsEndpoint: Endpoint = {\n  handler: async (req) => {\n    const jobsConfig = req.payload.config.jobs\n\n    if (!configHasJobs(jobsConfig)) {\n      return Response.json(\n        {\n          message: 'No jobs to run.',\n        },\n        { status: 200 },\n      )\n    }\n\n    const accessFn = jobsConfig.access?.run ?? defaultAccess\n\n    const hasAccess = await accessFn({ req })\n\n    if (!hasAccess) {\n      return Response.json(\n        {\n          message: req.i18n.t('error:unauthorized'),\n        },\n        { status: 401 },\n      )\n    }\n\n    const {\n      allQueues,\n      disableScheduling: disableSchedulingParam,\n      limit,\n      queue,\n      silent: silentParam,\n    } = req.query as {\n      allQueues?: 'false' | 'true'\n      disableScheduling?: 'false' | 'true'\n      limit?: number\n      queue?: string\n      silent?: string\n    }\n\n    const silent = silentParam === 'true'\n\n    const shouldHandleSchedules = disableSchedulingParam !== 'true'\n\n    const runAllQueues = allQueues && !(typeof allQueues === 'string' && allQueues === 'false')\n\n    if (shouldHandleSchedules && jobsConfig.scheduling) {\n      // If should handle schedules and schedules are defined\n      await req.payload.jobs.handleSchedules({ allQueues: runAllQueues, queue, req })\n    }\n\n    const runJobsArgs: RunJobsArgs = {\n      queue,\n      req,\n      // Access is validated above, so it's safe to override here\n      allQueues: runAllQueues,\n      overrideAccess: true,\n      silent,\n    }\n\n    const parsedLimit = Number(limit)\n    if (!isNaN(parsedLimit)) {\n      runJobsArgs.limit = parsedLimit\n    }\n\n    let noJobsRemaining = false\n    let remainingJobsFromQueried = 0\n    try {\n      const result = await runJobs(runJobsArgs)\n      noJobsRemaining = !!result.noJobsRemaining\n      remainingJobsFromQueried = result.remainingJobsFromQueried\n    } catch (err) {\n      req.payload.logger.error({\n        err,\n        msg: 'There was an error running jobs:',\n        queue: runJobsArgs.queue,\n      })\n\n      return Response.json(\n        {\n          message: req.i18n.t('error:unknown'),\n          noJobsRemaining: true,\n          remainingJobsFromQueried,\n        },\n        { status: 500 },\n      )\n    }\n\n    return Response.json(\n      {\n        message: req.i18n.t('general:success'),\n        noJobsRemaining,\n        remainingJobsFromQueried,\n      },\n      { status: 200 },\n    )\n  },\n  method: 'get',\n  path: '/run',\n}\n\nexport const configHasJobs = (jobsConfig: SanitizedJobsConfig): boolean => {\n  return Boolean(jobsConfig.tasks?.length || jobsConfig.workflows?.length)\n}\n"],"names":["defaultAccess","runJobs","runJobsEndpoint","handler","req","jobsConfig","payload","config","jobs","configHasJobs","Response","json","message","status","accessFn","access","run","hasAccess","i18n","t","allQueues","disableScheduling","disableSchedulingParam","limit","queue","silent","silentParam","query","shouldHandleSchedules","runAllQueues","scheduling","handleSchedules","runJobsArgs","overrideAccess","parsedLimit","Number","isNaN","noJobsRemaining","remainingJobsFromQueried","result","err","logger","error","msg","method","path","Boolean","tasks","length","workflows"],"mappings":"AAGA,SAASA,aAAa,QAAQ,8BAA6B;AAC3D,SAASC,OAAO,QAA0B,iCAAgC;AAE1E;;;;CAIC,GACD,OAAO,MAAMC,kBAA4B;IACvCC,SAAS,OAAOC;QACd,MAAMC,aAAaD,IAAIE,OAAO,CAACC,MAAM,CAACC,IAAI;QAE1C,IAAI,CAACC,cAAcJ,aAAa;YAC9B,OAAOK,SAASC,IAAI,CAClB;gBACEC,SAAS;YACX,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMC,WAAWT,WAAWU,MAAM,EAAEC,OAAOhB;QAE3C,MAAMiB,YAAY,MAAMH,SAAS;YAAEV;QAAI;QAEvC,IAAI,CAACa,WAAW;YACd,OAAOP,SAASC,IAAI,CAClB;gBACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;YACtB,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,MAAM,EACJO,SAAS,EACTC,mBAAmBC,sBAAsB,EACzCC,KAAK,EACLC,KAAK,EACLC,QAAQC,WAAW,EACpB,GAAGtB,IAAIuB,KAAK;QAQb,MAAMF,SAASC,gBAAgB;QAE/B,MAAME,wBAAwBN,2BAA2B;QAEzD,MAAMO,eAAeT,aAAa,CAAE,CAAA,OAAOA,cAAc,YAAYA,cAAc,OAAM;QAEzF,IAAIQ,yBAAyBvB,WAAWyB,UAAU,EAAE;YAClD,uDAAuD;YACvD,MAAM1B,IAAIE,OAAO,CAACE,IAAI,CAACuB,eAAe,CAAC;gBAAEX,WAAWS;gBAAcL;gBAAOpB;YAAI;QAC/E;QAEA,MAAM4B,cAA2B;YAC/BR;YACApB;YACA,2DAA2D;YAC3DgB,WAAWS;YACXI,gBAAgB;YAChBR;QACF;QAEA,MAAMS,cAAcC,OAAOZ;QAC3B,IAAI,CAACa,MAAMF,cAAc;YACvBF,YAAYT,KAAK,GAAGW;QACtB;QAEA,IAAIG,kBAAkB;QACtB,IAAIC,2BAA2B;QAC/B,IAAI;YACF,MAAMC,SAAS,MAAMtC,QAAQ+B;YAC7BK,kBAAkB,CAAC,CAACE,OAAOF,eAAe;YAC1CC,2BAA2BC,OAAOD,wBAAwB;QAC5D,EAAE,OAAOE,KAAK;YACZpC,IAAIE,OAAO,CAACmC,MAAM,CAACC,KAAK,CAAC;gBACvBF;gBACAG,KAAK;gBACLnB,OAAOQ,YAAYR,KAAK;YAC1B;YAEA,OAAOd,SAASC,IAAI,CAClB;gBACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;gBACpBkB,iBAAiB;gBACjBC;YACF,GACA;gBAAEzB,QAAQ;YAAI;QAElB;QAEA,OAAOH,SAASC,IAAI,CAClB;YACEC,SAASR,IAAIc,IAAI,CAACC,CAAC,CAAC;YACpBkB;YACAC;QACF,GACA;YAAEzB,QAAQ;QAAI;IAElB;IACA+B,QAAQ;IACRC,MAAM;AACR,EAAC;AAED,OAAO,MAAMpC,gBAAgB,CAACJ;IAC5B,OAAOyC,QAAQzC,WAAW0C,KAAK,EAAEC,UAAU3C,WAAW4C,SAAS,EAAED;AACnE,EAAC"}

package/dist/uploads/assertClientUploadAccess.d.ts

@@ -0,0 +1,7 @@
+import type { PayloadRequest } from '../types/index.js';
+/** Checks collection write permissions before an adapter grants access to upload file bytes. */
+export declare const assertClientUploadAccess: ({ collectionSlug, req, }: {
+    collectionSlug: string;
+    req: PayloadRequest;
+}) => Promise<void>;
+//# sourceMappingURL=assertClientUploadAccess.d.ts.map

package/dist/uploads/assertClientUploadAccess.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertClientUploadAccess.d.ts","sourceRoot":"","sources":["../../src/uploads/assertClientUploadAccess.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAKvD,gGAAgG;AAChG,eAAO,MAAM,wBAAwB,6BAGlC;IACD,cAAc,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,OAAO,CAAC,IAAI,CA4Bf,CAAA"}

package/dist/uploads/assertClientUploadAccess.js

@@ -0,0 +1,27 @@
+import { executeAccess } from '../auth/executeAccess.js';
+import { Forbidden } from '../errors/Forbidden.js';
+/** Checks collection write permissions before an adapter grants access to upload file bytes. */ export const assertClientUploadAccess = async ({ collectionSlug, req })=>{
+    if (!req.user) {
+        throw new Forbidden(req.t);
+    }
+    const collectionConfig = req.payload.collections[collectionSlug]?.config;
+    if (!collectionConfig) {
+        throw new Forbidden(req.t);
+    }
+    const canCreate = await executeAccess({
+        disableErrors: true,
+        req
+    }, collectionConfig.access.create);
+    if (canCreate) {
+        return;
+    }
+    const canUpdate = await executeAccess({
+        disableErrors: true,
+        req
+    }, collectionConfig.access.update);
+    if (!canUpdate) {
+        throw new Forbidden(req.t);
+    }
+};
+
+//# sourceMappingURL=assertClientUploadAccess.js.map

package/dist/uploads/assertClientUploadAccess.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/uploads/assertClientUploadAccess.ts"],"sourcesContent":["import type { PayloadRequest } from '../types/index.js'\n\nimport { executeAccess } from '../auth/executeAccess.js'\nimport { Forbidden } from '../errors/Forbidden.js'\n\n/** Checks collection write permissions before an adapter grants access to upload file bytes. */\nexport const assertClientUploadAccess = async ({\n  collectionSlug,\n  req,\n}: {\n  collectionSlug: string\n  req: PayloadRequest\n}): Promise<void> => {\n  if (!req.user) {\n    throw new Forbidden(req.t)\n  }\n\n  const collectionConfig = req.payload.collections[collectionSlug]?.config\n\n  if (!collectionConfig) {\n    throw new Forbidden(req.t)\n  }\n\n  const canCreate = await executeAccess(\n    { disableErrors: true, req },\n    collectionConfig.access.create,\n  )\n\n  if (canCreate) {\n    return\n  }\n\n  const canUpdate = await executeAccess(\n    { disableErrors: true, req },\n    collectionConfig.access.update,\n  )\n\n  if (!canUpdate) {\n    throw new Forbidden(req.t)\n  }\n}\n"],"names":["executeAccess","Forbidden","assertClientUploadAccess","collectionSlug","req","user","t","collectionConfig","payload","collections","config","canCreate","disableErrors","access","create","canUpdate","update"],"mappings":"AAEA,SAASA,aAAa,QAAQ,2BAA0B;AACxD,SAASC,SAAS,QAAQ,yBAAwB;AAElD,8FAA8F,GAC9F,OAAO,MAAMC,2BAA2B,OAAO,EAC7CC,cAAc,EACdC,GAAG,EAIJ;IACC,IAAI,CAACA,IAAIC,IAAI,EAAE;QACb,MAAM,IAAIJ,UAAUG,IAAIE,CAAC;IAC3B;IAEA,MAAMC,mBAAmBH,IAAII,OAAO,CAACC,WAAW,CAACN,eAAe,EAAEO;IAElE,IAAI,CAACH,kBAAkB;QACrB,MAAM,IAAIN,UAAUG,IAAIE,CAAC;IAC3B;IAEA,MAAMK,YAAY,MAAMX,cACtB;QAAEY,eAAe;QAAMR;IAAI,GAC3BG,iBAAiBM,MAAM,CAACC,MAAM;IAGhC,IAAIH,WAAW;QACb;IACF;IAEA,MAAMI,YAAY,MAAMf,cACtB;QAAEY,eAAe;QAAMR;IAAI,GAC3BG,iBAAiBM,MAAM,CAACG,MAAM;IAGhC,IAAI,CAACD,WAAW;QACd,MAAM,IAAId,UAAUG,IAAIE,CAAC;IAC3B;AACF,EAAC"}

package/dist/uploads/assertClientUploadAllowed.d.ts

@@ -0,0 +1,11 @@
+export declare const assertClientUploadFileSize: (filesize: unknown) => void;
+export declare const assertClientUploadAllowed: ({ collection, filename, mimeType, }: {
+    collection?: {
+        upload?: {
+            allowRestrictedFileTypes?: boolean;
+        } | boolean;
+    };
+    filename: unknown;
+    mimeType?: unknown;
+}) => void;
+//# sourceMappingURL=assertClientUploadAllowed.d.ts.map

package/dist/uploads/assertClientUploadAllowed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertClientUploadAllowed.d.ts","sourceRoot":"","sources":["../../src/uploads/assertClientUploadAllowed.ts"],"names":[],"mappings":"AA4BA,eAAO,MAAM,0BAA0B,aAAc,OAAO,SAI3D,CAAA;AAED,eAAO,MAAM,yBAAyB,wCAInC;IACD,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE;YAAE,wBAAwB,CAAC,EAAE,OAAO,CAAA;SAAE,GAAG,OAAO,CAAA;KAC1D,CAAA;IACD,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,KAAG,IA+BH,CAAA"}

package/dist/uploads/assertClientUploadAllowed.js

@@ -0,0 +1,46 @@
+import { APIError } from '../errors/APIError.js';
+import { getSanitizedUploadFilename, uploadRequiresServerValidation } from './getFileTypeIdentity.js';
+const MIME_TYPE_PATTERN = /^[!#$%&'*+.^`|~\w-]+\/[!#$%&'*+.^`|~\w-]+$/;
+const isValidMimeType = (mimeType)=>{
+    if (typeof mimeType !== 'string' || mimeType.length === 0 || mimeType !== mimeType.trim() || [
+        ...mimeType
+    ].some((character)=>{
+        const codePoint = character.codePointAt(0);
+        return codePoint !== undefined && (codePoint <= 0x1f || codePoint === 0x7f);
+    })) {
+        return false;
+    }
+    const [essence, ...parameters] = mimeType.split(';');
+    return MIME_TYPE_PATTERN.test(essence ?? '') && parameters.every((parameter)=>parameter.trim().length > 0);
+};
+export const assertClientUploadFileSize = (filesize)=>{
+    if (typeof filesize !== 'number' || !Number.isSafeInteger(filesize) || filesize < 0) {
+        throw new APIError('A valid file size is required for client uploads.', 400);
+    }
+};
+export const assertClientUploadAllowed = ({ collection, filename, mimeType })=>{
+    if (typeof filename !== 'string' || filename.length === 0 || filename.trim().length === 0 || !getSanitizedUploadFilename(filename)) {
+        throw new APIError('A valid filename is required for client uploads.', 400);
+    }
+    const allowRestrictedFileTypes = collection && typeof collection.upload === 'object' ? collection.upload.allowRestrictedFileTypes : false;
+    // The explicit restricted-file opt-out also preserves legacy provider clients that did not
+    // send MIME metadata. Secure-default collections always require a bindable MIME identity.
+    if (mimeType === undefined || mimeType === null || mimeType === '') {
+        if (allowRestrictedFileTypes) {
+            return;
+        }
+        throw new APIError('A valid MIME type is required for client uploads.', 400);
+    }
+    if (!isValidMimeType(mimeType)) {
+        throw new APIError('A valid MIME type is required for client uploads.', 400);
+    }
+    if (uploadRequiresServerValidation({
+        allowRestrictedFileTypes,
+        filename,
+        mimeType
+    })) {
+        throw new APIError('SVG and XML files must be uploaded through Payload.', 400);
+    }
+};
+
+//# sourceMappingURL=assertClientUploadAllowed.js.map

package/dist/uploads/assertClientUploadAllowed.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/uploads/assertClientUploadAllowed.ts"],"sourcesContent":["import { APIError } from '../errors/APIError.js'\nimport {\n  getSanitizedUploadFilename,\n  uploadRequiresServerValidation,\n} from './getFileTypeIdentity.js'\n\nconst MIME_TYPE_PATTERN = /^[!#$%&'*+.^`|~\\w-]+\\/[!#$%&'*+.^`|~\\w-]+$/\n\nconst isValidMimeType = (mimeType: unknown): mimeType is string => {\n  if (\n    typeof mimeType !== 'string' ||\n    mimeType.length === 0 ||\n    mimeType !== mimeType.trim() ||\n    [...mimeType].some((character) => {\n      const codePoint = character.codePointAt(0)\n      return codePoint !== undefined && (codePoint <= 0x1f || codePoint === 0x7f)\n    })\n  ) {\n    return false\n  }\n\n  const [essence, ...parameters] = mimeType.split(';')\n  return (\n    MIME_TYPE_PATTERN.test(essence ?? '') &&\n    parameters.every((parameter) => parameter.trim().length > 0)\n  )\n}\n\nexport const assertClientUploadFileSize = (filesize: unknown) => {\n  if (typeof filesize !== 'number' || !Number.isSafeInteger(filesize) || filesize < 0) {\n    throw new APIError('A valid file size is required for client uploads.', 400)\n  }\n}\n\nexport const assertClientUploadAllowed = ({\n  collection,\n  filename,\n  mimeType,\n}: {\n  collection?: {\n    upload?: { allowRestrictedFileTypes?: boolean } | boolean\n  }\n  filename: unknown\n  mimeType?: unknown\n}): void => {\n  if (\n    typeof filename !== 'string' ||\n    filename.length === 0 ||\n    filename.trim().length === 0 ||\n    !getSanitizedUploadFilename(filename)\n  ) {\n    throw new APIError('A valid filename is required for client uploads.', 400)\n  }\n\n  const allowRestrictedFileTypes =\n    collection && typeof collection.upload === 'object'\n      ? collection.upload.allowRestrictedFileTypes\n      : false\n\n  // The explicit restricted-file opt-out also preserves legacy provider clients that did not\n  // send MIME metadata. Secure-default collections always require a bindable MIME identity.\n  if (mimeType === undefined || mimeType === null || mimeType === '') {\n    if (allowRestrictedFileTypes) {\n      return\n    }\n    throw new APIError('A valid MIME type is required for client uploads.', 400)\n  }\n\n  if (!isValidMimeType(mimeType)) {\n    throw new APIError('A valid MIME type is required for client uploads.', 400)\n  }\n\n  if (uploadRequiresServerValidation({ allowRestrictedFileTypes, filename, mimeType })) {\n    throw new APIError('SVG and XML files must be uploaded through Payload.', 400)\n  }\n}\n"],"names":["APIError","getSanitizedUploadFilename","uploadRequiresServerValidation","MIME_TYPE_PATTERN","isValidMimeType","mimeType","length","trim","some","character","codePoint","codePointAt","undefined","essence","parameters","split","test","every","parameter","assertClientUploadFileSize","filesize","Number","isSafeInteger","assertClientUploadAllowed","collection","filename","allowRestrictedFileTypes","upload"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,wBAAuB;AAChD,SACEC,0BAA0B,EAC1BC,8BAA8B,QACzB,2BAA0B;AAEjC,MAAMC,oBAAoB;AAE1B,MAAMC,kBAAkB,CAACC;IACvB,IACE,OAAOA,aAAa,YACpBA,SAASC,MAAM,KAAK,KACpBD,aAAaA,SAASE,IAAI,MAC1B;WAAIF;KAAS,CAACG,IAAI,CAAC,CAACC;QAClB,MAAMC,YAAYD,UAAUE,WAAW,CAAC;QACxC,OAAOD,cAAcE,aAAcF,CAAAA,aAAa,QAAQA,cAAc,IAAG;IAC3E,IACA;QACA,OAAO;IACT;IAEA,MAAM,CAACG,SAAS,GAAGC,WAAW,GAAGT,SAASU,KAAK,CAAC;IAChD,OACEZ,kBAAkBa,IAAI,CAACH,WAAW,OAClCC,WAAWG,KAAK,CAAC,CAACC,YAAcA,UAAUX,IAAI,GAAGD,MAAM,GAAG;AAE9D;AAEA,OAAO,MAAMa,6BAA6B,CAACC;IACzC,IAAI,OAAOA,aAAa,YAAY,CAACC,OAAOC,aAAa,CAACF,aAAaA,WAAW,GAAG;QACnF,MAAM,IAAIpB,SAAS,qDAAqD;IAC1E;AACF,EAAC;AAED,OAAO,MAAMuB,4BAA4B,CAAC,EACxCC,UAAU,EACVC,QAAQ,EACRpB,QAAQ,EAOT;IACC,IACE,OAAOoB,aAAa,YACpBA,SAASnB,MAAM,KAAK,KACpBmB,SAASlB,IAAI,GAAGD,MAAM,KAAK,KAC3B,CAACL,2BAA2BwB,WAC5B;QACA,MAAM,IAAIzB,SAAS,oDAAoD;IACzE;IAEA,MAAM0B,2BACJF,cAAc,OAAOA,WAAWG,MAAM,KAAK,WACvCH,WAAWG,MAAM,CAACD,wBAAwB,GAC1C;IAEN,2FAA2F;IAC3F,0FAA0F;IAC1F,IAAIrB,aAAaO,aAAaP,aAAa,QAAQA,aAAa,IAAI;QAClE,IAAIqB,0BAA0B;YAC5B;QACF;QACA,MAAM,IAAI1B,SAAS,qDAAqD;IAC1E;IAEA,IAAI,CAACI,gBAAgBC,WAAW;QAC9B,MAAM,IAAIL,SAAS,qDAAqD;IAC1E;IAEA,IAAIE,+BAA+B;QAAEwB;QAA0BD;QAAUpB;IAAS,IAAI;QACpF,MAAM,IAAIL,SAAS,uDAAuD;IAC5E;AACF,EAAC"}

package/dist/uploads/assertClientUploadAllowed.spec.js

@@ -0,0 +1,91 @@
+import { describe, expect, it } from 'vitest';
+import { assertClientUploadAllowed } from './assertClientUploadAllowed.js';
+describe('assertClientUploadAllowed', ()=>{
+    it.each([
+        [
+            'missing',
+            undefined
+        ],
+        [
+            'whitespace',
+            '   '
+        ]
+    ])('should validate %s filename metadata', (_, filename)=>{
+        expect(()=>assertClientUploadAllowed({
+                filename: filename,
+                mimeType: 'image/png'
+            })).toThrow('A valid filename is required for client uploads.');
+    });
+    it.each([
+        [
+            'missing',
+            undefined
+        ],
+        [
+            'invalid',
+            'image'
+        ]
+    ])('should validate %s MIME metadata', (_, mimeType)=>{
+        expect(()=>assertClientUploadAllowed({
+                filename: 'image.png',
+                mimeType: mimeType
+            })).toThrow('A valid MIME type is required for client uploads.');
+    });
+    it.each([
+        [
+            'filename extension',
+            'image.SVG',
+            'application/octet-stream'
+        ],
+        [
+            'declared MIME parameters',
+            'image.txt',
+            'image/svg+xml; charset=utf-8'
+        ],
+        [
+            'XML extension',
+            'image.xml',
+            'application/octet-stream'
+        ],
+        [
+            'XML structured-suffix MIME',
+            'image.txt',
+            'application/xhtml+xml; charset=utf-8'
+        ],
+        [
+            'sanitized trailing period',
+            'image.svg.',
+            'application/octet-stream'
+        ]
+    ])('should require a server upload for content identified by %s', (_, filename, mimeType)=>{
+        expect(()=>assertClientUploadAllowed({
+                filename,
+                mimeType
+            })).toThrow('SVG and XML files must be uploaded through Payload.');
+    });
+    it('should preserve configured client upload paths', ()=>{
+        expect(()=>assertClientUploadAllowed({
+                filename: 'image.png',
+                mimeType: 'image/png'
+            })).not.toThrow();
+        expect(()=>assertClientUploadAllowed({
+                collection: {
+                    upload: {
+                        allowRestrictedFileTypes: true
+                    }
+                },
+                filename: 'image.svg',
+                mimeType: 'image/svg+xml'
+            })).not.toThrow();
+        expect(()=>assertClientUploadAllowed({
+                collection: {
+                    upload: {
+                        allowRestrictedFileTypes: true
+                    }
+                },
+                filename: 'image.png'
+            })).not.toThrow();
+    });
+});
+
+//# sourceMappingURL=assertClientUploadAllowed.spec.js.map

package/dist/uploads/assertClientUploadAllowed.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/uploads/assertClientUploadAllowed.spec.ts"],"sourcesContent":["import { describe, expect, it } from 'vitest'\n\nimport { assertClientUploadAllowed } from './assertClientUploadAllowed.js'\n\ndescribe('assertClientUploadAllowed', () => {\n  it.each([\n    ['missing', undefined],\n    ['whitespace', '   '],\n  ])('should validate %s filename metadata', (_, filename) => {\n    expect(() =>\n      assertClientUploadAllowed({\n        filename: filename as unknown as string,\n        mimeType: 'image/png',\n      }),\n    ).toThrow('A valid filename is required for client uploads.')\n  })\n\n  it.each([\n    ['missing', undefined],\n    ['invalid', 'image'],\n  ])('should validate %s MIME metadata', (_, mimeType) => {\n    expect(() =>\n      assertClientUploadAllowed({\n        filename: 'image.png',\n        mimeType: mimeType as unknown as string,\n      }),\n    ).toThrow('A valid MIME type is required for client uploads.')\n  })\n\n  it.each([\n    ['filename extension', 'image.SVG', 'application/octet-stream'],\n    ['declared MIME parameters', 'image.txt', 'image/svg+xml; charset=utf-8'],\n    ['XML extension', 'image.xml', 'application/octet-stream'],\n    ['XML structured-suffix MIME', 'image.txt', 'application/xhtml+xml; charset=utf-8'],\n    ['sanitized trailing period', 'image.svg.', 'application/octet-stream'],\n  ])('should require a server upload for content identified by %s', (_, filename, mimeType) => {\n    expect(() => assertClientUploadAllowed({ filename, mimeType })).toThrow(\n      'SVG and XML files must be uploaded through Payload.',\n    )\n  })\n\n  it('should preserve configured client upload paths', () => {\n    expect(() =>\n      assertClientUploadAllowed({ filename: 'image.png', mimeType: 'image/png' }),\n    ).not.toThrow()\n    expect(() =>\n      assertClientUploadAllowed({\n        collection: { upload: { allowRestrictedFileTypes: true } },\n        filename: 'image.svg',\n        mimeType: 'image/svg+xml',\n      }),\n    ).not.toThrow()\n    expect(() =>\n      assertClientUploadAllowed({\n        collection: { upload: { allowRestrictedFileTypes: true } },\n        filename: 'image.png',\n      }),\n    ).not.toThrow()\n  })\n})\n"],"names":["describe","expect","it","assertClientUploadAllowed","each","undefined","_","filename","mimeType","toThrow","not","collection","upload","allowRestrictedFileTypes"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAE7C,SAASC,yBAAyB,QAAQ,iCAAgC;AAE1EH,SAAS,6BAA6B;IACpCE,GAAGE,IAAI,CAAC;QACN;YAAC;YAAWC;SAAU;QACtB;YAAC;YAAc;SAAM;KACtB,EAAE,wCAAwC,CAACC,GAAGC;QAC7CN,OAAO,IACLE,0BAA0B;gBACxBI,UAAUA;gBACVC,UAAU;YACZ,IACAC,OAAO,CAAC;IACZ;IAEAP,GAAGE,IAAI,CAAC;QACN;YAAC;YAAWC;SAAU;QACtB;YAAC;YAAW;SAAQ;KACrB,EAAE,oCAAoC,CAACC,GAAGE;QACzCP,OAAO,IACLE,0BAA0B;gBACxBI,UAAU;gBACVC,UAAUA;YACZ,IACAC,OAAO,CAAC;IACZ;IAEAP,GAAGE,IAAI,CAAC;QACN;YAAC;YAAsB;YAAa;SAA2B;QAC/D;YAAC;YAA4B;YAAa;SAA+B;QACzE;YAAC;YAAiB;YAAa;SAA2B;QAC1D;YAAC;YAA8B;YAAa;SAAuC;QACnF;YAAC;YAA6B;YAAc;SAA2B;KACxE,EAAE,+DAA+D,CAACE,GAAGC,UAAUC;QAC9EP,OAAO,IAAME,0BAA0B;gBAAEI;gBAAUC;YAAS,IAAIC,OAAO,CACrE;IAEJ;IAEAP,GAAG,kDAAkD;QACnDD,OAAO,IACLE,0BAA0B;gBAAEI,UAAU;gBAAaC,UAAU;YAAY,IACzEE,GAAG,CAACD,OAAO;QACbR,OAAO,IACLE,0BAA0B;gBACxBQ,YAAY;oBAAEC,QAAQ;wBAAEC,0BAA0B;oBAAK;gBAAE;gBACzDN,UAAU;gBACVC,UAAU;YACZ,IACAE,GAAG,CAACD,OAAO;QACbR,OAAO,IACLE,0BAA0B;gBACxBQ,YAAY;oBAAEC,QAAQ;wBAAEC,0BAA0B;oBAAK;gBAAE;gBACzDN,UAAU;YACZ,IACAG,GAAG,CAACD,OAAO;IACf;AACF"}

package/dist/uploads/checkFileRestrictions.d.ts

@@ -3,5 +3,8 @@ import type { checkFileRestrictionsParams, FileAllowList } from './types.js';
  * Restricted file types and their extensions.
  */
 export declare const RESTRICTED_FILE_EXT_AND_TYPES: FileAllowList;
-export declare const checkFileRestrictions: ({ collection, file, req, }: checkFileRestrictionsParams) => Promise<void>;
+export declare const checkFileRestrictions: ({ collection, file, req, }: checkFileRestrictionsParams) => Promise<{
+    ext: string;
+    mime: string;
+} | undefined>;
 //# sourceMappingURL=checkFileRestrictions.d.ts.map

package/dist/uploads/checkFileRestrictions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkFileRestrictions.d.ts","sourceRoot":"","sources":["../../src/uploads/checkFileRestrictions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAS5E;;GAEG;AACH,eAAO,MAAM,6BAA6B,EAAE,aAgC3C,CAAA;AAED,eAAO,MAAM,qBAAqB,+BAI/B,2BAA2B,KAAG,OAAO,CAAC,IAAI,CAyJ5C,CAAA"}
+{"version":3,"file":"checkFileRestrictions.d.ts","sourceRoot":"","sources":["../../src/uploads/checkFileRestrictions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAqB5E;;GAEG;AACH,eAAO,MAAM,6BAA6B,EAAE,aAiC3C,CAAA;AAED,eAAO,MAAM,qBAAqB,+BAI/B,2BAA2B,KAAG,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CA8LjF,CAAA"}