@transloadit/zod 4.5.0 → 5.0.0

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

@@ -0,0 +1,231 @@
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
+import { z } from 'zod/v4';
+export declare const meta: RobotMetaInput;
+export declare const robotHttpRequestInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    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<"/http/request">;
+    url: z.ZodString;
+    method: z.ZodDefault<z.ZodEnum<{
+        POST: "POST";
+        DELETE: "DELETE";
+        GET: "GET";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>>;
+    payload: z.ZodDefault<z.ZodEnum<{
+        file: "file";
+        none: "none";
+        metadata: "metadata";
+        files: "files";
+    }>>;
+    headers: z.ZodDefault<z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull]>>>, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull]>>, z.ZodString]>>;
+    timeout: z.ZodDefault<z.ZodNumber>;
+    max_response_size: z.ZodDefault<z.ZodNumber>;
+    max_result_files: z.ZodDefault<z.ZodNumber>;
+    max_result_file_size: z.ZodDefault<z.ZodNumber>;
+    result_download_timeout: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotHttpRequestInstructionsSchema.shape>;
+export declare const robotHttpRequestInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    queue: z.ZodOptional<z.ZodEnum<{
+        batch: "batch";
+    }>>;
+    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<"/http/request">;
+    url: z.ZodString;
+    method: z.ZodDefault<z.ZodEnum<{
+        POST: "POST";
+        DELETE: "DELETE";
+        GET: "GET";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>>;
+    payload: z.ZodDefault<z.ZodEnum<{
+        file: "file";
+        none: "none";
+        metadata: "metadata";
+        files: "files";
+    }>>;
+    headers: z.ZodDefault<z.ZodUnion<readonly [z.ZodArray<z.ZodString>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull]>>>, z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull]>>, z.ZodString]>>;
+    timeout: z.ZodDefault<z.ZodNumber>;
+    max_response_size: z.ZodDefault<z.ZodNumber>;
+    max_result_files: z.ZodDefault<z.ZodNumber>;
+    max_result_file_size: z.ZodDefault<z.ZodNumber>;
+    result_download_timeout: z.ZodDefault<z.ZodNumber>;
+    result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, z.core.$strict>, interpolatableRobotHttpRequestInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    result: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    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<"/http/request">;
+    url: z.ZodString;
+    method: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        POST: "POST";
+        DELETE: "DELETE";
+        GET: "GET";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>]>>;
+    payload: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        file: "file";
+        none: "none";
+        metadata: "metadata";
+        files: "files";
+    }>]>>;
+    headers: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodString, z.ZodNull]>>>]>, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodString, z.ZodNull]>>, z.ZodString]>>;
+    timeout: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_response_size: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_result_files: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_result_file_size: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    result_download_timeout: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+}, z.core.$strict>, interpolatableRobotHttpRequestInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        batch: "batch";
+    }>]>>;
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+        meta: "meta";
+        execute: "execute";
+    }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
+    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<"/http/request">;
+    url: z.ZodString;
+    method: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        POST: "POST";
+        DELETE: "DELETE";
+        GET: "GET";
+        PATCH: "PATCH";
+        PUT: "PUT";
+    }>]>>;
+    payload: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+        file: "file";
+        none: "none";
+        metadata: "metadata";
+        files: "files";
+    }>]>>;
+    headers: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodString, z.ZodNull]>>>]>, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodNumber]>, z.ZodString, z.ZodNull]>>, z.ZodString]>>;
+    timeout: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_response_size: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_result_files: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    max_result_file_size: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    result_download_timeout: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+}, z.core.$strict>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotHttpRequestInstructions = Instructions['output'];
+export type RobotHttpRequestInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotHttpRequestInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotHttpRequestInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotHttpRequestInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotHttpRequestInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
+//# sourceMappingURL=http-request.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"http-request.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/http-request.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;AAW1B,eAAO,MAAM,IAAI,EAAE,cAiDlB,CAAA;AAGD,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA0GpC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,kCAAkC,CAAC,KAAK,CACtC,CAAA;AAEvD,eAAO,MACa,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBACpD,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAChC,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAC/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,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/v4/robots/http-request.js

