@transloadit/node 4.1.3

package/src/alphalib/types/robots/audio-loop.ts

@@ -0,0 +1,102 @@
+import { z } from 'zod'
+
+import { stackVersions } from '../stackVersions.ts'
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  bitrateSchema,
+  interpolateRobot,
+  robotBase,
+  robotFFmpegAudio,
+  robotUse,
+  sampleRateSchema,
+} from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: false,
+  bytescount: 4,
+  discount_factor: 0.25,
+  discount_pct: 75,
+  example_code: {
+    steps: {
+      looped: {
+        robot: '/audio/loop',
+        use: ':original',
+        duration: 300,
+        ffmpeg_stack: stackVersions.ffmpeg.recommendedVersion,
+      },
+    },
+  },
+  example_code_description: 'Loop uploaded audio to achieve a target duration of 300 seconds:',
+  marketing_intro:
+    'Whether you’re producing beats, white-noise, or just empty segments as fillers between audio tracks that you’re to stringing together with [🤖/audio/concat](/docs/robots/audio-concat/), [🤖/audio/loop](/docs/robots/audio-loop/) has got your back.',
+  minimum_charge: 0,
+  output_factor: 0.8,
+  override_lvl1: 'Audio Encoding',
+  purpose_sentence: 'loops one audio file as often as is required to match a given duration',
+  purpose_verb: 'loop',
+  purpose_word: 'loop',
+  purpose_words: 'Loop audio',
+  service_slug: 'audio-encoding',
+  slot_count: 20,
+  title: 'Loop audio',
+  typical_file_size_mb: 3.8,
+  typical_file_type: 'audio file',
+  uses_tools: ['ffmpeg'],
+  name: 'AudioLoopRobot',
+  priceFactor: 4,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotAudioLoopInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpegAudio)
+  .extend({
+    robot: z.literal('/audio/loop'),
+    bitrate: bitrateSchema.optional().describe(`
+Bit rate of the resulting audio file, in bits per second. If not specified will default to the bit rate of the input audio file.
+`),
+    sample_rate: sampleRateSchema.optional().describe(`
+Sample rate of the resulting audio file, in Hertz. If not specified will default to the sample rate of the input audio file.
+`),
+    duration: z
+      .number()
+      .default(60)
+      .describe(`
+Target duration for the whole process in seconds. The <dfn>Robot</dfn> will loop the input audio file for as long as this target duration is not reached yet.
+`),
+  })
+  .strict()
+
+export const robotAudioLoopInstructionsWithHiddenFieldsSchema =
+  robotAudioLoopInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotAudioLoopInstructionsSchema.shape.result]).optional(),
+  })
+
+export type RobotAudioLoopInstructions = z.infer<typeof robotAudioLoopInstructionsSchema>
+export type RobotAudioLoopInstructionsWithHiddenFields = z.infer<
+  typeof robotAudioLoopInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotAudioLoopInstructionsSchema = interpolateRobot(
+  robotAudioLoopInstructionsSchema,
+)
+export type InterpolatableRobotAudioLoopInstructions = InterpolatableRobotAudioLoopInstructionsInput
+
+export type InterpolatableRobotAudioLoopInstructionsInput = z.input<
+  typeof interpolatableRobotAudioLoopInstructionsSchema
+>
+
+export const interpolatableRobotAudioLoopInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotAudioLoopInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotAudioLoopInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAudioLoopInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotAudioLoopInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAudioLoopInstructionsWithHiddenFieldsSchema
+>

package/src/alphalib/types/robots/audio-merge.ts

