@trigger.dev/convex 0.0.0-stage → 4.8.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2023] [Trigger.dev]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,172 @@
-# Temporary Holding Version
+# @trigger.dev/convex
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run Trigger.dev tasks from Convex mutations and read their status and results through Convex reactive queries.
+
+Use Convex for application state and Trigger.dev for work that needs longer execution, more memory, ffmpeg, Playwright, Python, or other system dependencies. Tasks are still written and deployed normally with Trigger.dev.
+
+**Experimental MVP.** No HTTP routes, webhooks, Trigger lifecycle hooks, or changes to your Trigger server are required.
+
+## Install
+
+```sh
+npm install @trigger.dev/convex convex
+npx convex env set TRIGGER_SECRET_KEY tr_dev_...
+```
+
+Choose the Trigger environment's secret key. Never expose it to browser code.
+
+```ts
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import trigger from "@trigger.dev/convex/convex.config.js";
+
+const app = defineApp();
+app.use(trigger);
+export default app;
+```
+
+Run `npx convex dev` to generate your application's component references.
+
+```ts
+// convex/trigger.ts
+import { Trigger } from "@trigger.dev/convex";
+import { components, internal } from "./_generated/api";
+
+export const trigger: Trigger = new Trigger(components.trigger, {
+  onComplete: internal.jobs.onComplete, // Optional internal mutation
+});
+```
+
+The explicit `Trigger` annotation avoids circular type inference through Convex's generated API when configuring a completion callback.
+
+## Example: request work and read the result
+
+The example assumes a Trigger task named `render-video` exists. Type-only task imports do not bundle task code into Convex.
+
+```ts
+// convex/schema.ts
+import { defineSchema, defineTable } from "convex/server";
+import { v } from "convex/values";
+
+export default defineSchema({
+  jobs: defineTable({
+    owner: v.string(),
+    runId: v.optional(v.string()),
+    status: v.string(),
+    output: v.optional(v.any()),
+  }).index("by_runId", ["runId"]),
+});
+```
+
+```ts
+// convex/jobs.ts
+import { vRun } from "@trigger.dev/convex";
+import { v } from "convex/values";
+import { mutation, query, internalMutation } from "./_generated/server";
+import { trigger } from "./trigger";
+import type { renderVideo } from "../trigger/renderVideo";
+
+export const request = mutation({
+  args: { videoUrl: v.string() },
+  handler: async (ctx, { videoUrl }) => {
+    const user = await ctx.auth.getUserIdentity();
+    if (!user) throw new Error("Unauthorized");
+
+    const jobId = await ctx.db.insert("jobs", {
+      owner: user.subject,
+      status: "PENDING",
+    });
+    const runId = await trigger.trigger<typeof renderVideo>(
+      ctx,
+      "render-video",
+      { videoUrl },
+      { tags: [`job:${jobId}`] },
+    );
+    await ctx.db.patch(jobId, { runId });
+    return jobId;
+  },
+});
+
+export const status = query({
+  args: { jobId: v.id("jobs") },
+  handler: async (ctx, { jobId }) => {
+    const user = await ctx.auth.getUserIdentity();
+    const job = await ctx.db.get(jobId);
+    if (!user || !job || job.owner !== user.subject) return null;
+    return job.runId ? trigger.getRun(ctx, job.runId) : null;
+  },
+});
+
+export const onComplete = internalMutation({
+  args: { run: vRun },
+  handler: async (ctx, { run }) => {
+    const job = await ctx.db.query("jobs")
+      .withIndex("by_runId", q => q.eq("runId", run.id))
+      .unique();
+    if (job) await ctx.db.patch(job._id, {
+      status: run.status,
+      output: run.output,
+    });
+  },
+});
+```
+
+```tsx
+// React
+const run = useQuery(api.jobs.status, { jobId });
+// run.status, run.output, run.error, run.metadata, run.syncStatus
+```
+
+The ID returned by `trigger.trigger` identifies the **component record**, not the Trigger.dev run. The latter becomes available as `run.runId` after submission.
+
+## API
+
+- `trigger(ctx, taskId, payload, options?)`: enqueue work. Calling from a mutation makes the request atomic with your application's writes.
+- `getRun(ctx, id)`: read one record reactively.
+- `listRuns(ctx, paginationOpts)`: paginate records, newest first, up to 100 per page and a bounded read budget.
+- `resume(ctx, id)`: resume paused synchronization using the current credentials.
+
+Trigger options include tags, delay, queue name, concurrency key, machine, metadata, max attempts, max duration, TTL, and a component-level idempotency key.
+
+An optional `idempotencyKey` deduplicates requests across this component instance, regardless of task. Reusing a key returns the original record, even if its payload or task differs. Keys remain reserved while records exist.
+
+The constructor accepts `secretKey` (defaults to `TRIGGER_SECRET_KEY`), `baseUrl` (defaults to `https://api.trigger.dev`), and `onComplete`. HTTP base URLs are permitted only for localhost development.
+
+**Authorization belongs in your application's functions.** The component has no tenant or user model. Do not expose arbitrary record IDs or `listRuns` to clients without enforcing ownership. Queries never return stored credentials or request payloads.
+
+## Execution and reliability
+
+1. The calling mutation writes a component record and schedules submission. If the transaction rolls back, neither survives.
+2. A short action submits to the existing Trigger API with a stable key derived from the record ID.
+3. Scheduled actions retrieve status with backoff from approximately 15 to 60 seconds between checks. Nothing runs in Convex between checks.
+4. A terminal state, including cancellation, is persisted. The optional completion mutation runs in the same transaction, then stored request data and credentials are deleted.
+
+A scheduled watchdog is committed before each network action. An interrupted action is retried on the next check; obsolete responses cannot overwrite newer observations.
+
+Remote submission uses a 24-hour idempotency TTL. Automatic submission retries stop within one hour of creating the record, well before that TTL. This is **not an unlimited exactly-once guarantee**.
+
+Permanent API errors pause synchronization immediately. Eight consecutive transient or callback failures also pause it. Check `syncStatus === "paused"` and `syncError`. Fix the cause, then call `resume` from an authorized mutation. If submission has not been confirmed, it can only resume within the original one-hour window. After that, reconcile with the Trigger dashboard before creating new work.
+
+Keep the same Trigger environment when resuming. Changing credentials does not migrate remote runs between environments. Existing requests retain their original credentials until resumed.
+
+Completion callbacks should be short mutations. If a callback throws, completion and its application writes roll back together and are retried. A broken callback can therefore delay the component's completion state; `syncError` reports synchronization trouble. No callback is needed to use reactive results.
+
+## Limits
+
+- Polling costs Convex executions and Trigger API requests. This MVP is for validating the integration, not high-volume fan-out or subsecond progress.
+- Payload plus trigger options must fit within 256 KiB. Pass storage references for larger inputs.
+- Output, error, and metadata each have a 256 KiB inline budget. Oversized output is omitted with `outputOmitted: true`. Oversized error or metadata is omitted.
+- Trigger's `outputPresignedUrl`, when supplied, is preserved rather than downloaded. These URLs expire. Retrieve the run again through the Trigger API when you need a fresh URL.
+- Run records are retained. Paused requests retain their payload and credentials for recovery. Automatic retention cleanup is not included.
+- No batch API, cancellation command, waitpoint completion, schedules, or streaming yet. Trigger tasks themselves can use those features normally.
+
+## Development
+
+From the repository root:
+
+```sh
+pnpm --filter @trigger.dev/convex build
+pnpm --filter @trigger.dev/convex test
+```
+
+Tests use Convex's in-memory test runtime and real HTTP requests to a local server.

