feat: Add Convex Adapter

.changeset/swift-beds-explain.md

@@ -0,0 +1,5 @@
+---
+"uploadthing": minor
+---
+
+Add Convex Adapter

packages/uploadthing/package.json

@@ -126,6 +126,26 @@
         "default": "./remix/index.cjs"
       }
     },
+    "./convex": {
+      "import": {
+        "types": "./convex/index.d.ts",
+        "default": "./convex/index.js"
+      },
+      "require": {
+        "types": "./convex/index.d.cts",
+        "default": "./convex/index.cjs"
+      }
+    },
+    "./convex-helpers": {
+      "import": {
+        "types": "./convex-helpers/index.d.ts",
+        "default": "./convex-helpers/index.js"
+      },
+      "require": {
+        "types": "./convex-helpers/index.d.cts",
+        "default": "./convex-helpers/index.cjs"
+      }
+    },
     "./types": {
       "types": "./types/index.d.ts",
       "default": "./types/index.js"
@@ -134,6 +154,8 @@
   "files": [
     "client",
     "client-future",
+    "convex",
+    "convex-helpers",
     "dist",
     "effect-platform",
     "express",
@@ -194,6 +216,7 @@
     "zod": "^3.24.1"
   },
   "peerDependencies": {
+    "convex": "*",
     "express": "*",
     "h3": "*",
     "tailwindcss": "^3.0.0 || ^4.0.0-beta.0"
@@ -211,6 +234,9 @@
     "h3": {
       "optional": true
     },
+    "convex": {
+      "optional": true
+    },
     "tailwindcss": {
       "optional": true
     }

packages/uploadthing/src/convex-helpers.ts

@@ -0,0 +1,72 @@
+import type { FunctionReference, HttpRouter } from "convex/server";
+import { httpActionGeneric } from "convex/server";
+
+const addCorsHeaders = (headers?: Record<string, string>) => {
+  if (!process.env.CLIENT_ORIGIN) {
+    throw new Error("Convex deployment doesn't have CLIENT_ORIGIN set");
+  }
+
+  return new Headers({
+    ...headers,
+    "Access-Control-Allow-Origin": process.env.CLIENT_ORIGIN,
+    "Access-Control-Allow-Methods": "GET, POST, OPTIONS",
+    "Access-Control-Allow-Headers": "*",
+    "Access-Control-Max-Age": "86400",
+  });
+};
+
+export const createRouteHandler = (
+  http: HttpRouter,
+  internalAction: FunctionReference<
+    "action",
+    "internal",
+    {
+      request: {
+        url: string;
+        method: string;
+        headers: Record<string, string>;
+        body?: string;
+      };
+    },
+    {
+      status: number;
+      statusText: string;
+      headers: Record<string, string>;
+      body: string;
+    }
+  >,
+) => {
+  const handler = httpActionGeneric(async (ctx, req) => {
+    const headers: Record<string, string> = {};
+    req.headers.forEach((value, key) => {
+      headers[key] = value;
+    });
+    const request = {
+      url: req.url,
+      method: req.method,
+      headers,
+      body: await req.text(),
+    };
+    const response = await ctx.runAction(internalAction, { request });
+
+    return new Response(response.body, {
+      status: response.status,
+      statusText: response.statusText,
+      headers: addCorsHeaders(response.headers),
+    });
+  });
+
+  http.route({
+    method: "OPTIONS",
+    path: "/api/uploadthing",
+    handler: httpActionGeneric(async () =>
+      Promise.resolve(
+        new Response(null, { status: 204, headers: addCorsHeaders() }),
+      ),
+    ),
+  });
+
+  http.route({ method: "GET", path: "/api/uploadthing", handler });
+
+  http.route({ method: "POST", path: "/api/uploadthing", handler });
+};

packages/uploadthing/src/convex.ts

@@ -0,0 +1,76 @@
+import { internalActionGeneric } from "convex/server";
+import type { GenericActionCtx, GenericDataModel } from "convex/server";
+import { v } from "convex/values";
+import * as Effect from "effect/Effect";
+
+import type { Json } from "@uploadthing/shared";
+
+import { makeAdapterHandler } from "./_internal/handler";
+import { createBuilder } from "./_internal/upload-builder";
+import type { CreateBuilderOptions } from "./_internal/upload-builder";
+import type { FileRouter, RouteHandlerOptions } from "./types";
+
+export {
+  UTFiles,
+  /**
+   * This is an experimental feature.
+   * You need to be feature flagged on our backend to use this
+   */
+  UTRegion as experimental_UTRegion,
+} from "./_internal/types";
+export type { FileRouter };
+
+type AdapterArgs = {
+  ctx: GenericActionCtx<GenericDataModel>;
+  req: Request;
+};
+
+export const createUploadthing = <TErrorShape extends Json>(
+  opts?: CreateBuilderOptions<TErrorShape>,
+) => createBuilder<AdapterArgs, TErrorShape>(opts);
+
+export const createInternalAction = <TRouter extends FileRouter>(
+  opts: RouteHandlerOptions<TRouter>,
+) => {
+  const handler = makeAdapterHandler<
+    [GenericActionCtx<GenericDataModel>, Request],
+    AdapterArgs
+  >(
+    (ctx, req) => Effect.succeed({ ctx, req }),
+    (_, req) => Effect.succeed(req),
+    opts,
+    "convex",
+  );
+
+  return internalActionGeneric({
+    args: {
+      request: v.object({
+        url: v.string(),
+        method: v.string(),
+        headers: v.record(v.string(), v.string()),
+        body: v.optional(v.string()),
+      }),
+    },
+    handler: async (ctx: GenericActionCtx<GenericDataModel>, args) => {
+      const request = new Request(args.request.url, {
+        method: args.request.method,
+        headers: new Headers(args.request.headers),
+        body: args.request.body ? new Blob([args.request.body]) : null,
+      });
+
+      const response = await handler(ctx, request);
+
+      const headers: Record<string, string> = {};
+      response.headers.forEach((value, key) => {
+        headers[key] = value;
+      });
+
+      return {
+        status: response.status,
+        statusText: response.statusText,
+        headers,
+        body: await response.text(),
+      };
+    },
+  });
+};

packages/uploadthing/tsdown.config.ts

@@ -15,6 +15,8 @@ export default defineConfig({
     "../h3/index": "src/h3.ts",
     "../remix/index": "src/remix.ts",
     "../types/index": "src/types.ts",
+    "../convex/index": "src/convex.ts",
+    "../convex-helpers/index": "src/convex-helpers.ts",
   },
   format: ["esm", "cjs"],
   dts: {

packages/uploadthing/turbo.json

@@ -6,6 +6,8 @@
       "outputs": [
         "client/**",
         "client-future/**",
+        "convex/**",
+        "convex-helpers/**",
         "dist/**",
         "effect-platform/**",
         "express/**",