@transloadit/zod 4.1.3

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

@@ -0,0 +1,246 @@
+import { z } from 'zod/v3';
+import type { RobotMetaInput } from './_instructions-primitives.ts';
+export declare const meta: RobotMetaInput;
+export declare const robotSwiftImportInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+    queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+} & {
+    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")[]>>;
+} & {
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    bucket_region: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    secret: z.ZodOptional<z.ZodString>;
+} & {
+    robot: z.ZodLiteral<"/swift/import">;
+    path: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    recursive: z.ZodDefault<z.ZodBoolean>;
+    page_number: z.ZodDefault<z.ZodNumber>;
+    files_per_page: z.ZodDefault<z.ZodNumber>;
+    return_file_stubs: z.ZodDefault<z.ZodBoolean>;
+}, "strict", z.ZodTypeAny, {
+    path: string | string[];
+    result: boolean;
+    force_accept: boolean;
+    ignore_errors: string[];
+    force_name: string | string[] | null;
+    robot: "/swift/import";
+    recursive: boolean;
+    files_per_page: number;
+    page_number: number;
+    return_file_stubs: boolean;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    queue?: "batch" | undefined;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+}, {
+    path: string | string[];
+    robot: "/swift/import";
+    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;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+    recursive?: boolean | undefined;
+    files_per_page?: number | undefined;
+    page_number?: number | undefined;
+    return_file_stubs?: boolean | undefined;
+}>;
+export declare const robotSwiftImportInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    queue: z.ZodOptional<z.ZodEnum<["batch"]>>;
+    force_accept: z.ZodDefault<z.ZodBoolean>;
+    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")[]>>;
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    bucket_region: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    secret: z.ZodOptional<z.ZodString>;
+    robot: z.ZodLiteral<"/swift/import">;
+    path: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    recursive: z.ZodDefault<z.ZodBoolean>;
+    page_number: z.ZodDefault<z.ZodNumber>;
+    files_per_page: z.ZodDefault<z.ZodNumber>;
+    return_file_stubs: z.ZodDefault<z.ZodBoolean>;
+} & {
+    result: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"debug">, z.ZodDefault<z.ZodBoolean>]>>;
+}, "strict", z.ZodTypeAny, {
+    path: string | string[];
+    force_accept: boolean;
+    ignore_errors: string[];
+    force_name: string | string[] | null;
+    robot: "/swift/import";
+    recursive: boolean;
+    files_per_page: number;
+    page_number: number;
+    return_file_stubs: boolean;
+    output_meta?: boolean | string[] | Record<string, boolean> | undefined;
+    result?: boolean | "debug" | undefined;
+    queue?: "batch" | undefined;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+}, {
+    path: string | string[];
+    robot: "/swift/import";
+    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;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+    recursive?: boolean | undefined;
+    files_per_page?: number | undefined;
+    page_number?: number | undefined;
+    return_file_stubs?: boolean | undefined;
+}>;
+export type RobotSwiftImportInstructions = z.infer<typeof robotSwiftImportInstructionsSchema>;
+export type RobotSwiftImportInstructionsWithHiddenFields = z.infer<typeof robotSwiftImportInstructionsWithHiddenFieldsSchema>;
+export declare const interpolatableRobotSwiftImportInstructionsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    result: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    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")[]>]>>;
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    bucket_region: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    secret: z.ZodOptional<z.ZodString>;
+    robot: z.ZodLiteral<"/swift/import">;
+    path: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>;
+    recursive: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    page_number: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    files_per_page: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    return_file_stubs: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+}, "strict", z.ZodTypeAny, {
+    path: string | string[];
+    result: string | boolean;
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    force_name: string | string[] | null;
+    robot: "/swift/import";
+    recursive: string | boolean;
+    files_per_page: string | number;
+    page_number: string | number;
+    return_file_stubs: string | boolean;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    queue?: string | undefined;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+}, {
+    path: string | string[];
+    robot: "/swift/import";
+    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;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+    recursive?: string | boolean | undefined;
+    files_per_page?: string | number | undefined;
+    page_number?: string | number | undefined;
+    return_file_stubs?: string | boolean | undefined;
+}>;
+export type InterpolatableRobotSwiftImportInstructions = InterpolatableRobotSwiftImportInstructionsInput;
+export type InterpolatableRobotSwiftImportInstructionsInput = z.input<typeof interpolatableRobotSwiftImportInstructionsSchema>;
+export declare const interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema: z.ZodObject<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>, z.ZodUnion<[z.ZodString, z.ZodBoolean]>, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>>;
+    queue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEnum<["batch"]>]>>;
+    force_accept: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    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")[]>]>>;
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    bucket_region: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    secret: z.ZodOptional<z.ZodString>;
+    robot: z.ZodLiteral<"/swift/import">;
+    path: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>]>;
+    recursive: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    page_number: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    files_per_page: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    return_file_stubs: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    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, {
+    path: string | string[];
+    force_accept: string | boolean;
+    ignore_errors: string | string[];
+    force_name: string | string[] | null;
+    robot: "/swift/import";
+    recursive: string | boolean;
+    files_per_page: string | number;
+    page_number: string | number;
+    return_file_stubs: string | boolean;
+    output_meta?: string | boolean | string[] | Record<string, string | boolean> | undefined;
+    result?: string | boolean | undefined;
+    queue?: string | undefined;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+}, {
+    path: string | string[];
+    robot: "/swift/import";
+    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;
+    credentials?: string | undefined;
+    key?: string | undefined;
+    bucket?: string | undefined;
+    host?: string | undefined;
+    secret?: string | undefined;
+    bucket_region?: string | undefined;
+    recursive?: string | boolean | undefined;
+    files_per_page?: string | number | undefined;
+    page_number?: string | number | undefined;
+    return_file_stubs?: string | boolean | undefined;
+}>;
+export type InterpolatableRobotSwiftImportInstructionsWithHiddenFields = z.infer<typeof interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema>;
+export type InterpolatableRobotSwiftImportInstructionsWithHiddenFieldsInput = z.input<typeof interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema>;
+//# sourceMappingURL=swift-import.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"swift-import.d.ts","sourceRoot":"","sources":["../../../src/v3/robots/swift-import.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAanE,eAAO,MAAM,IAAI,EAAE,cAuClB,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BpC,CAAA;AAEX,eAAO,MAAM,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK3D,CAAA;AAEJ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,kDAAkD,CAC1D,CAAA;AAED,eAAO,MAAM,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5D,CAAA;AACD,MAAM,MAAM,0CAA0C,GACpD,+CAA+C,CAAA;AAEjD,MAAM,MAAM,+CAA+C,GAAG,CAAC,CAAC,KAAK,CACnE,OAAO,gDAAgD,CACxD,CAAA;AAED,eAAO,MAAM,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE5E,CAAA;AACD,MAAM,MAAM,0DAA0D,GAAG,CAAC,CAAC,KAAK,CAC9E,OAAO,gEAAgE,CACxE,CAAA;AACD,MAAM,MAAM,+DAA+D,GAAG,CAAC,CAAC,KAAK,CACnF,OAAO,gEAAgE,CACxE,CAAA"}

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

