@remotion/cli 4.0.0-webhook.26 → 4.1.0-alpha1

package/dist/still.js

@@ -1,157 +1,60 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.still = void 0;
-const renderer_1 = require("@remotion/renderer");
-const fs_1 = require("fs");
-const path_1 = __importDefault(require("path"));
-const chalk_1 = require("./chalk");
-const config_1 = require("./config");
-const determine_image_format_1 = require("./determine-image-format");
+const cleanup_before_quit_1 = require("./cleanup-before-quit");
+const convert_entry_point_to_serve_url_1 = require("./convert-entry-point-to-serve-url");
+const entry_point_1 = require("./entry-point");
 const get_cli_options_1 = require("./get-cli-options");
-const get_composition_id_1 = require("./get-composition-id");
 const log_1 = require("./log");
 const parse_command_line_1 = require("./parse-command-line");
-const progress_bar_1 = require("./progress-bar");
-const setup_cache_1 = require("./setup-cache");
-const truthy_1 = require("./truthy");
-const user_passed_output_location_1 = require("./user-passed-output-location");
-const still = async (remotionRoot) => {
-    var _a, _b;
-    const startTime = Date.now();
-    const file = parse_command_line_1.parsedCli._[1];
-    const fullPath = renderer_1.RenderInternals.isServeUrl(file)
-        ? file
-        : path_1.default.join(process.cwd(), file);
+const still_1 = require("./render-flows/still");
+const still = async (remotionRoot, args) => {
+    const { file, remainingArgs, reason: entryPointReason, } = (0, entry_point_1.findEntryPoint)(args, remotionRoot);
+    if (!file) {
+        log_1.Log.error('No entry point specified. Pass more arguments:');
+        log_1.Log.error('   npx remotion render [entry-point] [composition-name] [out-name]');
+        log_1.Log.error('Documentation: https://www.remotion.dev/docs/render');
+        process.exit(1);
+    }
+    const fullEntryPoint = (0, convert_entry_point_to_serve_url_1.convertEntryPointToServeUrl)(file);
     if (parse_command_line_1.parsedCli.frames) {
         log_1.Log.error('--frames flag was passed to the `still` command. This flag only works with the `render` command. Did you mean `--frame`? See reference: https://www.remotion.dev/docs/cli/');
         process.exit(1);
     }
-    const { inputProps, envVariables, quality, browser, stillFrame, browserExecutable, chromiumOptions, scale, ffmpegExecutable, ffprobeExecutable, overwrite, puppeteerTimeout, port, publicDir, } = await (0, get_cli_options_1.getCliOptions)({
+    const { browser, browserExecutable, chromiumOptions, envVariables, height, inputProps, overwrite, port, publicDir, puppeteerTimeout, jpegQuality, scale, stillFrame, width, logLevel, } = await (0, get_cli_options_1.getCliOptions)({
         isLambda: false,
         type: 'still',
-        codec: 'h264',
-    });
-    log_1.Log.verbose('Browser executable: ', browserExecutable);
-    const compositionId = (0, get_composition_id_1.getCompositionId)();
-    const { format: imageFormat, source } = (0, determine_image_format_1.determineFinalImageFormat)({
-        cliFlag: (_a = parse_command_line_1.parsedCli['image-format']) !== null && _a !== void 0 ? _a : null,
-        configImageFormat: (_b = config_1.ConfigInternals.getUserPreferredImageFormat()) !== null && _b !== void 0 ? _b : null,
-        downloadName: null,
-        outName: (0, user_passed_output_location_1.getUserPassedOutputLocation)(),
-        isLambda: false,
+        remotionRoot,
     });
-    const relativeOutputLocation = (0, user_passed_output_location_1.getOutputLocation)({
-        compositionId,
-        defaultExtension: imageFormat,
-    });
-    const absoluteOutputLocation = (0, get_cli_options_1.getAndValidateAbsoluteOutputFile)(relativeOutputLocation, overwrite);
-    log_1.Log.info(chalk_1.chalk.gray(`Output = ${relativeOutputLocation}, Format = ${imageFormat} (${source}), Composition = ${compositionId}`));
-    const browserInstance = (0, renderer_1.openBrowser)(browser, {
+    await (0, still_1.renderStillFlow)({
+        remotionRoot,
+        entryPointReason,
+        fullEntryPoint,
+        remainingArgs,
+        browser,
         browserExecutable,
         chromiumOptions,
-        shouldDumpIo: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
-        forceDeviceScaleFactor: scale,
-    });
-    (0, fs_1.mkdirSync)(path_1.default.join(absoluteOutputLocation, '..'), {
-        recursive: true,
-    });
-    const steps = [
-        renderer_1.RenderInternals.isServeUrl(fullPath) ? null : 'bundling',
-        'rendering',
-    ].filter(truthy_1.truthy);
-    const { cleanup: cleanupBundle, urlOrBundle } = await (0, setup_cache_1.bundleOnCliOrTakeServeUrl)({ fullPath, remotionRoot, steps, publicDir });
-    const puppeteerInstance = await browserInstance;
-    const downloadMap = renderer_1.RenderInternals.makeDownloadMap();
-    const comps = await (0, renderer_1.getCompositions)(urlOrBundle, {
-        inputProps,
-        puppeteerInstance,
         envVariables,
-        timeoutInMilliseconds: puppeteerTimeout,
-        chromiumOptions,
-        port,
-        browserExecutable,
-        ffmpegExecutable,
-        ffprobeExecutable,
-        downloadMap,
-    });
-    const composition = comps.find((c) => c.id === compositionId);
-    if (!composition) {
-        throw new Error(`Cannot find composition with ID ${compositionId}`);
-    }
-    const renderProgress = (0, progress_bar_1.createOverwriteableCliOutput)((0, parse_command_line_1.quietFlagProvided)());
-    const renderStart = Date.now();
-    const downloads = [];
-    let frames = 0;
-    const totalFrames = 1;
-    const updateProgress = () => {
-        renderProgress.update((0, progress_bar_1.makeRenderingAndStitchingProgress)({
-            rendering: {
-                frames,
-                concurrency: 1,
-                doneIn: frames === totalFrames ? Date.now() - renderStart : null,
-                steps,
-                totalFrames,
-            },
-            downloads,
-            stitching: null,
-        }));
-    };
-    updateProgress();
-    const onDownload = (src) => {
-        const id = Math.random();
-        const download = {
-            id,
-            name: src,
-            progress: 0,
-            downloaded: 0,
-            totalBytes: null,
-        };
-        downloads.push(download);
-        updateProgress();
-        return ({ percent }) => {
-            download.progress = percent;
-            updateProgress();
-        };
-    };
-    await (0, renderer_1.renderStill)({
-        composition,
-        frame: stillFrame,
-        output: absoluteOutputLocation,
-        serveUrl: urlOrBundle,
-        quality,
-        dumpBrowserLogs: renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'verbose'),
-        envVariables,
-        imageFormat,
+        height,
         inputProps,
-        chromiumOptions,
-        timeoutInMilliseconds: config_1.ConfigInternals.getCurrentPuppeteerTimeout(),
-        scale,
-        ffmpegExecutable,
-        browserExecutable,
         overwrite,
-        onDownload,
         port,
-        downloadMap,
+        publicDir,
+        puppeteerTimeout,
+        jpegQuality,
+        scale,
+        stillFrame,
+        width,
+        compositionIdFromUi: null,
+        imageFormatFromUi: null,
+        logLevel,
+        onProgress: () => undefined,
+        indentOutput: false,
+        addCleanupCallback: (c) => {
+            (0, cleanup_before_quit_1.registerCleanupJob)(c);
+        },
+        cancelSignal: null,
+        outputLocationFromUi: null,
     });
-    frames = 1;
-    updateProgress();
-    log_1.Log.info();
-    const closeBrowserPromise = puppeteerInstance.close();
-    log_1.Log.info(chalk_1.chalk.green('\nYour still frame is ready!'));
-    const seconds = Math.round((Date.now() - startTime) / 1000);
-    log_1.Log.info([
-        '- Total render time:',
-        seconds,
-        seconds === 1 ? 'second' : 'seconds',
-    ].join(' '));
-    log_1.Log.info('-', 'Output can be found at:');
-    log_1.Log.info(chalk_1.chalk.cyan(`▶️ ${absoluteOutputLocation}`));
-    await closeBrowserPromise;
-    await renderer_1.RenderInternals.cleanDownloadMap(downloadMap);
-    await cleanupBundle();
-    log_1.Log.verbose('Cleaned up', downloadMap.assetDir);
 };
 exports.still = still;

package/dist/studio.d.ts

@@ -0,0 +1 @@
+export declare const studioCommand: (remotionRoot: string, args: string[]) => Promise<void>;

package/dist/studio.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.studioCommand = void 0;
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const node_path_1 = __importDefault(require("node:path"));
+const better_opn_1 = require("./better-opn");
+const chalk_1 = require("./chalk");
+const config_1 = require("./config");
+const convert_entry_point_to_serve_url_1 = require("./convert-entry-point-to-serve-url");
+const entry_point_1 = require("./entry-point");
+const get_env_1 = require("./get-env");
+const get_input_props_1 = require("./get-input-props");
+const get_network_address_1 = require("./get-network-address");
+const log_1 = require("./log");
+const parse_command_line_1 = require("./parse-command-line");
+const get_absolute_public_dir_1 = require("./preview-server/get-absolute-public-dir");
+const live_events_1 = require("./preview-server/live-events");
+const public_folder_1 = require("./preview-server/public-folder");
+const start_server_1 = require("./preview-server/start-server");
+const server_ready_comment_1 = require("./server-ready-comment");
+const watch_root_file_1 = require("./watch-root-file");
+const noop = () => undefined;
+const getShouldOpenBrowser = () => {
+    var _a;
+    if (parse_command_line_1.parsedCli['no-open']) {
+        return {
+            shouldOpenBrowser: false,
+            reasonForBrowserDecision: '--no-open specified',
+        };
+    }
+    if (((_a = process.env.BROWSER) !== null && _a !== void 0 ? _a : '').toLowerCase() === 'none') {
+        return {
+            shouldOpenBrowser: false,
+            reasonForBrowserDecision: 'env BROWSER=none was set',
+        };
+    }
+    if (config_1.ConfigInternals.getShouldOpenBrowser() === false) {
+        return { shouldOpenBrowser: false, reasonForBrowserDecision: 'Config file' };
+    }
+    return { shouldOpenBrowser: true, reasonForBrowserDecision: 'default' };
+};
+const getPort = () => {
+    if (parse_command_line_1.parsedCli.port) {
+        return parse_command_line_1.parsedCli.port;
+    }
+    const serverPort = config_1.ConfigInternals.getServerPort();
+    if (serverPort) {
+        return serverPort;
+    }
+    return null;
+};
+const studioCommand = async (remotionRoot, args) => {
+    const { file, reason } = (0, entry_point_1.findEntryPoint)(args, remotionRoot);
+    log_1.Log.verbose('Entry point:', file, 'reason:', reason);
+    if (!file) {
+        log_1.Log.error('No Remotion entrypoint was found. Specify an additional argument manually:');
+        log_1.Log.error('  npx remotion studio src/index.ts');
+        log_1.Log.error('See https://www.remotion.dev/docs/register-root for more information.');
+        process.exit(1);
+    }
+    const desiredPort = getPort();
+    const fullEntryPath = (0, convert_entry_point_to_serve_url_1.convertEntryPointToServeUrl)(file);
+    let inputProps = (0, get_input_props_1.getInputProps)((newProps) => {
+        (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+            inputProps = newProps;
+            listener.sendEventToClient({
+                type: 'new-input-props',
+                newProps,
+            });
+        });
+    });
+    let envVariables = await (0, get_env_1.getEnvironmentVariables)((newEnvVariables) => {
+        (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+            envVariables = newEnvVariables;
+            listener.sendEventToClient({
+                type: 'new-env-variables',
+                newEnvVariables,
+            });
+        });
+    });
+    const publicDir = (0, get_absolute_public_dir_1.getAbsolutePublicDir)({
+        userPassedPublicDir: config_1.ConfigInternals.getPublicDir(),
+        remotionRoot,
+    });
+    const hashPrefix = '/static-';
+    const staticHash = `${hashPrefix}${node_crypto_1.default.randomBytes(6).toString('hex')}`;
+    (0, public_folder_1.initPublicFolderWatch)({
+        publicDir,
+        remotionRoot,
+        onUpdate: () => {
+            (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+                listener.sendEventToClient({
+                    type: 'new-public-folder',
+                    files: (0, public_folder_1.getFiles)(),
+                });
+            });
+        },
+        staticHash,
+    });
+    (0, watch_root_file_1.watchRootFile)(remotionRoot);
+    const { port, liveEventsServer } = await (0, start_server_1.startServer)({
+        entry: node_path_1.default.resolve(__dirname, 'previewEntry.js'),
+        userDefinedComponent: fullEntryPath,
+        getCurrentInputProps: () => inputProps,
+        getEnvVariables: () => envVariables,
+        port: desiredPort,
+        maxTimelineTracks: config_1.ConfigInternals.getMaxTimelineTracks(),
+        remotionRoot,
+        keyboardShortcutsEnabled: config_1.ConfigInternals.getKeyboardShortcutsEnabled(),
+        publicDir,
+        webpackOverride: config_1.ConfigInternals.getWebpackOverrideFn(),
+        poll: config_1.ConfigInternals.getWebpackPolling(),
+        userPassedPublicDir: config_1.ConfigInternals.getPublicDir(),
+        hash: staticHash,
+        hashPrefix,
+    });
+    (0, live_events_1.setLiveEventsListener)(liveEventsServer);
+    const networkAddress = (0, get_network_address_1.getNetworkAddress)();
+    if (networkAddress) {
+        (0, server_ready_comment_1.setServerReadyComment)(`Local: ${chalk_1.chalk.underline(`http://localhost:${port}`)}, Network: ${chalk_1.chalk.underline(`http://${networkAddress}:${port}`)}`);
+    }
+    else {
+        (0, server_ready_comment_1.setServerReadyComment)(`http://localhost:${port}`);
+    }
+    (0, server_ready_comment_1.printServerReadyComment)('Server ready');
+    const { reasonForBrowserDecision, shouldOpenBrowser } = getShouldOpenBrowser();
+    if (shouldOpenBrowser) {
+        await (0, better_opn_1.openBrowser)({
+            url: `http://localhost:${port}`,
+            browserArgs: parse_command_line_1.parsedCli['browser-args'],
+            browserFlag: parse_command_line_1.parsedCli.browser,
+        });
+    }
+    else {
+        log_1.Log.verbose(`Not opening browser, reason: ${reasonForBrowserDecision}`);
+    }
+    await new Promise(noop);
+};
+exports.studioCommand = studioCommand;

package/dist/truthy.d.ts

@@ -1,3 +1,3 @@
-declare type Truthy<T> = T extends false | '' | 0 | null | undefined ? never : T;
+type Truthy<T> = T extends false | '' | 0 | null | undefined ? never : T;
 export declare function truthy<T>(value: T): value is Truthy<T>;
 export {};

package/dist/upgrade.d.ts

@@ -1 +1 @@
-export declare const upgrade: (remotionRoot: string) => Promise<void>;
+export declare const upgrade: (remotionRoot: string, packageManager: string | undefined) => Promise<void>;

package/dist/upgrade.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.upgrade = void 0;
 const renderer_1 = require("@remotion/renderer");
-const path_1 = __importDefault(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 const config_1 = require("./config");
 const get_latest_remotion_version_1 = require("./get-latest-remotion-version");
 const list_of_remotion_packages_1 = require("./list-of-remotion-packages");
@@ -20,19 +20,26 @@ const getUpgradeCommand = ({ manager, packages, version, }) => {
     };
     return commands[manager];
 };
-const upgrade = async (remotionRoot) => {
-    var _a;
-    const packageJsonFilePath = path_1.default.join(remotionRoot, 'package.json');
+const upgrade = async (remotionRoot, packageManager) => {
+    var _a, _b, _c, _d;
+    const packageJsonFilePath = node_path_1.default.join(remotionRoot, 'package.json');
     const packageJson = require(packageJsonFilePath);
     const dependencies = Object.keys(packageJson.dependencies);
+    const devDependencies = Object.keys((_a = packageJson.devDependencies) !== null && _a !== void 0 ? _a : {});
+    const optionalDependencies = Object.keys((_b = packageJson.optionalDependencies) !== null && _b !== void 0 ? _b : {});
+    const peerDependencies = Object.keys((_c = packageJson.peerDependencies) !== null && _c !== void 0 ? _c : {});
     const latestRemotionVersion = await (0, get_latest_remotion_version_1.getLatestRemotionVersion)();
-    const manager = (0, get_package_manager_1.getPackageManager)(remotionRoot);
+    log_1.Log.info('Newest Remotion version is', latestRemotionVersion);
+    const manager = (0, get_package_manager_1.getPackageManager)(remotionRoot, packageManager);
     if (manager === 'unknown') {
         throw new Error(`No lockfile was found in your project (one of ${get_package_manager_1.lockFilePaths
             .map((p) => p.path)
             .join(', ')}). Install dependencies using your favorite manager!`);
     }
-    const toUpgrade = list_of_remotion_packages_1.listOfRemotionPackages.filter((u) => dependencies.includes(u));
+    const toUpgrade = list_of_remotion_packages_1.listOfRemotionPackages.filter((u) => dependencies.includes(u) ||
+        devDependencies.includes(u) ||
+        optionalDependencies.includes(u) ||
+        peerDependencies.includes(u));
     const prom = renderer_1.RenderInternals.execa(manager.manager, getUpgradeCommand({
         manager: manager.manager,
         packages: toUpgrade,
@@ -41,9 +48,10 @@ const upgrade = async (remotionRoot) => {
         stdio: 'inherit',
     });
     if (renderer_1.RenderInternals.isEqualOrBelowLogLevel(config_1.ConfigInternals.Logging.getLogLevel(), 'info')) {
-        (_a = prom.stdout) === null || _a === void 0 ? void 0 : _a.pipe(process.stdout);
+        (_d = prom.stdout) === null || _d === void 0 ? void 0 : _d.pipe(process.stdout);
     }
     await prom;
     log_1.Log.info('⏫ Remotion has been upgraded!');
+    log_1.Log.info('https://remotion.dev/changelog');
 };
 exports.upgrade = upgrade;

package/dist/user-passed-output-location.d.ts

@@ -1,5 +1,8 @@
-export declare const getUserPassedOutputLocation: () => string | null;
-export declare const getOutputLocation: ({ compositionId, defaultExtension, }: {
+export declare const getUserPassedOutputLocation: (args: string[], uiPassedOutName: string | null) => string;
+export declare const getOutputLocation: ({ compositionId, defaultExtension, args, type, outputLocationFromUi, }: {
     compositionId: string;
+    outputLocationFromUi: string | null;
     defaultExtension: string;
+    args: string[];
+    type: 'asset' | 'sequence';
 }) => string;

package/dist/user-passed-output-location.js

@@ -2,20 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOutputLocation = exports.getUserPassedOutputLocation = void 0;
 const config_1 = require("./config");
+const get_default_out_name_1 = require("./get-default-out-name");
 const parse_command_line_1 = require("./parse-command-line");
-const getUserPassedOutputLocation = () => {
-    const filename = parse_command_line_1.parsedCli._[3]
-        ? parse_command_line_1.parsedCli._[3]
-        : config_1.ConfigInternals.getOutputLocation();
+const getUserPassedOutputLocation = (args, uiPassedOutName) => {
+    var _a, _b;
+    const filename = (_b = (_a = uiPassedOutName !== null && uiPassedOutName !== void 0 ? uiPassedOutName : args[0]) !== null && _a !== void 0 ? _a : parse_command_line_1.parsedCli.output) !== null && _b !== void 0 ? _b : config_1.ConfigInternals.getOutputLocation();
     return filename;
 };
 exports.getUserPassedOutputLocation = getUserPassedOutputLocation;
-const getDefaultOutLocation = ({ compositionName, defaultExtension, }) => {
-    const defaultName = `out/${compositionName}.${defaultExtension}`;
-    return defaultName;
-};
-const getOutputLocation = ({ compositionId, defaultExtension, }) => {
+const getOutputLocation = ({ compositionId, defaultExtension, args, type, outputLocationFromUi, }) => {
     var _a;
-    return ((_a = (0, exports.getUserPassedOutputLocation)()) !== null && _a !== void 0 ? _a : getDefaultOutLocation({ compositionName: compositionId, defaultExtension }));
+    if (typeof args[0] !== 'undefined' &&
+        typeof parse_command_line_1.parsedCli.output !== 'undefined') {
+        throw new Error('Both an output flag (--output) and an output location as a positional argument were passed. Please choose only one of the ways.');
+    }
+    return ((_a = (0, exports.getUserPassedOutputLocation)(args, outputLocationFromUi)) !== null && _a !== void 0 ? _a : (0, get_default_out_name_1.getDefaultOutLocation)({
+        compositionName: compositionId,
+        defaultExtension,
+        type,
+    }));
 };
 exports.getOutputLocation = getOutputLocation;

package/dist/versions.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.versionsCommand = exports.validateVersionsBeforeCommand = exports.VERSIONS_COMMAND = void 0;
 const renderer_1 = require("@remotion/renderer");
-const fs_1 = __importDefault(require("fs"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const config_1 = require("./config");
 const list_of_remotion_packages_1 = require("./list-of-remotion-packages");
 const log_1 = require("./log");
@@ -14,7 +14,7 @@ const resolve_from_1 = require("./resolve-from");
 const getVersion = async (remotionRoot, p) => {
     try {
         const remotionPkgJson = (0, resolve_from_1.resolveFrom)(remotionRoot, `${p}/package.json`);
-        const file = await fs_1.default.promises.readFile(remotionPkgJson, 'utf-8');
+        const file = await node_fs_1.default.promises.readFile(remotionPkgJson, 'utf-8');
         const packageJson = JSON.parse(file);
         return packageJson.version;
     }

package/dist/watch-root-file.d.ts

@@ -0,0 +1 @@
+export declare const watchRootFile: (remotionRoot: string) => Promise<void>;

package/dist/watch-root-file.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchRootFile = void 0;
+const file_watcher_1 = require("./file-watcher");
+const live_events_1 = require("./preview-server/live-events");
+const project_info_1 = require("./preview-server/project-info");
+const watchRootFile = async (remotionRoot) => {
+    const rootFile = await (0, project_info_1.getProjectInfo)(remotionRoot);
+    if (!rootFile.videoFile) {
+        return;
+    }
+    (0, file_watcher_1.installFileWatcher)({
+        file: rootFile.videoFile,
+        onChange: () => {
+            // Don't care if changed, added or deleted - should trigger a refetch in the frontend all the time
+            (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
+                listener.sendEventToClient({ type: 'root-file-changed' });
+            });
+        },
+    });
+};
+exports.watchRootFile = watchRootFile;