@remotion/lambda-client 4.0.364 → 4.0.365

package/src/random-hash.ts

@@ -1,10 +0,0 @@
-const alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789';
-
-export const randomHashImplementation = (): string => {
-	return new Array(10)
-		.fill(1)
-		.map(() => {
-			return alphabet[Math.floor(Math.random() * alphabet.length)];
-		})
-		.join('');
-};

package/src/read-file.ts

@@ -1,35 +0,0 @@
-import {GetObjectCommand} from '@aws-sdk/client-s3';
-import type {Readable} from 'stream';
-import {getS3Client} from './get-s3-client';
-import type {AwsRegion} from './regions';
-import type {RequestHandler} from './types';
-
-export const lambdaReadFileImplementation = async ({
-	bucketName,
-	key,
-	region,
-	expectedBucketOwner,
-	forcePathStyle,
-	requestHandler,
-}: {
-	bucketName: string;
-	key: string;
-	region: AwsRegion;
-	expectedBucketOwner: string | null;
-	forcePathStyle: boolean;
-	requestHandler: RequestHandler | null;
-}): Promise<Readable> => {
-	const {Body} = await getS3Client({
-		region,
-		customCredentials: null,
-		forcePathStyle,
-		requestHandler,
-	}).send(
-		new GetObjectCommand({
-			Bucket: bucketName,
-			Key: key,
-			ExpectedBucketOwner: expectedBucketOwner ?? undefined,
-		}),
-	);
-	return Body as Readable;
-};

package/src/regions.ts

@@ -1,48 +0,0 @@
-export const DEFAULT_AWS_REGIONS = [
-	'eu-central-1',
-	'eu-west-1',
-	'eu-west-2',
-	'eu-west-3',
-	'eu-north-1',
-	'us-east-1', // N. Virginia
-	'us-east-2', // Ohio;
-	'us-west-1',
-	'us-west-2', // Oregon
-	'ap-south-1',
-	'ap-southeast-1',
-	'ap-southeast-2',
-	'ap-northeast-1',
-	'ap-northeast-2',
-	'ap-northeast-3',
-	'ca-central-1',
-	'sa-east-1',
-] as const;
-
-export const AWS_REGIONS = [
-	'eu-central-1',
-	'eu-central-2',
-	'eu-west-1',
-	'eu-west-2',
-	'eu-west-3',
-	'eu-south-1',
-	'eu-north-1',
-	'us-east-1', // N. Virginia
-	'us-east-2', // Ohio;
-	'us-west-1',
-	'us-west-2', // Oregon
-	'af-south-1',
-	'ap-south-1',
-	'ap-east-1',
-	'ap-southeast-1',
-	'ap-southeast-2',
-	'ap-northeast-1',
-	'ap-northeast-2',
-	'ap-northeast-3',
-	'ap-southeast-4',
-	'ap-southeast-5',
-	'ca-central-1',
-	'me-south-1',
-	'sa-east-1',
-] as const;
-
-export type AwsRegion = (typeof AWS_REGIONS)[number];

package/src/render-media-on-lambda.ts

