@transloadit/zod 4.1.5 → 4.1.7

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

@@ -0,0 +1,110 @@
+import { z } from 'zod/v4';
+import { googleBase, interpolateRobot, robotBase, robotUse } from "./_instructions-primitives.js";
+export const meta = {
+    allowed_for_url_transform: true,
+    bytescount: 6,
+    discount_factor: 0.15000150001500018,
+    discount_pct: 84.99984999849998,
+    example_code: {
+        steps: {
+            exported: {
+                robot: '/google/store',
+                use: ':original',
+                credentials: 'YOUR_GOOGLE_CREDENTIALS',
+                path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+            },
+        },
+    },
+    example_code_description: 'Export uploaded files to `my_target_folder` on Google Storage:',
+    has_small_icon: true,
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'File Exporting',
+    purpose_sentence: 'exports encoding results to Google Storage',
+    purpose_verb: 'export',
+    purpose_word: 'Google Storage',
+    purpose_words: 'Export files to Google Storage',
+    service_slug: 'file-exporting',
+    slot_count: 10,
+    title: 'Export files to Google Storage',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+    name: 'GoogleStoreRobot',
+    priceFactor: 6.6666,
+    queueSlotCount: 10,
+    isAllowedForUrlTransform: true,
+    trackOutputFileSize: false,
+    isInternal: false,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
+    stage: 'ga',
+};
+export const robotGoogleStoreInstructionsSchema = robotBase
+    .merge(robotUse)
+    .merge(googleBase)
+    .extend({
+    robot: z.literal('/google/store').describe(`
+The URL to the exported file in your Google bucket will be presented in the Transloadit <dfn>Assembly Status</dfn> JSON. This <dfn>Robot</dfn> can also be used to export encoded files to Google's Firebase as demonstrated in [this blogpost](/blog/2018/12/2h-youtube-clone/).
+`),
+    result: z
+        .boolean()
+        .optional()
+        .describe('Whether the results of this Step should be present in the Assembly Status JSON'),
+    credentials: z.string().describe(`
+Create a new [Google service account](https://cloud.google.com/storage/docs/authentication). Set its role to "Storage Object Creator". Choose "JSON" for the key file format and download it to your computer. You will need to upload this file when creating your <dfn>Template Credentials</dfn>.
+
+Go back to your Google credentials project and enable the "Google Cloud Storage JSON API" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.
+
+Now you can set up the \`storage.objects.create\` and \`storage.objects.delete\` permissions. The latter is optional and only required if you intend to overwrite existing paths.
+
+To do this from the Google Cloud console, navigate to "IAM &amp; Admin" and select "Roles". From here, click "Create Role", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.
+
+Next, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "Add Member", enter your service account as a new member, and select your newly created role.
+
+Then, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value.
+`),
+    path: z
+        .string()
+        .default('${unique_prefix}/${file.url_name}')
+        .describe(`
+The path at which the file is to be stored. This may include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables).
+`),
+    acl: z
+        .enum([
+        'authenticated-read',
+        'bucket-owner-full-control',
+        'private',
+        'project-private',
+        'public-read',
+    ])
+        .nullable()
+        .default('public-read')
+        .describe(`
+The permissions used for this file.
+`),
+    cache_control: z
+        .string()
+        .optional()
+        .describe(`
+The \`Cache-Control\` header determines how long browsers are allowed to cache your object for. Values specified with this parameter will be added to the object's metadata under the \`Cache-Control\` header. For more information on valid values, take a look at the [official Google documentation](https://cloud.google.com/storage/docs/metadata#cache-control).
+`),
+    url_template: z
+        .string()
+        .default('https://{HOST}/{PATH}')
+        .describe(`
+The URL of the file in the result JSON. This may include any of the following supported [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables).
+`),
+    ssl_url_template: z
+        .string()
+        .default('https://{HOST}/{PATH}')
+        .describe(`
+The SSL URL of the file in the result JSON. The following [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables) are supported.
+`),
+})
+    .strict();
+export const robotGoogleStoreInstructionsWithHiddenFieldsSchema = robotGoogleStoreInstructionsSchema.extend({
+    result: z
+        .union([z.literal('debug'), robotGoogleStoreInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotGoogleStoreInstructionsSchema = interpolateRobot(robotGoogleStoreInstructionsSchema);
+export const interpolatableRobotGoogleStoreInstructionsWithHiddenFieldsSchema = interpolateRobot(robotGoogleStoreInstructionsWithHiddenFieldsSchema);

package/dist/v4/robots/html-convert.d.ts

@@ -0,0 +1,200 @@
+import { z } from 'zod/v4';
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+export declare const meta: RobotMetaInput;
+export declare const robotHtmlConvertInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodEnum<{
+        pdf: "pdf";
+        jpeg: "jpeg";
+        jpg: "jpg";
+        png: "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: "domcontentloaded";
+        load: "load";
+        networkidle: "networkidle";
+        commit: "commit";
+    }>>;
+}, z.core.$strict>;
+export declare const robotHtmlConvertInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodEnum<{
+        pdf: "pdf";
+        jpeg: "jpeg";
+        jpg: "jpg";
+        png: "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: "domcontentloaded";
+        load: "load";
+        networkidle: "networkidle";
+        commit: "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>>>;
+    result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, z.core.$strict>;
+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>]>]>>;
+    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        pdf: "pdf";
+        jpeg: "jpeg";
+        jpg: "jpg";
+        png: "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: "domcontentloaded";
+        load: "load";
+        networkidle: "networkidle";
+        commit: "commit";
+    }>]>>;
+}, z.core.$strict>;
+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>]>]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    use: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>]>, z.ZodObject<{
+        steps: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+    robot: z.ZodLiteral<"/html/convert">;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        pdf: "pdf";
+        jpeg: "jpeg";
+        jpg: "jpg";
+        png: "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: "domcontentloaded";
+        load: "load";
+        networkidle: "networkidle";
+        commit: "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>>]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+}, z.core.$strict>;
+export type InterpolatableRobotHtmlConvertInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema>;
+export type InterpolatableRobotHtmlConvertInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=html-convert.d.ts.map

package/dist/v4/robots/html-convert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-convert.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/html-convert.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,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA+EpC,CAAA;AAEX,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAQ3D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE5D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE5E,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/v4/robots/html-convert.js

@@ -0,0 +1,135 @@
+import { z } from 'zod/v4';
+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(), 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.string(), z.unknown()).optional(),
+    actions: z.array(z.record(z.string(), z.unknown())).optional(),
+    result: z
+        .union([z.literal('debug'), robotHtmlConvertInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotHtmlConvertInstructionsSchema = interpolateRobot(robotHtmlConvertInstructionsSchema);
+export const interpolatableRobotHtmlConvertInstructionsWithHiddenFieldsSchema = interpolateRobot(robotHtmlConvertInstructionsWithHiddenFieldsSchema);

package/dist/v4/robots/http-import.d.ts

@@ -0,0 +1,104 @@
+import { z } from 'zod/v4';
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+export declare const meta: RobotMetaInput;
+export declare const robotHttpImportInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        import: "import";
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("import" | "meta" | "execute")[]>>>;
+    robot: z.ZodLiteral<"/http/import">;
+    url: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+    url_delimiter: z.ZodDefault<z.ZodString>;
+    headers: z.ZodDefault<z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>, z.ZodString]>>;
+    import_on_errors: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    fail_fast: z.ZodDefault<z.ZodBoolean>;
+    return_file_stubs: z.ZodDefault<z.ZodBoolean>;
+    range: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+}, z.core.$strict>;
+export declare const robotHttpImportInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    ignore_errors: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        import: "import";
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("import" | "meta" | "execute")[]>>>;
+    robot: z.ZodLiteral<"/http/import">;
+    url_delimiter: z.ZodDefault<z.ZodString>;
+    headers: z.ZodDefault<z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>, z.ZodString]>>;
+    import_on_errors: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    fail_fast: z.ZodDefault<z.ZodBoolean>;
+    return_file_stubs: z.ZodDefault<z.ZodBoolean>;
+    range: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    force_original_id: z.ZodOptional<z.ZodString>;
+    force_name: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
+    result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+}, z.core.$strict>;
+export type RobotHttpImportInstructions = z.infer<typeof robotHttpImportInstructionsSchema>;
+export type RobotHttpImportInstructionsWithHiddenFields = z.infer<typeof robotHttpImportInstructionsWithHiddenFieldsSchema>;
+export declare const interpolatableRobotHttpImportInstructionsSchema: 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>]>]>>;
+    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        import: "import";
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("import" | "meta" | "execute")[]>>]>>;
+    robot: z.ZodLiteral<"/http/import">;
+    url: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>;
+    url_delimiter: z.ZodDefault<z.ZodString>;
+    headers: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>]>, z.ZodString]>>;
+    import_on_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>>;
+    fail_fast: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    return_file_stubs: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    range: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+}, z.core.$strict>;
+export type InterpolatableRobotHttpImportInstructions = InterpolatableRobotHttpImportInstructionsInput;
+export type InterpolatableRobotHttpImportInstructionsInput = z.input<typeof interpolatableRobotHttpImportInstructionsSchema>;
+export declare const interpolatableRobotHttpImportInstructionsWithHiddenFieldsSchema: 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>]>]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        import: "import";
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("import" | "meta" | "execute")[]>>]>>;
+    robot: z.ZodLiteral<"/http/import">;
+    url_delimiter: z.ZodDefault<z.ZodString>;
+    headers: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>>]>, z.ZodString]>>;
+    import_on_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>>;
+    fail_fast: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    return_file_stubs: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    range: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    force_original_id: z.ZodOptional<z.ZodString>;
+    force_name: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodString, 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]>>]>>;
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+}, z.core.$strict>;
+export type InterpolatableRobotHttpImportInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotHttpImportInstructionsWithHiddenFieldsSchema>;
+export type InterpolatableRobotHttpImportInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotHttpImportInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=http-import.d.ts.map

package/dist/v4/robots/http-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-import.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/http-import.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAQnE,eAAO,MAAM,IAAI,EAAE,cAkClB,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;kBA8EnC,CAAA;AAEX,eAAO,MAAM,iDAAiD;;;;;;;;;;;;;;;;;;;;;;;;kBAgB1D,CAAA;AAEJ,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAC3F,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,iDAAiD,CACzD,CAAA;AAED,eAAO,MAAM,+CAA+C;;;;;;;;;;;;;;;;;;;;;kBAE3D,CAAA;AACD,MAAM,MAAM,yCAAyC,GACnD,8CAA8C,CAAA;AAEhD,MAAM,MAAM,8CAA8C,GAAG,CAAC,CAAC,KAAK,CAClE,OAAO,+CAA+C,CACvD,CAAA;AAED,eAAO,MAAM,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;kBAE3E,CAAA;AACD,MAAM,MAAM,yDAAyD,GAAG,CAAC,CAAC,KAAK,CAC7E,OAAO,+DAA+D,CACvE,CAAA;AACD,MAAM,MAAM,8DAA8D,GAAG,CAAC,CAAC,KAAK,CAClF,OAAO,+DAA+D,CACvE,CAAA"}