@transloadit/zod 4.3.5 → 4.4.1

package/dist/v3/robots/transloadit-import.d.ts

@@ -0,0 +1,195 @@
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+import { z } from 'zod/v3';
+/** Cross-field validation runs after interpolation-aware parsing at the Assembly Step boundary. */
+export declare function refineTransloaditImportSelector(step: {
+    robot: string;
+    path?: unknown;
+    asset_id?: unknown;
+    version_id?: unknown;
+    recursive?: unknown;
+}, context: z.RefinementCtx): void;
+export declare const meta: RobotMetaInput;
+export declare const robotTransloaditImportInstructionsSchema: 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">>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+} & {
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>>;
+    ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "import", "execute"]>, "many">]>, string[], boolean | ("import" | "meta" | "execute")[]>>;
+    import_on_errors: z.ZodDefault<z.ZodArray<z.ZodEnum<["meta"]>, "many">>;
+} & {
+    robot: z.ZodLiteral<"/transloadit/import">;
+    path: z.ZodOptional<z.ZodString>;
+    asset_id: z.ZodOptional<z.ZodString>;
+    version_id: z.ZodOptional<z.ZodString>;
+    recursive: z.ZodDefault<z.ZodBoolean>;
+}, "strict", z.ZodTypeAny, {
+    robot: "/transloadit/import";
+    result: boolean;
+    force_accept: boolean;
+    ignore_errors: string[];
+    force_name: string | string[] | null;
+    import_on_errors: "meta"[];
+    recursive: boolean;
+    path?: string | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}, {
+    robot: "/transloadit/import";
+    path?: string | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    result?: boolean | undefined;
+    queue?: "batch" | undefined;
+    force_accept?: boolean | undefined;
+    ignore_errors?: boolean | ("import" | "meta" | "execute")[] | undefined;
+    force_name?: string | string[] | null | undefined;
+    import_on_errors?: "meta"[] | undefined;
+    recursive?: boolean | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}>;
+export declare const robotTransloaditImportInstructionsWithHiddenFieldsSchema: 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">>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>>;
+    ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "import", "execute"]>, "many">]>, string[], boolean | ("import" | "meta" | "execute")[]>>;
+    import_on_errors: z.ZodDefault<z.ZodArray<z.ZodEnum<["meta"]>, "many">>;
+    robot: z.ZodLiteral<"/transloadit/import">;
+    path: z.ZodOptional<z.ZodString>;
+    asset_id: z.ZodOptional<z.ZodString>;
+    version_id: z.ZodOptional<z.ZodString>;
+    recursive: z.ZodDefault<z.ZodBoolean>;
+} & {
+    result: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, "strict", z.ZodTypeAny, {
+    robot: "/transloadit/import";
+    force_accept: boolean;
+    ignore_errors: string[];
+    force_name: string | string[] | null;
+    import_on_errors: "meta"[];
+    recursive: boolean;
+    path?: string | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    result?: boolean | "debug" | undefined;
+    queue?: "batch" | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}, {
+    robot: "/transloadit/import";
+    path?: string | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    result?: boolean | "debug" | undefined;
+    queue?: "batch" | undefined;
+    force_accept?: boolean | undefined;
+    ignore_errors?: boolean | ("import" | "meta" | "execute")[] | undefined;
+    force_name?: string | string[] | null | undefined;
+    import_on_errors?: "meta"[] | undefined;
+    recursive?: boolean | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}>;
+export type RobotTransloaditImportInstructions = z.infer<typeof robotTransloaditImportInstructionsSchema>;
+export type RobotTransloaditImportInstructionsWithHiddenFields = z.infer<typeof robotTransloaditImportInstructionsWithHiddenFieldsSchema>;
+export declare const interpolatableRobotTransloaditImportInstructionsSchema: 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">>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "import", "execute"]>, "many">]>, string[], boolean | ("import" | "meta" | "execute")[]>]>>;
+    import_on_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodEnum<["meta"]>]>, "many">]>>;
+    robot: z.ZodLiteral<"/transloadit/import">;
+    path: z.ZodOptional<z.ZodString>;
+    asset_id: z.ZodOptional<z.ZodString>;
+    version_id: z.ZodOptional<z.ZodString>;
+} & {
+    recursive: z.ZodUnion<[z.ZodDefault<z.ZodBoolean>, z.ZodEffects<z.ZodEnum<["true", "false"]>, boolean, "false" | "true">, z.ZodType<`\${${string}}`, z.ZodTypeDef, `\${${string}}`>]>;
+}, "strict", z.ZodTypeAny, {
+    robot: "/transloadit/import";
+    result: string | boolean;
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    force_name: string | string[] | null;
+    import_on_errors: string | string[];
+    recursive: boolean | `\${${string}}`;
+    path?: string | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}, {
+    robot: "/transloadit/import";
+    path?: string | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    result?: string | boolean | undefined;
+    queue?: string | undefined;
+    force_accept?: string | boolean | undefined;
+    ignore_errors?: string | boolean | ("import" | "meta" | "execute")[] | undefined;
+    force_name?: string | string[] | null | undefined;
+    import_on_errors?: string | string[] | undefined;
+    recursive?: boolean | "false" | "true" | `\${${string}}` | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}>;
+export type InterpolatableRobotTransloaditImportInstructions = InterpolatableRobotTransloaditImportInstructionsInput;
+export type InterpolatableRobotTransloaditImportInstructionsInput = z.input<typeof interpolatableRobotTransloaditImportInstructionsSchema>;
+export declare const interpolatableRobotTransloaditImportInstructionsWithHiddenFieldsSchema: 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">>]>>;
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    force_name: z.ZodDefault<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>>;
+    ignore_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "import", "execute"]>, "many">]>, string[], boolean | ("import" | "meta" | "execute")[]>]>>;
+    import_on_errors: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodEnum<["meta"]>]>, "many">]>>;
+    robot: z.ZodLiteral<"/transloadit/import">;
+    path: z.ZodOptional<z.ZodString>;
+    asset_id: z.ZodOptional<z.ZodString>;
+    version_id: 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]>>]>>;
+} & {
+    recursive: z.ZodUnion<[z.ZodDefault<z.ZodBoolean>, z.ZodEffects<z.ZodEnum<["true", "false"]>, boolean, "false" | "true">, z.ZodType<`\${${string}}`, z.ZodTypeDef, `\${${string}}`>]>;
+}, "strict", z.ZodTypeAny, {
+    robot: "/transloadit/import";
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    force_name: string | string[] | null;
+    import_on_errors: string | string[];
+    recursive: boolean | `\${${string}}`;
+    path?: string | undefined;
+    interpolate?: boolean | Record<string, boolean> | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    result?: string | boolean | undefined;
+    queue?: string | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}, {
+    robot: "/transloadit/import";
+    path?: string | undefined;
+    interpolate?: boolean | "false" | "true" | Record<string, boolean | "false" | "true"> | undefined;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    result?: string | boolean | undefined;
+    queue?: string | undefined;
+    force_accept?: string | boolean | undefined;
+    ignore_errors?: string | boolean | ("import" | "meta" | "execute")[] | undefined;
+    force_name?: string | string[] | null | undefined;
+    import_on_errors?: string | string[] | undefined;
+    recursive?: boolean | "false" | "true" | `\${${string}}` | undefined;
+    asset_id?: string | undefined;
+    version_id?: string | undefined;
+}>;
+export type InterpolatableRobotTransloaditImportInstructionsWithHiddenFields = InterpolatableRobotTransloaditImportInstructionsWithHiddenFieldsInput;
+export type InterpolatableRobotTransloaditImportInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotTransloaditImportInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=transloadit-import.d.ts.map

