@transloadit/convex 0.0.5 → 0.1.0

package/dist/test/index.d.ts

@@ -40,11 +40,11 @@ export declare function createTransloaditTest(): import("convex-test").TestConve
     results: import("convex/server").TableDefinition<import("convex/values").VObject<{
         userId?: string | undefined;
         album?: string | undefined;
-        mime?: string | undefined;
+        resultId?: string | undefined;
+        sslUrl?: string | undefined;
         name?: string | undefined;
         size?: number | undefined;
-        sslUrl?: string | undefined;
-        resultId?: string | undefined;
+        mime?: string | undefined;
         assemblyId: string;
         raw: any;
         stepName: string;
@@ -61,7 +61,7 @@ export declare function createTransloaditTest(): import("convex-test").TestConve
         mime: import("convex/values").VString<string | undefined, "optional">;
         raw: import("convex/values").VAny<any, "required", string>;
         createdAt: import("convex/values").VFloat64<number, "required">;
-    }, "required", "assemblyId" | "raw" | "userId" | "stepName" | "album" | "mime" | "name" | "size" | "sslUrl" | "resultId" | "createdAt" | `raw.${string}`>, {
+    }, "required", "assemblyId" | "raw" | "userId" | "stepName" | "album" | "createdAt" | `raw.${string}` | "resultId" | "sslUrl" | "name" | "size" | "mime">, {
         by_assemblyId: ["assemblyId", "_creationTime"];
         by_assemblyId_and_step: ["assemblyId", "stepName", "_creationTime"];
         by_album: ["album", "_creationTime"];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@transloadit/convex",
   "description": "Transloadit component for Convex",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "type": "module",
   "packageManager": "yarn@4.5.0",
   "repository": {
@@ -35,6 +35,7 @@
     "verify:convex": "yarn verify:cloud",
     "deploy:cloud": "node scripts/deploy-cloud.ts",
     "demo:cleanup": "node scripts/cleanup-demo.ts",
+    "demo:media": "node scripts/generate-demo-media.ts",
     "example:dev": "yarn build && node ./node_modules/next/dist/bin/next dev example",
     "example:build": "yarn build && node ./node_modules/next/dist/bin/next build example",
     "example:start": "yarn build && node ./node_modules/next/dist/bin/next start example",
@@ -57,11 +58,6 @@
       "types": "./dist/client/index.d.ts",
       "default": "./dist/client/index.js"
     },
-    "./react": {
-      "@convex-dev/component-source": "./src/react/index.tsx",
-      "types": "./dist/react/index.d.ts",
-      "default": "./dist/react/index.js"
-    },
     "./lib": {
       "@convex-dev/component-source": "./src/component/lib.ts",
       "types": "./dist/component/lib.d.ts",
@@ -82,18 +78,11 @@
     }
   },
   "peerDependencies": {
-    "convex": "^1.24.8",
-    "react": "^18.3.1 || ^19.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    }
+    "convex": "^1.24.8"
   },
   "dependencies": {
     "@transloadit/utils": "^4.1.9",
-    "@transloadit/zod": "^4.1.9",
-    "tus-js-client": "^4.3.1"
+    "@transloadit/zod": "^4.1.9"
   },
   "devDependencies": {
     "@auth/core": "^0.37.0",
@@ -102,6 +91,7 @@
     "@changesets/cli": "^2.29.8",
     "@convex-dev/auth": "^0.0.90",
     "@edge-runtime/vm": "^5.0.0",
+    "@fal-ai/client": "^1.8.4",
     "@playwright/test": "^1.57.0",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.0",
@@ -111,7 +101,7 @@
     "@uppy/core": "^5.2.0",
     "@uppy/dashboard": "^5.1.0",
     "@uppy/react": "^5.1.1",
-    "@uppy/tus": "^5.1.0",
+    "@uppy/transloadit": "^5.4.0",
     "convex": "^1.31.4",
     "convex-test": "^0.0.41",
     "dotenv": "^17.2.3",

package/src/client/index.ts

@@ -1,10 +1,33 @@
 import type { AssemblyStatus } from "@transloadit/zod/v3/assemblyStatus";
 import type { AssemblyInstructionsInput } from "@transloadit/zod/v3/template";
 import { actionGeneric, mutationGeneric, queryGeneric } from "convex/server";
-import { type Infer, v } from "convex/values";
+import { v } from "convex/values";
 import type { ComponentApi } from "../component/_generated/component.ts";
+import {
+  type AssemblyOptions,
+  type AssemblyResponse,
+  type AssemblyResultResponse,
+  type CreateAssemblyArgs,
+  vAssemblyIdArgs,
+  vAssemblyOptions,
+  vAssemblyResponse,
+  vAssemblyResultResponse,
+  vCreateAssemblyArgs,
+  vCreateAssemblyReturn,
+  vListAlbumResultsArgs,
+  vListAssembliesArgs,
+  vListResultsArgs,
+  vPurgeAlbumArgs,
+  vPurgeAlbumResponse,
+  vQueueWebhookResponse,
+  vStoreAssemblyMetadataArgs,
+  vWebhookActionArgs,
+  vWebhookResponse,
+} from "../shared/schemas.ts";
 import type { RunActionCtx, RunMutationCtx, RunQueryCtx } from "./types.ts";
 
+export { vAssemblyResponse, vAssemblyResultResponse, vCreateAssemblyArgs };
+
 export {
   assemblyStatusErrCodeSchema,
   assemblyStatusOkCodeSchema,
@@ -20,11 +43,6 @@ export {
   isAssemblyTerminalOk,
   isAssemblyTerminalOkStatus,
 } from "@transloadit/zod/v3/assemblyStatus";
-export type {
-  ParsedWebhookRequest,
-  VerifiedWebhookRequest,
-  WebhookActionArgs,
-} from "../component/apiUtils.ts";
 export {
   buildWebhookQueueArgs,
   handleWebhookRequest,
@@ -62,10 +80,10 @@ export {
   getResultUrl,
 } from "../shared/resultUtils.ts";
 export type {
-  TusMetadataOptions,
-  TusUploadConfig,
-} from "../shared/tusUpload.ts";
-export { buildTusUploadConfig } from "../shared/tusUpload.ts";
+  ParsedWebhookRequest,
+  VerifiedWebhookRequest,
+  WebhookActionArgs,
+} from "../shared/schemas.ts";
 export type { AssemblyStatus, AssemblyInstructionsInput };
 
 export interface TransloaditConfig {
@@ -85,56 +103,13 @@ function requireEnv(names: string[]): string {
   throw new Error(`Missing ${names.join(" or ")} environment variable`);
 }
 
-export const vAssemblyResponse = v.object({
-  _id: v.string(),
-  _creationTime: v.number(),
-  assemblyId: v.string(),
-  status: v.optional(v.string()),
-  ok: v.optional(v.string()),
-  message: v.optional(v.string()),
-  templateId: v.optional(v.string()),
-  notifyUrl: v.optional(v.string()),
-  numExpectedUploadFiles: v.optional(v.number()),
-  fields: v.optional(v.record(v.string(), v.any())),
-  uploads: v.optional(v.array(v.any())),
-  results: v.optional(v.record(v.string(), v.array(v.any()))),
-  error: v.optional(v.any()),
-  raw: v.optional(v.any()),
-  createdAt: v.number(),
-  updatedAt: v.number(),
-  userId: v.optional(v.string()),
-});
-
-export type AssemblyResponse = Infer<typeof vAssemblyResponse>;
-
-export const vAssemblyResultResponse = v.object({
-  _id: v.string(),
-  _creationTime: v.number(),
-  assemblyId: v.string(),
-  album: v.optional(v.string()),
-  userId: v.optional(v.string()),
-  stepName: v.string(),
-  resultId: v.optional(v.string()),
-  sslUrl: v.optional(v.string()),
-  name: v.optional(v.string()),
-  size: v.optional(v.number()),
-  mime: v.optional(v.string()),
-  raw: v.any(),
-  createdAt: v.number(),
-});
-
-export type AssemblyResultResponse = Infer<typeof vAssemblyResultResponse>;
-
-export const vCreateAssemblyArgs = v.object({
-  templateId: v.optional(v.string()),
-  steps: v.optional(v.record(v.string(), v.any())),
-  fields: v.optional(v.record(v.string(), v.any())),
-  notifyUrl: v.optional(v.string()),
-  numExpectedUploadFiles: v.optional(v.number()),
-  expires: v.optional(v.string()),
-  additionalParams: v.optional(v.record(v.string(), v.any())),
-  userId: v.optional(v.string()),
-});
+export { vAssemblyOptions };
+export type {
+  AssemblyOptions,
+  AssemblyResponse,
+  AssemblyResultResponse,
+  CreateAssemblyArgs,
+};
 
 /**
  * @deprecated Prefer `makeTransloaditAPI` or `Transloadit` for new code.
@@ -158,16 +133,20 @@ export class TransloaditClient {
     return new TransloaditClient(component, config);
   }
 
-  async createAssembly(
-    ctx: RunActionCtx,
-    args: Infer<typeof vCreateAssemblyArgs>,
-  ) {
+  async createAssembly(ctx: RunActionCtx, args: CreateAssemblyArgs) {
     return ctx.runAction(this.component.lib.createAssembly, {
       ...args,
       config: this.config,
     });
   }
 
+  async createAssemblyOptions(ctx: RunActionCtx, args: CreateAssemblyArgs) {
+    return ctx.runAction(this.component.lib.createAssemblyOptions, {
+      ...args,
+      config: this.config,
+    });
+  }
+
   async handleWebhook(
     ctx: RunActionCtx,
     args: {
@@ -266,10 +245,7 @@ export function makeTransloaditAPI(
   return {
     createAssembly: actionGeneric({
       args: vCreateAssemblyArgs,
-      returns: v.object({
-        assemblyId: v.string(),
-        data: v.any(),
-      }),
+      returns: vCreateAssemblyReturn,
       handler: async (ctx, args) => {
         const resolvedConfig = resolveConfig();
         return ctx.runAction(component.lib.createAssembly, {
@@ -278,18 +254,20 @@ export function makeTransloaditAPI(
         });
       },
     }),
-    handleWebhook: actionGeneric({
-      args: {
-        payload: v.any(),
-        rawBody: v.optional(v.string()),
-        signature: v.optional(v.string()),
+    createAssemblyOptions: actionGeneric({
+      args: vCreateAssemblyArgs,
+      returns: vAssemblyOptions,
+      handler: async (ctx, args) => {
+        const resolvedConfig = resolveConfig();
+        return ctx.runAction(component.lib.createAssemblyOptions, {
+          ...args,
+          config: resolvedConfig,
+        });
       },
-      returns: v.object({
-        assemblyId: v.string(),
-        resultCount: v.number(),
-        ok: v.optional(v.string()),
-        status: v.optional(v.string()),
-      }),
+    }),
+    handleWebhook: actionGeneric({
+      args: vWebhookActionArgs,
+      returns: vWebhookResponse,
       handler: async (ctx, args) => {
         const resolvedConfig = resolveConfig();
         return ctx.runAction(component.lib.handleWebhook, {
@@ -299,15 +277,8 @@ export function makeTransloaditAPI(
       },
     }),
     queueWebhook: actionGeneric({
-      args: {
-        payload: v.any(),
-        rawBody: v.optional(v.string()),
-        signature: v.optional(v.string()),
-      },
-      returns: v.object({
-        assemblyId: v.string(),
-        queued: v.boolean(),
-      }),
+      args: vWebhookActionArgs,
+      returns: vQueueWebhookResponse,
       handler: async (ctx, args) => {
         const resolvedConfig = resolveConfig();
         return ctx.runAction(component.lib.queueWebhook, {
@@ -317,13 +288,8 @@ export function makeTransloaditAPI(
       },
     }),
     refreshAssembly: actionGeneric({
-      args: { assemblyId: v.string() },
-      returns: v.object({
-        assemblyId: v.string(),
-        resultCount: v.number(),
-        ok: v.optional(v.string()),
-        status: v.optional(v.string()),
-      }),
+      args: vAssemblyIdArgs,
+      returns: vWebhookResponse,
       handler: async (ctx, args) => {
         const resolvedConfig = resolveConfig();
         return ctx.runAction(component.lib.refreshAssembly, {
@@ -333,63 +299,42 @@ export function makeTransloaditAPI(
       },
     }),
     getAssemblyStatus: queryGeneric({
-      args: { assemblyId: v.string() },
+      args: vAssemblyIdArgs,
       returns: v.union(vAssemblyResponse, v.null()),
       handler: async (ctx, args) => {
         return ctx.runQuery(component.lib.getAssemblyStatus, args);
       },
     }),
     listAssemblies: queryGeneric({
-      args: {
-        status: v.optional(v.string()),
-        userId: v.optional(v.string()),
-        limit: v.optional(v.number()),
-      },
+      args: vListAssembliesArgs,
       returns: v.array(vAssemblyResponse),
       handler: async (ctx, args) => {
         return ctx.runQuery(component.lib.listAssemblies, args);
       },
     }),
     listResults: queryGeneric({
-      args: {
-        assemblyId: v.string(),
-        stepName: v.optional(v.string()),
-        limit: v.optional(v.number()),
-      },
+      args: vListResultsArgs,
       returns: v.array(vAssemblyResultResponse),
       handler: async (ctx, args) => {
         return ctx.runQuery(component.lib.listResults, args);
       },
     }),
     listAlbumResults: queryGeneric({
-      args: {
-        album: v.string(),
-        limit: v.optional(v.number()),
-      },
+      args: vListAlbumResultsArgs,
       returns: v.array(vAssemblyResultResponse),
       handler: async (ctx, args) => {
         return ctx.runQuery(component.lib.listAlbumResults, args);
       },
     }),
     purgeAlbum: mutationGeneric({
-      args: {
-        album: v.string(),
-        deleteAssemblies: v.optional(v.boolean()),
-      },
-      returns: v.object({
-        deletedResults: v.number(),
-        deletedAssemblies: v.number(),
-      }),
+      args: vPurgeAlbumArgs,
+      returns: vPurgeAlbumResponse,
       handler: async (ctx, args) => {
         return ctx.runMutation(component.lib.purgeAlbum, args);
       },
     }),
     storeAssemblyMetadata: mutationGeneric({
-      args: {
-        assemblyId: v.string(),
-        userId: v.optional(v.string()),
-        fields: v.optional(v.record(v.string(), v.any())),
-      },
+      args: vStoreAssemblyMetadataArgs,
       returns: v.union(vAssemblyResponse, v.null()),
       handler: async (ctx, args) => {
         return ctx.runMutation(component.lib.storeAssemblyMetadata, args);

package/src/component/_generated/component.ts

@@ -60,6 +60,23 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
       { assemblyId: string; data: any },
       Name
     >;
+    createAssemblyOptions: FunctionReference<
+      "action",
+      "internal",
+      {
+        config: { authKey: string; authSecret: string };
+        templateId?: string;
+        steps?: any;
+        fields?: any;
+        notifyUrl?: string;
+        numExpectedUploadFiles?: number;
+        expires?: string;
+        additionalParams?: any;
+        userId?: string;
+      },
+      { params: string; signature: string; fields?: any },
+      Name
+    >;
     handleWebhook: FunctionReference<
       "action",
       "internal",

package/src/component/apiUtils.ts

@@ -1,28 +1,13 @@
 import { signParams, verifyWebhookSignature } from "@transloadit/utils";
 import type { AssemblyStatusResults } from "@transloadit/zod/v3/assemblyStatus";
-import type { AssemblyInstructionsInput } from "@transloadit/zod/v3/template";
 import { transloaditError } from "../shared/errors.ts";
-
-export interface TransloaditAuthConfig {
-  authKey: string;
-  authSecret: string;
-}
-
-export interface BuildParamsOptions {
-  authKey: string;
-  templateId?: string;
-  steps?: AssemblyInstructionsInput["steps"];
-  fields?: AssemblyInstructionsInput["fields"];
-  notifyUrl?: string;
-  numExpectedUploadFiles?: number;
-  expires?: string;
-  additionalParams?: Record<string, unknown>;
-}
-
-export interface BuildParamsResult {
-  params: Record<string, unknown>;
-  paramsString: string;
-}
+import type {
+  BuildParamsOptions,
+  BuildParamsResult,
+  ParsedWebhookRequest,
+  VerifiedWebhookRequest,
+  WebhookActionArgs,
+} from "../shared/schemas.ts";
 
 export function buildTransloaditParams(
   options: BuildParamsOptions,
@@ -74,16 +59,6 @@ export async function signTransloaditParams(
   return signParams(paramsString, authSecret, "sha384");
 }
 
-export type ParsedWebhookRequest = {
-  payload: unknown;
-  rawBody: string;
-  signature?: string;
-};
-
-export type VerifiedWebhookRequest = ParsedWebhookRequest & {
-  verified: boolean;
-};
-
 export async function parseTransloaditWebhook(
   request: Request,
 ): Promise<ParsedWebhookRequest> {
@@ -154,12 +129,6 @@ export async function buildWebhookQueueArgs(
   };
 }
 
-export type WebhookActionArgs = {
-  payload: unknown;
-  rawBody?: string;
-  signature?: string;
-};
-
 export async function handleWebhookRequest(
   request: Request,
   options: {

package/src/component/lib.test.ts

@@ -256,6 +256,25 @@ describe("Transloadit component lib", () => {
     expect(result.resultCount).toBe(1);
   });
 
+  test("createAssemblyOptions includes expected upload count when provided", async () => {
+    const t = convexTest(schema, modules);
+
+    const result = await t.action(api.lib.createAssemblyOptions, {
+      steps: {
+        resize: {
+          robot: "/image/resize",
+          width: 120,
+          height: 120,
+        },
+      },
+      numExpectedUploadFiles: 3,
+      config: { authKey: "test-key", authSecret: "test-secret" },
+    });
+
+    const params = JSON.parse(result.params) as Record<string, unknown>;
+    expect(params.num_expected_upload_files).toBe(3);
+  });
+
   test("queueWebhook rejects invalid signature", async () => {
     const t = convexTest(schema, modules);
     const payload = { assembly_id: "asm_bad" };