@transloadit/node 4.10.6 → 4.10.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transloadit/node",
-  "version": "4.10.6",
+  "version": "4.10.8",
   "description": "Node.js SDK for Transloadit",
   "homepage": "https://github.com/transloadit/node-sdk/tree/main/packages/node",
   "bugs": {

package/src/alphalib/object.ts

@@ -35,16 +35,42 @@ export function getRecordProperty(value: unknown, property: PropertyKey): unknow
   return value[property]
 }
 
+export function getNestedRecordProperty(
+  value: unknown,
+  first: PropertyKey,
+  second: PropertyKey,
+): unknown {
+  return getRecordProperty(getRecordProperty(value, first), second)
+}
+
 export function getStringProperty(value: unknown, property: PropertyKey): string | undefined {
   const propertyValue = getRecordProperty(value, property)
   return typeof propertyValue === 'string' ? propertyValue : undefined
 }
 
+export function getNestedStringProperty(
+  value: unknown,
+  first: PropertyKey,
+  second: PropertyKey,
+): string | undefined {
+  const propertyValue = getNestedRecordProperty(value, first, second)
+  return typeof propertyValue === 'string' ? propertyValue : undefined
+}
+
 export function getNumberProperty(value: unknown, property: PropertyKey): number | undefined {
   const propertyValue = getRecordProperty(value, property)
   return typeof propertyValue === 'number' ? propertyValue : undefined
 }
 
+export function getNestedNumberProperty(
+  value: unknown,
+  first: PropertyKey,
+  second: PropertyKey,
+): number | undefined {
+  const propertyValue = getNestedRecordProperty(value, first, second)
+  return typeof propertyValue === 'number' ? propertyValue : undefined
+}
+
 /**
  * Returns properly typed entries of an object
  */

package/src/alphalib/types/assemblyStatus.ts

@@ -7,6 +7,7 @@ export const assemblyBusyCodeSchema = z.enum([
   'ASSEMBLY_EXECUTING',
   'ASSEMBLY_REPLAYING',
 ])