package/dist/v3/robots/transloadit-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transloadit-import.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/transloadit-import.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAY1B,mGAAmG;AACnG,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE;IACJ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,EACD,OAAO,EAAE,CAAC,CAAC,aAAa,GACvB,IAAI,CAkBN;AAOD,eAAO,MAAM,IAAI,EAAE,cAiClB,CAAA;AAED,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyB1C,CAAA;AAEX,eAAO,MAAM,wDAAwD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKjE,CAAA;AAEJ,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,wCAAwC,CAChD,CAAA;AACD,MAAM,MAAM,kDAAkD,GAAG,CAAC,CAAC,KAAK,CACtE,OAAO,wDAAwD,CAChE,CAAA;AAED,eAAO,MAAM,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYjE,CAAA;AACF,MAAM,MAAM,gDAAgD,GAC1D,qDAAqD,CAAA;AAEvD,MAAM,MAAM,qDAAqD,GAAG,CAAC,CAAC,KAAK,CACzE,OAAO,sDAAsD,CAC9D,CAAA;AAED,eAAO,MAAM,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG/E,CAAA;AACJ,MAAM,MAAM,gEAAgE,GAC1E,qEAAqE,CAAA;AACvE,MAAM,MAAM,qEAAqE,GAAG,CAAC,CAAC,KAAK,CACzF,OAAO,sEAAsE,CAC9E,CAAA"}