package/dist/client/index.d.ts

@@ -0,0 +1,34 @@
+import { type FunctionReference, type GenericDataModel, type GenericMutationCtx, type GenericQueryCtx, type PaginationOptions } from "convex/server";
+import type { ComponentApi } from "../component/_generated/component.js";
+import type { Run, TriggerOptions } from "../component/shared.js";
+export { vRun } from "../component/shared.js";
+export type { Run, TriggerOptions, ComponentApi };
+type MutationCtx = Pick<GenericMutationCtx<GenericDataModel>, "runMutation">;
+type QueryCtx = Pick<GenericQueryCtx<GenericDataModel>, "runQuery">;
+type TaskLike = {
+    id: string;
+    trigger: (...args: any[]) => any;
+};
+export type TriggerConfig = {
+    secretKey?: string;
+    baseUrl?: string;
+    onComplete?: FunctionReference<"mutation", "internal", {
+        run: Run;
+    }, any>;
+};
+export declare class Trigger {
+    private component;
+    private config;
+    constructor(component: ComponentApi, config?: TriggerConfig);
+    private runtimeConfig;
+    trigger<TTask extends TaskLike = TaskLike>(ctx: MutationCtx, taskId: TTask["id"], payload: Parameters<TTask["trigger"]>[0], options?: TriggerOptions & {
+        idempotencyKey?: string;
+    }): Promise<string>;
+    getRun(ctx: QueryCtx, id: string): Promise<Run | null>;
+    listRuns(ctx: QueryCtx, paginationOpts: PaginationOptions): Promise<{
+        page: Run[];
+        isDone: boolean;
+        continueCursor: string;
+    }>;
+    resume(ctx: MutationCtx, id: string): Promise<null>;
+}

package/dist/client/index.js

