Sync alphalib

Author: kvz

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

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-import { ffmpegStackVersionSchema, useParamSchema } from './_instructions-primitives.ts'
+import { robotFFmpegAudio, robotBase, robotUse } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
 export const meta: RobotMeta = {
@@ -33,27 +33,23 @@ export const meta: RobotMeta = {
   typical_file_type: 'audio file',
 }
 
-export const robotAudioArtworkInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAudioArtworkInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpegAudio)
+  .extend({
     robot: z.literal('/audio/artwork').describe(`
 For extraction, this <dfn>Robot</dfn> uses the image format embedded within the audio file — most often, this is JPEG.
 
 If you need the image in a different format, pipe the result of this <dfn>Robot</dfn> into [🤖/image/resize](/docs/transcoding/image-manipulation/image-resize/).
 
 The \`method\` parameter determines whether to extract or insert.
 `),
-    use: useParamSchema.optional(),
     method: z.enum(['extract', 'insert']).default('extract').describe(`
 What should be done with the audio file. A value of \`"extract"\` means audio artwork will be extracted. A value of \`"insert"\` means the provided image will be inserted as audio artwork.
 `),
     change_format_if_necessary: z.boolean().default(false).describe(`
 Whether the original file should be transcoded into a new format if there is an issue with the original file.
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
   })
   .strict()
 export type RobotAudioArtworkInstructions = z.infer<typeof robotAudioArtworkInstructionsSchema>

src/alphalib/types/robots/audio-artwork.ts

@@ -2,12 +2,11 @@ import { z } from 'zod'
 
 import {
   bitrateSchema,
-  ffmpegParamSchema,
-  ffmpegStackVersionSchema,
-  outputMetaParamSchema,
+  robotFFmpeg,
   preset,
+  robotBase,
+  robotUse,
   sampleRateSchema,
-  useParamSchema,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -47,17 +46,17 @@ export const meta: RobotMeta = {
   typical_file_type: 'audio file',
 }
 
-export const robotAudioConcatInstructionsSchema = z
-  .object({
+export const robotAudioConcatInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
     result: z
       .boolean()
       .optional()
       .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
     robot: z.literal('/audio/concat').describe(`
 This Robot can concatenate an almost infinite number of audio files.
 `),
-    use: useParamSchema.optional(),
-    output_meta: outputMetaParamSchema,
     preset: preset.optional().describe(`
 Performs conversion using pre-configured settings.
 
@@ -76,8 +75,6 @@ When used this adds an audio fade in and out effect between each section of your
 
 This parameter does not add an audio fade effect at the beginning or end of your result audio file. If you want to do so, create an additional [🤖/audio/encode](/docs/transcoding/audio-encoding/audio-encode/) <dfn>Step</dfn> and use our \`ffmpeg\` parameter as shown in this [demo](/demos/audio-encoding/ffmpeg-fade-in-and-out/).
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
-    ffmpeg: ffmpegParamSchema.optional(),
   })
   .strict()
 export type RobotAudioConcatInstructions = z.infer<typeof robotAudioConcatInstructionsSchema>

src/alphalib/types/robots/audio-concat.ts

@@ -2,12 +2,11 @@ import { z } from 'zod'
 
 import {
   bitrateSchema,
-  ffmpegParamSchema,
-  ffmpegStackVersionSchema,
-  outputMetaParamSchema,
+  robotFFmpeg,
   preset,
+  robotBase,
+  robotUse,
   sampleRateSchema,
-  useParamSchema,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -43,15 +42,15 @@ export const meta: RobotMeta = {
   typical_file_type: 'audio file',
 }
 
-export const robotAudioEncodeInstructionsSchema = z
-  .object({
+export const robotAudioEncodeInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
     result: z
       .boolean()
       .optional()
       .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
     robot: z.literal('/audio/encode'),
-    use: useParamSchema.optional(),
-    output_meta: outputMetaParamSchema,
     preset: preset.default('mp3').describe(`
 Performs conversion using pre-configured settings.
 
@@ -65,8 +64,6 @@ Bit rate of the resulting audio file, in bits per second. If not specified will
     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.
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
-    ffmpeg: ffmpegParamSchema.optional(),
   })
   .strict()
 export type RobotAudioEncodeInstructions = z.infer<typeof robotAudioEncodeInstructionsSchema>

src/alphalib/types/robots/audio-encode.ts

@@ -2,12 +2,11 @@ import { z } from 'zod'
 
 import {
   bitrateSchema,
-  ffmpegParamSchema,
-  ffmpegStackVersionSchema,
-  outputMetaParamSchema,
+  robotFFmpeg,
   preset,
+  robotBase,
+  robotUse,
   sampleRateSchema,
-  useParamSchema,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -43,15 +42,11 @@ export const meta: RobotMeta = {
   typical_file_type: 'audio file',
 }
 
-export const robotAudioLoopInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAudioLoopInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
     robot: z.literal('/audio/loop'),
-    use: useParamSchema.optional(),
-    output_meta: outputMetaParamSchema,
     preset: preset.optional().describe(`
 Performs conversion using pre-configured settings.
 
@@ -68,8 +63,6 @@ Sample rate of the resulting audio file, in Hertz. If not specified will default
     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.
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
-    ffmpeg: ffmpegParamSchema.optional(),
   })
   .strict()
 export type RobotAudioLoopInstructions = z.infer<typeof robotAudioLoopInstructionsSchema>

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

@@ -2,12 +2,11 @@ import { z } from 'zod'
 
 import {
   bitrateSchema,
-  ffmpegParamSchema,
-  ffmpegStackVersionSchema,
-  outputMetaParamSchema,
+  robotFFmpeg,
   preset,
+  robotBase,
+  robotUse,
   sampleRateSchema,
-  useParamSchema,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -48,15 +47,11 @@ export const meta: RobotMeta = {
   typical_file_type: 'audio file',
 }
 
-export const robotAudioMergeInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAudioMergeInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
     robot: z.literal('/audio/merge'),
-    use: useParamSchema.optional(),
-    output_meta: outputMetaParamSchema,
     preset: preset.describe(`
 Performs conversion using pre-configured settings.
 
@@ -78,8 +73,6 @@ Specifies if any input files that do not match the target duration should be loo
     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.
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
-    ffmpeg: ffmpegParamSchema.optional(),
   })
   .strict()
 export type RobotAudioMergeInstructions = z.infer<typeof robotAudioMergeInstructionsSchema>

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

@@ -1,12 +1,6 @@
 import { z } from 'zod'
 
-import {
-  color_with_alpha,
-  ffmpegParamSchema,
-  ffmpegStackVersionSchema,
-  outputMetaParamSchema,
-  useParamSchema,
-} from './_instructions-primitives.ts'
+import { color_with_alpha, robotFFmpeg, robotBase, robotUse } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
 export const meta: RobotMeta = {
@@ -51,19 +45,15 @@ Here is an example waveform image:
   typical_file_type: 'audio file',
 }
 
-export const robotAudioWaveformInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAudioWaveformInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotFFmpeg)
+  .extend({
     robot: z.literal('/audio/waveform').describe(`
 We recommend that you use an [🤖/audio/encode](/docs/transcoding/audio-encoding/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/transcoding/audio-encoding/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/transcoding/image-manipulation/image-resize/).
 `),
-    use: useParamSchema.optional(),
-    output_meta: outputMetaParamSchema,
     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.
 `),
@@ -88,8 +78,6 @@ The color used in the center of the gradient. The format is "rrggbbaa" (red, gre
     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).
 `),
-    ffmpeg_stack: ffmpegStackVersionSchema.optional(),
-    ffmpeg: ffmpegParamSchema.optional(),
   })
   .strict()
 export type RobotAudioWaveformInstructions = z.infer<typeof robotAudioWaveformInstructionsSchema>

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

