@transloadit/zod 4.4.1 → 5.0.0

package/dist/v4/robots/swift-store.d.ts

@@ -1,15 +1,16 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts';
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
 import { z } from 'zod/v4';
 export declare const meta: RobotMetaInput;
 export declare const robotSwiftStoreInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
@@ -35,7 +36,6 @@ export declare const robotSwiftStoreInstructionsSchema: z.ZodObject<{
     }, z.core.$strict>]>>;
     credentials: z.ZodOptional<z.ZodString>;
     bucket: z.ZodOptional<z.ZodString>;
-    bucket_region: z.ZodOptional<z.ZodString>;
     host: z.ZodOptional<z.ZodString>;
     key: z.ZodOptional<z.ZodString>;
     secret: z.ZodOptional<z.ZodString>;
@@ -48,15 +48,17 @@ export declare const robotSwiftStoreInstructionsSchema: z.ZodObject<{
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     sign_urls_for: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotSwiftStoreInstructionsSchema.shape>;
 export declare const robotSwiftStoreInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
     }>>;
@@ -81,7 +83,6 @@ export declare const robotSwiftStoreInstructionsWithHiddenFieldsSchema: z.ZodObj
     }, z.core.$strict>]>>;
     credentials: z.ZodOptional<z.ZodString>;
     bucket: z.ZodOptional<z.ZodString>;
-    bucket_region: z.ZodOptional<z.ZodString>;
     host: z.ZodOptional<z.ZodString>;
     key: z.ZodOptional<z.ZodString>;
     secret: z.ZodOptional<z.ZodString>;
@@ -94,24 +95,22 @@ export declare const robotSwiftStoreInstructionsWithHiddenFieldsSchema: z.ZodObj
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     sign_urls_for: z.ZodOptional<z.ZodNumber>;
     result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
-}, z.core.$strict>;
-export type RobotSwiftStoreInstructions = z.infer<typeof robotSwiftStoreInstructionsSchema>;
-export type RobotSwiftStoreInstructionsWithHiddenFields = z.infer<typeof robotSwiftStoreInstructionsWithHiddenFieldsSchema>;
-export declare const interpolatableRobotSwiftStoreInstructionsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotSwiftStoreInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     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]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    result: z.ZodPrefault<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<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<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")[]>>]>>;
@@ -131,35 +130,32 @@ export declare const interpolatableRobotSwiftStoreInstructionsSchema: z.ZodObjec
     }, z.core.$strict>]>>;
     credentials: z.ZodOptional<z.ZodString>;
     bucket: z.ZodOptional<z.ZodString>;
-    bucket_region: z.ZodOptional<z.ZodString>;
     host: z.ZodOptional<z.ZodString>;
     key: z.ZodOptional<z.ZodString>;
     secret: z.ZodOptional<z.ZodString>;
     robot: z.ZodLiteral<"/swift/store">;
-    path: z.ZodDefault<z.ZodString>;
-    acl: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    path: z.ZodPrefault<z.ZodString>;
+    acl: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         private: "private";
         "public-read": "public-read";
     }>]>>;
-    headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    headers: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     sign_urls_for: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
-}, z.core.$strict>;
-export type InterpolatableRobotSwiftStoreInstructions = InterpolatableRobotSwiftStoreInstructionsInput;
-export type InterpolatableRobotSwiftStoreInstructionsInput = z.input<typeof interpolatableRobotSwiftStoreInstructionsSchema>;
-export declare const interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     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>]>]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     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<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<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")[]>>]>>;
@@ -179,20 +175,25 @@ export declare const interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSc
     }, z.core.$strict>]>>;
     credentials: z.ZodOptional<z.ZodString>;
     bucket: z.ZodOptional<z.ZodString>;
-    bucket_region: z.ZodOptional<z.ZodString>;
     host: z.ZodOptional<z.ZodString>;
     key: z.ZodOptional<z.ZodString>;
     secret: z.ZodOptional<z.ZodString>;
     robot: z.ZodLiteral<"/swift/store">;
-    path: z.ZodDefault<z.ZodString>;
-    acl: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    path: z.ZodPrefault<z.ZodString>;
+    acl: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         private: "private";
         "public-read": "public-read";
     }>]>>;
-    headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    headers: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     sign_urls_for: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
-    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
 }, z.core.$strict>;
-export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotSwiftStoreInstructions = Instructions['output'];
+export type RobotSwiftStoreInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotSwiftStoreInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotSwiftStoreInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotSwiftStoreInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=swift-store.d.ts.map

