@transloadit/zod 4.1.5 → 4.1.7

package/dist/v4/robots/swift-store.js

@@ -0,0 +1,82 @@
+import { z } from 'zod/v4';
+import { interpolateRobot, robotBase, robotUse, swiftBase } from "./_instructions-primitives.js";
+export const meta = {
+    allowed_for_url_transform: true,
+    bytescount: 6,
+    discount_factor: 0.15000150001500018,
+    discount_pct: 84.99984999849998,
+    example_code: {
+        steps: {
+            exported: {
+                robot: '/swift/store',
+                use: ':original',
+                credentials: 'YOUR_SWIFT_CREDENTIALS',
+                path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+            },
+        },
+    },
+    example_code_description: 'Export uploaded files to `my_target_folder` on Swift:',
+    has_small_icon: true,
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'File Exporting',
+    purpose_sentence: 'exports encoding results to OpenStack Swift buckets',
+    purpose_verb: 'export',
+    purpose_word: 'OpenStack Swift',
+    purpose_words: 'Export files to OpenStack/Swift',
+    service_slug: 'file-exporting',
+    slot_count: 10,
+    title: 'Export files to OpenStack Swift Spaces',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+    name: 'SwiftStoreRobot',
+    priceFactor: 6.6666,
+    queueSlotCount: 10,
+    isAllowedForUrlTransform: true,
+    trackOutputFileSize: false,
+    isInternal: false,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+    stage: 'ga',
+};
+export const robotSwiftStoreInstructionsSchema = robotBase
+    .merge(robotUse)
+    .merge(swiftBase)
+    .extend({
+    robot: z.literal('/swift/store').describe(`
+The URL to the result file in your OpenStack bucket 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(), z.string())
+        .default({ 'Content-Type': '${file.mime}' })
+        .describe(`
+An object containing a list of headers to be set for this file on swift 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 robotSwiftStoreInstructionsWithHiddenFieldsSchema = robotSwiftStoreInstructionsSchema.extend({
+    result: z
+        .union([z.literal('debug'), robotSwiftStoreInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotSwiftStoreInstructionsSchema = interpolateRobot(robotSwiftStoreInstructionsSchema);
+export const interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(robotSwiftStoreInstructionsWithHiddenFieldsSchema);

package/dist/v4/robots/text-speak.d.ts

@@ -0,0 +1,190 @@
+import { z } from 'zod/v4';
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+export declare const meta: RobotMetaInput;
+export declare const robotTextSpeakInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/text/speak">;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    provider: z.ZodEnum<{
+        aws: "aws";
+        gcp: "gcp";
+        replicate: "replicate";
+        fal: "fal";
+        transloadit: "transloadit";
+    }>;
+    target_language: z.ZodDefault<z.ZodString>;
+    voice: z.ZodDefault<z.ZodEnum<{
+        "female-1": "female-1";
+        "female-2": "female-2";
+        "female-3": "female-3";
+        "female-child-1": "female-child-1";
+        "male-1": "male-1";
+        "male-child-1": "male-child-1";
+    }>>;
+    ssml: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const robotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/text/speak">;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    provider: z.ZodEnum<{
+        aws: "aws";
+        gcp: "gcp";
+        replicate: "replicate";
+        fal: "fal";
+        transloadit: "transloadit";
+    }>;
+    target_language: z.ZodDefault<z.ZodString>;
+    voice: z.ZodDefault<z.ZodEnum<{
+        "female-1": "female-1";
+        "female-2": "female-2";
+        "female-3": "female-3";
+        "female-child-1": "female-child-1";
+        "male-1": "male-1";
+        "male-child-1": "male-child-1";
+    }>>;
+    ssml: z.ZodDefault<z.ZodBoolean>;
+    result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, z.core.$strict>;
+export type RobotTextSpeakInstructions = z.infer<typeof robotTextSpeakInstructionsSchema>;
+export type RobotTextSpeakInstructionsWithHiddenFields = z.infer<typeof robotTextSpeakInstructionsWithHiddenFieldsSchema>;
+export declare const interpolatableRobotTextSpeakInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/text/speak">;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    provider: z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        aws: "aws";
+        gcp: "gcp";
+        replicate: "replicate";
+        fal: "fal";
+        transloadit: "transloadit";
+    }>]>;
+    target_language: z.ZodDefault<z.ZodString>;
+    voice: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        "female-1": "female-1";
+        "female-2": "female-2";
+        "female-3": "female-3";
+        "female-child-1": "female-child-1";
+        "male-1": "male-1";
+        "male-child-1": "male-child-1";
+    }>]>>;
+    ssml: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+}, z.core.$strict>;
+export type InterpolatableRobotTextSpeakInstructions = InterpolatableRobotTextSpeakInstructionsInput;
+export type InterpolatableRobotTextSpeakInstructionsInput = z.input<typeof interpolatableRobotTextSpeakInstructionsSchema>;
+export declare const interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/text/speak">;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    provider: z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        aws: "aws";
+        gcp: "gcp";
+        replicate: "replicate";
+        fal: "fal";
+        transloadit: "transloadit";
+    }>]>;
+    target_language: z.ZodDefault<z.ZodString>;
+    voice: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        "female-1": "female-1";
+        "female-2": "female-2";
+        "female-3": "female-3";
+        "female-child-1": "female-child-1";
+        "male-1": "male-1";
+        "male-child-1": "male-child-1";
+    }>]>>;
+    ssml: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+}, z.core.$strict>;
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema>;
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=text-speak.d.ts.map

