@transloadit/zod 4.3.0 → 4.3.2

package/dist/v3/robots/file-preview.d.ts

@@ -2,6 +2,7 @@ import { z } from 'zod/v3';
 import type { RobotMetaInput } from './_instructions-primitives.ts';
 export declare const meta: RobotMetaInput;
 export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
@@ -63,6 +64,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     height: z.ZodDefault<z.ZodEffects<z.ZodNumber, number, unknown>>;
     resize_strategy: z.ZodDefault<z.ZodEnum<["crop", "fit", "fillcrop", "min_fit", "pad", "stretch"]>>;
     background: z.ZodDefault<z.ZodString>;
+    zoom: z.ZodDefault<z.ZodBoolean>;
     strategy: z.ZodOptional<z.ZodObject<{
         archive: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
         audio: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
@@ -115,6 +117,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     width: number;
     height: number;
     resize_strategy: "crop" | "fit" | "fillcrop" | "min_fit" | "pad" | "stretch";
+    zoom: boolean;
     background: string;
     format: "gif" | "jpg" | "png";
     waveform_center_color: string;
@@ -132,6 +135,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     clip_duration: number;
     clip_framerate: number;
     clip_loop: boolean;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -162,6 +166,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
 }, {
     robot: "/file/preview";
     optimize?: boolean | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -184,6 +189,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     width?: unknown;
     height?: unknown;
     resize_strategy?: "crop" | "fit" | "fillcrop" | "min_fit" | "pad" | "stretch" | undefined;
+    zoom?: boolean | undefined;
     background?: string | undefined;
     format?: "gif" | "jpg" | "png" | undefined;
     strategy?: {
@@ -214,6 +220,7 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     clip_loop?: boolean | undefined;
 }>;
 export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
@@ -272,6 +279,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     height: z.ZodDefault<z.ZodEffects<z.ZodNumber, number, unknown>>;
     resize_strategy: z.ZodDefault<z.ZodEnum<["crop", "fit", "fillcrop", "min_fit", "pad", "stretch"]>>;
     background: z.ZodDefault<z.ZodString>;
+    zoom: z.ZodDefault<z.ZodBoolean>;
     strategy: z.ZodOptional<z.ZodObject<{
         archive: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
         audio: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
@@ -325,6 +333,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     width: number;
     height: number;
     resize_strategy: "crop" | "fit" | "fillcrop" | "min_fit" | "pad" | "stretch";
+    zoom: boolean;
     background: string;
     format: "gif" | "jpg" | "png";
     waveform_center_color: string;
@@ -342,6 +351,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     clip_duration: number;
     clip_framerate: number;
     clip_loop: boolean;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -373,6 +383,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
 }, {
     robot: "/file/preview";
     optimize?: boolean | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -395,6 +406,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     width?: unknown;
     height?: unknown;
     resize_strategy?: "crop" | "fit" | "fillcrop" | "min_fit" | "pad" | "stretch" | undefined;
+    zoom?: boolean | undefined;
     background?: string | undefined;
     format?: "gif" | "jpg" | "png" | undefined;
     strategy?: {
@@ -428,6 +440,7 @@ export type RobotFilePreviewInstructions = z.infer<typeof robotFilePreviewInstru
 export type RobotFilePreviewInstructionsInput = z.input<typeof robotFilePreviewInstructionsSchema>;
 export type RobotFilePreviewInstructionsWithHiddenFields = z.infer<typeof robotFilePreviewInstructionsWithHiddenFieldsSchema>;
 export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
@@ -487,6 +500,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     height: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodNumber, number, unknown>]>>;
     resize_strategy: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["crop", "fit", "fillcrop", "min_fit", "pad", "stretch"]>]>>;
     background: z.ZodDefault<z.ZodString>;
+    zoom: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     strategy: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
         archive: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         audio: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
@@ -539,6 +553,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     width: string | number;
     height: string | number;
     resize_strategy: string;
+    zoom: string | boolean;
     background: string;
     format: string;
     waveform_center_color: string;
@@ -556,6 +571,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     clip_duration: string | number;
     clip_framerate: string | number;
     clip_loop: string | boolean;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -586,6 +602,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
 }, {
     robot: "/file/preview";
     optimize?: string | boolean | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -608,6 +625,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     width?: unknown;
     height?: unknown;
     resize_strategy?: string | undefined;
+    zoom?: string | boolean | undefined;
     background?: string | undefined;
     format?: string | undefined;
     strategy?: string | {
@@ -640,6 +658,7 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
 export type InterpolatableRobotFilePreviewInstructions = InterpolatableRobotFilePreviewInstructionsInput;
 export type InterpolatableRobotFilePreviewInstructionsInput = z.input<typeof interpolatableRobotFilePreviewInstructionsSchema>;
 export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -698,6 +717,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     height: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodNumber, number, unknown>]>>;
     resize_strategy: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["crop", "fit", "fillcrop", "min_fit", "pad", "stretch"]>]>>;
     background: z.ZodDefault<z.ZodString>;
