@remotion/lambda-client 4.0.364 → 4.0.366

package/src/check-credentials.ts

@@ -1,51 +0,0 @@
-import {DOCS_URL, truthy} from '@remotion/serverless-client';
-import {getEnvVariable} from './get-env-variable';
-import {getIsCli} from './is-cli';
-import {isLikelyToHaveAwsProfile} from './is-likely-to-have-aws-profile';
-
-const messageForVariable = (variable: string) => {
-	return [
-		`You have tried to call a Remotion Lambda function, but have not set the environment variable ${variable}.`,
-		getIsCli()
-			? null
-			: `- Environment variables from a '.env' file are not automatically read if you are calling the Node.JS APIs, in that case you need to load the file yourself or set the environment variables manually.`,
-		`- Please refer to the Remotion Lambda docs (${DOCS_URL}/docs/lambda/setup) to see how to generate the credentials for your AWS account and then set the environment variables.`,
-		`- For more reasons see the troubleshooting page: ${DOCS_URL}/docs/lambda/troubleshooting/permissions`,
-	]
-		.filter(truthy)
-		.join('\n');
-};
-
-export const checkCredentials = () => {
-	if (getEnvVariable('REMOTION_SKIP_AWS_CREDENTIALS_CHECK')) {
-		return;
-	}
-
-	if (getEnvVariable('REMOTION_AWS_PROFILE') || getEnvVariable('AWS_PROFILE')) {
-		return;
-	}
-
-	if (isLikelyToHaveAwsProfile()) {
-		return;
-	}
-
-	if (
-		!getEnvVariable('AWS_ACCESS_KEY_ID') &&
-		!getEnvVariable('REMOTION_AWS_ACCESS_KEY_ID')
-	) {
-		throw new Error(
-			messageForVariable('AWS_ACCESS_KEY_ID or REMOTION_AWS_ACCESS_KEY_ID'),
-		);
-	}
-
-	if (
-		!getEnvVariable('AWS_SECRET_ACCESS_KEY') &&
-		!getEnvVariable('REMOTION_AWS_SECRET_ACCESS_KEY')
-	) {
-		throw new Error(
-			messageForVariable(
-				'AWS_SECRET_ACCESS_KEY or REMOTION_AWS_SECRET_ACCESS_KEY',
-			),
-		);
-	}
-};

package/src/clean-items.ts

@@ -1,50 +0,0 @@
-import type {
-	CloudProvider,
-	ProviderSpecifics,
-} from '@remotion/serverless-client';
-import {pLimit} from './p-limit';
-
-const limit = pLimit(10);
-
-export const cleanItems = <Provider extends CloudProvider>({
-	bucket,
-	onAfterItemDeleted,
-	onBeforeItemDeleted,
-	region,
-	list,
-	providerSpecifics,
-	forcePathStyle,
-	requestHandler,
-}: {
-	bucket: string;
-	region: Provider['region'];
-	list: string[];
-	onBeforeItemDeleted: (data: {bucketName: string; itemName: string}) => void;
-	onAfterItemDeleted: (data: {bucketName: string; itemName: string}) => void;
-	providerSpecifics: ProviderSpecifics<Provider>;
-	forcePathStyle: boolean;
-	requestHandler: Provider['requestHandler'] | null;
-}) => {
-	return Promise.all(
-		list.map((object) =>
-			limit(async () => {
-				onBeforeItemDeleted({
-					bucketName: bucket,
-					itemName: object,
-				});
-				await providerSpecifics.deleteFile({
-					bucketName: bucket,
-					key: object,
-					region,
-					customCredentials: null,
-					forcePathStyle,
-					requestHandler,
-				});
-				onAfterItemDeleted({
-					bucketName: bucket,
-					itemName: object,
-				});
-			}),
-		),
-	);
-};

package/src/constants.ts

