transloadit 3.0.2 → 4.0.0-4

package/dist/alphalib/types/robots/s3-store.d.ts

@@ -0,0 +1,135 @@
+import { z } from 'zod';
+import type { RobotMeta } from './_instructions-primitives.ts';
+export declare const meta: RobotMeta;
+export declare const robotS3StoreInstructionsSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+}, {
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+}>, {
+    credentials: z.ZodOptional<z.ZodString>;
+    bucket: z.ZodOptional<z.ZodString>;
+    bucket_region: z.ZodOptional<z.ZodString>;
+    key: z.ZodOptional<z.ZodString>;
+    secret: z.ZodOptional<z.ZodString>;
+}>, {
+    robot: z.ZodLiteral<"/s3/store">;
+    path: z.ZodDefault<z.ZodString>;
+    url_prefix: z.ZodDefault<z.ZodString>;
+    acl: z.ZodDefault<z.ZodEnum<["bucket-default", "private", "public", "public-read"]>>;
+    check_integrity: z.ZodDefault<z.ZodBoolean>;
+    headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    tags: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    host: z.ZodDefault<z.ZodString>;
+    no_vhost: z.ZodDefault<z.ZodBoolean>;
+    sign_urls_for: z.ZodOptional<z.ZodNumber>;
+}>, "strict", z.ZodTypeAny, {
+    path: string;
+    headers: Record<string, string>;
+    host: string;
+    robot: "/s3/store";
+    result: boolean;
+    url_prefix: string;
+    acl: "public" | "private" | "public-read" | "bucket-default";
+    check_integrity: boolean;
+    tags: Record<string, string>;
+    no_vhost: boolean;
+    key?: string | undefined;
+    secret?: string | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    credentials?: string | undefined;
+    bucket?: string | undefined;
+    sign_urls_for?: number | undefined;
+    bucket_region?: string | undefined;
+}, {
+    robot: "/s3/store";
+    path?: string | undefined;
+    headers?: Record<string, string> | undefined;
+    host?: string | undefined;
+    key?: string | undefined;
+    secret?: string | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    result?: boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    credentials?: string | undefined;
+    bucket?: string | undefined;
+    sign_urls_for?: number | undefined;
+    url_prefix?: string | undefined;
+    acl?: "public" | "private" | "public-read" | "bucket-default" | undefined;
+    bucket_region?: string | undefined;
+    check_integrity?: boolean | undefined;
+    tags?: Record<string, string> | undefined;
+    no_vhost?: boolean | undefined;
+}>;
+export type RobotS3StoreInstructions = z.infer<typeof robotS3StoreInstructionsSchema>;
+export type RobotS3StoreInstructionsInput = z.input<typeof robotS3StoreInstructionsSchema>;
+//# sourceMappingURL=s3-store.d.ts.map

package/dist/alphalib/types/robots/s3-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-store.d.ts","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/s3-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAE9D,eAAO,MAAM,IAAI,EAAE,SA8BlB,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgFhC,CAAA;AAEX,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AACrF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA"}