@@ -0,0 +1,161 @@
+import { z } from 'zod/v4';
+import { defineRobot, httpHeaderSafetyDescription, httpUrlSchema, robotBase, robotCodeEvaluationMeta, robotUse, } from "./_instructions-primitives.js";
+export const meta = {
+    ...robotCodeEvaluationMeta,
+    example_code: {
+        steps: {
+            request: {
+                robot: '/http/request',
+                method: 'POST',
+                payload: 'metadata',
+                url: 'https://example.com/transloadit/files',
+                use: [],
+            },
+        },
+    },
+    example_code_description: 'Ask your application which input files should continue:',
+    extended_description: `
+Use this <dfn>Robot</dfn> when your application should inspect the current Assembly state or input
+files during an Assembly and return which input files should continue to later, statically declared
+Steps, or return new result-file URLs that Transloadit should download and emit from this Step.
+
+Request format:
+
+- \`payload: "none"\` sends no request body.
+- \`payload: "metadata"\` sends \`application/json\` with \`assembly\`, \`fields\`,
+  \`previous_step\`, \`file\`, and \`files\`.
+- \`payload: "file"\` sends \`multipart/form-data\` with a \`payload\` JSON field and the first input
+  file as form part \`file\`.
+- \`payload: "files"\` sends \`multipart/form-data\` with a \`payload\` JSON field and all input files
+  as repeated form parts named \`files[]\`.
+
+Your endpoint must respond with a 2xx status. It can return an empty body, \`[]\`, a single file
+object, an array of file objects, or an object with \`files\` as an array or object map. Returned
+files must include either:
+
+- \`path\`: Selects an input file path that was sent in the request payload.
+- \`url\`: Downloads a new HTTP(S) result file and emits it from this Step.
+
+The response never changes the Assembly flow. To process returned files, declare the following Steps
+in the Assembly Template and use this Step as their input.
+`,
+    override_lvl1: 'Workflow Automation',
+    purpose_sentence: 'calls your application during an Assembly and emits returned input file references',
+    purpose_verb: 'run',
+    purpose_word: 'HTTP endpoint',
+    purpose_words: 'Call HTTP endpoints',
+    title: 'Call HTTP endpoints during Assemblies',
+    name: 'HttpRequestRobot',
+    queueSlotCount: 1,
+    stage: 'alpha',
+};
+const headerValue = z.union([z.boolean(), z.number(), z.string(), z.null()]);
+export const robotHttpRequestInstructionsSchema = robotBase
+    .merge(robotUse)
+    .extend({
+    robot: z.literal('/http/request').describe(`
+Calls an HTTP endpoint during the Assembly and expects optional JSON describing zero or more input
+files or result-file URLs to emit from this Step.
+
+Your endpoint must return a 2xx response. An empty body, \`[]\`, or \`{ "files": [] }\` means this
+Step emits no files. You can also return one file object, an array of file objects, or
+\`{ "files": [...] }\` / \`{ "files": { "name": {...} } }\`. Returned file objects must include
+either a \`path\` that matches one of the input file paths sent to your endpoint, or an HTTP(S)
+\`url\` that Transloadit downloads and emits as a new result file.
+`),
+    url: httpUrlSchema.describe(`
+The HTTP or HTTPS endpoint to call.
+`),
+    method: z
+        .enum(['DELETE', 'GET', 'PATCH', 'POST', 'PUT'])
+        .default('POST')
+        .describe(`
+HTTP method to use for the request.
+`),
+    payload: z
+        .enum(['none', 'metadata', 'file', 'files'])
+        .default('none')
+        .describe(`
+Controls what is sent to your endpoint.
+
+- \`none\`: Send no request body.
+- \`metadata\`: Send a JSON body with Assembly metadata, fields, the previous Step, and file metadata.
+- \`file\`: Send multipart form data with a \`payload\` JSON field and the first input file as a
+  \`file\` part.
+- \`files\`: Send multipart form data with a \`payload\` JSON field and all input files as repeated
+  \`files[]\` parts. Useful with \`bundle_steps\`.
+
+The \`payload\` JSON object contains \`assembly\`, \`fields\`, \`previous_step\`, \`file\`, and
+\`files\`. \`file\` is the first input file’s metadata or \`null\`; \`files\` is an array of input
+file metadata.
+`),
+    headers: z
+        .union([
+        z.array(z.string()),
+        z.array(z.record(z.string(), headerValue)),
+        z.record(z.string(), headerValue),
+        z.string(),
+    ])
+        .default([])
+        .describe(`
+Custom request headers.
+
+Headers can be specified as an array of strings in the format \`"Header-Name: value"\`, an array
+of objects, an object map, or a JSON string that will be parsed into an object/array.
+
+${httpHeaderSafetyDescription}
+`),
+    timeout: z
+        .number()
+        .int()
+        .positive()
+        .max(300)
+        .default(60)
+        .describe(`
+Maximum number of seconds to wait for the HTTP request.
+
+The effective timeout is the lower of this value and Transloadit’s server-side cap. The cap is 30
+seconds plus 1 second per MiB sent to your endpoint.
+`),
+    max_response_size: z
+        .number()
+        .int()
+        .positive()
+        .max(10 * 1024 * 1024)
+        .default(1024 * 1024)
+        .describe(`
+Maximum accepted response size in bytes. The response should normally be a small JSON document.
+`),
+    max_result_files: z
+        .number()
+        .int()
+        .positive()
+        .max(100)
+        .default(10)
+        .describe(`
+Maximum number of files that the endpoint may return.
+`),
+    max_result_file_size: z
+        .number()
+        .int()
+        .positive()
+        .max(5 * 1024 * 1024 * 1024)
+        .default(100 * 1024 * 1024)
+        .describe(`
+Maximum allowed size in bytes for each result file returned by URL. If the remote server reports a
+larger file size, the result download is rejected before it starts. If the remote server does not
+report a size upfront, the download is aborted once this limit is exceeded.
+`),
+    result_download_timeout: z
+        .number()
+        .int()
+        .positive()
+        .max(600)
+        .default(120)
+        .describe(`
+Maximum number of seconds to spend downloading each result file returned by URL.
+`),
+})
+    .strict();
+export const robotDefinition = defineRobot(meta, robotHttpRequestInstructionsSchema);
+export const { withHiddenFields: robotHttpRequestInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotHttpRequestInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotHttpRequestInstructionsWithHiddenFieldsSchema, } = robotDefinition;

