@transloadit/convex 0.0.5 → 0.1.0

package/src/component/lib.ts

@@ -1,10 +1,33 @@
 import type { AssemblyStatus } from "@transloadit/zod/v3/assemblyStatus";
 import type { AssemblyInstructionsInput } from "@transloadit/zod/v3/template";
 import { anyApi, type FunctionReference } from "convex/server";
-import { type Infer, v } from "convex/values";
+import { v } from "convex/values";
 import { parseAssemblyStatus } from "../shared/assemblyUrls.ts";
 import { transloaditError } from "../shared/errors.ts";
 import { getResultUrl } from "../shared/resultUtils.ts";
+import {
+  type ProcessWebhookResult,
+  vAssembly,
+  vAssemblyBaseArgs,
+  vAssemblyIdArgs,
+  vAssemblyOptions,
+  vAssemblyResult,
+  vCreateAssemblyReturn,
+  vHandleWebhookArgs,
+  vListAlbumResultsArgs,
+  vListAssembliesArgs,
+  vListResultsArgs,
+  vPurgeAlbumArgs,
+  vPurgeAlbumResponse,
+  vQueueWebhookResponse,
+  vRefreshAssemblyArgs,
+  vReplaceResultsArgs,
+  vStoreAssemblyMetadataArgs,
+  vTransloaditConfig,
+  vUpsertAssemblyArgs,
+  vWebhookArgs,
+  vWebhookResponse,
+} from "../shared/schemas.ts";
 import {
   action,
   internalAction,
@@ -21,12 +44,8 @@ import {
 
 const TRANSLOADIT_ASSEMBLY_URL = "https://api2.transloadit.com/assemblies";
 
-type ProcessWebhookResult = {
-  assemblyId: string;
-  resultCount: number;
-  ok?: string;
-  status?: string;
-};
+export { vAssembly, vAssemblyResult, vTransloaditConfig };
+export type { Assembly, AssemblyResult } from "../shared/schemas.ts";
 
 type InternalApi = {
   lib: {
@@ -147,78 +166,8 @@ const applyAssemblyStatus = async (
   };
 };
 
-export const vAssembly = v.object({
-  _id: v.id("assemblies"),
-  _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 Assembly = Infer<typeof vAssembly>;
-
-export const vAssemblyResult = v.object({
-  _id: v.id("results"),
-  _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 AssemblyResult = Infer<typeof vAssemblyResult>;
-
-export const vTransloaditConfig = v.object({
-  authKey: v.string(),
-  authSecret: v.string(),
-});
-
-const vAssemblyBaseArgs = {
-  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 const upsertAssembly = internalMutation({
-  args: {
-    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()),
-    userId: v.optional(v.string()),
-  },
+  args: vUpsertAssemblyArgs,
   returns: v.id("assemblies"),
   handler: async (ctx, args) => {
     // Note: we persist full `raw` + `results` for debugging/fidelity. Large
@@ -272,15 +221,7 @@ export const upsertAssembly = internalMutation({
 });
 
 export const replaceResultsForAssembly = internalMutation({
-  args: {
-    assemblyId: v.string(),
-    results: v.array(
-      v.object({
-        stepName: v.string(),
-        result: v.any(),
-      }),
-    ),
-  },
+  args: vReplaceResultsArgs,
   returns: v.null(),
   handler: async (ctx, args) => {
     // We store raw result payloads for fidelity. For very large assemblies,
@@ -334,10 +275,7 @@ export const createAssembly = action({
     config: vTransloaditConfig,
     ...vAssemblyBaseArgs,
   },
-  returns: v.object({
-    assemblyId: v.string(),
-    data: v.any(),
-  }),
+  returns: vCreateAssemblyReturn,
   handler: async (ctx, args) => {
     const { paramsString, params } = buildTransloaditParams({
       authKey: args.config.authKey,
@@ -345,7 +283,7 @@ export const createAssembly = action({
       steps: args.steps as AssemblyInstructionsInput["steps"],
       fields: args.fields as AssemblyInstructionsInput["fields"],
       notifyUrl: args.notifyUrl,
-      numExpectedUploadFiles: undefined,
+      numExpectedUploadFiles: args.numExpectedUploadFiles,
       expires: args.expires,
       additionalParams: args.additionalParams as
         | Record<string, unknown>
@@ -414,29 +352,47 @@ export const createAssembly = action({
   },
 });
 
-const vWebhookArgs = {
-  payload: v.any(),
-  rawBody: v.optional(v.string()),
-  signature: v.optional(v.string()),
-  verifySignature: v.optional(v.boolean()),
-  authSecret: v.optional(v.string()),
-};
+export const createAssemblyOptions = action({
+  args: {
+    config: vTransloaditConfig,
+    ...vAssemblyBaseArgs,
+  },
+  returns: vAssemblyOptions,
+  handler: async (_ctx, args) => {
+    const { paramsString, params } = buildTransloaditParams({
+      authKey: args.config.authKey,
+      templateId: args.templateId,
+      steps: args.steps as AssemblyInstructionsInput["steps"],
+      fields: args.fields as AssemblyInstructionsInput["fields"],
+      notifyUrl: args.notifyUrl,
+      numExpectedUploadFiles: args.numExpectedUploadFiles,
+      expires: args.expires,
+      additionalParams: args.additionalParams as
+        | Record<string, unknown>
+        | undefined,
+    });
 
-const vPublicWebhookArgs = {
-  payload: v.any(),
-  rawBody: v.optional(v.string()),
-  signature: v.optional(v.string()),
-  verifySignature: v.optional(v.boolean()),
-};
+    const signature = await signTransloaditParams(
+      paramsString,
+      args.config.authSecret,
+    );
+
+    const fields =
+      params && typeof params.fields === "object" && params.fields
+        ? (params.fields as Record<string, unknown>)
+        : undefined;
+
+    return {
+      params: paramsString,
+      signature,
+      fields,
+    };
+  },
+});
 
 export const processWebhook = internalAction({
   args: vWebhookArgs,
-  returns: v.object({
-    assemblyId: v.string(),
-    resultCount: v.number(),
-    ok: v.optional(v.string()),
-    status: v.optional(v.string()),
-  }),
+  returns: vWebhookResponse,
   handler: async (ctx, args) => {
     const rawBody = resolveWebhookRawBody(args);
     const shouldVerify = args.verifySignature ?? true;
@@ -474,20 +430,8 @@ export const processWebhook = internalAction({
 });
 
 export const handleWebhook = action({
-  args: {
-    ...vPublicWebhookArgs,
-    config: v.optional(
-      v.object({
-        authSecret: v.string(),
-      }),
-    ),
-  },
-  returns: v.object({
-    assemblyId: v.string(),
-    resultCount: v.number(),
-    ok: v.optional(v.string()),
-    status: v.optional(v.string()),
-  }),
+  args: vHandleWebhookArgs,
+  returns: vWebhookResponse,
   handler: async (ctx, args) => {
     const verifySignature = args.verifySignature ?? true;
     return ctx.runAction(internal.lib.processWebhook, {
@@ -501,18 +445,8 @@ export const handleWebhook = action({
 });
 
 export const queueWebhook = action({
-  args: {
-    ...vPublicWebhookArgs,
-    config: v.optional(
-      v.object({
-        authSecret: v.string(),
-      }),
-    ),
-  },
-  returns: v.object({
-    assemblyId: v.string(),
-    queued: v.boolean(),
-  }),
+  args: vHandleWebhookArgs,
+  returns: vQueueWebhookResponse,
   handler: async (ctx, args) => {
     const rawBody = resolveWebhookRawBody(args);
     const shouldVerify = args.verifySignature ?? true;
@@ -564,21 +498,8 @@ export const queueWebhook = action({
 });
 
 export const refreshAssembly = action({
-  args: {
-    assemblyId: v.string(),
-    config: v.optional(
-      v.object({
-        authKey: v.string(),
-        authSecret: v.string(),
-      }),
-    ),
-  },
-  returns: v.object({
-    assemblyId: v.string(),
-    resultCount: v.number(),
-    ok: v.optional(v.string()),
-    status: v.optional(v.string()),
-  }),
+  args: vRefreshAssemblyArgs,
+  returns: vWebhookResponse,
   handler: async (ctx, args) => {
     const { assemblyId } = args;
     const authKey = args.config?.authKey ?? process.env.TRANSLOADIT_KEY;
@@ -603,7 +524,7 @@ export const refreshAssembly = action({
 });
 
 export const getAssemblyStatus = query({
-  args: { assemblyId: v.string() },
+  args: vAssemblyIdArgs,
   returns: v.union(vAssembly, v.null()),
   handler: async (ctx, args) => {
     return await ctx.db
@@ -614,11 +535,7 @@ export const getAssemblyStatus = query({
 });
 
 export const listAssemblies = query({
-  args: {
-    status: v.optional(v.string()),
-    userId: v.optional(v.string()),
-    limit: v.optional(v.number()),
-  },
+  args: vListAssembliesArgs,
   returns: v.array(vAssembly),
   handler: async (ctx, args) => {
     if (args.userId) {
@@ -644,11 +561,7 @@ export const listAssemblies = query({
 });
 
 export const listResults = query({
-  args: {
-    assemblyId: v.string(),
-    stepName: v.optional(v.string()),
-    limit: v.optional(v.number()),
-  },
+  args: vListResultsArgs,
   returns: v.array(vAssemblyResult),
   handler: async (ctx, args) => {
     if (args.stepName) {
@@ -671,10 +584,7 @@ export const listResults = query({
 });
 
 export const listAlbumResults = query({
-  args: {
-    album: v.string(),
-    limit: v.optional(v.number()),
-  },
+  args: vListAlbumResultsArgs,
   returns: v.array(vAssemblyResult),
   handler: async (ctx, args) => {
     return ctx.db
@@ -686,14 +596,8 @@ export const listAlbumResults = query({
 });
 
 export const purgeAlbum = mutation({
-  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) => {
     const results = await ctx.db
       .query("results")
@@ -725,11 +629,7 @@ export const purgeAlbum = mutation({
 });
 
 export const storeAssemblyMetadata = mutation({
-  args: {
-    assemblyId: v.string(),
-    userId: v.optional(v.string()),
-    fields: v.optional(v.record(v.string(), v.any())),
-  },
+  args: vStoreAssemblyMetadataArgs,
   returns: v.union(vAssembly, v.null()),
   handler: async (ctx, args) => {
     const existing = await ctx.db

package/src/component/schema.ts

@@ -1,40 +1,12 @@
 import { defineSchema, defineTable } from "convex/server";
-import { v } from "convex/values";
+import { vAssemblyFields, vAssemblyResultFields } from "../shared/schemas.ts";
 
 export default defineSchema({
-  assemblies: defineTable({
-    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()),
-  })
+  assemblies: defineTable(vAssemblyFields)
     .index("by_assemblyId", ["assemblyId"])
     .index("by_status", ["status"])
     .index("by_userId", ["userId"]),
-  results: defineTable({
-    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(),
-  })
+  results: defineTable(vAssemblyResultFields)
     .index("by_assemblyId", ["assemblyId"])
     .index("by_assemblyId_and_step", ["assemblyId", "stepName"])
     .index("by_album", ["album"]),

package/src/shared/schemas.ts

@@ -0,0 +1,279 @@
+import type { AssemblyInstructionsInput } from "@transloadit/zod/v3/template";
+import { type Infer, v } from "convex/values";
+
+export const vAssemblyFields = {
+  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 const vAssemblyResultFields = {
+  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 const vAssembly = v.object({
+  _id: v.id("assemblies"),
+  _creationTime: v.number(),
+  ...vAssemblyFields,
+});
+
+export type Assembly = Infer<typeof vAssembly>;
+
+export const vAssemblyResponse = v.object({
+  _id: v.string(),
+  _creationTime: v.number(),
+  ...vAssemblyFields,
+});
+
+export type AssemblyResponse = Infer<typeof vAssemblyResponse>;
+
+export const vAssemblyResult = v.object({
+  _id: v.id("results"),
+  _creationTime: v.number(),
+  ...vAssemblyResultFields,
+});
+
+export type AssemblyResult = Infer<typeof vAssemblyResult>;
+
+export const vAssemblyResultResponse = v.object({
+  _id: v.string(),
+  _creationTime: v.number(),
+  ...vAssemblyResultFields,
+});
+
+export type AssemblyResultResponse = Infer<typeof vAssemblyResultResponse>;
+
+export const vTransloaditConfig = v.object({
+  authKey: v.string(),
+  authSecret: v.string(),
+});
+
+export type TransloaditConfig = Infer<typeof vTransloaditConfig>;
+
+export const vAssemblyBaseArgs = {
+  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 const vCreateAssemblyArgs = v.object(vAssemblyBaseArgs);
+
+export type CreateAssemblyArgs = Omit<
+  Infer<typeof vCreateAssemblyArgs>,
+  "steps" | "fields"
+> & {
+  steps?: AssemblyInstructionsInput["steps"];
+  fields?: AssemblyInstructionsInput["fields"];
+};
+
+export const vCreateAssemblyReturn = v.object({
+  assemblyId: v.string(),
+  data: v.any(),
+});
+
+export type CreateAssemblyReturn = Infer<typeof vCreateAssemblyReturn>;
+
+export const vAssemblyOptions = v.object({
+  params: v.string(),
+  signature: v.string(),
+  fields: v.optional(v.record(v.string(), v.any())),
+});
+
+export type AssemblyOptions = Infer<typeof vAssemblyOptions>;
+
+export const vWebhookArgs = {
+  payload: v.any(),
+  rawBody: v.optional(v.string()),
+  signature: v.optional(v.string()),
+  verifySignature: v.optional(v.boolean()),
+  authSecret: v.optional(v.string()),
+};
+
+export const vPublicWebhookArgs = {
+  payload: v.any(),
+  rawBody: v.optional(v.string()),
+  signature: v.optional(v.string()),
+  verifySignature: v.optional(v.boolean()),
+};
+
+export const vWebhookActionArgs = v.object({
+  payload: v.any(),
+  rawBody: v.optional(v.string()),
+  signature: v.optional(v.string()),
+});
+
+export type WebhookActionArgs = Infer<typeof vWebhookActionArgs>;
+
+export const vWebhookResponse = v.object({
+  assemblyId: v.string(),
+  resultCount: v.number(),
+  ok: v.optional(v.string()),
+  status: v.optional(v.string()),
+});
+
+export type WebhookResponse = Infer<typeof vWebhookResponse>;
+
+export const vQueueWebhookResponse = v.object({
+  assemblyId: v.string(),
+  queued: v.boolean(),
+});
+
+export type QueueWebhookResponse = Infer<typeof vQueueWebhookResponse>;
+
+export const vAssemblyIdArgs = {
+  assemblyId: v.string(),
+};
+
+export const vListAssembliesArgs = {
+  status: v.optional(v.string()),
+  userId: v.optional(v.string()),
+  limit: v.optional(v.number()),
+};
+
+export const vListResultsArgs = {
+  assemblyId: v.string(),
+  stepName: v.optional(v.string()),
+  limit: v.optional(v.number()),
+};
+
+export const vListAlbumResultsArgs = {
+  album: v.string(),
+  limit: v.optional(v.number()),
+};
+
+export const vPurgeAlbumArgs = {
+  album: v.string(),
+  deleteAssemblies: v.optional(v.boolean()),
+};
+
+export const vPurgeAlbumResponse = v.object({
+  deletedResults: v.number(),
+  deletedAssemblies: v.number(),
+});
+
+export type PurgeAlbumResponse = Infer<typeof vPurgeAlbumResponse>;
+
+export const vStoreAssemblyMetadataArgs = {
+  assemblyId: v.string(),
+  userId: v.optional(v.string()),
+  fields: v.optional(v.record(v.string(), v.any())),
+};
+
+export const vRefreshAssemblyArgs = {
+  assemblyId: v.string(),
+  config: v.optional(
+    v.object({
+      authKey: v.string(),
+      authSecret: v.string(),
+    }),
+  ),
+};
+
+export const vHandleWebhookArgs = {
+  ...vPublicWebhookArgs,
+  config: v.optional(
+    v.object({
+      authSecret: v.string(),
+    }),
+  ),
+};
+
+export const vProcessWebhookResult = vWebhookResponse;
+
+export type ProcessWebhookResult = Infer<typeof vProcessWebhookResult>;
+
+export const vReplaceResultsArgs = {
+  assemblyId: v.string(),
+  results: v.array(
+    v.object({
+      stepName: v.string(),
+      result: v.any(),
+    }),
+  ),
+};
+
+export const vUpsertAssemblyArgs = {
+  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()),
+  userId: v.optional(v.string()),
+};
+
+export const vBuildParamsOptions = v.object({
+  authKey: v.string(),
+  templateId: v.optional(v.string()),
+  steps: v.optional(v.any()),
+  fields: v.optional(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())),
+});
+
+export type BuildParamsOptions = Omit<
+  Infer<typeof vBuildParamsOptions>,
+  "steps" | "fields"
+> & {
+  steps?: AssemblyInstructionsInput["steps"];
+  fields?: AssemblyInstructionsInput["fields"];
+};
+
+export const vBuildParamsResult = v.object({
+  params: v.record(v.string(), v.any()),
+  paramsString: v.string(),
+});
+
+export type BuildParamsResult = Infer<typeof vBuildParamsResult>;
+
+const vParsedWebhookFields = {
+  payload: v.any(),
+  rawBody: v.string(),
+  signature: v.optional(v.string()),
+};
+
+export const vParsedWebhookRequest = v.object(vParsedWebhookFields);
+
+export type ParsedWebhookRequest = Infer<typeof vParsedWebhookRequest>;
+
+export const vVerifiedWebhookRequest = v.object({
+  ...vParsedWebhookFields,
+  verified: v.boolean(),
+});
+
+export type VerifiedWebhookRequest = Infer<typeof vVerifiedWebhookRequest>;