@remotion/bundler 3.2.15 → 3.2.20

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,29 @@ const getConfig = ({ entryPoint, outDir, resolvedRemotionRoot, onProgressUpdate,
     });
 };
 exports.getConfig = getConfig;
-const bundle = async (entryPoint, onProgressUpdate, options) => {
+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;
+};
+async function bundle(...args) {
     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 actualArgs = convertArgumentsIntoOptions(args);
+    const resolvedRemotionRoot = (_a = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.rootDir) !== null && _a !== void 0 ? _a : process.cwd();
+    const outDir = await prepareOutDir((_b = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.outDir) !== null && _b !== void 0 ? _b : 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 +83,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 +102,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 = (_c = actualArgs === null || actualArgs === void 0 ? void 0 : actualArgs.publicPath) !== null && _c !== void 0 ? _c : '/';
     const staticHash = '/' +
         [trimTrailingSlash(trimLeadingSlash(baseDir)), 'public']
             .filter(Boolean)
@@ -104,5 +124,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.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;
@@ -26,14 +26,14 @@ export declare const BundlerInternals: {
     }) => 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/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": "3.2.15",
+	"version": "3.2.20",
 	"description": "Bundler for Remotion",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -26,7 +26,7 @@
 		"css-loader": "5.2.7",
 		"esbuild": "0.14.19",
 		"react-refresh": "0.9.0",
-		"remotion": "3.2.15",
+		"remotion": "3.2.20",
 		"style-loader": "2.0.0",
 		"webpack": "5.72.0"
 	},
@@ -64,5 +64,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "7346704683815d274733cb3d280157b9ff570773"
+	"gitHead": "640f36c0c2d9fb1b7768925bf9d64840cbc31bc6"
 }