@transloadit/convex 0.0.2 → 0.0.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@transloadit/convex",
   "description": "Transloadit component for Convex",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "packageManager": "yarn@4.5.0",
   "repository": {
@@ -22,18 +22,27 @@
   "scripts": {
     "build": "tsc -p tsconfig.build.json && node scripts/emit-package-json.ts",
     "build:watch": "tsc -p tsconfig.build.json --watch",
+    "changeset": "changeset",
+    "changeset:version": "changeset version",
     "typecheck": "tsc --noEmit",
     "test": "vitest run --typecheck",
     "test:watch": "vitest --typecheck",
+    "verify": "yarn check && yarn verify:local",
+    "verify:local": "node scripts/verify.ts --mode local",
+    "verify:cloud": "node scripts/verify.ts --mode cloud",
+    "verify:real": "yarn verify:cloud",
+    "verify:browser": "yarn verify:local",
+    "verify:convex": "yarn verify:cloud",
+    "deploy:cloud": "node scripts/deploy-cloud.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",
     "lint": "biome check .",
     "format": "biome format . --write",
     "check": "yarn format && yarn lint && yarn typecheck && yarn test",
     "prepack": "yarn build",
-    "smoke": "dotenv -q -- node scripts/smoke-test.ts",
-    "template:ensure": "dotenv -q -- node scripts/ensure-template.ts",
-    "tunnel": "node scripts/start-webhook-tunnel.ts",
-    "qa:full": "dotenv -q -- node scripts/qa-full.ts",
-    "qa:full:verbose": "dotenv -q -- node scripts/qa-full.ts --verbose"
+    "template:ensure": "node scripts/ensure-template.ts",
+    "tunnel": "node scripts/start-webhook-tunnel.ts"
   },
   "files": [
     "dist",
@@ -56,10 +65,18 @@
       "types": "./dist/component/lib.d.ts",
       "default": "./dist/component/lib.js"
     },
+    "./test": {
+      "types": "./dist/test/index.d.ts",
+      "default": "./dist/test/index.js"
+    },
     "./convex.config": {
       "@convex-dev/component-source": "./src/component/convex.config.ts",
       "types": "./dist/component/convex.config.d.ts",
       "default": "./dist/component/convex.config.js"
+    },
+    "./debug": {
+      "types": "./dist/debug/index.d.ts",
+      "default": "./dist/debug/index.js"
     }
   },
   "peerDependencies": {
@@ -72,19 +89,40 @@
     }
   },
   "dependencies": {
-    "tus-js-client": "^4.1.0"
+    "@transloadit/utils": "^4.1.9",
+    "@transloadit/zod": "^4.1.9",
+    "tus-js-client": "^4.3.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.2.4",
+    "@auth/core": "^0.37.0",
+    "@biomejs/biome": "^2.3.11",
+    "@changesets/cli": "^2.27.12",
+    "@convex-dev/auth": "^0.0.90",
     "@edge-runtime/vm": "^5.0.0",
-    "@types/node": "^20.19.0",
-    "@types/react": "^19.1.10",
-    "convex": "^1.24.8",
-    "convex-test": "0.0.37",
-    "dotenv-cli": "^8.0.0",
+    "@playwright/test": "^1.57.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/node": "^25.0.8",
+    "@types/react": "^19.2.8",
+    "@types/react-dom": "^19",
+    "@uppy/core": "^5.2.0",
+    "@uppy/dashboard": "^5.1.0",
+    "@uppy/react": "^5.1.1",
+    "@uppy/tus": "^5.1.0",
+    "convex": "^1.31.4",
+    "convex-test": "^0.0.41",
+    "dotenv": "^17.2.3",
+    "esbuild": "^0.27.2",
+    "jsdom": "^26.1.0",
+    "next": "^16.1.3",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
     "typescript": "^5.9.3",
-    "vitest": "3.2.4"
+    "vitest": "^4.0.17"
+  },
+  "resolutions": {
+    "preact": "10.28.2"
   },
   "types": "./dist/client/index.d.ts",
   "module": "./dist/client/index.js"
-}
+}

package/src/client/index.ts

