transloadit 4.13.1 → 5.0.0

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

@@ -1,48 +1,32 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
   autoProviderDescription,
-  interpolateRobot,
+  createProcessingExample,
+  defineRobot,
   robotBase,
+  robotImageProcessingMeta,
   robotUse,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  discount_factor: 1,
-  bytescount: 1,
-  discount_pct: 0,
-  example_code: {
-    steps: {
-      remove_background: {
-        robot: '/image/bgremove',
-        use: ':original',
-      },
-    },
-  },
+  ...robotImageProcessingMeta,
+  example_code: createProcessingExample('remove_background', '/image/bgremove'),
   example_code_description: 'Remove the background from the uploaded image:',
-  minimum_charge: 0,
-  output_factor: 0.6,
-  override_lvl1: 'Image Manipulation',
   purpose_sentence: 'removes the background from images',
   purpose_verb: 'remove',
   purpose_word: 'remove',
   purpose_words: 'Remove the background from images',
-  service_slug: 'image-manipulation',
-  slot_count: 10,
   title: 'Remove the background from images',
-  typical_file_size_mb: 0.8,
-  typical_file_type: 'image',
   name: 'ImageBgremoveRobot',
-  priceFactor: 1,
-  queueSlotCount: 10,
   minimumChargeUsd: 0.006,
-  isAllowedForUrlTransform: true,
   trackOutputFileSize: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 export const robotImageBgremoveInstructionsSchema = robotBase
@@ -61,7 +45,7 @@ export const robotImageBgremoveInstructionsSchema = robotBase
       .enum(['auto', 'transloadit', 'replicate', 'fal'])
       .default('auto')
       .describe(
-        `${autoProviderDescription} Set this to \`"transloadit"\`, \`"replicate"\`, or \`"fal"\` to force a specific provider.`,
+        `${autoProviderDescription}\n\nSelect a specific provider to override automatic selection.`,
       ),
     model: z
       .string()
@@ -72,34 +56,23 @@ export const robotImageBgremoveInstructionsSchema = robotBase
   })
   .strict()
 
-export const robotImageBgremoveInstructionsWithHiddenFieldsSchema =
-  robotImageBgremoveInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotImageBgremoveInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotImageBgremoveInstructions = z.infer<typeof robotImageBgremoveInstructionsSchema>
-export type RobotImageBgremoveInstructionsWithHiddenFields = z.infer<
-  typeof robotImageBgremoveInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotImageBgremoveInstructionsSchema.shape> =
+  defineRobot(meta, robotImageBgremoveInstructionsSchema)
 
-export const interpolatableRobotImageBgremoveInstructionsSchema = interpolateRobot(
-  robotImageBgremoveInstructionsSchema,
-)
-export type InterpolatableRobotImageBgremoveInstructions =
-  InterpolatableRobotImageBgremoveInstructionsInput
+export const {
+  withHiddenFields: robotImageBgremoveInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotImageBgremoveInstructionsSchema,
+  interpolatableWithHiddenFields:
+    interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotImageBgremoveInstructionsInput = z.input<
-  typeof interpolatableRobotImageBgremoveInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotImageBgremoveInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema
->
+export type RobotImageBgremoveInstructions = Instructions['output']
+export type RobotImageBgremoveInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotImageBgremoveInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotImageBgremoveInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,24 +1,26 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
-import { interpolateRobot, robotBase, robotUse } from './_instructions-primitives.ts'
+import {
+  createProcessingExample,
+  defineRobot,
+  robotArtificialIntelligenceMeta,
+  robotBase,
+  robotUse,
+} from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 1,
-  discount_factor: 1,
-  discount_pct: 0,
-  example_code: {
-    steps: {
-      copyright_checked: {
-        robot: '/image/copyrightdetect',
-        use: ':original',
-        confidence_threshold: 80,
-        error_on_decline: true,
-        error_msg: 'This image appears to be a known stock photo. Please upload original content.',
-      },
-    },
-  },
+  ...robotArtificialIntelligenceMeta,
+  example_code: createProcessingExample('copyright_checked', '/image/copyrightdetect', {
+    confidence_threshold: 80,
+    error_on_decline: true,
+    error_msg: 'This image appears to be a known stock photo. Please upload original content.',
+  }),
   example_code_description:
     'Detect known stock photos and copyrighted works in uploaded images and reject flagged files:',
   extended_description: `
@@ -55,27 +57,16 @@ export const meta: RobotMetaInput = {
 >
 > In this setup, files with at least one match at or above your threshold are declined, and only the remaining files continue to later Steps.
 `,
-  minimum_charge: 1572864,
-  output_factor: 0.05,
   override_lvl1: 'Artificial Intelligence',
   purpose_sentence:
     'detects known stock photos, brand logos, and watermarked images in uploaded files using reverse image search',
   purpose_verb: 'detect',
   purpose_word: 'detect stock photos and copyrighted works',
   purpose_words: 'Detect known stock photos and copyrighted works in images',
-  service_slug: 'artificial-intelligence',
-  slot_count: 10,
   title: 'Detect known stock photos and copyrighted works in images',
   typical_file_size_mb: 0.8,
-  typical_file_type: 'image',
   name: 'ImageCopyrightdetectRobot',
-  priceFactor: 1,
-  queueSlotCount: 10,
   minimumChargeUsd: 0.0013,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
   stage: 'alpha',
 }
 
