@remotion/lambda 3.2.29 → 3.2.30

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

@@ -31,6 +31,10 @@ export declare type RenderMediaOnLambdaInput = {
     downloadBehavior?: DownloadBehavior | null;
     muted?: boolean;
     overwrite?: boolean;
+    webhook?: {
+        url: string;
+        secret: string | null;
+    };
 };
 export declare type RenderMediaOnLambdaOutput = {
     renderId: string;
@@ -53,10 +57,11 @@ export declare type RenderMediaOnLambdaOutput = {
  * @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. Default "1"
  * @param params.logLevel Level of logging that Lambda function should perform. Default "info".
+ * @param params.webhook Configuration for webhook called upon completion or timeout of the render.
  * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
  */
-export declare const renderMediaOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
+export declare const renderMediaOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, webhook, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
 /**
  * @deprecated Renamed to renderMediaOnLambda()
  */
-export declare const renderVideoOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;
+export declare const renderVideoOnLambda: ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, webhook, }: RenderMediaOnLambdaInput) => Promise<RenderMediaOnLambdaOutput>;

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

@@ -26,9 +26,10 @@ const validate_serveurl_1 = require("../shared/validate-serveurl");
  * @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. Default "1"
  * @param params.logLevel Level of logging that Lambda function should perform. Default "info".
+ * @param params.webhook Configuration for webhook called upon completion or timeout of the render.
  * @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
  */