package/dist/v4/robots/swift-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swift-store.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/swift-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAI1B,eAAO,MAAM,IAAI,EAAE,cAoClB,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAkCnC,CAAA;AAEX,eAAO,MAAM,iDAAiD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAK1D,CAAA;AAEJ,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAC3F,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,iDAAiD,CACzD,CAAA;AAED,eAAO,MAAM,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE3D,CAAA;AACD,MAAM,MAAM,yCAAyC,GACnD,8CAA8C,CAAA;AAEhD,MAAM,MAAM,8CAA8C,GAAG,CAAC,CAAC,KAAK,CAClE,OAAO,+CAA+C,CACvD,CAAA;AAED,eAAO,MAAM,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE3E,CAAA;AACD,MAAM,MAAM,yDAAyD,GAAG,CAAC,CAAC,KAAK,CAC7E,OAAO,+DAA+D,CACvE,CAAA;AACD,MAAM,MAAM,8DAA8D,GAAG,CAAC,CAAC,KAAK,CAClF,OAAO,+DAA+D,CACvE,CAAA"}
+{"version":3,"file":"swift-store.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/swift-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAc1B,eAAO,MAAM,IAAI,EAAE,cAWlB,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAiBnC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,iCAAiC,CAAC,KAAK,CACtC,CAAA;AAEtD,eAAO,MACa,iDAAiD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBACnD,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAC/B,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAC9E,CAAA;AAEnB,KAAK,YAAY,GAAG,uBAAuB,CAAC,OAAO,eAAe,CAAC,CAAA;AAEnE,MAAM,MAAM,2BAA2B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAChE,MAAM,MAAM,2CAA2C,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AACtF,MAAM,MAAM,yCAAyC,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC3F,MAAM,MAAM,8CAA8C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAChG,MAAM,MAAM,yDAAyD,GACnE,YAAY,CAAC,4BAA4B,CAAC,CAAA;AAC5C,MAAM,MAAM,8DAA8D,GACxE,YAAY,CAAC,2BAA2B,CAAC,CAAA"}

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

@@ -1,81 +1,33 @@
 import { z } from 'zod/v4';
-import { interpolateRobot, robotBase, robotUse, swiftBase } from "./_instructions-primitives.js";
+import { createStorageStoreExample, defineRobot, robotBase, robotStoreMeta, robotUse, signedSslUrlLifetime, storageAcl, storeFilePath, swiftBase, } from "./_instructions-primitives.js";
 export const meta = {
-    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:',
+    ...robotStoreMeta,
+    example_code: createStorageStoreExample('/swift/store', 'YOUR_SWIFT_CREDENTIALS'),
+    example_code_description: 'Export uploaded files to `my_target_folder` in an OpenStack Swift container:',
     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_sentence: 'exports encoding results to OpenStack Swift containers',
     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',
+    purpose_words: 'Export files to OpenStack Swift',
+    title: 'Export files to OpenStack Swift',
     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.
-`),
+The URL to the result file in your OpenStack Swift container will be returned in the <dfn>Assembly Status JSON</dfn>.`),
+    path: storeFilePath,
+    acl: storageAcl,
     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).