@@ -1,38 +0,0 @@
-import type {GenericRenderProgress, Privacy} from '@remotion/serverless-client';
-import type {AwsProvider} from './aws-provider';
-import type {AwsRegion} from './regions';
-
-export const MIN_MEMORY = 512;
-export const MAX_MEMORY = 10240;
-export const DEFAULT_MEMORY_SIZE = 2048;
-
-export const DEFAULT_TIMEOUT = 120;
-export const MIN_TIMEOUT = 15;
-export const MAX_TIMEOUT = 900;
-
-export const DEFAULT_FRAMES_PER_LAMBDA = 20;
-
-export const BINARY_NAME = 'remotion lambda';
-export const DEFAULT_REGION: AwsRegion = 'us-east-1';
-export const DEFAULT_MAX_RETRIES = 1;
-
-export const MAX_EPHEMERAL_STORAGE_IN_MB = 10240;
-// TODO: In V5, Enable set this to 10240
-export const DEFAULT_EPHEMERAL_STORAGE_IN_MB = 2048;
-export const MIN_EPHEMERAL_STORAGE_IN_MB = 512;
-
-export const DEFAULT_OUTPUT_PRIVACY: Privacy = 'public';
-
-export const DEFAULT_CLOUDWATCH_RETENTION_PERIOD = 14;
-
-export const RENDER_FN_PREFIX = 'remotion-render-';
-export const LOG_GROUP_PREFIX = '/aws/lambda/';
-export const LAMBDA_INSIGHTS_PREFIX = '/aws/lambda-insights';
-
-export const getSitesKey = (siteId: string) => `sites/${siteId}`;
-
-export type RenderProgress = GenericRenderProgress<AwsProvider>;
-
-export const LAMBDA_CONCURRENCY_LIMIT_QUOTA = 'L-B99A9384';
-
-export const REMOTION_BUCKET_PREFIX = 'remotionlambda-';

package/src/content-disposition-header.ts

@@ -1,64 +0,0 @@
-import type {DownloadBehavior} from '@remotion/serverless-client';
-
-// By setting the Content-Disposition header in an S3 object,
-// you can control if the user downloads the item if you
-// visit the link
-
-const problematicCharacters = {
-	'%3A': ':',
-	'%2F': '/',
-	'%3F': '?',
-	'%23': '#',
-	'%5B': '[',
-	'%5D': ']',
-	'%40': '@',
-	'%21': '!',
-	'%24': '$',
-	'%26': '&',
-	'%27': "'",
-	'%28': '(',
-	'%29': ')',
-	'%2A': '*',
-	'%2B': '+',
-	'%2C': ',',
-	'%3B': ';',
-};
-
-type HexInfo = {
-	containsHex: boolean;
-};
-
-const includesHexOfUnsafeChar = (path: string): HexInfo => {
-	for (const key of Object.keys(
-		problematicCharacters,
-	) as (keyof typeof problematicCharacters)[]) {
-		if (path.includes(key)) {
-			return {containsHex: true};
-		}
-	}
-
-	return {containsHex: false};
-};
-
-export const getContentDispositionHeader = (
-	behavior: DownloadBehavior | null,
-): string | undefined => {
-	if (behavior === null) {
-		return undefined;
-	}
-
-	if (behavior.type === 'play-in-browser') {
-		return undefined;
-	}
-
-	if (behavior.fileName === null) {
-		return `attachment`;
-	}
-
-	const {containsHex} = includesHexOfUnsafeChar(behavior.fileName);
-	if (containsHex) {
-		return `attachment; filename="${behavior.fileName}"`;
-	}
-
-	return `attachment; filename="${encodeURIComponent(behavior.fileName)}"`;
-};

package/src/convert-to-serve-url.ts

@@ -1,24 +0,0 @@
-import {DOCS_URL} from '@remotion/serverless-client';
-import type {AwsRegion} from './regions';
-
-export const convertToServeUrlImplementation = ({
-	urlOrId,
-	region,
-	bucketName,
-}: {
-	urlOrId: string;
-	region: AwsRegion;
-	bucketName: string;
-}) => {
-	if (urlOrId.startsWith('src/')) {
-		throw new Error(
-			`Remotion Lambda can only render based on a URL in the cloud. It seems like you passed a local file: ${urlOrId}. Read the setup guide for Remotion Lambda ${DOCS_URL}/docs/lambda/setup`,
-		);
-	}
-
-	if (urlOrId.startsWith('http://') || urlOrId.startsWith('https://')) {
-		return urlOrId;
-	}
-
-	return `https://${bucketName}.s3.${region}.amazonaws.com/sites/${urlOrId}/index.html`;
-};

