@remotion/bundler 4.0.0-prefetch.10 → 4.0.0-prefetch.12

package/LICENSE.md

@@ -1,34 +1,34 @@
 # Remotion License
 
-Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion create videos for free (even commercial), while a company license is required for for-profit organisations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
 
 - [Free license](#free-license)
 - [Company license](#company-license)
 
 ## Free license
 
-Copyright © 2022 [Jonny Burger](https://jonny.io)
+Copyright © 2022 [Remotion](https://www.remotion.dev/)
 
 ### Eligibility
 
 You are eligible to use Remotion for free if you are:
 
 - an individual
-- a for-profit organisation with up to 3 employees
-- a non-profit or not-for-profit organisation
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
 - evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
 
 ### Allowed use cases
 
-Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify and the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
 
 ### Disallowed use cases
 
-It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, sublicensing your own derivate of Remotion.
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
 
 ### Warranty notice
 
-The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
 
 ### Support
 

package/dist/bundle.d.ts

@@ -1,6 +1,6 @@
 import type { WebpackOverrideFn } from 'remotion';
 import webpack from 'webpack';
-export declare type BundleOptions = {
+export declare type LegacyBundleOptions = {
     webpackOverride?: WebpackOverrideFn;
     outDir?: string;
     enableCaching?: boolean;
@@ -8,11 +8,21 @@ export declare type BundleOptions = {
     rootDir?: string;
     publicDir?: string | null;
 };
-export declare const getConfig: ({ entryPoint, outDir, resolvedRemotionRoot, onProgressUpdate, options, }: {
+export declare const getConfig: ({ entryPoint, outDir, resolvedRemotionRoot, onProgress, options, }: {
     outDir: string;
     entryPoint: string;
     resolvedRemotionRoot: string;
-    onProgressUpdate?: ((progress: number) => void) | undefined;
-    options?: BundleOptions | undefined;
+    onProgress?: ((progress: number) => void) | undefined;
+    options?: LegacyBundleOptions | undefined;
 }) => [string, webpack.Configuration];
-export declare const bundle: (entryPoint: string, onProgressUpdate?: ((progress: number) => void) | undefined, options?: BundleOptions) => Promise<string>;
+export declare type BundleOptions = {
+    entryPoint: string;
+    onProgress?: (progress: number) => void;
+} & LegacyBundleOptions;
+declare type Arguments = [options: BundleOptions] | [
+    entryPoint: string,
+    onProgress?: (progress: number) => void,
+    options?: LegacyBundleOptions
+];
+export declare function bundle(...args: Arguments): Promise<string>;
+export {};

package/dist/bundle.js

@@ -13,7 +13,6 @@ const worker_threads_1 = require("worker_threads");
 const copy_dir_1 = require("./copy-dir");
 const index_html_1 = require("./index-html");
 const webpack_config_1 = require("./webpack-config");
-const entry = require.resolve('./renderEntry');
 const promisified = (0, util_1.promisify)(webpack_1.default);
 const prepareOutDir = async (specified) => {
     if (specified) {
@@ -34,15 +33,16 @@ const trimTrailingSlash = (p) => {
     }
     return p;
 };
-const getConfig = ({ entryPoint, outDir, resolvedRemotionRoot, onProgressUpdate, options, }) => {
+const getConfig = ({ entryPoint, outDir, resolvedRemotionRoot, onProgress, options, }) => {
     var _a, _b;
+    const entry = require.resolve('./renderEntry');
     return (0, webpack_config_1.webpackConfig)({
         entry,
         userDefinedComponent: entryPoint,
         outDir,
         environment: 'production',
         webpackOverride: (_a = options === null || options === void 0 ? void 0 : options.webpackOverride) !== null && _a !== void 0 ? _a : ((f) => f),
-        onProgressUpdate,
+        onProgress,
         enableCaching: (_b = options === null || options === void 0 ? void 0 : options.enableCaching) !== null && _b !== void 0 ? _b : true,
         maxTimelineTracks: 15,
         // For production, the variables are set dynamically
@@ -53,10 +53,42 @@ const getConfig = ({ entryPoint, outDir, resolvedRemotionRoot, onProgressUpdate,
     });
 };
 exports.getConfig = getConfig;
-const bundle = async (entryPoint, onProgressUpdate, options) => {
-    var _a, _b, _c;
-    const resolvedRemotionRoot = (_a = options === null || options === void 0 ? void 0 : options.rootDir) !== null && _a !== void 0 ? _a : process.cwd();
-    const outDir = await prepareOutDir((_b = options === null || options === void 0 ? void 0 : options.outDir) !== null && _b !== void 0 ? _b : null);
+const convertArgumentsIntoOptions = (args) => {
+    var _a;
+    if (args.length === 0) {
+        throw new TypeError('bundle() was called without arguments');
+    }
+    const firstArg = args[0];
+    if (typeof firstArg === 'string') {
+        return {
+            entryPoint: firstArg,
+            onProgress: args[1],
+            ...((_a = args[2]) !== null && _a !== void 0 ? _a : {}),
+        };
+    }
+    if (typeof firstArg.entryPoint !== 'string') {
+        throw new TypeError('bundle() was called without the `entryPoint` option');
+    }
+    return firstArg;
+};
+const recursionLimit = 5;
+const findClosestPackageJsonFolder = (currentDir) => {
+    let possiblePackageJson = '';
+    for (let i = 0; i < recursionLimit; i++) {
+        possiblePackageJson = path_1.default.join(currentDir, 'package.json');
+        const exists = fs_1.default.existsSync(possiblePackageJson);
+        if (exists) {
+            return path_1.default.dirname(possiblePackageJson);
+        }
+        currentDir = path_1.default.dirname(currentDir);
+    }
+    return null;
+};
+async function bundle(...args) {
+    var _a, _b, _c, _d;
+    const actualArgs = convertArgumentsIntoOptions(args);
+    const resolvedRemotionRoot = (_b = (_a = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.rootDir) !== null && _a !== void 0 ? _a : findClosestPackageJsonFolder(actualArgs.entryPoint)) !== null && _b !== void 0 ? _b : process.cwd();
+    const outDir = await prepareOutDir((_c = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.outDir) !== null && _c !== void 0 ? _c : null);
     // The config might use an override which might use
     // `process.cwd()`. The context should always be the Remotion root.
     // This is not supported in worker threads (used for tests)
@@ -64,11 +96,12 @@ const bundle = async (entryPoint, onProgressUpdate, options) => {
     if (worker_threads_1.isMainThread) {
         process.chdir(resolvedRemotionRoot);
     }
+    const { entryPoint, onProgress, ...options } = actualArgs;
     const [, config] = (0, exports.getConfig)({
         outDir,
         entryPoint,
         resolvedRemotionRoot,
-        onProgressUpdate,
+        onProgress,
         options,
     });
     const output = await promisified([config]);
@@ -82,7 +115,7 @@ const bundle = async (entryPoint, onProgressUpdate, options) => {
     if (errors !== undefined && errors.length > 0) {
         throw new Error(errors[0].message + '\n' + errors[0].details);
     }
-    const baseDir = (_c = options === null || options === void 0 ? void 0 : options.publicPath) !== null && _c !== void 0 ? _c : '/';
+    const baseDir = (_d = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.publicPath) !== null && _d !== void 0 ? _d : '/';
     const staticHash = '/' +
         [trimTrailingSlash(trimLeadingSlash(baseDir)), 'public']
             .filter(Boolean)
@@ -104,5 +137,5 @@ const bundle = async (entryPoint, onProgressUpdate, options) => {
     });
     fs_1.default.writeFileSync(path_1.default.join(outDir, 'index.html'), html);
     return outDir;
-};
+}
 exports.bundle = bundle;

package/dist/index-html.d.ts

@@ -1,8 +1,9 @@
-export declare const indexHtml: ({ baseDir, editorName, inputProps, staticHash, remotionRoot, previewServerCommand, }: {
+export declare const indexHtml: ({ baseDir, editorName, inputProps, envVariables, staticHash, remotionRoot, previewServerCommand, }: {
     staticHash: string;
     baseDir: string;
     editorName: string | null;
     inputProps: object | null;
+    envVariables?: Record<string, string> | undefined;
     remotionRoot: string;
     previewServerCommand: string | null;
 }) => string;

package/dist/index-html.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.indexHtml = void 0;
 const path_1 = __importDefault(require("path"));
-const indexHtml = ({ baseDir, editorName, inputProps, staticHash, remotionRoot, previewServerCommand, }) => `
+const indexHtml = ({ baseDir, editorName, inputProps, envVariables, staticHash, remotionRoot, previewServerCommand, }) => `
 <!DOCTYPE html>
 <html lang="en">
 	<head>
@@ -29,6 +29,12 @@ const indexHtml = ({ baseDir, editorName, inputProps, staticHash, remotionRoot,
     ? `<script>window.remotion_inputProps = ${JSON.stringify(JSON.stringify(inputProps))};</script>
 			`
     : ''}
+		${envVariables
+    ? `<script> window.process = {
+    						env: ${JSON.stringify(envVariables)}
+ 				};</script>
+			`
+    : ''}
 		
 		<div id="container"></div>
 		<div id="menuportal-0"></div>

package/dist/index.d.ts

@@ -2,13 +2,13 @@ import esbuild = require('esbuild');
 import webpack = require('webpack');
 export declare const BundlerInternals: {
     esbuild: typeof esbuild;
-    webpackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgressUpdate, enableCaching, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }: {
+    webpackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgress, enableCaching, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }: {
         entry: string;
         userDefinedComponent: string;
         outDir: string;
         environment: "development" | "production";
         webpackOverride: import("remotion/dist/internals").WebpackOverrideFn;
-        onProgressUpdate?: ((f: number) => void) | undefined;
+        onProgress?: ((f: number) => void) | undefined;
         enableCaching?: boolean | undefined;
         envVariables: Record<string, string>;
         maxTimelineTracks: number;
@@ -16,24 +16,25 @@ export declare const BundlerInternals: {
         entryPoints: string[];
         remotionRoot: string;
     }) => [string, webpack.Configuration];
-    indexHtml: ({ baseDir, editorName, inputProps, staticHash, remotionRoot, previewServerCommand, }: {
+    indexHtml: ({ baseDir, editorName, inputProps, envVariables, staticHash, remotionRoot, previewServerCommand, }: {
         staticHash: string;
         baseDir: string;
         editorName: string | null;
         inputProps: object | null;
+        envVariables?: Record<string, string> | undefined;
         remotionRoot: string;
         previewServerCommand: string | null;
     }) => string;
     cacheExists: (remotionRoot: string, environment: "development" | "production", hash: string) => "exists" | "other-exists" | "does-not-exist";
     clearCache: (remotionRoot: string) => Promise<void>;
-    getConfig: ({ entryPoint, outDir, resolvedRemotionRoot, onProgressUpdate, options, }: {
+    getConfig: ({ entryPoint, outDir, resolvedRemotionRoot, onProgress, options, }: {
         outDir: string;
         entryPoint: string;
         resolvedRemotionRoot: string;
-        onProgressUpdate?: ((progress: number) => void) | undefined;
-        options?: import("./bundle").BundleOptions | undefined;
+        onProgress?: ((progress: number) => void) | undefined;
+        options?: import("./bundle").LegacyBundleOptions | undefined;
     }) => [string, webpack.Configuration];
 };
-export { bundle, BundleOptions } from './bundle';
+export { bundle, BundleOptions, LegacyBundleOptions } from './bundle';
 export { webpack };
 export declare type WebpackConfiguration = webpack.Configuration;

package/dist/renderEntry.js

@@ -15,6 +15,19 @@ const remotion_1 = require("remotion");
 const bundle_mode_1 = require("./bundle-mode");
 const homepage_1 = require("./homepage/homepage");
 remotion_1.Internals.CSSUtils.injectCSS(remotion_1.Internals.CSSUtils.makeDefaultCSS(null, '#fff'));
+const getCanSerializeDefaultProps = (object) => {
+    try {
+        const str = JSON.stringify(object);
+        // 256MB is the theoretical limit, making it throw if over 90% of that is reached.
+        return str.length < 256 * 1024 * 1024 * 0.9;
+    }
+    catch (err) {
+        if (err.message.includes('Invalid string length')) {
+            return false;
+        }
+        throw err;
+    }
+};
 const GetVideo = ({ state }) => {
     const video = remotion_1.Internals.useVideo();
     const compositions = (0, react_1.useContext)(remotion_1.Internals.CompositionManager);
@@ -82,7 +95,7 @@ let cleanupVideoContainer = () => {
 let cleanupExplainerContainer = () => {
     explainerContainer.innerHTML = '';
 };
-const waitForRootHandle = (0, remotion_1.delayRender)('Loading root component');
+const waitForRootHandle = (0, remotion_1.delayRender)('Loading root component - See https://remotion.dev/docs/troubleshooting/loading-root-component if you experience a timeout');
 const WaitForRoot = () => {
     const [Root, setRoot] = (0, react_1.useState)(() => remotion_1.Internals.getRoot());
     (0, react_1.useEffect)(() => {
@@ -161,9 +174,19 @@ if (typeof window !== 'undefined') {
         if (!remotion_1.Internals.compositionsRef.current) {
             throw new Error('Unexpectedly did not have a CompositionManager');
         }
-        return remotion_1.Internals.compositionsRef.current
-            .getCompositions()
-            .map((c) => {
+        const compositions = remotion_1.Internals.compositionsRef.current.getCompositions();
+        const canSerializeDefaultProps = getCanSerializeDefaultProps(compositions);
+        if (!canSerializeDefaultProps) {
+            console.warn('defaultProps are too big to serialize - trying to find the problematic composition...');
+            for (const comp of compositions) {
+                if (!getCanSerializeDefaultProps(comp)) {
+                    throw new Error(`defaultProps too big - could not serialize - the defaultProps of composition with ID ${comp.id} - the object that was passed to defaultProps was too big. Learn how to mitigate this error by visiting https://remotion.dev/docs/troubleshooting/serialize-defaultprops`);
+                }
+            }
+            console.warn('Could not single out a problematic composition -  The composition list as a whole is too big to serialize.');
+            throw new Error('defaultProps too big - Could not serialize - an object that was passed to defaultProps was too big. Learn how to mitigate this error by visiting https://remotion.dev/docs/troubleshooting/serialize-defaultprops');
+        }
+        return compositions.map((c) => {
             return {
                 defaultProps: c.defaultProps,
                 durationInFrames: c.durationInFrames,

package/dist/test/validate-bundle.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/validate-bundle.test.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const bundle_1 = require("../bundle");
+(0, vitest_1.test)('Should reject bad bundle options', () => {
+    // @ts-expect-error
+    (0, vitest_1.expect)(() => (0, bundle_1.bundle)()).rejects.toThrow(/bundle\(\) was called without arguments/);
+    // @ts-expect-error
+    (0, vitest_1.expect)(() => (0, bundle_1.bundle)({})).rejects.toThrow(/bundle\(\) was called without the `entryPoint` option/);
+});

package/dist/webpack-config.d.ts

@@ -1,11 +1,11 @@
 import type { WebpackConfiguration, WebpackOverrideFn } from 'remotion';
-export declare const webpackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgressUpdate, enableCaching, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }: {
+export declare const webpackConfig: ({ entry, userDefinedComponent, outDir, environment, webpackOverride, onProgress, enableCaching, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }: {
     entry: string;
     userDefinedComponent: string;
     outDir: string;
     environment: 'development' | 'production';
     webpackOverride: WebpackOverrideFn;
-    onProgressUpdate?: ((f: number) => void) | undefined;
+    onProgress?: ((f: number) => void) | undefined;
     enableCaching?: boolean | undefined;
     envVariables: Record<string, string>;
     maxTimelineTracks: number;

package/dist/webpack-config.js

@@ -50,7 +50,7 @@ const esbuildLoaderOptions = {
 function truthy(value) {
     return Boolean(value);
 }
-const webpackConfig = ({ entry, userDefinedComponent, outDir, environment, webpackOverride = (f) => f, onProgressUpdate, enableCaching = true, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }) => {
+const webpackConfig = ({ entry, userDefinedComponent, outDir, environment, webpackOverride = (f) => f, onProgress, enableCaching = true, envVariables, maxTimelineTracks, entryPoints, remotionRoot, keyboardShortcutsEnabled, }) => {
     const conf = webpackOverride({
         optimization: {
             minimize: false,
@@ -95,8 +95,8 @@ const webpackConfig = ({ entry, userDefinedComponent, outDir, environment, webpa
             ]
             : [
                 new webpack_1.ProgressPlugin((p) => {
-                    if (onProgressUpdate) {
-                        onProgressUpdate(Number((p * 100).toFixed(2)));
+                    if (onProgress) {
+                        onProgress(Number((p * 100).toFixed(2)));
                     }
                 }),
             ],

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/bundler",
-	"version": "4.0.0-prefetch.10+cf59c29c7",
+	"version": "4.0.0-prefetch.12+c7eb5bd76",
 	"description": "Bundler for Remotion",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -26,9 +26,9 @@
 		"css-loader": "5.2.7",
 		"esbuild": "0.14.19",
 		"react-refresh": "0.9.0",
-		"remotion": "4.0.0-prefetch.10+cf59c29c7",
+		"remotion": "4.0.0-prefetch.12+c7eb5bd76",
 		"style-loader": "2.0.0",
-		"webpack": "5.72.0"
+		"webpack": "5.74.0"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -42,16 +42,16 @@
 		"@types/webpack-env": "^1.16.0",
 		"@typescript-eslint/eslint-plugin": "5.18.0",
 		"@typescript-eslint/parser": "5.18.0",
-		"eslint": "8.13.0",
+		"eslint": "8.25.0",
 		"eslint-plugin-10x": "1.5.2",
 		"eslint-plugin-react": "7.29.4",
 		"eslint-plugin-react-hooks": "4.4.0",
-		"prettier": "^2.0.5",
+		"prettier": "^2.7.1",
 		"prettier-plugin-organize-imports": "^2.3.4",
 		"react": "^18.0.0",
 		"react-dom": "^18.0.0",
 		"typescript": "^4.7.0",
-		"vitest": "^0.18.0"
+		"vitest": "0.24.3"
 	},
 	"keywords": [
 		"remotion",
@@ -64,5 +64,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "cf59c29c7b500377b7157afb761754159156d25f"
+	"gitHead": "c7eb5bd76f2f89677f007a54e1bc5d3e3403094f"
 }