package/dist/v4/robots/image-bgremove.d.ts

@@ -1,15 +1,16 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts';
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
 import { z } from 'zod/v4';
 export declare const meta: RobotMetaInput;
 export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
@@ -44,22 +45,24 @@ export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
         webp: "webp";
     }>>;
     provider: z.ZodDefault<z.ZodEnum<{
-        auto: "auto";
         replicate: "replicate";
+        auto: "auto";
         fal: "fal";
         transloadit: "transloadit";
     }>>;
     model: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
+export declare const robotDefinition: RobotDefinition<typeof robotImageBgremoveInstructionsSchema.shape>;
 export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodEnum<{
         batch: "batch";
     }>>;
@@ -93,31 +96,29 @@ export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.Zod
         webp: "webp";
     }>>;
     provider: z.ZodDefault<z.ZodEnum<{
-        auto: "auto";
         replicate: "replicate";
+        auto: "auto";
         fal: "fal";
         transloadit: "transloadit";
     }>>;
     model: z.ZodOptional<z.ZodString>;
     result: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
-}, z.core.$strict>;
-export type RobotImageBgremoveInstructions = z.infer<typeof robotImageBgremoveInstructionsSchema>;
-export type RobotImageBgremoveInstructionsWithHiddenFields = z.infer<typeof robotImageBgremoveInstructionsWithHiddenFieldsSchema>;
-export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotImageBgremoveInstructionsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
-    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    result: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         batch: "batch";
     }>]>>;
-    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
-    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
         meta: "meta";
         execute: "execute";
     }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
@@ -140,35 +141,33 @@ export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodOb
         background: "background";
         foreground: "foreground";
     }>]>>;
-    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    format: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         gif: "gif";
         png: "png";
         webp: "webp";
     }>]>>;
-    provider: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
-        auto: "auto";
+    provider: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         replicate: "replicate";
+        auto: "auto";
         fal: "fal";
         transloadit: "transloadit";
     }>]>>;
     model: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
-export type InterpolatableRobotImageBgremoveInstructions = InterpolatableRobotImageBgremoveInstructionsInput;
-export type InterpolatableRobotImageBgremoveInstructionsInput = z.input<typeof interpolatableRobotImageBgremoveInstructionsSchema>;
-export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+}, z.core.$strict>, interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
     interpolate: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-        false: "false";
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>, z.ZodRecord<z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
         true: "true";
