@transloadit/node 4.1.3

package/src/alphalib/types/robots/document-thumbs.ts

@@ -0,0 +1,231 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  colorspaceSchema,
+  interpolateRobot,
+  robotBase,
+  robotImagemagick,
+  robotUse,
+} from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: true,
+  bytescount: 1,
+  discount_factor: 1,
+  discount_pct: 0,
+  example_code: {
+    steps: {
+      thumbnailed: {
+        use: ':original',
+        robot: '/document/thumbs',
+        width: 200,
+        resize_strategy: 'fit',
+        trim_whitespace: false,
+      },
+    },
+  },
+  example_code_description: 'Convert all pages of a PDF document into separate 200px-wide images:',
+  minimum_charge: 524288,
+  output_factor: 1,
+  override_lvl1: 'Document Processing',
+  purpose_sentence:
+    'generates an image for each page in a PDF file or an animated GIF file that loops through all pages',
+  purpose_verb: 'extract',
+  purpose_word: 'thumbnail',
+  purpose_words: 'Extract thumbnail images from documents',
+  service_slug: 'document-processing',
+  slot_count: 10,
+  title: 'Extract thumbnail images from documents',
+  typical_file_size_mb: 0.8,
+  typical_file_type: 'document',
+  uses_tools: ['imagemagick'],
+  name: 'DocumentThumbsRobot',
+  priceFactor: 1,
+  queueSlotCount: 60,
+  minimumCharge: 524288,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotDocumentThumbsInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(robotImagemagick)
+  .extend({
+    robot: z.literal('/document/thumbs').describe(`
+## Things to keep in mind
+
+- If you convert a multi-page PDF file into several images, all result images will be sorted with the first image being the thumbnail of the first document page, etc.
+- You can also check the \`meta.thumb_index\` key of each result image to find out which page it corresponds to. Keep in mind that these thumb indices **start at 0,** not at 1.
+`),
+    page: z
+      .number()
+      .int()
+      .nullable()
+      .default(null)
+      .describe(`
+The PDF page that you want to convert to an image. By default the value is \`null\` which means that all pages will be converted into images.
+`),
+    format: z
+      .enum(['gif', 'jpeg', 'jpg', 'png'])
+      .default('png')
+      .describe(`
+The format of the extracted image(s).
+
+If you specify the value \`"gif"\`, then an animated gif cycling through all pages is created. Please check out [this demo](/demos/document-processing/convert-all-pages-of-a-document-into-an-animated-gif/) to learn more about this.
+`),
+    delay: z
+      .number()
+      .int()
+      .min(0)
+      .optional()
+      .describe(`
+If your output format is \`"gif"\` then this parameter sets the number of 100th seconds to pass before the next frame is shown in the animation. Set this to \`100\` for example to allow 1 second to pass between the frames of the animated gif.
+
+If your output format is not \`"gif"\`, then this parameter does not have any effect.
+`),
+    width: z
+      .number()
+      .int()
+      .min(1)
+      .max(5000)
+      .optional()
+      .describe(`
+Width of the new image, in pixels. If not specified, will default to the width of the input image
+`),
+    height: z
+      .number()
+      .int()
+      .min(1)
+      .max(5000)
+      .optional()
+      .describe(`
+Height of the new image, in pixels. If not specified, will default to the height of the input image
+`),
+    resize_strategy: z
+      .enum(['crop', 'fillcrop', 'fit', 'min_fit', 'pad', 'stretch'])
+      .default('pad')
+      .describe(`
+One of the [available resize strategies](/docs/topics/resize-strategies/).
+`),
+    // TODO: Determine the allowed colors
+    background: z
+      .string()
+      .default('#FFFFFF')
+      .describe(`
+Either the hexadecimal code or [name](https://www.imagemagick.org/script/color.php#color_names) of the color used to fill the background (only used for the pad resize strategy).
+
+By default, the background of transparent images is changed to white. For details about how to preserve transparency across all image types, see [this demo](/demos/image-manipulation/properly-preserve-transparency-across-all-image-types/).
+`),
+    // TODO: Update options list. Why are they capitalized? They are lowercase in th ImageMagick docs.
+    alpha: z
+      .enum(['Remove', 'Set'])
+      .optional()
+      .describe(`
+Change how the alpha channel of the resulting image should work. Valid values are \`"Set"\` to enable transparency and \`"Remove"\` to remove transparency.
+
+For a list of all valid values please check the ImageMagick documentation [here](http://www.imagemagick.org/script/command-line-options.php#alpha).
+`),
+    density: z
+      .string()
+      .regex(/\d+(x\d+)?/)
+      .optional()
+      .describe(`
+While in-memory quality and file format depth specifies the color resolution, the density of an image is the spatial (space) resolution of the image. That is the density (in pixels per inch) of an image and defines how far apart (or how big) the individual pixels are. It defines the size of the image in real world terms when displayed on devices or printed.
+
+You can set this value to a specific \`width\` or in the format \`width\`x\`height\`.
+
+If your converted image has a low resolution, please try using the density parameter to resolve that.
+`),
+    antialiasing: z
+      .boolean()
+      .default(false)
+      .describe(`
+Controls whether or not antialiasing is used to remove jagged edges from text or images in a document.
+`),
+    colorspace: colorspaceSchema.optional().describe(`
+Sets the image colorspace. For details about the available values, see the [ImageMagick documentation](https://www.imagemagick.org/script/command-line-options.php#colorspace).
+
+Please note that if you were using \`"RGB"\`, we recommend using \`"sRGB"\`. ImageMagick might try to find the most efficient \`colorspace\` based on the color of an image, and default to e.g. \`"Gray"\`. To force colors, you might then have to use this parameter.
+`),
+    trim_whitespace: z
+      .boolean()
+      .default(true)
+      .describe(`
+This determines if additional whitespace around the PDF should first be trimmed away before it is converted to an image. If you set this to \`true\` only the real PDF page contents will be shown in the image.
+
+If you need to reflect the PDF's dimensions in your image, it is generally a good idea to set this to \`false\`.
+`),
+    pdf_use_cropbox: z
+      .boolean()
+      .default(true)
+      .describe(`
+Some PDF documents lie about their dimensions. For instance they'll say they are landscape, but when opened in decent Desktop readers, it's really in portrait mode. This can happen if the document has a cropbox defined. When this option is enabled (by default), the cropbox is leading in determining the dimensions of the resulting thumbnails.
+`),
+    turbo: z
+      .boolean()
+      .default(true)
+      .describe(`
+If you set this to \`false\`, the robot will not emit files as they become available. This is useful if you are only interested in the final result and not in the intermediate steps.
+
+Also, extracted pages will be resized a lot faster as they are sent off to other machines for the resizing. This is especially useful for large documents with many pages to get up to 20 times faster processing.
+
+Turbo Mode increases pricing, though, in that the input document's file size is added for every extracted page. There are no performance benefits nor increased charges for single-page documents.
+`),
+  })
+  .strict()
+
+export const robotDocumentThumbsInstructionsWithHiddenFieldsSchema =
+  robotDocumentThumbsInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotDocumentThumbsInstructionsSchema.shape.result])
+      .optional(),
+    stack: z
+      .string()
+      .optional()
+      .describe(`
+The image processing stack to use. Defaults to the robot's preferred stack (ImageMagick).
+`),
+    // Override to support lowercase for BC:
+    alpha: z
+      .enum(['Remove', 'Set', 'remove', 'set'])
+      .optional()
+      .describe(`
+Change how the alpha channel of the resulting image should work. Valid values are \`"Set"\` to enable transparency and \`"Remove"\` to remove transparency. Lowercase values are also accepted for backwards compatibility.
+`),
+    // Override to support 'none' for BC
+    resize_strategy: z
+      .enum(['crop', 'fillcrop', 'fit', 'min_fit', 'pad', 'stretch', 'none'])
+      .optional()
+      .describe(`
+One of the [available resize strategies](/docs/transcoding/image-manipulation/image-resize/#resize-strategies). The 'none' value is supported for backwards compatibility.
+`),
+  })
+
+export type RobotDocumentThumbsInstructions = z.infer<typeof robotDocumentThumbsInstructionsSchema>
+export type RobotDocumentThumbsInstructionsWithHiddenFields = z.infer<
+  typeof robotDocumentThumbsInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotDocumentThumbsInstructionsSchema = interpolateRobot(
+  robotDocumentThumbsInstructionsSchema,
+)
+export type InterpolatableRobotDocumentThumbsInstructions =
+  InterpolatableRobotDocumentThumbsInstructionsInput
+
+export type InterpolatableRobotDocumentThumbsInstructionsInput = z.input<
+  typeof interpolatableRobotDocumentThumbsInstructionsSchema
+>
+
+export const interpolatableRobotDocumentThumbsInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotDocumentThumbsInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotDocumentThumbsInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotDocumentThumbsInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotDocumentThumbsInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotDocumentThumbsInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,100 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  dropboxBase,
+  interpolateRobot,
+  path,
+  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: '/dropbox/import',
+        credentials: 'YOUR_DROPBOX_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 Dropbox',
+  purpose_verb: 'import',
+  purpose_word: 'Dropbox',
+  purpose_words: 'Import files from Dropbox',
+  requires_credentials: true,
+  service_slug: 'file-importing',
+  slot_count: 20,
+  title: 'Import files from Dropbox',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'DropboxImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotDropboxImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(dropboxBase)
+  .extend({
+    robot: z.literal('/dropbox/import'),
+    path: path.describe(`
+The path in your Dropbox 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>.
+`),
+  })
+  .strict()
+
+export const robotDropboxImportInstructionsWithHiddenFieldsSchema =
+  robotDropboxImportInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotDropboxImportInstructionsSchema.shape.result])
+      .optional(),
+    access_token: z.string().optional(), // Legacy field for backward compatibility
+  })
+
+export type RobotDropboxImportInstructions = z.infer<typeof robotDropboxImportInstructionsSchema>
+export type RobotDropboxImportInstructionsWithHiddenFields = z.infer<
+  typeof robotDropboxImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotDropboxImportInstructionsSchema = interpolateRobot(
+  robotDropboxImportInstructionsSchema,
+)
+export type InterpolatableRobotDropboxImportInstructions =
+  InterpolatableRobotDropboxImportInstructionsInput
+
+export type InterpolatableRobotDropboxImportInstructionsInput = z.input<
+  typeof interpolatableRobotDropboxImportInstructionsSchema
+>
+
+export const interpolatableRobotDropboxImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotDropboxImportInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotDropboxImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotDropboxImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotDropboxImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotDropboxImportInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,97 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { dropboxBase, interpolateRobot, robotBase, robotUse } from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: true,
+  bytescount: 6,
+  discount_factor: 0.15000150001500018,
+  discount_pct: 84.99984999849998,
+  example_code: {
+    steps: {
+      exported: {
+        robot: '/dropbox/store',
+        use: ':original',
+        credentials: 'YOUR_DROPBOX_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on Dropbox:',
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to Dropbox',
+  purpose_verb: 'export',
+  purpose_word: 'Dropbox',
+  purpose_words: 'Export files to Dropbox',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Dropbox',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'DropboxStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotDropboxStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(dropboxBase)
+  .extend({
+    robot: z.literal('/dropbox/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).
+`),
+    create_sharing_link: z
+      .boolean()
+      .default(false)
+      .describe(`
+Whether to create a URL to this file for sharing with other people. This will overwrite the file's \`"url"\` property.
+`),
+  })
+  .strict()
+
+export const robotDropboxStoreInstructionsWithHiddenFieldsSchema =
+  robotDropboxStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotDropboxStoreInstructionsSchema.shape.result])
+      .optional(),
+    access_token: z.string().optional(), // Legacy field for backward compatibility
+  })
+
+export type RobotDropboxStoreInstructions = z.infer<typeof robotDropboxStoreInstructionsSchema>
+export type RobotDropboxStoreInstructionsInput = z.input<typeof robotDropboxStoreInstructionsSchema>
+export type RobotDropboxStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotDropboxStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotDropboxStoreInstructionsSchema = interpolateRobot(
+  robotDropboxStoreInstructionsSchema,
+)
+export type InterpolatableRobotDropboxStoreInstructions =
+  InterpolatableRobotDropboxStoreInstructionsInput
+
+export type InterpolatableRobotDropboxStoreInstructionsInput = z.input<
+  typeof interpolatableRobotDropboxStoreInstructionsSchema
+>
+
+export const interpolatableRobotDropboxStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotDropboxStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotDropboxStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotDropboxStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotDropboxStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotDropboxStoreInstructionsWithHiddenFieldsSchema
+>

package/src/alphalib/types/robots/edgly-deliver.ts

@@ -0,0 +1,73 @@
+import { z } from 'zod'
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase } from './_instructions-primitives.ts'
+
+export const meta: RobotMetaInput = {
+  allowed_for_url_transform: false,
+  bytescount: 20,
+  discount_factor: 0.05,
+  discount_pct: 95,
+  minimum_charge: 102400,
+  output_factor: 1,
+  override_lvl1: 'Content Delivery',
+  purpose_sentence: 'caches and delivers files globally',
+  purpose_verb: 'cache & deliver',
+  purpose_word: 'Cache and deliver files',
+  purpose_words: 'Cache and deliver files globally',
+  service_slug: 'content-delivery',
+  slot_count: 0,
+  title: 'Cache and deliver files globally',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'EdglyDeliverRobot',
+  priceFactor: 20,
+  queueSlotCount: 0,
+  minimumCharge: 102400,
+  downloadInputFiles: false,
+  preserveInputFileUrls: true,
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: false,
+  isInternal: true,
+  stage: 'removed',
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+}
+
+export const robotEdglyDeliverInstructionsSchema = robotBase
+  .extend({
+    robot: z.literal('/edgly/deliver').describe(`
+When you want Transloadit to tranform files on the fly, this <dfn>Robot</dfn> can cache and deliver the results close to your end-user, saving on latency and encoding volume. The use of this <dfn>Robot</dfn> is implicit when you use the <code>edgly.net</code> domain.
+`),
+  })
+  .strict()
+
+export const robotEdglyDeliverInstructionsWithHiddenFieldsSchema =
+  robotEdglyDeliverInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotEdglyDeliverInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotEdglyDeliverInstructions = z.infer<typeof robotEdglyDeliverInstructionsSchema>
+export type RobotEdglyDeliverInstructionsWithHiddenFields = z.infer<
+  typeof robotEdglyDeliverInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotEdglyDeliverInstructionsSchema = interpolateRobot(
+  robotEdglyDeliverInstructionsSchema,
+)
+export type InterpolatableRobotEdglyDeliverInstructions =
+  InterpolatableRobotEdglyDeliverInstructionsInput
+
+export type InterpolatableRobotEdglyDeliverInstructionsInput = z.input<
+  typeof interpolatableRobotEdglyDeliverInstructionsSchema
+>
+
+export const interpolatableRobotEdglyDeliverInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotEdglyDeliverInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotEdglyDeliverInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotEdglyDeliverInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotEdglyDeliverInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotEdglyDeliverInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,167 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase, 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: {
+      compressed: {
+        robot: '/file/compress',
+        use: {
+          steps: [':original'],
+          bundle_steps: true,
+        },
+        format: 'zip',
+      },
+    },
+  },
+  example_code_description: 'Compress uploaded files into a ZIP archive:',
+  extended_description: `
+### Archive structure for the \`"advanced"\` file layout.
+
+There are a few things that we kept in mind when designing the \`"advanced"\` archive structure:
+
+- There could be naming collisions.
+- You want to know which <dfn>Step</dfn> a result file belongs to.
+- You want to know from which originally uploaded file a result file was generated.
+- Ideally, you want subfolders for a better structure of files.
+
+To achieve all this, we have created the following archive file structure.
+
+- There is a subfolder for each <dfn>Step</dfn> name that has result files in the archive.
+- Files are named according to the first two letters of the unique original prefix + "_" + the first two letters of the unique prefix + "_" + the original file name. If you do not know what the original prefixes are, please check [our available Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) and look for \`\${unique_original_prefix}\` and \`\${unique_prefix}\`.
+- Files that belong to the \`:original\` <dfn>Step</dfn> (originally uploaded files) do **not** include the first two letters of the \`unique_original_prefix\`.
+- If you are dealing with thumbnails from [🤖/video/thumbs](/docs/robots/video-thumbs/), there is an additional digit representing the order in the file name.
+
+Here is an example:
+
+\`\`\`yaml
+":original":
+  - gh_a.mov          # "gh" are the first 2 letters of the unique prefix.
+                      # "a.mov" was the file name of the uploaded file.
+  - ff_b.mov
+"thumbed":
+  - gh_e8_thumb_1.jpg # "gh" is the unique original prefix, meaning it's a result of a.mov.
+                      # "e8" is the file's unique prefix.
+                      # The "1" shows the thumbnail order.
+  - gh_cv_thumb_2.jpg
+  - ff_9b_thumb_3.jpg
+"resized":
+  - gh_ll_thumb.jpg
+  - gh_df_thumb.jpg
+  - ff_jk_thumb.jpg   # is a child of b.mov, as it starts with "ff"
+\`\`\`
+`,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Compressing',
+  purpose_sentence: 'creates archives of files or file conversion results',
+  purpose_verb: 'compress',
+  purpose_word: 'compress',
+  purpose_words: 'Compress files',
+  service_slug: 'file-compressing',
+  slot_count: 15,
+  title: 'Compress files',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FileCompressRobot',
+  priceFactor: 1,
+  queueSlotCount: 15,
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFileCompressInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/compress'),
+    format: z
+      .enum(['tar', 'zip'])
+      .default('tar')
+      .describe(`
+The format of the archive to be created. Supported values are \`"tar"\` and \`"zip"\`.
+
+Note that \`"tar"\` without setting \`gzip\` to \`true\` results in an archive that's not compressed in any way.
+`),
+    gzip: z
+      .boolean()
+      .default(false)
+      .describe(`
+Determines if the result archive should also be gzipped. Gzip compression is only applied if you use the \`"tar"\` format.
+`),
+    password: z
+      .string()
+      .nullable()
+      .default(null)
+      .describe(`
+This allows you to encrypt all archive contents with a password and thereby protect it against unauthorized use. To unzip the archive, the user will need to provide the password in a text input field prompt.
+
+This parameter has no effect if the format parameter is anything other than \`"zip"\`.
+`),
+    compression_level: z
+      .number()
+      .int()
+      .min(-9)
+      .max(0)
+      .default(-6)
+      .describe(`
+Determines how fiercely to try to compress the archive. \`-0\` is compressionless, which is suitable for media that is already compressed. \`-1\` is fastest with lowest compression. \`-9\` is slowest with the highest compression.
+
+If you are using \`-0\` in combination with the \`tar\` format with \`gzip\` enabled, consider setting \`gzip: false\` instead. This results in a plain Tar archive, meaning it already has no compression.
+`),
+    file_layout: z
+      .enum(['advanced', 'simple', 'relative-path'])
+      .default('advanced')
+      .describe(`
+Determines if the result archive should contain all files in one directory (value for this is \`"simple"\`) or in subfolders according to the explanation below (value for this is \`"advanced"\`). The \`"relative-path"\` option preserves the relative directory structure of the input files.
+
+Files with same names are numbered in the \`"simple"\` file layout to avoid naming collisions.
+`),
+    archive_name: z
+      .string()
+      .optional()
+      .describe(`
+The name of the archive file to be created (without the file extension).
+`),
+  })
+  .strict()
+
+export const robotFileCompressInstructionsWithHiddenFieldsSchema =
+  robotFileCompressInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotFileCompressInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotFileCompressInstructions = z.infer<typeof robotFileCompressInstructionsSchema>
+export type RobotFileCompressInstructionsWithHiddenFields = z.infer<
+  typeof robotFileCompressInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileCompressInstructionsSchema = interpolateRobot(
+  robotFileCompressInstructionsSchema,
+)
+export type InterpolatableRobotFileCompressInstructions =
+  InterpolatableRobotFileCompressInstructionsInput
+
+export type InterpolatableRobotFileCompressInstructionsInput = z.input<
+  typeof interpolatableRobotFileCompressInstructionsSchema
+>
+
+export const interpolatableRobotFileCompressInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileCompressInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileCompressInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileCompressInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileCompressInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileCompressInstructionsWithHiddenFieldsSchema
+>