@@ -0,0 +1,137 @@
+import { z } from 'zod'
+
+import { stackVersions } from '../stackVersions.ts'
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  bitrateSchema,
+  interpolateRobot,
+  robotBase,
+  robotFFmpegAudio,
+  robotUse,
+  robotUseWithHiddenFields,
+  sampleRateSchema,
+} from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: false,
+  bytescount: 4,
+  discount_factor: 0.25,
+  discount_pct: 75,
+  example_code: {
+    steps: {
+      merged: {
+        robot: '/audio/merge',
+        preset: 'mp3',
+        use: {
+          steps: [
+            {
+              name: ':original',
+              fields: 'first_audio_file',
+              as: 'audio',
+            },
+            {
+              name: ':original',
+              fields: 'second_audio_file',
+              as: 'audio',
+            },
+            {
+              name: ':original',
+              fields: 'third_audio_file',
+              as: 'audio',
+            },
+          ],
+        },
+        ffmpeg_stack: stackVersions.ffmpeg.recommendedVersion,
+      },
+    },
+  },
+  example_code_description:
+    'If you have a form with 3 file input fields and wish to overlay the uploaded audios, 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 `audio`:',
+  minimum_charge: 0,
+  output_factor: 0.8,
+  override_lvl1: 'Audio Encoding',
+  purpose_sentence: 'overlays several audio files on top of each other',
+  purpose_verb: 'merge',
+  purpose_word: 'merge',
+  purpose_words: 'Merge audio files into one',
+  service_slug: 'audio-encoding',
+  slot_count: 20,
+  title: 'Merge audio files into one',
+  typical_file_size_mb: 3.8,
+  typical_file_type: 'audio file',
+  uses_tools: ['ffmpeg'],
+  name: 'AudioMergeRobot',
+  priceFactor: 4,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotAudioMergeInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpegAudio)
+  .extend({
+    robot: z.literal('/audio/merge'),
+    bitrate: bitrateSchema.optional().describe(`
+Bit rate of the resulting audio file, in bits per second. If not specified will default to the bit rate of the input audio file.
+`),
+    sample_rate: sampleRateSchema.optional().describe(`
+Sample rate of the resulting audio file, in Hertz. If not specified will default to the sample rate of the input audio file.
+`),
+    duration: z
+      .enum(['first', 'longest', 'shortest'])
+      .default('longest')
+      .describe(`
+Duration of the output file compared to the duration of all merged audio files. Can be \`"first"\` (duration of the first input file), \`"shortest"\` (duration of the shortest audio file) or \`"longest"\` for the duration of the longest input file.
+`),
+    loop: z
+      .boolean()
+      .default(false)
+      .describe(`
+Specifies if any input files that do not match the target duration should be looped to match it. Useful for audio merging where your overlay file is typically much shorter than the main audio file.
+`),
+    volume: z
+      .enum(['average', 'sum'])
+      .default('average')
+      .describe(`
+Valid values are \`"average"\` and \`"sum"\` here. \`"average"\` means each input is scaled 1/n (n is the number of inputs) or \`"sum"\` which means each individual audio stays on the same volume, but since we merge tracks 'on top' of each other, this could result in very loud output.
+`),
+  })
+  .strict()
+
+export const robotAudioMergeInstructionsWithHiddenFieldsSchema = robotAudioMergeInstructionsSchema
+  .omit({ use: true })
+  .merge(robotUseWithHiddenFields)
+  .extend({
+    result: z
+      .union([z.literal('debug'), robotAudioMergeInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotAudioMergeInstructions = z.infer<typeof robotAudioMergeInstructionsSchema>
+export type RobotAudioMergeInstructionsWithHiddenFields = z.infer<
+  typeof robotAudioMergeInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotAudioMergeInstructionsSchema = interpolateRobot(
+  robotAudioMergeInstructionsSchema,
+)
+export type InterpolatableRobotAudioMergeInstructions =
+  InterpolatableRobotAudioMergeInstructionsInput
+
+export type InterpolatableRobotAudioMergeInstructionsInput = z.input<
+  typeof interpolatableRobotAudioMergeInstructionsSchema
+>
+
+export const interpolatableRobotAudioMergeInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotAudioMergeInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotAudioMergeInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAudioMergeInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotAudioMergeInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAudioMergeInstructionsWithHiddenFieldsSchema
+>

package/src/alphalib/types/robots/audio-waveform.ts

@@ -0,0 +1,280 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  color_with_alpha,
+  interpolateRobot,
+  robotBase,
+  robotFFmpeg,
+  robotUse,
+} from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: false,
+  bytescount: 1,
+  discount_factor: 1,
+  discount_pct: 0,
+  example_code: {
+    steps: {
+      waveformed: {
+        robot: '/audio/waveform',
+        use: ':original',
+        width: 400,
+        height: 200,
+        outer_color: '0099ccff',
+        center_color: '0099ccff',
+      },
+    },
+  },
+  example_code_description:
+    'Generate a 400×200 waveform in `#0099cc` color from an uploaded audio file:',
+  extended_description: `
+Here is an example waveform image:
+
+{% assign hotDemo = collections.demos |find: "url", "/demos/audio-encoding/generate-a-waveform-image-from-an-audio-file/" %}
+
+<img src="{{hotDemo.data.generated_outputs.waveformed["audio-encoding-generate-a-waveform-image-from-an-audio-file-waveformed-joakim_karud-rock_angel-0.png"].ssl_url}}" width="300" alt="Example waveform image">
+`,
+  minimum_charge: 1048576,
+  output_factor: 0.07,
+  override_lvl1: 'Audio Encoding',
+  purpose_sentence:
+    'generates waveform images for your audio files and allows you to change their colors and dimensions',
+  purpose_verb: 'generate',
+  purpose_word: 'generate waveforms',
+  purpose_words: 'Generate waveform images from audio',
+  service_slug: 'audio-encoding',
+  slot_count: 20,
+  title: 'Generate waveform images from audio',
+  typical_file_size_mb: 3.8,
+  typical_file_type: 'audio file',
+  name: 'AudioWaveformRobot',
+  priceFactor: 1,
+  queueSlotCount: 20,
+  minimumCharge: 1048576,
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+// Base schema with common fields
+const robotAudioWaveformInstructionsBaseSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
+    robot: z.literal('/audio/waveform').describe(`
+We recommend that you use an [🤖/audio/encode](/docs/robots/audio-encode/) <dfn>Step</dfn> prior to your waveform <dfn>Step</dfn> to convert audio files to MP3. This way it is guaranteed that [🤖/audio/waveform](/docs/robots/audio-waveform/) accepts your audio file and you can also down-sample large audio files and save some money.
+
+Similarly, if you need the output image in a different format, please pipe the result of this <dfn>Robot</dfn> into [🤖/image/resize](/docs/robots/image-resize/).
+`),
+    format: z
+      .enum(['image', 'json'])
+      .default('image')
+      .describe(`
+The format of the result file. Can be \`"image"\` or \`"json"\`. If \`"image"\` is supplied, a PNG image will be created, otherwise a JSON file.
+`),
+    width: z
+      .number()
+      .int()
+      .min(1)
+      .default(256)
+      .describe(`
+The width of the resulting image if the format \`"image"\` was selected.
+`),
+    height: z
+      .number()
+      .int()
+      .min(1)
+      .default(64)
+      .describe(`
+The height of the resulting image if the format \`"image"\` was selected.
+`),
+    antialiasing: z
+      .union([z.literal(0), z.literal(1), z.boolean()])
+      .default(0)
+      .describe(`
+Either a value of \`0\` or \`1\`, or \`true\`/\`false\`, corresponding to if you want to enable antialiasing to achieve smoother edges in the waveform graph or not.
+`),
+    background_color: color_with_alpha.default('#00000000').describe(`
+The background color of the resulting image in the "rrggbbaa" format (red, green, blue, alpha), if the format \`"image"\` was selected.
+`),
+    center_color: color_with_alpha.default('000000ff').describe(`
+The color used in the center of the gradient. The format is "rrggbbaa" (red, green, blue, alpha).
+`),
+    outer_color: color_with_alpha.default('000000ff').describe(`
+The color used in the outer parts of the gradient. The format is "rrggbbaa" (red, green, blue, alpha).
+`),
+  })
+
+const styleSchema = z.preprocess(
+  (val) => {
+    // Backwards compatibility: historically this robot used numeric styles 0/1/2.
+    // The new API is `style: "v0" | "v1"`. Old v2 values are mapped to v1.
+    if (val === 'v1' || val === 1 || val === '1') return 'v1'
+    if (val === 'v0' || val === 0 || val === '0') return 'v0'
+    return val
+  },
+  z.enum(['v0', 'v1']).default('v0'),
+)
+
+// Unified schema: all parameters exist for both styles, but v1-only parameters only apply when
+// `style` is `v1` (they are accepted for v0 but have no effect).
+export const robotAudioWaveformInstructionsSchema = robotAudioWaveformInstructionsBaseSchema
+  .extend({
+    style: styleSchema.describe(`
+Waveform style version.
+
+- \`"v0"\`: Legacy waveform generation (default).
+- \`"v1"\`: Advanced waveform generation with additional parameters.
+
+For backwards compatibility, numeric values \`0\`, \`1\`, \`2\` are also accepted and mapped to \`"v0"\` (0) and \`"v1"\` (1/2).
+`),
+
+    // v1-only parameters (accepted for v0 but have no effect)
+    split_channels: z
+      .boolean()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. If set to \`true\`, outputs multi-channel waveform data or image files, one per channel.
+`),
+    zoom: z
+      .number()
+      .int()
+      .min(1)
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Zoom level in samples per pixel. This parameter cannot be used together with \`pixels_per_second\`.
+`),
+    pixels_per_second: z
+      .number()
+      .positive()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Zoom level in pixels per second. This parameter cannot be used together with \`zoom\`.
+`),
+    bits: z
+      .union([z.literal(8), z.literal(16)])
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Bit depth for waveform data. Can be 8 or 16.
+`),
+    start: z
+      .number()
+      .min(0)
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Start time in seconds.
+`),
+    end: z
+      .number()
+      .min(0)
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. End time in seconds (0 means end of audio).
+`),
+    colors: z
+      .enum(['audition', 'audacity'])
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Color scheme to use. Can be "audition" or "audacity".
+`),
+    border_color: color_with_alpha.optional().describe(`
+Available when style is \`"v1"\`. Border color in "rrggbbaa" format.
+`),
+    waveform_style: z
+      .enum(['normal', 'bars'])
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Waveform style. Can be "normal" or "bars".
+`),
+    bar_width: z
+      .number()
+      .int()
+      .positive()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Width of bars in pixels when waveform_style is "bars".
+`),
+    bar_gap: z
+      .number()
+      .int()
+      .min(0)
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Gap between bars in pixels when waveform_style is "bars".
+`),
+    bar_style: z
+      .enum(['square', 'rounded'])
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Bar style when waveform_style is "bars".
+`),
+    axis_label_color: color_with_alpha.optional().describe(`
+Available when style is \`"v1"\`. Color for axis labels in "rrggbbaa" format.
+`),
+    no_axis_labels: z
+      .boolean()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. If set to \`true\`, renders waveform image without axis labels.
+`),
+    with_axis_labels: z
+      .boolean()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. If set to \`true\`, renders waveform image with axis labels.
+`),
+    amplitude_scale: z
+      .number()
+      .positive()
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. Amplitude scale factor.
+`),
+    compression: z
+      .number()
+      .int()
+      .min(-1)
+      .max(9)
+      .optional()
+      .describe(`
+Available when style is \`"v1"\`. PNG compression level: 0 (none) to 9 (best), or -1 (default). Only applicable when format is "image".
+`),
+  })
+  .strict()
+
+export const robotAudioWaveformInstructionsWithHiddenFieldsSchema =
+  robotAudioWaveformInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotAudioWaveformInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotAudioWaveformInstructions = z.infer<typeof robotAudioWaveformInstructionsSchema>
+export type RobotAudioWaveformInstructionsWithHiddenFields = z.infer<
+  typeof robotAudioWaveformInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotAudioWaveformInstructionsSchema = interpolateRobot(
+  robotAudioWaveformInstructionsSchema,
+)
+
+export type InterpolatableRobotAudioWaveformInstructions = z.input<
+  typeof interpolatableRobotAudioWaveformInstructionsSchema
+>
+export type InterpolatableRobotAudioWaveformInstructionsInput = z.input<
+  typeof interpolatableRobotAudioWaveformInstructionsSchema
+>
+
+export const interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotAudioWaveformInstructionsWithHiddenFieldsSchema,
+)
+
+export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,111 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  azureBase,
+  files_per_page,
+  interpolateRobot,
+  next_page_token,
+  path,
+  recursive,
+  robotBase,
+  robotImport,
+} from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: true,
+  bytescount: 10,
+  discount_factor: 0.1,
+  discount_pct: 90,
+  example_code: {
+    steps: {
+      imported: {
+        robot: '/azure/import',
+        credentials: 'YOUR_AZURE_CREDENTIALS',
+        path: 'path/to/files/',
+      },
+    },
+  },
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Importing',
+  purpose_sentence: 'imports whole directories of files from your Azure container',
+  purpose_verb: 'import',
+  purpose_word: 'Azure',
+  purpose_words: 'Import files from Azure',
+  service_slug: 'file-importing',
+  requires_credentials: true,
+  slot_count: 20,
+  title: 'Import files from Azure',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'AzureImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotAzureImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(azureBase)
+  .extend({
+    robot: z.literal('/azure/import'),
+    path: path.describe(`
+The path in your container to the specific file or directory. If the path points to a file, only this file will be imported. For example: \`images/avatar.jpg\`.
+
+If it points to a directory, indicated by a trailing slash (\`/\`), then all files that are descendants of this directory are recursively imported. For example: \`images/\`.
+
+If you want to import all files from the root directory, please use \`/\` as the value here.
+
+You can also use an array of path strings here to import multiple paths in the same <dfn>Robot</dfn>'s <dfn>Step</dfn>.
+`),
+    recursive: recursive.describe(`
+  Setting this to \`true\` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.
+  `),
+    next_page_token: next_page_token.describe(`
+A string token used for pagination. The returned files of one paginated call have the next page token inside of their meta data, which needs to be used for the subsequent paging call.
+`),
+    files_per_page: files_per_page.describe(`
+The pagination page size.
+`),
+  })
+  .strict()
+
+export const robotAzureImportInstructionsWithHiddenFieldsSchema =
+  robotAzureImportInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotAzureImportInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotAzureImportInstructions = z.infer<typeof robotAzureImportInstructionsSchema>
+export type RobotAzureImportInstructionsWithHiddenFields = z.infer<
+  typeof robotAzureImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotAzureImportInstructionsSchema = interpolateRobot(
+  robotAzureImportInstructionsSchema,
+)
+export type InterpolatableRobotAzureImportInstructions =
+  InterpolatableRobotAzureImportInstructionsInput
+
+export type InterpolatableRobotAzureImportInstructionsInput = z.input<
+  typeof interpolatableRobotAzureImportInstructionsSchema
+>
+
+export const interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotAzureImportInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotAzureImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotAzureImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema
+>