+export type AssemblyBusyCode = z.infer<typeof assemblyBusyCodeSchema>
 
 export const assemblyStatusOkCodeSchema = z.enum([
   'ASSEMBLY_CANCELED',
@@ -19,6 +20,7 @@ export const assemblyStatusOkCodeSchema = z.enum([
   // 'ASSEMBLY_FILE_ACCEPTED',
   // 'ASSEMBLY_FILE_RESERVED',
 ])
+export type AssemblyStatusOkCode = z.infer<typeof assemblyStatusOkCodeSchema>
 
 export const assemblyStatusErrCodeSchema = z.enum([
   'ADMIN_PERMISSIONS_REQUIRED',
@@ -351,6 +353,7 @@ export const assemblyStatusErrCodeSchema = z.enum([
   'YOUTUBE_STORE_PROBLEM_SENDING_FILE',
   'YOUTUBE_STORE_VALIDATION',
 ])
+export type AssemblyStatusErrCode = z.infer<typeof assemblyStatusErrCodeSchema>
 
 const assemblyStatusMetaSchema = z
   .object({
@@ -455,6 +458,22 @@ const assemblyStatusMetaSchema = z
     num_subtitles: z.union([z.number(), z.null()]).optional(),
     bit_depth: z.union([z.number(), z.null()]).optional(),
     seekable: z.union([z.boolean(), z.null()]).optional(),
+    interlaced: z.boolean().nullable().optional(),
+    field_order: z.string().nullable().optional(),
+    interlace_detection: z
+      .object({
+        sampled_frames: z.number().optional(),
+        tff: z.number().optional(),
+        bff: z.number().optional(),
+        progressive: z.number().optional(),
+        undetermined: z.number().optional(),
+        confidence: z.number().optional(),
+        method: z.string().optional(),
+        ffprobe_field_order: z.string().nullable().optional(),
+      })
+      .passthrough()
+      .nullable()
+      .optional(),
     pixel_format: z.union([z.string(), z.null()]).optional(),
     reference_count: z.union([z.number(), z.null()]).optional(),
     time_base: z.union([z.string(), z.null()]).optional(),
@@ -740,6 +759,7 @@ export const assemblyStatusBaseSchema = z.object({
   notify_status: z.string().nullable().optional(),
   notify_response_code: z.number().nullable().optional(),
   notify_response_data: z.string().nullable().optional(),
+  notify_error: z.string().nullable().optional(),
   notify_duration: z.number().nullable().optional(),
   last_job_completed: z.string().nullable().optional(),
   fields: z.record(z.unknown()).optional(),

package/src/alphalib/types/robots/_instructions-primitives.ts

@@ -1682,59 +1682,59 @@ export const filterExpression = z.union([
   z.array(z.union([z.string(), z.number(), z.null()])),
 ])
 
-export type FilterCondition = z.infer<typeof filterCondition>
-export const filterCondition = z.union([
-  z.null(),
-  z.string(),
-  z.array(
-    z.tuple([
-      filterExpression,
-      z.union([
-        z.literal('=').describe('Equals without type check'),
-        z.literal('==').describe('Equals without type check'),
-        z.literal('===').describe('Strict equals with type check'),
-        z.literal('<').describe('Less than'),
-        z.literal('>').describe('Greater than'),
-        z.literal('<=').describe('Less or equal'),
-        z.literal('>=').describe('Greater or equal'),
-        z.literal('!=').describe('Simple inequality check without type check'),
-        z.literal('!==').describe('Strict inequality check with type check'),
-        z
-          .literal('regex')
-          .describe(
-            'Case-insensitive regular expression based on [RE2](https://github.com/google/re2) `.match()`',
-          ),
-        z
-          .literal('!regex')
-          .describe(
-            'Case-insensitive regular expression based on [RE2](https://github.com/google/re2) `!.match()`',
-          ),
-        z
-          .literal('includes')
-          .describe(
-            'Check if the right element is included in the array, which is represented by the left element',
-          ),
-        z
-          .literal('!includes')
-          .describe(
-            'Check if the right element is not included in the array, which is represented by the left element',
-          ),
-        z
-          .literal('empty')
-          .describe(
-            'Check if the left element is an empty array, an object without properties, an empty string, the number zero or the boolean false. Leave the third element of the array to be an empty string. It won’t be evaluated.',
-          ),
-        z
-          .literal('!empty')
-          .describe(
-            'Check if the left element is an array with members, an object with at least one property, a non-empty string, a number that does not equal zero or the boolean true. Leave the third element of the array to be an empty string. It won’t be evaluated.',
-          ),
-      ]),
-      filterExpression,
-    ]),
-  ),
+export type FilterConditionOperator = z.infer<typeof filterConditionOperatorSchema>
+export const filterConditionOperatorSchema = z.union([
+  z.literal('=').describe('Equals without type check'),
+  z.literal('==').describe('Equals without type check'),
+  z.literal('===').describe('Strict equals with type check'),
+  z.literal('<').describe('Less than'),
+  z.literal('>').describe('Greater than'),
+  z.literal('<=').describe('Less or equal'),
+  z.literal('>=').describe('Greater or equal'),
+  z.literal('!=').describe('Simple inequality check without type check'),
+  z.literal('!==').describe('Strict inequality check with type check'),
+  z
+    .literal('regex')
+    .describe(
+      'Case-insensitive regular expression based on [RE2](https://github.com/google/re2) `.match()`',
+    ),
+  z
+    .literal('!regex')
+    .describe(
+      'Case-insensitive regular expression based on [RE2](https://github.com/google/re2) `!.match()`',
+    ),
+  z
+    .literal('includes')
+    .describe(
+      'Check if the right element is included in the array, which is represented by the left element',
+    ),
+  z
+    .literal('!includes')
+    .describe(
+      'Check if the right element is not included in the array, which is represented by the left element',
+    ),
+  z
+    .literal('empty')
+    .describe(
+      'Check if the left element is an empty array, an object without properties, an empty string, the number zero or the boolean false. Leave the third element of the array to be an empty string. It won’t be evaluated.',
+    ),
+  z
+    .literal('!empty')
+    .describe(
+      'Check if the left element is an array with members, an object with at least one property, a non-empty string, a number that does not equal zero or the boolean true. Leave the third element of the array to be an empty string. It won’t be evaluated.',
+    ),
 ])
 
+export type FilterConditionPart = z.infer<typeof filterConditionPartSchema>
+export const filterConditionPartSchema = z.tuple([
+  filterExpression,
+  filterConditionOperatorSchema,
+  filterExpression,
+])
+
+export type FilterCondition = z.infer<typeof filterCondition>
+export const filterCondition = z.union([z.null(), z.string(), z.array(filterConditionPartSchema)])
+
 /**
  * Parameters specific to the /video/encode robot. Useful for typing robots that pass files to /video/encode.
  */
@@ -1913,10 +1913,17 @@ Delta to apply to segment duration. This is optional and allows fine-tuning of s
   })
   .strict()
 
-/**
- * Type for the normalized use parameter from AssemblyNormalizer
- * The steps array can contain either strings or objects with name property
- */
+export type NormalizedUseStepName = string | undefined
+
+export interface NormalizedUseStep {
+  as?: unknown[]
+  fields?: unknown[]
+  name: NormalizedUseStepName
+}
+
 export interface NormalizedUse {
-  steps: Array<{ name: string; as?: string; fields?: string }>
+  bundle_steps: boolean
+  fields: true | unknown[]
+  group_by_original: boolean
+  steps: NormalizedUseStep[]
 }

package/src/alphalib/types/robots/assembly-savejson.ts

@@ -46,9 +46,20 @@ TODO: Add robot description here
   })
   .strict()
 
+export const robotAssemblySavejsonInstructionsWithHiddenFieldsSchema =
+  robotAssemblySavejsonInstructionsSchema.extend({
+    assembly_id: z.string().optional(),
+    expiry: z.string().optional(),
+    instance: z.string().optional(),
+    status: z.unknown().optional(),
+  })
+
 export type RobotAssemblySavejsonInstructions = z.infer<
   typeof robotAssemblySavejsonInstructionsSchema
 >
+export type RobotAssemblySavejsonInstructionsWithHiddenFields = z.infer<
+  typeof robotAssemblySavejsonInstructionsWithHiddenFieldsSchema
+>
 
 export const interpolatableRobotAssemblySavejsonInstructionsSchema = interpolateRobot(
   robotAssemblySavejsonInstructionsSchema,
@@ -59,3 +70,13 @@ export type InterpolatableRobotAssemblySavejsonInstructions =
 export type InterpolatableRobotAssemblySavejsonInstructionsInput = z.input<
   typeof interpolatableRobotAssemblySavejsonInstructionsSchema
 >
+
+export const interpolatableRobotAssemblySavejsonInstructionsWithHiddenFieldsSchema =
+  interpolateRobot(robotAssemblySavejsonInstructionsWithHiddenFieldsSchema)
+export type InterpolatableRobotAssemblySavejsonInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAssemblySavejsonInstructionsWithHiddenFieldsSchema
+>
+
+export type InterpolatableRobotAssemblySavejsonInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAssemblySavejsonInstructionsWithHiddenFieldsSchema
+>

package/src/alphalib/types/robots/file-filter.ts

@@ -9,6 +9,17 @@ import {
   robotUse,
 } from './_instructions-primitives.ts'
 
+export type {
+  FilterCondition,
+  FilterConditionOperator,
+  FilterConditionPart,
+} from './_instructions-primitives.ts'
+
+export {
+  filterConditionOperatorSchema,
+  filterConditionPartSchema,
+} from './_instructions-primitives.ts'
+
 export const meta: RobotMetaInput = {
   bytescount: 0,
   discount_factor: 0,
@@ -71,7 +82,7 @@ Passing JavaScript allows you to implement logic as complex as you wish, however
 The \`accepts\` and \`declines\` parameters can each be set to an array of arrays with three members:
 
 1. A value or job variable, such as \`\${file.mime}\`
-2. One of the following operators: \`==\`, \`===\`, \`<\`, \`>\`, \`<=\`, \`>=\`, \`!=\`, \`!==\`, \`regex\`, \`!regex\`, \`includes\`, \`!includes\`
+2. One of the following operators: \`=\`, \`==\`, \`===\`, \`<\`, \`>\`, \`<=\`, \`>=\`, \`!=\`, \`!==\`, \`regex\`, \`!regex\`, \`includes\`, \`!includes\`, \`empty\`, \`!empty\`
 3. A value or job variable, such as \`50\` or \`"foo"\`
 
 Examples:

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

@@ -103,6 +103,14 @@ Setting this to \`"meta"\` will still import the file on metadata extraction err
       .default(false)
       .describe(`
 Disable the internal retry mechanism, and fail immediately if a resource can't be imported. This can be useful for performance critical applications.
+`),
+    max_file_size: z
+      .number()
+      .int()
+      .positive()
+      .optional()
+      .describe(`
+Maximum allowed size in bytes for each imported file. If the remote server reports a larger file size, the import is rejected before the download starts. If the remote server does not report a size upfront, the download is aborted once this limit is exceeded.
 `),
     return_file_stubs,
     range: z

package/src/alphalib/types/robots/image-facedetect.ts

@@ -9,6 +9,29 @@ import {
   robotUse,
 } from './_instructions-primitives.ts'
 
+export const imageFacedetectFaceSelectionModes = [
+  'each',
+  'group',
+  'max-confidence',
+  'max-size',
+] as const
+
+export const imageFacedetectFaceSelectionModeSchema = z.enum(imageFacedetectFaceSelectionModes)
+
+export const imageFacedetectFaceCoordinatesSchema = z
+  .object({
+    confidence: z.number().optional(),
+    height: z.number(),
+    width: z.number(),
+    x1: z.number(),
+    x2: z.number().optional(),
+    y1: z.number(),
+    y2: z.number().optional(),
+  })
+  .passthrough()
+
+export type ImageFacedetectFaceCoordinates = z.infer<typeof imageFacedetectFaceCoordinatesSchema>
+
 export const meta: RobotMetaInput = {
   bytescount: 1,
   discount_factor: 1,
@@ -104,7 +127,7 @@ The default value \`"preserve"\` means that the input image format is re-used.
 Specifies the minimum confidence that a detected face must have. Only faces which have a higher confidence value than this threshold will be included in the result.
 `),
     faces: z
-      .union([z.enum(['each', 'group', 'max-confidence', 'max-size']), z.number().int()])
+      .union([imageFacedetectFaceSelectionModeSchema, z.number().int()])
       .default('each')
       .describe(`
 Determines which of the detected faces should be returned. Valid values are:

package/src/alphalib/types/robots/speech-transcribe.ts

@@ -9,10 +9,10 @@ import {
   robotUse,
 } from './_instructions-primitives.ts'
 
-const speechTranscribeProviderSchema = z.enum(['aws', 'gcp', 'replicate']).default('replicate')
+const speechTranscribeProviderSchema = z.enum(['aws', 'gcp', 'replicate']).optional()
 const speechTranscribeProviderWithHiddenFieldsSchema = z
   .enum(['aws', 'gcp', 'replicate', 'transloadit'])
-  .default('replicate')
+  .optional()
 
 export const meta: RobotMetaInput = {
   bytescount: 1,
@@ -68,11 +68,48 @@ export const robotSpeechTranscribeInstructionsSchema = robotBase
 You can use the text that we return in your application, or you can pass the text down to other <dfn>Robots</dfn> to filter audio or video files that contain (or do not contain) certain content, or burn the text into images or video for example.
 
 Another common use case is automatically subtitling videos, or making audio searchable.
+
+Set \`speaker_labels\` to \`true\` when you want JSON or meta transcription output to distinguish
+recurring speakers:
+
+\`\`\`json
+{
+  "steps": {
+    "transcribed": {
+      "use": ":original",
+      "robot": "/speech/transcribe",
+      "provider": "aws",
+      "format": "json",
+      "speaker_labels": true,
+      "max_speakers": 3
+    }
+  }
+}
+\`\`\`
+
+Speaker labels are currently supported by the \`aws\` and \`gcp\` providers. If you enable
+\`speaker_labels\` without setting \`provider\`, Transloadit uses \`aws\` for that <dfn>Step</dfn>. Labels
+are normalized as \`speaker_1\`, \`speaker_2\`, and so on:
+
+\`\`\`json
+{
+  "text": "Hello there. Hi!",
+  "words": [
+    { "text": "Hello", "startTime": 0, "endTime": 0.5, "speaker": "speaker_1" },
+    { "text": "there", "startTime": 0.6, "endTime": 1, "speaker": "speaker_1" },
+    { "text": "Hi!", "startTime": 1.2, "endTime": 1.8, "speaker": "speaker_2" }
+  ],
+  "segments": [
+    { "text": "Hello there", "startTime": 0, "endTime": 1, "speaker": "speaker_1" },
+    { "text": "Hi!", "startTime": 1.2, "endTime": 1.8, "speaker": "speaker_2" }
+  ]
+}
+\`\`\`
 `),
     provider: speechTranscribeProviderSchema.describe(`
 Which AI provider to leverage.
 
-Defaults to \`"replicate"\`, which currently uses our highest-quality deployed transcription path while ElevenLabs Scribe support is being prepared.
+Defaults to \`"replicate"\`, which currently uses our highest-quality deployed transcription path while ElevenLabs Scribe support is being prepared. When \`speaker_labels\` is \`true\` and \`provider\` is omitted, Transloadit defaults to \`"aws"\`, because speaker labels are currently supported by the \`aws\` and \`gcp\` providers.
 
 Transloadit abstracts the interface so you can expect the same data structures, but different latencies and information being returned. Different cloud vendors have different areas they shine in, and we recommend to try out and see what yields the best results for your use case.
 `),
@@ -86,9 +123,26 @@ Whether to return a full response (\`"full"\`), or a flat list of descriptions (
 Output format for the transcription.
 
 - \`"text"\` outputs a plain text file that you can store and process.
-- \`"json"\` outputs a JSON file containing timestamped words.
+- \`"json"\` outputs a JSON file containing timestamped words. When \`speaker_labels\` is enabled, words can include \`speaker\` labels and the JSON can also include grouped \`segments\` by speaker.
 - \`"srt"\` and \`"webvtt"\` output subtitle files of those respective file types, which can be stored separately or used in other encoding <dfn>Steps</dfn>.
-- \`"meta"\` does not return a file, but stores the data inside  Transloadit's file object (under \`\${file.meta.transcription.text}\`) that's passed around between encoding <dfn>Steps</dfn>, so that you can use the values to burn the data into videos, filter on them, etc.
+- \`"meta"\` does not return a file, but stores the data inside Transloadit's file object (under \`\${file.meta.transcription.text}\`, \`\${file.meta.transcription.words}\`, and, when speaker labels are available, \`\${file.meta.transcription.segments}\`) that's passed around between encoding <dfn>Steps</dfn>, so that you can use the values to burn the data into videos, filter on them, etc.
+`),
+    speaker_labels: z
+      .boolean()
+      .default(false)
+      .describe(`
+When enabled, Transloadit asks the transcription provider to distinguish different speakers. JSON and meta output can then include \`speaker\` labels such as \`"speaker_1"\` on individual words, plus grouped \`segments\` by speaker. Text, SRT, and WebVTT output behavior is unchanged.
+
+Speaker labels identify recurring voices, not real person names. Accuracy depends on audio quality, background noise, overlapping speech, and the number of speakers.
+`),
+    max_speakers: z
+      .number()
+      .int()
+      .min(1)
+      .max(10)
+      .default(10)
+      .describe(`
+The maximum number of speakers to detect when \`speaker_labels\` is enabled.
 `),
     // TODO determine the list of languages
     source_language: z
@@ -113,6 +167,7 @@ The language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/
 
 export const robotSpeechTranscribeInstructionsWithHiddenFieldsSchema =
   robotSpeechTranscribeInstructionsSchema.extend({
+    model: z.enum(['whisper-large-v3']).optional(),
     provider: speechTranscribeProviderWithHiddenFieldsSchema,
     result: z
       .union([z.literal('debug'), robotSpeechTranscribeInstructionsSchema.shape.result])

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

@@ -95,6 +95,8 @@ You can add text overlays to videos using FFmpeg's \`drawtext\` filter through t
 - 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\`).
+- File-loading \`drawtext\` options such as \`textfile\` and \`fontfile\` are not supported. Use
+  inline \`text\` and a font family name instead.
 - Preserve the source audio by setting \`"codec:a": "copy"\`.
 - Position text with the \`x\` and \`y\` expressions. The example above centers the text.
 

package/src/tus.ts

@@ -153,6 +153,12 @@ export async function sendTusRequest({
       rejectCompletion = reject
     })
 
+    // If startPromise rejects first, pMap aborts before sendTusRequest reaches the aggregate awaits
+    // below. These bookkeeping promises still need handlers so the startPromise rejection remains
+    // the single error surface.
+    uploadUrlPromise.catch(() => {})
+    completionPromise.catch(() => {})
+
     uploadUrlPromises.push(uploadUrlPromise)
     completionPromises.push(completionPromise)