@remotion/lambda 4.0.0-webhook.27 → 4.1.0-alpha3

package/dist/api/get-function-info.d.ts

@@ -1,18 +1,18 @@
 import type { AwsRegion } from '../pricing/aws-regions';
-export declare type FunctionInfo = {
+export type FunctionInfo = {
     functionName: string;
     timeoutInSeconds: number;
     memorySizeInMb: number;
     version: string | null;
     diskSizeInMb: number;
 };
-export declare type GetFunctionInfoInput = {
+export type GetFunctionInfoInput = {
     region: AwsRegion;
     functionName: string;
 };
 /**
  * @description Given a region and function name, returns information about the function such as version, memory size and timeout.
- * @link https://remotion.dev/docs/lambda/getfunctioninfo
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctioninfo)
  * @param {AwsRegion} options.region The region in which the function resides in.
  * @param {string} options.functionName The name of the function
  * @return {Promise<FunctionInfo>} Promise resolving to information about the function.

package/dist/api/get-function-info.js

@@ -8,7 +8,7 @@ const get_function_version_1 = require("../shared/get-function-version");
 const validate_aws_region_1 = require("../shared/validate-aws-region");
 /**
  * @description Given a region and function name, returns information about the function such as version, memory size and timeout.
- * @link https://remotion.dev/docs/lambda/getfunctioninfo
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctioninfo)
  * @param {AwsRegion} options.region The region in which the function resides in.
  * @param {string} options.functionName The name of the function
  * @return {Promise<FunctionInfo>} Promise resolving to information about the function.

package/dist/api/get-functions.d.ts

@@ -1,16 +1,14 @@
 import type { AwsRegion } from '../pricing/aws-regions';
 import type { FunctionInfo } from './get-function-info';
-export declare type GetFunctionsInput = {
+export type GetFunctionsInput = {
     region: AwsRegion;
     compatibleOnly: boolean;
 };
 /**
- *
- *
  * @description Lists Remotion Lambda render functions deployed to AWS Lambda.
- * @link https://remotion.dev/docs/lambda/getfunctions
- * @param options.region The region of which the functions should be listed.
- * @param options.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctions)
+ * @param params.region The region of which the functions should be listed.
+ * @param params.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
  * @returns {Promise<FunctionInfo[]>} An array with the objects containing information about the deployed functions.
  */
-export declare const getFunctions: (options: GetFunctionsInput) => Promise<FunctionInfo[]>;
+export declare const getFunctions: (params: GetFunctionsInput) => Promise<FunctionInfo[]>;

package/dist/api/get-functions.js

@@ -27,19 +27,17 @@ const getAllFunctions = async ({ existing, nextMarker, region, }) => {
     return allLambdas;
 };
 /**
- *
- *
  * @description Lists Remotion Lambda render functions deployed to AWS Lambda.
- * @link https://remotion.dev/docs/lambda/getfunctions
- * @param options.region The region of which the functions should be listed.
- * @param options.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getfunctions)
+ * @param params.region The region of which the functions should be listed.
+ * @param params.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
  * @returns {Promise<FunctionInfo[]>} An array with the objects containing information about the deployed functions.
  */
-const getFunctions = async (options) => {
+const getFunctions = async (params) => {
     const lambdas = await getAllFunctions({
         existing: [],
         nextMarker: null,
-        region: options.region,
+        region: params.region,
     });
     const remotionLambdas = lambdas.filter((f) => {
         var _a;
@@ -49,7 +47,7 @@ const getFunctions = async (options) => {
         try {
             const version = await (0, get_function_version_1.getFunctionVersion)({
                 functionName: fn.FunctionName,
-                region: options.region,
+                region: params.region,
             });
             return version;
         }
@@ -67,11 +65,11 @@ const getFunctions = async (options) => {
             diskSizeInMb: (_b = (_a = lambda.EphemeralStorage) === null || _a === void 0 ? void 0 : _a.Size) !== null && _b !== void 0 ? _b : constants_1.DEFAULT_EPHEMERAL_STORAGE_IN_MB,
         };
     });
-    if (!options.compatibleOnly) {
+    if (!params.compatibleOnly) {
         return list;
     }
     return list.filter((l) => {
-        if (!options.compatibleOnly) {
+        if (!params.compatibleOnly) {
             return true;
         }
         return l.version === version_1.VERSION;

package/dist/api/get-or-create-bucket.d.ts

@@ -1,15 +1,15 @@
 import type { AwsRegion } from '../pricing/aws-regions';
-export declare type GetOrCreateBucketInput = {
+export type GetOrCreateBucketInput = {
     region: AwsRegion;
-    onBucketEnsured?: () => void;
 };
-export declare type GetOrCreateBucketOutput = {
+export type GetOrCreateBucketOutput = {
     bucketName: string;
+    alreadyExisted: boolean;
 };
 /**
  * @description Creates a bucket for Remotion Lambda in your S3 account. If one already exists, it will get returned instead.
- * @link https://remotion.dev/docs/lambda/getorcreatebucket
- * @param options.region The region in which you want your S3 bucket to reside in.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getorcreatebucket)
+ * @param params.region The region in which you want your S3 bucket to reside in.
  * @returns {Promise<GetOrCreateBucketOutput>} An object containing the `bucketName`.
  */
-export declare const getOrCreateBucket: (options: GetOrCreateBucketInput) => Promise<GetOrCreateBucketOutput>;
+export declare const getOrCreateBucket: (params: GetOrCreateBucketInput) => Promise<GetOrCreateBucketOutput>;

package/dist/api/get-or-create-bucket.js

@@ -2,36 +2,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOrCreateBucket = void 0;
 const constants_1 = require("../shared/constants");
-const random_hash_1 = require("../shared/random-hash");
+const validate_bucketname_1 = require("../shared/validate-bucketname");
 const create_bucket_1 = require("./create-bucket");
-const enable_s3_website_1 = require("./enable-s3-website");
 const get_buckets_1 = require("./get-buckets");
 /**
  * @description Creates a bucket for Remotion Lambda in your S3 account. If one already exists, it will get returned instead.
- * @link https://remotion.dev/docs/lambda/getorcreatebucket
- * @param options.region The region in which you want your S3 bucket to reside in.
+ * @see [Documentation](https://remotion.dev/docs/lambda/getorcreatebucket)
+ * @param params.region The region in which you want your S3 bucket to reside in.
  * @returns {Promise<GetOrCreateBucketOutput>} An object containing the `bucketName`.
  */
-const getOrCreateBucket = async (options) => {
-    var _a, _b;
-    const { remotionBuckets } = await (0, get_buckets_1.getRemotionS3Buckets)(options.region);
+const getOrCreateBucket = async (params) => {
+    const { remotionBuckets } = await (0, get_buckets_1.getRemotionS3Buckets)(params.region);
     if (remotionBuckets.length > 1) {
-        throw new Error(`You have multiple buckets (${remotionBuckets.map((b) => b.name)}) in your S3 region (${options.region}) starting with "${constants_1.REMOTION_BUCKET_PREFIX}". This is an error, please delete buckets so that you have one maximum.`);
+        throw new Error(`You have multiple buckets (${remotionBuckets.map((b) => b.name)}) in your S3 region (${params.region}) starting with "${constants_1.REMOTION_BUCKET_PREFIX}". Please see https://remotion.dev/docs/lambda/multiple-buckets.`);
     }
     if (remotionBuckets.length === 1) {
-        (_a = options.onBucketEnsured) === null || _a === void 0 ? void 0 : _a.call(options);
-        return { bucketName: remotionBuckets[0].name };
+        return { bucketName: remotionBuckets[0].name, alreadyExisted: true };
     }
-    const bucketName = constants_1.REMOTION_BUCKET_PREFIX + (0, random_hash_1.randomHash)();
+    const bucketName = (0, validate_bucketname_1.makeBucketName)(params.region);
     await (0, create_bucket_1.createBucket)({
         bucketName,
-        region: options.region,
+        region: params.region,
     });
-    (_b = options.onBucketEnsured) === null || _b === void 0 ? void 0 : _b.call(options);
-    await (0, enable_s3_website_1.enableS3Website)({
-        region: options.region,
-        bucketName,
-    });
-    return { bucketName };
+    return { bucketName, alreadyExisted: false };
 };
 exports.getOrCreateBucket = getOrCreateBucket;

package/dist/api/get-regions.d.ts

@@ -1,7 +1,11 @@
 import type { AwsRegion } from '../pricing/aws-regions';
+type Options = {
+    enabledByDefaultOnly?: boolean;
+};
 /**
  * @description Gets an array of all supported AWS regions of this release of Remotion Lambda.
- * @link https://remotion.dev/docs/lambda/getregions
+ * @see [Documentation](https://remotion.dev/docs/lambda/getregions)
  * @returns {AwsRegion[]} A list of AWS regions.
  */
-export declare const getRegions: () => readonly AwsRegion[];
+export declare const getRegions: (options?: Options) => readonly AwsRegion[];
+export {};

package/dist/api/get-regions.js

@@ -1,13 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRegions = void 0;
+const aws_regions_1 = require("../pricing/aws-regions");
 const regions_1 = require("../regions");
 /**
  * @description Gets an array of all supported AWS regions of this release of Remotion Lambda.
- * @link https://remotion.dev/docs/lambda/getregions
+ * @see [Documentation](https://remotion.dev/docs/lambda/getregions)
  * @returns {AwsRegion[]} A list of AWS regions.
  */
-const getRegions = () => {
-    return regions_1.AWS_REGIONS;
+const getRegions = (options) => {
+    var _a;
+    const onlyEnabledByDefault = (_a = options === null || options === void 0 ? void 0 : options.enabledByDefaultOnly) !== null && _a !== void 0 ? _a : false;
+    return onlyEnabledByDefault ? aws_regions_1.DEFAULT_AWS_REGIONS : regions_1.AWS_REGIONS;
 };
 exports.getRegions = getRegions;

package/dist/api/get-render-progress.d.ts

@@ -1,7 +1,7 @@
 import type { AwsRegion } from '../pricing/aws-regions';
 import type { CustomCredentials } from '../shared/aws-clients';
 import type { RenderProgress } from '../shared/constants';
-export declare type GetRenderInput = {
+export type GetRenderInput = {
     functionName: string;
     bucketName: string;
     renderId: string;
@@ -10,7 +10,7 @@ export declare type GetRenderInput = {
 };
 /**
  * @description Gets the current status of a render originally triggered via renderMediaOnLambda().
- * @link https://remotion.dev/docs/lambda/getrenderprogress
+ * @see [Documentation](https://remotion.dev/docs/lambda/getrenderprogress)
  * @param {string} params.functionName The name of the function used to trigger the render.
  * @param {string} params.bucketName The name of the bucket that was used in the render.
  * @param {string} params.renderId The ID of the render that was returned by `renderMediaOnLambda()`.
@@ -18,4 +18,4 @@ export declare type GetRenderInput = {
  * @param {CustomCredentials} params.s3OutputProvider? Endpoint and credentials if the output file is stored outside of AWS.
  * @returns {Promise<RenderProgress>} See documentation for this function to see all properties on the return object.
  */
-export declare const getRenderProgress: ({ functionName, bucketName, renderId, region, s3OutputProvider, }: GetRenderInput) => Promise<RenderProgress>;
+export declare const getRenderProgress: (input: GetRenderInput) => Promise<RenderProgress>;

package/dist/api/get-render-progress.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRenderProgress = void 0;
-const version_1 = require("remotion/version");
 const call_lambda_1 = require("../shared/call-lambda");
 const constants_1 = require("../shared/constants");
+const make_lambda_payload_1 = require("./make-lambda-payload");
 /**
  * @description Gets the current status of a render originally triggered via renderMediaOnLambda().
- * @link https://remotion.dev/docs/lambda/getrenderprogress
+ * @see [Documentation](https://remotion.dev/docs/lambda/getrenderprogress)
  * @param {string} params.functionName The name of the function used to trigger the render.
  * @param {string} params.bucketName The name of the bucket that was used in the render.
  * @param {string} params.renderId The ID of the render that was returned by `renderMediaOnLambda()`.
@@ -14,17 +14,12 @@ const constants_1 = require("../shared/constants");
  * @param {CustomCredentials} params.s3OutputProvider? Endpoint and credentials if the output file is stored outside of AWS.
  * @returns {Promise<RenderProgress>} See documentation for this function to see all properties on the return object.
  */
-const getRenderProgress = async ({ functionName, bucketName, renderId, region, s3OutputProvider, }) => {
+const getRenderProgress = async (input) => {
     const result = await (0, call_lambda_1.callLambda)({
-        functionName,
+        functionName: input.functionName,
         type: constants_1.LambdaRoutines.status,
-        payload: {
-            bucketName,
-            renderId,
-            version: version_1.VERSION,
-            s3OutputProvider,
-        },
-        region,
+        payload: (0, make_lambda_payload_1.getRenderProgressPayload)(input),
+        region: input.region,
     });
     return result;
 };

package/dist/api/get-sites.d.ts

@@ -1,25 +1,25 @@
 import type { AwsRegion } from '../pricing/aws-regions';
 import type { BucketWithLocation } from './get-buckets';
-declare type Site = {
+type Site = {
     sizeInBytes: number;
     lastModified: number | null;
     bucketName: string;
     id: string;
     serveUrl: string;
 };
-export declare type GetSitesInput = {
+export type GetSitesInput = {
     region: AwsRegion;
+    forceBucketName?: string;
 };
-export declare type GetSitesOutput = {
+export type GetSitesOutput = {
     sites: Site[];
     buckets: BucketWithLocation[];
 };
 /**
- *
  * @description Gets all the deployed sites for a certain AWS region.
- * @link https://remotion.dev/docs/lambda/getsites
+ * @see [Documentation](https://remotion.dev/docs/lambda/getsites)
  * @param {AwsRegion} params.region The AWS region that you want to query for.
  * @returns {Promise<GetSitesOutput>} A Promise containing an object with `sites` and `bucket` keys. Consult documentation for details.
  */
-export declare const getSites: ({ region, }: GetSitesInput) => Promise<GetSitesOutput>;
+export declare const getSites: ({ region, forceBucketName, }: GetSitesInput) => Promise<GetSitesOutput>;
 export {};

package/dist/api/get-sites.js

@@ -7,15 +7,16 @@ const get_account_id_1 = require("../shared/get-account-id");
 const make_s3_url_1 = require("../shared/make-s3-url");
 const get_buckets_1 = require("./get-buckets");
 /**
- *
  * @description Gets all the deployed sites for a certain AWS region.
- * @link https://remotion.dev/docs/lambda/getsites
+ * @see [Documentation](https://remotion.dev/docs/lambda/getsites)
  * @param {AwsRegion} params.region The AWS region that you want to query for.
  * @returns {Promise<GetSitesOutput>} A Promise containing an object with `sites` and `bucket` keys. Consult documentation for details.
  */
-const getSites = async ({ region, }) => {
+const getSites = async ({ region, forceBucketName, }) => {
     var _a;
-    const { remotionBuckets } = await (0, get_buckets_1.getRemotionS3Buckets)(region);
+    const { remotionBuckets } = forceBucketName
+        ? await (0, get_buckets_1.getRemotionS3Buckets)(region, forceBucketName)
+        : await (0, get_buckets_1.getRemotionS3Buckets)(region);
     const accountId = await (0, get_account_id_1.getAccountId)({ region });
     const sites = {};
     for (const bucket of remotionBuckets) {

package/dist/api/iam-validation/simulate-rule.d.ts

@@ -1,6 +1,6 @@
 import type { AwsRegion } from '../../pricing/aws-regions';
-export declare type EvalDecision = 'allowed' | 'explicitDeny' | 'implicitDeny';
-export declare type SimulationResult = {
+export type EvalDecision = 'allowed' | 'explicitDeny' | 'implicitDeny';
+export type SimulationResult = {
     decision: EvalDecision;
     name: string;
 };

package/dist/api/iam-validation/simulate-rule.js

@@ -2,32 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.simulateRule = void 0;
 const client_iam_1 = require("@aws-sdk/client-iam");
-const aws_policies_1 = require("aws-policies");
 const aws_clients_1 = require("../../shared/aws-clients");
 const simulateRule = async (options) => {
     var _a;
     try {
-        if (options.actionNames.includes(aws_policies_1.iam.GetUser)) {
-            try {
-                await (0, aws_clients_1.getIamClient)(options.region).send(new client_iam_1.GetUserCommand({}));
-                const result = [
-                    {
-                        decision: 'allowed',
-                        name: aws_policies_1.iam.GetUser,
-                    },
-                ];
-                return result;
-            }
-            catch (err) {
-                const result = [
-                    {
-                        decision: 'explicitDeny',
-                        name: aws_policies_1.iam.GetUser,
-                    },
-                ];
-                return result;
-            }
-        }
         const res = await (0, aws_clients_1.getIamClient)(options.region).send(new client_iam_1.SimulatePrincipalPolicyCommand({
             ActionNames: options.actionNames,
             PolicySourceArn: options.arn,

package/dist/api/iam-validation/simulate.d.ts

@@ -1,16 +1,16 @@
 import type { AwsRegion } from '../../pricing/aws-regions';
 import type { SimulationResult } from './simulate-rule';
 export declare const logPermissionOutput: (output: SimulationResult) => string;
-export declare type SimulatePermissionsInput = {
+export type SimulatePermissionsInput = {
     region: AwsRegion;
     onSimulation?: (result: SimulationResult) => void;
 };
-export declare type SimulatePermissionsOutput = {
+export type SimulatePermissionsOutput = {
     results: SimulationResult[];
 };
 /**
  * @description Simulates calls using the AWS Simulator to validate the correct permissions.
- * @link http://remotion.dev/docs/lambda/simulatepermissions
+ * @see [Documentation](http://remotion.dev/docs/lambda/simulatepermissions)
  * @param {AwsRegion} options.region The region which you would like to validate
  * @param {(result: SimulationResult) => void} options.onSimulation The region which you would like to validate
  * @returns {Promise<SimulatePermissionsOutput>} See documentation for detailed response structure.

package/dist/api/iam-validation/simulate.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.simulatePermissions = exports.logPermissionOutput = void 0;
-const client_iam_1 = require("@aws-sdk/client-iam");
+const client_sts_1 = require("@aws-sdk/client-sts");
 const aws_clients_1 = require("../../shared/aws-clients");
 const simulate_rule_1 = require("./simulate-rule");
 const user_permissions_1 = require("./user-permissions");
@@ -19,22 +19,43 @@ const logPermissionOutput = (output) => {
 exports.logPermissionOutput = logPermissionOutput;
 /**
  * @description Simulates calls using the AWS Simulator to validate the correct permissions.
- * @link http://remotion.dev/docs/lambda/simulatepermissions
+ * @see [Documentation](http://remotion.dev/docs/lambda/simulatepermissions)
  * @param {AwsRegion} options.region The region which you would like to validate
  * @param {(result: SimulationResult) => void} options.onSimulation The region which you would like to validate
  * @returns {Promise<SimulatePermissionsOutput>} See documentation for detailed response structure.
  */
 const simulatePermissions = async (options) => {
     var _a;
-    const user = await (0, aws_clients_1.getIamClient)(options.region).send(new client_iam_1.GetUserCommand({}));
-    if (!user || !user.User) {
-        throw new Error('No valid AWS user detected');
+    const callerIdentity = await (0, aws_clients_1.getStsClient)(options.region).send(new client_sts_1.GetCallerIdentityCommand({}));
+    if (!(callerIdentity === null || callerIdentity === void 0 ? void 0 : callerIdentity.Arn)) {
+        throw new Error('No valid AWS Caller Identity detected');
+    }
+    const callerIdentityArnComponents = callerIdentity.Arn.match(/arn:aws:([^:]+)::(\d+):([^/]+)(.*)/);
+    if (!callerIdentityArnComponents) {
+        throw new Error('Unknown AWS Caller Identity ARN detected');
+    }
+    const callerIdentityArnType = callerIdentityArnComponents[1];
+    let callerArn;
+    if (callerIdentityArnType === 'iam' &&
+        callerIdentityArnComponents[3] === 'user') {
+        callerArn = callerIdentity.Arn;
+    }
+    else if (callerIdentityArnType === 'sts' &&
+        callerIdentityArnComponents[3] === 'assumed-role') {
+        const assumedRoleComponents = callerIdentityArnComponents[4].match(/\/([^/]+)\/(.*)/);
+        if (!assumedRoleComponents) {
+            throw new Error('Unsupported AWS Caller Identity as Assumed-Role ARN detected');
+        }
+        callerArn = `arn:aws:iam::${callerIdentityArnComponents[2]}:role/${assumedRoleComponents[1]}`;
+    }
+    else {
+        throw new Error('Unsupported AWS Caller Identity ARN detected');
     }
     const results = [];
     for (const per of user_permissions_1.requiredPermissions) {
         const result = await (0, simulate_rule_1.simulateRule)({
             actionNames: per.actions,
-            arn: user.User.Arn,
+            arn: callerArn,
             region: options.region,
             resource: per.resource,
             retries: 2,

package/dist/api/iam-validation/user-permissions.d.ts

@@ -1,6 +1,6 @@
 import { iam, lambda, logs, s3, servicequotas } from 'aws-policies';
 export declare const requiredPermissions: {
-    actions: (s3 | iam | lambda | logs | servicequotas)[];
+    actions: (s3 | iam | lambda | 'lambda:PutRuntimeManagementConfig' | logs | servicequotas)[];
     resource: string[];
     id: string;
 }[];

package/dist/api/iam-validation/user-permissions.js

@@ -15,12 +15,6 @@ exports.requiredPermissions = [
         ],
         resource: ['*'],
     },
-    {
-        id: 'Identity',
-        actions: [aws_policies_1.iam.GetUser],
-        // eslint-disable-next-line no-template-curly-in-string
-        resource: ['arn:aws:iam::*:user/${aws:username}'],
-    },
     {
         id: 'PermissionValidation',
         actions: [aws_policies_1.iam.SimulatePrincipalPolicy],
@@ -43,8 +37,8 @@ exports.requiredPermissions = [
             aws_policies_1.s3.GetBucketLocation,
             aws_policies_1.s3.PutBucketAcl,
             aws_policies_1.s3.DeleteBucket,
-            aws_policies_1.s3.PutBucketWebsite,
-            aws_policies_1.s3.DeleteBucketWebsite,
+            aws_policies_1.s3.PutBucketOwnershipControls,
+            aws_policies_1.s3.PutBucketPublicAccessBlock,
         ],
         resource: [`arn:aws:s3:::${constants_1.REMOTION_BUCKET_PREFIX}*`],
     },
@@ -66,6 +60,7 @@ exports.requiredPermissions = [
             aws_policies_1.lambda.CreateFunction,
             aws_policies_1.lambda.DeleteFunction,
             aws_policies_1.lambda.PutFunctionEventInvokeConfig,
+            'lambda:PutRuntimeManagementConfig',
         ],
         resource: [`arn:aws:lambda:*:*:function:${constants_1.RENDER_FN_PREFIX}*`],
     },

package/dist/api/make-lambda-payload.d.ts

@@ -0,0 +1,5 @@
+import type { LambdaStartPayload, LambdaStatusPayload } from '../defaults';
+import type { GetRenderInput } from './get-render-progress';
+import type { RenderMediaOnLambdaInput } from './render-media-on-lambda';
+export declare const makeLambdaRenderMediaPayload: ({ rendererFunctionName, frameRange, framesPerLambda, forceBucketName: bucketName, codec, composition, serveUrl, imageFormat, inputProps, region, crf, envVariables, pixelFormat, proResProfile, maxRetries, privacy, logLevel, outName, timeoutInMilliseconds, chromiumOptions, scale, everyNthFrame, numberOfGifLoops, audioBitrate, concurrencyPerLambda, audioCodec, forceHeight, forceWidth, webhook, videoBitrate, downloadBehavior, muted, overwrite, dumpBrowserLogs, jpegQuality, quality, }: RenderMediaOnLambdaInput) => Promise<LambdaStartPayload>;
+export declare const getRenderProgressPayload: ({ bucketName, renderId, s3OutputProvider, }: GetRenderInput) => LambdaStatusPayload;

package/dist/api/make-lambda-payload.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRenderProgressPayload = exports.makeLambdaRenderMediaPayload = void 0;
+const version_1 = require("remotion/version");
+const defaults_1 = require("../defaults");
+const serialize_input_props_1 = require("../shared/serialize-input-props");
+const validate_download_behavior_1 = require("../shared/validate-download-behavior");
+const validate_frames_per_lambda_1 = require("../shared/validate-frames-per-lambda");
+const validate_lambda_codec_1 = require("../shared/validate-lambda-codec");
+const validate_serveurl_1 = require("../shared/validate-serveurl");
+const renderer_1 = require("@remotion/renderer");
+const makeLambdaRenderMediaPayload = async ({ rendererFunctionName, frameRange, framesPerLambda, forceBucketName: bucketName, codec, composition, serveUrl, imageFormat, inputProps, region, crf, envVariables, pixelFormat, proResProfile, maxRetries, privacy, logLevel, outName, timeoutInMilliseconds, chromiumOptions, scale, everyNthFrame, numberOfGifLoops, audioBitrate, concurrencyPerLambda, audioCodec, forceHeight, forceWidth, webhook, videoBitrate, downloadBehavior, muted, overwrite, dumpBrowserLogs, jpegQuality, quality, }) => {
+    if (quality) {
+        throw new Error('quality has been renamed to jpegQuality. Please rename the option.');
+    }
+    const actualCodec = (0, validate_lambda_codec_1.validateLambdaCodec)(codec);
+    (0, validate_serveurl_1.validateServeUrl)(serveUrl);
+    (0, validate_frames_per_lambda_1.validateFramesPerLambda)({
+        framesPerLambda: framesPerLambda !== null && framesPerLambda !== void 0 ? framesPerLambda : null,
+        durationInFrames: 1,
+    });
+    (0, validate_download_behavior_1.validateDownloadBehavior)(downloadBehavior);
+    const serializedInputProps = await (0, serialize_input_props_1.serializeInputProps)({
+        inputProps: inputProps !== null && inputProps !== void 0 ? inputProps : {},
+        region,
+        type: 'video-or-audio',
+        userSpecifiedBucketName: bucketName !== null && bucketName !== void 0 ? bucketName : null,
+    });
+    return {
+        rendererFunctionName: rendererFunctionName !== null && rendererFunctionName !== void 0 ? rendererFunctionName : null,
+        framesPerLambda: framesPerLambda !== null && framesPerLambda !== void 0 ? framesPerLambda : null,
+        composition,
+        serveUrl,
+        inputProps: serializedInputProps,
+        codec: actualCodec,
+        imageFormat: imageFormat !== null && imageFormat !== void 0 ? imageFormat : 'jpeg',
+        crf,
+        envVariables,
+        pixelFormat,
+        proResProfile,
+        jpegQuality,
+        maxRetries: maxRetries !== null && maxRetries !== void 0 ? maxRetries : 1,
+        privacy: privacy !== null && privacy !== void 0 ? privacy : 'public',
+        logLevel: dumpBrowserLogs
+            ? 'verbose'
+            : logLevel !== null && logLevel !== void 0 ? logLevel : renderer_1.RenderInternals.getLogLevel(),
+        frameRange: frameRange !== null && frameRange !== void 0 ? frameRange : null,
+        outName: outName !== null && outName !== void 0 ? outName : null,
+        timeoutInMilliseconds: timeoutInMilliseconds !== null && timeoutInMilliseconds !== void 0 ? timeoutInMilliseconds : 30000,
+        chromiumOptions: chromiumOptions !== null && chromiumOptions !== void 0 ? chromiumOptions : {},
+        scale: scale !== null && scale !== void 0 ? scale : 1,
+        everyNthFrame: everyNthFrame !== null && everyNthFrame !== void 0 ? everyNthFrame : 1,
+        numberOfGifLoops: numberOfGifLoops !== null && numberOfGifLoops !== void 0 ? numberOfGifLoops : 0,
+        concurrencyPerLambda: concurrencyPerLambda !== null && concurrencyPerLambda !== void 0 ? concurrencyPerLambda : 1,
+        downloadBehavior: downloadBehavior !== null && downloadBehavior !== void 0 ? downloadBehavior : { type: 'play-in-browser' },
+        muted: muted !== null && muted !== void 0 ? muted : false,
+        version: version_1.VERSION,
+        overwrite: overwrite !== null && overwrite !== void 0 ? overwrite : false,
+        audioBitrate: audioBitrate !== null && audioBitrate !== void 0 ? audioBitrate : null,
+        videoBitrate: videoBitrate !== null && videoBitrate !== void 0 ? videoBitrate : null,
+        webhook: webhook !== null && webhook !== void 0 ? webhook : null,
+        forceHeight: forceHeight !== null && forceHeight !== void 0 ? forceHeight : null,
+        forceWidth: forceWidth !== null && forceWidth !== void 0 ? forceWidth : null,
+        bucketName: bucketName !== null && bucketName !== void 0 ? bucketName : null,
+        audioCodec: audioCodec !== null && audioCodec !== void 0 ? audioCodec : null,
+        type: defaults_1.LambdaRoutines.start,
+    };
+};
+exports.makeLambdaRenderMediaPayload = makeLambdaRenderMediaPayload;
+const getRenderProgressPayload = ({ bucketName, renderId, s3OutputProvider, }) => {
+    return {
+        type: defaults_1.LambdaRoutines.status,
+        bucketName,
+        renderId,
+        version: version_1.VERSION,
+        s3OutputProvider,
+    };
+};
+exports.getRenderProgressPayload = getRenderProgressPayload;

package/dist/api/presign-url.d.ts

@@ -1,14 +1,14 @@
 import type { AwsRegion } from '../pricing/aws-regions';
-declare type PresignURLInput = {
+export type PresignUrlInput<CheckIfObjectExists extends boolean = boolean> = {
     region: AwsRegion;
     bucketName: string;
     objectKey: string;
-    checkIfObjectExists?: boolean;
+    checkIfObjectExists?: CheckIfObjectExists;
     expiresInSeconds: number;
 };
 /**
  * @description Returns a public url of an object stored in Remotion's S3 bucket.
- * @link https://remotion.dev/docs/lambda/presignurl
+ * @see [Documentation](https://remotion.dev/docs/lambda/presignurl)
  * @param {AwsRegion} params.region The region in which the S3 bucket resides in.
  * @param {string} params.bucketName The name of the bucket to fetch the object from.
  * @param {string} params.objectKey Key of the S3 object to get.
@@ -16,5 +16,4 @@ declare type PresignURLInput = {
  * @param {boolean} params.checkIfObjectExists Whether the function should check if the object exists in the bucket before generating the presigned url.
  * @returns {Promise<string | null>} The public url of an object or `null` if `checkIfObjectExists=true` & object does not exist.
  */
-export declare const presignUrl: ({ region, bucketName, objectKey, checkIfObjectExists, expiresInSeconds, }: PresignURLInput) => Promise<string | null>;
-export {};
+export declare const presignUrl: <CheckIfObjectExists extends boolean = false>({ region, bucketName, objectKey, checkIfObjectExists, expiresInSeconds, }: PresignUrlInput<CheckIfObjectExists>) => Promise<CheckIfObjectExists extends true ? string | null : string>;