package/src/create-bucket.ts

@@ -1,87 +0,0 @@
-import {
-	CreateBucketCommand,
-	DeleteBucketOwnershipControlsCommand,
-	DeletePublicAccessBlockCommand,
-	PutBucketAclCommand,
-} from '@aws-sdk/client-s3';
-import type {ProviderSpecifics} from '@remotion/serverless-client';
-import type {AwsProvider} from './aws-provider';
-import {getS3Client} from './get-s3-client';
-
-export const createBucket: ProviderSpecifics<AwsProvider>['createBucket'] =
-	async ({region, bucketName, forcePathStyle, requestHandler}) => {
-		await getS3Client({
-			region,
-			customCredentials: null,
-			forcePathStyle,
-			requestHandler,
-		}).send(
-			new CreateBucketCommand({
-				Bucket: bucketName,
-			}),
-		);
-
-		try {
-			await getS3Client({
-				region,
-				customCredentials: null,
-				forcePathStyle,
-				requestHandler,
-			}).send(
-				new DeleteBucketOwnershipControlsCommand({
-					Bucket: bucketName,
-				}),
-			);
-		} catch (err) {
-			if ((err as Error).message.includes('Access Denied')) {
-				throw new Error(
-					'Since April 2023, more AWS permissions are required to create an S3 bucket. You need to update your user policy to continue. See https://remotion.dev/docs/lambda/s3-public-access for instructions on how to resolve this issue.',
-				);
-			}
-
-			throw err;
-		}
-
-		try {
-			await getS3Client({
-				region,
-				customCredentials: null,
-				forcePathStyle,
-				requestHandler,
-			}).send(
-				new DeletePublicAccessBlockCommand({
-					Bucket: bucketName,
-				}),
-			);
-		} catch (err) {
-			if ((err as Error).message.includes('Access Denied')) {
-				throw new Error(
-					'PARTIAL SUCCESS: The s3:PutBucketOwnershipControls was found, but the s3:PutBucketPublicAccessBlock permission is not given. Since April 2023, more AWS permissions are required to create an S3 bucket. You need to update your user policy to continue. You need to update your user policy to continue. See https://remotion.dev/docs/lambda/s3-public-access for instructions on how to resolve this issue.',
-				);
-			}
-
-			throw err;
-		}
-
-		try {
-			await getS3Client({
-				region,
-				customCredentials: null,
-				forcePathStyle,
-				requestHandler,
-			}).send(
-				new PutBucketAclCommand({
-					Bucket: bucketName,
-					ACL: 'public-read',
-				}),
-			);
-		} catch (err) {
-			if ((err as Error).message.includes('The bucket does not allow ACLs')) {
-				throw new Error(
-					`Could not add an ACL to the bucket. This might have happened because the bucket was already successfully created before but then failed to configure correctly. We recommend to delete the bucket (${bucketName}) if it is empty and start over to fix the problem.`,
-				);
-			}
-
-			throw err;
-		}
-	};

package/src/delete-file.ts

@@ -1,38 +0,0 @@
-import {DeleteObjectCommand} from '@aws-sdk/client-s3';
-import type {
-	CustomCredentials,
-	ProviderSpecifics,
-} from '@remotion/serverless-client';
-import type {AwsProvider} from './aws-provider';
-import {getS3Client} from './get-s3-client';
-import type {AwsRegion} from './regions';
-import type {RequestHandler} from './types';
-
-export const lambdaDeleteFileImplementation: ProviderSpecifics<AwsProvider>['deleteFile'] =
-	async ({
-		bucketName,
-		key,
-		region,
-		customCredentials,
-		forcePathStyle,
-		requestHandler,
-	}: {
-		region: AwsRegion;
-		bucketName: string;
-		key: string;
-		customCredentials: CustomCredentials<AwsProvider> | null;
-		forcePathStyle: boolean;
-		requestHandler: RequestHandler | null;
-	}) => {
-		await getS3Client({
-			region,
-			customCredentials,
-			forcePathStyle,
-			requestHandler,
-		}).send(
-			new DeleteObjectCommand({
-				Bucket: bucketName,
-				Key: key,
-			}),
-		);
-	};