package/dist/alphalib/types/robots/s3-store.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.robotS3StoreInstructionsSchema = exports.meta = void 0;
+const zod_1 = require("zod");
+const _instructions_primitives_ts_1 = require("./_instructions-primitives.js");
+exports.meta = {
+    allowed_for_url_transform: true,
+    bytescount: 10,
+    discount_factor: 0.1,
+    discount_pct: 90,
+    docs_redirect_from: ['/docs/export-to-amazon-s3/'],
+    example_code: {
+        steps: {
+            exported: {
+                robot: '/s3/store',
+                use: ':original',
+                credentials: 'YOUR_AWS_CREDENTIALS',
+                path: 'my_target_folder/${unique_prefix}/${file.url_name}',
+            },
+        },
+    },
+    example_code_description: 'Export uploaded files to `my_target_folder` in an S3 bucket:',
+    has_small_icon: true,
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'File Exporting',
+    purpose_sentence: 'exports encoding results to Amazon S3',
+    purpose_verb: 'export',
+    purpose_word: 'Amazon S3',
+    purpose_words: 'Export files to Amazon S3',
+    service_slug: 'file-exporting',
+    slot_count: 10,
+    title: 'Export files to Amazon S3',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+};
+exports.robotS3StoreInstructionsSchema = _instructions_primitives_ts_1.robotBase
+    .merge(_instructions_primitives_ts_1.robotUse)
+    .merge(_instructions_primitives_ts_1.s3Base)
+    .extend({
+    robot: zod_1.z.literal('/s3/store').describe(`
+If you are new to Amazon S3, see our tutorial on [using your own S3 bucket](/docs/faq/how-to-set-up-an-amazon-s3-bucket/).
+
+The URL to the result file in your S3 bucket will be returned in the <dfn>Assembly Status JSON</dfn>. If your S3 bucket has versioning enabled, the version ID of the file will be returned within \`meta.version_id\`
+
+**Avoid permission errors.** By default, \`acl\` is set to \`"public"\`. AWS S3 has a bucket setting called "Block new public ACLs and uploading public objects". Set this to <strong>False</strong> in your bucket if you intend to leave \`acl\` as \`"public"\`. Otherwise, you’ll receive permission errors in your Assemblies despite your S3 credentials being configured correctly. [{.alert .alert-warning}]
+
+**Use DNS-compliant bucket names.** Your bucket name [must be DNS-compliant](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) and must not contain uppercase letters. Any non-alphanumeric characters in the file names will be replaced with an underscore, and spaces will be replaced with dashes. If your existing S3 bucket contains uppercase letters or is otherwise not DNS-compliant, rewrite the result URLs using the <dfn>Robot</dfn>’s \`url_prefix\` parameter. [{.alert .alert-warning}]
+
+<a id="minimum-s3-iam-permissions" aria-hidden="true"></a>
+
+## Limit access
+
+You will also need to add permissions to your bucket so that Transloadit can access it properly. Here is an example IAM policy that you can use. Following the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege), it contains the **minimum required permissions** to export a file to your S3 bucket using Transloadit. You may require more permissions (especially viewing permissions) depending on your application.
+
+Please change \`{BUCKET_NAME}\` in the values for \`Sid\` and \`Resource\` accordingly. Also, this policy will grant the minimum required permissions to all your users. We advise you to create a separate Amazon IAM user, and use its User ARN (can be found in the "Summary" tab of a user [here](https://console.aws.amazon.com/iam/home#users)) for the \`Principal\` value. More information about this can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/AccessPolicyLanguage_UseCases_s3_a.html).
+
+\`\`\`json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "AllowTransloaditToStoreFilesIn{BUCKET_NAME}Bucket",
+      "Effect": "Allow",
+      "Action": ["s3:GetBucketLocation", "s3:ListBucket", "s3:PutObject", "s3:PutObjectAcl"],
+      "Resource": ["arn:aws:s3:::{BUCKET_NAME}", "arn:aws:s3:::{BUCKET_NAME}/*"]
+    }
+  ]
+}
+\`\`\`
+
+The \`Sid\` value is just an identifier for you to recognize the rule later. You can name it anything you like.
+
+The policy needs to be separated into two parts, because the \`ListBucket\` action requires permissions on the bucket while the other actions require permissions on the objects in the bucket. When targeting the objects there's a trailing slash and an asterisk in the \`Resource\` parameter, whereas when the policy targets the bucket, the slash and the asterisk are omitted.
+
+Please note that if you give the <dfn>Robot</dfn>'s \`acl\` parameter a value of \`"bucket-default"\`, then you do not need the \`"s3:PutObjectAcl"\` permission in your bucket policy.
+
+In order to build proper result URLs we need to know the region in which your S3 bucket resides. For this we require the \`GetBucketLocation\` permission. Figuring out your bucket's region this way will also slow down your Assemblies. To make this much faster and to also not require the \`GetBucketLocation\` permission, we have added the \`bucket_region\` parameter to the /s3/store and /s3/import Robots. We recommend using them at all times.
+
+Please keep in mind that if you use bucket encryption you may also need to add \`"sts:*"\` and \`"kms:*"\` to the bucket policy. Please read [here](https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) and [here](https://aws.amazon.com/blogs/security/how-to-restrict-amazon-s3-bucket-access-to-a-specific-iam-role/) in case you run into trouble with our example bucket policy.
+`),
+    path: zod_1.z.string().default('${unique_prefix}/${file.url_name}').describe(`
+The path at which the file is to be stored. This may include any available [Assembly variables](/docs/topics/assembly-instructions/#assembly-variables). The path must not be a directory.
+`),
+    url_prefix: zod_1.z.string().default('http://{bucket}.s3.amazonaws.com/').describe(`
+The URL prefix used for the returned URL, such as \`"http://my.cdn.com/some/path/"\`.
+`),
+    acl: zod_1.z.enum(['bucket-default', 'private', 'public', 'public-read']).default('public-read')
+        .describe(`
+The permissions used for this file.
+
+Please keep in mind that the default value \`"public-read"\` can lead to permission errors due to the \`"Block all public access"\` checkbox that is checked by default when creating a new Amazon S3 Bucket in the AWS console.
+`),
+    check_integrity: zod_1.z.boolean().default(false).describe(`
+Calculate and submit the file's checksum in order for S3 to verify its integrity after uploading, which can help with occasional file corruption issues.
+
+Enabling this option adds to the overall execution time, as integrity checking can be CPU intensive, especially for larger files.
+`),
+    headers: zod_1.z.record(zod_1.z.string()).default({ 'Content-Type': '${file.mime}' }).describe(`
+An object containing a list of headers to be set for this file on S3, such as \`{ FileURL: "\${file.url_name}" }\`. This can also include any available [Assembly Variables](/docs/topics/assembly-instructions/#assembly-variables). You can find a list of available headers [here](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html).
+
+Object Metadata can be specified using \`x-amz-meta-*\` headers. Note that these headers [do not support non-ASCII metadata values](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata).
+`),
+    tags: zod_1.z.record(zod_1.z.string()).default({}).describe(`
+Object tagging allows you to categorize storage. You can associate up to 10 tags with an object. Tags that are associated with an object must have unique tag keys.
+`),
+    host: zod_1.z.string().default('s3.amazonaws.com').describe(`
+The host of the storage service used. This only needs to be set when the storage service used is not Amazon S3, but has a compatible API (such as hosteurope.de). The default protocol used is HTTP, for anything else the protocol needs to be explicitly specified. For example, prefix the host with \`https://\` or \`s3://\` to use either respective protocol.
+`),
+    no_vhost: zod_1.z.boolean().default(false).describe(`
+Set to \`true\` if you use a custom host and run into access denied errors.
+`),
+    sign_urls_for: zod_1.z.number().int().min(0).optional().describe(`
+This parameter provides signed URLs in the result JSON (in the \`signed_url\` and \`signed_ssl_url\` properties). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.
+`),
+})
+    .strict();
+//# sourceMappingURL=s3-store.js.map

