transloadit 4.14.0 → 5.0.0

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

@@ -1,59 +1,43 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import { stackVersions } from '../stackVersions.ts'
 import {
   bitrateSchema,
-  interpolateRobot,
+  createProcessingExample,
+  defineRobot,
+  robotAudioEncodingMeta,
   robotBase,
   robotFFmpegAudio,
+  robotParameterDocs,
   robotUse,
   sampleRateSchema,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 4,
-  discount_factor: 0.25,
-  discount_pct: 75,
-  example_code: {
-    steps: {
-      split: {
-        robot: '/audio/split',
-        use: ':original',
-        ffmpeg_stack: stackVersions.ffmpeg.recommendedVersion,
-        segments: [
-          { from: 0, to: 30 },
-          { from: 60, to: 90 },
-        ],
-      },
-    },
-  },
+  ...robotAudioEncodingMeta,
+  example_code: createProcessingExample('split', '/audio/split', {
+    ffmpeg_stack: stackVersions.ffmpeg.recommendedVersion,
+    segments: [
+      { from: 0, to: 30 },
+      { from: 60, to: 90 },
+    ],
+  }),
   example_code_description:
     'Split an audio file into two segments, extracting the first 30 seconds and a segment from 1:00 to 1:30:',
-  minimum_charge: 0,
-  output_factor: 0.8,
-  override_lvl1: 'Audio Encoding',
   purpose_sentence:
     'splits an audio file into multiple segments based on an array of from/to durations',
   purpose_verb: 'split',
   purpose_word: 'split',
   purpose_words: 'Split audio',
-  service_slug: 'audio-encoding',
-  slot_count: 20,
   title: 'Split audio',
-  typical_file_size_mb: 3.8,
-  typical_file_type: 'audio file',
   uses_tools: ['ffmpeg'],
   name: 'AudioSplitRobot',
-  priceFactor: 4,
-  queueSlotCount: 20,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: true,
-  applyCommunityPlanMediaTrim: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 const segmentSchema = z
@@ -90,43 +74,29 @@ An array of objects, each specifying a segment to extract from the input audio.
 
 Times can be specified as numbers (seconds) or as timecode strings (e.g. \`"00:01:30.000"\`).
 `),
-    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.
-`),
+    bitrate: bitrateSchema.optional().describe(robotParameterDocs.audio_bitrate.description),
+    sample_rate: sampleRateSchema
+      .optional()
+      .describe(robotParameterDocs.audio_sample_rate.description),
   })
   .strict()
 
-export const robotAudioSplitInstructionsWithHiddenFieldsSchema =
-  robotAudioSplitInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotAudioSplitInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotAudioSplitInstructions = z.infer<typeof robotAudioSplitInstructionsSchema>
-export type RobotAudioSplitInstructionsWithHiddenFields = z.infer<
-  typeof robotAudioSplitInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotAudioSplitInstructionsSchema.shape> =
+  defineRobot(meta, robotAudioSplitInstructionsSchema)
 
-export const interpolatableRobotAudioSplitInstructionsSchema = interpolateRobot(
-  robotAudioSplitInstructionsSchema,
-)
-export type InterpolatableRobotAudioSplitInstructions =
-  InterpolatableRobotAudioSplitInstructionsInput
+export const {
+  withHiddenFields: robotAudioSplitInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotAudioSplitInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotAudioSplitInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotAudioSplitInstructionsInput = z.input<
-  typeof interpolatableRobotAudioSplitInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotAudioSplitInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotAudioSplitInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotAudioSplitInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotAudioSplitInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotAudioSplitInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotAudioSplitInstructionsWithHiddenFieldsSchema
->
+export type RobotAudioSplitInstructions = Instructions['output']
+export type RobotAudioSplitInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotAudioSplitInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotAudioSplitInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotAudioSplitInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotAudioSplitInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,31 +1,30 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
+import { zodStableJsonDefault, zodWithJsonInputSchema } from '../../lib/zodInputSemantics.ts'
 import {
   color_with_alpha,
-  interpolateRobot,
+  createProcessingExample,
+  defineRobot,
+  robotAudioEncodingMeta,
   robotBase,
   robotFFmpeg,
   robotUse,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  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',
-      },
-    },
-  },
+  ...robotAudioEncodingMeta,
+  example_code: createProcessingExample('waveformed', '/audio/waveform', {
+    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: `
@@ -35,29 +34,15 @@ Here is an example waveform image:
 
 <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: true,
-  trackOutputFileSize: true,
-  applyCommunityPlanMediaTrim: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 // Base schema with common fields
@@ -110,16 +95,21 @@ The color used in the outer parts of the gradient. The format is "rrggbbaa" (red
 `),
   })
 
-const styleSchema = z.preprocess(
-  (val) => {
+const styleValueSchema = z.enum(['v0', 'v1', 'spectrogram'])
+const styleInputSchema = zodStableJsonDefault(
+  z.union([styleValueSchema, z.literal(0), z.literal(1), z.literal('0'), z.literal('1')]),
+  'v0',
+)
+const styleSchema = zodWithJsonInputSchema(
+  z.preprocess((val) => {
     // Backwards compatibility: historically this robot used numeric styles 0/1.
     // The new API is `style: "v0" | "v1" | "spectrogram"`.
     if (val === 'v1' || val === 1 || val === '1') return 'v1'
     if (val === 'v0' || val === 0 || val === '0') return 'v0'
     if (val === 'spectrogram') return 'spectrogram'
     return val
-  },
-  z.enum(['v0', 'v1', 'spectrogram']).default('v0'),
+  }, styleValueSchema.default('v0')),
+  styleInputSchema,
 )
 
 // Color maps for spectrogram visualization
@@ -331,36 +321,23 @@ Available when style is \`"spectrogram"\`. Orientation of the spectrogram. \`"ho
   })
   .strict()
 
-export const robotAudioWaveformInstructionsWithHiddenFieldsSchema =
-  robotAudioWaveformInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotAudioWaveformInstructionsSchema.shape.result])
-      .optional(),
-  })
+export const robotDefinition: RobotDefinition<typeof robotAudioWaveformInstructionsSchema.shape> =
+  defineRobot(meta, robotAudioWaveformInstructionsSchema)
 
-export type RobotAudioWaveformInstructions = z.infer<typeof robotAudioWaveformInstructionsSchema>
-export type RobotAudioWaveformInstructionsWithHiddenFields = z.infer<
-  typeof robotAudioWaveformInstructionsWithHiddenFieldsSchema
->
+export const {
+  withHiddenFields: robotAudioWaveformInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotAudioWaveformInstructionsSchema,
+  interpolatableWithHiddenFields:
+    interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export const interpolatableRobotAudioWaveformInstructionsSchema = interpolateRobot(
-  robotAudioWaveformInstructionsSchema,
-)
-
-export type InterpolatableRobotAudioWaveformInstructions = z.input<
-  typeof interpolatableRobotAudioWaveformInstructionsSchema
->
-export type InterpolatableRobotAudioWaveformInstructionsInput = z.input<
-  typeof interpolatableRobotAudioWaveformInstructionsSchema
->
-
-export const interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotAudioWaveformInstructionsWithHiddenFieldsSchema,
-)
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotAudioWaveformInstructionsWithHiddenFieldsSchema
->
+export type RobotAudioWaveformInstructions = Instructions['output']
+export type RobotAudioWaveformInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotAudioWaveformInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotAudioWaveformInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotAudioWaveformInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,55 +1,36 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
   azureBase,
+  createStorageImportExample,
+  defineRobot,
   files_per_page,
-  interpolateRobot,
   next_page_token,
   path,
   recursive,
   robotBase,
   robotImport,
+  robotImportMeta,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 10,
-  discount_factor: 0.1,
-  discount_pct: 90,
-  example_code: {
-    steps: {
-      imported: {
-        robot: '/azure/import',
-        credentials: 'YOUR_AZURE_CREDENTIALS',
-        path: 'path/to/files/',
-      },
-    },
-  },
+  ...robotImportMeta,
+  example_code: createStorageImportExample('/azure/import', 'YOUR_AZURE_CREDENTIALS', false),
   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
@@ -78,34 +59,22 @@ 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 robotDefinition: RobotDefinition<typeof robotAzureImportInstructionsSchema.shape> =
+  defineRobot(meta, robotAzureImportInstructionsSchema)
 
-export const interpolatableRobotAzureImportInstructionsSchema = interpolateRobot(
-  robotAzureImportInstructionsSchema,
-)
-export type InterpolatableRobotAzureImportInstructions =
-  InterpolatableRobotAzureImportInstructionsInput
+export const {
+  withHiddenFields: robotAzureImportInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotAzureImportInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotAzureImportInstructionsInput = z.input<
-  typeof interpolatableRobotAzureImportInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotAzureImportInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotAzureImportInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotAzureImportInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotAzureImportInstructionsWithHiddenFieldsSchema
->
+export type RobotAzureImportInstructions = Instructions['output']
+export type RobotAzureImportInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotAzureImportInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotAzureImportInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotAzureImportInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotAzureImportInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,62 +1,49 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinitionWithHiddenFields,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
-import { azureBase, interpolateRobot, robotBase, robotUse } from './_instructions-primitives.ts'
+import {
+  zodCodePointLength,
+  zodInputPreservingTransform,
+  zodWithJsonInputSchema,
+} from '../../lib/zodInputSemantics.ts'
+import {
+  azureBase,
+  createStorageStoreExample,
+  defineRobotWithHiddenFields,
+  robotBase,
+  robotStoreMeta,
+  robotUse,
+  storePath,
+} from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 6,
-  discount_factor: 0.15000150001500018,
-  discount_pct: 84.99984999849998,
-  example_code: {
-    steps: {
-      exported: {
-        robot: '/azure/store',
-        use: ':original',
-        credentials: 'YOUR_AZURE_CREDENTIALS',
-        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
-      },
-    },
-  },
+  ...robotStoreMeta,
+  example_code: createStorageStoreExample('/azure/store', 'YOUR_AZURE_CREDENTIALS'),
   example_code_description: 'Export uploaded files to `my_target_folder` on Azure:',
   has_small_icon: true,
-  minimum_charge: 0,
-  output_factor: 1,
-  override_lvl1: 'File Exporting',
   purpose_sentence: 'exports encoding results to Microsoft Azure',
-  purpose_verb: 'export',
   purpose_word: 'Azure',
   purpose_words: 'Export files to Microsoft Azure',
-  service_slug: 'file-exporting',
-  slot_count: 10,
   title: 'Export files to Microsoft Azure',
-  typical_file_size_mb: 1.2,
-  typical_file_type: 'file',
   name: 'AzureStoreRobot',
-  priceFactor: 6.6666,
-  queueSlotCount: 10,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: false,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
-const azureStoreMetadataValueSchema = z
-  .union([z.string(), z.number(), z.boolean()])
-  .transform(String)
+const azureStoreMetadataValueSchema = zodWithJsonInputSchema(
+  zodInputPreservingTransform(z.union([z.string(), z.number(), z.boolean()]), String),
+  z.union([z.string(), z.number().finite(), z.boolean()]),
+)
 
 export const robotAzureStoreInstructionsSchema = robotBase
   .merge(robotUse)
   .merge(azureBase)
   .extend({
     robot: z.literal('/azure/store'),
-    path: z
-      .string()
-      .default('${unique_prefix}/${file.url_name}')
-      .describe(`
-The path at which the file is to be stored. This may include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).
-`),
+    path: storePath,
     content_type: z
       .string()
       .optional()
@@ -101,11 +88,7 @@ A JavaScript object containing a list of metadata to be set for this file on Azu
       .describe(`
 Set this to a number to enable shared access signatures for your stored object. This reflects the number of seconds that the signature will be valid for once the object is stored. Enabling this will attach the shared access signature (SAS) to the result URL of your object.
 `),
-    sas_permissions: z
-      .string()
-      .regex(/^[rdw]+$/)
-      .min(0)
-      .max(3)
+    sas_permissions: zodCodePointLength(z.string().regex(/^[rdw]+$/u), { max: 3 })
       .optional()
       .describe(`
 Set this to a combination of \`r\` (read), \`w\` (write) and \`d\` (delete) for your shared access signatures (SAS) permissions.
@@ -113,35 +96,28 @@ Set this to a combination of \`r\` (read), \`w\` (write) and \`d\` (delete) for
   })
   .strict()
 
-export const robotAzureStoreInstructionsWithHiddenFieldsSchema =
-  robotAzureStoreInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotAzureStoreInstructionsSchema.shape.result])
-      .optional(),
-    upload_stack: z.enum(['v1', 'v2']).optional(),
-  })
+const hiddenFields = {
+  upload_stack: z.enum(['v1', 'v2']).optional(),
+}
 
-export type RobotAzureStoreInstructions = z.infer<typeof robotAzureStoreInstructionsSchema>
-export type RobotAzureStoreInstructionsWithHiddenFields = z.infer<
-  typeof robotAzureStoreInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinitionWithHiddenFields<
+  typeof robotAzureStoreInstructionsSchema.shape,
+  typeof hiddenFields
+> = defineRobotWithHiddenFields(meta, robotAzureStoreInstructionsSchema, hiddenFields)
 
-export const interpolatableRobotAzureStoreInstructionsSchema = interpolateRobot(
-  robotAzureStoreInstructionsSchema,
-)
-export type InterpolatableRobotAzureStoreInstructions =
-  InterpolatableRobotAzureStoreInstructionsInput
+export const {
+  withHiddenFields: robotAzureStoreInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotAzureStoreInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotAzureStoreInstructionsInput = z.input<
-  typeof interpolatableRobotAzureStoreInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotAzureStoreInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotAzureStoreInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotAzureStoreInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema
->
+export type RobotAzureStoreInstructions = Instructions['output']
+export type RobotAzureStoreInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotAzureStoreInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotAzureStoreInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotAzureStoreInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotAzureStoreInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']