+    zoom: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     strategy: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
         archive: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         audio: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
@@ -750,6 +770,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     width: string | number;
     height: string | number;
     resize_strategy: string;
+    zoom: string | boolean;
     background: string;
     format: string;
     waveform_center_color: string;
@@ -767,6 +788,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     clip_duration: string | number;
     clip_framerate: string | number;
     clip_loop: string | boolean;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -798,6 +820,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
 }, {
     robot: "/file/preview";
     optimize?: string | boolean | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -820,6 +843,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     width?: unknown;
     height?: unknown;
     resize_strategy?: string | undefined;
+    zoom?: string | boolean | undefined;
     background?: string | undefined;
     format?: string | undefined;
     strategy?: string | {

package/dist/v3/robots/file-preview.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-preview.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/file-preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAYnE,eAAO,MAAM,IAAI,EAAE,cAwClB,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0KpC,CAAA;AAEX,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3D,CAAA;AAEJ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAClG,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,kDAAkD,CAC1D,CAAA;AAED,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5D,CAAA;AACD,MAAM,MAAM,0CAA0C,GACpD,+CAA+C,CAAA;AAEjD,MAAM,MAAM,+CAA+C,GAAG,CAAC,CAAC,KAAK,CACnE,OAAO,gDAAgD,CACxD,CAAA;AAED,eAAO,MAAM,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5E,CAAA;AACD,MAAM,MAAM,0DAA0D,GAAG,CAAC,CAAC,KAAK,CAC9E,OAAO,gEAAgE,CACxE,CAAA;AACD,MAAM,MAAM,+DAA+D,GAAG,CAAC,CAAC,KAAK,CACnF,OAAO,gEAAgE,CACxE,CAAA"}
+{"version":3,"file":"file-preview.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/file-preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAYnE,eAAO,MAAM,IAAI,EAAE,cAuClB,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkLpC,CAAA;AAEX,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3D,CAAA;AAEJ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAClG,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,kDAAkD,CAC1D,CAAA;AAED,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5D,CAAA;AACD,MAAM,MAAM,0CAA0C,GACpD,+CAA+C,CAAA;AAEjD,MAAM,MAAM,+CAA+C,GAAG,CAAC,CAAC,KAAK,CACnE,OAAO,gDAAgD,CACxD,CAAA;AAED,eAAO,MAAM,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5E,CAAA;AACD,MAAM,MAAM,0DAA0D,GAAG,CAAC,CAAC,KAAK,CAC9E,OAAO,gEAAgE,CACxE,CAAA;AACD,MAAM,MAAM,+DAA+D,GAAG,CAAC,CAAC,KAAK,CACnF,OAAO,gEAAgE,CACxE,CAAA"}

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

@@ -1,7 +1,6 @@
 import { z } from 'zod/v3';
 import { color_with_alpha, complexHeightSchema, complexWidthSchema, interpolateRobot, optimize_priority, resize_strategy, robotBase, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    allowed_for_url_transform: true,
     bytescount: 1,
     discount_factor: 1,
     discount_pct: 0,
@@ -69,6 +68,14 @@ See the list of available [resize strategies](/docs/topics/resize-strategies/) f
 `),
     background: color_with_alpha.default('#ffffffff').describe(`
 The hexadecimal code of the color used to fill the background (only used for the pad resize strategy). The format is \`#rrggbb[aa]\` (red, green, blue, alpha). Use \`#00000000\` for a transparent padding.
+`),
+    zoom: z
+        .boolean()
+        .default(true)
+        .describe(`
+If set to \`false\`, smaller images will not be stretched to the desired \`width\` and \`height\`. This is useful if you want to retain the original image dimensions and only limit the output to a maximum size. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/topics/resize-strategies/).
+
+Note that this parameter only affects strategies that produce a still image. Animated clips generated by the \`clip\` strategy are not affected.
 `),
     strategy: z
         .object({

package/dist/v3/robots/file-read.d.ts

@@ -2,6 +2,7 @@ import { z } from 'zod/v3';
 import type { RobotMetaInput } from './_instructions-primitives.ts';
 export declare const meta: RobotMetaInput;
 export declare const robotFileReadInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
@@ -63,6 +64,7 @@ export declare const robotFileReadInstructionsSchema: z.ZodObject<{
     result: boolean;
     force_accept: boolean;
     ignore_errors: string[];
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -81,6 +83,7 @@ export declare const robotFileReadInstructionsSchema: z.ZodObject<{
     queue?: "batch" | undefined;
 }, {
     robot: "/file/read";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -102,6 +105,7 @@ export declare const robotFileReadInstructionsSchema: z.ZodObject<{
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
 }>;
 export declare const robotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
@@ -161,6 +165,7 @@ export declare const robotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObjec
     robot: "/file/read";
     force_accept: boolean;
     ignore_errors: string[];
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -180,6 +185,7 @@ export declare const robotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObjec
     queue?: "batch" | undefined;
 }, {
     robot: "/file/read";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -203,6 +209,7 @@ export declare const robotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObjec
 export type RobotFileReadInstructions = z.infer<typeof robotFileReadInstructionsSchema>;
 export type RobotFileReadInstructionsWithHiddenFields = z.infer<typeof robotFileReadInstructionsWithHiddenFieldsSchema>;
 export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
@@ -262,6 +269,7 @@ export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<
     result: string | boolean;
     force_accept: string | boolean;
     ignore_errors: string | string[];
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -280,6 +288,7 @@ export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<
     queue?: string | undefined;
 }, {
     robot: "/file/read";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -303,6 +312,7 @@ export declare const interpolatableRobotFileReadInstructionsSchema: z.ZodObject<
 export type InterpolatableRobotFileReadInstructions = InterpolatableRobotFileReadInstructionsInput;
 export type InterpolatableRobotFileReadInstructionsInput = z.input<typeof interpolatableRobotFileReadInstructionsSchema>;
 export declare const interpolatableRobotFileReadInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -361,6 +371,7 @@ export declare const interpolatableRobotFileReadInstructionsWithHiddenFieldsSche
     robot: "/file/read";
     force_accept: string | boolean;
     ignore_errors: string | string[];
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -380,6 +391,7 @@ export declare const interpolatableRobotFileReadInstructionsWithHiddenFieldsSche
     queue?: string | undefined;
 }, {
     robot: "/file/read";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"file-read.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/file-read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAGnE,eAAO,MAAM,IAAI,EAAE,cAyBlB,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASjC,CAAA;AAEX,eAAO,MAAM,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGxD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEzD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEzE,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/v3/robots/file-read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAGnE,eAAO,MAAM,IAAI,EAAE,cAiClB,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASjC,CAAA;AAEX,eAAO,MAAM,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGxD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEzD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEzE,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"}

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

@@ -1,10 +1,18 @@
 import { z } from 'zod/v3';
 import { interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
 export const meta = {
-    allowed_for_url_transform: true,
     bytescount: 5,
     discount_factor: 0.2,
     discount_pct: 80,
+    example_code: {
+        steps: {
+            read: {
+                robot: '/file/read',
+                use: ':original',
+            },
+        },
+    },
+    example_code_description: 'Read UTF-8 text content from an uploaded file:',
     minimum_charge: 512000,
     output_factor: 1,
     override_lvl1: 'Document Processing',

package/dist/v3/robots/file-serve.d.ts

@@ -2,6 +2,7 @@ import { z } from 'zod/v3';
 import type { RobotMetaInput } from './_instructions-primitives.ts';
 export declare const meta: RobotMetaInput;
 export declare const robotFileServeInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
@@ -58,6 +59,7 @@ export declare const robotFileServeInstructionsSchema: z.ZodObject<{
     }>]>>;
 } & {
     robot: z.ZodLiteral<"/file/serve">;
+    cache_duration: z.ZodOptional<z.ZodNumber>;
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, "strict", z.ZodTypeAny, {
     robot: "/file/serve";
@@ -65,6 +67,7 @@ export declare const robotFileServeInstructionsSchema: z.ZodObject<{
     force_accept: boolean;
     ignore_errors: string[];
     headers: Record<string, string>;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -81,8 +84,10 @@ export declare const robotFileServeInstructionsSchema: z.ZodObject<{
     } | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
     queue?: "batch" | undefined;
+    cache_duration?: number | undefined;
 }, {
     robot: "/file/serve";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -103,8 +108,10 @@ export declare const robotFileServeInstructionsSchema: z.ZodObject<{
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
     headers?: Record<string, string> | undefined;
+    cache_duration?: number | undefined;
 }>;
 export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
@@ -158,6 +165,7 @@ export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObje
         group_by_original?: boolean | undefined;
     }>]>>;
     robot: z.ZodLiteral<"/file/serve">;
+    cache_duration: z.ZodOptional<z.ZodNumber>;
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
 } & {
     result: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
@@ -166,6 +174,7 @@ export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObje
     force_accept: boolean;
     ignore_errors: string[];
     headers: Record<string, string>;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -183,8 +192,10 @@ export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObje
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
     result?: boolean | "debug" | undefined;
     queue?: "batch" | undefined;
+    cache_duration?: number | undefined;
 }, {
     robot: "/file/serve";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -205,11 +216,13 @@ export declare const robotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObje
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
     headers?: Record<string, string> | undefined;
+    cache_duration?: number | undefined;
 }>;
 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<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
@@ -264,6 +277,7 @@ export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject
         group_by_original?: boolean | undefined;
     }>]>>;
     robot: z.ZodLiteral<"/file/serve">;
+    cache_duration: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, "strict", z.ZodTypeAny, {
     robot: "/file/serve";
@@ -271,6 +285,7 @@ export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject
     force_accept: string | boolean;
     ignore_errors: string | string[];
     headers: Record<string, string>;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -287,8 +302,10 @@ export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject
     } | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
     queue?: string | undefined;
+    cache_duration?: string | number | undefined;
 }, {
     robot: "/file/serve";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -309,10 +326,12 @@ export declare const interpolatableRobotFileServeInstructionsSchema: z.ZodObject
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
     headers?: Record<string, string> | undefined;
+    cache_duration?: string | number | undefined;
 }>;
 export type InterpolatableRobotFileServeInstructions = InterpolatableRobotFileServeInstructionsInput;
 export type InterpolatableRobotFileServeInstructionsInput = z.input<typeof interpolatableRobotFileServeInstructionsSchema>;
 export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
     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, "many">]>]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -366,6 +385,7 @@ export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSch
         group_by_original?: boolean | undefined;
     }>]>>;
     robot: z.ZodLiteral<"/file/serve">;