package/dist/alphalib/types/robots/s3-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-store.js","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/s3-store.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,+EAA2E;AAG9D,QAAA,IAAI,GAAc;IAC7B,yBAAyB,EAAE,IAAI;IAC/B,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,GAAG;IACpB,YAAY,EAAE,EAAE;IAChB,kBAAkB,EAAE,CAAC,4BAA4B,CAAC;IAClD,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,QAAQ,EAAE;gBACR,KAAK,EAAE,WAAW;gBAClB,GAAG,EAAE,WAAW;gBAChB,WAAW,EAAE,sBAAsB;gBACnC,IAAI,EAAE,oDAAoD;aAC3D;SACF;KACF;IACD,wBAAwB,EAAE,8DAA8D;IACxF,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,gBAAgB;IAC/B,gBAAgB,EAAE,uCAAuC;IACzD,YAAY,EAAE,QAAQ;IACtB,YAAY,EAAE,WAAW;IACzB,aAAa,EAAE,2BAA2B;IAC1C,YAAY,EAAE,gBAAgB;IAC9B,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,2BAA2B;IAClC,oBAAoB,EAAE,GAAG;IACzB,iBAAiB,EAAE,MAAM;CAC1B,CAAA;AAEY,QAAA,8BAA8B,GAAG,uCAAS;KACpD,KAAK,CAAC,sCAAQ,CAAC;KACf,KAAK,CAAC,oCAAM,CAAC;KACb,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC1C,CAAC;IACE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC,QAAQ,CAAC;;CAE1E,CAAC;IACE,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC,QAAQ,CAAC;;CAEhF,CAAC;IACE,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;SACvF,QAAQ,CAAC;;;;CAIf,CAAC;IACE,eAAe,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;;;;CAIxD,CAAC;IACE,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC;;;;CAItF,CAAC;IACE,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC;;CAEnD,CAAC;IACE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC;;CAEzD,CAAC;IACE,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;;CAEjD,CAAC;IACE,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;CAE9D,CAAC;CACC,CAAC;KACD,MAAM,EAAE,CAAA"}

package/dist/alphalib/types/robots/script-run.d.ts