@@ -0,0 +1,80 @@
+import { z } from 'zod/v3';
+import { files_per_page, interpolateRobot, page_number, path, recursive, return_file_stubs, robotBase, robotImport, swiftBase, } from "./_instructions-primitives.js";
+export const meta = {
+    allowed_for_url_transform: true,
+    bytescount: 10,
+    discount_factor: 0.1,
+    discount_pct: 90,
+    example_code: {
+        steps: {
+            imported: {
+                robot: '/swift/import',
+                credentials: 'YOUR_SWIFT_CREDENTIALS',
+                path: 'path/to/files/',
+                recursive: true,
+            },
+        },
+    },
+    example_code_description: 'Import files from the `path/to/files` directory and its subdirectories:',
+    has_small_icon: true,
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'File Importing',
+    purpose_sentence: 'imports whole directories of files from your Openstack/Swift bucket',
+    purpose_verb: 'import',
+    purpose_word: 'Openstack/Swift',
+    purpose_words: 'Import files from Openstack/Swift',
+    requires_credentials: true,
+    service_slug: 'file-importing',
+    slot_count: 20,
+    title: 'Import files from Openstack/Swift',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+    name: 'SwiftImportRobot',
+    priceFactor: 6.6666,
+    queueSlotCount: 20,
+    isAllowedForUrlTransform: true,
+    trackOutputFileSize: false,
+    isInternal: false,
+    removeJobResultFilesFromDiskRightAfterStoringOnS3: true,
+    stage: 'ga',
+};
+export const robotSwiftImportInstructionsSchema = robotBase
+    .merge(robotImport)
+    .merge(swiftBase)
+    .extend({
+    robot: z.literal('/swift/import'),
+    path: path.describe(`
+The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: \`images/avatar.jpg\`.
+
+If it points to a directory, indicated by a trailing slash (\`/\`), then all files that are direct descendants of this directory will be imported. For example: \`images/\`.
+
+Directories are **not** imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the \`recursive\` parameter.
+
+If you want to import all files from the root directory, please use \`/\` as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with \`/\`, you'll receive an error: \`A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.\`
+
+You can also use an array of path strings here to import multiple paths in the same <dfn>Robot</dfn>'s <dfn>Step</dfn>.
+`),
+    recursive: recursive.describe(`
+Setting this to \`true\` will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.
+
+Please use the pagination parameters \`page_number\` and \`files_per_page\` wisely here.
+`),
+    page_number: page_number.describe(`
+The pagination page number. For now, in order to not break backwards compatibility in non-recursive imports, this only works when recursive is set to \`true\`.
+
+When doing big imports, make sure no files are added or removed from other scripts within your path, otherwise you might get weird results with the pagination.
+`),
+    files_per_page: files_per_page.describe(`
+The pagination page size. This only works when recursive is \`true\` for now, in order to not break backwards compatibility in non-recursive imports.
+`),
+    return_file_stubs,
+})
+    .strict();
+export const robotSwiftImportInstructionsWithHiddenFieldsSchema = robotSwiftImportInstructionsSchema.extend({
+    result: z
+        .union([z.literal('debug'), robotSwiftImportInstructionsSchema.shape.result])
+        .optional(),
+});
+export const interpolatableRobotSwiftImportInstructionsSchema = interpolateRobot(robotSwiftImportInstructionsSchema);
+export const interpolatableRobotSwiftImportInstructionsWithHiddenFieldsSchema = interpolateRobot(robotSwiftImportInstructionsWithHiddenFieldsSchema);