@transloadit/node 4.1.3

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

@@ -0,0 +1,143 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase, robotUse, vimeoBase } 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: '/vimeo/store',
+        use: ':original',
+        credentials: 'YOUR_VIMEO_CREDENTIALS',
+        title: 'Transloadit: Video Example',
+        description: 'Some nice description',
+      },
+    },
+  },
+  example_code_description: 'Export an uploaded video to Vimeo and set its title and description:',
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to vimeo',
+  purpose_verb: 'export',
+  purpose_word: 'Vimeo',
+  purpose_words: 'Export files to Vimeo',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Vimeo',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'VimeoStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotVimeoStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(vimeoBase)
+  .extend({
+    robot: z.literal('/vimeo/store'),
+    title: z.string().describe(`
+The title of the video to be displayed on Vimeo.
+`),
+    description: z.string().describe(`
+The description of the video to be displayed on Vimeo.
+`),
+    acl: z
+      .enum(['anybody', 'contacts', 'disable', 'nobody', 'password', 'unlisted', 'users'])
+      .default('anybody')
+      .describe(`
+Controls access permissions for the video. Here are the valid values:
+
+- \`"anybody"\` — anyone can access the video.
+- \`"contacts"\` — only those who follow the owner on Vimeo can access the video.
+- \`"disable"\` — the video is embeddable, but it's hidden on Vimeo and can't be played.
+- \`"nobody"\` — no one except the owner can access the video.
+- \`"password"\` — only those with the password can access the video.
+- \`"unlisted"\` — only those with the private link can access the video.
+- \`"users"\` — only Vimeo members can access the video.
+`),
+    password: z
+      .string()
+      .optional()
+      .describe(`
+The password to access the video if \`acl\` is \`"password"\`.
+`),
+    showcases: z
+      .array(z.string())
+      .default([])
+      .describe(`
+An array of string IDs of showcases that you want to add the video to. The IDs can be found when browsing Vimeo. For example \`https://vimeo.com/manage/showcases/[SHOWCASE_ID]/info\`.
+`),
+    downloadable: z
+      .boolean()
+      .default(false)
+      .describe(`
+Whether or not the video can be downloaded from the Vimeo website.
+
+Only set this to \`true\` if you have unlocked this feature in your Vimeo accounting by upgrading to their "Pro" plan. If you use it while on their Freemium plan, the Vimeo API will return an \`"Invalid parameter supplied"\` error.
+`),
+    folder_id: z
+      .string()
+      .nullable()
+      .default(null)
+      .describe(`
+The ID of the folder to which the video is uploaded.
+
+When visiting one of your folders, the URL is similar to \`https://vimeo.com/manage/folders/xxxxxxxx\`. The folder_id would be \`"xxxxxxxx"\`.
+`),
+    folder_uri: z
+      .string()
+      .optional()
+      .describe(`
+Deprecated. Please use \`folder_id\` instead. The URI of the folder to which the video is uploaded.
+`),
+  })
+  .strict()
+
+export const robotVimeoStoreInstructionsWithHiddenFieldsSchema =
+  robotVimeoStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotVimeoStoreInstructionsSchema.shape.result])
+      .optional(),
+    access_token: z
+      .string()
+      .optional()
+      .describe('Legacy authentication field. Use credentials instead.'),
+  })
+
+export type RobotVimeoStoreInstructions = z.infer<typeof robotVimeoStoreInstructionsSchema>
+export type RobotVimeoStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotVimeoStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotVimeoStoreInstructionsSchema = interpolateRobot(
+  robotVimeoStoreInstructionsSchema,
+)
+export type InterpolatableRobotVimeoStoreInstructions =
+  InterpolatableRobotVimeoStoreInstructionsInput
+
+export type InterpolatableRobotVimeoStoreInstructionsInput = z.input<
+  typeof interpolatableRobotVimeoStoreInstructionsSchema
+>
+
+export const interpolatableRobotVimeoStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotVimeoStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotVimeoStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotVimeoStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotVimeoStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotVimeoStoreInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,124 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  files_per_page,
+  interpolateRobot,
+  page_number,
+  path,
+  recursive,
+  return_file_stubs,
+  robotBase,
+  robotImport,
+  wasabiBase,
+} 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: '/wasabi/import',
+        credentials: 'YOUR_WASABI_CREDENTIALS',
+        path: 'path/to/files/',
+        recursive: true,
+      },
+    },
+  },
+  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 wasabi bucket',
+  purpose_verb: 'import',
+  purpose_word: 'Wasabi',
+  purpose_words: 'Import files from Wasabi',
+  requires_credentials: true,
+  service_slug: 'file-importing',
+  slot_count: 20,
+  title: 'Import files from Wasabi',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'WasabiImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotWasabiImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(wasabiBase)
+  .extend({
+    result: z
+      .boolean()
+      .optional()
+      .describe('Whether the results of this Step should be present in the Assembly Status JSON'),
+    robot: z.literal('/wasabi/import'),
+    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\`.
+
+If it points to a directory, indicated by a trailing slash (\`/\`), then all files that are direct descendants of this directory will be imported. For example: \`images/\`.
+
+Directories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the \`recursive\` parameter.
+
+If you want to import all files from the root directory, please use \`/\` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with \`/\`, you'll receive an error: \`A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.\`
+
+You can also use an array of path strings here to import multiple paths in the same <dfn>Robot</dfn>'s <dfn>Step</dfn>.
+`),
+    recursive: recursive.describe(`
+Setting this to \`true\` will enable importing files from subfolders and sub-subfolders, etc. of the given path.
+
+Please use the pagination parameters \`page_number\` and \`files_per_page\` wisely here.
+`),
+    page_number: page_number.describe(`
+The pagination page number. For now, in order to not break backwards compatibility in non-recursive imports, this only works when recursive is set to \`true\`.
+
+When doing big imports, make sure no files are added or removed from other scripts within your path, otherwise you might get weird results with the pagination.
+`),
+    files_per_page: files_per_page.describe(`
+The pagination page size. This only works when recursive is \`true\` for now, in order to not break backwards compatibility in non-recursive imports.
+`),
+    return_file_stubs,
+  })
+  .strict()
+
+export const robotWasabiImportInstructionsWithHiddenFieldsSchema =
+  robotWasabiImportInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotWasabiImportInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotWasabiImportInstructions = z.infer<typeof robotWasabiImportInstructionsSchema>
+export type RobotWasabiImportInstructionsWithHiddenFields = z.infer<
+  typeof robotWasabiImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotWasabiImportInstructionsSchema = interpolateRobot(
+  robotWasabiImportInstructionsSchema,
+)
+export type InterpolatableRobotWasabiImportInstructions =
+  InterpolatableRobotWasabiImportInstructionsInput
+
+export type InterpolatableRobotWasabiImportInstructionsInput = z.input<
+  typeof interpolatableRobotWasabiImportInstructionsSchema
+>
+
+export const interpolatableRobotWasabiImportInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotWasabiImportInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotWasabiImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotWasabiImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotWasabiImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotWasabiImportInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,113 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { interpolateRobot, robotBase, robotUse, wasabiBase } 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: '/wasabi/store',
+        use: ':original',
+        credentials: 'YOUR_WASABI_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on Wasabi:',
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to Wasabi buckets',
+  purpose_verb: 'export',
+  purpose_word: 'Wasabi',
+  purpose_words: 'Export files to Wasabi',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Wasabi',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'WasabiStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotWasabiStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(wasabiBase)
+  .extend({
+    robot: z.literal('/wasabi/store').describe(`
+The URL to the result file will be returned in the <dfn>Assembly Status JSON</dfn>.
+`),
+    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). The path must not be a directory.
+`),
+    acl: z
+      .enum(['private', 'public-read'])
+      .default('public-read')
+      .describe(`
+The permissions used for this file.
+`),
+    headers: z
+      .record(z.string())
+      .default({ 'Content-Type': '${file.mime}' })
+      .describe(`
+An object containing a list of headers to be set for this file on Wasabi Spaces, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
+
+Object Metadata can be specified using \`x-amz-meta-*\` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).
+`),
+    sign_urls_for: z
+      .number()
+      .int()
+      .min(0)
+      .optional()
+      .describe(`
+This parameter provides signed URLs in the result JSON (in the \`signed_ssl_url\` property). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.
+`),
+  })
+  .strict()
+
+export const robotWasabiStoreInstructionsWithHiddenFieldsSchema =
+  robotWasabiStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotWasabiStoreInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotWasabiStoreInstructions = z.infer<typeof robotWasabiStoreInstructionsSchema>
+export type RobotWasabiStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotWasabiStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotWasabiStoreInstructionsSchema = interpolateRobot(
+  robotWasabiStoreInstructionsSchema,
+)
+export type InterpolatableRobotWasabiStoreInstructions =
+  InterpolatableRobotWasabiStoreInstructionsInput
+
+export type InterpolatableRobotWasabiStoreInstructionsInput = z.input<
+  typeof interpolatableRobotWasabiStoreInstructionsSchema
+>
+
+export const interpolatableRobotWasabiStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotWasabiStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotWasabiStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotWasabiStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotWasabiStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotWasabiStoreInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,153 @@
+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: 6,
+  discount_factor: 0.15000150001500018,
+  discount_pct: 84.99984999849998,
+  example_code: {
+    steps: {
+      exported: {
+        robot: '/youtube/store',
+        use: ':original',
+        credentials: 'YOUR_YOUTUBE_CREDENTIALS',
+        title: 'Transloadit: Video Example',
+        description: 'Some nice description',
+        category: 'science & technology',
+        keywords: 'transloadit, robots, botty',
+        visibility: 'private',
+      },
+    },
+  },
+  example_code_description: 'Export an uploaded video to YouTube and set some basic parameters:',
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to YouTube',
+  purpose_verb: 'export',
+  purpose_word: 'YouTube',
+  purpose_words: 'Export files to YouTube',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to YouTube',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'YoutubeStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotYoutubeStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .extend({
+    robot: z.literal('/youtube/store').describe(`
+> [!Note]
+> This <dfn>Robot</dfn> only accepts videos.
+
+## Installation
+
+Since YouTube works with OAuth, you will need to generate [Template Credentials](/c/template-credentials/) to use this <dfn>Robot</dfn>.
+
+To change the \`title\`, \`description\`, \`category\`, or \`keywords\` per video, we recommend to [inject variables into your Template](/docs/topics/templates/).
+
+## Adding a thumbnail image to your video
+
+You can add a custom thumbnail to your video on YouTube by using our \`"as"\` syntax for the \`"use"\` parameter to supply both a video and an image to the step:
+
+\`\`\`json
+"exported": {
+  "use": [
+    { "name": "video_encode_step", "as": "video" },
+    { "name": "image_resize_step", "as": "image" },
+  ],
+  ...
+},
+\`\`\`
+
+If you encounter an error such as "The authenticated user doesnʼt have permissions to upload and set custom video thumbnails", you should go to your YouTube account and try adding a custom thumbnail to one of your existing videos. Youʼll be prompted to add your phone number. Once youʼve added it, the error should go away.
+`),
+    credentials: z.string().describe(`
+The authentication Template credentials used for your YouTube account. You can generate them on the [Template Credentials page](/c/template-credentials/). Simply add the name of your YouTube channel, and you will be redirected to a Google verification page. Accept the presented permissions and you will be good to go.
+`),
+    title: z
+      .string()
+      .max(80)
+      .describe(`
+The title of the video to be displayed on YouTube.
+
+Note that since the YouTube API requires titles to be within 80 characters, longer titles may be truncated.
+`),
+    description: z.string().describe(`
+The description of the video to be displayed on YouTube. This can be up to 5000 characters, including \`\\n\` for new-lines.
+`),
+    category: z
+      .preprocess(
+        (val) => (typeof val === 'string' ? val.toLowerCase() : val),
+        z.enum([
+          'autos & vehicles',
+          'comedy',
+          'education',
+          'entertainment',
+          'film & animation',
+          'gaming',
+          'howto & style',
+          'music',
+          'news & politics',
+          'people & blogs',
+          'pets & animals',
+          'science & technology',
+          'sports',
+          'travel & events',
+        ]),
+      )
+      .describe(`
+The category to which this video will be assigned.
+`),
+    keywords: z.string().describe(`
+Tags used to describe the video, separated by commas. These tags will also be displayed on YouTube.
+`),
+    visibility: z.enum(['public', 'private', 'unlisted']).describe(`
+Defines the visibility of the uploaded video.
+`),
+  })
+  .strict()
+
+export const robotYoutubeStoreInstructionsWithHiddenFieldsSchema =
+  robotYoutubeStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotYoutubeStoreInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotYoutubeStoreInstructions = z.infer<typeof robotYoutubeStoreInstructionsSchema>
+export type RobotYoutubeStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotYoutubeStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotYoutubeStoreInstructionsSchema = interpolateRobot(
+  robotYoutubeStoreInstructionsSchema,
+)
+export type InterpolatableRobotYoutubeStoreInstructions =
+  InterpolatableRobotYoutubeStoreInstructionsInput
+
+export type InterpolatableRobotYoutubeStoreInstructionsInput = z.input<
+  typeof interpolatableRobotYoutubeStoreInstructionsSchema
+>
+
+export const interpolatableRobotYoutubeStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotYoutubeStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotYoutubeStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotYoutubeStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotYoutubeStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotYoutubeStoreInstructionsWithHiddenFieldsSchema
+>

package/src/alphalib/types/stackVersions.ts

@@ -0,0 +1,12 @@
+export const stackVersions = {
+  ffmpeg: {
+    recommendedVersion: 'v6' as const,
+    test: /^v?[567](\.\d+)?(\.\d+)?$/,
+    suggestedValues: ['v5', 'v6', 'v7'] as const,
+  },
+  imagemagick: {
+    recommendedVersion: 'v3' as const,
+    test: /^v?[23](\.\d+)?(\.\d+)?$/,
+    suggestedValues: ['v2', 'v3'] as const,
+  },
+}