@@ -0,0 +1,94 @@
+import { z } from 'zod';
+import type { RobotMeta } from './_instructions-primitives.ts';
+export declare const meta: RobotMeta;
+export declare const robotScriptRunInstructionsSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+}, {
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+}>, {
+    robot: z.ZodLiteral<"/script/run">;
+    script: z.ZodString;
+}>, "strict", z.ZodTypeAny, {
+    script: string;
+    robot: "/script/run";
+    result: boolean;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+}, {
+    script: string;
+    robot: "/script/run";
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    result?: boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+}>;
+export type RobotScriptRunInstructions = z.infer<typeof robotScriptRunInstructionsSchema>;
+//# sourceMappingURL=script-run.d.ts.map

package/dist/alphalib/types/robots/script-run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-run.d.ts","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/script-run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAE9D,eAAO,MAAM,IAAI,EAAE,SAiBlB,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDlC,CAAA;AAEX,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA"}

package/dist/alphalib/types/robots/script-run.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.robotScriptRunInstructionsSchema = exports.meta = void 0;
+const zod_1 = require("zod");
+const _instructions_primitives_ts_1 = require("./_instructions-primitives.js");
+exports.meta = {
+    allowed_for_url_transform: true,
+    bytescount: 10,
+    discount_factor: 0.1,
+    discount_pct: 90,
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'Code Evaluation',
+    purpose_sentence: 'runs scripts in Assemblies',
+    purpose_verb: 'run',
+    purpose_word: 'script',
+    purpose_words: 'Run scripts in Assemblies',
+    service_slug: 'code-evaluation',
+    slot_count: 5,
+    title: 'Run Scripts',
+    typical_file_size_mb: 0.0001,
+    typical_file_type: 'file',
+};
+exports.robotScriptRunInstructionsSchema = _instructions_primitives_ts_1.robotBase
+    .merge(_instructions_primitives_ts_1.robotUse)
+    .extend({
+    robot: zod_1.z.literal('/script/run').describe(`
+This <dfn>Robot</dfn> allows you to run arbitrary \`JavaScript\` as part of the <dfn>Assembly</dfn>
+execution process. The <dfn>Robot</dfn> is invoked automatically when there are <dfn>Assembly
+Instructions</dfn> containing \`\${...}\`:
+
+\`\`\`json
+{
+  "robot": "/image/resize",
+  "width": "\${Math.max(file.meta.width, file.meta.height)}"
+}
+\`\`\`
+
+You can also invoke this <dfn>Robot</dfn> directly, leaving out the \`\${...}\`:
+
+\`\`\`json
+{
+  "robot": "/script/run",
+  "script": "Math.max(file.meta.width, file.meta.height)"
+}
+\`\`\`
+
+When accessing arrays, the syntax is the same as in any JavaScript program:
+
+\`\`\`json
+{
+  "robot": "/image/resize",
+  "width": "\${file.meta.faces[0].width * 2}"
+}
+\`\`\`
+
+Compared to only accessing an <dfn>Assembly Variable</dfn>:
+
+\`\`\`json
+{
+  "robot": "/image/resize",
+  "width": "\${file.meta.faces[0].width}"
+}
+\`\`\`
+
+For more information, see [Dynamic Evaluation](/docs/topics/dynamic-evaluation/).
+`),
+    script: zod_1.z.string().describe(`
+A string of JavaScript to evaluate. It has access to all JavaScript features available in a modern browser environment.
+
+The script is expected to return a \`JSON.stringify\`-able value in the same tick, so no \`await\` or callbacks are allowed (yet).
+
+If the script does not finish within 1000ms it times out with an error. The return value or error is exported as \`file.meta.result\`. If there was an error, \`file.meta.isError\` is \`true\`. Note that the <dfn>Assembly</dfn> will not crash in this case. If you need it to crash, you can check this value with a [🤖/file/filter](/docs/transcoding/file-filtering/file-filter/) <dfn>Step</dfn>, setting \`error_on_decline\` to \`true\`.
+
+You can check whether evaluating this script was free by inspecting \`file.meta.isFree\`. It is recommended to do this during development as to not see sudden unexpected costs in production.
+`),
+})
+    .strict();
+//# sourceMappingURL=script-run.js.map

