transloadit 4.0.2 → 4.0.3

package/src/alphalib/types/robots/meta-read.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
-
-import { interpolateRobot, type RobotMetaInput, robotBase } from './_instructions-primitives.ts'
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase } from './_instructions-primitives.ts'
 
 // @ts-expect-error - MetaReadRobot is not ready yet @TODO please supply missing keys
 export const meta: RobotMetaInput = {
@@ -15,7 +15,7 @@ export const meta: RobotMetaInput = {
 
 export const robotMetaReadInstructionsSchema = robotBase
   .extend({
-    robot: z.literal('/meta/read').describe(`Reads metadata from a file.`),
+    robot: z.literal('/meta/read').describe('Reads metadata from a file.'),
   })
   .strict()
 

package/src/alphalib/types/robots/minio-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/minio-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on MinIO:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on MinIO:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/s3-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/s3-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` in an S3 bucket:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` in an S3 bucket:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,
@@ -149,6 +149,12 @@ Set to \`true\` if you use a custom host and run into access denied errors.
       .optional()
       .describe(`
 This parameter provides signed URLs in the result JSON (in the \`signed_url\` and \`signed_ssl_url\` properties). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.
+`),
+    session_token: z
+      .string()
+      .optional()
+      .describe(`
+The session token to use for the S3 store. This is only used if the credentials are from an IAM user with the \`sts:AssumeRole\` permission.
 `),
   })
   .strict()

package/src/alphalib/types/robots/sftp-import.ts

@@ -17,7 +17,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   minimum_charge: 0,
   output_factor: 1,
   override_lvl1: 'File Importing',

package/src/alphalib/types/robots/sftp-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on an SFTP server:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on an SFTP server:',
   minimum_charge: 0,
   output_factor: 1,
   override_lvl1: 'File Exporting',

package/src/alphalib/types/robots/supabase-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/supabase-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on supabase R2:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on supabase R2:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/swift-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/swift-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on Swift:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on Swift:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/types/robots/tigris-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,
@@ -85,7 +86,7 @@ The pagination page size. This only works when recursive is \`true\` for now, in
     bucket_region: z
       .string()
       .optional()
-      .describe(`The region of your Tigris bucket. This is optional as it can often be derived.`),
+      .describe('The region of your Tigris bucket. This is optional as it can often be derived.'),
   })
   .strict()
 

package/src/alphalib/types/robots/tigris-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on Tigris:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on Tigris:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,
@@ -81,7 +81,7 @@ If this parameter is not used, no URL signing is done.
     bucket_region: z
       .string()
       .optional()
-      .describe(`The region of your Tigris bucket. This is optional as it can often be derived.`),
+      .describe('The region of your Tigris bucket. This is optional as it can often be derived.'),
   })
   .strict()
 

package/src/alphalib/types/robots/tlcdn-deliver.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
-
-import { interpolateRobot, type RobotMetaInput, robotBase } from './_instructions-primitives.ts'
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
   allowed_for_url_transform: false,

package/src/alphalib/types/robots/video-concat.ts

@@ -39,7 +39,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `If you have a form with 3 file input fields and want to concatenate the uploaded videos in a specific order, instruct Transloadit using the \`name\` attribute of each input field. Use this attribute as the value for the \`fields\` key in the JSON, and set \`as\` to \`video_[[index]]\`. Transloadit will concatenate the files based on the ascending index order:`,
+  example_code_description:
+    'If you have a form with 3 file input fields and want to concatenate the uploaded videos in a specific order, instruct Transloadit using the `name` attribute of each input field. Use this attribute as the value for the `fields` key in the JSON, and set `as` to `video_[[index]]`. Transloadit will concatenate the files based on the ascending index order:',
   minimum_charge: 0,
   output_factor: 0.6,
   override_lvl1: 'Video Encoding',

package/src/alphalib/types/robots/video-encode.ts

