@remotion/lambda 3.2.22 → 3.2.23

package/dist/api/bucket-exists.js

@@ -6,7 +6,7 @@ const aws_clients_1 = require("../shared/aws-clients");
 const bucketExistsInRegion = async ({ bucketName, region, expectedBucketOwner, }) => {
     var _a;
     try {
-        const bucket = await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.GetBucketLocationCommand({
+        const bucket = await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.GetBucketLocationCommand({
             Bucket: bucketName,
             ExpectedBucketOwner: expectedBucketOwner !== null && expectedBucketOwner !== void 0 ? expectedBucketOwner : undefined,
         }));

package/dist/api/clean-items.js

@@ -11,7 +11,7 @@ const cleanItems = async ({ bucket, onAfterItemDeleted, onBeforeItemDeleted, reg
             bucketName: bucket,
             itemName: object,
         });
-        await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.DeleteObjectCommand({
+        await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.DeleteObjectCommand({
             Bucket: bucket,
             Key: object,
         }));

package/dist/api/create-bucket.js

@@ -4,7 +4,7 @@ exports.createBucket = void 0;
 const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const createBucket = async ({ region, bucketName, }) => {
-    await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.CreateBucketCommand({
+    await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.CreateBucketCommand({
         Bucket: bucketName,
         ACL: 'public-read',
     }));

package/dist/api/delete-render.d.ts

@@ -0,0 +1,19 @@
+import type { AwsRegion } from '../client';
+import type { CustomCredentials } from '../shared/aws-clients';
+export declare type DeleteRenderInput = {
+    region: AwsRegion;
+    bucketName: string;
+    renderId: string;
+    customCredentials?: CustomCredentials;
+};
+/**
+ * @description Deletes a render artifact and it's metadata given it's renderId.
+ * @link https://remotion.dev/docs/lambda/deleterender
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ */
+export declare const deleteRender: (input: DeleteRenderInput) => Promise<{
+    freedBytes: number;
+}>;

package/dist/api/delete-render.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteRender = void 0;
+const defaults_1 = require("../defaults");
+const expected_out_name_1 = require("../functions/helpers/expected-out-name");
+const get_render_metadata_1 = require("../functions/helpers/get-render-metadata");
+const io_1 = require("../functions/helpers/io");
+const get_account_id_1 = require("../shared/get-account-id");
+const clean_items_1 = require("./clean-items");
+/**
+ * @description Deletes a render artifact and it's metadata given it's renderId.
+ * @link https://remotion.dev/docs/lambda/deleterender
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ */
+const deleteRender = async (input) => {
+    var _a;
+    const expectedBucketOwner = await (0, get_account_id_1.getAccountId)({
+        region: input.region,
+    });
+    const renderMetadata = await (0, get_render_metadata_1.getRenderMetadata)({
+        bucketName: input.bucketName,
+        expectedBucketOwner,
+        region: input.region,
+        renderId: input.renderId,
+    });
+    const { key, renderBucketName, customCredentials } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName, (_a = input.customCredentials) !== null && _a !== void 0 ? _a : null);
+    await (0, io_1.lambdaDeleteFile)({
+        bucketName: renderBucketName,
+        customCredentials,
+        key,
+        region: input.region,
+    });
+    let files = await (0, io_1.lambdaLs)({
+        bucketName: input.bucketName,
+        prefix: (0, defaults_1.rendersPrefix)(input.renderId),
+        region: input.region,
+        expectedBucketOwner,
+    });
+    let totalSize = 0;
+    while (files.length > 0) {
+        totalSize += files.reduce((a, b) => {
+            var _a;
+            return a + ((_a = b.Size) !== null && _a !== void 0 ? _a : 0);
+        }, 0);
+        await (0, clean_items_1.cleanItems)({
+            list: files.map((f) => f.Key),
+            bucket: input.bucketName,
+            onAfterItemDeleted: () => undefined,
+            onBeforeItemDeleted: () => undefined,
+            region: input.region,
+        });
+        files = await (0, io_1.lambdaLs)({
+            bucketName: input.bucketName,
+            prefix: (0, defaults_1.rendersPrefix)(input.renderId),
+            region: input.region,
+            expectedBucketOwner,
+        });
+    }
+    return {
+        freedBytes: totalSize,
+    };
+};
+exports.deleteRender = deleteRender;

package/dist/api/delete-site.js

@@ -23,11 +23,6 @@ const deleteSite = async ({ bucketName, siteName, region, onAfterItemDeleted, })
         region,
         expectedBucketOwner: accountId,
     });
-    if (files.length === 0) {
-        return {
-            totalSizeInBytes: 0,
-        };
-    }
     let totalSize = 0;
     while (files.length > 0) {
         totalSize += files.reduce((a, b) => {

package/dist/api/download-media.d.ts

@@ -1,16 +1,29 @@
 import type { LambdaReadFileProgress } from '../functions/helpers/read-with-progress';
 import type { AwsRegion } from '../pricing/aws-regions';
+import type { CustomCredentials } from '../shared/aws-clients';
 export declare type DownloadMediaInput = {
     region: AwsRegion;
     bucketName: string;
     renderId: string;
     outPath: string;
     onProgress?: LambdaReadFileProgress;
+    customCredentials?: CustomCredentials;
 };
 export declare type DownloadMediaOutput = {
     outputPath: string;
     sizeInBytes: number;
 };
+/**
+ * @description Triggers a render on a lambda given a composition and a lambda function.
+ * @link https://remotion.dev/docs/lambda/downloadmedia
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render.
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.outPath Where to save the media.
+ * @param params.onProgress Progress callback function - see docs for details.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
+ */
 export declare const downloadMedia: (input: DownloadMediaInput) => Promise<DownloadMediaOutput>;
 /**
  * @deprecated Renamed to downloadMedia()

package/dist/api/download-media.js

@@ -10,8 +10,19 @@ const expected_out_name_1 = require("../functions/helpers/expected-out-name");
 const get_render_metadata_1 = require("../functions/helpers/get-render-metadata");
 const read_with_progress_1 = require("../functions/helpers/read-with-progress");
 const get_account_id_1 = require("../shared/get-account-id");
+/**
+ * @description Triggers a render on a lambda given a composition and a lambda function.
+ * @link https://remotion.dev/docs/lambda/downloadmedia
+ * @param params.region The AWS region in which the media resides.
+ * @param params.bucketName The `bucketName` that was specified during the render.
+ * @param params.renderId The `renderId` that was obtained after triggering the render.
+ * @param params.outPath Where to save the media.
+ * @param params.onProgress Progress callback function - see docs for details.
+ * @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
+ * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
+ */
 const downloadMedia = async (input) => {
-    var _a;
+    var _a, _b;
     const expectedBucketOwner = await (0, get_account_id_1.getAccountId)({
         region: input.region,
     });
@@ -23,14 +34,15 @@ const downloadMedia = async (input) => {
     });
     const outputPath = path_1.default.resolve(process.cwd(), input.outPath);
     renderer_1.RenderInternals.ensureOutputDirectory(outputPath);
-    const { key, renderBucketName } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName);
+    const { key, renderBucketName, customCredentials } = (0, expected_out_name_1.getExpectedOutName)(renderMetadata, input.bucketName, (_a = input.customCredentials) !== null && _a !== void 0 ? _a : null);
     const { sizeInBytes } = await (0, read_with_progress_1.lambdaDownloadFileWithProgress)({
         bucketName: renderBucketName,
         expectedBucketOwner,
         key,
         region: input.region,
-        onProgress: (_a = input.onProgress) !== null && _a !== void 0 ? _a : (() => undefined),
+        onProgress: (_b = input.onProgress) !== null && _b !== void 0 ? _b : (() => undefined),
         outputPath,
+        customCredentials,
     });
     return {
         outputPath,

package/dist/api/enable-s3-website.js

@@ -4,7 +4,7 @@ exports.enableS3Website = void 0;
 const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const enableS3Website = async ({ region, bucketName, }) => {
-    await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.PutBucketWebsiteCommand({
+    await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.PutBucketWebsiteCommand({
         Bucket: bucketName,
         WebsiteConfiguration: {
             IndexDocument: {

package/dist/api/get-aws-client.d.ts

@@ -4,10 +4,11 @@ import * as LambdaSDK from '@aws-sdk/client-lambda';
 import * as S3SDK from '@aws-sdk/client-s3';
 import * as ServiceQuotasSDK from '@aws-sdk/client-service-quotas';
 import type { AwsRegion } from '../client';
-import type { ServiceMapping } from '../shared/aws-clients';
+import type { CustomCredentials, ServiceMapping } from '../shared/aws-clients';
 export declare type GetAwsClientInput<T extends keyof ServiceMapping> = {
     region: AwsRegion;
     service: T;
+    customCredentials?: CustomCredentials | null;
 };
 declare type SdkMapping = {
     s3: typeof S3SDK;
@@ -25,7 +26,8 @@ export declare type GetAwsClientOutput<T extends keyof ServiceMapping> = {
  * @link https://remotion.dev/docs/lambda/getawsclient
  * @param {AwsRegion} params.region The region in which the S3 bucket resides in.
  * @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
+ * @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
  * @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
  */
-export declare const getAwsClient: <T extends keyof ServiceMapping>({ region, service, }: GetAwsClientInput<T>) => GetAwsClientOutput<T>;
+export declare const getAwsClient: <T extends keyof ServiceMapping>({ region, service, customCredentials, }: GetAwsClientInput<T>) => GetAwsClientOutput<T>;
 export {};

package/dist/api/get-aws-client.js

@@ -35,11 +35,16 @@ const aws_clients_1 = require("../shared/aws-clients");
  * @link https://remotion.dev/docs/lambda/getawsclient
  * @param {AwsRegion} params.region The region in which the S3 bucket resides in.
  * @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
+ * @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
  * @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
  */
-const getAwsClient = ({ region, service, }) => {
+const getAwsClient = ({ region, service, customCredentials, }) => {
     return {
-        client: (0, aws_clients_1.getServiceClient)(region, service),
+        client: (0, aws_clients_1.getServiceClient)({
+            region,
+            service,
+            customCredentials: customCredentials !== null && customCredentials !== void 0 ? customCredentials : null,
+        }),
         sdk: {
             lambda: LambdaSDK,
             cloudwatch: CloudWatchSDK,

package/dist/api/get-buckets.js

@@ -5,13 +5,13 @@ const client_s3_1 = require("@aws-sdk/client-s3");
 const aws_clients_1 = require("../shared/aws-clients");
 const constants_1 = require("../shared/constants");
 const getRemotionS3Buckets = async (region) => {
-    const { Buckets } = await (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.ListBucketsCommand({}));
+    const { Buckets } = await (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.ListBucketsCommand({}));
     if (!Buckets) {
         return { remotionBuckets: [] };
     }
     const remotionBuckets = Buckets.filter((b) => { var _a; return (_a = b.Name) === null || _a === void 0 ? void 0 : _a.startsWith(constants_1.REMOTION_BUCKET_PREFIX); });
     const locations = await Promise.all(remotionBuckets.map((bucket) => {
-        return (0, aws_clients_1.getS3Client)(region).send(new client_s3_1.GetBucketLocationCommand({
+        return (0, aws_clients_1.getS3Client)(region, null).send(new client_s3_1.GetBucketLocationCommand({
             Bucket: bucket.Name,
         }));
     }));

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

@@ -1,10 +1,12 @@
 import type { AwsRegion } from '../pricing/aws-regions';
+import type { CustomCredentials } from '../shared/aws-clients';
 import type { RenderProgress } from '../shared/constants';
 export declare type GetRenderInput = {
     functionName: string;
     bucketName: string;
     renderId: string;
     region: AwsRegion;
+    s3OutputProvider?: CustomCredentials;
 };
 /**
  * @description Gets the current status of a render originally triggered via renderMediaOnLambda().
@@ -13,6 +15,7 @@ export declare type GetRenderInput = {
  * @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()`.
  * @param {AwsRegion} params.region The region in which the render was triggered.
+ * @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, }: GetRenderInput) => Promise<RenderProgress>;
+export declare const getRenderProgress: ({ functionName, bucketName, renderId, region, s3OutputProvider, }: GetRenderInput) => Promise<RenderProgress>;

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

@@ -11,9 +11,10 @@ const constants_1 = require("../shared/constants");
  * @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()`.
  * @param {AwsRegion} params.region The region in which the render was triggered.
+ * @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, }) => {
+const getRenderProgress = async ({ functionName, bucketName, renderId, region, s3OutputProvider, }) => {
     const result = await (0, call_lambda_1.callLambda)({
         functionName,
         type: constants_1.LambdaRoutines.status,
@@ -21,6 +22,7 @@ const getRenderProgress = async ({ functionName, bucketName, renderId, region, }
             bucketName,
             renderId,
             version: version_1.VERSION,
+            s3OutputProvider,
         },
         region,
     });

package/dist/api/presign-url.js

@@ -19,7 +19,7 @@ const validate_presign_expiration_1 = require("../shared/validate-presign-expira
 const presignUrl = async ({ region, bucketName, objectKey, checkIfObjectExists = false, expiresInSeconds, }) => {
     (0, validate_bucketname_1.validateBucketName)(bucketName, { mustStartWithRemotion: false });
     (0, validate_presign_expiration_1.validatePresignExpiration)(expiresInSeconds);
-    const s3Client = (0, aws_clients_1.getS3Client)(region);
+    const s3Client = (0, aws_clients_1.getS3Client)(region, null);
     if (checkIfObjectExists) {
         try {
             await s3Client.send(new client_s3_1.HeadObjectCommand({

package/dist/api/render-media-on-lambda.d.ts

@@ -43,14 +43,14 @@ export declare type RenderMediaOnLambdaOutput = {
  * @param params.serveUrl The URL of the deployed project
  * @param params.composition The ID of the composition which should be rendered.
  * @param params.inputProps The input props that should be passed to the composition.
- * @param params.codec The video codec which should be used for encoding.
+ * @param params.codec The media codec which should be used for encoding.
  * @param params.imageFormat In which image format the frames should be rendered.
  * @param params.crf The constant rate factor to be used during encoding.
  * @param params.envVariables Object containing environment variables to be inserted into the video environment
  * @param params.proResProfile The ProRes profile if rendering a ProRes video
  * @param params.quality JPEG quality if JPEG was selected as the image format.
- * @param params.region The AWS region in which the video should be rendered.
- * @param params.maxRetries How often rendering a chunk may fail before the video render gets aborted.
+ * @param params.region The AWS region in which the media should be rendered.
+ * @param params.maxRetries How often rendering a chunk may fail before the media render gets aborted.
  * @param params.logLevel Level of logging that Lambda function should perform. Default "info".
  * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
  */

package/dist/api/render-media-on-lambda.js

@@ -17,14 +17,14 @@ const validate_serveurl_1 = require("../shared/validate-serveurl");
  * @param params.serveUrl The URL of the deployed project
  * @param params.composition The ID of the composition which should be rendered.
  * @param params.inputProps The input props that should be passed to the composition.
- * @param params.codec The video codec which should be used for encoding.
+ * @param params.codec The media codec which should be used for encoding.
  * @param params.imageFormat In which image format the frames should be rendered.
  * @param params.crf The constant rate factor to be used during encoding.
  * @param params.envVariables Object containing environment variables to be inserted into the video environment
  * @param params.proResProfile The ProRes profile if rendering a ProRes video
  * @param params.quality JPEG quality if JPEG was selected as the image format.
- * @param params.region The AWS region in which the video should be rendered.
- * @param params.maxRetries How often rendering a chunk may fail before the video render gets aborted.
+ * @param params.region The AWS region in which the media should be rendered.
+ * @param params.maxRetries How often rendering a chunk may fail before the media render gets aborted.
  * @param params.logLevel Level of logging that Lambda function should perform. Default "info".
  * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
  */

package/dist/api/upload-dir.js

@@ -37,7 +37,7 @@ const uploadDir = async ({ bucket, region, dir, onProgress, folder, privacy, })
     for (const file of files) {
         progresses[file.name] = 0;
     }
-    const client = (0, aws_clients_1.getS3Client)(region);
+    const client = (0, aws_clients_1.getS3Client)(region, null);
     const uploads = files.map(async (filePath) => {
         const Key = (0, make_s3_key_1.makeS3Key)(folder, dir, filePath.name);
         const Body = (0, fs_1.createReadStream)(filePath.name);