@transloadit/zod 4.5.0 → 5.0.0

package/dist/v4/robots/file-preview.js

@@ -1,42 +1,23 @@
+import { optionalWithV3Semantics } from "../lib/sdkZodOptional.js";
 import { z } from 'zod/v4';
-import { color_with_alpha, complexHeightSchema, complexWidthSchema, interpolateRobot, optimize_priority, resize_strategy, robotBase, robotUse, } from "./_instructions-primitives.js";
+import { color_with_alpha, complexHeightSchema, complexWidthSchema, createProcessingExample, defineRobot, optimize_priority, resize_strategy, robotBase, robotMediaCatalogingMeta, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    bytescount: 1,
-    discount_factor: 1,
-    discount_pct: 0,
-    example_code: {
-        steps: {
-            previewed: {
-                robot: '/file/preview',
-                use: ':original',
-                height: 400,
-                width: 300,
-                format: 'png',
-            },
-        },
-    },
+    ...robotMediaCatalogingMeta,
+    example_code: createProcessingExample('previewed', '/file/preview', {
+        height: 400,
+        width: 300,
+        format: 'png',
+    }),
     example_code_description: 'Generate a preview thumbnail for any uploaded file:',
-    minimum_charge: 1048576,
-    output_factor: 1,
-    override_lvl1: 'Media Cataloging',
     purpose_sentence: 'generates a thumbnail for any uploaded file to preview its content, similar to the thumbnails in desktop file managers',
     purpose_verb: 'generate',
     purpose_word: 'generate',
     purpose_words: 'Generate a preview thumbnail',
-    service_slug: 'media-cataloging',
-    slot_count: 15,
     title: 'Generate a preview thumbnail',
-    typical_file_size_mb: 1.2,
-    typical_file_type: 'file',
     name: 'FilePreviewRobot',
-    priceFactor: 1,
-    queueSlotCount: 15,
     minimumCharge: 1048576,
-    isAllowedForUrlTransform: true,
     trackOutputFileSize: true,
     importRanges: ['0-19999999', '-1000000'],
-    isInternal: false,
-    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
     stage: 'beta',
 };
 export const robotFilePreviewInstructionsSchema = robotBase
@@ -77,7 +58,7 @@ If set to \`false\`, smaller images will not be stretched to the desired \`width
 
 Note that this parameter only affects strategies that produce a still image. Animated clips generated by the \`clip\` strategy are not affected.
 `),
-    strategy: z
+    strategy: optionalWithV3Semantics(z
         .object({
         archive: z.array(z.string()).default(['icon']),
         audio: z.array(z.string()).default(['artwork', 'waveform', 'icon']),
@@ -86,8 +67,7 @@ Note that this parameter only affects strategies that produce a still image. Ani
         unknown: z.array(z.string()).default(['icon']),
         video: z.array(z.string()).default(['artwork', 'frame', 'icon']),
         webpage: z.array(z.string()).default(['render', 'icon']),
-    })
-        .optional()
+    }))
         .describe(`
 Definition of the thumbnail generation process per file category. The parameter must be an object whose keys can be one of the file categories: \`audio\`, \`video\`, \`image\`, \`document\`, \`archive\`, \`webpage\`, and \`unknown\`. The corresponding value is an array of strategies for the specific file category. See the above section for a list of all available strategies.
 
@@ -107,10 +87,10 @@ The parameter defaults to the following definition:
 }
 \`\`\`
 `),
