@transloadit/zod 4.4.1 → 5.0.0

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

@@ -1,9 +1,10 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts';
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
 import { z } from 'zod/v3';
 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">>]>>;
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
@@ -75,16 +76,16 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
         webpage: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         unknown: string[];
-        document: string[];
         image: string[];
+        document: string[];
         video: string[];
         webpage: string[];
         audio: string[];
         archive: string[];
     }, {
         unknown?: string[] | undefined;
-        document?: string[] | undefined;
         image?: string[] | undefined;
+        document?: string[] | undefined;
         video?: string[] | undefined;
         webpage?: string[] | undefined;
         audio?: string[] | undefined;
@@ -109,9 +110,10 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     clip_framerate: z.ZodDefault<z.ZodNumber>;
     clip_loop: z.ZodDefault<z.ZodBoolean>;
 }, "strict", z.ZodTypeAny, {
+    result: boolean;
     optimize: boolean;
     robot: "/file/preview";
-    result: boolean;
+    user_meta: Record<string, unknown>;
     force_accept: boolean;
     ignore_errors: string[];
     width: number;
@@ -135,7 +137,6 @@ 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;
@@ -150,12 +151,13 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
     queue?: "batch" | undefined;
     strategy?: {
         unknown: string[];
-        document: string[];
         image: string[];
+        document: string[];
         video: string[];
         webpage: string[];
         audio: string[];
@@ -165,8 +167,8 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     artwork_center_color?: string | undefined;
 }, {
     robot: "/file/preview";
+    result?: boolean | undefined;
     optimize?: boolean | undefined;
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -181,8 +183,9 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: "batch" | undefined;
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
@@ -194,8 +197,8 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     format?: "gif" | "jpeg" | "jpg" | "png" | "avif" | "webp" | undefined;
     strategy?: {
         unknown?: string[] | undefined;
-        document?: string[] | undefined;
         image?: string[] | undefined;
+        document?: string[] | undefined;
         video?: string[] | undefined;
         webpage?: string[] | undefined;
         audio?: string[] | undefined;
@@ -219,9 +222,11 @@ export declare const robotFilePreviewInstructionsSchema: z.ZodObject<{
     clip_framerate?: number | undefined;
     clip_loop?: boolean | undefined;
 }>;
+export declare const robotDefinition: RobotDefinition<typeof robotFilePreviewInstructionsSchema.shape>;
 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">>]>>;
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
     ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "execute"]>, "many">]>, string[], boolean | ("meta" | "execute")[]>>;
@@ -290,16 +295,16 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
         webpage: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         unknown: string[];
-        document: string[];
         image: string[];
+        document: string[];
         video: string[];
         webpage: string[];
         audio: string[];
         archive: string[];
     }, {
         unknown?: string[] | undefined;
-        document?: string[] | undefined;
         image?: string[] | undefined;
+        document?: string[] | undefined;
         video?: string[] | undefined;
         webpage?: string[] | undefined;
         audio?: string[] | undefined;
@@ -328,6 +333,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
 }, "strict", z.ZodTypeAny, {
     optimize: boolean;
     robot: "/file/preview";
+    user_meta: Record<string, unknown>;
     force_accept: boolean;
     ignore_errors: string[];
     width: number;
@@ -351,7 +357,7 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     clip_duration: number;
     clip_framerate: number;
     clip_loop: boolean;
-    interpolate?: boolean | Record<string, boolean> | undefined;
+    result?: boolean | "debug" | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -366,13 +372,13 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | "debug" | undefined;
     queue?: "batch" | undefined;
     strategy?: {
         unknown: string[];
-        document: string[];
         image: string[];
+        document: string[];
         video: string[];
         webpage: string[];
         audio: string[];
@@ -382,8 +388,8 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     artwork_center_color?: string | undefined;
 }, {
     robot: "/file/preview";
+    result?: boolean | "debug" | undefined;
     optimize?: boolean | undefined;
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -398,8 +404,9 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | "debug" | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: "batch" | undefined;
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
@@ -411,8 +418,8 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     format?: "gif" | "jpeg" | "jpg" | "png" | "avif" | "webp" | undefined;
     strategy?: {
         unknown?: string[] | undefined;
-        document?: string[] | undefined;
         image?: string[] | undefined;
+        document?: string[] | undefined;
         video?: string[] | undefined;
         webpage?: string[] | undefined;
         audio?: string[] | undefined;
@@ -435,13 +442,10 @@ export declare const robotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodOb
     clip_duration?: number | undefined;
     clip_framerate?: number | undefined;
     clip_loop?: boolean | undefined;
-}>;
-export type RobotFilePreviewInstructions = z.infer<typeof robotFilePreviewInstructionsSchema>;
-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">>]>>;
+}>, interpolatableRobotFilePreviewInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, 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, "many">]>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -511,16 +515,16 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
         webpage: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     }, "strip", z.ZodTypeAny, {
         unknown: string | string[];
-        document: string | string[];
         image: string | string[];
+        document: string | string[];
         video: string | string[];
         webpage: string | string[];
         audio: string | string[];
         archive: string | string[];
     }, {
         unknown?: string | string[] | undefined;
-        document?: string | string[] | undefined;
         image?: string | string[] | undefined;
+        document?: string | string[] | undefined;
         video?: string | string[] | undefined;
         webpage?: string | string[] | undefined;
         audio?: string | string[] | undefined;
@@ -545,9 +549,10 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     clip_framerate: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
     clip_loop: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
 }, "strict", z.ZodTypeAny, {
+    result: string | boolean;
     optimize: string | boolean;
     robot: "/file/preview";
-    result: string | boolean;
+    user_meta: Record<string, unknown>;
     force_accept: string | boolean;
     ignore_errors: string | string[];
     width: string | number;
@@ -571,7 +576,6 @@ 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,12 +590,13 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
     queue?: string | undefined;
     strategy?: string | {
         unknown: string | string[];
-        document: string | string[];
         image: string | string[];
+        document: string | string[];
         video: string | string[];
         webpage: string | string[];
         audio: string | string[];
@@ -601,8 +606,8 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     artwork_center_color?: string | undefined;
 }, {
     robot: "/file/preview";
+    result?: string | boolean | undefined;
     optimize?: string | boolean | undefined;
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -617,8 +622,9 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: string | undefined;
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
@@ -630,8 +636,8 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     format?: string | undefined;
     strategy?: string | {
         unknown?: string | string[] | undefined;
-        document?: string | string[] | undefined;
         image?: string | string[] | undefined;
+        document?: string | string[] | undefined;
         video?: string | string[] | undefined;
         webpage?: string | string[] | undefined;
         audio?: string | string[] | undefined;
@@ -654,12 +660,10 @@ export declare const interpolatableRobotFilePreviewInstructionsSchema: z.ZodObje
     clip_duration?: string | number | undefined;
     clip_framerate?: string | number | undefined;
     clip_loop?: string | boolean | undefined;
-}>;
-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">>]>>;
+}>, interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, 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, "many">]>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "execute"]>, "many">]>, string[], boolean | ("meta" | "execute")[]>]>>;
@@ -728,16 +732,16 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
         webpage: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     }, "strip", z.ZodTypeAny, {
         unknown: string | string[];
-        document: string | string[];
         image: string | string[];
+        document: string | string[];
         video: string | string[];
         webpage: string | string[];
         audio: string | string[];
         archive: string | string[];
     }, {
         unknown?: string | string[] | undefined;
-        document?: string | string[] | undefined;
         image?: string | string[] | undefined;
+        document?: string | string[] | undefined;
         video?: string | string[] | undefined;
         webpage?: string | string[] | undefined;
         audio?: string | string[] | undefined;
@@ -765,6 +769,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
 }, "strict", z.ZodTypeAny, {
     optimize: string | boolean;
     robot: "/file/preview";
+    user_meta: Record<string, unknown>;
     force_accept: string | boolean;
     ignore_errors: string | string[];
     width: string | number;
@@ -788,7 +793,7 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     clip_duration: string | number;
     clip_framerate: string | number;
     clip_loop: string | boolean;
-    interpolate?: boolean | Record<string, boolean> | undefined;
+    result?: string | boolean | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -803,13 +808,13 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
     queue?: string | undefined;
     strategy?: string | {
         unknown: string | string[];
-        document: string | string[];
         image: string | string[];
+        document: string | string[];
         video: string | string[];
         webpage: string | string[];
         audio: string | string[];
@@ -819,8 +824,8 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     artwork_center_color?: string | undefined;
 }, {
     robot: "/file/preview";
+    result?: string | boolean | undefined;
     optimize?: string | boolean | undefined;
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -835,8 +840,9 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: string | undefined;
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
@@ -848,8 +854,8 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     format?: string | undefined;
     strategy?: string | {
         unknown?: string | string[] | undefined;
-        document?: string | string[] | undefined;
         image?: string | string[] | undefined;
+        document?: string | string[] | undefined;
         video?: string | string[] | undefined;
         webpage?: string | string[] | undefined;
         audio?: string | string[] | undefined;
@@ -873,6 +879,13 @@ export declare const interpolatableRobotFilePreviewInstructionsWithHiddenFieldsS
     clip_framerate?: string | number | undefined;
     clip_loop?: string | boolean | undefined;
 }>;
-export type InterpolatableRobotFilePreviewInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotFilePreviewInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotFilePreviewInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotFilePreviewInstructions = Instructions['output'];
+export type RobotFilePreviewInstructionsInput = Instructions['input'];
+export type RobotFilePreviewInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotFilePreviewInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotFilePreviewInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotFilePreviewInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotFilePreviewInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=file-preview.d.ts.map

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,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAa1B,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"}
+{"version":3,"file":"file-preview.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/file-preview.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;AAe1B,eAAO,MAAM,IAAI,EAAE,cAmBlB,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkLpC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,kCAAkC,CAAC,KAAK,CACtC,CAAA;AAEvD,eAAO,MACa,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACpD,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAChC,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAC/E,CAAA;AAEnB,KAAK,YAAY,GAAG,uBAAuB,CAAC,OAAO,eAAe,CAAC,CAAA;AAEnE,MAAM,MAAM,4BAA4B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AACjE,MAAM,MAAM,iCAAiC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AACrE,MAAM,MAAM,4CAA4C,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AACvF,MAAM,MAAM,0CAA0C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC5F,MAAM,MAAM,+CAA+C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AACjG,MAAM,MAAM,0DAA0D,GACpE,YAAY,CAAC,4BAA4B,CAAC,CAAA;AAC5C,MAAM,MAAM,+DAA+D,GACzE,YAAY,CAAC,2BAA2B,CAAC,CAAA"}

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

@@ -1,42 +1,22 @@
 import { z } from 'zod/v3';
-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
@@ -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;