+    cache_duration: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     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]>>]>>;
 }, "strict", z.ZodTypeAny, {
@@ -373,6 +393,7 @@ export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSch
     force_accept: string | boolean;
     ignore_errors: string | string[];
     headers: Record<string, string>;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -390,8 +411,10 @@ export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSch
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
     result?: string | boolean | undefined;
     queue?: string | undefined;
+    cache_duration?: string | number | undefined;
 }, {
     robot: "/file/serve";
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -412,6 +435,7 @@ export declare const interpolatableRobotFileServeInstructionsWithHiddenFieldsSch
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
     headers?: Record<string, string> | undefined;
+    cache_duration?: string | number | undefined;
 }>;
 export type InterpolatableRobotFileServeInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema>;
 export type InterpolatableRobotFileServeInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotFileServeInstructionsWithHiddenFieldsSchema>;

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

@@ -1 +1 @@
-{"version":3,"file":"file-serve.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/file-serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAGnE,eAAO,MAAM,IAAI,EAAE,cA0BlB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgElC,CAAA;AAEX,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGzD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE1D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE1E,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/v3/robots/file-serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAGnE,eAAO,MAAM,IAAI,EAAE,cA0ClB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgFlC,CAAA;AAEX,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGzD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE1D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE1E,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/v3/robots/file-serve.js

@@ -1,10 +1,26 @@
 import { z } from 'zod/v3';
 import { interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
 export const meta = {
-    allowed_for_url_transform: true,
     bytescount: 4,
     discount_factor: 0.25,
     discount_pct: 75,
+    example_code: {
+        steps: {
+            resized: {
+                robot: '/image/resize',
+                use: ':original',
+                width: 800,
+                height: 450,
+                resize_strategy: 'fit',
+            },
+            served: {
+                robot: '/file/serve',
+                use: 'resized',
+                cache_duration: 86400,
+            },
+        },
+    },
+    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',
@@ -31,7 +47,7 @@ export const robotFileServeInstructionsSchema = robotBase
     .merge(robotUse)
     .extend({
     robot: z.literal('/file/serve').describe(`
-When you want Transloadit to tranform files on the fly, you can use this <dfn>Robot</dfn> to determine which <dfn>Step</dfn> of a <dfn>Template</dfn> should be served to the end-user (via a CDN), as well as set extra information on the served files, such as headers. This way you can for instance suggest the CDN for how long to keep cached copies of the result around. By default, as you can see in the \`headers\` parameter, we instruct browsers to cache the result for 72h (\`259200\` seconds) and CDNs to cache the content for 24h (\`86400\` seconds). These values should be adjusted to suit your use case.
+When you want Transloadit to tranform files on the fly, you can use this <dfn>Robot</dfn> to determine which <dfn>Step</dfn> of a <dfn>Template</dfn> should be served to the end-user (via a CDN), as well as set extra information on the served files, such as headers. This way you can for instance suggest the CDN for how long to keep cached copies of the result around. By default, we instruct browsers to cache the result for 72h (\`259200\` seconds) and CDNs to cache the content for 24h (\`86400\` seconds). Use the \`cache_duration\` parameter to customize both values at once.
 
 🤖/file/serve merely acts as the glue layer between our <dfn>Assembly</dfn> engine and serving files over HTTP. It let's you pick the proper result of a series of <dfn>Steps</dfn> via the \`use\` parameter and configure headers on the original content. That is where its responsibilies end, and 🤖/tlcdn/deliver, then takes over to globally distribute this original content across the globe, and make sure that is cached close to your end-users, when they make requests such as <https://my-app.tlcdn.com/resize-img/canoe.jpg?w=500>, another. 🤖/tlcdn/deliver is not a part of your <dfn>Assembly Instructions</dfn>, but it may appear on your invoices as bandwidth charges incur when distributing the cached copies. 🤖/file/serve only charges when the CDN does not have a cached copy and requests to regenerate the original content, which depending on your caching settings could be just once a month, or year, per file/transformation.
 
@@ -39,9 +55,9 @@ While theoretically possible, you could use [🤖/file/serve](/docs/robots/file-
 
 Also consider configuring caching headers and cache-control directives to control how content is cached and invalidated on the CDN edge servers, balancing between freshness and efficiency.
 
-## Smart CDN Security with Signature Authentication
+## Smart CDN security with signed URLs
 
-You can leverage [Signature Authentication](/docs/api/authentication/#smart-cdn) to avoid abuse of our encoding platform. Below is a quick Node.js example using our Node SDK, but there are [examples for other languages and SDKs](/docs/api/authentication/#example-code) as well.
+You can leverage [signed Smart CDN URLs](/docs/api/authentication/#smart-cdn) to avoid abuse of our encoding platform. Below is a quick Node.js example using our Node SDK, but there are [examples for other languages and SDKs](/docs/api/authentication/#example-code) as well.
 
 \`\`\`javascript
 // yarn add transloadit
@@ -67,27 +83,42 @@ console.log(url)
 
 This will generate a signed Smart CDN URL that includes authentication parameters, preventing unauthorized access to your transformation endpoints.
 
+For new integrations, use the modern \`sig\` + \`exp\` format. Legacy \`s\` signatures are deprecated. Also note that the expiration window is the practical cache window for signed results: shorter expirations tighten access control, while longer expirations improve cache reuse and lower encoding volume.
+
 ## More information
 
 - [Content Delivery](/services/content-delivery/)
 - [🤖/file/serve](/docs/robots/file-serve/) pricing
 - [🤖/tlcdn/deliver](/docs/robots/tlcdn-deliver/) pricing
 - [File Preview Feature](/blog/2024/06/file-preview-with-smart-cdn/) blog post
+`),
+    cache_duration: z
+        .number()
+        .int()
+        .min(0)
+        .optional()
+        .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.
 `),
     headers: z
         .record(z.string())
         .default({
-        'Access-Control-Allow-Headers': 'X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length, Transloadit-Client, Authorization',
+        'Access-Control-Allow-Headers': 'X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length, Transloadit-Client, Authorization, Range, If-Range',
         'Access-Control-Allow-Methods': 'POST, GET, PUT, DELETE, OPTIONS',
         'Access-Control-Allow-Origin': '*',
-        'Cache-Control': 'public, max-age=259200, s-max-age=86400',
+        'Access-Control-Expose-Headers': 'Transloadit-Assembly-URL, Content-Range, Content-Length, Accept-Ranges',
+        'Cache-Control': 'public, max-age=259200, s-maxage=86400',
         'Content-Type': '${file.mime}; charset=utf-8',
-        'Transfer-Encoding': 'chunked',
         'Transloadit-Assembly': '…',
         'Transloadit-RequestID': '…',
+        'Accept-Ranges': 'bytes',
     })
         .describe(`
 An object containing a list of headers to be set for a file as we serve it to a CDN/web browser, such as \`{ FileURL: "\${file.url_name}" }\` which will be merged over the defaults, and can include any available [Assembly Variable](/docs/topics/assembly-instructions/#assembly-variables).
+
+The \`Accept-Ranges: bytes\` header advertises that HTTP range requests are supported for seekable media playback. This relies on Transloadit's storage backends (S3, GCS, etc.) all honoring Range request headers. The CORS headers include \`Range\` and \`If-Range\` in \`Access-Control-Allow-Headers\` to permit cross-origin range requests, and expose \`Content-Range\`, \`Content-Length\`, and \`Accept-Ranges\` via \`Access-Control-Expose-Headers\` so browser JavaScript can read these values.
 `),
 })
     .strict();