package/dist/v3/robots/transloadit-import.js

@@ -0,0 +1,107 @@
+import { z } from 'zod/v3';
+import { damIdSchema } from "../storageAsset.js";
+import { booleanStringSchema, interpolateRobot, interpolationSchemaFull, recursive, robotBase, robotImport, } from "./_instructions-primitives.js";
+/** Cross-field validation runs after interpolation-aware parsing at the Assembly Step boundary. */
+export function refineTransloaditImportSelector(step, context) {
+    if (step.robot !== '/transloadit/import')
+        return;
+    const hasPath = step.path !== undefined;
+    const hasAsset = step.asset_id !== undefined;
+    if (hasPath === hasAsset || (step.version_id !== undefined && !hasAsset)) {
+        context.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: [step.version_id !== undefined && !hasAsset ? 'version_id' : 'asset_id'],
+            message: 'Select either path, or asset_id with an optional version_id.',
+        });
+    }
+    if (hasAsset && step.recursive === true) {
+        context.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['recursive'],
+            message: 'Recursive imports require a path, not an asset_id.',
+        });
+    }
+}
+const recursiveDescription = `
+Whether to import files from subfolders and sub-subfolders when \`path\` is a folder. By default
+only the folder's own files are imported.
+`;
+export const meta = {
+    bytescount: 10,
+    discount_factor: 0.1,
+    discount_pct: 90,
+    example_code: {
+        steps: {
+            imported: {
+                robot: '/transloadit/import',
+                path: 'photos/cat.jpg',
+            },
+        },
+    },
+    example_code_description: 'Import a file from Transloadit Storage:',
+    has_small_icon: true,
+    isAllowedForUrlTransform: true,
+    isInternal: false,
+    minimum_charge: 0,
+    name: 'TransloaditImportRobot',
+    output_factor: 1,
+    override_lvl1: 'File Importing',
+    priceFactor: 10,
+    purpose_sentence: 'imports files from Transloadit Storage',
+    purpose_verb: 'import',
+    purpose_word: 'Transloadit Storage',
+    purpose_words: 'Import files from Transloadit Storage',
+    queueSlotCount: 10,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+    service_slug: 'file-importing',
+    slot_count: 10,
+    stage: 'beta',
+    title: 'Import files from Transloadit Storage',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+};
+export const robotTransloaditImportInstructionsSchema = robotBase
+    .merge(robotImport)
+    .extend({
+    robot: z.literal('/transloadit/import').describe(`
+Imports files from your Workspace's Transloadit Storage. Select a mutable location with
+\`path\`, or a logical asset with \`asset_id\`. Add \`version_id\` to pin the exact stored bytes.
+IDs remain subject to Workspace access and version retention.
+`),
+    path: z
+        .string()
+        .optional()
+        .describe(`
+The current file or folder location, for example \`photos/cat.jpg\`. Use either \`path\` or
+\`asset_id\`, not both. Renaming makes an old path stale; overwriting changes what it imports.
+`),
+    asset_id: damIdSchema.optional().describe(`
+The stored asset's stable ID. Without \`version_id\`, imports its current version even after
+renaming or moving it. Cannot be combined with \`path\` or recursive folder imports.
+`),
+    version_id: damIdSchema.optional().describe(`
+The exact retained version of \`asset_id\` to import. Requires \`asset_id\`; a missing or deleted
+version never falls back to the current version.
+`),
+    recursive: recursive.describe(recursiveDescription),
+})
+    .strict();
+export const robotTransloaditImportInstructionsWithHiddenFieldsSchema = robotTransloaditImportInstructionsSchema.extend({
+    result: z
+        .union([z.literal('debug'), robotTransloaditImportInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotTransloaditImportInstructionsSchema = interpolateRobot(robotTransloaditImportInstructionsSchema).extend({
+    // The generic boolean interpolator changes literal false to true. Keep Storage's documented
+    // false default intact; unresolved variables are validated after uploader interpolation.
+    recursive: z
+        .union([
+        recursive,
+        booleanStringSchema.transform((value) => value === 'true'),
+        interpolationSchemaFull,
+    ])
+        .describe(recursiveDescription),
+});
+export const interpolatableRobotTransloaditImportInstructionsWithHiddenFieldsSchema = interpolateRobot(robotTransloaditImportInstructionsWithHiddenFieldsSchema).extend({
+    recursive: interpolatableRobotTransloaditImportInstructionsSchema.shape.recursive,
+});