@depup/payload 3.79.1-depup.0

package/dist/queues/config/generateJobsJSONSchemas.js

@@ -0,0 +1,135 @@
+import { fieldsToJSONSchema } from '../../utilities/configToJSONSchema.js';
+import { flattenAllFields } from '../../utilities/flattenAllFields.js';
+export function generateJobsJSONSchemas(config, jobsConfig, interfaceNameDefinitions, /**
+   * Used for relationship fields, to determine whether to use a string or number type for the ID.
+   * While there is a default ID field type set by the db adapter, they can differ on a collection-level
+   * if they have custom ID fields.
+   */ collectionIDFieldTypes, i18n) {
+    const properties = {
+        tasks: {},
+        workflows: {}
+    };
+    const definitions = new Map();
+    if (jobsConfig?.tasks?.length) {
+        for (const task of jobsConfig.tasks){
+            const fullTaskJsonSchema = {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    input: {},
+                    output: {}
+                },
+                required: []
+            };
+            if (task?.inputSchema?.length) {
+                const inputJsonSchema = fieldsToJSONSchema(collectionIDFieldTypes, flattenAllFields({
+                    fields: task.inputSchema
+                }), interfaceNameDefinitions, config, i18n);
+                const fullInputJsonSchema = {
+                    type: 'object',
+                    additionalProperties: false,
+                    properties: inputJsonSchema.properties,
+                    required: inputJsonSchema.required
+                };
+                fullTaskJsonSchema.properties.input = fullInputJsonSchema;
+                fullTaskJsonSchema.required.push('input');
+            }
+            if (task?.outputSchema?.length) {
+                const outputJsonSchema = fieldsToJSONSchema(collectionIDFieldTypes, flattenAllFields({
+                    fields: task.outputSchema
+                }), interfaceNameDefinitions, config, i18n);
+                const fullOutputJsonSchema = {
+                    type: 'object',
+                    additionalProperties: false,
+                    properties: outputJsonSchema.properties,
+                    required: outputJsonSchema.required
+                };
+                fullTaskJsonSchema.properties.output = fullOutputJsonSchema;
+                fullTaskJsonSchema.required.push('output');
+            }
+            const normalizedTaskSlug = task.slug[0].toUpperCase() + task.slug.slice(1);
+            definitions.set(task.interfaceName ?? `Task${normalizedTaskSlug}`, fullTaskJsonSchema);
+        }
+        // Now add properties.tasks definition that references the types in definitions keyed by task slug:
+        properties.tasks = {
+            type: 'object',
+            additionalProperties: false,
+            properties: {
+                ...Object.fromEntries((jobsConfig.tasks ?? []).map((task)=>{
+                    const normalizedTaskSlug = task.slug[0].toUpperCase() + task.slug.slice(1);
+                    const toReturn = {
+                        $ref: task.interfaceName ? `#/definitions/${task.interfaceName}` : `#/definitions/Task${normalizedTaskSlug}`
+                    };
+                    return [
+                        task.slug,
+                        toReturn
+                    ];
+                })),
+                inline: {
+                    type: 'object',
+                    additionalProperties: false,
+                    properties: {
+                        input: {},
+                        output: {}
+                    },
+                    required: [
+                        'input',
+                        'output'
+                    ]
+                }
+            },
+            required: [
+                ...(jobsConfig.tasks ?? []).map((task)=>task.slug),
+                'inline'
+            ]
+        };
+    }
+    if (jobsConfig?.workflows?.length) {
+        for (const workflow of jobsConfig.workflows){
+            const fullWorkflowJsonSchema = {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    input: {}
+                },
+                required: []
+            };
+            if (workflow?.inputSchema?.length) {
+                const inputJsonSchema = fieldsToJSONSchema(collectionIDFieldTypes, flattenAllFields({
+                    fields: workflow.inputSchema
+                }), interfaceNameDefinitions, config, i18n);
+                const fullInputJsonSchema = {
+                    type: 'object',
+                    additionalProperties: false,
+                    properties: inputJsonSchema.properties,
+                    required: inputJsonSchema.required
+                };
+                fullWorkflowJsonSchema.properties.input = fullInputJsonSchema;
+                fullWorkflowJsonSchema.required.push('input');
+            }
+            const normalizedWorkflowSlug = workflow.slug[0].toUpperCase() + workflow.slug.slice(1);
+            definitions.set(workflow.interfaceName ?? `Workflow${normalizedWorkflowSlug}`, fullWorkflowJsonSchema);
+            properties.workflows = {
+                type: 'object',
+                additionalProperties: false,
+                properties: Object.fromEntries(jobsConfig.workflows.map((workflow)=>{
+                    const normalizedWorkflowSlug = workflow.slug[0].toUpperCase() + workflow.slug.slice(1);
+                    const toReturn = {
+                        $ref: workflow.interfaceName ? `#/definitions/${workflow.interfaceName}` : `#/definitions/Workflow${normalizedWorkflowSlug}`
+                    };
+                    return [
+                        workflow.slug,
+                        toReturn
+                    ];
+                })),
+                required: jobsConfig.workflows.map((workflow)=>workflow.slug)
+            };
+        }
+    }
+    return {
+        definitions,
+        properties
+    };
+}
+
+//# sourceMappingURL=generateJobsJSONSchemas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/queues/config/generateJobsJSONSchemas.ts"],"sourcesContent":["import type { I18n } from '@payloadcms/translations'\nimport type { JSONSchema4 } from 'json-schema'\n\nimport type { SanitizedConfig } from '../../config/types.js'\nimport type { JobsConfig } from './types/index.js'\n\nimport { fieldsToJSONSchema } from '../../utilities/configToJSONSchema.js'\nimport { flattenAllFields } from '../../utilities/flattenAllFields.js'\nexport function generateJobsJSONSchemas(\n  config: SanitizedConfig,\n  jobsConfig: JobsConfig,\n  interfaceNameDefinitions: Map<string, JSONSchema4>,\n  /**\n   * Used for relationship fields, to determine whether to use a string or number type for the ID.\n   * While there is a default ID field type set by the db adapter, they can differ on a collection-level\n   * if they have custom ID fields.\n   */\n  collectionIDFieldTypes: { [key: string]: 'number' | 'string' },\n  i18n?: I18n,\n): {\n  definitions?: Map<string, JSONSchema4>\n  properties?: { tasks: JSONSchema4 }\n} {\n  const properties: { tasks: JSONSchema4; workflows: JSONSchema4 } = {\n    tasks: {},\n    workflows: {},\n  }\n  const definitions: Map<string, JSONSchema4> = new Map()\n\n  if (jobsConfig?.tasks?.length) {\n    for (const task of jobsConfig.tasks) {\n      const fullTaskJsonSchema: JSONSchema4 = {\n        type: 'object',\n        additionalProperties: false,\n        properties: {\n          input: {},\n          output: {},\n        },\n        required: [],\n      }\n      if (task?.inputSchema?.length) {\n        const inputJsonSchema = fieldsToJSONSchema(\n          collectionIDFieldTypes,\n          flattenAllFields({ fields: task.inputSchema }),\n          interfaceNameDefinitions,\n          config,\n          i18n,\n        )\n\n        const fullInputJsonSchema: JSONSchema4 = {\n          type: 'object',\n          additionalProperties: false,\n          properties: inputJsonSchema.properties,\n          required: inputJsonSchema.required,\n        }\n\n        fullTaskJsonSchema.properties!.input = fullInputJsonSchema\n        ;(fullTaskJsonSchema.required as string[]).push('input')\n      }\n      if (task?.outputSchema?.length) {\n        const outputJsonSchema = fieldsToJSONSchema(\n          collectionIDFieldTypes,\n          flattenAllFields({ fields: task.outputSchema }),\n          interfaceNameDefinitions,\n          config,\n          i18n,\n        )\n\n        const fullOutputJsonSchema: JSONSchema4 = {\n          type: 'object',\n          additionalProperties: false,\n          properties: outputJsonSchema.properties,\n          required: outputJsonSchema.required,\n        }\n\n        fullTaskJsonSchema.properties!.output = fullOutputJsonSchema\n        ;(fullTaskJsonSchema.required as string[]).push('output')\n      }\n\n      const normalizedTaskSlug = task.slug[0].toUpperCase() + task.slug.slice(1)\n\n      definitions.set(task.interfaceName ?? `Task${normalizedTaskSlug}`, fullTaskJsonSchema)\n    }\n    // Now add properties.tasks definition that references the types in definitions keyed by task slug:\n    properties.tasks = {\n      type: 'object',\n      additionalProperties: false,\n      properties: {\n        ...Object.fromEntries(\n          (jobsConfig.tasks ?? []).map((task) => {\n            const normalizedTaskSlug = task.slug[0].toUpperCase() + task.slug.slice(1)\n\n            const toReturn: JSONSchema4 = {\n              $ref: task.interfaceName\n                ? `#/definitions/${task.interfaceName}`\n                : `#/definitions/Task${normalizedTaskSlug}`,\n            }\n\n            return [task.slug, toReturn]\n          }),\n        ),\n        inline: {\n          type: 'object',\n          additionalProperties: false,\n          properties: {\n            input: {},\n            output: {},\n          },\n          required: ['input', 'output'],\n        },\n      },\n      required: [...(jobsConfig.tasks ?? []).map((task) => task.slug), 'inline'],\n    }\n  }\n\n  if (jobsConfig?.workflows?.length) {\n    for (const workflow of jobsConfig.workflows) {\n      const fullWorkflowJsonSchema: JSONSchema4 = {\n        type: 'object',\n        additionalProperties: false,\n        properties: {\n          input: {},\n        },\n        required: [],\n      }\n\n      if (workflow?.inputSchema?.length) {\n        const inputJsonSchema = fieldsToJSONSchema(\n          collectionIDFieldTypes,\n          flattenAllFields({ fields: workflow.inputSchema }),\n          interfaceNameDefinitions,\n          config,\n          i18n,\n        )\n\n        const fullInputJsonSchema: JSONSchema4 = {\n          type: 'object',\n          additionalProperties: false,\n          properties: inputJsonSchema.properties,\n          required: inputJsonSchema.required,\n        }\n\n        fullWorkflowJsonSchema.properties!.input = fullInputJsonSchema\n        ;(fullWorkflowJsonSchema.required as string[]).push('input')\n      }\n      const normalizedWorkflowSlug = workflow.slug[0].toUpperCase() + workflow.slug.slice(1)\n\n      definitions.set(\n        workflow.interfaceName ?? `Workflow${normalizedWorkflowSlug}`,\n        fullWorkflowJsonSchema,\n      )\n\n      properties.workflows = {\n        type: 'object',\n        additionalProperties: false,\n        properties: Object.fromEntries(\n          jobsConfig.workflows.map((workflow) => {\n            const normalizedWorkflowSlug = workflow.slug[0].toUpperCase() + workflow.slug.slice(1)\n\n            const toReturn: JSONSchema4 = {\n              $ref: workflow.interfaceName\n                ? `#/definitions/${workflow.interfaceName}`\n                : `#/definitions/Workflow${normalizedWorkflowSlug}`,\n            }\n\n            return [workflow.slug, toReturn]\n          }),\n        ),\n        required: jobsConfig.workflows.map((workflow) => workflow.slug),\n      }\n    }\n  }\n\n  return {\n    definitions,\n    properties,\n  }\n}\n"],"names":["fieldsToJSONSchema","flattenAllFields","generateJobsJSONSchemas","config","jobsConfig","interfaceNameDefinitions","collectionIDFieldTypes","i18n","properties","tasks","workflows","definitions","Map","length","task","fullTaskJsonSchema","type","additionalProperties","input","output","required","inputSchema","inputJsonSchema","fields","fullInputJsonSchema","push","outputSchema","outputJsonSchema","fullOutputJsonSchema","normalizedTaskSlug","slug","toUpperCase","slice","set","interfaceName","Object","fromEntries","map","toReturn","$ref","inline","workflow","fullWorkflowJsonSchema","normalizedWorkflowSlug"],"mappings":"AAMA,SAASA,kBAAkB,QAAQ,wCAAuC;AAC1E,SAASC,gBAAgB,QAAQ,sCAAqC;AACtE,OAAO,SAASC,wBACdC,MAAuB,EACvBC,UAAsB,EACtBC,wBAAkD,EAClD;;;;GAIC,GACDC,sBAA8D,EAC9DC,IAAW;IAKX,MAAMC,aAA6D;QACjEC,OAAO,CAAC;QACRC,WAAW,CAAC;IACd;IACA,MAAMC,cAAwC,IAAIC;IAElD,IAAIR,YAAYK,OAAOI,QAAQ;QAC7B,KAAK,MAAMC,QAAQV,WAAWK,KAAK,CAAE;YACnC,MAAMM,qBAAkC;gBACtCC,MAAM;gBACNC,sBAAsB;gBACtBT,YAAY;oBACVU,OAAO,CAAC;oBACRC,QAAQ,CAAC;gBACX;gBACAC,UAAU,EAAE;YACd;YACA,IAAIN,MAAMO,aAAaR,QAAQ;gBAC7B,MAAMS,kBAAkBtB,mBACtBM,wBACAL,iBAAiB;oBAAEsB,QAAQT,KAAKO,WAAW;gBAAC,IAC5ChB,0BACAF,QACAI;gBAGF,MAAMiB,sBAAmC;oBACvCR,MAAM;oBACNC,sBAAsB;oBACtBT,YAAYc,gBAAgBd,UAAU;oBACtCY,UAAUE,gBAAgBF,QAAQ;gBACpC;gBAEAL,mBAAmBP,UAAU,CAAEU,KAAK,GAAGM;gBACrCT,mBAAmBK,QAAQ,CAAcK,IAAI,CAAC;YAClD;YACA,IAAIX,MAAMY,cAAcb,QAAQ;gBAC9B,MAAMc,mBAAmB3B,mBACvBM,wBACAL,iBAAiB;oBAAEsB,QAAQT,KAAKY,YAAY;gBAAC,IAC7CrB,0BACAF,QACAI;gBAGF,MAAMqB,uBAAoC;oBACxCZ,MAAM;oBACNC,sBAAsB;oBACtBT,YAAYmB,iBAAiBnB,UAAU;oBACvCY,UAAUO,iBAAiBP,QAAQ;gBACrC;gBAEAL,mBAAmBP,UAAU,CAAEW,MAAM,GAAGS;gBACtCb,mBAAmBK,QAAQ,CAAcK,IAAI,CAAC;YAClD;YAEA,MAAMI,qBAAqBf,KAAKgB,IAAI,CAAC,EAAE,CAACC,WAAW,KAAKjB,KAAKgB,IAAI,CAACE,KAAK,CAAC;YAExErB,YAAYsB,GAAG,CAACnB,KAAKoB,aAAa,IAAI,CAAC,IAAI,EAAEL,oBAAoB,EAAEd;QACrE;QACA,mGAAmG;QACnGP,WAAWC,KAAK,GAAG;YACjBO,MAAM;YACNC,sBAAsB;YACtBT,YAAY;gBACV,GAAG2B,OAAOC,WAAW,CACnB,AAAChC,CAAAA,WAAWK,KAAK,IAAI,EAAE,AAAD,EAAG4B,GAAG,CAAC,CAACvB;oBAC5B,MAAMe,qBAAqBf,KAAKgB,IAAI,CAAC,EAAE,CAACC,WAAW,KAAKjB,KAAKgB,IAAI,CAACE,KAAK,CAAC;oBAExE,MAAMM,WAAwB;wBAC5BC,MAAMzB,KAAKoB,aAAa,GACpB,CAAC,cAAc,EAAEpB,KAAKoB,aAAa,EAAE,GACrC,CAAC,kBAAkB,EAAEL,oBAAoB;oBAC/C;oBAEA,OAAO;wBAACf,KAAKgB,IAAI;wBAAEQ;qBAAS;gBAC9B,GACD;gBACDE,QAAQ;oBACNxB,MAAM;oBACNC,sBAAsB;oBACtBT,YAAY;wBACVU,OAAO,CAAC;wBACRC,QAAQ,CAAC;oBACX;oBACAC,UAAU;wBAAC;wBAAS;qBAAS;gBAC/B;YACF;YACAA,UAAU;mBAAI,AAAChB,CAAAA,WAAWK,KAAK,IAAI,EAAE,AAAD,EAAG4B,GAAG,CAAC,CAACvB,OAASA,KAAKgB,IAAI;gBAAG;aAAS;QAC5E;IACF;IAEA,IAAI1B,YAAYM,WAAWG,QAAQ;QACjC,KAAK,MAAM4B,YAAYrC,WAAWM,SAAS,CAAE;YAC3C,MAAMgC,yBAAsC;gBAC1C1B,MAAM;gBACNC,sBAAsB;gBACtBT,YAAY;oBACVU,OAAO,CAAC;gBACV;gBACAE,UAAU,EAAE;YACd;YAEA,IAAIqB,UAAUpB,aAAaR,QAAQ;gBACjC,MAAMS,kBAAkBtB,mBACtBM,wBACAL,iBAAiB;oBAAEsB,QAAQkB,SAASpB,WAAW;gBAAC,IAChDhB,0BACAF,QACAI;gBAGF,MAAMiB,sBAAmC;oBACvCR,MAAM;oBACNC,sBAAsB;oBACtBT,YAAYc,gBAAgBd,UAAU;oBACtCY,UAAUE,gBAAgBF,QAAQ;gBACpC;gBAEAsB,uBAAuBlC,UAAU,CAAEU,KAAK,GAAGM;gBACzCkB,uBAAuBtB,QAAQ,CAAcK,IAAI,CAAC;YACtD;YACA,MAAMkB,yBAAyBF,SAASX,IAAI,CAAC,EAAE,CAACC,WAAW,KAAKU,SAASX,IAAI,CAACE,KAAK,CAAC;YAEpFrB,YAAYsB,GAAG,CACbQ,SAASP,aAAa,IAAI,CAAC,QAAQ,EAAES,wBAAwB,EAC7DD;YAGFlC,WAAWE,SAAS,GAAG;gBACrBM,MAAM;gBACNC,sBAAsB;gBACtBT,YAAY2B,OAAOC,WAAW,CAC5BhC,WAAWM,SAAS,CAAC2B,GAAG,CAAC,CAACI;oBACxB,MAAME,yBAAyBF,SAASX,IAAI,CAAC,EAAE,CAACC,WAAW,KAAKU,SAASX,IAAI,CAACE,KAAK,CAAC;oBAEpF,MAAMM,WAAwB;wBAC5BC,MAAME,SAASP,aAAa,GACxB,CAAC,cAAc,EAAEO,SAASP,aAAa,EAAE,GACzC,CAAC,sBAAsB,EAAES,wBAAwB;oBACvD;oBAEA,OAAO;wBAACF,SAASX,IAAI;wBAAEQ;qBAAS;gBAClC;gBAEFlB,UAAUhB,WAAWM,SAAS,CAAC2B,GAAG,CAAC,CAACI,WAAaA,SAASX,IAAI;YAChE;QACF;IACF;IAEA,OAAO;QACLnB;QACAH;IACF;AACF"}

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

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

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

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

