@transloadit/node 4.1.3

package/dist/alphalib/types/robots/html-convert.d.ts

@@ -0,0 +1,531 @@
+import { z } from 'zod';
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+export declare const meta: RobotMetaInput;
+export declare const robotHtmlConvertInstructionsSchema: z.ZodObject<{
+    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"]>>;
+    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")[]>>;
+} & {
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+} & {
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodEnum<["jpeg", "jpg", "pdf", "png"]>>;
+    fullpage: z.ZodDefault<z.ZodBoolean>;
+    omit_background: z.ZodDefault<z.ZodBoolean>;
+    width: z.ZodDefault<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    delay: z.ZodDefault<z.ZodNumber>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    wait_until: z.ZodDefault<z.ZodEnum<["domcontentloaded", "load", "networkidle", "commit"]>>;
+}, "strict", z.ZodTypeAny, {
+    format: "pdf" | "jpeg" | "jpg" | "png";
+    url: string | null;
+    result: boolean;
+    robot: "/html/convert";
+    force_accept: boolean;
+    ignore_errors: string[];
+    width: number;
+    delay: number;
+    fullpage: boolean;
+    omit_background: boolean;
+    wait_until: "domcontentloaded" | "load" | "networkidle" | "commit";
+    headers?: Record<string, string> | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    height?: number | undefined;
+}, {
+    robot: "/html/convert";
+    headers?: Record<string, string> | undefined;
+    format?: "pdf" | "jpeg" | "jpg" | "png" | undefined;
+    url?: string | null | undefined;
+    result?: boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    force_accept?: boolean | undefined;
+    ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    delay?: number | undefined;
+    fullpage?: boolean | undefined;
+    omit_background?: boolean | undefined;
+    wait_until?: "domcontentloaded" | "load" | "networkidle" | "commit" | undefined;
+}>;
+export declare const robotHtmlConvertInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    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>;
+    ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "execute"]>, "many">]>, string[], boolean | ("meta" | "execute")[]>>;
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodEnum<["jpeg", "jpg", "pdf", "png"]>>;
+    fullpage: z.ZodDefault<z.ZodBoolean>;
+    omit_background: z.ZodDefault<z.ZodBoolean>;
+    width: z.ZodDefault<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    delay: z.ZodDefault<z.ZodNumber>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    wait_until: z.ZodDefault<z.ZodEnum<["domcontentloaded", "load", "networkidle", "commit"]>>;
+} & {
+    debuginfo: z.ZodOptional<z.ZodBoolean>;
+    timeouts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, "strict", z.ZodTypeAny, {
+    format: "pdf" | "jpeg" | "jpg" | "png";
+    url: string | null;
+    robot: "/html/convert";
+    force_accept: boolean;
+    ignore_errors: string[];
+    width: number;
+    delay: number;
+    fullpage: boolean;
+    omit_background: boolean;
+    wait_until: "domcontentloaded" | "load" | "networkidle" | "commit";
+    headers?: Record<string, string> | undefined;
+    result?: boolean | "debug" | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    height?: number | undefined;
+    debuginfo?: boolean | undefined;
+    timeouts?: Record<string, unknown> | undefined;
+    actions?: Record<string, unknown>[] | undefined;
+}, {
+    robot: "/html/convert";
+    headers?: Record<string, string> | undefined;
+    format?: "pdf" | "jpeg" | "jpg" | "png" | undefined;
+    url?: string | null | undefined;
+    result?: boolean | "debug" | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    force_accept?: boolean | undefined;
+    ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    delay?: number | undefined;
+    fullpage?: boolean | undefined;
+    omit_background?: boolean | undefined;
+    wait_until?: "domcontentloaded" | "load" | "networkidle" | "commit" | undefined;
+    debuginfo?: boolean | undefined;
+    timeouts?: Record<string, unknown> | undefined;
+    actions?: Record<string, unknown>[] | undefined;
+}>;
+export type RobotHtmlConvertInstructions = z.infer<typeof robotHtmlConvertInstructionsSchema>;
+export type RobotHtmlConvertInstructionsWithHiddenFields = z.infer<typeof robotHtmlConvertInstructionsWithHiddenFieldsSchema>;
+export declare const interpolatableRobotHtmlConvertInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    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]>>;
+    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")[]>]>>;
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["jpeg", "jpg", "pdf", "png"]>]>>;
+    fullpage: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    omit_background: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    width: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    height: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    delay: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    wait_until: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["domcontentloaded", "load", "networkidle", "commit"]>]>>;
+}, "strict", z.ZodTypeAny, {
+    format: string;
+    url: string | null;
+    result: string | boolean;
+    robot: "/html/convert";
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    width: string | number;
+    delay: string | number;
+    fullpage: string | boolean;
+    omit_background: string | boolean;
+    wait_until: string;
+    headers?: Record<string, string> | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    height?: string | number | undefined;
+}, {
+    robot: "/html/convert";
+    headers?: Record<string, string> | undefined;
+    format?: string | undefined;
+    url?: string | null | undefined;
+    result?: string | boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    force_accept?: string | boolean | undefined;
+    ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
+    width?: string | number | undefined;
+    height?: string | number | undefined;
+    delay?: string | number | undefined;
+    fullpage?: string | boolean | undefined;
+    omit_background?: string | boolean | undefined;
+    wait_until?: string | undefined;
+}>;
+export type InterpolatableRobotHtmlConvertInstructions = InterpolatableRobotHtmlConvertInstructionsInput;
+export type InterpolatableRobotHtmlConvertInstructionsInput = z.input<typeof interpolatableRobotHtmlConvertInstructionsSchema>;
+export declare const interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    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")[]>]>>;
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["jpeg", "jpg", "pdf", "png"]>]>>;
+    fullpage: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    omit_background: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    width: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    height: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    delay: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    wait_until: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["domcontentloaded", "load", "networkidle", "commit"]>]>>;
+    debuginfo: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    timeouts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    actions: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">]>>;
+    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, {
+    format: string;
+    url: string | null;
+    robot: "/html/convert";
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    width: string | number;
+    delay: string | number;
+    fullpage: string | boolean;
+    omit_background: string | boolean;
+    wait_until: string;
+    headers?: Record<string, string> | undefined;
+    result?: string | boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    height?: string | number | undefined;
+    debuginfo?: string | boolean | undefined;
+    timeouts?: Record<string, unknown> | undefined;
+    actions?: string | Record<string, unknown>[] | undefined;
+}, {
+    robot: "/html/convert";
+    headers?: Record<string, string> | undefined;
+    format?: string | undefined;
+    url?: string | null | undefined;
+    result?: string | boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        fields?: string[] | undefined;
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    force_accept?: string | boolean | undefined;
+    ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
+    width?: string | number | undefined;
+    height?: string | number | undefined;
+    delay?: string | number | undefined;
+    fullpage?: string | boolean | undefined;
+    omit_background?: string | boolean | undefined;
+    wait_until?: string | undefined;
+    debuginfo?: string | boolean | undefined;
+    timeouts?: Record<string, unknown> | undefined;
+    actions?: string | Record<string, unknown>[] | undefined;
+}>;
+export type InterpolatableRobotHtmlConvertInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema>;
+export type InterpolatableRobotHtmlConvertInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=html-convert.d.ts.map