@@ -134,35 +125,26 @@ In what format to return the detection results.
   })
   .strict()
 
-export const robotImageCopyrightdetectInstructionsWithHiddenFieldsSchema =
-  robotImageCopyrightdetectInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotImageCopyrightdetectInstructionsSchema.shape.result])
-      .optional(),
-  })
+export const robotDefinition: RobotDefinition<
+  typeof robotImageCopyrightdetectInstructionsSchema.shape
+> = defineRobot(meta, robotImageCopyrightdetectInstructionsSchema)
 
-export type RobotImageCopyrightdetectInstructions = z.infer<
-  typeof robotImageCopyrightdetectInstructionsSchema
->
-export type RobotImageCopyrightdetectInstructionsWithHiddenFields = z.infer<
-  typeof robotImageCopyrightdetectInstructionsWithHiddenFieldsSchema
->
+export const {
+  withHiddenFields: robotImageCopyrightdetectInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotImageCopyrightdetectInstructionsSchema,
+  interpolatableWithHiddenFields:
+    interpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export const interpolatableRobotImageCopyrightdetectInstructionsSchema = interpolateRobot(
-  robotImageCopyrightdetectInstructionsSchema,
-)
-export type InterpolatableRobotImageCopyrightdetectInstructions =
-  InterpolatableRobotImageCopyrightdetectInstructionsInput
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export type InterpolatableRobotImageCopyrightdetectInstructionsInput = z.input<
-  typeof interpolatableRobotImageCopyrightdetectInstructionsSchema
->
-
-export const interpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsSchema =
-  interpolateRobot(robotImageCopyrightdetectInstructionsWithHiddenFieldsSchema)
-export type InterpolatableRobotImageCopyrightdetectInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsSchema
->
+export type RobotImageCopyrightdetectInstructions = Instructions['output']
+export type RobotImageCopyrightdetectInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotImageCopyrightdetectInstructions =
+  Instructions['interpolatableInput']
+export type InterpolatableRobotImageCopyrightdetectInstructionsInput =
+  Instructions['interpolatableInput']
+export type InterpolatableRobotImageCopyrightdetectInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotImageCopyrightdetectInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,56 +1,42 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
-  autoProviderDescription,
   awsGcpAiProviderSchema,
+  createProcessingExample,
+  defineRobot,
   granularitySchema,
-  interpolateRobot,
+  robotArtificialIntelligenceMeta,
   robotBase,
+  robotParameterDocs,
   robotUse,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 1,
-  discount_factor: 1,
-  discount_pct: 0,
-  example_code: {
-    steps: {
-      described: {
-        robot: '/image/describe',
-        use: ':original',
-        provider: 'aws',
-      },
-    },
-  },
+  ...robotArtificialIntelligenceMeta,
+  example_code: createProcessingExample('described', '/image/describe', {
+    provider: 'aws',
+  }),
   example_code_description:
     'Recognize objects in an uploaded image and store the labels in a JSON file:',
   extended_description: `
 > [!Warning]
 > Transloadit aims to be deterministic, but this <dfn>Robot</dfn> uses third-party AI services. The providers (AWS, GCP) will evolve their models over time, giving different responses for the same input images. Avoid relying on exact responses in your tests and application.
 `,
-  minimum_charge: 1572864,
-  output_factor: 0.05,
   override_lvl1: 'Artificial Intelligence',
   purpose_sentence: 'recognizes objects in images and returns them as English words',
   purpose_verb: 'recognize',
   purpose_word: 'recognize objects',
   purpose_words: 'Recognize objects in images',
-  service_slug: 'artificial-intelligence',
-  slot_count: 10,
   title: 'Recognize objects in images',
   typical_file_size_mb: 0.8,
-  typical_file_type: 'image',
   name: 'ImageDescribeRobot',
-  priceFactor: 1,
-  queueSlotCount: 10,
   minimumChargeUsd: 0.0013,
-  isAllowedForUrlTransform: true,
-  trackOutputFileSize: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'ga',
 }
 
 export const robotImageDescribeInstructionsSchema = robotBase