-    artwork_outer_color: color_with_alpha.optional().describe(`
+    artwork_outer_color: optionalWithV3Semantics(color_with_alpha).describe(`
   The color used in the outer parts of the artwork's gradient.
   `),
-    artwork_center_color: color_with_alpha.optional().describe(`
+    artwork_center_color: optionalWithV3Semantics(color_with_alpha).describe(`
   The color used in the center of the artwork's gradient.
   `),
     waveform_center_color: color_with_alpha.default('#000000ff').describe(`
@@ -143,9 +123,9 @@ Width of the waveform, in pixels. Only used if the \`waveform\` strategy for aud
         .describe(`
 The style of the icon generated if the \`icon\` strategy is applied. The default style, \`with-text\`, includes an icon showing the file type and a text box below it, whose content can be controlled by the \`icon_text_content\` parameter and defaults to the file extension (e.g. MP4, JPEG). The \`square\` style only includes a square variant of the icon showing the file type. Below are exemplary previews generated for a text file utilizing the different styles:
 
-<br><br> <strong>\`with-text\` style:</strong> <br>
+<br /><br /> <strong>\`with-text\` style:</strong> <br />
 ![Image with text style]({{site.asset_cdn}}/assets/images/file-preview/icon-with-text.png)
-<br><br> <strong>\`square\` style:</strong> <br>
+<br /><br /> <strong>\`square\` style:</strong> <br />
 ![Image with square style]({{site.asset_cdn}}/assets/images/file-preview/icon-square.png)
 `),
     icon_text_color: color_with_alpha.default('#a2a2a2').describe(`
@@ -170,14 +150,14 @@ The content of the text box in generated icons. Only used if the \`icon_style\`
         .describe(`
 Specifies whether the generated preview image should be optimized to reduce the image's file size while keeping their quaility. If enabled, the images will be optimized using [🤖/image/optimize](/docs/robots/image-optimize/).
 `),
-    optimize_priority: optimize_priority.describe(`
-Specifies whether conversion speed or compression ratio is prioritized when optimizing images. Only used if \`optimize\` is enabled. Please see the [🤖/image/optimize documentation](/docs/robots/image-optimize/#param-priority) for more details.
+    optimize_priority: optimize_priority.default('conversion-speed').describe(`
+Specifies whether conversion speed or compression ratio is prioritized when optimizing images. Only used if \`optimize\` is enabled. Please see the [🤖/image/optimize documentation](/docs/robots/image-optimize/#priority) for more details.
 `),
     optimize_progressive: z
         .boolean()
         .default(false)
         .describe(`
-Specifies whether images should be interlaced, which makes the result image load progressively in browsers. Only used if \`optimize\` is enabled. Please see the [🤖/image/optimize documentation](/docs/robots/image-optimize/#param-progressive) for more details.
+Specifies whether images should be interlaced, which makes the result image load progressively in browsers. Only used if \`optimize\` is enabled. Please see the [🤖/image/optimize documentation](/docs/robots/image-optimize/#progressive) for more details.
 `),
     clip_format: z
         .enum(['apng', 'avif', 'gif', 'webp'])
@@ -218,10 +198,5 @@ Specifies whether the generated animated image should loop forever (\`true\`) or
 `),
 })
     .strict();
-export const robotFilePreviewInstructionsWithHiddenFieldsSchema = robotFilePreviewInstructionsSchema.extend({
-    result: z
-        .union([z.literal('debug'), robotFilePreviewInstructionsSchema.shape.result])
-        .optional(),
-});
-export const interpolatableRobotFilePreviewInstructionsSchema = interpolateRobot(robotFilePreviewInstructionsSchema);
-export const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema = interpolateRobot(robotFilePreviewInstructionsWithHiddenFieldsSchema);
+export const robotDefinition = defineRobot(meta, robotFilePreviewInstructionsSchema);
+export const { withHiddenFields: robotFilePreviewInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotFilePreviewInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema, } = robotDefinition;

package/dist/v4/robots/file-read.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 robotFileReadInstructionsSchema: 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,15 +36,17 @@ export declare const robotFileReadInstructionsSchema: z.ZodObject<{
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/file/read">;
 }, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotFileReadInstructionsSchema.shape>;
 export declare const robotFileReadInstructionsWithHiddenFieldsSchema: 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";
     }>>;
@@ -68,24 +71,22 @@ export declare const robotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObjec
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/file/read">;
     result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