+An object containing a list of headers to be set for this file in your OpenStack Swift container, 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.
-`),
+    sign_urls_for: signedSslUrlLifetime,
 })
     .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);
+export const robotDefinition = defineRobot(meta, robotSwiftStoreInstructionsSchema);
+export const { withHiddenFields: robotSwiftStoreInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotSwiftStoreInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotSwiftStoreInstructionsWithHiddenFieldsSchema, } = robotDefinition;

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

@@ -1,15 +1,16 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts';
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
 import { z } from 'zod/v4';
 export declare const meta: RobotMetaInput;
 export declare const robotTextSpeakInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
@@ -36,9 +37,9 @@ export declare const robotTextSpeakInstructionsSchema: z.ZodObject<{
     robot: z.ZodLiteral<"/text/speak">;
     prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     provider: z.ZodDefault<z.ZodEnum<{
-        auto: "auto";
         aws: "aws";
         gcp: "gcp";
+        auto: "auto";
     }>>;
     target_language: z.ZodDefault<z.ZodString>;
     voice: z.ZodDefault<z.ZodEnum<{
@@ -51,15 +52,17 @@ export declare const robotTextSpeakInstructionsSchema: z.ZodObject<{
     }>>;
     ssml: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotTextSpeakInstructionsSchema.shape>;
 export declare const robotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
     }>>;
@@ -85,9 +88,9 @@ export declare const robotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObje
     robot: z.ZodLiteral<"/text/speak">;
     prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     provider: z.ZodDefault<z.ZodEnum<{
-        auto: "auto";
         aws: "aws";
         gcp: "gcp";
+        auto: "auto";
     }>>;
     target_language: z.ZodDefault<z.ZodString>;
     voice: z.ZodDefault<z.ZodEnum<{
@@ -100,24 +103,22 @@ export declare const robotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObje
     }>>;
     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<{
+}, z.core.$strict>, interpolatableRobotTextSpeakInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     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]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    result: z.ZodPrefault<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<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<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")[]>>]>>;
@@ -137,13 +138,13 @@ export declare const interpolatableRobotTextSpeakInstructionsSchema: z.ZodObject
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/text/speak">;
     prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    provider: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
-        auto: "auto";
+    provider: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         aws: "aws";
         gcp: "gcp";
+        auto: "auto";
     }>]>>;
-    target_language: z.ZodDefault<z.ZodString>;
-    voice: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    target_language: z.ZodPrefault<z.ZodString>;
+    voice: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         "female-1": "female-1";
         "female-2": "female-2";
         "female-3": "female-3";
@@ -151,24 +152,22 @@ export declare const interpolatableRobotTextSpeakInstructionsSchema: z.ZodObject
         "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<{
+    ssml: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+}, z.core.$strict>, interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     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>]>]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     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<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<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")[]>>]>>;
@@ -188,13 +187,13 @@ export declare const interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSch
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/text/speak">;
     prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    provider: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
-        auto: "auto";
+    provider: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         aws: "aws";
         gcp: "gcp";
+        auto: "auto";
     }>]>>;
-    target_language: z.ZodDefault<z.ZodString>;
-    voice: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    target_language: z.ZodPrefault<z.ZodString>;
+    voice: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         "female-1": "female-1";
         "female-2": "female-2";
         "female-3": "female-3";
@@ -202,9 +201,15 @@ export declare const interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSch
         "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]>>]>>;
+    ssml: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
 }, z.core.$strict>;
-export type InterpolatableRobotTextSpeakInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotTextSpeakInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotTextSpeakInstructions = Instructions['output'];
+export type RobotTextSpeakInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotTextSpeakInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotTextSpeakInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotTextSpeakInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=text-speak.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"text-speak.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/text-speak.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAU1B,eAAO,MAAM,IAAI,EAAE,cAkElB,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"}
+{"version":3,"file":"text-speak.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/text-speak.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAY1B,eAAO,MAAM,IAAI,EAAE,cA+ClB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAuClC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,gCAAgC,CAAC,KAAK,CACtC,CAAA;AAErD,eAAO,MACa,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAClD,8CAA8C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAC9B,8DAA8D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAC7E,CAAA;AAEnB,KAAK,YAAY,GAAG,uBAAuB,CAAC,OAAO,eAAe,CAAC,CAAA;AAEnE,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAC/D,MAAM,MAAM,0CAA0C,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AACrF,MAAM,MAAM,wCAAwC,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC1F,MAAM,MAAM,6CAA6C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC/F,MAAM,MAAM,wDAAwD,GAClE,YAAY,CAAC,4BAA4B,CAAC,CAAA;AAC5C,MAAM,MAAM,6DAA6D,GACvE,YAAY,CAAC,2BAA2B,CAAC,CAAA"}

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

@@ -1,20 +1,12 @@
 import { z } from 'zod/v4';
-import { autoProviderDescription, awsGcpAiProviderSchema, interpolateRobot, robotBase, robotUse, } from "./_instructions-primitives.js";
+import { awsGcpAiProviderSchema, createProcessingExample, defineRobot, robotArtificialIntelligenceMeta, robotBase, robotParameterDocs, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    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',
-            },
-        },
-    },
+    ...robotArtificialIntelligenceMeta,
+    example_code: createProcessingExample('synthesized', '/text/speak', {
+        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]
@@ -44,27 +36,16 @@ export const meta = {
 </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)
@@ -80,11 +61,7 @@ Another common use case is making your product accessible to people with a readi
         .describe(`
 Which text to speak. You can also set this to \`null\` and supply an input text file.
 `),
-    provider: awsGcpAiProviderSchema.describe(`
-${autoProviderDescription}
-
-Set this to \`"aws"\` or \`"gcp"\` to force a specific provider.
-`),
+    provider: awsGcpAiProviderSchema.describe(robotParameterDocs.ai_provider.description),
     // TODO determine the list of languages
     target_language: z
         .string()
@@ -99,7 +76,7 @@ The language should be specified in the [BCP-47](https://www.rfc-editor.org/rfc/
         .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)
@@ -110,8 +87,5 @@ Please see the supported syntaxes for [AWS](https://docs.aws.amazon.com/polly/la
 `),
 })
     .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);
+export const robotDefinition = defineRobot(meta, robotTextSpeakInstructionsSchema);
+export const { withHiddenFields: robotTextSpeakInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotTextSpeakInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotTextSpeakInstructionsWithHiddenFieldsSchema, } = robotDefinition;