feat: add Convex adapter

examples/backend-adapters/server/package.json

@@ -12,6 +12,7 @@
     "dev:effect": "NODE_ENV=development PORT=3003 tsx watch src/effect-platform.ts"
   },
   "dependencies": {
+    "convex": "^1.16.0",
     "@effect/platform": "0.68.5",
     "@effect/platform-node": "0.63.5",
     "@effect/schema": "0.75.4",

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

@@ -0,0 +1,28 @@
+// 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 `cereateUploadthing` 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((args) => {
+      return { uploadedBy: args.metadata.userId };
+    }),
+} satisfies FileRouter;
+
+const http = httpRouter();
+addUploadthingRoutes(http, { router });
+export default http;

packages/uploadthing/package.json

@@ -99,6 +99,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",
@@ -126,6 +136,7 @@
   },
   "files": [
     "client",
+    "convex",
     "effect-platform",
     "express",
     "fastify",
@@ -182,6 +193,7 @@
     "zod": "^3.23.8"
   },
   "peerDependencies": {
+    "convex": "*",
     "express": "*",
     "fastify": "*",
     "h3": "*",
@@ -198,6 +210,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, httpRouter } from "convex/server";
+import * as Effect from "effect/Effect";
+
+import type { Json } from "@uploadthing/shared";
+
+import { makeAdapterHandler } from "./internal/handler";
+import type { FileRouter, RouteHandlerOptions } from "./internal/types";
+import { createBuilder } from "./internal/upload-builder";
+import type { CreateBuilderOptions } from "./internal/upload-builder";
+
+export type { FileRouter };
+
+type MiddlewareArgs<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<
+    MiddlewareArgs<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/**",
         "effect-platform/**",
         "express/**",
         "fastify/**",