-}, z.core.$strict>;
-export type RobotFileReadInstructions = z.infer<typeof robotFileReadInstructionsSchema>;
-export type RobotFileReadInstructionsWithHiddenFields = z.infer<typeof robotFileReadInstructionsWithHiddenFieldsSchema>;
-export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotFileReadInstructionsSchema: 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")[]>>]>>;
@@ -104,23 +105,21 @@ export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<
         fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/file/read">;
-}, z.core.$strict>;
-export type InterpolatableRobotFileReadInstructions = InterpolatableRobotFileReadInstructionsInput;
-export type InterpolatableRobotFileReadInstructionsInput = z.input<typeof interpolatableRobotFileReadInstructionsSchema>;
-export declare const interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema: 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")[]>>]>>;
@@ -139,8 +138,14 @@ export declare const interpolatableRobotFileReadInstructionsWithHiddenFieldsSche
         fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>]>>;
     robot: z.ZodLiteral<"/file/read">;
-    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 InterpolatableRobotFileReadInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotFileReadInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotFileReadInstructions = Instructions['output'];
+export type RobotFileReadInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotFileReadInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotFileReadInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotFileReadInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotFileReadInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=file-read.d.ts.map

package/dist/v4/robots/file-read.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-read.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/file-read.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,cAiClB,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBASjC,CAAA;AAEX,eAAO,MAAM,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAGxD,CAAA;AAEJ,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AACvF,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,+CAA+C,CACvD,CAAA;AAED,eAAO,MAAM,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAEzD,CAAA;AACD,MAAM,MAAM,uCAAuC,GAAG,4CAA4C,CAAA;AAElG,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,6CAA6C,CACrD,CAAA;AAED,eAAO,MAAM,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAEzE,CAAA;AACD,MAAM,MAAM,uDAAuD,GAAG,CAAC,CAAC,KAAK,CAC3E,OAAO,6DAA6D,CACrE,CAAA;AACD,MAAM,MAAM,4DAA4D,GAAG,CAAC,CAAC,KAAK,CAChF,OAAO,6DAA6D,CACrE,CAAA"}
+{"version":3,"file":"file-read.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/file-read.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;AAU1B,eAAO,MAAM,IAAI,EAAE,cAelB,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBASjC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,+BAA+B,CAAC,KAAK,CACtC,CAAA;AAEpD,eAAO,MACa,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBACjD,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAC7B,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAC5E,CAAA;AAEnB,KAAK,YAAY,GAAG,uBAAuB,CAAC,OAAO,eAAe,CAAC,CAAA;AAEnE,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAC9D,MAAM,MAAM,yCAAyC,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AACpF,MAAM,MAAM,uCAAuC,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AACzF,MAAM,MAAM,4CAA4C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC9F,MAAM,MAAM,uDAAuD,GACjE,YAAY,CAAC,4BAA4B,CAAC,CAAA;AAC5C,MAAM,MAAM,4DAA4D,GACtE,YAAY,CAAC,2BAA2B,CAAC,CAAA"}

package/dist/v4/robots/file-read.js

@@ -1,27 +1,13 @@
 import { z } from 'zod/v4';