@@ -1,227 +0,0 @@
-import type {StorageClass} from '@aws-sdk/client-s3';
-import type {
-	AudioCodec,
-	BrowserSafeApis,
-	ChromiumOptions,
-	DownloadBehavior,
-	FrameRange,
-	OutNameInput,
-	PixelFormat,
-	Privacy,
-	ProResProfile,
-	ServerlessCodec,
-	ToOptions,
-	VideoImageFormat,
-	WebhookOption,
-} from '@remotion/serverless-client';
-import {
-	ServerlessRoutines,
-	wrapWithErrorHandling,
-} from '@remotion/serverless-client';
-import {awsImplementation, type AwsProvider} from './aws-provider';
-import {
-	getCloudwatchMethodUrl,
-	getCloudwatchRendererUrl,
-	getLambdaInsightsUrl,
-	getProgressJsonUrl,
-	getS3RenderUrl,
-} from './get-aws-urls';
-import type {InnerRenderMediaOnLambdaInput} from './make-lambda-payload';
-import {makeLambdaRenderMediaPayload} from './make-lambda-payload';
-import type {AwsRegion} from './regions';
-import type {RequestHandler} from './types';
-
-export type RenderMediaOnLambdaInput = {
-	region: AwsRegion;
-	functionName: string;
-	serveUrl: string;
-	composition: string;
-	inputProps?: Record<string, unknown>;
-	codec: ServerlessCodec;
-	imageFormat?: VideoImageFormat;
-	crf?: number | undefined;
-	envVariables?: Record<string, string>;
-	pixelFormat?: PixelFormat;
-	proResProfile?: ProResProfile;
-	privacy?: Privacy;
-	/**
-	 * @deprecated Renamed to `jpegQuality`
-	 */
-	quality?: never;
-	jpegQuality?: number;
-	maxRetries?: number;
-	framesPerLambda?: number;
-	concurrency?: number;
-	frameRange?: FrameRange;
-	outName?: OutNameInput<AwsProvider>;
-	chromiumOptions?: Omit<ChromiumOptions, 'enableMultiProcessOnLinux'>;
-	scale?: number;
-	everyNthFrame?: number;
-	concurrencyPerLambda?: number;
-	downloadBehavior?: DownloadBehavior | null;
-	overwrite?: boolean;
-	webhook?: WebhookOption | null;
-	forceWidth?: number | null;
-	forceHeight?: number | null;
-	rendererFunctionName?: string | null;
-	forceBucketName?: string;
-	audioCodec?: AudioCodec | null;
-	/**
-	 * @deprecated in favor of `logLevel`: true
-	 */
-	dumpBrowserLogs?: boolean;
-	forcePathStyle?: boolean;
-	metadata?: Record<string, string> | null;
-	storageClass?: StorageClass | null;
-	requestHandler?: RequestHandler;
-} & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.renderMediaOnLambda>>;
-
-export type RenderMediaOnLambdaOutput = {
-	renderId: string;
-	bucketName: string;
-	cloudWatchLogs: string;
-	cloudWatchMainLogs: string;
-	lambdaInsightsLogs: string;
-	folderInS3Console: string;
-	progressJsonInConsole: string;
-};
-
-export const internalRenderMediaOnLambdaRaw = async (
-	input: InnerRenderMediaOnLambdaInput,
-): Promise<RenderMediaOnLambdaOutput> => {
-	const {functionName, region, rendererFunctionName} = input;
-
-	try {
-		const res = await awsImplementation.callFunctionSync({
-			functionName,
-			type: ServerlessRoutines.start,
-			payload: await makeLambdaRenderMediaPayload(input),
-			region,
-			timeoutInTest: 120000,
-			requestHandler: input.requestHandler,
-		});
-
-		return {
-			renderId: res.renderId,
-			bucketName: res.bucketName,
-			cloudWatchLogs: getCloudwatchRendererUrl({
-				functionName,
-				region,
-				renderId: res.renderId,
-				rendererFunctionName: rendererFunctionName ?? null,
-				chunk: null,
-			}),
-			cloudWatchMainLogs: getCloudwatchMethodUrl({
-				renderId: res.renderId,
-				functionName,
-				method: ServerlessRoutines.launch,
-				region,
-				rendererFunctionName: rendererFunctionName ?? null,
-			}),
-			folderInS3Console: getS3RenderUrl({
-				bucketName: res.bucketName,
-				renderId: res.renderId,
-				region,
-			}),
-			lambdaInsightsLogs: getLambdaInsightsUrl({
-				functionName,
-				region,
-			}),
-			progressJsonInConsole: getProgressJsonUrl({
-				bucketName: res.bucketName,
-				renderId: res.renderId,
-				region,
-			}),
-		};
-	} catch (err) {
-		if ((err as Error).stack?.includes('UnrecognizedClientException')) {
-			throw new Error(
-				'UnrecognizedClientException: The AWS credentials provided were probably mixed up. Learn how to fix this issue here: https://remotion.dev/docs/lambda/troubleshooting/unrecognizedclientexception',
-			);
-		}
-
-		throw err;
-	}
-};
-
-export const renderMediaOnLambdaOptionalToRequired = (
-	options: RenderMediaOnLambdaInput,
-): InnerRenderMediaOnLambdaInput => {
-	return {
-		offthreadVideoThreads: options.offthreadVideoThreads ?? null,
-		audioBitrate: options.audioBitrate ?? null,
-		audioCodec: options.audioCodec ?? null,
-		chromiumOptions: options.chromiumOptions ?? {},
-		codec: options.codec,
-		colorSpace: options.colorSpace ?? null,
-		composition: options.composition,
-		concurrencyPerLambda: options.concurrencyPerLambda ?? 1,
-		concurrency: options.concurrency ?? null,
-		crf: options.crf,
-		downloadBehavior: options.downloadBehavior ?? {type: 'play-in-browser'},
-		envVariables: options.envVariables ?? {},
-		everyNthFrame: options.everyNthFrame ?? 1,
-		forceBucketName: options.forceBucketName ?? null,
-		forceHeight: options.forceHeight ?? null,
-		forceWidth: options.forceWidth ?? null,
-		frameRange: options.frameRange ?? null,
-		framesPerLambda: options.framesPerLambda ?? null,
-		functionName: options.functionName,
-		imageFormat: options.imageFormat ?? 'jpeg',
-		inputProps: options.inputProps ?? {},
-		jpegQuality: options.jpegQuality ?? 80,
-		logLevel: options.logLevel ?? 'info',
-		maxRetries: options.maxRetries ?? 1,
-		muted: options.muted ?? false,
-		numberOfGifLoops: options.numberOfGifLoops ?? null,
-		offthreadVideoCacheSizeInBytes:
-			options.offthreadVideoCacheSizeInBytes ?? null,
-		outName: options.outName ?? null,
-		overwrite: options.overwrite ?? false,
-		pixelFormat: options.pixelFormat ?? undefined,
-		privacy: options.privacy ?? 'public',
-		proResProfile: options.proResProfile ?? undefined,
-		region: options.region,
-		rendererFunctionName: options.rendererFunctionName ?? null,
-		scale: options.scale ?? 1,
-		serveUrl: options.serveUrl,
-		timeoutInMilliseconds: options.timeoutInMilliseconds ?? 30000,
-		videoBitrate: options.videoBitrate ?? null,
-		encodingMaxRate: options.encodingMaxRate ?? null,
-		encodingBufferSize: options.encodingBufferSize ?? null,
-		webhook: options.webhook ?? null,
-		x264Preset: options.x264Preset ?? null,
-		deleteAfter: options.deleteAfter ?? null,
-		preferLossless: options.preferLossless ?? false,
-		forcePathStyle: options.forcePathStyle ?? false,
-		indent: false,
-		metadata: options.metadata ?? null,
-		apiKey: options.apiKey ?? null,
-		storageClass: options.storageClass ?? null,
-		requestHandler: options.requestHandler ?? null,
-		mediaCacheSizeInBytes: options.mediaCacheSizeInBytes ?? null,
-	};
-};
-
-const wrapped = wrapWithErrorHandling(internalRenderMediaOnLambdaRaw);
-
-/*
- * @description Kicks off a render process on Remotion Lambda. The progress can be tracked using getRenderProgress().
- * @see [Documentation](https://remotion.dev/docs/lambda/rendermediaonlambda)
- */
-export const renderMediaOnLambda = (
-	options: RenderMediaOnLambdaInput,
-): Promise<RenderMediaOnLambdaOutput> => {
-	if (options.quality) {
-		throw new Error(
-			'quality has been renamed to jpegQuality. Please rename the option.',
-		);
-	}
-
-	return wrapped(renderMediaOnLambdaOptionalToRequired(options));
-};
-
-/**
- * @deprecated Renamed to renderMediaOnLambda()
- */
-export const renderVideoOnLambda = renderMediaOnLambda;

