@trigger.dev/sdk 3.0.0-beta.6 → 3.0.0

package/dist/v3/index.d.mts

@@ -1,254 +0,0 @@
-import { TaskRunContext, InitOutput, RetryOptions, QueueOptions, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, SuccessFnParams, FetchRetryOptions } from '@trigger.dev/core/v3';
-export { HandleErrorArgs, HandleErrorFunction, LogLevel, RetryOptions, ProjectConfig as TriggerConfig, logger } from '@trigger.dev/core/v3';
-import { HttpHandler } from 'msw';
-
-type Context = TaskRunContext;
-type RequireOne<T, K extends keyof T> = {
-    [X in Exclude<keyof T, K>]?: T[X];
-} & {
-    [P in K]-?: T[P];
-};
-type Queue = RequireOne<QueueOptions, "name">;
-type TaskOptions<TPayload, TOutput = any, TInitOutput extends InitOutput = any> = {
-    /** An id for your task. This must be unique inside your project and not change between versions.  */
-    id: string;
-    /** The retry settings when an uncaught error is thrown.
-     *
-     * If omitted it will use the values in your `trigger.config.ts` file.
-     *
-     * @example
-     *
-     * ```
-     * export const taskWithRetries = task({
-        id: "task-with-retries",
-        retry: {
-          maxAttempts: 10,
-          factor: 1.8,
-          minTimeoutInMs: 500,
-          maxTimeoutInMs: 30_000,
-          randomize: false,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-     * */
-    retry?: RetryOptions;
-    /** Used to configure what should happen when more than one run is triggered at the same time.
-     *
-     * @example
-     * one at a time execution
-     *
-     * ```ts
-     * export const oneAtATime = task({
-        id: "one-at-a-time",
-        queue: {
-          concurrencyLimit: 1,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-     */
-    queue?: QueueOptions;
-    /** Configure the spec of the machine you want your task to run on.
-     *
-     * @example
-     *
-     * ```ts
-     * export const heavyTask = task({
-        id: "heavy-task",
-        machine: {
-          cpu: 2,
-          memory: 4,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-    */
-    machine?: {
-        /** vCPUs. The default is 0.5.
-         *
-         * Possible values:
-         * - 0.25
-         * - 0.5
-         * - 1
-         * - 2
-         * - 4
-         */
-        cpu?: MachineCpu;
-        /** In GBs of RAM. The default is 1.
-         *
-         * Possible values:
-         * - 0.25
-         * - 0.5
-         * - 1
-         * - 2
-         * - 4
-         * - 8
-         */
-        memory?: MachineMemory;
-    };
-    /** This gets called when a task is triggered. It's where you put the code you want to execute.
-     *
-     * @param payload - The payload that is passed to your task when it's triggered. This must be JSON serializable.
-     * @param params - Metadata about the run.
-     */
-    run: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<TOutput>;
-    init?: (payload: TPayload, params: InitFnParams) => Promise<TInitOutput>;
-    handleError?: (payload: TPayload, error: unknown, params: HandleErrorFnParams<TInitOutput>) => HandleErrorResult;
-    cleanup?: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<void>;
-    middleware?: (payload: TPayload, params: MiddlewareFnParams) => Promise<void>;
-    onSuccess?: (payload: TPayload, params: SuccessFnParams<TOutput, TInitOutput>) => Promise<void>;
-};
-type InvokeHandle = {
-    id: string;
-};
-type InvokeBatchHandle = {
-    batchId: string;
-    runs: string[];
-};
-type TaskRunResult<TOutput = any> = {
-    ok: true;
-    id: string;
-    output: TOutput;
-} | {
-    ok: false;
-    id: string;
-    error: any;
-};
-type BatchResult<TOutput = any> = {
-    id: string;
-    runs: TaskRunResult<TOutput>[];
-};
-type Task<TInput, TOutput = any> = {
-    trigger: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<InvokeHandle>;
-    batchTrigger: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<InvokeBatchHandle>;
-    triggerAndWait: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<TOutput>;
-    batchTriggerAndWait: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<BatchResult<TOutput>>;
-};
-type TaskRunOptions = {
-    idempotencyKey?: string;
-    maxAttempts?: number;
-    startAt?: Date;
-    startAfter?: number;
-    queue?: TaskRunConcurrencyOptions;
-    concurrencyKey?: string;
-};
-type TaskRunConcurrencyOptions = Queue;
-type BatchRunOptions = TaskRunOptions & {
-    maxConcurrency?: number;
-};
-
-/** Creates a task that can be triggered
- * @param options - Task options
- * @example
- *
- * ```ts
- * import { task } from "@trigger.dev/sdk/v3";
- *
- * export const helloWorld = task({
-    id: "hello-world",
- *    run: async (payload: { url: string }) => {
- *    return { hello: "world" };
- *  },
- * });
- *
- * ```
- *
- * @returns A task that can be triggered
- */
-declare function task<TInput, TOutput = any, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
-
-type WaitOptions = {
-    seconds: number;
-} | {
-    minutes: number;
-} | {
-    hours: number;
-} | {
-    days: number;
-} | {
-    weeks: number;
-} | {
-    months: number;
-} | {
-    years: number;
-};
-declare const wait: {
-    for: (options: WaitOptions) => Promise<void>;
-    until: (options: {
-        date: Date;
-        throwIfInThePast?: boolean;
-    }) => Promise<void>;
-};
-
-type CacheMetadata = {
-    createdTime: number;
-    ttl?: number | null;
-};
-type CacheEntry<Value = unknown> = {
-    metadata: CacheMetadata;
-    value: Value;
-};
-type Eventually<Value> = Value | null | undefined | Promise<Value | null | undefined>;
-type CacheStore<Value = any> = {
-    name?: string;
-    get: (key: string) => Eventually<CacheEntry<Value>>;
-    set: (key: string, value: CacheEntry<Value>) => unknown | Promise<unknown>;
-    delete: (key: string) => unknown | Promise<unknown>;
-};
-type CacheFunction = <Value>(cacheKey: string, fn: () => Promise<Value> | Value) => Promise<Value> | Value;
-declare class InMemoryCache<Value = any> {
-    private _cache;
-    get(key: string): Eventually<CacheEntry<Value>>;
-    set(key: string, value: CacheEntry<Value>): unknown;
-    delete(key: string): unknown;
-}
-/**
- * Create a cache function that uses the provided store to cache values. Using InMemoryCache is safe because each task run is isolated.
- * @param store
- * @returns
- */
-declare function createCache(store: CacheStore): CacheFunction;
-
-declare function onThrow<T>(fn: (options: {
-    attempt: number;
-    maxAttempts: number;
-}) => Promise<T>, options: RetryOptions): Promise<T>;
-interface RetryFetchRequestInit extends RequestInit {
-    retry?: FetchRetryOptions;
-    timeoutInMs?: number;
-}
-declare function retryFetch(input: RequestInfo | URL, init?: RetryFetchRequestInit | undefined): Promise<Response>;
-declare const retry: {
-    onThrow: typeof onThrow;
-    fetch: typeof retryFetch;
-    interceptFetch: (...handlers: Array<HttpHandler>) => {
-        run: <T>(fn: (...args: any[]) => Promise<T>) => Promise<T>;
-    };
-};
-
-export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type Context, type Eventually, InMemoryCache, type WaitOptions, createCache, retry, task, wait };