package/src/delete-function.ts

@@ -1,28 +0,0 @@
-import {DeleteFunctionCommand} from '@aws-sdk/client-lambda';
-import type {
-	DeleteFunction,
-	DeleteFunctionInput as GenericDeleteFunctionInput,
-} from '@remotion/serverless-client';
-import {getLambdaClient} from './aws-clients';
-import type {AwsProvider} from './aws-provider';
-import type {RequestHandler} from './types';
-
-export type DeleteFunctionInput = GenericDeleteFunctionInput<AwsProvider> & {
-	requestHandler?: RequestHandler;
-};
-
-/*
- * @description Deletes a deployed Lambda function based on its name.
- * @see [Documentation](https://remotion.dev/docs/lambda/deletefunction)
- */
-export const deleteFunction: DeleteFunction<AwsProvider> = async ({
-	region,
-	functionName,
-	requestHandler,
-}: DeleteFunctionInput): Promise<void> => {
-	await getLambdaClient(region, undefined, requestHandler ?? null).send(
-		new DeleteFunctionCommand({
-			FunctionName: functionName,
-		}),
-	);
-};

package/src/delete-render.ts

@@ -1,114 +0,0 @@
-import type {ProviderSpecifics} from '@remotion/serverless-client';
-import {
-	getExpectedOutName,
-	getOverallProgressFromStorage,
-	rendersPrefix,
-	type CustomCredentials,
-} from '@remotion/serverless-client';
-import type {AwsProvider} from './aws-provider';
-import {awsImplementation} from './aws-provider';
-import {cleanItems} from './clean-items';
-import {REMOTION_BUCKET_PREFIX} from './constants';
-import type {AwsRegion} from './regions';
-import type {RequestHandler} from './types';
-
-export type DeleteRenderInput = {
-	region: AwsRegion;
-	bucketName: string;
-	renderId: string;
-	customCredentials?: CustomCredentials<AwsProvider>;
-	forcePathStyle?: boolean;
-	requestHandler?: RequestHandler;
-};
-
-export const internalDeleteRender = async (
-	input: DeleteRenderInput & {
-		providerSpecifics: ProviderSpecifics<AwsProvider>;
-		forcePathStyle: boolean;
-	},
-) => {
-	const expectedBucketOwner = await input.providerSpecifics.getAccountId({
-		region: input.region,
-	});
-	const progress = await getOverallProgressFromStorage({
-		bucketName: input.bucketName,
-		expectedBucketOwner,
-		region: input.region,
-		renderId: input.renderId,
-		providerSpecifics: input.providerSpecifics,
-		forcePathStyle: input.forcePathStyle,
-		requestHandler: input.requestHandler,
-	});
-
-	// Render did not start yet
-	if (progress.renderMetadata === null) {
-		return {freedBytes: 0};
-	}
-
-	const {key, renderBucketName, customCredentials} = getExpectedOutName({
-		renderMetadata: progress.renderMetadata,
-		bucketName: input.bucketName,
-		customCredentials: input.customCredentials ?? null,
-		bucketNamePrefix: REMOTION_BUCKET_PREFIX,
-	});
-
-	await input.providerSpecifics.deleteFile({
-		bucketName: renderBucketName,
-		customCredentials,
-		key,
-		region: input.region,
-		forcePathStyle: input.forcePathStyle,
-		requestHandler: input.requestHandler,
-	});
-
-	let files = await input.providerSpecifics.listObjects({
-		bucketName: input.bucketName,
-		prefix: rendersPrefix(input.renderId),
-		region: input.region,
-		expectedBucketOwner,
-		forcePathStyle: input.forcePathStyle,
-		requestHandler: input.requestHandler,
-	});
-
-	let totalSize = 0;
-
-	while (files.length > 0) {
-		totalSize += files.reduce((a, b) => {
-			return a + (b.Size ?? 0);
-		}, 0);
-		await cleanItems({
-			list: files.map((f) => f.Key as string),
-			bucket: input.bucketName,
-			onAfterItemDeleted: () => undefined,
-			onBeforeItemDeleted: () => undefined,
-			region: input.region,
-			providerSpecifics: input.providerSpecifics,
-			forcePathStyle: input.forcePathStyle,
-			requestHandler: input.requestHandler,
-		});
-		files = await input.providerSpecifics.listObjects({
-			bucketName: input.bucketName,
-			prefix: rendersPrefix(input.renderId),
-			region: input.region,
-			expectedBucketOwner,
-			forcePathStyle: input.forcePathStyle,
-			requestHandler: input.requestHandler,
-		});
-	}
-
-	return {
-		freedBytes: totalSize,
-	};
-};
-
-/*
- * @description Deletes a rendered video, audio or still and its associated metadata.
- * @see [Documentation](https://remotion.dev/docs/lambda/deleterender)
- */
-export const deleteRender = (input: DeleteRenderInput) => {
-	return internalDeleteRender({
-		...input,
-		providerSpecifics: awsImplementation,
-		forcePathStyle: input.forcePathStyle ?? false,
-	});
-};