@@ -1,11 +1,12 @@
 import { z } from 'zod'
 
 import {
-  credentials,
+  azureBase,
   files_per_page,
-  ignore_errors,
+  robotImport,
   next_page_token,
   path,
+  robotBase,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -41,19 +42,11 @@ export const meta: RobotMeta = {
   typical_file_type: 'file',
 }
 
-export const robotAzureImportInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAzureImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(azureBase)
+  .extend({
     robot: z.literal('/azure/import'),
-    ignore_errors,
-    credentials: credentials.describe(`
-Please create your associated <dfn>Template Credentials</dfn> in your Transloadit account and use the name of your [Template Credentials](/c/template-credentials/) as this parameter's value. They will contain the values for your Azure Container, Account and Key.
-
-While we recommend to use <dfn>Template Credentials</dfn> at all times, some use cases demand dynamic credentials for which using <dfn>Template Credentials</dfn> is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: \`"account"\`, \`"key"\`, \`"container"\`.
-`),
     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\`.
 

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

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-import { useParamSchema } from './_instructions-primitives.ts'
+import { azureBase, robotBase, robotUse } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
 export const meta: RobotMeta = {
@@ -34,19 +34,11 @@ export const meta: RobotMeta = {
   typical_file_type: 'file',
 }
 
-export const robotAzureStoreInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotAzureStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(azureBase)
+  .extend({
     robot: z.literal('/azure/store'),
-    use: useParamSchema.optional(),
-    credentials: z.string().describe(`
-Please create your associated <dfn>Template Credentials</dfn> in your Transloadit account and use the name of your [Template Credentials](/c/template-credentials/) as this parameter's value. They will contain the values for your Azure Container, Account and Key.
-
-While we recommend to use <dfn>Template Credentials</dfn> at all times, some use cases demand dynamic credentials for which using <dfn>Template Credentials</dfn> is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: \`"account"\`, \`"key"\`, \`"container"\`.
-`),
     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).
 `),

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

@@ -1,11 +1,12 @@
 import { z } from 'zod'
 
 import {
-  credentials,
+  backblazeBase,
   files_per_page,
-  ignore_errors,
+  robotImport,
   path,
   recursive,
+  robotBase,
 } from './_instructions-primitives.ts'
 import type { RobotMeta } from './_instructions-primitives.ts'
 
@@ -42,25 +43,11 @@ export const meta: RobotMeta = {
   typical_file_type: 'file',
 }
 
-export const robotBackblazeImportInstructionsSchema = z
-  .object({
-    result: z
-      .boolean()
-      .optional()
-      .describe(`Whether the results of this Step should be present in the Assembly Status JSON`),
+export const robotBackblazeImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(backblazeBase)
+  .extend({
     robot: z.literal('/backblaze/import'),
-    ignore_errors,
-    credentials: credentials.describe(`
-Please create your associated <dfn>Template Credentials</dfn> in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value. They will contain the values for your Backblaze Bucket Name, App Key ID, and App Key.
-
-To create your credential information, head over to Backblaze, sign in to your account, and select "Create a Bucket". Save the name of your bucket, and click on the "App Keys" tab, scroll to the bottom of the page then select “Add a New Application Key”. Allow access to your recently created bucket, select  “Read and Write” as your type of access, and tick the “Allow List All Bucket Names” option.
-
-Now that everything is in place, create your key, and take note of the information you are given so you can input the information into your <dfn>Template Credentials</dfn>.
-
-⚠️ Your App Key will only be viewable once, so make sure you note this down.
-
-While we recommend to use <dfn>Template Credentials</dfn> at all times, some use cases demand dynamic credentials for which using <dfn>Template Credentials</dfn> is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: \`"bucket"\`, \`"app_key_id"\`, \`"app_key"\`.
-`),
     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\`.