-const renderMediaOnLambda = async ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, }) => {
+const renderMediaOnLambda = async ({ functionName, serveUrl, inputProps, codec, imageFormat, crf, envVariables, pixelFormat, proResProfile, quality, region, maxRetries, composition, framesPerLambda, privacy, logLevel, frameRange, outName, timeoutInMilliseconds, chromiumOptions, scale, numberOfGifLoops, everyNthFrame, concurrencyPerLambda, downloadBehavior, muted, overwrite, webhook, }) => {
     var _a;
     const actualCodec = (0, validate_lambda_codec_1.validateLambdaCodec)(codec);
     (0, validate_serveurl_1.validateServeUrl)(serveUrl);
@@ -69,6 +70,7 @@ const renderMediaOnLambda = async ({ functionName, serveUrl, inputProps, codec,
                 muted: muted !== null && muted !== void 0 ? muted : false,
                 version: version_1.VERSION,
                 overwrite: overwrite !== null && overwrite !== void 0 ? overwrite : false,
+                webhook: webhook !== null && webhook !== void 0 ? webhook : null,
             },
             region,
         });

package/dist/api/validate-webhook-signature.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @description Throws if the signature of the finish webhook is missing or inauthentic
+ * @link https://remotion.dev/docs/lambda/validate-webhook-signature
+ * @param params.secret The secret used for signing the webhook
+ * @param params.body The body that was received by the endpoint
+ * @param params.signatureHeader The `X-Remotion-Signature` header
+ * @returns {void}
+ */
+export declare const validateWebhookSignature: ({ secret, body, signatureHeader, }: {
+    secret: string;
+    body: string;
+    signatureHeader: string;
+}) => void;

package/dist/api/validate-webhook-signature.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateWebhookSignature = void 0;
+/**
+ * @description Throws if the signature of the finish webhook is missing or inauthentic
+ * @link https://remotion.dev/docs/lambda/validate-webhook-signature
+ * @param params.secret The secret used for signing the webhook
+ * @param params.body The body that was received by the endpoint
+ * @param params.signatureHeader The `X-Remotion-Signature` header
+ * @returns {void}
+ */
+const validateWebhookSignature = ({ secret, body, signatureHeader, }) => {
+    if (!secret) {
+        throw new TypeError("No 'secret' was provided to validateWebhookSignature().");
+    }
+    if (!body) {
+        throw new TypeError("No 'body' was provided to validateWebhookSignature().");
+    }
+    if (typeof require === 'undefined') {
+        throw new Error('validateWebhookSignature can only be called from Node.JS');
+    }
+    const Crypto = require('crypto');
+    const hmac = Crypto.createHmac('sha512', secret);
+    const signature = `sha512=${hmac.update(JSON.stringify(body)).digest('hex')}`;
+    if (!signatureHeader || signatureHeader === 'NO_SECRET_PROVIDED') {
+        throw new Error('No webhook signature was provided');
+    }
+    if (signatureHeader !== signature) {
+        throw new Error('Signatures do not match');
+    }
+};
+exports.validateWebhookSignature = validateWebhookSignature;

package/dist/cli/args.d.ts

@@ -24,6 +24,8 @@ declare type LambdaCommandLineOptions = {
     ['architecture']: LambdaArchitecture;
     ['custom-role-arn']: string | undefined;
     privacy: Privacy;
+    webhook: string | undefined;
+    ['webhook-secret']: string | undefined;
 };
 export declare const parsedLambdaCli: LambdaCommandLineOptions & minimist.ParsedArgs;
 export declare const forceFlagProvided: boolean;

package/dist/cli/commands/render/render.js

@@ -19,7 +19,7 @@ const log_1 = require("../../log");
 const progress_1 = require("./progress");
 exports.RENDER_COMMAND = 'render';
 const renderCommand = async (args) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const serveUrl = args[0];
     if (!serveUrl) {
         log_1.Log.error('No serve URL passed.');
@@ -82,6 +82,12 @@ const renderCommand = async (args) => {
         concurrencyPerLambda: args_1.parsedLambdaCli['concurrency-per-lambda'],
         muted,
         overwrite,
+        webhook: args_1.parsedLambdaCli.webhook
+            ? {
+                url: args_1.parsedLambdaCli.webhook,
+                secret: (_e = args_1.parsedLambdaCli['webhook-secret']) !== null && _e !== void 0 ? _e : null,
+            }
+            : undefined,
     });
     const totalSteps = downloadName ? 5 : 4;
     const progressBar = cli_1.CliInternals.createOverwriteableCliOutput(cli_1.CliInternals.quietFlagProvided());

package/dist/cli/helpers/determine-image-format.d.ts

@@ -0,0 +1,10 @@
+import type { ImageFormat, StillImageFormat } from '@remotion/renderer';
+export declare const getImageFormat: ({ downloadName, outName, configImageFormat, cliFlag, }: {
+    downloadName: string | null;
+    outName: string | null;
+    configImageFormat: ImageFormat | null;
+    cliFlag: ImageFormat | null;
+}) => {
+    format: StillImageFormat;
+    source: string;
+};

package/dist/cli/helpers/determine-image-format.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageFormat = void 0;
+const deriveExtensionFromFilename = (filename) => {
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.png')) {
+        return 'png';
+    }
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpg')) {
+        return 'jpeg';
+    }
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpeg')) {
+        return 'jpeg';
+    }
+    return null;
+};
+const getImageFormat = ({ downloadName, outName, configImageFormat, cliFlag, }) => {
+    const outNameExtension = deriveExtensionFromFilename(outName);
+    const downloadNameExtension = deriveExtensionFromFilename(downloadName);
+    if (outNameExtension &&
+        downloadNameExtension &&
+        outNameExtension !== downloadNameExtension) {
+        throw new TypeError(`Image format mismatch: ${outName} was given as the S3 output name and ${downloadName} was given as the download name, but the extensions don't match.`);
+    }
+    if (downloadNameExtension) {
+        if (cliFlag && downloadNameExtension !== cliFlag) {
+            throw new TypeError(`Image format mismatch: ${downloadName} was given as the download name, but --image-format=${cliFlag} was passed. The image formats must match.`);
+        }
+        return { format: downloadNameExtension, source: 'Download name extension' };
+    }
+    if (outNameExtension) {
+        if (cliFlag && outNameExtension !== cliFlag) {
+            throw new TypeError(`Image format mismatch: ${outName} was given as the S3 out name, but --image-format=${cliFlag} was passed. The image formats must match.`);
+        }
+        return { format: outNameExtension, source: 'Out name extension' };
+    }
+    if (cliFlag === 'none') {
+        throw new TypeError('The --image-format flag must not be "none" for stills.');
+    }
+    if (cliFlag !== null) {
+        return { format: cliFlag, source: '--image-format flag' };
+    }
+    if (configImageFormat !== null && configImageFormat !== 'none') {
+        return { format: configImageFormat, source: 'Config file' };
+    }
+    return { format: 'png', source: 'Default' };
+};
+exports.getImageFormat = getImageFormat;