-    }>]>, z.ZodTransform<boolean, boolean | "false" | "true">>>]>>;
+        false: "false";
+    }>]>, z.ZodTransform<boolean, boolean | "true" | "false">>>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>]>>;
+    user_meta: z.ZodPrefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         batch: "batch";
     }>]>>;
-    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
-    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
+    force_accept: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    ignore_errors: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodEnum<{
         meta: "meta";
         execute: "execute";
     }>>]>, z.ZodTransform<string[], boolean | ("meta" | "execute")[]>>]>>;
@@ -191,20 +190,26 @@ export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenField
         background: "background";
         foreground: "foreground";
     }>]>>;
-    format: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
+    format: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         gif: "gif";
         png: "png";
         webp: "webp";
     }>]>>;
-    provider: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
-        auto: "auto";
+    provider: z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodEnum<{
         replicate: "replicate";
+        auto: "auto";
         fal: "fal";
         transloadit: "transloadit";
     }>]>>;
     model: z.ZodOptional<z.ZodString>;
-    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
+    result: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodUnion<[z.ZodString, z.ZodLiteral<"debug">]>, z.ZodPrefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>]>>;
 }, z.core.$strict>;
-export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema>;
-export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema>;
+type Instructions = RobotSchemaVariantTypes<typeof robotDefinition>;
+export type RobotImageBgremoveInstructions = Instructions['output'];
+export type RobotImageBgremoveInstructionsWithHiddenFields = Instructions['hiddenOutput'];
+export type InterpolatableRobotImageBgremoveInstructions = Instructions['interpolatableInput'];
+export type InterpolatableRobotImageBgremoveInstructionsInput = Instructions['interpolatableInput'];
+export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFields = Instructions['interpolatableHiddenOutput'];
+export type InterpolatableRobotImageBgremoveInstructionsWithHiddenFieldsInput = Instructions['interpolatableHiddenInput'];
+export {};
 //# sourceMappingURL=image-bgremove.d.ts.map

package/dist/v4/robots/image-bgremove.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image-bgremove.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/image-bgremove.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAS1B,eAAO,MAAM,IAAI,EAAE,cAkClB,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAyBtC,CAAA;AAEX,eAAO,MAAM,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAK7D,CAAA;AAEJ,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AACjG,MAAM,MAAM,8CAA8C,GAAG,CAAC,CAAC,KAAK,CAClE,OAAO,oDAAoD,CAC5D,CAAA;AAED,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE9D,CAAA;AACD,MAAM,MAAM,4CAA4C,GACtD,iDAAiD,CAAA;AAEnD,MAAM,MAAM,iDAAiD,GAAG,CAAC,CAAC,KAAK,CACrE,OAAO,kDAAkD,CAC1D,CAAA;AAED,eAAO,MAAM,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAE9E,CAAA;AACD,MAAM,MAAM,4DAA4D,GAAG,CAAC,CAAC,KAAK,CAChF,OAAO,kEAAkE,CAC1E,CAAA;AACD,MAAM,MAAM,iEAAiE,GAAG,CAAC,CAAC,KAAK,CACrF,OAAO,kEAAkE,CAC1E,CAAA"}
+{"version":3,"file":"image-bgremove.d.ts","sourceRoot":"","sources":["../../../src/v4/robots/image-bgremove.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,uBAAuB,EACxB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAW1B,eAAO,MAAM,IAAI,EAAE,cAYlB,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAuBtC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,oCAAoC,CAAC,KAAK,CACtC,CAAA;AAEzD,eAAO,MACa,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBACtD,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAEhE,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBACnD,CAAA;AAEnB,KAAK,YAAY,GAAG,uBAAuB,CAAC,OAAO,eAAe,CAAC,CAAA;AAEnE,MAAM,MAAM,8BAA8B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AACnE,MAAM,MAAM,8CAA8C,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AACzF,MAAM,MAAM,4CAA4C,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AAC9F,MAAM,MAAM,iDAAiD,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAA;AACnG,MAAM,MAAM,4DAA4D,GACtE,YAAY,CAAC,4BAA4B,CAAC,CAAA;AAC5C,MAAM,MAAM,iEAAiE,GAC3E,YAAY,CAAC,2BAA2B,CAAC,CAAA"}