@@ -50,7 +50,55 @@ export const robotVideoEncodeInstructionsSchema = robotBase
   .merge(robotUse)
   .merge(videoEncodeSpecificInstructionsSchema)
   .extend({
-    robot: z.literal('/video/encode'),
+    robot: z.literal('/video/encode').describe(`
+The /video/encode Robot is a versatile tool for video processing that handles transcoding, resizing, and watermarking. It supports various formats including modern standards like HEVC (H.265), and provides features such as presets for common devices, custom FFmpeg parameters for powerusers, watermark positioning, and more.
+
+## Adding text overlays with FFmpeg
+
+You can add text overlays to videos using FFmpeg's \`drawtext\` filter through this <Definition term="Robot">Robot</Definition>'s \`ffmpeg\` parameter. Here are two examples — one with the default font and one with a custom font family name:
+
+\`\`\`json
+{
+  "steps": {
+    ":original": {
+      "robot": "/upload/handle"
+    },
+    "text_overlay_default": {
+      "use": ":original",
+      "robot": "/video/encode",
+      "preset": "empty",
+      "ffmpeg_stack": "{{stacks.ffmpeg.recommended_version}}",
+      "ffmpeg": {
+        "codec:a": "copy",
+        "vf": "drawtext=text='My text overlay':fontcolor=white:fontsize=24:box=1:boxcolor=black@0.5:boxborderw=5:x=(w-text_w)/2:y=(h-text_h)/2"
+      },
+      "result": true
+    },
+    "text_overlay_custom": {
+      "use": ":original",
+      "robot": "/video/encode",
+      "preset": "empty",
+      "ffmpeg_stack": "{{stacks.ffmpeg.recommended_version}}",
+      "ffmpeg": {
+        "codec:a": "copy",
+        "vf": "drawtext=font='Times New Roman':text='My text overlay':fontcolor=white:fontsize=24:box=1:boxcolor=black@0.5:boxborderw=5:x=(w-text_w)/2:y=(h-text_h)/2"
+      },
+      "result": true
+    }
+  }
+}
+\`\`\`
+
+**Notes:**
+
+- Use the \`font\` attribute to reference a font by family name with FFmpeg's \`drawtext\`
+- FFmpeg font family names typically do not contain dashes (e.g. \`Times New Roman\`), while
+  ImageMagick uses dashed names (e.g. \`Times-New-Roman\`).
+- Preserve the source audio by setting \`"codec:a": "copy"\`.
+- Position text with the \`x\` and \`y\` expressions. The example above centers the text.
+
+See the live demo [here](/demos/video-encoding/add-text-overlay/).
+`),
     font_size: z.number().optional(),
     font_color: z.string().optional(),
     text_background_color: z.string().optional(),

package/src/alphalib/types/robots/video-subtitle.ts

@@ -39,7 +39,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `If you have two file input fields in a form — one for a video and another for an SRT or VTT subtitle, named \`input_video\` and \`input_srt\` respectively (with the HTML \`name\` attribute), hereʼs how to embed the subtitles into the video with Transloadit:`,
+  example_code_description:
+    'If you have two file input fields in a form — one for a video and another for an SRT or VTT subtitle, named `input_video` and `input_srt` respectively (with the HTML `name` attribute), hereʼs how to embed the subtitles into the video with Transloadit:',
   minimum_charge: 0,
   output_factor: 0.6,
   override_lvl1: 'Video Encoding',

package/src/alphalib/types/robots/vimeo-import.ts

@@ -83,7 +83,7 @@ You can also use an array of path strings here to import multiple paths in the s
     rendition: z
       .enum(['240p', '360p', '540p', '720p', '1080p', 'source'])
       .default('720p')
-      .describe(`The quality of the video to import.`),
+      .describe('The quality of the video to import.'),
   })
   .strict()
 

package/src/alphalib/types/robots/wasabi-import.ts

