@transloadit/zod 4.4.1 → 5.0.0

package/dist/v3/robots/http-request.js

@@ -0,0 +1,161 @@
+import { z } from 'zod/v3';
+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(headerValue)),
+        z.record(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/v3/robots/image-bgremove.d.ts

@@ -1,9 +1,10 @@
-import type { RobotMetaInput } from './_instructions-primitives.ts';
+import type { RobotDefinition, RobotMetaInput, RobotSchemaVariantTypes } from './_instructions-primitives.ts';
 import { z } from 'zod/v3';
 export declare const meta: RobotMetaInput;
 export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
-    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodBoolean>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
@@ -64,13 +65,13 @@ export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
     provider: z.ZodDefault<z.ZodEnum<["auto", "transloadit", "replicate", "fal"]>>;
     model: z.ZodOptional<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
-    robot: "/image/bgremove";
     result: boolean;
+    robot: "/image/bgremove";
+    user_meta: Record<string, unknown>;
     force_accept: boolean;
     ignore_errors: string[];
     format: "gif" | "png" | "webp";
-    provider: "auto" | "replicate" | "fal" | "transloadit";
-    interpolate?: boolean | Record<string, boolean> | undefined;
+    provider: "replicate" | "auto" | "fal" | "transloadit";
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -85,13 +86,14 @@ export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
     queue?: "batch" | undefined;
     model?: string | undefined;
     select?: "background" | "foreground" | undefined;
 }, {
     robot: "/image/bgremove";
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    result?: boolean | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -106,19 +108,22 @@ export declare const robotImageBgremoveInstructionsSchema: z.ZodObject<{
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: "batch" | undefined;
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
     model?: string | undefined;
     format?: "gif" | "png" | "webp" | undefined;
-    provider?: "auto" | "replicate" | "fal" | "transloadit" | undefined;
+    provider?: "replicate" | "auto" | "fal" | "transloadit" | undefined;
     select?: "background" | "foreground" | undefined;
 }>;
+export declare const robotDefinition: RobotDefinition<typeof robotImageBgremoveInstructionsSchema.shape>;
 export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
-    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
     force_accept: z.ZodDefault<z.ZodBoolean>;
     ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "execute"]>, "many">]>, string[], boolean | ("meta" | "execute")[]>>;
@@ -179,11 +184,12 @@ export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.Zod
     result: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
 }, "strict", z.ZodTypeAny, {
     robot: "/image/bgremove";
+    user_meta: Record<string, unknown>;
     force_accept: boolean;
     ignore_errors: string[];
     format: "gif" | "png" | "webp";
-    provider: "auto" | "replicate" | "fal" | "transloadit";
-    interpolate?: boolean | Record<string, boolean> | undefined;
+    provider: "replicate" | "auto" | "fal" | "transloadit";
+    result?: boolean | "debug" | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -198,14 +204,14 @@ export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.Zod
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | "debug" | undefined;
     queue?: "batch" | undefined;
     model?: string | undefined;
     select?: "background" | "foreground" | undefined;
 }, {
     robot: "/image/bgremove";
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    result?: boolean | "debug" | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -220,21 +226,20 @@ export declare const robotImageBgremoveInstructionsWithHiddenFieldsSchema: z.Zod
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: boolean | string[] | Record<string, boolean> | undefined;
-    result?: boolean | "debug" | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: "batch" | undefined;
     force_accept?: boolean | undefined;
     ignore_errors?: boolean | ("meta" | "execute")[] | undefined;
     model?: string | undefined;
     format?: "gif" | "png" | "webp" | undefined;
-    provider?: "auto" | "replicate" | "fal" | "transloadit" | undefined;
+    provider?: "replicate" | "auto" | "fal" | "transloadit" | undefined;
     select?: "background" | "foreground" | undefined;
-}>;
-export type RobotImageBgremoveInstructions = z.infer<typeof robotImageBgremoveInstructionsSchema>;
-export type RobotImageBgremoveInstructionsWithHiddenFields = z.infer<typeof robotImageBgremoveInstructionsWithHiddenFieldsSchema>;
-export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodObject<{
-    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
+}>, interpolatableRobotImageBgremoveInstructionsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
@@ -293,13 +298,13 @@ export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodOb
     provider: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEnum<["auto", "transloadit", "replicate", "fal"]>]>>;
     model: z.ZodOptional<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
-    robot: "/image/bgremove";
     result: string | boolean;
+    robot: "/image/bgremove";
+    user_meta: Record<string, unknown>;
     force_accept: string | boolean;
     ignore_errors: string | string[];
     format: string;
     provider: string;
-    interpolate?: boolean | Record<string, boolean> | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -314,13 +319,14 @@ export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodOb
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
     queue?: string | undefined;
     model?: string | undefined;
     select?: string | undefined;
 }, {
     robot: "/image/bgremove";
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    result?: string | boolean | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -335,8 +341,9 @@ export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodOb
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: string | undefined;
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
@@ -344,12 +351,10 @@ export declare const interpolatableRobotImageBgremoveInstructionsSchema: z.ZodOb
     format?: string | undefined;
     provider?: string | undefined;
     select?: string | undefined;
-}>;
-export type InterpolatableRobotImageBgremoveInstructions = InterpolatableRobotImageBgremoveInstructionsInput;
-export type InterpolatableRobotImageBgremoveInstructionsInput = z.input<typeof interpolatableRobotImageBgremoveInstructionsSchema>;
-export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
-    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "false" | "true">>]>>;
+}>, interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    interpolate: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<["true", "false"]>]>, boolean, boolean | "true" | "false">>]>>;
     output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    user_meta: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
     force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
     ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "execute"]>, "many">]>, string[], boolean | ("meta" | "execute")[]>]>>;