package/dist/alphalib/types/robots/script-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-run.js","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/script-run.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,+EAAmE;AAGtD,QAAA,IAAI,GAAc;IAC7B,yBAAyB,EAAE,IAAI;IAC/B,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,GAAG;IACpB,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,iBAAiB;IAChC,gBAAgB,EAAE,4BAA4B;IAC9C,YAAY,EAAE,KAAK;IACnB,YAAY,EAAE,QAAQ;IACtB,aAAa,EAAE,2BAA2B;IAC1C,YAAY,EAAE,iBAAiB;IAC/B,UAAU,EAAE,CAAC;IACb,KAAK,EAAE,aAAa;IACpB,oBAAoB,EAAE,MAAM;IAC5B,iBAAiB,EAAE,MAAM;CAC1B,CAAA;AAEY,QAAA,gCAAgC,GAAG,uCAAS;KACtD,KAAK,CAAC,sCAAQ,CAAC;KACf,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC5C,CAAC;IACE,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC;;;;;;;;CAQ/B,CAAC;CACC,CAAC;KACD,MAAM,EAAE,CAAA"}

package/dist/alphalib/types/robots/sftp-import.d.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod';
+import type { RobotMeta } from './_instructions-primitives.ts';
+export declare const meta: RobotMeta;
+export declare const robotSftpImportInstructionsSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+}, {
+    ignore_errors: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodEnum<["meta", "import"]>, "many">]>, string[], boolean | ("meta" | "import")[]>>;
+}>, {
+    credentials: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    port: z.ZodDefault<z.ZodNumber>;
+    user: z.ZodOptional<z.ZodString>;
+    public_key: z.ZodOptional<z.ZodString>;
+}>, {
+    robot: z.ZodLiteral<"/sftp/import">;
+    path: z.ZodString;
+}>, "strict", z.ZodTypeAny, {
+    path: string;
+    port: number;
+    robot: "/sftp/import";
+    result: boolean;
+    ignore_errors: string[];
+    host?: string | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    credentials?: string | undefined;
+    user?: string | undefined;
+    public_key?: string | undefined;
+}, {
+    path: string;
+    robot: "/sftp/import";
+    host?: string | undefined;
+    port?: number | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    result?: boolean | undefined;
+    ignore_errors?: boolean | ("meta" | "import")[] | undefined;
+    credentials?: string | undefined;
+    user?: string | undefined;
+    public_key?: string | undefined;
+}>;
+export type RobotSftpImportInstructions = z.infer<typeof robotSftpImportInstructionsSchema>;
+export type RobotSftpImportInstructionsInput = z.input<typeof robotSftpImportInstructionsSchema>;
+//# sourceMappingURL=sftp-import.d.ts.map

package/dist/alphalib/types/robots/sftp-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sftp-import.d.ts","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/sftp-import.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAE9D,eAAO,MAAM,IAAI,EAAE,SA8BlB,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASnC,CAAA;AAEX,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAC3F,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA"}

package/dist/alphalib/types/robots/sftp-import.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.robotSftpImportInstructionsSchema = exports.meta = void 0;
+const zod_1 = require("zod");
+const _instructions_primitives_ts_1 = require("./_instructions-primitives.js");
+exports.meta = {
+    allowed_for_url_transform: true,
+    bytescount: 10,
+    discount_factor: 0.1,
+    discount_pct: 90,
+    docs_redirect_from: ['/docs/import-files-over-sftp/'],
+    example_code: {
+        steps: {
+            imported: {
+                robot: '/sftp/import',
+                credentials: 'YOUR_SFTP_CREDENTIALS',
+                path: 'path/to/files/',
+            },
+        },
+    },
+    example_code_description: 'Import files from the `path/to/files` directory and its subdirectories:',
+    minimum_charge: 0,
+    output_factor: 1,
+    override_lvl1: 'File Importing',
+    purpose_sentence: 'imports whole libraries of files from your SFTP servers into Transloadit. This Robot relies on public key authentication',
+    purpose_verb: 'import',
+    purpose_word: 'SFTP servers',
+    purpose_words: 'Import files from SFTP servers',
+    service_slug: 'file-importing',
+    slot_count: 20,
+    title: 'Import files from SFTP servers',
+    typical_file_size_mb: 1.2,
+    typical_file_type: 'file',
+};
+exports.robotSftpImportInstructionsSchema = _instructions_primitives_ts_1.robotBase
+    .merge(_instructions_primitives_ts_1.robotImport)
+    .merge(_instructions_primitives_ts_1.sftpBase)
+    .extend({
+    robot: zod_1.z.literal('/sftp/import'),
+    path: zod_1.z.string().describe(`
+The path on your SFTP server where to search for files.
+`),
+})
+    .strict();
+//# sourceMappingURL=sftp-import.js.map

