@remotion/lambda 4.0.24 → 4.0.25

package/dist/api/make-lambda-payload.js

@@ -8,6 +8,7 @@ const validate_download_behavior_1 = require("../shared/validate-download-behavi
 const validate_frames_per_lambda_1 = require("../shared/validate-frames-per-lambda");
 const validate_lambda_codec_1 = require("../shared/validate-lambda-codec");
 const validate_serveurl_1 = require("../shared/validate-serveurl");
+const validate_webhook_1 = require("../shared/validate-webhook");
 const makeLambdaRenderMediaPayload = async ({ rendererFunctionName, frameRange, framesPerLambda, forceBucketName: bucketName, codec, composition, serveUrl, imageFormat, inputProps, region, crf, envVariables, pixelFormat, proResProfile, x264Preset, maxRetries, privacy, logLevel, outName, timeoutInMilliseconds, chromiumOptions, scale, everyNthFrame, numberOfGifLoops, audioBitrate, concurrencyPerLambda, audioCodec, forceHeight, forceWidth, webhook, videoBitrate, downloadBehavior, muted, overwrite, dumpBrowserLogs, jpegQuality, quality, offthreadVideoCacheSizeInBytes, }) => {
     if (quality) {
         throw new Error('quality has been renamed to jpegQuality. Please rename the option.');
@@ -19,6 +20,7 @@ const makeLambdaRenderMediaPayload = async ({ rendererFunctionName, frameRange,
         durationInFrames: 1,
     });
     (0, validate_download_behavior_1.validateDownloadBehavior)(downloadBehavior);
+    (0, validate_webhook_1.validateWebhook)(webhook);
     const stringifiedInputProps = (0, compress_props_1.serializeOrThrow)(inputProps !== null && inputProps !== void 0 ? inputProps : {}, 'input-props');
     const serialized = await (0, compress_props_1.compressInputProps)({
         stringifiedInputProps,

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

@@ -1,7 +1,7 @@
 import type { AudioCodec, ChromiumOptions, FrameRange, LogLevel, PixelFormat, ProResProfile, ToOptions, VideoImageFormat, X264Preset } from '@remotion/renderer';
 import type { BrowserSafeApis } from '@remotion/renderer/client';
 import type { AwsRegion } from '../pricing/aws-regions';
-import type { OutNameInput, Privacy } from '../shared/constants';
+import type { OutNameInput, Privacy, WebhookOption } from '../shared/constants';
 import type { DownloadBehavior } from '../shared/content-disposition-header';
 import type { LambdaCodec } from '../shared/validate-lambda-codec';
 export type RenderMediaOnLambdaInput = {
@@ -39,10 +39,7 @@ export type RenderMediaOnLambdaInput = {
     overwrite?: boolean;
     audioBitrate?: string | null;
     videoBitrate?: string | null;
-    webhook?: {
-        url: string;
-        secret: string | null;
-    };
+    webhook?: WebhookOption | null;
     forceWidth?: number | null;
     forceHeight?: number | null;
     rendererFunctionName?: string | null;

package/dist/cli/args.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="minimist" />
+import type { BrowserSafeApis } from '@remotion/renderer/client';
 import type { AwsRegion } from '../pricing/aws-regions';
 import type { Privacy } from '../shared/constants';
 type LambdaCommandLineOptions = {
@@ -25,6 +26,7 @@ type LambdaCommandLineOptions = {
     privacy: Privacy;
     webhook: string | undefined;
     ['webhook-secret']: string | undefined;
+    [BrowserSafeApis.options.webhookCustomDataOption.cliFlag]: string | undefined;
     ['renderer-function-name']: string | undefined;
     ['function-name']: string | undefined;
     ['force-bucket-name']: string | undefined;

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

@@ -17,6 +17,7 @@ const validate_serveurl_1 = require("../../../shared/validate-serveurl");
 const args_1 = require("../../args");
 const get_aws_region_1 = require("../../get-aws-region");
 const find_function_name_1 = require("../../helpers/find-function-name");
+const get_webhook_custom_data_1 = require("../../helpers/get-webhook-custom-data");
 const quit_1 = require("../../helpers/quit");
 const log_1 = require("../../log");
 const progress_1 = require("./progress");
@@ -97,6 +98,7 @@ const renderCommand = async (args, remotionRoot) => {
     (0, validate_privacy_1.validatePrivacy)(privacy, true);
     const framesPerLambda = (_e = args_1.parsedLambdaCli['frames-per-lambda']) !== null && _e !== void 0 ? _e : undefined;
     (0, validate_frames_per_lambda_1.validateFramesPerLambda)({ framesPerLambda, durationInFrames: 1 });
+    const webhookCustomData = (0, get_webhook_custom_data_1.getWebhookCustomData)();
     const res = await (0, render_media_on_lambda_1.renderMediaOnLambda)({
         functionName,
         serveUrl,
@@ -132,6 +134,7 @@ const renderCommand = async (args, remotionRoot) => {
             ? {
                 url: args_1.parsedLambdaCli.webhook,
                 secret: (_f = args_1.parsedLambdaCli['webhook-secret']) !== null && _f !== void 0 ? _f : null,
+                customData: webhookCustomData,
             }
             : undefined,
         rendererFunctionName: (_g = args_1.parsedLambdaCli['renderer-function-name']) !== null && _g !== void 0 ? _g : null,

package/dist/cli/helpers/get-webhook-custom-data.d.ts

@@ -0,0 +1 @@
+export declare const getWebhookCustomData: () => Record<string, unknown> | null;

package/dist/cli/helpers/get-webhook-custom-data.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWebhookCustomData = void 0;
+const client_1 = require("@remotion/renderer/client");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const args_1 = require("../args");
+const log_1 = require("../log");
+const getWebhookCustomData = () => {
+    const flagName = client_1.BrowserSafeApis.options.webhookCustomDataOption.cliFlag;
+    const webhookFlag = args_1.parsedLambdaCli[flagName];
+    if (!webhookFlag) {
+        return null;
+    }
+    const jsonFile = node_path_1.default.resolve(process.cwd(), webhookFlag);
+    try {
+        if (node_fs_1.default.existsSync(jsonFile)) {
+            const rawJsonData = node_fs_1.default.readFileSync(jsonFile, 'utf-8');
+            return JSON.parse(rawJsonData);
+        }
+        return JSON.parse(webhookFlag);
+    }
+    catch (err) {
+        log_1.Log.error(`You passed --${flagName} but it was neither valid JSON nor a file path to a valid JSON file. Provided value: ${webhookFlag}`);
+        log_1.Log.info('Got the following value:', webhookFlag);
+        log_1.Log.error('Check that your input is parseable using `JSON.parse` and try again.');
+        if (node_os_1.default.platform() === 'win32') {
+            log_1.Log.warn('Note: Windows handles escaping of quotes very weirdly in the command line.');
+            log_1.Log.warn('This might have led to you having this problem.');
+            log_1.Log.warn('Consider using the alternative API for --props which is to pass');
+            log_1.Log.warn('a path to a JSON file:');
+            log_1.Log.warn(`  --${flagName}=path/to/props.json`);
+        }
+        process.exit(1);
+    }
+};
+exports.getWebhookCustomData = getWebhookCustomData;

package/dist/cli/helpers/validate.d.ts

@@ -0,0 +1,4 @@
+import { Internals } from 'remotion';
+export declare const validateFps: typeof Internals.validateFps;
+export declare const validateDimension: typeof Internals.validateDimension;
+export declare const validateDurationInFrames: typeof Internals.validateDurationInFrames;

package/dist/cli/helpers/validate.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDurationInFrames = exports.validateDimension = exports.validateFps = void 0;
+/* eslint-disable prefer-destructuring */
+const remotion_1 = require("remotion");
+exports.validateFps = remotion_1.Internals.validateFps;
+exports.validateDimension = remotion_1.Internals.validateDimension;
+exports.validateDurationInFrames = remotion_1.Internals.validateDurationInFrames;

package/dist/functions/launch.js

@@ -28,7 +28,6 @@ const client_lambda_1 = require("@aws-sdk/client-lambda");
 const renderer_1 = require("@remotion/renderer");
 const node_fs_1 = __importStar(require("node:fs"));
 const node_path_1 = require("node:path");
-const remotion_1 = require("remotion");
 const version_1 = require("remotion/version");
 const aws_clients_1 = require("../shared/aws-clients");
 const cleanup_serialized_input_props_1 = require("../shared/cleanup-serialized-input-props");
@@ -36,6 +35,7 @@ const compress_props_1 = require("../shared/compress-props");
 const constants_1 = require("../shared/constants");
 const docs_url_1 = require("../shared/docs-url");
 const invoke_webhook_1 = require("../shared/invoke-webhook");
+const validate_1 = require("../shared/validate");
 const validate_frames_per_lambda_1 = require("../shared/validate-frames-per-lambda");
 const validate_outname_1 = require("../shared/validate-outname");
 const validate_privacy_1 = require("../shared/validate-privacy");
@@ -115,13 +115,13 @@ const innerLaunchHandler = async (params, options) => {
         offthreadVideoCacheSizeInBytes: params.offthreadVideoCacheSizeInBytes,
     });
     renderer_1.RenderInternals.Log.info('Composition validated, resolved props', comp.props);
-    remotion_1.Internals.validateDurationInFrames(comp.durationInFrames, {
+    (0, validate_1.validateDurationInFrames)(comp.durationInFrames, {
         component: 'passed to a Lambda render',
         allowFloats: false,
     });
-    remotion_1.Internals.validateFps(comp.fps, 'passed to a Lambda render', false);
-    remotion_1.Internals.validateDimension(comp.height, 'height', 'passed to a Lambda render');
-    remotion_1.Internals.validateDimension(comp.width, 'width', 'passed to a Lambda render');
+    (0, validate_1.validateFps)(comp.fps, 'passed to a Lambda render', false);
+    (0, validate_1.validateDimension)(comp.height, 'height', 'passed to a Lambda render');
+    (0, validate_1.validateDimension)(comp.width, 'width', 'passed to a Lambda render');
     renderer_1.RenderInternals.validateBitrate(params.audioBitrate, 'audioBitrate');
     renderer_1.RenderInternals.validateBitrate(params.videoBitrate, 'videoBitrate');
     renderer_1.RenderInternals.validateConcurrency(params.concurrencyPerLambda, 'concurrencyPerLambda');
@@ -442,11 +442,13 @@ const innerLaunchHandler = async (params, options) => {
     return postRenderData;
 };
 const launchHandler = async (params, options) => {
+    var _a, _b;
     if (params.type !== constants_1.LambdaRoutines.launch) {
         throw new Error('Expected launch type');
     }
     let webhookInvoked = false;
     const webhookDueToTimeout = setTimeout(async () => {
+        var _a;
         if (params.webhook && !webhookInvoked) {
             try {
                 await (0, invoke_webhook_1.invokeWebhook)({
@@ -457,6 +459,7 @@ const launchHandler = async (params, options) => {
                         renderId: params.renderId,
                         expectedBucketOwner: options.expectedBucketOwner,
                         bucketName: params.bucketName,
+                        customData: (_a = params.webhook.customData) !== null && _a !== void 0 ? _a : null,
                     },
                 });
                 webhookInvoked = true;
@@ -502,6 +505,7 @@ const launchHandler = async (params, options) => {
                         renderId: params.renderId,
                         expectedBucketOwner: options.expectedBucketOwner,
                         bucketName: params.bucketName,
+                        customData: (_a = params.webhook.customData) !== null && _a !== void 0 ? _a : null,
                         outputUrl: postRenderData.outputFile,
                         lambdaErrors: postRenderData.errors,
                         outputFile: postRenderData.outputFile,
@@ -575,6 +579,7 @@ const launchHandler = async (params, options) => {
                         renderId: params.renderId,
                         expectedBucketOwner: options.expectedBucketOwner,
                         bucketName: params.bucketName,
+                        customData: (_b = params.webhook.customData) !== null && _b !== void 0 ? _b : null,
                         errors: [err].map((e) => ({
                             message: e.message,
                             name: e.name,

package/dist/shared/compress-props.js

@@ -7,6 +7,7 @@ const constants_1 = require("./constants");
 const random_hash_1 = require("./random-hash");
 const serialize_props_1 = require("./serialize-props");
 const stream_to_string_1 = require("./stream-to-string");
+const validate_webhook_1 = require("./validate-webhook");
 const serializeOrThrow = (inputProps, propsType) => {
     try {
         const payload = (0, serialize_props_1.serializeJSONWithDate)({
@@ -22,7 +23,7 @@ const serializeOrThrow = (inputProps, propsType) => {
 };
 exports.serializeOrThrow = serializeOrThrow;
 const getNeedsToUpload = (type, sizes) => {
-    const MARGIN = 5000;
+    const MARGIN = 5000 + validate_webhook_1.MAX_WEBHOOK_CUSTOM_DATA_SIZE;
     const MAX_INLINE_PAYLOAD_SIZE = (type === 'still' ? 5000000 : 200000) - MARGIN;
     const sizesAlreadyUsed = sizes.reduce((a, b) => a + b);
     if (sizesAlreadyUsed > MAX_INLINE_PAYLOAD_SIZE) {

package/dist/shared/constants.d.ts

@@ -1,4 +1,5 @@
-import type { AudioCodec, ChromiumOptions, Codec, FrameRange, LogLevel, PixelFormat, ProResProfile, StillImageFormat, VideoImageFormat, X264Preset } from '@remotion/renderer';
+import type { AudioCodec, ChromiumOptions, Codec, FrameRange, LogLevel, PixelFormat, ProResProfile, StillImageFormat, ToOptions, VideoImageFormat, X264Preset } from '@remotion/renderer';
+import type { BrowserSafeApis } from '@remotion/renderer/client';
 import type { VideoConfig } from 'remotion';
 import type { ChunkRetry } from '../functions/helpers/get-retry-stats';
 import type { EnhancedErrorInfo } from '../functions/helpers/write-lambda-error';
@@ -95,10 +96,13 @@ export declare enum LambdaRoutines {
     still = "still",
     compositions = "compositions"
 }
-type WebhookOption = null | {
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type WebhookOption = Prettify<null | ({
     url: string;
     secret: string | null;
-};
+} & Partial<ToOptions<[typeof BrowserSafeApis.options.webhookCustomDataOption]>>)>;
 export type SerializedInputProps = {
     type: 'bucket-url';
     hash: string;

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

@@ -31,6 +31,7 @@ export type WebhookPayload = {
     renderId: string;
     expectedBucketOwner: string;
     bucketName: string;
+    customData: Record<string, unknown> | null;
 } & DynamicWebhookPayload;
 export declare const mockableHttpClients: {
     http: typeof http.request;

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

@@ -0,0 +1,3 @@
+import type { WebhookOption } from './constants';
+export declare const MAX_WEBHOOK_CUSTOM_DATA_SIZE = 1024;
+export declare const validateWebhook: (webhook?: WebhookOption | null) => void;

package/dist/shared/validate-webhook.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateWebhook = exports.MAX_WEBHOOK_CUSTOM_DATA_SIZE = void 0;
+exports.MAX_WEBHOOK_CUSTOM_DATA_SIZE = 1024;
+const validateWebhook = (webhook) => {
+    if (typeof webhook === 'undefined' || webhook === null) {
+        return;
+    }
+    if (webhook.customData) {
+        const size = JSON.stringify(webhook.customData).length;
+        if (size > exports.MAX_WEBHOOK_CUSTOM_DATA_SIZE) {
+            throw new Error(`Webhook "customData" must be less than ${exports.MAX_WEBHOOK_CUSTOM_DATA_SIZE} bytes. Current size: ${size} bytes.`);
+        }
+    }
+};
+exports.validateWebhook = validateWebhook;

package/dist/shared/validate.d.ts

@@ -0,0 +1,4 @@
+import { Internals } from 'remotion';
+export declare const validateFps: typeof Internals.validateFps;
+export declare const validateDimension: typeof Internals.validateDimension;
+export declare const validateDurationInFrames: typeof Internals.validateDurationInFrames;

package/dist/shared/validate.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDurationInFrames = exports.validateDimension = exports.validateFps = void 0;
+/* eslint-disable prefer-destructuring */
+const remotion_1 = require("remotion");
+exports.validateFps = remotion_1.Internals.validateFps;
+exports.validateDimension = remotion_1.Internals.validateDimension;
+exports.validateDurationInFrames = remotion_1.Internals.validateDurationInFrames;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/lambda",
-  "version": "4.0.24",
+  "version": "4.0.25",
   "description": "Distributed renderer for Remotion based on AWS Lambda",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -26,10 +26,10 @@
     "aws-policies": "^1.0.1",
     "mime-types": "2.1.34",
     "zod": "3.21.4",
-    "@remotion/cli": "4.0.24",
-    "@remotion/bundler": "4.0.24",
-    "@remotion/renderer": "4.0.24",
-    "remotion": "4.0.24"
+    "@remotion/bundler": "4.0.25",
+    "@remotion/cli": "4.0.25",
+    "@remotion/renderer": "4.0.25",
+    "remotion": "4.0.25"
   },
   "devDependencies": {
     "@jonny/eslint-config": "3.0.266",
@@ -43,11 +43,11 @@
     "ts-node": "^10.8.0",
     "vitest": "0.31.1",
     "zip-lib": "^0.7.2",
-    "@remotion/bundler": "4.0.24",
-    "@remotion/compositor-linux-arm64-gnu": "4.0.24"
+    "@remotion/bundler": "4.0.25",
+    "@remotion/compositor-linux-arm64-gnu": "4.0.25"
   },
   "peerDependencies": {
-    "@remotion/bundler": "4.0.24"
+    "@remotion/bundler": "4.0.25"
   },
   "publishConfig": {
     "access": "public"

package/dist/shared/deserialize-input-props.d.ts

@@ -1,8 +0,0 @@
-import type { AwsRegion } from '../client';
-import type { SerializedInputProps } from './constants';
-export declare const deserializeInputProps: ({ serialized, region, bucketName, expectedBucketOwner, }: {
-    serialized: SerializedInputProps;
-    region: AwsRegion;
-    bucketName: string;
-    expectedBucketOwner: string;
-}) => Promise<Record<string, unknown>>;

package/dist/shared/deserialize-input-props.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeInputProps = void 0;
-const io_1 = require("../functions/helpers/io");
-const constants_1 = require("./constants");
-const stream_to_string_1 = require("./stream-to-string");
-const deserializeInputProps = async ({ serialized, region, bucketName, expectedBucketOwner, }) => {
-    if (serialized.type === 'payload') {
-        return JSON.parse(serialized.payload);
-    }
-    try {
-        const response = await (0, io_1.lambdaReadFile)({
-            bucketName,
-            expectedBucketOwner,
-            key: (0, constants_1.inputPropsKey)(serialized.hash),
-            region,
-        });
-        const body = await (0, stream_to_string_1.streamToString)(response);
-        const payload = JSON.parse(body);
-        return payload;
-    }
-    catch (err) {
-        throw new Error(`Failed to parse input props that were serialized: ${err.stack}`);
-    }
-};
-exports.deserializeInputProps = deserializeInputProps;

package/dist/shared/serialize-input-props.d.ts

@@ -1,14 +0,0 @@
-import type { AwsRegion } from '../client';
-import type { SerializedInputProps } from './constants';
-export declare const serializeInputProps: ({ inputProps, region, type, userSpecifiedBucketName, }: {
-    inputProps: Record<string, unknown>;
-    region: AwsRegion;
-    type: 'still' | 'video-or-audio';
-    userSpecifiedBucketName: string | null;
-}) => Promise<SerializedInputProps>;
-export declare const deserializeInputProps: ({ serialized, region, bucketName, expectedBucketOwner, }: {
-    serialized: SerializedInputProps;
-    region: AwsRegion;
-    bucketName: string;
-    expectedBucketOwner: string;
-}) => Promise<Record<string, unknown>>;

package/dist/shared/serialize-input-props.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeInputProps = exports.serializeInputProps = void 0;
-const get_or_create_bucket_1 = require("../api/get-or-create-bucket");
-const io_1 = require("../functions/helpers/io");
-const constants_1 = require("./constants");
-const random_hash_1 = require("./random-hash");
-const stream_to_string_1 = require("./stream-to-string");
-const serializeInputProps = async ({ inputProps, region, type, userSpecifiedBucketName, }) => {
-    try {
-        const payload = JSON.stringify(inputProps);
-        const hash = (0, random_hash_1.randomHash)();
-        const MAX_INLINE_PAYLOAD_SIZE = type === 'still' ? 5000000 : 200000;
-        if (payload.length > MAX_INLINE_PAYLOAD_SIZE) {
-            console.warn(`Warning: inputProps are over ${Math.round(MAX_INLINE_PAYLOAD_SIZE / 1000)}KB (${Math.ceil(payload.length / 1024)}KB) in size. Uploading them to S3 to circumvent AWS Lambda payload size.`);
-            const bucketName = userSpecifiedBucketName !== null && userSpecifiedBucketName !== void 0 ? userSpecifiedBucketName : (await (0, get_or_create_bucket_1.getOrCreateBucket)({
-                region,
-            })).bucketName;
-            await (0, io_1.lambdaWriteFile)({
-                body: payload,
-                bucketName,
-                region,
-                customCredentials: null,
-                downloadBehavior: null,
-                expectedBucketOwner: null,
-                key: (0, constants_1.inputPropsKey)(hash),
-                privacy: 'public',
-            });
-            return {
-                type: 'bucket-url',
-                hash,
-            };
-        }
-        return {
-            type: 'payload',
-            payload,
-        };
-    }
-    catch (err) {
-        throw new Error('Error serializing inputProps. Check it has no circular references or reduce the size if the object is big.');
-    }
-};
-exports.serializeInputProps = serializeInputProps;
-const deserializeInputProps = async ({ serialized, region, bucketName, expectedBucketOwner, }) => {
-    if (serialized.type === 'payload') {
-        return JSON.parse(serialized.payload);
-    }
-    try {
-        const response = await (0, io_1.lambdaReadFile)({
-            bucketName,
-            expectedBucketOwner,
-            key: (0, constants_1.inputPropsKey)(serialized.hash),
-            region,
-        });
-        const body = await (0, stream_to_string_1.streamToString)(response);
-        const payload = JSON.parse(body);
-        return payload;
-    }
-    catch (err) {
-        throw new Error(`Failed to parse input props that were serialized: ${err.stack}`);
-    }
-};
-exports.deserializeInputProps = deserializeInputProps;