@trigger.dev/core 3.0.0-beta.5 → 3.0.0-beta.51

package/dist/catalog-H7yFiZ60.d.mts

@@ -0,0 +1,202 @@
+import { L as LogLevel } from './taskLogger-r_AFTX45.mjs';
+import { M as MachinePresetName, a as TaskRunContext } from './common-CLW82lkt.mjs';
+import { R as RetryOptions, P as Prettify, T as TaskMetadata, a as TaskFileMetadata, b as TaskMetadataWithFilePath } from './schemas-C9ssfehv.mjs';
+import { InstrumentationOption } from '@opentelemetry/instrumentation';
+
+interface ProjectConfig {
+    project: string;
+    triggerDirectories?: string | string[];
+    triggerUrl?: string;
+    retries?: {
+        enabledInDev?: boolean;
+        default?: RetryOptions;
+    };
+    additionalPackages?: string[];
+    /**
+     * The default machine preset to use for your deployed trigger.dev tasks. You can override this on a per-task basis.
+     * @default "small-1x"
+     */
+    machine?: MachinePresetName;
+    /**
+     * List of additional files to include in your trigger.dev bundle. e.g. ["./prisma/schema.prisma"]
+     *
+     * Supports glob patterns.
+     *
+     * Note: The path separator for glob patterns is `/`, even on Windows!
+     */
+    additionalFiles?: string[];
+    /**
+     * List of patterns that determine if a module is included in your trigger.dev bundle. This is needed when consuming ESM only packages, since the trigger.dev bundle is currently built as a CJS module.
+     */
+    dependenciesToBundle?: Array<string | RegExp>;
+    /**
+     * The path to your project's tsconfig.json file. Will use tsconfig.json in the project directory if not provided.
+     */
+    tsconfigPath?: string;
+    /**
+     * The OpenTelemetry instrumentations to enable
+     */
+    instrumentations?: InstrumentationOption[];
+    /**
+     * Set the log level for the logger. Defaults to "info", so you will see "log", "info", "warn", and "error" messages, but not "debug" messages.
+     *
+     * We automatically set the logLevel to "debug" during test runs
+     *
+     * @default "info"
+     */
+    logLevel?: LogLevel;
+    /**
+     * Enable console logging while running the dev CLI. This will print out logs from console.log, console.warn, and console.error. By default all logs are sent to the trigger.dev backend, and not logged to the console.
+     */
+    enableConsoleLogging?: boolean;
+    /**
+     * Run before a task is executed, for all tasks. This is useful for setting up any global state that is needed for all tasks.
+     */
+    init?: (payload: unknown, params: InitFnParams) => void | Promise<void>;
+    /**
+     * onSuccess is called after the run function has successfully completed.
+     */
+    onSuccess?: (payload: unknown, output: unknown, params: SuccessFnParams<any>) => Promise<void>;
+    /**
+     * onFailure is called after a task run has failed (meaning the run function threw an error and won't be retried anymore)
+     */
+    onFailure?: (payload: unknown, error: unknown, params: FailureFnParams<any>) => Promise<void>;
+    /**
+     * onStart is called the first time a task is executed in a run (not before every retry)
+     */
+    onStart?: (payload: unknown, params: StartFnParams) => Promise<void>;
+    /**
+     * postInstall will run during the deploy build step, after all the dependencies have been installed.
+     *
+     * @example "prisma generate"
+     */
+    postInstall?: string;
+    /**
+     * CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable in, useful in use with self signed cert in the trigger.dev environment.
+     *
+     * @example "./certs/ca.crt"
+     * Note: must start with "./" and be relative to the project root.
+     *
+     */
+    extraCACerts?: string;
+}
+
+type InitOutput = Record<string, any> | void | undefined;
+type RunFnParams<TInitOutput extends InitOutput> = Prettify<{
+    /** Metadata about the task, run, attempt, queue, environment, organization, project and batch.  */
+    ctx: Context;
+    /** If you use the `init` function, this will be whatever you returned. */
+    init?: TInitOutput;
+}>;
+type MiddlewareFnParams = Prettify<{
+    ctx: Context;
+    next: () => Promise<void>;
+}>;
+type InitFnParams = Prettify<{
+    ctx: Context;
+}>;
+type StartFnParams = Prettify<{
+    ctx: Context;
+}>;
+type Context = TaskRunContext;
+type SuccessFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput>;
+type FailureFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput>;
+type HandleErrorFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput> & Prettify<{
+    retry?: RetryOptions;
+    retryAt?: Date;
+    retryDelayInMs?: number;
+}>;
+type HandleErrorModificationOptions = {
+    skipRetrying?: boolean | undefined;
+    retryAt?: Date | undefined;
+    retryDelayInMs?: number | undefined;
+    retry?: RetryOptions | undefined;
+    error?: unknown;
+};
+type HandleErrorResult = undefined | void | HandleErrorModificationOptions | Promise<undefined | void | HandleErrorModificationOptions>;
+type HandleErrorArgs = {
+    ctx: Context;
+    retry?: RetryOptions;
+    retryAt?: Date;
+    retryDelayInMs?: number;
+};
+type HandleErrorFunction = (payload: any, error: unknown, params: HandleErrorArgs) => HandleErrorResult;
+type ResolveEnvironmentVariablesOptions = {
+    variables: Record<string, string> | Array<{
+        name: string;
+        value: string;
+    }>;
+    override?: boolean;
+};
+type ResolveEnvironmentVariablesResult = ResolveEnvironmentVariablesOptions | Promise<void | undefined | ResolveEnvironmentVariablesOptions> | void | undefined;
+type ResolveEnvironmentVariablesParams = {
+    projectRef: string;
+    environment: "dev" | "staging" | "prod";
+    env: Record<string, string>;
+};
+type ResolveEnvironmentVariablesFunction = (params: ResolveEnvironmentVariablesParams) => ResolveEnvironmentVariablesResult;
+type TaskMetadataWithFunctions = TaskMetadata & {
+    fns: {
+        run: (payload: any, params: RunFnParams<any>) => Promise<any>;
+        init?: (payload: any, params: InitFnParams) => Promise<InitOutput>;
+        cleanup?: (payload: any, params: RunFnParams<any>) => Promise<void>;
+        middleware?: (payload: any, params: MiddlewareFnParams) => Promise<void>;
+        handleError?: (payload: any, error: unknown, params: HandleErrorFnParams<any>) => HandleErrorResult;
+        onSuccess?: (payload: any, output: any, params: SuccessFnParams<any>) => Promise<void>;
+        onFailure?: (payload: any, error: unknown, params: FailureFnParams<any>) => Promise<void>;
+        onStart?: (payload: any, params: StartFnParams) => Promise<void>;
+    };
+};
+
+/**
+ * Contains two parts: the first part is the seconds, the second part is the nanoseconds.
+ *
+ */
+type ClockTime = [number, number];
+interface Clock {
+    preciseNow(): ClockTime;
+    reset(): void;
+}
+
+type UsageSample = {
+    cpuTime: number;
+    wallTime: number;
+};
+interface UsageMeasurement {
+    sample(): UsageSample;
+}
+interface UsageManager {
+    disable(): void;
+    start(): UsageMeasurement;
+    stop(measurement: UsageMeasurement): UsageSample;
+    sample(): UsageSample | undefined;
+    pauseAsync<T>(cb: () => Promise<T>): Promise<T>;
+}
+
+declare class UsageAPI implements UsageManager {
+    #private;
+    private static _instance?;
+    private constructor();
+    static getInstance(): UsageAPI;
+    setGlobalUsageManager(manager: UsageManager): boolean;
+    disable(): void;
+    start(): UsageMeasurement;
+    stop(measurement: UsageMeasurement): UsageSample;
+    pauseAsync<T>(cb: () => Promise<T>): Promise<T>;
+    sample(): UsageSample | undefined;
+}
+
+/** Entrypoint for usage API */
+declare const usage: UsageAPI;
+
+interface TaskCatalog {
+    registerTaskMetadata(task: TaskMetadataWithFunctions): void;
+    updateTaskMetadata(id: string, task: Partial<TaskMetadataWithFunctions>): void;
+    registerTaskFileMetadata(id: string, metadata: TaskFileMetadata): void;
+    getAllTaskMetadata(): Array<TaskMetadataWithFilePath>;
+    getTaskMetadata(id: string): TaskMetadataWithFilePath | undefined;
+    getTask(id: string): TaskMetadataWithFunctions | undefined;
+    taskExists(id: string): boolean;
+}
+
+export { type Clock as C, type FailureFnParams as F, type HandleErrorFunction as H, type InitOutput as I, type MiddlewareFnParams as M, type ProjectConfig as P, type RunFnParams as R, type StartFnParams as S, type TaskMetadataWithFunctions as T, type UsageMeasurement as U, type ClockTime as a, type TaskCatalog as b, type UsageManager as c, type UsageSample as d, type InitFnParams as e, type Context as f, type SuccessFnParams as g, type HandleErrorFnParams as h, type HandleErrorModificationOptions as i, type HandleErrorResult as j, type HandleErrorArgs as k, type ResolveEnvironmentVariablesResult as l, type ResolveEnvironmentVariablesParams as m, type ResolveEnvironmentVariablesFunction as n, usage as u };