package/src/render-still-on-lambda.ts

@@ -1,209 +0,0 @@
-import type {
-	BrowserSafeApis,
-	ChromiumOptions,
-	DownloadBehavior,
-	StillImageFormat,
-	ToOptions,
-} from '@remotion/serverless-client';
-import {ServerlessRoutines} from '@remotion/serverless-client';
-
-import type {StorageClass} from '@aws-sdk/client-s3';
-import type {
-	CostsInfo,
-	OutNameInput,
-	Privacy,
-	ReceivedArtifact,
-	RenderStillFunctionResponsePayload,
-} from '@remotion/serverless-client';
-import {wrapWithErrorHandling} from '@remotion/serverless-client';
-import {awsImplementation, type AwsProvider} from './aws-provider';
-import {DEFAULT_MAX_RETRIES} from './constants';
-import {getCloudwatchMethodUrl, getLambdaInsightsUrl} from './get-aws-urls';
-import {makeLambdaRenderStillPayload} from './make-lambda-payload';
-import type {AwsRegion} from './regions';
-import type {RequestHandler} from './types';
-
-type MandatoryParameters = {
-	region: AwsRegion;
-	functionName: string;
-	serveUrl: string;
-	composition: string;
-	inputProps: Record<string, unknown>;
-	imageFormat: StillImageFormat;
-	privacy: Privacy;
-};
-
-type OptionalParameters = {
-	maxRetries: number;
-	envVariables: Record<string, string>;
-	frame: number;
-	outName: OutNameInput<AwsProvider> | null;
-	chromiumOptions: ChromiumOptions;
-	downloadBehavior: DownloadBehavior;
-	forceWidth: number | null;
-	forceHeight: number | null;
-	forceBucketName: string | null;
-	onInit: (data: {
-		renderId: string;
-		cloudWatchLogs: string;
-		lambdaInsightsUrl: string;
-	}) => void;
-	indent: boolean;
-	forcePathStyle: boolean;
-	storageClass: StorageClass | null;
-	requestHandler: RequestHandler | null | undefined;
-} & ToOptions<typeof BrowserSafeApis.optionsMap.renderStillOnLambda>;
-
-export type RenderStillOnLambdaNonNullInput = MandatoryParameters &
-	OptionalParameters;
-
-export type RenderStillOnLambdaInput = MandatoryParameters &
-	Partial<OptionalParameters> & {
-		requestHandler?: RequestHandler;
-	};
-
-export type RenderStillOnLambdaOutput = {
-	estimatedPrice: CostsInfo;
-	url: string;
-	outKey: string;
-	sizeInBytes: number;
-	bucketName: string;
-	renderId: string;
-	cloudWatchLogs: string;
-	artifacts: ReceivedArtifact<AwsProvider>[];
-};
-
-const innerRenderStillOnLambda = async (
-	input: RenderStillOnLambdaNonNullInput,
-): Promise<RenderStillOnLambdaOutput> => {
-	const {functionName, region, onInit} = input;
-	try {
-		const payload = await makeLambdaRenderStillPayload(input);
-		const res = await new Promise<
-			RenderStillFunctionResponsePayload<AwsProvider>
-		>((resolve, reject) => {
-			awsImplementation
-				.callFunctionStreaming<ServerlessRoutines.still>({
-					functionName,
-					type: ServerlessRoutines.still,
-					payload,
-					region,
-					receivedStreamingPayload: ({message}) => {
-						if (message.type === 'render-id-determined') {
-							onInit?.({
-								renderId: message.payload.renderId,
-								cloudWatchLogs: getCloudwatchMethodUrl({
-									functionName,
-									method: ServerlessRoutines.still,
-									region,
-									rendererFunctionName: null,
-									renderId: message.payload.renderId,
-								}),
-								lambdaInsightsUrl: getLambdaInsightsUrl({
-									functionName,
-									region,
-								}),
-							});
-						}
-
-						if (message.type === 'error-occurred') {
-							reject(new Error(message.payload.error));
-						}
-
-						if (message.type === 'still-rendered') {
-							resolve(message.payload);
-						}
-					},
-					timeoutInTest: 120000,
-					retriesRemaining: input.maxRetries,
-					requestHandler: input.requestHandler,
-				})
-				.then(() => {
-					reject(new Error('Expected response to be streamed'));
-				})
-				.catch((err) => {
-					reject(err);
-				});
-		});
-
-		return {
-			estimatedPrice: res.estimatedPrice,
-			url: res.output,
-			outKey: res.outKey,
-			sizeInBytes: res.size,
-			bucketName: res.bucketName,
-			renderId: res.renderId,
-			cloudWatchLogs: getCloudwatchMethodUrl({
-				functionName,
-				method: ServerlessRoutines.still,
-				region,
-				renderId: res.renderId,
-				rendererFunctionName: null,
-			}),
-			artifacts: res.receivedArtifacts,
-		};
-	} catch (err) {
-		if ((err as Error).stack?.includes('UnrecognizedClientException')) {
-			throw new Error(
-				'UnrecognizedClientException: The AWS credentials provided were probably mixed up. Learn how to fix this issue here: https://remotion.dev/docs/lambda/troubleshooting/unrecognizedclientexception',
-			);
-		}
-
-		throw err;
-	}
-};
-
-export const internalRenderStillOnLambda = wrapWithErrorHandling(
-	innerRenderStillOnLambda,
-);
-
-/*
- * @description Renders a still image inside a lambda function and writes it to the specified output location.
- * @see [Documentation](https://remotion.dev/docs/lambda/renderstillonlambda)
- */
-export const renderStillOnLambda = (
-	input: RenderStillOnLambdaInput & {
-		/**
-		 * @deprecated Renamed to `jpegQuality`
-		 */
-		quality?: never;
-		/**
-		 * @deprecated Renamed to `logLevel`
-		 */
-		dumpBrowserLogs?: boolean;
-	},
-) => {
-	return internalRenderStillOnLambda({
-		chromiumOptions: input.chromiumOptions ?? {},
-		composition: input.composition,
-		deleteAfter: input.deleteAfter ?? null,
-		downloadBehavior: input.downloadBehavior ?? {type: 'play-in-browser'},
-		envVariables: input.envVariables ?? {},
-		forceBucketName: input.forceBucketName ?? null,
-		forceHeight: input.forceHeight ?? null,
-		forceWidth: input.forceWidth ?? null,
-		frame: input.frame ?? 0,
-		functionName: input.functionName,
-		imageFormat: input.imageFormat,
-		indent: false,
-		inputProps: input.inputProps,
-		maxRetries: input.maxRetries ?? DEFAULT_MAX_RETRIES,
-		onInit: input.onInit ?? (() => undefined),
-		outName: input.outName ?? null,
-		privacy: input.privacy,
-		region: input.region,
-		serveUrl: input.serveUrl,
-		jpegQuality: input.jpegQuality ?? input.quality ?? 80,
-		logLevel: input.dumpBrowserLogs ? 'verbose' : (input.logLevel ?? 'info'),
-		offthreadVideoCacheSizeInBytes:
-			input.offthreadVideoCacheSizeInBytes ?? null,
-		scale: input.scale ?? 1,
-		timeoutInMilliseconds: input.timeoutInMilliseconds ?? 30000,
-		forcePathStyle: input.forcePathStyle ?? false,
-		apiKey: input.apiKey ?? null,
-		offthreadVideoThreads: input.offthreadVideoThreads ?? null,
-		storageClass: input.storageClass ?? null,
-		requestHandler: input.requestHandler ?? null,
-		mediaCacheSizeInBytes: input.mediaCacheSizeInBytes ?? null,
-	});
-};