package/dist/cli/helpers/webhook-types.d.ts

@@ -0,0 +1,6 @@
+export declare type WebhookPayload = {
+    type: 'success' | 'error' | 'timeout';
+    renderId: string;
+    bucketName: string;
+    expectedBucketOwner: string;
+};

package/dist/cli/helpers/webhook-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client.d.ts

@@ -2,7 +2,9 @@ import { getFunctions } from './api/get-functions';
 import { getRenderProgress } from './api/get-render-progress';
 import { renderMediaOnLambda, renderVideoOnLambda } from './api/render-media-on-lambda';
 import { renderStillOnLambda } from './api/render-still-on-lambda';
+import { validateWebhookSignature } from './api/validate-webhook-signature';
 import type { AwsRegion } from './pricing/aws-regions';
 import type { RenderProgress } from './shared/constants';
-export { renderVideoOnLambda, renderMediaOnLambda, renderStillOnLambda, getRenderProgress, getFunctions, };
-export type { AwsRegion, RenderProgress };
+import type { WebhookPayload } from './shared/invoke-webhook';
+export { renderVideoOnLambda, renderMediaOnLambda, renderStillOnLambda, getRenderProgress, getFunctions, validateWebhookSignature, };
+export type { AwsRegion, RenderProgress, WebhookPayload };

package/dist/client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFunctions = exports.getRenderProgress = exports.renderStillOnLambda = exports.renderMediaOnLambda = exports.renderVideoOnLambda = void 0;
+exports.validateWebhookSignature = exports.getFunctions = exports.getRenderProgress = exports.renderStillOnLambda = exports.renderMediaOnLambda = exports.renderVideoOnLambda = void 0;
 const get_functions_1 = require("./api/get-functions");
 Object.defineProperty(exports, "getFunctions", { enumerable: true, get: function () { return get_functions_1.getFunctions; } });
 const get_render_progress_1 = require("./api/get-render-progress");
