🎥 Make videos programmatically with React
import {GetObjectCommand, HeadObjectCommand} from '@aws-sdk/client-s3';
import {getSignedUrl} from '@aws-sdk/s3-request-presigner';
import {REMOTION_BUCKET_PREFIX} from './constants';
import {getS3Client} from './get-s3-client';
import type {AwsRegion} from './regions';
import type {RequestHandler} from './types';
import {validateBucketName} from './validate-bucket-name';
import {validatePresignExpiration} from './validate-presign-expiration';
type MandatoryParameters = {
region: AwsRegion;
bucketName: string;
objectKey: string;
expiresInSeconds: number;
};
type OptionalParameters<CheckIfObjectExists extends boolean> = {
checkIfObjectExists: CheckIfObjectExists;
forcePathStyle: boolean;
};
export type PresignUrlInput<CheckIfObjectExists extends boolean = boolean> =
MandatoryParameters &
Partial<OptionalParameters<CheckIfObjectExists>> & {
requestHandler?: RequestHandler;
};
type PresignUrlInputInternal<CheckIfObjectExists extends boolean> =
MandatoryParameters &
OptionalParameters<CheckIfObjectExists> & {
requestHandler?: RequestHandler;
};
const internalPresignUrl = async <CheckIfObjectExists extends boolean = false>({
region,
bucketName,
objectKey,
checkIfObjectExists,
expiresInSeconds,
forcePathStyle,
requestHandler,
}: PresignUrlInputInternal<CheckIfObjectExists>): Promise<
CheckIfObjectExists extends true ? string | null : string
> => {
validateBucketName({
bucketName,
bucketNamePrefix: REMOTION_BUCKET_PREFIX,
options: {mustStartWithRemotion: false},
});
validatePresignExpiration(expiresInSeconds);
const s3Client = getS3Client({
region,
customCredentials: null,
forcePathStyle,
requestHandler: requestHandler ?? null,
});
if (checkIfObjectExists === true) {
try {
await s3Client.send(
new HeadObjectCommand({
Bucket: bucketName,
Key: objectKey,
}),
);
} catch (err) {
if ((err as {name: string}).name === 'NotFound') {
return null as unknown as string;
}
if (
(err as Error).message === 'UnknownError' ||
(err as {$metadata: {httpStatusCode: number}}).$metadata
.httpStatusCode === 403
) {
throw new Error(
`Unable to access item "${objectKey}" from bucket "${bucketName}". You must have permission for both "s3:GetObject" and "s3:ListBucket" actions.`,
);
}
throw err;
}
}
const objCommand = new GetObjectCommand({
Bucket: bucketName,
Key: objectKey,
});
const publicUrl = await getSignedUrl(s3Client, objCommand, {
expiresIn: expiresInSeconds,
});
return publicUrl;
};
/*
* @description Takes a private S3 object and turns it into a public URL by signing it with your AWS credentials.
* @see [Documentation](https://remotion.dev/docs/lambda/presignurl)
*/
export const presignUrl = <CheckIfObjectExists extends boolean = false>({
region,
bucketName,
objectKey,
checkIfObjectExists,
expiresInSeconds,
forcePathStyle,
requestHandler,
}: PresignUrlInput<CheckIfObjectExists>): Promise<
CheckIfObjectExists extends true ? string | null : string
> => {
return internalPresignUrl({
region,
bucketName,
objectKey,
checkIfObjectExists: checkIfObjectExists ?? false,
expiresInSeconds,
forcePathStyle: forcePathStyle ?? false,
requestHandler,
});
};