feat: add Convex adapter

examples/backend-adapters/server/package.json

@@ -18,6 +18,7 @@
     "@fastify/cors": "^10.0.1",
     "@hono/node-server": "^1.13.7",
     "@sinclair/typebox": "^0.34.13",
+    "convex": "^1.17.4",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "effect": "3.12.0",

examples/backend-adapters/server/src/convex.ts

@@ -0,0 +1,34 @@
+// In a real Convex app, you'd create this file at `convex/http.ts` to set
+// up HTTP routes for UploadThing.
+
+import { httpRouter } from "convex/server";
+
+import {
+  addUploadthingRoutes,
+  createUploadthing,
+  FileRouter,
+} from "uploadthing/convex";
+
+// In a real app, you can wire up `createUploadthing` to your Convex
+// schema for increased type safety.
+// ```ts
+// import schema from "./schema";
+// const f = createUploadthing({ schema })
+// ```
+const f = createUploadthing();
+
+const router = {
+  imageUploader: f({ image: { maxFileSize: "4MB" } })
+    .middleware(async ({ event }) => {
+      const identity = await event.auth.getUserIdentity();
+      return { userId: identity?.subject ?? "nothing" };
+    })
+    .onUploadComplete(({ metadata, event }) => {
+      console.log("Upload complete!", metadata);
+      return { uploadedBy: metadata.userId };
+    }),
+} satisfies FileRouter;
+
+const http = httpRouter();
+addUploadthingRoutes(http, { router });
+export default http;

packages/uploadthing/package.json

@@ -101,6 +101,16 @@
         "default": "./h3/index.cjs"
       }
     },
+    "./convex": {
+      "import": {
+        "types": "./convex/index.d.ts",
+        "default": "./convex/index.js"
+      },
+      "require": {
+        "types": "./convex/index.d.cts",
+        "default": "./convex/index.cjs"
+      }
+    },
     "./remix": {
       "import": {
         "types": "./remix/index.d.ts",
@@ -118,6 +128,7 @@
   },
   "files": [
     "client",
+    "convex",
     "dist",
     "effect-platform",
     "express",
@@ -158,6 +169,7 @@
     "@uploadthing/tsconfig": "workspace:*",
     "body-parser": "^1.20.2",
     "bunchee": "^6.2.0",
+    "convex": "^1.17.4",
     "eslint": "9.17.0",
     "express": "^5.0.1",
     "fastify": "^5.2.0",
@@ -172,6 +184,7 @@
     "zod": "^3.24.1"
   },
   "peerDependencies": {
+    "convex": "*",
     "express": "*",
     "h3": "*",
     "tailwindcss": "^3.0.0 || ^4.0.0-beta.0"
@@ -186,6 +199,9 @@
     "fastify": {
       "optional": true
     },
+    "convex": {
+      "optional": true
+    },
     "h3": {
       "optional": true
     },

packages/uploadthing/src/convex.ts

@@ -0,0 +1,94 @@
+import type {
+  DataModelFromSchemaDefinition,
+  GenericActionCtx,
+  GenericDataModel,
+  HttpRouter,
+  SchemaDefinition,
+} from "convex/server";
+import { httpActionGeneric } from "convex/server";
+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 type { FileRouter };
+
+type AdapterArgs<DataModel extends GenericDataModel> = {
+  req: Request;
+  res: undefined;
+  event: GenericActionCtx<DataModel>;
+};
+
+type ConvexBuilderOptions<
+  TErrorShape extends Json,
+  SchemaDef extends SchemaDefinition<any, boolean>,
+> = CreateBuilderOptions<TErrorShape> & {
+  schema?: SchemaDef;
+};
+
+export const createUploadthing = <
+  TErrorShape extends Json,
+  SchemaDef extends SchemaDefinition<any, boolean>,
+>(
+  opts?: ConvexBuilderOptions<TErrorShape, SchemaDef>,
+) =>
+  createBuilder<
+    AdapterArgs<DataModelFromSchemaDefinition<SchemaDef>>,
+    TErrorShape
+  >(opts);
+
+export const addUploadthingRoutes = <TRouter extends FileRouter>(
+  router: HttpRouter,
+  opts: RouteHandlerOptions<TRouter>,
+) => {
+  const handler = makeAdapterHandler<
+    [GenericActionCtx<GenericDataModel>, Request]
+  >(
+    (ctx, req) => Effect.succeed({ req, res: undefined, event: ctx }),
+    (_, req) => Effect.succeed(req),
+    opts,
+    "convex",
+  );
+
+  router.route({
+    method: "GET",
+    path: "/api/uploadthing",
+    handler: httpActionGeneric(handler),
+  });
+
+  router.route({
+    method: "POST",
+    path: "/api/uploadthing",
+    handler: httpActionGeneric(handler),
+  });
+
+  router.route({
+    method: "OPTIONS",
+    path: "/api/uploadthing",
+    handler: httpActionGeneric((_ctx, { headers }) => {
+      const isCorsRequest =
+        headers.get("Origin") != null &&
+        headers.get("Access-Control-Request-Method") != null &&
+        headers.get("Access-Control-Request-Headers") != null;
+
+      if (!isCorsRequest) {
+        return Promise.resolve(new Response());
+      }
+      return Promise.resolve(
+        new Response(null, {
+          status: 200,
+          headers: {
+            "Access-Control-Allow-Origin": "*",
+            "Access-Control-Allow-Methods": "POST, GET, OPTIONS",
+            "Access-Control-Allow-Headers": "*",
+            "Access-Control-Max-Age": "86400",
+          },
+        }),
+      );
+    }),
+  });
+};

packages/uploadthing/turbo.json

@@ -5,6 +5,7 @@
     "build": {
       "outputs": [
         "client/**",
+        "convex/**",
         "dist/**",
         "effect-platform/**",
         "express/**",