@@ -28,7 +28,8 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Import files from the \`path/to/files\` directory and its subdirectories:`,
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,
@@ -59,7 +60,7 @@ export const robotWasabiImportInstructionsSchema = robotBase
     result: z
       .boolean()
       .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+      .describe('Whether the results of this Step should be present in the Assembly Status JSON'),
     robot: z.literal('/wasabi/import'),
     path: path.describe(`
 The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: \`images/avatar.jpg\`.

package/src/alphalib/types/robots/wasabi-store.ts

@@ -18,7 +18,7 @@ export const meta: RobotMetaInput = {
       },
     },
   },
-  example_code_description: `Export uploaded files to \`my_target_folder\` on Wasabi:`,
+  example_code_description: 'Export uploaded files to `my_target_folder` on Wasabi:',
   has_small_icon: true,
   minimum_charge: 0,
   output_factor: 1,

package/src/alphalib/zodParseWithContext.ts

@@ -113,7 +113,7 @@ export function zodParseWithContext<T extends z.ZodType>(
       else if ('unionErrors' in zodIssue && zodIssue.unionErrors) {
         // --- Moved initialization out of the loop ---
         const collectedLiterals: Record<string, (string | number | boolean)[]> = {}
-        const collectedMessages: Record<string, string[]> = {}
+        const collectedMessages: Record<string, Set<string>> = {}
 
         // Process nested issues within the union
         for (const unionError of zodIssue.unionErrors) {
@@ -123,8 +123,11 @@ export function zodParseWithContext<T extends z.ZodType>(
 
             // Ensure paths exist in collection maps
             if (!collectedLiterals[nestedPath]) collectedLiterals[nestedPath] = []
-            if (!collectedMessages[nestedPath]) collectedMessages[nestedPath] = []
+            if (!collectedMessages[nestedPath]) collectedMessages[nestedPath] = new Set()
 
+            if (issue.code === 'custom' && issue.message.includes('interpolation string')) {
+              continue
+            }
             if (issue.code === 'invalid_literal') {
               const { expected } = issue
               if (
@@ -137,7 +140,7 @@ export function zodParseWithContext<T extends z.ZodType>(
                 collectedLiterals[nestedPath].push(expected)
               }
               // Still add the raw message for fallback
-              collectedMessages[nestedPath].push(issue.message)
+              collectedMessages[nestedPath].add(issue.message)
             }
             // Keep existing enum handling if needed, but literal should cover most cases
             else if (issue.code === 'invalid_enum_value') {
@@ -145,7 +148,7 @@ export function zodParseWithContext<T extends z.ZodType>(
               if (options && options.length > 0) {
                 collectedLiterals[nestedPath].push(...options.map(String)) // Assuming options are compatible
               }
-              collectedMessages[nestedPath].push(issue.message)
+              collectedMessages[nestedPath].add(issue.message)
             }
             // Keep existing unrecognized keys handling
             else if (issue.code === 'unrecognized_keys') {
@@ -153,7 +156,7 @@ export function zodParseWithContext<T extends z.ZodType>(
               const { keys } = issue
               const truncatedKeys = keys.slice(0, maxKeysToShow)
               const ellipsis = keys.length > maxKeysToShow ? '...' : ''
-              collectedMessages[nestedPath].push(
+              collectedMessages[nestedPath].add(
                 `has unrecognized keys: ${truncatedKeys.map((k) => `\`${k}\``).join(', ')}${ellipsis}`,
               )
             }
@@ -177,13 +180,13 @@ export function zodParseWithContext<T extends z.ZodType>(
                 }
               }
 
-              collectedMessages[nestedPath].push(
+              collectedMessages[nestedPath].add(
                 `got invalid type: ${received} (value: \`${actualValueStr}\`, expected: ${expectedOutput})`,
               )
             }
             // <-- End added handling -->
             else {
-              collectedMessages[nestedPath].push(issue.message) // Handle other nested codes
+              collectedMessages[nestedPath].add(issue.message) // Handle other nested codes
             }
           }
         }
@@ -194,13 +197,17 @@ export function zodParseWithContext<T extends z.ZodType>(
           if (!badPaths.has(nestedPath)) {
             badPaths.set(nestedPath, [])
           }
-          const targetMessages = badPaths.get(nestedPath)!
+
+          const targetMessages = badPaths.get(nestedPath)
+          if (!targetMessages) {
+            continue
+          }
 
           // Prioritize more specific messages (like invalid type with details)
-          const invalidTypeMessages = collectedMessages[nestedPath].filter((m) =>
+          const invalidTypeMessages = Array.from(collectedMessages[nestedPath]).filter((m) =>
             m.startsWith('got invalid type:'),
           )
-          const unrecognizedKeyMessages = collectedMessages[nestedPath].filter((m) =>
+          const unrecognizedKeyMessages = Array.from(collectedMessages[nestedPath]).filter((m) =>
             m.startsWith('has unrecognized keys:'),
           )
           const literalMessages = collectedLiterals[nestedPath] ?? []
@@ -217,9 +224,6 @@ export function zodParseWithContext<T extends z.ZodType>(
             targetMessages.push(...collectedMessages[nestedPath])
           }
         }
-
-        // Prevent the main `messages` array from being populated further for this union issue
-        continue // Skip adding messages directly from the top-level union issue itself
       }
       // Handle other specific error codes (only if not handled above)
       else {
@@ -231,7 +235,7 @@ export function zodParseWithContext<T extends z.ZodType>(
         switch (zodIssue.code) {
           case 'invalid_type': {
             received = zodIssue.received === 'undefined' ? 'missing' : zodIssue.received
-            const actualValue = getByPath(obj, path) as any
+            const actualValue = getByPath(obj, path)
             const actualValueStr =
               typeof actualValue === 'object' && actualValue !== null
                 ? JSON.stringify(actualValue)

package/src/apiTypes.ts

@@ -2,11 +2,6 @@ import type { AssemblyInstructions, AssemblyInstructionsInput } from './alphalib
 
 export {
   type AssemblyIndexItem,
-  type AssemblyStatusMeta,
-  type AssemblyStatusResult,
-  type AssemblyStatusResults,
-  type AssemblyStatusUpload,
-  type AssemblyStatusUploads,
   assemblyIndexItemSchema,
   assemblyStatusSchema,
 } from './alphalib/types/assemblyStatus.ts'