@@ -59,11 +45,7 @@ export const robotImageDescribeInstructionsSchema = robotBase
     robot: z.literal('/image/describe').describe(`
 You can use the labels that we return in your application to automatically classify images. You can also pass the labels down to other <dfn>Robots</dfn> to filter images that contain (or do not contain) certain content.
 `),
-    provider: awsGcpAiProviderSchema.describe(`
-${autoProviderDescription}
-
-Set this to \`"aws"\` or \`"gcp"\` to force a specific provider.
-`),
+    provider: awsGcpAiProviderSchema.describe(robotParameterDocs.ai_provider.description),
     granularity: granularitySchema.describe(`
 Whether to return a full response (\`"full"\`) including confidence percentages for each found label, or just a flat list of labels (\`"list"\`).
 `),
@@ -89,34 +71,23 @@ For an example of how to automatically reject NSFW content and malware, please c
   })
   .strict()
 
-export const robotImageDescribeInstructionsWithHiddenFieldsSchema =
-  robotImageDescribeInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotImageDescribeInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotImageDescribeInstructions = z.infer<typeof robotImageDescribeInstructionsSchema>
-export type RobotImageDescribeInstructionsWithHiddenFields = z.infer<
-  typeof robotImageDescribeInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotImageDescribeInstructionsSchema.shape> =
+  defineRobot(meta, robotImageDescribeInstructionsSchema)
 
-export const interpolatableRobotImageDescribeInstructionsSchema = interpolateRobot(
-  robotImageDescribeInstructionsSchema,
-)
-export type InterpolatableRobotImageDescribeInstructions =
-  InterpolatableRobotImageDescribeInstructionsInput
+export const {
+  withHiddenFields: robotImageDescribeInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotImageDescribeInstructionsSchema,
+  interpolatableWithHiddenFields:
+    interpolatableRobotImageDescribeInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
 
-export type InterpolatableRobotImageDescribeInstructionsInput = z.input<
-  typeof interpolatableRobotImageDescribeInstructionsSchema
->
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
 
-export const interpolatableRobotImageDescribeInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotImageDescribeInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotImageDescribeInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotImageDescribeInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotImageDescribeInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotImageDescribeInstructionsWithHiddenFieldsSchema
->
+export type RobotImageDescribeInstructions = Instructions['output']
+export type RobotImageDescribeInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotImageDescribeInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotImageDescribeInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotImageDescribeInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotImageDescribeInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']

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

@@ -1,19 +1,22 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts'
+import type {
+  RobotDefinition,
+  RobotMetaInput,
+  RobotSchemaVariantTypes,
+} from './_instructions-primitives.ts'
 
 import { z } from 'zod'
 
 import {
+  defineRobot,
   imageQualitySchema,
-  interpolateRobot,
   robotBase,
   robotImagemagick,
+  robotImageProcessingMeta,
   robotUse,
 } from './_instructions-primitives.ts'
 
 export const meta: RobotMetaInput = {
-  bytescount: 1,
-  discount_factor: 1,
-  discount_pct: 0,
+  ...robotImageProcessingMeta,
   example_code: {
     steps: {
       enhanced_classic: {
@@ -31,27 +34,17 @@ export const meta: RobotMetaInput = {
     },
   },
   example_code_description: 'Enhance uploaded images with classic auto mode or AI restoration:',
-  minimum_charge: 0,
-  output_factor: 0.6,
-  override_lvl1: 'Image Manipulation',
   purpose_sentence:
     'automatically enhances images by adjusting levels, contrast, and sharpness, and optionally applies photo filter presets',
   purpose_verb: 'enhance',
   purpose_word: 'enhance',
   purpose_words: 'Enhance images',
-  service_slug: 'image-manipulation',
-  slot_count: 15,
   title: 'Enhance images',
   typical_file_size_mb: 1.2,
-  typical_file_type: 'image',
   name: 'ImageEnhanceRobot',
-  priceFactor: 1,
   queueSlotCount: 15,
-  isAllowedForUrlTransform: true,
   trackOutputFileSize: true,
-  isInternal: false,
-  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-  stage: 'beta',
+  stage: 'ga',
 }
 
 const enhanceModeSchema = z.enum(['auto', 'auto_gentle', 'auto_aggressive', 'none']).default('auto')
@@ -88,14 +81,7 @@ With this <dfn>Robot</dfn> you can automatically enhance images with one click
 
 It works well together with [🤖/image/resize](/docs/robots/image-resize/) — you can enhance first, then resize, or vice versa.
 
-> [!Note]
-> This <dfn>Robot</dfn> accepts all image types supported by ImageMagick and will pass through unsupported types unchanged.
-
-> [!Note]
-> \`engine: "classic"\` uses \`enhance\`, \`preset\`, \`sharpen\`, and \`denoise\`. \`engine: "ai"\` uses \`ai_preset\` and \`quality\`; classic controls are ignored in AI mode.
-
-> [!Note]
-> Output keeps the original file extension when possible. In AI mode, if the target extension is not writable by the selected \`imagemagick_stack\`, the file is passed through unchanged.
+This <dfn>Robot</dfn> accepts all image types supported by ImageMagick and passes unsupported types through unchanged. \`engine: "classic"\` uses \`enhance\`, \`preset\`, \`sharpen\`, and \`denoise\`, while \`engine: "ai"\` uses \`ai_preset\` and \`quality\`; classic controls are ignored in AI mode. Output keeps the original file extension when possible. In AI mode, if the target extension is not writable by the selected \`imagemagick_stack\`, the file is passed through unchanged.
 `),
     enhance: enhanceModeSchema.describe(`
 The auto-enhancement mode. \`"auto"\` applies balanced auto-levels, gamma correction, and subtle sharpening. \`"auto_gentle"\` is more conservative (good for already-decent photos). \`"auto_aggressive"\` applies stronger normalization and contrast. \`"none"\` skips auto-enhance (useful when only applying a preset filter).
@@ -148,39 +134,27 @@ Additional sharpening amount (\`0\` = none, \`10\` = maximum). The \`"auto"\` en
 Noise reduction strength (\`0\` = none, \`10\` = maximum). Useful for high-ISO photos.
 `),
     quality: imageQualitySchema.describe(`
-Quality of the output image. A value between \`1\` and \`100\`. Defaults to \`92\`.
+Quality of the output image. A value between \`1\` and \`100\`. Defaults to \`${imageQualitySchema.parse(undefined)}\`.
 `),
   })
   .strict()
 