@@ -1,7 +1,72 @@
+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 type { ComponentApi } from "../component/_generated/component.js";
-import type { RunActionCtx, RunMutationCtx, RunQueryCtx } from "./types.js";
+import type { ComponentApi } from "../component/_generated/component.ts";
+import type { RunActionCtx, RunMutationCtx, RunQueryCtx } from "./types.ts";
+
+export {
+  assemblyStatusErrCodeSchema,
+  assemblyStatusOkCodeSchema,
+  assemblyStatusResultsSchema,
+  assemblyStatusSchema,
+  isAssemblyBusy,
+  isAssemblyBusyStatus,
+  isAssemblyErrorStatus,
+  isAssemblyOkStatus,
+  isAssemblySysError,
+  isAssemblyTerminal,
+  isAssemblyTerminalError,
+  isAssemblyTerminalOk,
+  isAssemblyTerminalOkStatus,
+} from "@transloadit/zod/v3/assemblyStatus";
+export type {
+  ParsedWebhookRequest,
+  VerifiedWebhookRequest,
+  WebhookActionArgs,
+} from "../component/apiUtils.ts";
+export {
+  buildWebhookQueueArgs,
+  handleWebhookRequest,
+  parseAndVerifyTransloaditWebhook,
+  parseTransloaditWebhook,
+} from "../component/apiUtils.ts";
+export type {
+  NormalizedAssemblyUrls,
+  TransloaditAssembly,
+} from "../shared/assemblyUrls.ts";
+export {
+  ASSEMBLY_STATUS_COMPLETED,
+  ASSEMBLY_STATUS_UPLOADING,
+  getAssemblyStage,
+  isAssemblyCompletedStatus,
+  isAssemblyUploadingStatus,
+  normalizeAssemblyUploadUrls,
+  parseAssemblyFields,
+  parseAssemblyResults,
+  parseAssemblyStatus,
+  parseAssemblyUrls,
+} from "../shared/assemblyUrls.ts";
+export { pollAssembly } from "../shared/pollAssembly.ts";
+export type {
+  ImageResizeResult,
+  ResultByRobot,
+  ResultForRobot,
+  StoreResult,
+  TransloaditResult,
+  VideoEncodeResult,
+  VideoThumbsResult,
+} from "../shared/resultTypes.ts";
+export {
+  getResultOriginalKey,
+  getResultUrl,
+} from "../shared/resultUtils.ts";
+export type {
+  TusMetadataOptions,
+  TusUploadConfig,
+} from "../shared/tusUpload.ts";
+export { buildTusUploadConfig } from "../shared/tusUpload.ts";
+export type { AssemblyStatus, AssemblyInstructionsInput };
 
 export interface TransloaditConfig {
   authKey: string;
@@ -30,9 +95,9 @@ export const vAssemblyResponse = v.object({
   templateId: v.optional(v.string()),
   notifyUrl: v.optional(v.string()),
   numExpectedUploadFiles: v.optional(v.number()),
-  fields: v.optional(v.any()),
-  uploads: v.optional(v.any()),
-  results: v.optional(v.any()),
+  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(),
@@ -60,15 +125,18 @@ export type AssemblyResultResponse = Infer<typeof vAssemblyResultResponse>;
 
 export const vCreateAssemblyArgs = v.object({
   templateId: v.optional(v.string()),
-  steps: v.optional(v.any()),
-  fields: v.optional(v.any()),
+  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.any()),
+  additionalParams: v.optional(v.record(v.string(), v.any())),
   userId: v.optional(v.string()),
 });
 
+/**
+ * @deprecated Prefer `makeTransloaditAPI` or `Transloadit` for new code.
+ */
 export class TransloaditClient {
   declare component: TransloaditComponent;
   declare config: TransloaditConfig;
@@ -79,12 +147,8 @@ export class TransloaditClient {
   ) {
     this.component = component;
     this.config = {
-      authKey:
-        config?.authKey ??
-        requireEnv(["TRANSLOADIT_AUTH_KEY", "TRANSLOADIT_KEY"]),
-      authSecret:
-        config?.authSecret ??
-        requireEnv(["TRANSLOADIT_AUTH_SECRET", "TRANSLOADIT_SECRET"]),
+      authKey: config?.authKey ?? requireEnv(["TRANSLOADIT_KEY"]),
+      authSecret: config?.authSecret ?? requireEnv(["TRANSLOADIT_SECRET"]),
     };
   }
 
@@ -102,17 +166,22 @@ export class TransloaditClient {
     });
   }
 
-  async generateUploadParams(
+  async handleWebhook(
     ctx: RunActionCtx,
-    args: Infer<typeof vCreateAssemblyArgs>,
+    args: {
+      payload: unknown;
+      rawBody?: string;
+      signature?: string;
+      verifySignature?: boolean;
+    },
   ) {
-    return ctx.runAction(this.component.lib.generateUploadParams, {
+    return ctx.runAction(this.component.lib.handleWebhook, {
       ...args,
-      config: this.config,
+      config: { authSecret: this.config.authSecret },
     });
   }
 
-  async handleWebhook(
+  async queueWebhook(
     ctx: RunActionCtx,
     args: {
       payload: unknown;
@@ -121,12 +190,19 @@ export class TransloaditClient {
       verifySignature?: boolean;
     },
   ) {
-    return ctx.runAction(this.component.lib.handleWebhook, {
+    return ctx.runAction(this.component.lib.queueWebhook, {
       ...args,
       config: { authSecret: this.config.authSecret },
     });
   }
 
+  async refreshAssembly(ctx: RunActionCtx, assemblyId: string) {
+    return ctx.runAction(this.component.lib.refreshAssembly, {
+      assemblyId,
+      config: this.config,
+    });
+  }
+
   async getAssemblyStatus(ctx: RunQueryCtx, assemblyId: string) {
     return ctx.runQuery(this.component.lib.getAssemblyStatus, { assemblyId });
   }
@@ -157,17 +233,25 @@ export class TransloaditClient {
   }
 }
 
+export class Transloadit extends TransloaditClient {}
+
+/**
+ * @deprecated Prefer `new Transloadit(...)` or `makeTransloaditAPI(...)`.
+ */
+export function createTransloadit(
+  component: TransloaditComponent,
+  config?: Partial<TransloaditConfig>,
+) {
+  return new Transloadit(component, config);
+}
+
 export function makeTransloaditAPI(
   component: TransloaditComponent,
   config?: Partial<TransloaditConfig>,
 ) {
   const resolvedConfig: TransloaditConfig = {
-    authKey:
-      config?.authKey ??
-      requireEnv(["TRANSLOADIT_AUTH_KEY", "TRANSLOADIT_KEY"]),
-    authSecret:
-      config?.authSecret ??
-      requireEnv(["TRANSLOADIT_AUTH_SECRET", "TRANSLOADIT_SECRET"]),
+    authKey: config?.authKey ?? requireEnv(["TRANSLOADIT_KEY"]),
+    authSecret: config?.authSecret ?? requireEnv(["TRANSLOADIT_SECRET"]),
   };
 
   return {
@@ -184,38 +268,57 @@ export function makeTransloaditAPI(
         });
       },
     }),
-    generateUploadParams: actionGeneric({
-      args: vCreateAssemblyArgs,
+    handleWebhook: actionGeneric({
+      args: {
+        payload: v.any(),
+        rawBody: v.optional(v.string()),
+        signature: v.optional(v.string()),
+      },
       returns: v.object({
-        params: v.string(),
-        signature: v.string(),
-        url: v.string(),
+        assemblyId: v.string(),
+        resultCount: v.number(),
+        ok: v.optional(v.string()),
+        status: v.optional(v.string()),
       }),
       handler: async (ctx, args) => {
-        return ctx.runAction(component.lib.generateUploadParams, {
+        return ctx.runAction(component.lib.handleWebhook, {
           ...args,
-          config: resolvedConfig,
+          config: { authSecret: resolvedConfig.authSecret },
         });
       },
     }),
-    handleWebhook: actionGeneric({
+    queueWebhook: actionGeneric({
       args: {
         payload: v.any(),
         rawBody: v.optional(v.string()),
         signature: v.optional(v.string()),
-        verifySignature: v.optional(v.boolean()),
       },
       returns: v.object({
         assemblyId: v.string(),
-        resultCount: v.number(),
+        queued: v.boolean(),
       }),
       handler: async (ctx, args) => {
-        return ctx.runAction(component.lib.handleWebhook, {
+        return ctx.runAction(component.lib.queueWebhook, {
           ...args,
           config: { authSecret: resolvedConfig.authSecret },
         });
       },
     }),
+    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()),
+      }),
+      handler: async (ctx, args) => {
+        return ctx.runAction(component.lib.refreshAssembly, {
+          ...args,
+          config: resolvedConfig,
+        });
+      },
+    }),
     getAssemblyStatus: queryGeneric({
       args: { assemblyId: v.string() },
       returns: v.union(vAssemblyResponse, v.null()),
@@ -249,7 +352,7 @@ export function makeTransloaditAPI(
       args: {
         assemblyId: v.string(),
         userId: v.optional(v.string()),
-        fields: v.optional(v.any()),
+        fields: v.optional(v.record(v.string(), v.any())),
       },
       returns: v.union(vAssemblyResponse, v.null()),
       handler: async (ctx, args) => {

package/src/component/_generated/api.ts

@@ -8,8 +8,8 @@
  * @module
  */
 
-import type * as apiUtils from "../apiUtils.js";
-import type * as lib from "../lib.js";
+import type * as apiUtils from "../apiUtils.ts";
+import type * as lib from "../lib.ts";
 
 import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
 import { anyApi, componentsGeneric } from "convex/server";

package/src/component/_generated/component.ts

@@ -60,24 +60,43 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
       { assemblyId: string; data: any },
       Name
     >;
-    generateUploadParams: FunctionReference<
+    handleWebhook: FunctionReference<
       "action",
       "internal",
       {
-        config: { authKey: string; authSecret: string };
-        templateId?: string;
-        steps?: any;
-        fields?: any;
-        notifyUrl?: string;
-        numExpectedUploadFiles?: number;
-        expires?: string;
-        additionalParams?: any;
-        userId?: string;
+        payload: any;
+        rawBody?: string;
+        signature?: string;
+        verifySignature?: boolean;
+        config?: { authSecret: string };
+      },
+      {
+        assemblyId: string;
+        resultCount: number;
+        ok?: string;
+        status?: string;
       },
-      { params: string; signature: string; url: string },
       Name
     >;
-    handleWebhook: FunctionReference<
+    processWebhook: FunctionReference<
+      "action",
+      "internal",
+      {
+        payload: any;
+        rawBody?: string;
+        signature?: string;
+        verifySignature?: boolean;
+        authSecret?: string;
+      },
+      {
+        assemblyId: string;
+        resultCount: number;
+        ok?: string;
+        status?: string;
+      },
+      Name
+    >;
+    queueWebhook: FunctionReference<
       "action",
       "internal",
       {
@@ -87,7 +106,19 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         verifySignature?: boolean;
         config?: { authSecret: string };
       },
-      { assemblyId: string; resultCount: number },
+      { assemblyId: string; queued: boolean },
+      Name
+    >;
+    refreshAssembly: FunctionReference<
+      "action",
+      "internal",
+      { assemblyId: string; config?: { authKey: string; authSecret: string } },
+      {
+        assemblyId: string;
+        resultCount: number;
+        ok?: string;
+        status?: string;
+      },
       Name
     >;
     getAssemblyStatus: FunctionReference<

package/src/component/_generated/dataModel.ts

@@ -15,7 +15,7 @@ import type {
   SystemTableNames,
 } from "convex/server";
 import type { GenericId } from "convex/values";
-import schema from "../schema.js";
+import schema from "../schema.ts";
 
 export type TableNames = TableNamesInDataModel<DataModel>;
 

package/src/component/_generated/server.ts

@@ -28,7 +28,7 @@ import {
   internalMutationGeneric,
   internalQueryGeneric,
 } from "convex/server";
-import type { DataModel } from "./dataModel.js";
+import type { DataModel } from "./dataModel.ts";
 
 export const query: QueryBuilder<DataModel, "public"> = queryGeneric;