package/src/runtime-preference.ts

@@ -1,7 +0,0 @@
-export const runtimePreferenceOptions = [
-	'default',
-	'apple-emojis',
-	'cjk',
-] as const;
-
-export type RuntimePreference = (typeof runtimePreferenceOptions)[number];

package/src/speculate-function-name.ts

@@ -1,60 +0,0 @@
-import {RENDER_FN_PREFIX} from './constants';
-import {LAMBDA_VERSION_STRING} from './lambda-version-string';
-
-export type SpeculateFunctionNameInput = {
-	memorySizeInMb: string | number;
-	diskSizeInMb: string | number;
-	timeoutInSeconds: string | number;
-};
-
-export const innerSpeculateFunctionName = ({
-	diskSizeInMb,
-	memorySizeInMb,
-	timeoutInSeconds,
-}: SpeculateFunctionNameInput) => {
-	// No validation here, used in find-function-name.ts
-	return [
-		`${RENDER_FN_PREFIX}${LAMBDA_VERSION_STRING}`,
-		`mem${memorySizeInMb}mb`,
-		`disk${diskSizeInMb}mb`,
-		`${timeoutInSeconds}sec`,
-	].join('-');
-};
-
-/*
- * @description Speculate the name of the Lambda function that will be created by `deployFunction()` or its CLI equivalent, based on the function configuration.
- * @see [Documentation](https://remotion.dev/docs/lambda/speculatefunctionname)
- */
-export const speculateFunctionName = ({
-	memorySizeInMb,
-	diskSizeInMb,
-	timeoutInSeconds,
-}: SpeculateFunctionNameInput) => {
-	const memorySize = Number(memorySizeInMb);
-	const diskSize = Number(diskSizeInMb);
-	const timeout = Number(timeoutInSeconds);
-
-	if (!Number.isInteger(memorySize) || memorySize <= 0) {
-		throw new Error(
-			`Memory size must be a positive integer. Received: ${memorySizeInMb}`,
-		);
-	}
-
-	if (!Number.isInteger(diskSize) || diskSize <= 0) {
-		throw new Error(
-			`Disk size must be a positive integer. Received: ${diskSizeInMb}`,
-		);
-	}
-
-	if (!Number.isInteger(timeout) || timeout <= 0) {
-		throw new Error(
-			`Timeout must be a positive integer. Received: ${timeoutInSeconds}`,
-		);
-	}
-
-	return innerSpeculateFunctionName({
-		diskSizeInMb,
-		memorySizeInMb,
-		timeoutInSeconds,
-	});
-};