package/src/encode-aws-url-params.ts

@@ -1,3 +0,0 @@
-export const encodeAwsUrlParams = (input: string) => {
-	return encodeURIComponent(input).replace(/%/g, '$25');
-};

package/src/estimate-price.ts

@@ -1,95 +0,0 @@
-import {MIN_EPHEMERAL_STORAGE_IN_MB} from './constants';
-import {pricing} from './price-per-1s';
-import type {AwsRegion} from './regions';
-import {validateAwsRegion} from './validate-aws-region';
-import {validateDiskSizeInMb} from './validate-disk-size-in-mb';
-import {validateMemorySize} from './validate-memory-size';
-
-type Miliseconds =
-	| {
-			/**
-			 * @deprecated Typo in property name. Use `durationInMilliseconds` instead.
-			 */
-			durationInMiliseconds: number;
-	  }
-	| {
-			durationInMilliseconds: number;
-	  };
-
-export type EstimatePriceInput = {
-	region: AwsRegion;
-	memorySizeInMb: number;
-	diskSizeInMb: number;
-	lambdasInvoked: number;
-} & Miliseconds;
-
-/*
- * @description Calculates the AWS costs incurred for AWS Lambda given the region, execution duration and memory size.
- * @see [Documentation](https://remotion.dev/docs/lambda/estimateprice)
- */
-export const estimatePrice = ({
-	region,
-	memorySizeInMb,
-	diskSizeInMb,
-	lambdasInvoked,
-	...other
-}: EstimatePriceInput): number => {
-	validateMemorySize(memorySizeInMb);
-	validateAwsRegion(region);
-	validateDiskSizeInMb(diskSizeInMb);
-
-	const durationInMilliseconds =
-		'durationInMiliseconds' in other
-			? other.durationInMiliseconds
-			: other.durationInMilliseconds;
-
-	if (typeof durationInMilliseconds !== 'number') {
-		throw new TypeError(
-			`Parameter 'durationInMilliseconds' must be a number but got ${typeof durationInMilliseconds}`,
-		);
-	}
-
-	if (Number.isNaN(durationInMilliseconds)) {
-		throw new TypeError(
-			`Parameter 'durationInMilliseconds' must not be NaN but it is.`,
-		);
-	}
-
-	if (!Number.isFinite(durationInMilliseconds)) {
-		throw new TypeError(
-			`Parameter 'durationInMilliseconds' must be finite but it is ${durationInMilliseconds}`,
-		);
-	}
-
-	if (durationInMilliseconds < 0) {
-		throw new TypeError(
-			`Parameter 'durationInMilliseconds' must be over 0 but it is ${durationInMilliseconds}.`,
-		);
-	}
-
-	const durationPrice = pricing[region]['Lambda Duration-ARM'].price;
-
-	// In GB-second
-	const timeCostDollars =
-		Number(durationPrice) *
-		((memorySizeInMb * durationInMilliseconds) / 1000 / 1024);
-
-	const diskSizePrice = pricing[region]['Lambda Storage-Duration-ARM'].price;
-
-	const chargedDiskSize = Math.max(
-		0,
-		diskSizeInMb - MIN_EPHEMERAL_STORAGE_IN_MB,
-	);
-	// In GB-second
-	const diskSizeDollars =
-		chargedDiskSize *
-		Number(diskSizePrice) *
-		(durationInMilliseconds / 1000 / 1024);
-
-	const invocationCost =
-		Number(pricing[region]['Lambda Requests'].price) * lambdasInvoked;
-
-	return Number(
-		(timeCostDollars + diskSizeDollars + invocationCost).toFixed(5),
-	);
-};