package/dist/queues/config/global.js

@@ -0,0 +1,20 @@
+export const jobStatsGlobalSlug = 'payload-jobs-stats';
+/**
+ * Global config for job statistics.
+ */ export const getJobStatsGlobal = (config)=>{
+    return {
+        slug: jobStatsGlobalSlug,
+        admin: {
+            group: 'System',
+            hidden: true
+        },
+        fields: [
+            {
+                name: 'stats',
+                type: 'json'
+            }
+        ]
+    };
+};
+
+//# sourceMappingURL=global.js.map

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

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

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

@@ -0,0 +1,290 @@
+import type { CollectionConfig, Job } from '../../../index.js';
+import type { MaybePromise, Payload, PayloadRequest, Sort } from '../../../types/index.js';
+import type { RunJobsSilent } from '../../localAPI.js';
+import type { RunJobsArgs } from '../../operations/runJobs/index.js';
+import type { JobStats } from '../global.js';
+import type { TaskConfig } from './taskTypes.js';
+import type { WorkflowConfig } from './workflowTypes.js';
+export type AutorunCronConfig = {
+    /**
+     * If you want to autoRUn jobs from all queues, set this to true.
+     * If you set this to true, the `queue` property will be ignored.
+     *
+     * @default false
+     */
+    allQueues?: boolean;
+    /**
+     * The cron schedule for the job.
+     * @default '* * * * *' (every minute).
+     *
+     * @example
+     *     ┌───────────── (optional) second (0 - 59)
+     *     │ ┌───────────── minute (0 - 59)
+     *     │ │ ┌───────────── hour (0 - 23)
+     *     │ │ │ ┌───────────── day of the month (1 - 31)
+     *     │ │ │ │ ┌───────────── month (1 - 12)
+     *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)
+     *     │ │ │ │ │ │
+     *     │ │ │ │ │ │
+     *  - '* 0 * * * *' every hour at minute 0
+     *  - '* 0 0 * * *' daily at midnight
+     *  - '* 0 0 * * 0' weekly at midnight on Sundays
+     *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month
+     *  - '* 0/5 * * * *' every 5 minutes
+     *  - '* * * * * *' every second
+     */
+    cron?: string;
+    /**
+     * By default, the autorun will attempt to schedule jobs for tasks and workflows that have a `schedule` property, given
+     * the queue name is the same.
+     *
+     * Set this to `true` to disable the scheduling of jobs automatically.
+     *
+     * @default false
+     */
+    disableScheduling?: boolean;
+    /**
+     * The limit for the job. This can be overridden by the user. Defaults to 10.
+     */
+    limit?: number;
+    /**
+     * The queue name for the job.
+     *
+     * @default 'default'
+     */
+    queue?: string;
+    /**
+     * If set to true, the job system will not log any output to the console (for both info and error logs).
+     * Can be an option for more granular control over logging.
+     *
+     * This will not automatically affect user-configured logs (e.g. if you call `console.log` or `payload.logger.info` in your job code).
+     *
+     * @default false
+     */
+    silent?: RunJobsSilent;
+};
+export type RunJobAccessArgs = {
+    req: PayloadRequest;
+};
+export type RunJobAccess = (args: RunJobAccessArgs) => MaybePromise<boolean>;
+export type QueueJobAccessArgs = {
+    req: PayloadRequest;
+};
+export type CancelJobAccessArgs = {
+    req: PayloadRequest;
+};
+export type CancelJobAccess = (args: CancelJobAccessArgs) => MaybePromise<boolean>;
+export type QueueJobAccess = (args: QueueJobAccessArgs) => MaybePromise<boolean>;
+export type SanitizedJobsConfig = {
+    /**
+     * If set to `true`, the job system is enabled and a payload-jobs collection exists.
+     * This property is automatically set during sanitization.
+     */
+    enabled?: boolean;
+    /**
+     * If set to `true`, at least one task or workflow has scheduling enabled.
+     * This property is automatically set during sanitization.
+     */
+    scheduling?: boolean;
+    /**
+     * If set to `true`, a payload-job-stats global exists.
+     * This property is automatically set during sanitization.
+     */
+    stats?: boolean;
+} & JobsConfig;
+export type JobsConfig = {
+    /**
+     * Specify access control to determine who can interact with jobs.
+     */
+    access?: {
+        /**
+         * By default, all logged-in users can cancel jobs.
+         */
+        cancel?: CancelJobAccess;
+        /**
+         * By default, all logged-in users can queue jobs.
+         */
+        queue?: QueueJobAccess;
+        /**
+         * By default, all logged-in users can run jobs.
+         */
+        run?: RunJobAccess;
+    };
+    /** Adds information about the parent job to the task log. This is useful for debugging and tracking the flow of tasks.
+     *
+     * In 4.0, this will default to `true`.
+     *
+     * @default false
+     */
+    addParentToTaskLog?: boolean;
+    /**
+     * Allows you to configure cron jobs that automatically run queued jobs
+     * at specified intervals. Note that this does not _queue_ new jobs - only
+     * _runs_ jobs that are already in the specified queue.
+     *
+     * @remark this property should not be used on serverless platforms like Vercel
+     */
+    autoRun?: ((payload: Payload) => MaybePromise<AutorunCronConfig[]>) | AutorunCronConfig[];
+    /**
+     * Determine whether or not to delete a job after it has successfully completed.
+     */
+    deleteJobOnComplete?: boolean;
+    /**
+     * Specify depth for retrieving jobs from the queue.
+     * This should be as low as possible in order for job retrieval
+     * to be as efficient as possible. Setting it to anything higher than
+     * 0 will drastically affect performance, as less efficient database
+     * queries will be used.
+     *
+     * @default 0
+     * @deprecated - this will be removed in 4.0
+     */
+    depth?: number;
+    /**
+     * Enable concurrency controls for workflows and tasks.
+     * When enabled, adds a `concurrencyKey` field to the jobs collection schema.
+     * This allows workflows and tasks to use the `concurrency` option to prevent race conditions.
+     *
+     * **Important:** Enabling this may require a database migration depending on your database adapter,
+     * as it adds a new indexed field to the jobs collection schema.
+     *
+     * @default false
+     * @todo In 4.0, this will default to `true`.
+     */
+    enableConcurrencyControl?: boolean;
+    /**
+     * Override any settings on the default Jobs collection. Accepts the default collection and allows you to return
+     * a new collection.
+     */
+    jobsCollectionOverrides?: (args: {
+        defaultJobsCollection: CollectionConfig;
+    }) => CollectionConfig;
+    /**
+     * Adjust the job processing order using a Payload sort string. This can be set globally or per queue.
+     *
+     * FIFO would equal `createdAt` and LIFO would equal `-createdAt`.
+     *
+     * @default all jobs for all queues will be executed in FIFO order.
+     */
+    processingOrder?: ((args: RunJobsArgs) => Promise<Sort> | Sort) | {
+        default?: Sort;
+        queues: {
+            [queue: string]: Sort;
+        };
+    } | Sort;
+    /**
+     * By default, the job system uses direct database calls for optimal performance.
+     * If you added custom hooks to your jobs collection, you can set this to true to
+     * use the standard Payload API for all job operations. This is discouraged, as it will
+     * drastically affect performance.
+     *
+     * @default false
+     * @deprecated - this will be removed in 4.0
+     */
+    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.
+     * @default undefined - if this function is not defined, jobs will be run - as if () => true was passed.
+     * @param payload
+     * @returns boolean
+     */
+    shouldAutoRun?: (payload: Payload) => MaybePromise<boolean>;
+    /**
+     * Define all possible tasks here
+     */
+    tasks?: TaskConfig<any>[];
+    /**
+     * Define all the workflows here. Workflows orchestrate the flow of multiple tasks.
+     */
+    workflows?: WorkflowConfig<any>[];
+};
+export type Queueable = {
+    scheduleConfig: ScheduleConfig;
+    taskConfig?: TaskConfig;
+    waitUntil?: Date;
+    workflowConfig?: WorkflowConfig;
+};
+export type BeforeScheduleFn = (args: {
+    defaultBeforeSchedule: BeforeScheduleFn;
+    /**
+     * payload-job-stats global data
+     */
+    jobStats: JobStats;
+    queueable: Queueable;
+    req: PayloadRequest;
+}) => MaybePromise<{
+    input?: object;
+    shouldSchedule: boolean;
+    waitUntil?: Date;
+}>;
+export type AfterScheduleFn = (args: {
+    defaultAfterSchedule: AfterScheduleFn;
+    /**
+     * payload-job-stats global data. If the global does not exist, it will be null.
+     */
+    jobStats: JobStats | null;
+    queueable: Queueable;
+    req: PayloadRequest;
+} & ({
+    error: Error;
+    job?: never;
+    status: 'error';
+} | {
+    error?: never;
+    job: Job;
+    status: 'success';
+} | {
+    error?: never;
+    job?: never;
+    /**
+     * If the beforeSchedule hook returned `shouldSchedule: false`, this will be called with status `skipped`.
+     */
+    status: 'skipped';
+})) => MaybePromise<void>;
+export type ScheduleConfig = {
+    /**
+     * The cron for scheduling the job.
+     *
+     * @example
+     *     ┌───────────── (optional) second (0 - 59)
+     *     │ ┌───────────── minute (0 - 59)
+     *     │ │ ┌───────────── hour (0 - 23)
+     *     │ │ │ ┌───────────── day of the month (1 - 31)
+     *     │ │ │ │ ┌───────────── month (1 - 12)
+     *     │ │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)
+     *     │ │ │ │ │ │
+     *     │ │ │ │ │ │
+     *  - '* 0 * * * *' every hour at minute 0
+     *  - '* 0 0 * * *' daily at midnight
+     *  - '* 0 0 * * 0' weekly at midnight on Sundays
+     *  - '* 0 0 1 * *' monthly at midnight on the 1st day of the month
+     *  - '* 0/5 * * * *' every 5 minutes
+     *  - '* * * * * *' every second
+     */
+    cron: string;
+    hooks?: {
+        /**
+         * Functions that will be executed after the job has been successfully scheduled.
+         *
+         * @default By default, global update?? Unless global update should happen before
+         */
+        afterSchedule?: AfterScheduleFn;
+        /**
+         * Functions that will be executed before the job is scheduled.
+         * You can use this to control whether or not the job should be scheduled, or what input
+         * data should be passed to the job.
+         *
+         * @default By default, this has one function that returns { shouldSchedule: true } if the following conditions are met:
+         * - There currently is no job of the same type in the specified queue that is currently running
+         * - There currently is no job of the same type in the specified queue that is scheduled to run in the future
+         * - There currently is no job of the same type in the specified queue that failed previously but can be retried
+         */
+        beforeSchedule?: BeforeScheduleFn;
+    };
+    /**
+     * Queue to which the scheduled job will be added.
+     */
+    queue: string;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/queues/config/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,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"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/queues/config/types/index.ts"],"sourcesContent":["import type { CollectionConfig, 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"}