@transloadit/node 4.1.3

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

@@ -0,0 +1,71 @@
+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: true,
+  bytescount: 5,
+  discount_factor: 0.2,
+  discount_pct: 80,
+  minimum_charge: 512000,
+  output_factor: 1,
+  override_lvl1: 'Document Processing',
+  purpose_sentence: 'reads file contents from supported file-types',
+  purpose_verb: 'read',
+  purpose_word: 'read files',
+  purpose_words: 'Read file contents',
+  service_slug: 'document-processing',
+  slot_count: 5,
+  title: 'Read file contents',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FileReadRobot',
+  priceFactor: 5,
+  queueSlotCount: 5,
+  minimumCharge: 512000,
+  isAllowedForUrlTransform: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFileReadInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/read').describe(`
+This <dfn>Robot</dfn> accepts any file, and will read the file using UTF-8 encoding. The result is outputted to \`file.meta.content\` to be accessed in later <dfn>Steps</dfn>.
+
+The <dfn>Robot</dfn> currently only accepts files under 500KB.
+`),
+  })
+  .strict()
+
+export const robotFileReadInstructionsWithHiddenFieldsSchema =
+  robotFileReadInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotFileReadInstructionsSchema.shape.result]).optional(),
+  })
+
+export type RobotFileReadInstructions = z.infer<typeof robotFileReadInstructionsSchema>
+export type RobotFileReadInstructionsWithHiddenFields = z.infer<
+  typeof robotFileReadInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileReadInstructionsSchema = interpolateRobot(
+  robotFileReadInstructionsSchema,
+)
+export type InterpolatableRobotFileReadInstructions = InterpolatableRobotFileReadInstructionsInput
+
+export type InterpolatableRobotFileReadInstructionsInput = z.input<
+  typeof interpolatableRobotFileReadInstructionsSchema
+>
+
+export const interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileReadInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileReadInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileReadInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,128 @@
+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: true,
+  bytescount: 4,
+  discount_factor: 0.25,
+  discount_pct: 75,
+  minimum_charge: 0,
+  output_factor: 1,
+  purpose_sentence: 'serves files to web browsers',
+  purpose_verb: 'serve',
+  purpose_word: 'Serve files',
+  purpose_words: 'Serve files to web browsers',
+  service_slug: 'content-delivery',
+  slot_count: 0,
+  title: 'Serve files to web browsers',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FileServeRobot',
+  priceFactor: 4,
+  queueSlotCount: 0,
+  downloadInputFiles: false,
+  preserveInputFileUrls: true,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  stage: 'ga',
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+}
+
+export const robotFileServeInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/serve').describe(`
+When you want Transloadit to tranform files on the fly, you can use this <dfn>Robot</dfn> to determine which <dfn>Step</dfn> of a <dfn>Template</dfn> should be served to the end-user (via a CDN), as well as set extra information on the served files, such as headers. This way you can for instance suggest the CDN for how long to keep cached copies of the result around. By default, as you can see in the \`headers\` parameter, we instruct browsers to cache the result for 72h (\`259200\` seconds) and CDNs to cache the content for 24h (\`86400\` seconds). These values should be adjusted to suit your use case.
+
+🤖/file/serve merely acts as the glue layer between our <dfn>Assembly</dfn> engine and serving files over HTTP. It let's you pick the proper result of a series of <dfn>Steps</dfn> via the \`use\` parameter and configure headers on the original content. That is where its responsibilies end, and 🤖/tlcdn/deliver, then takes over to globally distribute this original content across the globe, and make sure that is cached close to your end-users, when they make requests such as <https://my-app.tlcdn.com/resize-img/canoe.jpg?w=500>, another. 🤖/tlcdn/deliver is not a part of your <dfn>Assembly Instructions</dfn>, but it may appear on your invoices as bandwidth charges incur when distributing the cached copies. 🤖/file/serve only charges when the CDN does not have a cached copy and requests to regenerate the original content, which depending on your caching settings could be just once a month, or year, per file/transformation.
+
+While theoretically possible, you could use [🤖/file/serve](/docs/robots/file-serve/) directly in HTML files, but we strongly recommend against this, because if your site gets popular and the media URL that /file/serve is handling gets hit one million times, that is one million new image resizes. Wrapping it with a CDN (and thanks to the caching that comes with it) makes sure encoding charges stay low, as well as latencies.
+
+Also consider configuring caching headers and cache-control directives to control how content is cached and invalidated on the CDN edge servers, balancing between freshness and efficiency.
+
+## Smart CDN Security with Signature Authentication
+
+You can leverage [Signature Authentication](/docs/api/authentication/#smart-cdn) to avoid abuse of our encoding platform. Below is a quick Node.js example using our Node SDK, but there are [examples for other languages and SDKs](/docs/api/authentication/#example-code) as well.
+
+\`\`\`javascript
+// yarn add transloadit
+// or
+// npm install --save transloadit
+
+import { Transloadit } from 'transloadit'
+
+const transloadit = new Transloadit({
+  authKey: 'YOUR_TRANSLOADIT_KEY',
+  authSecret: 'YOUR_TRANSLOADIT_SECRET',
+})
+
+const url = transloadit.getSignedSmartCDNUrl({
+  workspace: 'YOUR_WORKSPACE',
+  template: 'YOUR_TEMPLATE',
+  input: 'image.png',
+  urlParams: { height: 100, width: 100 },
+})
+
+console.log(url)
+\`\`\`
+
+This will generate a signed Smart CDN URL that includes authentication parameters, preventing unauthorized access to your transformation endpoints.
+
+## More information
+
+- [Content Delivery](/services/content-delivery/)
+- [🤖/file/serve](/docs/robots/file-serve/) pricing
+- [🤖/tlcdn/deliver](/docs/robots/tlcdn-deliver/) pricing
+- [File Preview Feature](/blog/2024/06/file-preview-with-smart-cdn/) blog post
+`),
+    headers: z
+      .record(z.string())
+      .default({
+        'Access-Control-Allow-Headers':
+          'X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length, Transloadit-Client, Authorization',
+        'Access-Control-Allow-Methods': 'POST, GET, PUT, DELETE, OPTIONS',
+        'Access-Control-Allow-Origin': '*',
+        'Cache-Control': 'public, max-age=259200, s-max-age=86400',
+        'Content-Type': '${file.mime}; charset=utf-8',
+        'Transfer-Encoding': 'chunked',
+        'Transloadit-Assembly': '…',
+        'Transloadit-RequestID': '…',
+      })
+      .describe(`
+An object containing a list of headers to be set for a file as we serve it to a CDN/web browser, such as \`{ FileURL: "\${file.url_name}" }\` which will be merged over the defaults, and can include any available [Assembly Variable](/docs/topics/assembly-instructions/#assembly-variables).
+`),
+  })
+  .strict()
+
+export const robotFileServeInstructionsWithHiddenFieldsSchema =
+  robotFileServeInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotFileServeInstructionsSchema.shape.result]).optional(),
+  })
+
+export type RobotFileServeInstructions = z.infer<typeof robotFileServeInstructionsSchema>
+export type RobotFileServeInstructionsInput = z.input<typeof robotFileServeInstructionsSchema>
+export type RobotFileServeInstructionsWithHiddenFields = z.infer<
+  typeof robotFileServeInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileServeInstructionsSchema = interpolateRobot(
+  robotFileServeInstructionsSchema,
+)
+export type InterpolatableRobotFileServeInstructions = InterpolatableRobotFileServeInstructionsInput
+
+export type InterpolatableRobotFileServeInstructionsInput = z.input<
+  typeof interpolatableRobotFileServeInstructionsSchema
+>
+
+export const interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileServeInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileServeInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileServeInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,102 @@
+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: true,
+  bytescount: 4,
+  description:
+    '/file/verify is a simple Robot that helps ensure that the files you upload are of the type you initially intended. This is especially useful when handling user-generated content, where you may not want to run certain Steps in your Template if the user hasn’t uploaded a file of the correct type. Another use case for /file/verify is when a user uploads a ZIP file, but we find that it has a few damaged files inside when we extract it. Perhaps you don’t want to error out, but only send the good files to a next processing step. With /file/verify, you can do exactly that (assuming the default of `error_on_decline`: `true`).',
+  discount_factor: 0.25,
+  discount_pct: 75,
+  example_code: {
+    steps: {
+      scanned: {
+        robot: '/file/verify',
+        use: ':original',
+        error_on_decline: true,
+        error_msg: 'At least one of the uploaded files was not the desired type',
+        verify_to_be: 'image',
+      },
+    },
+  },
+  example_code_description: 'Scan the uploaded files and throw an error if they are not images:',
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Filtering',
+  purpose_sentence: 'verifies your files are the type that you want',
+  purpose_verb: 'verify',
+  purpose_word: 'verify the file type',
+  purpose_words: 'Verify the file type',
+  service_slug: 'file-filtering',
+  slot_count: 10,
+  title: 'Verify the file type',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FileVerifyRobot',
+  priceFactor: 4,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFileVerifyInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/verify'),
+    error_on_decline: z
+      .boolean()
+      .default(false)
+      .describe(`
+If this is set to \`true\` and one or more files are declined, the Assembly will be stopped and marked with an error.
+`),
+    error_msg: z
+      .string()
+      .default('One of your files was declined')
+      .describe(`
+The error message shown to your users (such as by Uppy) when a file is declined and \`error_on_decline\` is set to \`true\`.
+`),
+    verify_to_be: z
+      .string()
+      .default('pdf')
+      .describe(`
+The type that you want to match against to ensure your file is of this type. For example, \`image\` will verify whether uploaded files are images. This also works against file media types, in this case \`image/png\` would also work to match against specifically \`png\` files.
+`),
+  })
+  .strict()
+
+export const robotFileVerifyInstructionsWithHiddenFieldsSchema =
+  robotFileVerifyInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotFileVerifyInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotFileVerifyInstructions = z.infer<typeof robotFileVerifyInstructionsSchema>
+export type RobotFileVerifyInstructionsWithHiddenFields = z.infer<
+  typeof robotFileVerifyInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileVerifyInstructionsSchema = interpolateRobot(
+  robotFileVerifyInstructionsSchema,
+)
+export type InterpolatableRobotFileVerifyInstructions =
+  InterpolatableRobotFileVerifyInstructionsInput
+
+export type InterpolatableRobotFileVerifyInstructionsInput = z.input<
+  typeof interpolatableRobotFileVerifyInstructionsSchema
+>
+
+export const interpolatableRobotFileVerifyInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileVerifyInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileVerifyInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileVerifyInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileVerifyInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileVerifyInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,113 @@
+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,
+  description:
+    'While 100% security is a myth, having /file/virusscan as a gatekeeper bot helps reject millions of trojans, viruses, malware & other malicious threats before they reach your platform.',
+  discount_factor: 1,
+  discount_pct: 0,
+  example_code: {
+    steps: {
+      scanned: {
+        robot: '/file/virusscan',
+        use: ':original',
+        error_on_decline: true,
+        error_msg: 'At least one of the uploaded files is malicious and was declined',
+      },
+    },
+  },
+  example_code_description:
+    'Scan uploaded files and throw an error if a malicious file is detected:',
+  minimum_charge: 1048576,
+  ogimage: '/assets/images/robots/ogimages/file-virusscan.jpg',
+  output_factor: 1,
+  override_lvl1: 'File Filtering',
+  purpose_sentence:
+    'rejects millions of trojans, viruses, malware & other malicious threats before they reach your platform',
+  purpose_verb: 'scan',
+  purpose_word: 'scan for viruses and reject malware',
+  purpose_words: 'Scan files for viruses',
+  service_slug: 'file-filtering',
+  slot_count: 38,
+  title: 'Scan files for viruses',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FileVirusscanRobot',
+  priceFactor: 1,
+  queueSlotCount: 38,
+  minimumCharge: 1048576,
+  lazyLoad: true,
+  installVersionFile: process.env.API2_CLAMD_INSTALL_VERSION_FILE || '',
+  isAllowedForUrlTransform: false,
+  trackOutputFileSize: true,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFileVirusscanInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/virusscan').describe(`
+      This <dfn>Robot</dfn> is built on top of [ClamAV](https://www.clamav.net/), the best open source antivirus engine available. We update its signatures on a daily basis.
+
+By default, this <dfn>Robot</dfn> excludes all malicious files from further processing without any additional notification. This behavior can be changed by setting \`error_on_decline\` to \`true\`, which will stop <dfn>Assemblies</dfn> as soon as malicious files are found. Such <dfn>Assemblies</dfn> will then be marked with an error.
+
+We allow the use of industry standard [EICAR files](https://www.eicar.org/download-anti-malware-testfile/) for integration testing without needing to use potentially dangerous live virus samples.
+`),
+    error_on_decline: z
+      .boolean()
+      .default(false)
+      .describe(`
+If this is set to \`true\` and one or more files are declined, the Assembly will be stopped and marked with an error.
+`),
+    error_msg: z
+      .string()
+      .default('One of your files was declined')
+      .describe(`
+The error message shown to your users (such as by Uppy) when a file is declined and \`error_on_decline\` is set to \`true\`.
+`),
+  })
+  .strict()
+
+export const robotFileVirusscanInstructionsWithHiddenFieldsSchema =
+  robotFileVirusscanInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotFileVirusscanInstructionsSchema.shape.result])
+      .optional(),
+    can_use_daemon_fallback: z
+      .boolean()
+      .optional()
+      .describe(`
+Allow the robot to use a daemon fallback mechanism if the primary scanning method fails.
+`),
+  })
+
+export type RobotFileVirusscanInstructions = z.infer<typeof robotFileVirusscanInstructionsSchema>
+export type RobotFileVirusscanInstructionsWithHiddenFields = z.infer<
+  typeof robotFileVirusscanInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileVirusscanInstructionsSchema = interpolateRobot(
+  robotFileVirusscanInstructionsSchema,
+)
+export type InterpolatableRobotFileVirusscanInstructions =
+  InterpolatableRobotFileVirusscanInstructionsInput
+
+export type InterpolatableRobotFileVirusscanInstructionsInput = z.input<
+  typeof interpolatableRobotFileVirusscanInstructionsSchema
+>
+
+export const interpolatableRobotFileVirusscanInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileVirusscanInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileVirusscanInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileVirusscanInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileVirusscanInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileVirusscanInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,56 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase, robotUse } from './_instructions-primitives.ts'
+
+// @ts-expect-error - FileWatermarkRobot is not ready yet @TODO please supply missing keys
+export const meta: RobotMetaInput = {
+  name: 'FileWatermarkRobot',
+  priceFactor: 4,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFileWatermarkInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/file/watermark'),
+    randomize: z.boolean().optional(),
+  })
+  .strict()
+
+export const robotFileWatermarkInstructionsWithHiddenFieldsSchema =
+  robotFileWatermarkInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotFileWatermarkInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotFileWatermarkInstructions = z.infer<typeof robotFileWatermarkInstructionsSchema>
+export type RobotFileWatermarkInstructionsWithHiddenFields = z.infer<
+  typeof robotFileWatermarkInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFileWatermarkInstructionsSchema = interpolateRobot(
+  robotFileWatermarkInstructionsSchema,
+)
+export type InterpolatableRobotFileWatermarkInstructions =
+  InterpolatableRobotFileWatermarkInstructionsInput
+
+export type InterpolatableRobotFileWatermarkInstructionsInput = z.input<
+  typeof interpolatableRobotFileWatermarkInstructionsSchema
+>
+
+export const interpolatableRobotFileWatermarkInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFileWatermarkInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFileWatermarkInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFileWatermarkInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFileWatermarkInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFileWatermarkInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,95 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  ftpBase,
+  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: '/ftp/import',
+        credentials: 'YOUR_FTP_CREDENTIALS',
+        path: 'path/to/files/',
+      },
+    },
+  },
+  example_code_description:
+    'Import files from the `path/to/files` directory and its subdirectories:',
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Importing',
+  purpose_sentence:
+    'imports whole libraries of files from your FTP servers into Transloadit. This Robot relies on password access. For more security, consider our /sftp/import Robot',
+  purpose_verb: 'import',
+  purpose_word: 'FTP servers',
+  purpose_words: 'Import files from FTP servers',
+  service_slug: 'file-importing',
+  slot_count: 20,
+  title: 'Import files from FTP servers',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FtpImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotFtpImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(ftpBase)
+  .extend({
+    robot: z.literal('/ftp/import'),
+    path: path.describe(`
+The path on your FTP server where to search for files. Files are imported recursively from all sub-directories and sub-sub-directories (and so on) from this path.
+`),
+    passive_mode: z
+      .boolean()
+      .default(true)
+      .describe(`
+Determines if passive mode should be used for the FTP connection.
+`),
+  })
+  .strict()
+
+export const robotFtpImportInstructionsWithHiddenFieldsSchema =
+  robotFtpImportInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotFtpImportInstructionsSchema.shape.result]).optional(),
+  })
+
+export type RobotFtpImportInstructions = z.infer<typeof robotFtpImportInstructionsSchema>
+export type RobotFtpImportInstructionsWithHiddenFields = z.infer<
+  typeof robotFtpImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFtpImportInstructionsSchema = interpolateRobot(
+  robotFtpImportInstructionsSchema,
+)
+export type InterpolatableRobotFtpImportInstructions = InterpolatableRobotFtpImportInstructionsInput
+
+export type InterpolatableRobotFtpImportInstructionsInput = z.input<
+  typeof interpolatableRobotFtpImportInstructionsSchema
+>
+
+export const interpolatableRobotFtpImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFtpImportInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFtpImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFtpImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFtpImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFtpImportInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,119 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { ftpBase, 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: '/ftp/store',
+        use: ':original',
+        credentials: 'YOUR_FTP_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on an FTP server:',
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence:
+    'exports encoding results to your FTP servers. This Robot relies on password access. For more security, consider our /sftp/store Robot',
+  purpose_verb: 'export',
+  purpose_word: 'FTP servers',
+  purpose_words: 'Export files to FTP servers',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to FTP servers',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'FtpStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotFtpStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(ftpBase)
+  .extend({
+    robot: z.literal('/ftp/store'),
+    path: z
+      .string()
+      .default('${unique_prefix}/${file.url_name}')
+      .describe(`
+The path at which the file is to be stored. This can contain any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).
+
+Please note that you might need to include your homedir at the beginning of the path.
+`),
+    url_template: z
+      .string()
+      .default('https://{HOST}/{PATH}')
+      .describe(`
+The URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.
+`),
+    ssl_url_template: z
+      .string()
+      .default('https://{HOST}/{PATH}')
+      .describe(`
+The SSL URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.
+`),
+    secure: z
+      .boolean()
+      .default(false)
+      .describe(`
+Determines whether to establish a secure connection to the FTP server using SSL.
+`),
+  })
+  .strict()
+
+export const robotFtpStoreInstructionsWithHiddenFieldsSchema =
+  robotFtpStoreInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotFtpStoreInstructionsSchema.shape.result]).optional(),
+    use_remote_utime: z
+      .boolean()
+      .optional()
+      .describe(`
+Use the remote file's modification time instead of the current time when storing the file.
+`),
+    version: z
+      .union([z.string(), z.number()])
+      .optional()
+      .describe(`
+Version identifier for the underlying tool used (2 is ncftp, 1 is ftp).
+`),
+    allowNetwork: z.string().optional(), // For internal test purposes
+  })
+
+export type RobotFtpStoreInstructions = z.infer<typeof robotFtpStoreInstructionsSchema>
+export type RobotFtpStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotFtpStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotFtpStoreInstructionsSchema = interpolateRobot(
+  robotFtpStoreInstructionsSchema,
+)
+export type InterpolatableRobotFtpStoreInstructions = InterpolatableRobotFtpStoreInstructionsInput
+
+export type InterpolatableRobotFtpStoreInstructionsInput = z.input<
+  typeof interpolatableRobotFtpStoreInstructionsSchema
+>
+
+export const interpolatableRobotFtpStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotFtpStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotFtpStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotFtpStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotFtpStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotFtpStoreInstructionsWithHiddenFieldsSchema
+>