package/src/express-webhook.ts

@@ -1,57 +0,0 @@
-import type {Request, Response} from 'express';
-import type {NextWebhookArgs} from './app-router-webhook';
-import {addHeaders} from './pages-router-webhook';
-import {validateWebhookSignature} from './validate-webhook-signature';
-
-export const expressWebhook = (options: NextWebhookArgs) => {
-	const {testing, extraHeaders, secret, onSuccess, onTimeout, onError} =
-		options;
-	return async (req: Request, res: Response) => {
-		//  add headers to enable  testing
-		if (testing) {
-			const testingheaders = {
-				'Access-Control-Allow-Origin': 'https://www.remotion.dev',
-				'Access-Control-Allow-Headers':
-					'X-CSRF-Token, X-Requested-With, Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version, X-Remotion-Status, X-Remotion-Signature, X-Remotion-Mode',
-				'Access-Control-Allow-Methods': 'OPTIONS,POST',
-			};
-			addHeaders(res, testingheaders);
-		}
-
-		//  add extra headers
-		addHeaders(res, extraHeaders || {});
-
-		// dont go forward if just testing
-		if (req.method === 'OPTIONS') {
-			res.status(200).end();
-			return;
-		}
-
-		try {
-			// validate the webhook signature
-			validateWebhookSignature({
-				signatureHeader: req.header('X-Remotion-Signature') as string,
-				body: req.body,
-				secret,
-			});
-
-			//  custom logic
-			const payload = req.body;
-			if (payload.type === 'success' && onSuccess) {
-				await onSuccess(payload);
-			} else if (payload.type === 'error' && onError) {
-				await onError(payload);
-			} else if (payload.type === 'timeout' && onTimeout) {
-				await onTimeout(payload);
-			}
-
-			// send response
-			res.status(200).json({success: true});
-		} catch (err) {
-			res.status(500).json({
-				success: false,
-				error: err instanceof Error ? err.message : String(err),
-			});
-		}
-	};
-};

package/src/get-account-id.ts

@@ -1,22 +0,0 @@
-import {GetCallerIdentityCommand} from '@aws-sdk/client-sts';
-import type {GetAccountId} from '@remotion/serverless-client';
-import {getStsClient} from './aws-clients';
-import type {AwsProvider} from './aws-provider';
-import type {AwsRegion} from './regions';
-import {validateAwsRegion} from './validate-aws-region';
-
-export const getAccountIdImplementation: GetAccountId<
-	AwsProvider
-> = async (options: {region: AwsRegion}) => {
-	validateAwsRegion(options.region);
-
-	const callerIdentity = await getStsClient(options.region, null).send(
-		new GetCallerIdentityCommand({}),
-	);
-
-	if (!callerIdentity.Account) {
-		throw new Error('Cannot get account ID');
-	}
-
-	return callerIdentity.Account;
-};