-import { interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
+import { createProcessingExample, defineRobot, robotBase, robotDocumentProcessingMeta, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    bytescount: 5,
-    discount_factor: 0.2,
-    discount_pct: 80,
-    example_code: {
-        steps: {
-            read: {
-                robot: '/file/read',
-                use: ':original',
-            },
-        },
-    },
+    ...robotDocumentProcessingMeta,
+    example_code: createProcessingExample('read', '/file/read'),
     example_code_description: 'Read UTF-8 text content from an uploaded file:',
-    minimum_charge: 512000,
-    output_factor: 1,
-    override_lvl1: 'Document Processing',
     purpose_sentence: 'reads file contents from supported file-types',
     purpose_verb: 'read',
     purpose_word: 'read files',
     purpose_words: 'Read file contents',
-    service_slug: 'document-processing',
-    slot_count: 5,
     title: 'Read file contents',
     typical_file_size_mb: 1.2,
     typical_file_type: 'file',
@@ -29,10 +15,6 @@ export const meta = {
     priceFactor: 5,
     queueSlotCount: 5,
     minimumCharge: 512000,
-    isAllowedForUrlTransform: true,
-    isInternal: false,
-    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-    stage: 'ga',
 };
 export const robotFileReadInstructionsSchema = robotBase
     .merge(robotUse)
@@ -44,8 +26,5 @@ The <dfn>Robot</dfn> currently only accepts files under 500KB.
 `),
 })
     .strict();
-export const robotFileReadInstructionsWithHiddenFieldsSchema = robotFileReadInstructionsSchema.extend({
-    result: z.union([z.literal('debug'), robotFileReadInstructionsSchema.shape.result]).optional(),
-});
-export const interpolatableRobotFileReadInstructionsSchema = interpolateRobot(robotFileReadInstructionsSchema);
-export const interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema = interpolateRobot(robotFileReadInstructionsWithHiddenFieldsSchema);
+export const robotDefinition = defineRobot(meta, robotFileReadInstructionsSchema);
+export const { withHiddenFields: robotFileReadInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotFileReadInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema, } = robotDefinition;

package/dist/v4/robots/file-serve.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 robotFileServeInstructionsSchema: 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";
@@ -38,15 +39,17 @@ export declare const robotFileServeInstructionsSchema: z.ZodObject<{
     download_name: z.ZodOptional<z.ZodString>;
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotFileServeInstructionsSchema.shape>;
 export declare const robotFileServeInstructionsWithHiddenFieldsSchema: 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";
     }>>;
@@ -74,25 +77,22 @@ export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObje
     download_name: z.ZodOptional<z.ZodString>;
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
-}, z.core.$strict>;
-export type RobotFileServeInstructions = z.infer<typeof robotFileServeInstructionsSchema>;
-export type RobotFileServeInstructionsInput = z.input<typeof robotFileServeInstructionsSchema>;
-export type RobotFileServeInstructionsWithHiddenFields = z.infer<typeof robotFileServeInstructionsWithHiddenFieldsSchema>;
-export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotFileServeInstructionsSchema: 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")[]>>]>>;
@@ -113,24 +113,22 @@ export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject
     robot: z.ZodLiteral<"/file/serve">;
     cache_duration: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     download_name: z.ZodOptional<z.ZodString>;
-    headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
-}, z.core.$strict>;
-export type InterpolatableRobotFileServeInstructions = InterpolatableRobotFileServeInstructionsInput;
-export type InterpolatableRobotFileServeInstructionsInput = z.input<typeof interpolatableRobotFileServeInstructionsSchema>;
-export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    headers: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strict>, interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema: 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")[]>>]>>;
@@ -151,9 +149,16 @@ export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSch
     robot: z.ZodLiteral<"/file/serve">;
     cache_duration: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     download_name: z.ZodOptional<z.ZodString>;
-    headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
-    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+    headers: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    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 InterpolatableRobotFileServeInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotFileServeInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotFileServeInstructions = Instructions['output'];
+export type RobotFileServeInstructionsInput = Instructions['input'];
+export type RobotFileServeInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotFileServeInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotFileServeInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotFileServeInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotFileServeInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=file-serve.d.ts.map

package/dist/v4/robots/file-serve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-serve.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/file-serve.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,cA2ClB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAuFlC,CAAA;AAEX,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAGzD,CAAA;AAEJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AACzF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAC9F,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":"file-serve.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/file-serve.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAS1B,eAAO,MAAM,IAAI,EAAE,cA6BlB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAqFlC,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,+BAA+B,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AACnE,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/file-serve.js

@@ -1,9 +1,8 @@
+import { optionalWithV3Semantics } from "../lib/sdkZodOptional.js";
 import { z } from 'zod/v4';
-import { interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
+import { defineRobot, robotBase, robotContentDeliveryMeta, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    bytescount: 4,
-    discount_factor: 0.25,
-    discount_pct: 75,
+    ...robotContentDeliveryMeta,
     example_code: {
         steps: {
             resized: {
@@ -21,28 +20,16 @@ export const meta = {
         },
     },
     example_code_description: 'Serve transformed files with explicit browser and CDN cache duration:',
-    minimum_charge: 0,
-    output_factor: 1,
     purpose_sentence: 'serves files to web browsers',
     purpose_verb: 'serve',
     purpose_word: 'Serve files',
     purpose_words: 'Serve files to web browsers',
-    service_slug: 'content-delivery',
-    slot_count: 0,
     title: 'Serve files to web browsers',
-    typical_file_size_mb: 1.2,
-    typical_file_type: 'file',
     name: 'FileServeRobot',
     priceFactor: 4,
     minimumChargeUsd: 0.0000152587890625,
-    queueSlotCount: 0,
-    downloadInputFiles: false,
-    preserveInputFileUrls: true,
     isAllowedForUrlTransform: true,
-    trackOutputFileSize: false,
     isInternal: false,
-    stage: 'ga',
-    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
 };
 export const robotFileServeInstructionsSchema = robotBase
     .merge(robotUse)
@@ -93,21 +80,19 @@ For new integrations, use the modern \`sig\` + \`exp\` format. Legacy \`s\` sign
 - [🤖/tlcdn/deliver](/docs/robots/tlcdn-deliver/) pricing
 - [File Preview Feature](/blog/2024/06/file-preview-with-smart-cdn/) blog post
 `),
-    cache_duration: z
+    cache_duration: optionalWithV3Semantics(z
         .number()
         .int()
-        .min(0)
-        .optional()
+        .min(0))
         .describe(`
 An optional duration in seconds that the served file should be cached. When set, this value is used for both the \`max-age\` (browser cache) and \`s-maxage\` (shared/CDN cache) directives in the \`Cache-Control\` header, overriding the defaults. For example, setting \`cache_duration\` to \`43200\` would cache the file for 12 hours.
 
 This is useful for controlling data retention in CDNs. For instance, if your temporary files are deleted after 24 hours, you can set \`cache_duration\` to \`86400\` to ensure cached copies also expire within that window.
 `),
-    download_name: z
+    download_name: optionalWithV3Semantics(z
         .string()
         // biome-ignore lint/suspicious/noControlCharactersInRegex: reject header-injection control characters, not literal text.
-        .regex(/^[^/\\\u0000-\u001f\u007f-\u009f]{0,255}$/u)
-        .optional()
+        .regex(/^[^/\\\u0000-\u001f\u007f-\u009f]{0,255}$/u))
         .describe('Serve as an attachment using this Unicode filename. Empty or omitted keeps inline delivery. Overrides a Content-Disposition header without changing the bytes or Range support.'),
     headers: z.record(z.string(), z.string())
         .default({
@@ -128,8 +113,5 @@ The \`Accept-Ranges: bytes\` header advertises that HTTP range requests are supp
 `),
 })
     .strict();
-export const robotFileServeInstructionsWithHiddenFieldsSchema = robotFileServeInstructionsSchema.extend({
-    result: z.union([z.literal('debug'), robotFileServeInstructionsSchema.shape.result]).optional(),
-});
-export const interpolatableRobotFileServeInstructionsSchema = interpolateRobot(robotFileServeInstructionsSchema);
-export const interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema = interpolateRobot(robotFileServeInstructionsWithHiddenFieldsSchema);
+export const robotDefinition = defineRobot(meta, robotFileServeInstructionsSchema);
+export const { withHiddenFields: robotFileServeInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotFileServeInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema, } = robotDefinition;