@@ -10,3 +10,5 @@ Object.defineProperty(exports, "renderMediaOnLambda", { enumerable: true, get: f
 Object.defineProperty(exports, "renderVideoOnLambda", { enumerable: true, get: function () { return render_media_on_lambda_1.renderVideoOnLambda; } });
 const render_still_on_lambda_1 = require("./api/render-still-on-lambda");
 Object.defineProperty(exports, "renderStillOnLambda", { enumerable: true, get: function () { return render_still_on_lambda_1.renderStillOnLambda; } });
+const validate_webhook_signature_1 = require("./api/validate-webhook-signature");
+Object.defineProperty(exports, "validateWebhookSignature", { enumerable: true, get: function () { return validate_webhook_signature_1.validateWebhookSignature; } });

package/dist/functions/chunk-optimization/plan-frame-ranges.d.ts

@@ -6,9 +6,6 @@ export declare const planFrameRanges: ({ framesPerLambda, optimization, shouldUs
     frameRange: [number, number];
     everyNthFrame: number;
 }) => {
-    chunks: [
-        number,
-        number
-    ][];
+    chunks: [number, number][];
     didUseOptimization: boolean;
 };

package/dist/functions/helpers/write-lambda-error.d.ts

@@ -1,6 +1,6 @@
 import type { FileNameAndSize } from './get-files-in-folder';
 export declare type LambdaErrorInfo = {
-    type: 'renderer' | 'browser' | 'stitcher';
+    type: 'renderer' | 'browser' | 'stitcher' | 'webhook';
     message: string;
     name: string;
     stack: string;

package/dist/functions/launch.js

@@ -12,6 +12,7 @@ const version_1 = require("remotion/version");
 const aws_clients_1 = require("../shared/aws-clients");
 const constants_1 = require("../shared/constants");
 const docs_url_1 = require("../shared/docs-url");
+const invoke_webhook_1 = require("../shared/invoke-webhook");
 const make_s3_url_1 = require("../shared/make-s3-url");
 const validate_frames_per_lambda_1 = require("../shared/validate-frames-per-lambda");
 const validate_outname_1 = require("../shared/validate-outname");
@@ -68,6 +69,49 @@ const innerLaunchHandler = async (params, options) => {
         throw new Error('Expected launch type');
     }
     const startedDate = Date.now();
+    let webhookInvoked = false;
+    const webhookDueToTimeout = setTimeout(async () => {
+        if (params.webhook && !webhookInvoked) {
+            try {
+                await (0, invoke_webhook_1.invokeWebhook)({
+                    url: params.webhook.url,
+                    secret: params.webhook.secret,
+                    payload: {
+                        type: 'timeout',
+                        renderId: params.renderId,
+                        expectedBucketOwner: options.expectedBucketOwner,
+                        bucketName: params.bucketName,
+                    },
+                });
+                webhookInvoked = true;
+            }
+            catch (err) {
+                if (process.env.NODE_ENV === 'test') {
+                    throw err;
+                }
+                await (0, write_lambda_error_1.writeLambdaError)({
+                    bucketName: params.bucketName,
+                    errorInfo: {
+                        type: 'webhook',
+                        message: err.message,
+                        name: err.name,
+                        stack: err.stack,
+                        tmpDir: null,
+                        frame: 0,
+                        chunk: 0,
+                        isFatal: false,
+                        attempt: 1,
+                        willRetry: false,
+                        totalAttempts: 1,
+                    },
+                    renderId: params.renderId,
+                    expectedBucketOwner: options.expectedBucketOwner,
+                });
+                console.log('Failed to invoke webhook:');
+                console.log(err);
+            }
+        }
+    }, Math.max(params.timeoutInMilliseconds - 1000, 1000));
     const [browserInstance, optimization] = await Promise.all([
         (0, get_browser_instance_1.getBrowserInstance)(renderer_1.RenderInternals.isEqualOrBelowLogLevel(params.logLevel, 'verbose'), params.chromiumOptions),
         (0, s3_optimization_file_1.getOptimization)({
@@ -378,6 +422,7 @@ const innerLaunchHandler = async (params, options) => {
         contents,
         jobs,
     });
+    const outputUrl = (0, get_output_url_from_metadata_1.getOutputUrlFromMetadata)(renderMetadata, params.bucketName, customCredentials);
     const postRenderData = (0, create_post_render_data_1.createPostRenderData)({
         expectedBucketOwner: options.expectedBucketOwner,
         region: (0, get_current_region_1.getCurrentRegionInFunction)(),
@@ -391,7 +436,7 @@ const innerLaunchHandler = async (params, options) => {
         outputFile: {
             lastModified: Date.now(),
             size: outputSize.size,
-            url: (0, get_output_url_from_metadata_1.getOutputUrlFromMetadata)(renderMetadata, params.bucketName, customCredentials),
+            url: outputUrl,
         },
     });
     await finalEncodingProgressProm;
@@ -409,8 +454,54 @@ const innerLaunchHandler = async (params, options) => {
         customCredentials: null,
     });
     await Promise.all([cleanupChunksProm, fs_1.default.promises.rm(outfile)]);
+    clearTimeout(webhookDueToTimeout);
+    if (params.webhook && !webhookInvoked) {
+        try {
+            await (0, invoke_webhook_1.invokeWebhook)({
+                url: params.webhook.url,
+                secret: params.webhook.secret,
+                payload: {
+                    type: 'success',
+                    renderId: params.renderId,
+                    expectedBucketOwner: options.expectedBucketOwner,
+                    bucketName: params.bucketName,
+                    outputUrl,
+                    lambdaErrors: postRenderData.errors,
+                    outputFile: postRenderData.outputFile,
+                    timeToFinish: postRenderData.timeToFinish,
+                },
+            });
+            webhookInvoked = true;
+        }
+        catch (err) {
+            if (process.env.NODE_ENV === 'test') {
+                throw err;
+            }
+            await (0, write_lambda_error_1.writeLambdaError)({
+                bucketName: params.bucketName,
+                errorInfo: {
+                    type: 'webhook',
+                    message: err.message,
+                    name: err.name,
+                    stack: err.stack,
+                    tmpDir: null,
+                    frame: 0,
+                    chunk: 0,
+                    isFatal: false,
+                    attempt: 1,
+                    willRetry: false,
+                    totalAttempts: 1,
+                },
+                renderId: params.renderId,
+                expectedBucketOwner: options.expectedBucketOwner,
+            });
+            console.log('Failed to invoke webhook:');
+            console.log(err);
+        }
+    }
 };
 const launchHandler = async (params, options) => {
+    var _a, _b;
     if (params.type !== constants_1.LambdaRoutines.launch) {
         throw new Error('Expected launch type');
     }
@@ -440,6 +531,50 @@ const launchHandler = async (params, options) => {
             expectedBucketOwner: options.expectedBucketOwner,
             renderId: params.renderId,
         });
+        if ((_a = params.webhook) === null || _a === void 0 ? void 0 : _a.url) {
+            try {
+                await (0, invoke_webhook_1.invokeWebhook)({
+                    url: params.webhook.url,
+                    secret: (_b = params.webhook.secret) !== null && _b !== void 0 ? _b : null,
+                    payload: {
+                        type: 'error',
+                        renderId: params.renderId,
+                        expectedBucketOwner: options.expectedBucketOwner,
+                        bucketName: params.bucketName,
+                        errors: [err].map((e) => ({
+                            message: e.message,
+                            name: e.name,
+                            stack: e.stack,
+                        })),
+                    },
+                });
+            }
+            catch (error) {
+                if (process.env.NODE_ENV === 'test') {
+                    throw error;
+                }
+                await (0, write_lambda_error_1.writeLambdaError)({
+                    bucketName: params.bucketName,
+                    errorInfo: {
+                        type: 'webhook',
+                        message: err.message,
+                        name: err.name,
+                        stack: err.stack,
+                        tmpDir: null,
+                        frame: 0,
+                        chunk: 0,
+                        isFatal: false,
+                        attempt: 1,
+                        willRetry: false,
+                        totalAttempts: 1,
+                    },
+                    renderId: params.renderId,
+                    expectedBucketOwner: options.expectedBucketOwner,
+                });
+                console.log('Failed to invoke webhook:');
+                console.log(error);
+            }
+        }
     }
 };
 exports.launchHandler = launchHandler;

package/dist/functions/renderer.js

@@ -136,6 +136,13 @@ const renderHandler = async (params, options, logs) => {
             downloadMap,
             muted: params.muted,
             enforceAudioTrack: true,
+            onSlowestFrames: (slowestFrames) => {
+                console.log();
+                console.log(`Slowest frames:`);
+                slowestFrames.forEach(({ frame, time }) => {
+                    console.log(`Frame ${frame} (${time.toFixed(3)}ms)`);
+                });
+            },
         })
             .then(() => resolve())
             .catch((err) => reject(err));

package/dist/functions/start.js

@@ -63,6 +63,7 @@ const startHandler = async (params, options) => {
         downloadBehavior: params.downloadBehavior,
         muted: params.muted,
         overwrite: params.overwrite,
+        webhook: params.webhook,
     };
     await (0, aws_clients_1.getLambdaClient)((0, get_current_region_1.getCurrentRegionInFunction)()).send(new client_lambda_1.InvokeCommand({
         FunctionName: process.env.AWS_LAMBDA_FUNCTION_NAME,

package/dist/index.d.ts

@@ -32,11 +32,13 @@ import type { RenderMediaOnLambdaInput, RenderMediaOnLambdaOutput } from './api/
 import { renderMediaOnLambda, renderVideoOnLambda } from './api/render-media-on-lambda';
 import type { RenderStillOnLambdaInput, RenderStillOnLambdaOutput } from './api/render-still-on-lambda';
 import { renderStillOnLambda } from './api/render-still-on-lambda';
+import { validateWebhookSignature } from './api/validate-webhook-signature';
 import type { LambdaLSInput, LambdaLsReturnType } from './functions/helpers/io';
 import { LambdaInternals } from './internals';
 import type { AwsRegion } from './pricing/aws-regions';
 import type { CustomCredentials } from './shared/aws-clients';
 import type { RenderProgress } from './shared/constants';
+import type { WebhookPayload } from './shared/invoke-webhook';
 import type { LambdaArchitecture } from './shared/validate-architecture';
-export { deleteSite, deployFunction, deploySite, downloadMedia, downloadVideo, getFunctions, getUserPolicy, getRolePolicy, getSites, getOrCreateBucket, getRenderProgress, renderVideoOnLambda, renderMediaOnLambda, simulatePermissions, deleteFunction, getFunctionInfo, estimatePrice, LambdaInternals, renderStillOnLambda, getRegions, getAwsClient, presignUrl, deleteRender, };
-export type { AwsRegion, RenderProgress, DeploySiteInput, DeploySiteOutput, LambdaLsReturnType, LambdaLSInput, DeleteSiteInput, DeleteSiteOutput, EstimatePriceInput, DeployFunctionInput, DeployFunctionOutput, DeleteFunctionInput, GetFunctionInfoInput, FunctionInfo, GetFunctionsInput, GetSitesInput, GetSitesOutput, DownloadMediaInput, DownloadMediaOutput, GetOrCreateBucketInput, GetOrCreateBucketOutput, GetRenderInput, RenderMediaOnLambdaInput, RenderMediaOnLambdaOutput, RenderStillOnLambdaInput, RenderStillOnLambdaOutput, SimulatePermissionsInput, SimulatePermissionsOutput, GetAwsClientInput, GetAwsClientOutput, LambdaArchitecture, CustomCredentials, };
+export { deleteSite, deployFunction, deploySite, downloadMedia, downloadVideo, getFunctions, getUserPolicy, getRolePolicy, getSites, getOrCreateBucket, getRenderProgress, renderVideoOnLambda, renderMediaOnLambda, simulatePermissions, deleteFunction, getFunctionInfo, estimatePrice, LambdaInternals, renderStillOnLambda, getRegions, getAwsClient, presignUrl, deleteRender, validateWebhookSignature, };
+export type { AwsRegion, RenderProgress, DeploySiteInput, DeploySiteOutput, LambdaLsReturnType, LambdaLSInput, DeleteSiteInput, DeleteSiteOutput, EstimatePriceInput, DeployFunctionInput, DeployFunctionOutput, DeleteFunctionInput, GetFunctionInfoInput, FunctionInfo, GetFunctionsInput, GetSitesInput, GetSitesOutput, DownloadMediaInput, DownloadMediaOutput, GetOrCreateBucketInput, GetOrCreateBucketOutput, GetRenderInput, RenderMediaOnLambdaInput, RenderMediaOnLambdaOutput, RenderStillOnLambdaInput, RenderStillOnLambdaOutput, SimulatePermissionsInput, SimulatePermissionsOutput, GetAwsClientInput, GetAwsClientOutput, LambdaArchitecture, CustomCredentials, WebhookPayload, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteRender = exports.presignUrl = exports.getAwsClient = exports.getRegions = exports.renderStillOnLambda = exports.LambdaInternals = exports.estimatePrice = exports.getFunctionInfo = exports.deleteFunction = exports.simulatePermissions = exports.renderMediaOnLambda = exports.renderVideoOnLambda = exports.getRenderProgress = exports.getOrCreateBucket = exports.getSites = exports.getRolePolicy = exports.getUserPolicy = exports.getFunctions = exports.downloadVideo = exports.downloadMedia = exports.deploySite = exports.deployFunction = exports.deleteSite = void 0;
+exports.validateWebhookSignature = exports.deleteRender = exports.presignUrl = exports.getAwsClient = exports.getRegions = exports.renderStillOnLambda = exports.LambdaInternals = exports.estimatePrice = exports.getFunctionInfo = exports.deleteFunction = exports.simulatePermissions = exports.renderMediaOnLambda = exports.renderVideoOnLambda = exports.getRenderProgress = exports.getOrCreateBucket = exports.getSites = exports.getRolePolicy = exports.getUserPolicy = exports.getFunctions = exports.downloadVideo = exports.downloadMedia = exports.deploySite = exports.deployFunction = exports.deleteSite = void 0;
 const delete_function_1 = require("./api/delete-function");
 Object.defineProperty(exports, "deleteFunction", { enumerable: true, get: function () { return delete_function_1.deleteFunction; } });
 const delete_render_1 = require("./api/delete-render");
@@ -42,5 +42,7 @@ Object.defineProperty(exports, "renderMediaOnLambda", { enumerable: true, get: f
 Object.defineProperty(exports, "renderVideoOnLambda", { enumerable: true, get: function () { return render_media_on_lambda_1.renderVideoOnLambda; } });
 const render_still_on_lambda_1 = require("./api/render-still-on-lambda");
 Object.defineProperty(exports, "renderStillOnLambda", { enumerable: true, get: function () { return render_still_on_lambda_1.renderStillOnLambda; } });
+const validate_webhook_signature_1 = require("./api/validate-webhook-signature");
+Object.defineProperty(exports, "validateWebhookSignature", { enumerable: true, get: function () { return validate_webhook_signature_1.validateWebhookSignature; } });
 const internals_1 = require("./internals");
 Object.defineProperty(exports, "LambdaInternals", { enumerable: true, get: function () { return internals_1.LambdaInternals; } });

package/dist/shared/constants.d.ts

@@ -93,6 +93,10 @@ export declare enum LambdaRoutines {
     renderer = "renderer",
     still = "still"
 }
+declare type WebhookOption = null | {
+    url: string;
+    secret: string | null;
+};
 export declare type LambdaPayloads = {
     info: {
         type: LambdaRoutines.info;
@@ -125,6 +129,7 @@ export declare type LambdaPayloads = {
         muted: boolean;
         version: string;
         overwrite: boolean;
+        webhook: WebhookOption;
     };
     launch: {
         type: LambdaRoutines.launch;
@@ -155,6 +160,7 @@ export declare type LambdaPayloads = {
         downloadBehavior: DownloadBehavior;
         muted: boolean;
         overwrite: boolean;
+        webhook: WebhookOption;
     };
     status: {
         type: LambdaRoutines.status;
@@ -304,3 +310,4 @@ export declare type RenderProgress = {
 export declare type Privacy = 'public' | 'private' | 'no-acl';
 export declare const LAMBDA_CONCURRENCY_LIMIT_QUOTA = "L-B99A9384";
 export declare const LAMBDA_BURST_LIMIT_QUOTA = "L-548AE339";
+export {};

package/dist/shared/invoke-webhook.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
+import type { EnhancedErrorInfo } from '../functions/helpers/write-lambda-error';
+/**
+ * @description Calculates cryptographically secure signature for webhooks using Hmac.
+ * @link https://remotion.dev/docs/lambda/webhooks#validate-webhooks
+ * @param payload Stringified request body to encode in the signature.
+ * @param secret User-provided webhook secret used to sign the request.
+ * @returns {string} Calculated signature
+ */
+export declare function calculateSignature(payload: string, secret: string | null): string;
+declare type DynamicWebhookPayload = {
+    type: 'error';
+    errors: {
+        message: string;
+        name: string;
+        stack: string;
+    }[];
+} | {
+    type: 'success';
+    lambdaErrors: EnhancedErrorInfo[];
+    outputUrl: string | undefined;
+    outputFile: string | undefined;
+    timeToFinish: number | undefined;
+} | {
+    type: 'timeout';
+};
+export declare type WebhookPayload = {
+    renderId: string;
+    expectedBucketOwner: string;
+    bucketName: string;
+} & DynamicWebhookPayload;
+export declare const mockableHttpClients: {
+    http: typeof http.request;
+    https: typeof https.request;
+};
+export declare function invokeWebhook({ payload, secret, url, }: {
+    payload: WebhookPayload;
+    url: string;
+    secret: string | null;
+}): Promise<void>;
+export {};

package/dist/shared/invoke-webhook.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeWebhook = exports.mockableHttpClients = exports.calculateSignature = void 0;
+const Crypto = __importStar(require("crypto"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+/**
+ * @description Calculates cryptographically secure signature for webhooks using Hmac.
+ * @link https://remotion.dev/docs/lambda/webhooks#validate-webhooks
+ * @param payload Stringified request body to encode in the signature.
+ * @param secret User-provided webhook secret used to sign the request.
+ * @returns {string} Calculated signature
+ */
+function calculateSignature(payload, secret) {
+    if (!secret) {
+        return 'NO_SECRET_PROVIDED';
+    }
+    const hmac = Crypto.createHmac('sha512', secret);
+    const signature = 'sha512=' + hmac.update(payload).digest('hex');
+    return signature;
+}
+exports.calculateSignature = calculateSignature;
+const getWebhookClient = (url) => {
+    if (url.startsWith('https://')) {
+        return exports.mockableHttpClients.https;
+    }
+    if (url.startsWith('http://')) {
+        return exports.mockableHttpClients.http;
+    }
+    throw new Error('Can only request URLs starting with http:// or https://');
+};
+exports.mockableHttpClients = {
+    http: http_1.default.request,
+    https: https_1.default.request,
+};
+function invokeWebhook({ payload, secret, url, }) {
+    const jsonPayload = JSON.stringify(payload);
+    return new Promise((resolve, reject) => {
+        const req = getWebhookClient(url)(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Content-Length': jsonPayload.length,
+                'X-Remotion-Mode': 'production',
+                'X-Remotion-Signature': calculateSignature(jsonPayload, secret),
+                'X-Remotion-Status': payload.type,
+            },
+            timeout: 5000,
+        }, (res) => {
+            if (res.statusCode && res.statusCode > 299) {
+                reject(new Error(`Sent a webhook but got a status code of ${res.statusCode} with message '${res.statusMessage}'`));
+                return;
+            }
+            resolve();
+        });
+        req.write(jsonPayload);
+        req.on('error', (err) => {
+            reject(err);
+        });
+        req.end();
+    });
+}
+exports.invokeWebhook = invokeWebhook;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/lambda",
-	"version": "3.2.29",
+	"version": "3.2.30",
 	"description": "Distributed renderer for Remotion based on AWS Lambda",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -32,12 +32,12 @@
 		"@aws-sdk/client-service-quotas": "3.58.0",
 		"@aws-sdk/lib-storage": "3.58.0",
 		"@aws-sdk/s3-request-presigner": "3.58.0",
-		"@remotion/bundler": "3.2.29",
-		"@remotion/cli": "3.2.29",
-		"@remotion/renderer": "3.2.29",
+		"@remotion/bundler": "3.2.30",
+		"@remotion/cli": "3.2.30",
+		"@remotion/renderer": "3.2.30",
 		"aws-policies": "^1.0.1",
 		"mime-types": "2.1.34",
-		"remotion": "3.2.29"
+		"remotion": "3.2.30"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -62,5 +62,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "9a2ff4d68324af8d1fe55ebdf94bdadccf446a10"
+	"gitHead": "5dc5f4c010c47186c7911b575998296d6a65f7cb"
 }