-export const robotImageEnhanceInstructionsWithHiddenFieldsSchema =
-  robotImageEnhanceInstructionsSchema.extend({
-    result: z
-      .union([z.literal('debug'), robotImageEnhanceInstructionsSchema.shape.result])
-      .optional(),
-  })
-
-export type RobotImageEnhanceInstructions = z.infer<typeof robotImageEnhanceInstructionsSchema>
-export type RobotImageEnhanceInstructionsWithHiddenFields = z.infer<
-  typeof robotImageEnhanceInstructionsWithHiddenFieldsSchema
->
-
-export const interpolatableRobotImageEnhanceInstructionsSchema = interpolateRobot(
-  robotImageEnhanceInstructionsSchema,
-)
-export type InterpolatableRobotImageEnhanceInstructions =
-  InterpolatableRobotImageEnhanceInstructionsInput
-
-export type InterpolatableRobotImageEnhanceInstructionsInput = z.input<
-  typeof interpolatableRobotImageEnhanceInstructionsSchema
->
-
-export const interpolatableRobotImageEnhanceInstructionsWithHiddenFieldsSchema = interpolateRobot(
-  robotImageEnhanceInstructionsWithHiddenFieldsSchema,
-)
-export type InterpolatableRobotImageEnhanceInstructionsWithHiddenFields = z.infer<
-  typeof interpolatableRobotImageEnhanceInstructionsWithHiddenFieldsSchema
->
-export type InterpolatableRobotImageEnhanceInstructionsWithHiddenFieldsInput = z.input<
-  typeof interpolatableRobotImageEnhanceInstructionsWithHiddenFieldsSchema
->
+export const robotDefinition: RobotDefinition<typeof robotImageEnhanceInstructionsSchema.shape> =
+  defineRobot(meta, robotImageEnhanceInstructionsSchema)
+
+export const {
+  withHiddenFields: robotImageEnhanceInstructionsWithHiddenFieldsSchema,
+  interpolatable: interpolatableRobotImageEnhanceInstructionsSchema,
+  interpolatableWithHiddenFields: interpolatableRobotImageEnhanceInstructionsWithHiddenFieldsSchema,
+} = robotDefinition
+
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>
+
+export type RobotImageEnhanceInstructions = Instructions['output']
+export type RobotImageEnhanceInstructionsWithHiddenFields = Instructions['hiddenOutput']
+export type InterpolatableRobotImageEnhanceInstructions = Instructions['interpolatableInput']
+export type InterpolatableRobotImageEnhanceInstructionsInput = Instructions['interpolatableInput']
+export type InterpolatableRobotImageEnhanceInstructionsWithHiddenFields =
+  Instructions['interpolatableHiddenOutput']
+export type InterpolatableRobotImageEnhanceInstructionsWithHiddenFieldsInput =
+  Instructions['interpolatableHiddenInput']