@@ -409,11 +414,12 @@ export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenField
     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, {
     robot: "/image/bgremove";
+    user_meta: Record<string, unknown>;
     force_accept: string | boolean;
     ignore_errors: string | string[];
     format: string;
     provider: string;
-    interpolate?: boolean | Record<string, boolean> | undefined;
+    result?: string | boolean | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -428,14 +434,14 @@ export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenField
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
     queue?: string | undefined;
     model?: string | undefined;
     select?: string | undefined;
 }, {
     robot: "/image/bgremove";
-    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    result?: string | boolean | undefined;
     use?: string | string[] | {
         name: string;
         fields?: string | undefined;
@@ -450,8 +456,9 @@ export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenField
         bundle_steps?: boolean | undefined;
         group_by_original?: boolean | undefined;
     } | undefined;
+    interpolate?: boolean | "true" | "false" | Record<string, boolean | "true" | "false"> | undefined;
     output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
-    result?: string | boolean | undefined;
+    user_meta?: Record<string, unknown> | undefined;
     queue?: string | undefined;
     force_accept?: string | boolean | undefined;
     ignore_errors?: string | boolean | ("meta" | "execute")[] | undefined;
@@ -460,6 +467,12 @@ export declare const interpolatableRobotImageBgremoveInstructionsWithHiddenField
     provider?: string | undefined;
     select?: string | undefined;
 }>;
-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/v3/robots/image-bgremove.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image-bgremove.d.ts","sourceRoot":"","sources":["../../../src/v3/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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBtC,CAAA;AAEX,eAAO,MAAM,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK7D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9D,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9E,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/v3/robots/image-bgremove.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,cAYlB,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBtC,CAAA;AAEX,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,OAAO,oCAAoC,CAAC,KAAK,CACtC,CAAA;AAEzD,eAAO,MACa,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACtD,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEhE,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EACnD,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"}

package/dist/v3/robots/image-bgremove.js

@@ -1,39 +1,17 @@
 import { z } from 'zod/v3';
-import { autoProviderDescription, interpolateRobot, robotBase, robotUse, } from "./_instructions-primitives.js";
+import { autoProviderDescription, createProcessingExample, defineRobot, robotBase, robotImageProcessingMeta, robotUse, } from "./_instructions-primitives.js";
 export const meta = {
-    discount_factor: 1,
-    bytescount: 1,
-    discount_pct: 0,
-    example_code: {
-        steps: {
-            remove_background: {
-                robot: '/image/bgremove',
-                use: ':original',
-            },
-        },
-    },
+    ...robotImageProcessingMeta,
+    example_code: createProcessingExample('remove_background', '/image/bgremove'),
     example_code_description: 'Remove the background from the uploaded image:',
-    minimum_charge: 0,
-    output_factor: 0.6,
-    override_lvl1: 'Image Manipulation',
     purpose_sentence: 'removes the background from images',
     purpose_verb: 'remove',
     purpose_word: 'remove',
     purpose_words: 'Remove the background from images',
-    service_slug: 'image-manipulation',
-    slot_count: 10,
     title: 'Remove the background from images',
-    typical_file_size_mb: 0.8,
-    typical_file_type: 'image',
     name: 'ImageBgremoveRobot',
-    priceFactor: 1,
-    queueSlotCount: 10,
     minimumChargeUsd: 0.006,
-    isAllowedForUrlTransform: true,
     trackOutputFileSize: true,
-    isInternal: false,
-    removeJobResultFilesFromDiskRightAfterStoringOnS3: false,
-    stage: 'ga',
 };
 export const robotImageBgremoveInstructionsSchema = robotBase
     .merge(robotUse)
@@ -50,17 +28,12 @@ export const robotImageBgremoveInstructionsSchema = robotBase
     provider: z
         .enum(['auto', 'transloadit', 'replicate', 'fal'])
         .default('auto')
-        .describe(`${autoProviderDescription} Set this to \`"transloadit"\`, \`"replicate"\`, or \`"fal"\` to force a specific provider.`),
+        .describe(`${autoProviderDescription}\n\nSelect a specific provider to override automatic selection.`),
     model: z
         .string()
         .optional()
         .describe('Provider-specific model to use for removing the background. Mostly intended for testing and evaluation.'),
 })
     .strict();
-export const robotImageBgremoveInstructionsWithHiddenFieldsSchema = robotImageBgremoveInstructionsSchema.extend({
-    result: z
-        .union([z.literal('debug'), robotImageBgremoveInstructionsSchema.shape.result])
-        .optional(),
-});
-export const interpolatableRobotImageBgremoveInstructionsSchema = interpolateRobot(robotImageBgremoveInstructionsSchema);
-export const interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema = interpolateRobot(robotImageBgremoveInstructionsWithHiddenFieldsSchema);
+export const robotDefinition = defineRobot(meta, robotImageBgremoveInstructionsSchema);
+export const { withHiddenFields: robotImageBgremoveInstructionsWithHiddenFieldsSchema, interpolatable: interpolatableRobotImageBgremoveInstructionsSchema, interpolatableWithHiddenFields: interpolatableRobotImageBgremoveInstructionsWithHiddenFieldsSchema, } = robotDefinition;