@@ -0,0 +1,45 @@
+import { createFunctionHandle, } from "convex/server";
+export { vRun } from "../component/shared.js";
+export class Trigger {
+    component;
+    config;
+    constructor(component, config = {}) {
+        this.component = component;
+        this.config = config;
+    }
+    runtimeConfig() {
+        const secretKey = this.config.secretKey ?? process.env.TRIGGER_SECRET_KEY;
+        if (!secretKey)
+            throw new Error("Set TRIGGER_SECRET_KEY or pass secretKey");
+        const url = new URL(this.config.baseUrl ?? "https://api.trigger.dev");
+        if (url.protocol !== "https:" &&
+            !(url.protocol === "http:" && ["localhost", "127.0.0.1", "[::1]"].includes(url.hostname))) {
+            throw new Error("baseUrl must use HTTPS, except for local development");
+        }
+        if (url.username || url.password || url.search || url.hash)
+            throw new Error("Invalid baseUrl");
+        return { secretKey, baseUrl: url.toString().replace(/\/$/, "") };
+    }
+    async trigger(ctx, taskId, payload, options = {}) {
+        const { idempotencyKey, ...triggerOptions } = options;
+        return ctx.runMutation(this.component.runs.trigger, {
+            taskId,
+            payload,
+            options: triggerOptions,
+            idempotencyKey,
+            config: this.runtimeConfig(),
+            callback: this.config.onComplete
+                ? await createFunctionHandle(this.config.onComplete)
+                : undefined,
+        });
+    }
+    async getRun(ctx, id) {
+        return ctx.runQuery(this.component.runs.get, { id });
+    }
+    async listRuns(ctx, paginationOpts) {
+        return ctx.runQuery(this.component.runs.list, { paginationOpts });
+    }
+    async resume(ctx, id) {
+        return ctx.runMutation(this.component.runs.resume, { id, config: this.runtimeConfig() });
+    }
+}

package/dist/component/_generated/component.d.ts

@@ -0,0 +1,11 @@
+import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
+import type * as runs from "../runs.js";
+type PublicApi = FilterApi<ApiFromModules<{
+    runs: typeof runs;
+}>, FunctionReference<any, "public">>;
+export type ComponentApi<Name extends string | undefined = string | undefined> = {
+    runs: {
+        [Key in keyof PublicApi["runs"]]: PublicApi["runs"][Key] extends FunctionReference<infer Type, any, infer Args, infer Result> ? FunctionReference<Type, "internal", Args, Result, Name> : never;
+    };
+};
+export {};

package/dist/component/_generated/component.js

@@ -0,0 +1 @@
+export {};

package/dist/component/api.d.ts

@@ -0,0 +1,9 @@
+import { type ApiFromModules, type FilterApi, type FunctionReference } from "convex/server";
+import type * as runs from "./runs.js";
+import type * as worker from "./worker.js";
+type Api = ApiFromModules<{
+    runs: typeof runs;
+    worker: typeof worker;
+}>;
+export declare const internal: FilterApi<Api, FunctionReference<any, "internal">>;
+export {};

package/dist/component/api.js

@@ -0,0 +1,2 @@
+import { anyApi } from "convex/server";
+export const internal = anyApi;

package/dist/component/apiClient.d.ts

@@ -0,0 +1,10 @@
+import { type Config } from "./shared.js";
+export declare class ApiError extends Error {
+    retryable: boolean;
+    constructor(message: string, retryable: boolean);
+}
+export declare function request(config: Config, path: string, body?: unknown): Promise<Record<string, unknown>>;
+export declare function inlineValue(value: unknown): {
+    value?: any;
+    omitted: boolean;
+};

package/dist/component/apiClient.js

@@ -0,0 +1,48 @@
+import { MAX_INLINE_BYTES, REQUEST_TIMEOUT_MS } from "./shared.js";
+export class ApiError extends Error {
+    retryable;
+    constructor(message, retryable) {
+        super(message);
+        this.retryable = retryable;
+    }
+}
+export async function request(config, path, body) {
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), REQUEST_TIMEOUT_MS);
+    try {
+        const response = await fetch(config.baseUrl + path, {
+            method: body === undefined ? "GET" : "POST",
+            headers: { Authorization: `Bearer ${config.secretKey}`, "Content-Type": "application/json" },
+            body: body === undefined ? undefined : JSON.stringify(body),
+            signal: controller.signal,
+            redirect: "error",
+        });
+        if (!response.ok) {
+            await response.body?.cancel();
+            const retryHeader = response.headers.get("x-should-retry");
+            // Never persist response bodies, which could contain credentials or payloads.
+            throw new ApiError(`Trigger.dev API returned HTTP ${response.status}`, retryHeader === "true" ||
+                (retryHeader !== "false" &&
+                    (response.status === 408 ||
+                        response.status === 409 ||
+                        response.status === 429 ||
+                        response.status >= 500)));
+        }
+        const data = await response.json();
+        if (!data || typeof data !== "object" || Array.isArray(data)) {
+            throw new ApiError("Invalid Trigger.dev response", true);
+        }
+        return data;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+export function inlineValue(value) {
+    if (value === undefined)
+        return { omitted: false };
+    if (new TextEncoder().encode(JSON.stringify(value)).byteLength > MAX_INLINE_BYTES) {
+        return { omitted: true };
+    }
+    return { value, omitted: false };
+}

package/dist/component/convex.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("convex/server").ComponentDefinition<any, {}>;
+export default _default;

package/dist/component/convex.config.js

@@ -0,0 +1,2 @@
+import { defineComponent } from "convex/server";
+export default defineComponent("trigger");