package/dist/v4/robots/text-speak.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-speak.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/text-speak.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAQnE,eAAO,MAAM,IAAI,EAAE,cAmElB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA2ClC,CAAA;AAEX,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAGzD,CAAA;AAEJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AACzF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,gDAAgD,CACxD,CAAA;AAED,eAAO,MAAM,8CAA8C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE1D,CAAA;AACD,MAAM,MAAM,wCAAwC,GAAG,6CAA6C,CAAA;AAEpG,MAAM,MAAM,6CAA6C,GAAG,CAAC,CAAC,KAAK,CACjE,OAAO,8CAA8C,CACtD,CAAA;AAED,eAAO,MAAM,8DAA8D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE1E,CAAA;AACD,MAAM,MAAM,wDAAwD,GAAG,CAAC,CAAC,KAAK,CAC5E,OAAO,8DAA8D,CACtE,CAAA;AACD,MAAM,MAAM,6DAA6D,GAAG,CAAC,CAAC,KAAK,CACjF,OAAO,8DAA8D,CACtE,CAAA"}

package/dist/v4/robots/text-speak.js

@@ -0,0 +1,118 @@
+import { z } from 'zod/v4';
+import { aiProviderSchema, interpolateRobot, robotBase, robotUse, } from "./_instructions-primitives.js";
+export const meta = {
+    allowed_for_url_transform: true,
+    bytescount: 1,
+    discount_factor: 1,
+    discount_pct: 0,
+    example_code: {
+        steps: {
+            synthesized: {
+                robot: '/text/speak',
+                use: ':original',
+                provider: 'aws',
+                voice: 'female-1',
+                target_language: 'en-US',
+            },
+        },
+    },
+    example_code_description: 'Synthesize speech from uploaded text documents, using a female voice in American English:',
+    extended_description: `
+> [!Warning]
+> Transloadit aims to be deterministic, but this <dfn>Robot</dfn> uses third-party AI services. The providers (AWS, GCP) will evolve their models over time, giving different responses for the same input media. Avoid relying on exact responses in your tests and application.
+
+## Supported languages and voices
+
+{% for provider in text_speak_voices %}
+
+### {{provider[0] | upcase }}
+
+<table class="table">
+  <thead>
+    <tr>
+      <th>Language</th>
+      <th>Voices</th>
+    </tr>
+  </thead>
+  <tbody>
+    {%- for language in provider[1] %}
+      <tr>
+        <td><strong>{{language[0]}}</strong></td>
+        <td>{{ language[1] | join: ", " }}</td>
+      </tr>
+    {%- endfor %}
+  </tbody>
+</table>
+{% endfor %}
+`,
+    minimum_charge: 1048576,
+    output_factor: 1,
+    override_lvl1: 'Artificial Intelligence',
+    purpose_sentence: 'synthesizes speech in documents',
+    purpose_verb: 'speak',
+    purpose_word: 'synthesize speech',
+    purpose_words: 'Synthesize speech in documents',
+    service_slug: 'artificial-intelligence',
+    slot_count: 10,
+    title: 'Speak text',
+    typical_file_size_mb: 1,
+    typical_file_type: 'document',
+    name: 'TextSpeakRobot',
+    priceFactor: 1,
+    queueSlotCount: 10,
+    minimumChargeUsd: 0.05,
+    isAllowedForUrlTransform: true,
+    trackOutputFileSize: true,
+    isInternal: false,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+    stage: 'ga',
+};
+export const robotTextSpeakInstructionsSchema = robotBase
+    .merge(robotUse)
+    .extend({
+    robot: z.literal('/text/speak').describe(`
+You can use the audio that we return in your application, or you can pass the audio down to other <dfn>Robots</dfn> to add a voice track to a video for example.
+
+Another common use case is making your product accessible to people with a reading disability.
+`),
+    prompt: z
+        .string()
+        .nullish()
+        .describe(`
+Which text to speak. You can also set this to \`null\` and supply an input text file.
+`),
+    provider: aiProviderSchema.describe(`
+Which AI provider to leverage.
+
+Transloadit outsources this task and abstracts the interface so you can expect the same data structures, but different latencies and information being returned. Different cloud vendors have different areas they shine in, and we recommend to try out and see what yields the best results for your use case.
+`),
+    // TODO determine the list of languages
+    target_language: z
+        .string()
+        .default('en-US')
+        .describe(`
+The written language of the document. This will also be the language of the spoken text.
+
+The language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format, such as \`"en-GB"\`, \`"de-DE"\` or \`"fr-FR"\`. Please consult the list of supported languages and voices.
+`),
+    voice: z
+        .enum(['female-1', 'female-2', 'female-3', 'female-child-1', 'male-1', 'male-child-1'])
+        .default('female-1')
+        .describe(`
+The gender to be used for voice synthesis. Please consult the list of supported languages and voices.
+      `),
+    ssml: z
+        .boolean()
+        .default(false)
+        .describe(`
+Supply [Speech Synthesis Markup Language](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) instead of raw text, in order to gain more control over how your text is voiced, including rests and pronounciations.
+
+Please see the supported syntaxes for [AWS](https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html) and [GCP](https://cloud.google.com/text-to-speech/docs/ssml).
+`),
+})
+    .strict();
+export const robotTextSpeakInstructionsWithHiddenFieldsSchema = robotTextSpeakInstructionsSchema.extend({
+    result: z.union([z.literal('debug'), robotTextSpeakInstructionsSchema.shape.result]).optional(),
+});
+export const interpolatableRobotTextSpeakInstructionsSchema = interpolateRobot(robotTextSpeakInstructionsSchema);
+export const interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema = interpolateRobot(robotTextSpeakInstructionsWithHiddenFieldsSchema);