package/dist/alphalib/types/robots/html-convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-convert.d.ts","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/html-convert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAGnE,eAAO,MAAM,IAAI,EAAE,cA0ClB,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgFpC,CAAA;AAEX,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQ3D,CAAA;AAEJ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,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/alphalib/types/robots/html-convert.js

@@ -0,0 +1,137 @@
+import { z } from 'zod';
+import { interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
+export const meta = {
+    allowed_for_url_transform: true,
+    bytescount: 1,
+    discount_factor: 1,
+    discount_pct: 0,
+    example_code: {
+        steps: {
+            captured: {
+                robot: '/html/convert',
+                url: 'https://transloadit.com',
+            },
+        },
+    },
+    example_code_description: 'Take a full screenshot of the Transloadit homepage:',
+    extended_description: `
+> [!Warning]
+> A validation error will occur if neither an HTML file is uploaded nor a URL parameter is given.
+
+> [!Note]
+> Any files imported within the HTML page will be included in the cost.
+`,
+    minimum_charge: 1048576,
+    output_factor: 0.5,
+    override_lvl1: 'Document Processing',
+    purpose_sentence: 'takes screenshots of web pages or uploaded HTML pages',
+    purpose_verb: 'take',
+    purpose_word: 'take screenshots of a webpage',
+    purpose_words: 'Take screenshots of webpages or HTML files',
+    service_slug: 'document-processing',
+    slot_count: 10,
+    title: 'Take screenshots of webpages or uploaded HTML files',
+    typical_file_size_mb: 0.6,
+    typical_file_type: 'webpage',
+    name: 'HtmlConvertRobot',
+    priceFactor: 1,
+    queueSlotCount: 30,
+    minimumCharge: 1048576,
+    isAllowedForUrlTransform: true,
+    trackOutputFileSize: true,
+    isInternal: false,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+    stage: 'ga',
+};
+export const robotHtmlConvertInstructionsSchema = robotBase
+    .merge(robotUse)
+    .extend({
+    robot: z.literal('/html/convert').describe(`
+A URL can be provided instead of an input HTML file, to capture a screenshot from the website referenced by the URL.
+
+Use [🤖/image/resize](/docs/robots/image-resize/) to resize or crop the screenshot as needed.
+`),
+    url: z
+        .string()
+        .nullable()
+        .default(null)
+        .describe(`
+The URL of the web page to be converted. Optional, as you can also upload/import HTML files and pass it to this <dfn>Robot</dfn>.
+`),
+    format: z
+        .enum(['jpeg', 'jpg', 'pdf', 'png'])
+        .default('png')
+        .describe(`
+The format of the resulting image.
+`),
+    fullpage: z
+        .boolean()
+        .default(true)
+        .describe(`
+Determines if a screenshot of the full page should be taken or not.
+
+If set to \`true\`, the \`height\` parameter will not have any effect, as heights of websites vary. You can control the size of the resulting image somewhat, though, by setting the \`width\` parameter.
+
+If set to \`false\`, an image will be cropped from the top of the webpage according to your \`width\` and \`height\` parameters.
+`),
+    omit_background: z
+        .boolean()
+        .default(false)
+        .describe(`
+Determines whether to preserve a transparent background in HTML pages. Useful if you're generating artwork in HTML that you want to overlay on e.g. a video.
+
+The default of \`false\` fills transparent areas with a white background, for easier reading/printing.
+
+This parameter is only used when \`format\` is not \`pdf\`.
+`),
+    width: z
+        .number()
+        .int()
+        .min(1)
+        .default(1024)
+        .describe(`
+The screen width that will be used, in pixels. Change this to change the  dimensions of the resulting image.
+`),
+    height: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe(`
+The screen height that will be used, in pixels. By default this equals the length of the web page in pixels if \`fullpage\` is set to \`true\`. If \`fullpage\` is set to \`false\`, the height parameter takes effect and defaults to the value \`768\`.
+`),
+    delay: z
+        .number()
+        .int()
+        .min(0)
+        .default(0)
+        .describe(`
+The delay (in milliseconds) applied to allow the page and all of its JavaScript to render before taking the screenshot.
+`),
+    headers: z
+        .record(z.string())
+        .optional()
+        .describe(`
+An object containing optional headers that will be passed along with the original request to the website. For example, this parameter can be used to pass along an authorization token along with the request.
+`),
+    wait_until: z
+        .enum(['domcontentloaded', 'load', 'networkidle', 'commit'])
+        .default('networkidle')
+        .describe(`
+The event to wait for before taking the screenshot. Used for loading Javascript, and images.
+
+See [Playwright's documentation](https://playwright.dev/docs/api/class-page#page-wait-for-load-state) for more information.
+`),
+})
+    .strict();
+export const robotHtmlConvertInstructionsWithHiddenFieldsSchema = robotHtmlConvertInstructionsSchema.extend({
+    debuginfo: z.boolean().optional(),
+    timeouts: z.record(z.unknown()).optional(),
+    actions: z.array(z.record(z.unknown())).optional(),
+    result: z
+        .union([z.literal('debug'), robotHtmlConvertInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotHtmlConvertInstructionsSchema = interpolateRobot(robotHtmlConvertInstructionsSchema);
+export const interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema = interpolateRobot(robotHtmlConvertInstructionsWithHiddenFieldsSchema);
+//# sourceMappingURL=html-convert.js.map

package/dist/alphalib/types/robots/html-convert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-convert.js","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/html-convert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAA;AAErF,MAAM,CAAC,MAAM,IAAI,GAAmB;IAClC,yBAAyB,EAAE,IAAI;IAC/B,UAAU,EAAE,CAAC;IACb,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC;IACf,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,QAAQ,EAAE;gBACR,KAAK,EAAE,eAAe;gBACtB,GAAG,EAAE,yBAAyB;aAC/B;SACF;KACF;IACD,wBAAwB,EAAE,qDAAqD;IAC/E,oBAAoB,EAAE;;;;;;CAMvB;IACC,cAAc,EAAE,OAAO;IACvB,aAAa,EAAE,GAAG;IAClB,aAAa,EAAE,qBAAqB;IACpC,gBAAgB,EAAE,uDAAuD;IACzE,YAAY,EAAE,MAAM;IACpB,YAAY,EAAE,+BAA+B;IAC7C,aAAa,EAAE,4CAA4C;IAC3D,YAAY,EAAE,qBAAqB;IACnC,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,qDAAqD;IAC5D,oBAAoB,EAAE,GAAG;IACzB,iBAAiB,EAAE,SAAS;IAC5B,IAAI,EAAE,kBAAkB;IACxB,WAAW,EAAE,CAAC;IACd,cAAc,EAAE,EAAE;IAClB,aAAa,EAAE,OAAO;IACtB,wBAAwB,EAAE,IAAI;IAC9B,mBAAmB,EAAE,IAAI;IACzB,UAAU,EAAE,KAAK;IACjB,iDAAiD,EAAE,KAAK;IACxD,KAAK,EAAE,IAAI;CACZ,CAAA;AAED,MAAM,CAAC,MAAM,kCAAkC,GAAG,SAAS;KACxD,KAAK,CAAC,QAAQ,CAAC;KACf,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC;;;;CAI9C,CAAC;IACE,GAAG,EAAE,CAAC;SACH,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC;;CAEf,CAAC;IACE,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;SACnC,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC;;CAEf,CAAC;IACE,QAAQ,EAAE,CAAC;SACR,OAAO,EAAE;SACT,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC;;;;;;CAMf,CAAC;IACE,eAAe,EAAE,CAAC;SACf,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC;;;;;;CAMf,CAAC;IACE,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC;;CAEf,CAAC;IACE,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC;;CAEf,CAAC;IACE,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,CAAC,CAAC;SACV,QAAQ,CAAC;;CAEf,CAAC;IACE,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAClB,QAAQ,EAAE;SACV,QAAQ,CAAC;;CAEf,CAAC;IACE,UAAU,EAAE,CAAC;SACV,IAAI,CAAC,CAAC,kBAAkB,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;SAC3D,OAAO,CAAC,aAAa,CAAC;SACtB,QAAQ,CAAC;;;;CAIf,CAAC;CACC,CAAC;KACD,MAAM,EAAE,CAAA;AAEX,MAAM,CAAC,MAAM,kDAAkD,GAC7D,kCAAkC,CAAC,MAAM,CAAC;IACxC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,kCAAkC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SAC5E,QAAQ,EAAE;CACd,CAAC,CAAA;AAOJ,MAAM,CAAC,MAAM,gDAAgD,GAAG,gBAAgB,CAC9E,kCAAkC,CACnC,CAAA;AAQD,MAAM,CAAC,MAAM,gEAAgE,GAAG,gBAAgB,CAC9F,kDAAkD,CACnD,CAAA"}