@transloadit/node 4.1.3

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

@@ -0,0 +1,143 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { azureBase, 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: '/azure/store',
+        use: ':original',
+        credentials: 'YOUR_AZURE_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on Azure:',
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to Microsoft Azure',
+  purpose_verb: 'export',
+  purpose_word: 'Azure',
+  purpose_words: 'Export files to Microsoft Azure',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Microsoft Azure',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'AzureStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotAzureStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(azureBase)
+  .extend({
+    robot: z.literal('/azure/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).
+`),
+    content_type: z
+      .string()
+      .optional()
+      .describe(`
+The content type with which to store the file. By default this will be guessed by Azure.
+`),
+    content_encoding: z
+      .string()
+      .optional()
+      .describe(`
+The content encoding with which to store the file. By default this will be guessed by Azure.
+`),
+    content_language: z
+      .string()
+      .optional()
+      .describe(`
+The content language with which to store the file. By default this will be guessed by Azure.
+`),
+    content_disposition: z
+      .string()
+      .optional()
+      .describe(`
+The content disposition with which to store the file. By default this will be guessed by Azure.
+`),
+    cache_control: z
+      .string()
+      .optional()
+      .describe(`
+The cache control header with which to store the file.
+`),
+    // TODO: verify if this is correct.
+    metadata: z
+      .record(z.string())
+      .default({})
+      .describe(`
+A JavaScript object containing a list of metadata to be set for this file on Azure, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).
+`),
+    sas_expires_in: z
+      .number()
+      .int()
+      .min(0)
+      .optional()
+      .describe(`
+Set this to a number to enable shared access signatures for your stored object. This reflects the number of seconds that the signature will be valid for once the object is stored. Enabling this will attach the shared access signature (SAS) to the result URL of your object.
+`),
+    sas_permissions: z
+      .string()
+      .regex(/^[rdw]+$/)
+      .min(0)
+      .max(3)
+      .optional()
+      .describe(`
+Set this to a combination of \`r\` (read), \`w\` (write) and \`d\` (delete) for your shared access signatures (SAS) permissions.
+`),
+  })
+  .strict()
+
+export const robotAzureStoreInstructionsWithHiddenFieldsSchema =
+  robotAzureStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotAzureStoreInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotAzureStoreInstructions = z.infer<typeof robotAzureStoreInstructionsSchema>
+export type RobotAzureStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotAzureStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotAzureStoreInstructionsSchema = interpolateRobot(
+  robotAzureStoreInstructionsSchema,
+)
+export type InterpolatableRobotAzureStoreInstructions =
+  InterpolatableRobotAzureStoreInstructionsInput
+
+export type InterpolatableRobotAzureStoreInstructionsInput = z.input<
+  typeof interpolatableRobotAzureStoreInstructionsSchema
+>
+
+export const interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotAzureStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotAzureStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotAzureStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotAzureStoreInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,119 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  backblazeBase,
+  files_per_page,
+  interpolateRobot,
+  path,
+  recursive,
+  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: '/backblaze/import',
+        credentials: 'YOUR_BACKBLAZE_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 Backblaze bucket',
+  purpose_verb: 'import',
+  purpose_word: 'Backblaze',
+  purpose_words: 'Import files from Backblaze',
+  requires_credentials: true,
+  service_slug: 'file-importing',
+  slot_count: 20,
+  title: 'Import files from Backblaze',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'BackblazeImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotBackblazeImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(backblazeBase)
+  .extend({
+    robot: z.literal('/backblaze/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 a 404 \`BACKBLAZE_IMPORT_NOT_FOUND\` error.
+
+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 subdirectories and sub-subdirectories (etc.) of the given path.
+
+Please use the pagination parameters \`start_file_name\` and \`files_per_page\` wisely here.
+`),
+    start_file_name: z
+      .string()
+      .default('')
+      .describe(`
+The name of the last file from the previous paging call. This tells the <dfn>Robot</dfn> to ignore all files up to and including this file.
+`),
+    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.
+`),
+  })
+  .strict()
+
+export const robotBackblazeImportInstructionsWithHiddenFieldsSchema =
+  robotBackblazeImportInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotBackblazeImportInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotBackblazeImportInstructions = z.infer<
+  typeof robotBackblazeImportInstructionsSchema
+>
+export type RobotBackblazeImportInstructionsWithHiddenFields = z.infer<
+  typeof robotBackblazeImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotBackblazeImportInstructionsSchema = interpolateRobot(
+  robotBackblazeImportInstructionsSchema,
+)
+export type InterpolatableRobotBackblazeImportInstructions =
+  InterpolatableRobotBackblazeImportInstructionsInput
+
+export type InterpolatableRobotBackblazeImportInstructionsInput = z.input<
+  typeof interpolatableRobotBackblazeImportInstructionsSchema
+>
+
+export const interpolatableRobotBackblazeImportInstructionsWithHiddenFieldsSchema =
+  interpolateRobot(robotBackblazeImportInstructionsWithHiddenFieldsSchema)
+export type InterpolatableRobotBackblazeImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotBackblazeImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotBackblazeImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotBackblazeImportInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,104 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import { backblazeBase, 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: '/backblaze/store',
+        use: ':original',
+        credentials: 'YOUR_BACKBLAZE_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on Backblaze:',
+  extended_description: `
+## Access
+
+Your Backblaze buckets need to have the \`listBuckets\` (to obtain a bucket ID from a bucket name), \`writeFiles\` and \`listFiles\` permissions.
+`,
+  has_small_icon: true,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to Backblaze',
+  purpose_verb: 'export',
+  purpose_word: 'Backblaze',
+  purpose_words: 'Export files to Backblaze',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Backblaze',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'BackblazeStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotBackblazeStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(backblazeBase)
+  .extend({
+    robot: z.literal('/backblaze/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).
+`),
+    headers: z
+      .record(z.string())
+      .default({})
+      .describe(`
+An object containing a list of headers to be set for this file on backblaze, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
+
+[Here](https://www.backblaze.com/b2/docs/b2_upload_file.html) you can find a list of available headers.
+
+Object Metadata can be specified using \`X-Bz-Info-*\` headers.
+`),
+  })
+  .strict()
+
+export const robotBackblazeStoreInstructionsWithHiddenFieldsSchema =
+  robotBackblazeStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotBackblazeStoreInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotBackblazeStoreInstructions = z.infer<typeof robotBackblazeStoreInstructionsSchema>
+export type RobotBackblazeStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotBackblazeStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotBackblazeStoreInstructionsSchema = interpolateRobot(
+  robotBackblazeStoreInstructionsSchema,
+)
+export type InterpolatableRobotBackblazeStoreInstructions =
+  InterpolatableRobotBackblazeStoreInstructionsInput
+
+export type InterpolatableRobotBackblazeStoreInstructionsInput = z.input<
+  typeof interpolatableRobotBackblazeStoreInstructionsSchema
+>
+
+export const interpolatableRobotBackblazeStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(
+  robotBackblazeStoreInstructionsWithHiddenFieldsSchema,
+)
+export type InterpolatableRobotBackblazeStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotBackblazeStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotBackblazeStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotBackblazeStoreInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,118 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  cloudfilesBase,
+  files_per_page,
+  interpolateRobot,
+  page_number,
+  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: '/cloudfiles/import',
+        credentials: 'YOUR_CLOUDFILES_CREDENTIALS',
+        path: 'path/to/files/',
+        recursive: true,
+      },
+    },
+  },
+  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 directories of files from your Rackspace Cloud Files container',
+  purpose_verb: 'import',
+  purpose_word: 'Rackspace Cloud Files',
+  purpose_words: 'Import files from Rackspace Cloud Files',
+  requires_credentials: true,
+  service_slug: 'file-importing',
+  slot_count: 20,
+  title: 'Import files from Rackspace Cloud Files',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'CloudfilesImportRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 20,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+  stage: 'ga',
+}
+
+export const robotCloudfilesImportInstructionsSchema = robotBase
+  .merge(robotImport)
+  .merge(cloudfilesBase)
+  .extend({
+    robot: z.literal('/cloudfiles/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.
+
+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: z
+      .boolean()
+      .default(false)
+      .describe(`
+Setting this to \`true\` will enable importing files from subdirectories and sub-subdirectories (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.
+`),
+  })
+  .strict()
+
+export const robotCloudfilesImportInstructionsWithHiddenFieldsSchema =
+  robotCloudfilesImportInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotCloudfilesImportInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotCloudfilesImportInstructions = z.infer<
+  typeof robotCloudfilesImportInstructionsSchema
+>
+export type RobotCloudfilesImportInstructionsWithHiddenFields = z.infer<
+  typeof robotCloudfilesImportInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotCloudfilesImportInstructionsSchema = interpolateRobot(
+  robotCloudfilesImportInstructionsSchema,
+)
+export type InterpolatableRobotCloudfilesImportInstructions =
+  InterpolatableRobotCloudfilesImportInstructionsInput
+
+export type InterpolatableRobotCloudfilesImportInstructionsInput = z.input<
+  typeof interpolatableRobotCloudfilesImportInstructionsSchema
+>
+
+export const interpolatableRobotCloudfilesImportInstructionsWithHiddenFieldsSchema =
+  interpolateRobot(robotCloudfilesImportInstructionsWithHiddenFieldsSchema)
+export type InterpolatableRobotCloudfilesImportInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotCloudfilesImportInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotCloudfilesImportInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotCloudfilesImportInstructionsWithHiddenFieldsSchema
+>

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

@@ -0,0 +1,104 @@
+import { z } from 'zod'
+
+import type { RobotMetaInput } from './_instructions-primitives.ts'
+import {
+  cloudfilesBase,
+  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: '/cloudfiles/store',
+        use: ':original',
+        credentials: 'YOUR_CLOUDFILES_CREDENTIALS',
+        path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+      },
+    },
+  },
+  example_code_description: 'Export uploaded files to `my_target_folder` on Rackspace Cloud Files:',
+  extended_description: `
+<a id="export-to-rackspace-cloudfiles" aria-hidden="true"></a>
+
+## A note about URLs
+
+If your container is CDN-enabled, the resulting \`file.url\` indicates the path to the file in your
+CDN container, or is \`null\` otherwise.
+
+The storage container URL for this file is always available via \`file.meta.storage_url\`.
+`,
+  minimum_charge: 0,
+  output_factor: 1,
+  override_lvl1: 'File Exporting',
+  purpose_sentence: 'exports encoding results to Rackspace Cloud Files',
+  purpose_verb: 'export',
+  purpose_word: 'Rackspace Cloud Files',
+  purpose_words: 'Export files to Rackspace Cloud Files',
+  service_slug: 'file-exporting',
+  slot_count: 10,
+  title: 'Export files to Rackspace Cloud Files',
+  typical_file_size_mb: 1.2,
+  typical_file_type: 'file',
+  name: 'CloudfilesStoreRobot',
+  priceFactor: 6.6666,
+  queueSlotCount: 10,
+  isAllowedForUrlTransform: true,
+  trackOutputFileSize: false,
+  isInternal: false,
+  removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+  stage: 'ga',
+}
+
+export const robotCloudfilesStoreInstructionsSchema = robotBase
+  .merge(robotUse)
+  .merge(cloudfilesBase)
+  .extend({
+    robot: z.literal('/cloudfiles/store'),
+    path: z
+      .string()
+      .default('${unique_prefix}/${file.url_name}')
+      .describe(`
+The path at which to store the file. This value can also contain [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).
+`),
+  })
+  .strict()
+
+export const robotCloudfilesStoreInstructionsWithHiddenFieldsSchema =
+  robotCloudfilesStoreInstructionsSchema.extend({
+    result: z
+      .union([z.literal('debug'), robotCloudfilesStoreInstructionsSchema.shape.result])
+      .optional(),
+  })
+
+export type RobotCloudfilesStoreInstructions = z.infer<
+  typeof robotCloudfilesStoreInstructionsSchema
+>
+export type RobotCloudfilesStoreInstructionsWithHiddenFields = z.infer<
+  typeof robotCloudfilesStoreInstructionsWithHiddenFieldsSchema
+>
+
+export const interpolatableRobotCloudfilesStoreInstructionsSchema = interpolateRobot(
+  robotCloudfilesStoreInstructionsSchema,
+)
+export type InterpolatableRobotCloudfilesStoreInstructions =
+  InterpolatableRobotCloudfilesStoreInstructionsInput
+
+export type InterpolatableRobotCloudfilesStoreInstructionsInput = z.input<
+  typeof interpolatableRobotCloudfilesStoreInstructionsSchema
+>
+
+export const interpolatableRobotCloudfilesStoreInstructionsWithHiddenFieldsSchema =
+  interpolateRobot(robotCloudfilesStoreInstructionsWithHiddenFieldsSchema)
+export type InterpolatableRobotCloudfilesStoreInstructionsWithHiddenFields = z.infer<
+  typeof interpolatableRobotCloudfilesStoreInstructionsWithHiddenFieldsSchema
+>
+export type InterpolatableRobotCloudfilesStoreInstructionsWithHiddenFieldsInput = z.input<
+  typeof interpolatableRobotCloudfilesStoreInstructionsWithHiddenFieldsSchema
+>