package/dist/alphalib/types/robots/sftp-import.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sftp-import.js","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/sftp-import.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,+EAAgF;AAGnE,QAAA,IAAI,GAAc;IAC7B,yBAAyB,EAAE,IAAI;IAC/B,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,GAAG;IACpB,YAAY,EAAE,EAAE;IAChB,kBAAkB,EAAE,CAAC,+BAA+B,CAAC;IACrD,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,QAAQ,EAAE;gBACR,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,uBAAuB;gBACpC,IAAI,EAAE,gBAAgB;aACvB;SACF;KACF;IACD,wBAAwB,EACtB,yEAAyE;IAC3E,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,gBAAgB;IAC/B,gBAAgB,EACd,0HAA0H;IAC5H,YAAY,EAAE,QAAQ;IACtB,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,gCAAgC;IAC/C,YAAY,EAAE,gBAAgB;IAC9B,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,gCAAgC;IACvC,oBAAoB,EAAE,GAAG;IACzB,iBAAiB,EAAE,MAAM;CAC1B,CAAA;AAEY,QAAA,iCAAiC,GAAG,uCAAS;KACvD,KAAK,CAAC,yCAAW,CAAC;KAClB,KAAK,CAAC,sCAAQ,CAAC;KACf,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,OAAO,CAAC,cAAc,CAAC;IAChC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC;;CAE7B,CAAC;CACC,CAAC;KACD,MAAM,EAAE,CAAA"}

package/dist/alphalib/types/robots/sftp-store.d.ts

@@ -0,0 +1,120 @@
+import { z } from 'zod';
+import type { RobotMeta } from './_instructions-primitives.ts';
+export declare const meta: RobotMeta;
+export declare const robotSftpStoreInstructionsSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    output_meta: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodBoolean]>>;
+    result: z.ZodDefault<z.ZodBoolean>;
+}, {
+    use: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodOptional<z.ZodString>;
+        as: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }, {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }>, "many">]>, z.ZodObject<{
+        steps: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodOptional<z.ZodString>;
+            as: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }, {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }>, "many">]>;
+        bundle_steps: z.ZodOptional<z.ZodBoolean>;
+        group_by_original: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }, {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    }>]>>;
+}>, {
+    credentials: z.ZodOptional<z.ZodString>;
+    host: z.ZodOptional<z.ZodString>;
+    port: z.ZodDefault<z.ZodNumber>;
+    user: z.ZodOptional<z.ZodString>;
+    public_key: z.ZodOptional<z.ZodString>;
+}>, {
+    robot: z.ZodLiteral<"/sftp/store">;
+    path: z.ZodDefault<z.ZodString>;
+    url_template: z.ZodDefault<z.ZodString>;
+    ssl_url_template: z.ZodDefault<z.ZodString>;
+    file_chmod: z.ZodDefault<z.ZodString>;
+}>, "strict", z.ZodTypeAny, {
+    path: string;
+    port: number;
+    robot: "/sftp/store";
+    result: boolean;
+    url_template: string;
+    ssl_url_template: string;
+    file_chmod: string;
+    host?: string | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    credentials?: string | undefined;
+    user?: string | undefined;
+    public_key?: string | undefined;
+}, {
+    robot: "/sftp/store";
+    path?: string | undefined;
+    host?: string | undefined;
+    port?: number | undefined;
+    output_meta?: boolean | Record<string, boolean> | undefined;
+    result?: boolean | undefined;
+    use?: string | string[] | {
+        name: string;
+        fields?: string | undefined;
+        as?: string | undefined;
+    }[] | {
+        steps: string | string[] | {
+            name: string;
+            fields?: string | undefined;
+            as?: string | undefined;
+        }[];
+        bundle_steps?: boolean | undefined;
+        group_by_original?: boolean | undefined;
+    } | undefined;
+    credentials?: string | undefined;
+    user?: string | undefined;
+    url_template?: string | undefined;
+    ssl_url_template?: string | undefined;
+    public_key?: string | undefined;
+    file_chmod?: string | undefined;
+}>;
+export type RobotSftpStoreInstructions = z.infer<typeof robotSftpStoreInstructionsSchema>;
+export type RobotSftpStoreInstructionsInput = z.input<typeof robotSftpStoreInstructionsSchema>;
+//# sourceMappingURL=sftp-store.d.ts.map