package/dist/v3/index.d.ts

@@ -1,254 +0,0 @@
-import { TaskRunContext, InitOutput, RetryOptions, QueueOptions, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, SuccessFnParams, FetchRetryOptions } from '@trigger.dev/core/v3';
-export { HandleErrorArgs, HandleErrorFunction, LogLevel, RetryOptions, ProjectConfig as TriggerConfig, logger } from '@trigger.dev/core/v3';
-import { HttpHandler } from 'msw';
-
-type Context = TaskRunContext;
-type RequireOne<T, K extends keyof T> = {
-    [X in Exclude<keyof T, K>]?: T[X];
-} & {
-    [P in K]-?: T[P];
-};
-type Queue = RequireOne<QueueOptions, "name">;
-type TaskOptions<TPayload, TOutput = any, TInitOutput extends InitOutput = any> = {
-    /** An id for your task. This must be unique inside your project and not change between versions.  */
-    id: string;
-    /** The retry settings when an uncaught error is thrown.
-     *
-     * If omitted it will use the values in your `trigger.config.ts` file.
-     *
-     * @example
-     *
-     * ```
-     * export const taskWithRetries = task({
-        id: "task-with-retries",
-        retry: {
-          maxAttempts: 10,
-          factor: 1.8,
-          minTimeoutInMs: 500,
-          maxTimeoutInMs: 30_000,
-          randomize: false,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-     * */
-    retry?: RetryOptions;
-    /** Used to configure what should happen when more than one run is triggered at the same time.
-     *
-     * @example
-     * one at a time execution
-     *
-     * ```ts
-     * export const oneAtATime = task({
-        id: "one-at-a-time",
-        queue: {
-          concurrencyLimit: 1,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-     */
-    queue?: QueueOptions;
-    /** Configure the spec of the machine you want your task to run on.
-     *
-     * @example
-     *
-     * ```ts
-     * export const heavyTask = task({
-        id: "heavy-task",
-        machine: {
-          cpu: 2,
-          memory: 4,
-        },
-        run: async ({ payload, ctx }) => {
-          //...
-        },
-      });
-     * ```
-    */
-    machine?: {
-        /** vCPUs. The default is 0.5.
-         *
-         * Possible values:
-         * - 0.25
-         * - 0.5
-         * - 1
-         * - 2
-         * - 4
-         */
-        cpu?: MachineCpu;
-        /** In GBs of RAM. The default is 1.
-         *
-         * Possible values:
-         * - 0.25
-         * - 0.5
-         * - 1
-         * - 2
-         * - 4
-         * - 8
-         */
-        memory?: MachineMemory;
-    };
-    /** This gets called when a task is triggered. It's where you put the code you want to execute.
-     *
-     * @param payload - The payload that is passed to your task when it's triggered. This must be JSON serializable.
-     * @param params - Metadata about the run.
-     */
-    run: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<TOutput>;
-    init?: (payload: TPayload, params: InitFnParams) => Promise<TInitOutput>;
-    handleError?: (payload: TPayload, error: unknown, params: HandleErrorFnParams<TInitOutput>) => HandleErrorResult;
-    cleanup?: (payload: TPayload, params: RunFnParams<TInitOutput>) => Promise<void>;
-    middleware?: (payload: TPayload, params: MiddlewareFnParams) => Promise<void>;
-    onSuccess?: (payload: TPayload, params: SuccessFnParams<TOutput, TInitOutput>) => Promise<void>;
-};
-type InvokeHandle = {
-    id: string;
-};
-type InvokeBatchHandle = {
-    batchId: string;
-    runs: string[];
-};
-type TaskRunResult<TOutput = any> = {
-    ok: true;
-    id: string;
-    output: TOutput;
-} | {
-    ok: false;
-    id: string;
-    error: any;
-};
-type BatchResult<TOutput = any> = {
-    id: string;
-    runs: TaskRunResult<TOutput>[];
-};
-type Task<TInput, TOutput = any> = {
-    trigger: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<InvokeHandle>;
-    batchTrigger: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<InvokeBatchHandle>;
-    triggerAndWait: (params: {
-        payload: TInput;
-        options?: TaskRunOptions;
-    }) => Promise<TOutput>;
-    batchTriggerAndWait: (params: {
-        items: {
-            payload: TInput;
-            options?: TaskRunOptions;
-        }[];
-        batchOptions?: BatchRunOptions;
-    }) => Promise<BatchResult<TOutput>>;
-};
-type TaskRunOptions = {
-    idempotencyKey?: string;
-    maxAttempts?: number;
-    startAt?: Date;
-    startAfter?: number;
-    queue?: TaskRunConcurrencyOptions;
-    concurrencyKey?: string;
-};
-type TaskRunConcurrencyOptions = Queue;
-type BatchRunOptions = TaskRunOptions & {
-    maxConcurrency?: number;
-};
-
-/** Creates a task that can be triggered
- * @param options - Task options
- * @example
- *
- * ```ts
- * import { task } from "@trigger.dev/sdk/v3";
- *
- * export const helloWorld = task({
-    id: "hello-world",
- *    run: async (payload: { url: string }) => {
- *    return { hello: "world" };
- *  },
- * });
- *
- * ```
- *
- * @returns A task that can be triggered
- */
-declare function task<TInput, TOutput = any, TInitOutput extends InitOutput = any>(options: TaskOptions<TInput, TOutput, TInitOutput>): Task<TInput, TOutput>;
-
-type WaitOptions = {
-    seconds: number;
-} | {
-    minutes: number;
-} | {
-    hours: number;
-} | {
-    days: number;
-} | {
-    weeks: number;
-} | {
-    months: number;
-} | {
-    years: number;
-};
-declare const wait: {
-    for: (options: WaitOptions) => Promise<void>;
-    until: (options: {
-        date: Date;
-        throwIfInThePast?: boolean;
-    }) => Promise<void>;
-};
-
-type CacheMetadata = {
-    createdTime: number;
-    ttl?: number | null;
-};
-type CacheEntry<Value = unknown> = {
-    metadata: CacheMetadata;
-    value: Value;
-};
-type Eventually<Value> = Value | null | undefined | Promise<Value | null | undefined>;
-type CacheStore<Value = any> = {
-    name?: string;
-    get: (key: string) => Eventually<CacheEntry<Value>>;
-    set: (key: string, value: CacheEntry<Value>) => unknown | Promise<unknown>;
-    delete: (key: string) => unknown | Promise<unknown>;
-};
-type CacheFunction = <Value>(cacheKey: string, fn: () => Promise<Value> | Value) => Promise<Value> | Value;
-declare class InMemoryCache<Value = any> {
-    private _cache;
-    get(key: string): Eventually<CacheEntry<Value>>;
-    set(key: string, value: CacheEntry<Value>): unknown;
-    delete(key: string): unknown;
-}
-/**
- * Create a cache function that uses the provided store to cache values. Using InMemoryCache is safe because each task run is isolated.
- * @param store
- * @returns
- */
-declare function createCache(store: CacheStore): CacheFunction;
-
-declare function onThrow<T>(fn: (options: {
-    attempt: number;
-    maxAttempts: number;
-}) => Promise<T>, options: RetryOptions): Promise<T>;
-interface RetryFetchRequestInit extends RequestInit {
-    retry?: FetchRetryOptions;
-    timeoutInMs?: number;
-}
-declare function retryFetch(input: RequestInfo | URL, init?: RetryFetchRequestInit | undefined): Promise<Response>;
-declare const retry: {
-    onThrow: typeof onThrow;
-    fetch: typeof retryFetch;
-    interceptFetch: (...handlers: Array<HttpHandler>) => {
-        run: <T>(fn: (...args: any[]) => Promise<T>) => Promise<T>;
-    };
-};
-
-export { type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type Context, type Eventually, InMemoryCache, type WaitOptions, createCache, retry, task, wait };