package/dist/catalog-h79CG5Wy.d.ts

@@ -0,0 +1,202 @@
+import { L as LogLevel } from './taskLogger-CzADe4je.js';
+import { M as MachinePresetName, a as TaskRunContext } from './common-CLW82lkt.js';
+import { R as RetryOptions, P as Prettify, T as TaskMetadata, a as TaskFileMetadata, b as TaskMetadataWithFilePath } from './schemas-C9ssfehv.js';
+import { InstrumentationOption } from '@opentelemetry/instrumentation';
+
+interface ProjectConfig {
+    project: string;
+    triggerDirectories?: string | string[];
+    triggerUrl?: string;
+    retries?: {
+        enabledInDev?: boolean;
+        default?: RetryOptions;
+    };
+    additionalPackages?: string[];
+    /**
+     * The default machine preset to use for your deployed trigger.dev tasks. You can override this on a per-task basis.
+     * @default "small-1x"
+     */
+    machine?: MachinePresetName;
+    /**
+     * List of additional files to include in your trigger.dev bundle. e.g. ["./prisma/schema.prisma"]
+     *
+     * Supports glob patterns.
+     *
+     * Note: The path separator for glob patterns is `/`, even on Windows!
+     */
+    additionalFiles?: string[];
+    /**
+     * List of patterns that determine if a module is included in your trigger.dev bundle. This is needed when consuming ESM only packages, since the trigger.dev bundle is currently built as a CJS module.
+     */
+    dependenciesToBundle?: Array<string | RegExp>;
+    /**
+     * The path to your project's tsconfig.json file. Will use tsconfig.json in the project directory if not provided.
+     */
+    tsconfigPath?: string;
+    /**
+     * The OpenTelemetry instrumentations to enable
+     */
+    instrumentations?: InstrumentationOption[];
+    /**
+     * Set the log level for the logger. Defaults to "info", so you will see "log", "info", "warn", and "error" messages, but not "debug" messages.
+     *
+     * We automatically set the logLevel to "debug" during test runs
+     *
+     * @default "info"
+     */
+    logLevel?: LogLevel;
+    /**
+     * Enable console logging while running the dev CLI. This will print out logs from console.log, console.warn, and console.error. By default all logs are sent to the trigger.dev backend, and not logged to the console.
+     */
+    enableConsoleLogging?: boolean;
+    /**
+     * Run before a task is executed, for all tasks. This is useful for setting up any global state that is needed for all tasks.
+     */
+    init?: (payload: unknown, params: InitFnParams) => void | Promise<void>;
+    /**
+     * onSuccess is called after the run function has successfully completed.
+     */
+    onSuccess?: (payload: unknown, output: unknown, params: SuccessFnParams<any>) => Promise<void>;
+    /**
+     * onFailure is called after a task run has failed (meaning the run function threw an error and won't be retried anymore)
+     */
+    onFailure?: (payload: unknown, error: unknown, params: FailureFnParams<any>) => Promise<void>;
+    /**
+     * onStart is called the first time a task is executed in a run (not before every retry)
+     */
+    onStart?: (payload: unknown, params: StartFnParams) => Promise<void>;
+    /**
+     * postInstall will run during the deploy build step, after all the dependencies have been installed.
+     *
+     * @example "prisma generate"
+     */
+    postInstall?: string;
+    /**
+     * CA Cert file to be added to NODE_EXTRA_CA_CERT environment variable in, useful in use with self signed cert in the trigger.dev environment.
+     *
+     * @example "./certs/ca.crt"
+     * Note: must start with "./" and be relative to the project root.
+     *
+     */
+    extraCACerts?: string;
+}
+
+type InitOutput = Record<string, any> | void | undefined;
+type RunFnParams<TInitOutput extends InitOutput> = Prettify<{
+    /** Metadata about the task, run, attempt, queue, environment, organization, project and batch.  */
+    ctx: Context;
+    /** If you use the `init` function, this will be whatever you returned. */
+    init?: TInitOutput;
+}>;
+type MiddlewareFnParams = Prettify<{
+    ctx: Context;
+    next: () => Promise<void>;
+}>;
+type InitFnParams = Prettify<{
+    ctx: Context;
+}>;
+type StartFnParams = Prettify<{
+    ctx: Context;
+}>;
+type Context = TaskRunContext;
+type SuccessFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput>;
+type FailureFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput>;
+type HandleErrorFnParams<TInitOutput extends InitOutput> = RunFnParams<TInitOutput> & Prettify<{
+    retry?: RetryOptions;
+    retryAt?: Date;
+    retryDelayInMs?: number;
+}>;
+type HandleErrorModificationOptions = {
+    skipRetrying?: boolean | undefined;
+    retryAt?: Date | undefined;
+    retryDelayInMs?: number | undefined;
+    retry?: RetryOptions | undefined;
+    error?: unknown;
+};
+type HandleErrorResult = undefined | void | HandleErrorModificationOptions | Promise<undefined | void | HandleErrorModificationOptions>;
+type HandleErrorArgs = {
+    ctx: Context;
+    retry?: RetryOptions;
+    retryAt?: Date;
+    retryDelayInMs?: number;
+};
+type HandleErrorFunction = (payload: any, error: unknown, params: HandleErrorArgs) => HandleErrorResult;
+type ResolveEnvironmentVariablesOptions = {
+    variables: Record<string, string> | Array<{
+        name: string;
+        value: string;
+    }>;
+    override?: boolean;
+};
+type ResolveEnvironmentVariablesResult = ResolveEnvironmentVariablesOptions | Promise<void | undefined | ResolveEnvironmentVariablesOptions> | void | undefined;
+type ResolveEnvironmentVariablesParams = {
+    projectRef: string;
+    environment: "dev" | "staging" | "prod";
+    env: Record<string, string>;
+};
+type ResolveEnvironmentVariablesFunction = (params: ResolveEnvironmentVariablesParams) => ResolveEnvironmentVariablesResult;
+type TaskMetadataWithFunctions = TaskMetadata & {
+    fns: {
+        run: (payload: any, params: RunFnParams<any>) => Promise<any>;
+        init?: (payload: any, params: InitFnParams) => Promise<InitOutput>;
+        cleanup?: (payload: any, params: RunFnParams<any>) => Promise<void>;
+        middleware?: (payload: any, params: MiddlewareFnParams) => Promise<void>;
+        handleError?: (payload: any, error: unknown, params: HandleErrorFnParams<any>) => HandleErrorResult;
+        onSuccess?: (payload: any, output: any, params: SuccessFnParams<any>) => Promise<void>;
+        onFailure?: (payload: any, error: unknown, params: FailureFnParams<any>) => Promise<void>;
+        onStart?: (payload: any, params: StartFnParams) => Promise<void>;
+    };
+};
+
+/**
+ * Contains two parts: the first part is the seconds, the second part is the nanoseconds.
+ *
+ */
+type ClockTime = [number, number];
+interface Clock {
+    preciseNow(): ClockTime;
+    reset(): void;
+}
+
+type UsageSample = {
+    cpuTime: number;
+    wallTime: number;
+};
+interface UsageMeasurement {
+    sample(): UsageSample;
+}
+interface UsageManager {
+    disable(): void;
+    start(): UsageMeasurement;
+    stop(measurement: UsageMeasurement): UsageSample;
+    sample(): UsageSample | undefined;
+    pauseAsync<T>(cb: () => Promise<T>): Promise<T>;
+}
+
+declare class UsageAPI implements UsageManager {
+    #private;
+    private static _instance?;
+    private constructor();
+    static getInstance(): UsageAPI;
+    setGlobalUsageManager(manager: UsageManager): boolean;
+    disable(): void;
+    start(): UsageMeasurement;
+    stop(measurement: UsageMeasurement): UsageSample;
+    pauseAsync<T>(cb: () => Promise<T>): Promise<T>;
+    sample(): UsageSample | undefined;
+}
+
+/** Entrypoint for usage API */
+declare const usage: UsageAPI;
+
+interface TaskCatalog {
+    registerTaskMetadata(task: TaskMetadataWithFunctions): void;
+    updateTaskMetadata(id: string, task: Partial<TaskMetadataWithFunctions>): void;
+    registerTaskFileMetadata(id: string, metadata: TaskFileMetadata): void;
+    getAllTaskMetadata(): Array<TaskMetadataWithFilePath>;
+    getTaskMetadata(id: string): TaskMetadataWithFilePath | undefined;
+    getTask(id: string): TaskMetadataWithFunctions | undefined;
+    taskExists(id: string): boolean;
+}
+
+export { type Clock as C, type FailureFnParams as F, type HandleErrorFunction as H, type InitOutput as I, type MiddlewareFnParams as M, type ProjectConfig as P, type RunFnParams as R, type StartFnParams as S, type TaskMetadataWithFunctions as T, type UsageMeasurement as U, type ClockTime as a, type TaskCatalog as b, type UsageManager as c, type UsageSample as d, type InitFnParams as e, type Context as f, type SuccessFnParams as g, type HandleErrorFnParams as h, type HandleErrorModificationOptions as i, type HandleErrorResult as j, type HandleErrorArgs as k, type ResolveEnvironmentVariablesResult as l, type ResolveEnvironmentVariablesParams as m, type ResolveEnvironmentVariablesFunction as n, usage as u };