@remotion/cli 3.3.83 → 3.3.86

package/dist/preview-server/render-queue/queue.js

@@ -1,208 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processJobIfPossible = exports.cancelJob = exports.removeJob = exports.addJob = exports.processJob = exports.notifyClientsOfJobUpdate = exports.getRenderQueue = void 0;
-const path_1 = __importDefault(require("path"));
-const chalk_1 = require("../../chalk");
-const file_watcher_1 = require("../../file-watcher");
-const handle_common_errors_1 = require("../../handle-common-errors");
-const log_1 = require("../../log");
-const progress_types_1 = require("../../progress-types");
-const live_events_1 = require("../live-events");
-const process_still_1 = require("./process-still");
-const process_video_1 = require("./process-video");
-let jobQueue = [];
-const updateJob = (id, updater) => {
-    jobQueue = jobQueue.map((j) => {
-        if (id === j.id) {
-            return updater(j);
-        }
-        return j;
-    });
-    (0, exports.notifyClientsOfJobUpdate)();
-};
-const getRenderQueue = () => {
-    return jobQueue.map((j) => {
-        const { cleanup, ...rest } = j;
-        return rest;
-    });
-};
-exports.getRenderQueue = getRenderQueue;
-const notifyClientsOfJobUpdate = () => {
-    (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
-        listener.sendEventToClient({
-            type: 'render-queue-updated',
-            queue: (0, exports.getRenderQueue)(),
-        });
-    });
-};
-exports.notifyClientsOfJobUpdate = notifyClientsOfJobUpdate;
-const processJob = async ({ job, remotionRoot, entryPoint, onProgress, addCleanupCallback, }) => {
-    if (job.type === 'still') {
-        await (0, process_still_1.processStill)({
-            job,
-            remotionRoot,
-            entryPoint,
-            onProgress,
-            addCleanupCallback,
-        });
-        return;
-    }
-    if (job.type === 'video') {
-        await (0, process_video_1.processVideoJob)({
-            job,
-            remotionRoot,
-            entryPoint,
-            onProgress,
-            addCleanupCallback,
-        });
-        return;
-    }
-    throw new Error(`Unknown job ${JSON.stringify(job)}`);
-};
-exports.processJob = processJob;
-const addJob = ({ job, entryPoint, remotionRoot, }) => {
-    jobQueue.push(job);
-    (0, exports.processJobIfPossible)({ entryPoint, remotionRoot });
-    (0, exports.notifyClientsOfJobUpdate)();
-};
-exports.addJob = addJob;
-const removeJob = (jobId) => {
-    jobQueue = jobQueue.filter((job) => {
-        if (job.id === jobId) {
-            job.cleanup.forEach((c) => {
-                c();
-            });
-            return false;
-        }
-        return true;
-    });
-    (0, exports.notifyClientsOfJobUpdate)();
-};
-exports.removeJob = removeJob;
-const cancelJob = (jobId) => {
-    for (const job of jobQueue) {
-        if (job.id === jobId) {
-            if (job.status !== 'running') {
-                throw new Error('Job is not running');
-            }
-            job.cancelToken.cancel();
-            break;
-        }
-    }
-};
-exports.cancelJob = cancelJob;
-// TODO: Currently, concurrency = 1 is not enforced
-const processJobIfPossible = async ({ remotionRoot, entryPoint, }) => {
-    const nextJob = jobQueue.find((q) => {
-        return q.status === 'idle';
-    });
-    if (!nextJob) {
-        return;
-    }
-    const jobCleanups = [];
-    try {
-        updateJob(nextJob.id, (job) => {
-            return {
-                ...job,
-                status: 'running',
-                progress: {
-                    value: 0,
-                    message: 'Starting job...',
-                    ...(0, progress_types_1.initialAggregateRenderProgress)(),
-                },
-            };
-        });
-        const startTime = Date.now();
-        log_1.Log.info(chalk_1.chalk.gray('╭─ Starting render '));
-        let lastProgress = null;
-        await (0, exports.processJob)({
-            job: nextJob,
-            entryPoint,
-            remotionRoot,
-            onProgress: (progress) => {
-                updateJob(nextJob.id, (job) => {
-                    lastProgress = progress;
-                    // Ignore late callbacks of progress updates after cancelling
-                    if (job.status === 'failed' || job.status === 'done') {
-                        return job;
-                    }
-                    if (job.type === 'still') {
-                        return {
-                            ...job,
-                            status: 'running',
-                            progress,
-                        };
-                    }
-                    if (job.type === 'video') {
-                        return {
-                            ...job,
-                            status: 'running',
-                            progress,
-                        };
-                    }
-                    throw new Error('Unknown job type');
-                });
-            },
-            addCleanupCallback: (cleanup) => {
-                jobCleanups.push(cleanup);
-            },
-        });
-        log_1.Log.info(chalk_1.chalk.gray('╰─ Done in ' + (Date.now() - startTime) + 'ms.'));
-        const { unwatch } = (0, file_watcher_1.installFileWatcher)({
-            file: path_1.default.resolve(remotionRoot, nextJob.outName),
-            onChange: (type) => {
-                if (type === 'created') {
-                    updateJob(nextJob.id, (job) => ({
-                        ...job,
-                        deletedOutputLocation: false,
-                    }));
-                }
-                if (type === 'deleted') {
-                    updateJob(nextJob.id, (job) => ({
-                        ...job,
-                        deletedOutputLocation: true,
-                    }));
-                }
-            },
-        });
-        updateJob(nextJob.id, (job) => {
-            if (!lastProgress) {
-                throw new Error('expected progress');
-            }
-            return {
-                ...job,
-                status: 'done',
-                cleanup: [...job.cleanup, unwatch],
-                progress: { message: 'Done', value: 1, ...lastProgress },
-            };
-        });
-    }
-    catch (err) {
-        log_1.Log.error(chalk_1.chalk.gray('╰─ '), chalk_1.chalk.red('Failed to render'));
-        updateJob(nextJob.id, (job) => {
-            return {
-                ...job,
-                status: 'failed',
-                error: {
-                    message: err.message,
-                    stack: err.stack,
-                },
-            };
-        });
-        await (0, handle_common_errors_1.handleCommonError)(err);
-        (0, live_events_1.waitForLiveEventsListener)().then((listener) => {
-            listener.sendEventToClient({
-                type: 'render-job-failed',
-                compositionId: nextJob.compositionId,
-                error: err,
-            });
-        });
-    }
-    finally {
-        await Promise.all(jobCleanups.map((c) => c()));
-    }
-};
-exports.processJobIfPossible = processJobIfPossible;

package/dist/preview-server/routes/add-render.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { AddRenderRequest } from '../render-queue/job';
-export declare const handleAddRender: ApiHandler<AddRenderRequest, undefined>;

package/dist/preview-server/routes/add-render.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleAddRender = void 0;
-const renderer_1 = require("@remotion/renderer");
-const queue_1 = require("../render-queue/queue");
-const handleAddRender = ({ input, entryPoint, remotionRoot, }) => {
-    const id = String(Math.random()).replace('0.', '');
-    if (input.type === 'video') {
-        (0, queue_1.addJob)({
-            entryPoint,
-            remotionRoot,
-            job: {
-                cleanup: [],
-                codec: input.codec,
-                audioCodec: input.audioCodec,
-                compositionId: input.compositionId,
-                deletedOutputLocation: false,
-                type: 'video',
-                status: 'idle',
-                id,
-                imageFormat: input.imageFormat,
-                outName: input.outName,
-                jpegQuality: input.jpegQuality,
-                scale: input.scale,
-                startedAt: Date.now(),
-                verbose: input.verbose,
-                cancelToken: (0, renderer_1.makeCancelSignal)(),
-                concurrency: input.concurrency,
-                crf: input.crf,
-                endFrame: input.endFrame,
-                startFrame: input.startFrame,
-                muted: input.muted,
-                enforceAudioTrack: input.enforceAudioTrack,
-                proResProfile: input.proResProfile,
-                pixelFormat: input.pixelFormat,
-                audioBitrate: input.audioBitrate,
-                videoBitrate: input.videoBitrate,
-                everyNthFrame: input.everyNthFrame,
-                numberOfGifLoops: input.numberOfGifLoops,
-                delayRenderTimeout: input.delayRenderTimeout,
-                disallowParallelEncoding: input.disallowParallelEncoding,
-                chromiumOptions: input.chromiumOptions,
-                envVariables: input.envVariables,
-                inputProps: input.inputProps,
-            },
-        });
-    }
-    if (input.type === 'still') {
-        (0, queue_1.addJob)({
-            job: {
-                compositionId: input.compositionId,
-                id: String(Math.random()).replace('0.', ''),
-                startedAt: Date.now(),
-                type: 'still',
-                outName: input.outName,
-                status: 'idle',
-                imageFormat: input.imageFormat,
-                jpegQuality: input.jpegQuality,
-                frame: input.frame,
-                scale: input.scale,
-                cleanup: [],
-                deletedOutputLocation: false,
-                verbose: input.verbose,
-                cancelToken: (0, renderer_1.makeCancelSignal)(),
-                chromiumOptions: input.chromiumOptions,
-                delayRenderTimeout: input.delayRenderTimeout,
-                envVariables: input.envVariables,
-                inputProps: input.inputProps,
-            },
-            entryPoint,
-            remotionRoot,
-        });
-    }
-    return Promise.resolve(undefined);
-};
-exports.handleAddRender = handleAddRender;

package/dist/preview-server/routes/can-update-default-props.d.ts

@@ -1,4 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { CanUpdateDefaultPropsRequest, CanUpdateDefaultPropsResponse } from '../render-queue/job';
-export declare const checkIfTypeScriptFile: (file: string) => void;
-export declare const canUpdateDefaultPropsHandler: ApiHandler<CanUpdateDefaultPropsRequest, CanUpdateDefaultPropsResponse>;

package/dist/preview-server/routes/can-update-default-props.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.canUpdateDefaultPropsHandler = exports.checkIfTypeScriptFile = void 0;
-const fs_1 = require("fs");
-const update_default_props_1 = require("../../codemods/update-default-props");
-const project_info_1 = require("../project-info");
-const checkIfTypeScriptFile = (file) => {
-    if (!file.endsWith('.tsx') &&
-        !file.endsWith('.ts') &&
-        !file.endsWith('.mtsx') &&
-        !file.endsWith('.mts')) {
-        throw new Error('Cannot update default props for non-TypeScript files');
-    }
-};
-exports.checkIfTypeScriptFile = checkIfTypeScriptFile;
-const canUpdateDefaultPropsHandler = async ({ input: { compositionId }, remotionRoot }) => {
-    try {
-        const projectInfo = await (0, project_info_1.getProjectInfo)(remotionRoot);
-        if (!projectInfo.videoFile) {
-            throw new Error('Cannot find root file in project');
-        }
-        (0, exports.checkIfTypeScriptFile)(projectInfo.videoFile);
-        await (0, update_default_props_1.updateDefaultProps)({
-            compositionId,
-            input: (0, fs_1.readFileSync)(projectInfo.videoFile, 'utf-8'),
-            newDefaultProps: {},
-        });
-        return {
-            canUpdate: true,
-        };
-    }
-    catch (err) {
-        return {
-            canUpdate: false,
-            reason: err.message,
-        };
-    }
-};
-exports.canUpdateDefaultPropsHandler = canUpdateDefaultPropsHandler;

package/dist/preview-server/routes/cancel-render.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { CancelRenderRequest, CancelRenderResponse } from '../render-queue/job';
-export declare const handleCancelRender: ApiHandler<CancelRenderRequest, CancelRenderResponse>;

package/dist/preview-server/routes/cancel-render.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleCancelRender = void 0;
-const queue_1 = require("../render-queue/queue");
-const handleCancelRender = ({ input: { jobId } }) => {
-    (0, queue_1.cancelJob)(jobId);
-    return Promise.resolve({});
-};
-exports.handleCancelRender = handleCancelRender;

package/dist/preview-server/routes/open-in-file-explorer.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { OpenInFileExplorerRequest } from '../render-queue/job';
-export declare const handleOpenInFileExplorer: ApiHandler<OpenInFileExplorerRequest, void>;

package/dist/preview-server/routes/open-in-file-explorer.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleOpenInFileExplorer = void 0;
-const open_directory_in_finder_1 = require("../render-queue/open-directory-in-finder");
-const handleOpenInFileExplorer = ({ input: { directory }, remotionRoot }) => {
-    return (0, open_directory_in_finder_1.openDirectoryInFinder)(directory, remotionRoot);
-};
-exports.handleOpenInFileExplorer = handleOpenInFileExplorer;

package/dist/preview-server/routes/remove-render.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { RemoveRenderRequest } from '../render-queue/job';
-export declare const handleRemoveRender: ApiHandler<RemoveRenderRequest, undefined>;

package/dist/preview-server/routes/remove-render.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleRemoveRender = void 0;
-const queue_1 = require("../render-queue/queue");
-const handleRemoveRender = ({ input: { jobId }, }) => {
-    (0, queue_1.removeJob)(jobId);
-    return Promise.resolve(undefined);
-};
-exports.handleRemoveRender = handleRemoveRender;

package/dist/preview-server/routes/subscribe-to-file-existence.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { SubscribeToFileExistenceRequest, SubscribeToFileExistenceResponse } from '../render-queue/job';
-export declare const subscribeToFileExistence: ApiHandler<SubscribeToFileExistenceRequest, SubscribeToFileExistenceResponse>;

package/dist/preview-server/routes/subscribe-to-file-existence.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.subscribeToFileExistence = void 0;
-const file_existence_watchers_1 = require("../file-existence-watchers");
-const subscribeToFileExistence = ({ input: { file, clientId }, remotionRoot }) => {
-    const { exists } = (0, file_existence_watchers_1.subscribeToFileExistenceWatchers)({
-        file,
-        remotionRoot,
-        clientId,
-    });
-    return Promise.resolve({ exists });
-};
-exports.subscribeToFileExistence = subscribeToFileExistence;

package/dist/preview-server/routes/unsubscribe-from-file-existence.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { UnsubscribeFromFileExistenceRequest } from '../render-queue/job';
-export declare const unsubscribeFromFileExistence: ApiHandler<UnsubscribeFromFileExistenceRequest, undefined>;

package/dist/preview-server/routes/unsubscribe-from-file-existence.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unsubscribeFromFileExistence = void 0;
-const file_existence_watchers_1 = require("../file-existence-watchers");
-const unsubscribeFromFileExistence = ({ input, remotionRoot }) => {
-    (0, file_existence_watchers_1.unsubscribeFromFileExistenceWatchers)({
-        file: input.file,
-        clientId: input.clientId,
-        remotionRoot,
-    });
-    return Promise.resolve(undefined);
-};
-exports.unsubscribeFromFileExistence = unsubscribeFromFileExistence;

package/dist/preview-server/routes/update-default-props.d.ts

@@ -1,3 +0,0 @@
-import type { ApiHandler } from '../api-types';
-import type { UpdateDefaultPropsRequest } from '../render-queue/job';
-export declare const updateDefaultPropsHandler: ApiHandler<UpdateDefaultPropsRequest, void>;

package/dist/preview-server/routes/update-default-props.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateDefaultPropsHandler = void 0;
-const fs_1 = require("fs");
-const update_default_props_1 = require("../../codemods/update-default-props");
-const date_serialization_1 = require("../../editor/components/RenderModal/SchemaEditor/date-serialization");
-const project_info_1 = require("../project-info");
-const can_update_default_props_1 = require("./can-update-default-props");
-const updateDefaultPropsHandler = async ({ input: { compositionId, defaultProps }, remotionRoot }) => {
-    const projectInfo = await (0, project_info_1.getProjectInfo)(remotionRoot);
-    // TODO: What happens if this error is thrown? Handle in frontend
-    if (!projectInfo.videoFile) {
-        throw new Error('Cannot find root file in project');
-    }
-    (0, can_update_default_props_1.checkIfTypeScriptFile)(projectInfo.videoFile);
-    // TODO: Pass error to frontend
-    const updated = await (0, update_default_props_1.updateDefaultProps)({
-        compositionId,
-        input: (0, fs_1.readFileSync)(projectInfo.videoFile, 'utf-8'),
-        newDefaultProps: (0, date_serialization_1.deserializeJSONWithDate)(defaultProps),
-    });
-    (0, fs_1.writeFileSync)(projectInfo.videoFile, updated);
-};
-exports.updateDefaultPropsHandler = updateDefaultPropsHandler;

package/dist/progress-types.d.ts

@@ -1,32 +0,0 @@
-import type { Codec, StitchingState } from '@remotion/renderer';
-import type { BundlingState, CopyingState } from './progress-bar';
-import type { RenderStep } from './step';
-export declare type DownloadProgress = {
-    name: string;
-    id: number;
-    progress: number | null;
-    totalBytes: number | null;
-    downloaded: number;
-};
-export declare type RenderingProgressInput = {
-    frames: number;
-    totalFrames: number;
-    steps: RenderStep[];
-    concurrency: number;
-    doneIn: number | null;
-};
-export declare type StitchingProgressInput = {
-    frames: number;
-    totalFrames: number;
-    doneIn: number | null;
-    stage: StitchingState;
-    codec: Codec;
-};
-export declare type AggregateRenderProgress = {
-    rendering: RenderingProgressInput | null;
-    stitching: StitchingProgressInput | null;
-    downloads: DownloadProgress[];
-    bundling: BundlingState;
-    copyingState: CopyingState;
-};
-export declare const initialAggregateRenderProgress: () => AggregateRenderProgress;

package/dist/progress-types.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialAggregateRenderProgress = void 0;
-const initialAggregateRenderProgress = () => ({
-    rendering: null,
-    downloads: [],
-    stitching: null,
-    bundling: {
-        progress: 0,
-        doneIn: null,
-    },
-    copyingState: {
-        bytes: 0,
-        doneIn: null,
-    },
-});
-exports.initialAggregateRenderProgress = initialAggregateRenderProgress;

package/dist/render-flows/render.d.ts

@@ -1,47 +0,0 @@
-import type { AudioCodec, Browser, BrowserExecutable, CancelSignal, ChromiumOptions, Codec, Crf, FfmpegOverrideFn, FrameRange, LogLevel, PixelFormat, ProResProfile, VideoImageFormat } from '@remotion/renderer';
-import type { Loop } from '../config/number-of-gif-loops';
-import type { JobProgressCallback } from '../preview-server/render-queue/job';
-export declare const renderVideoFlow: ({ remotionRoot, fullEntryPoint, indent, logLevel, browserExecutable, browser, chromiumOptions, scale, shouldOutputImageSequence, publicDir, inputProps, envVariables, puppeteerTimeout, port, height, width, remainingArgs, compositionIdFromUi, entryPointReason, overwrite, quiet, concurrency, frameRange, everyNthFrame, outputLocationFromUI, jpegQuality, onProgress, addCleanupCallback, cancelSignal, crf, uiCodec, uiImageFormat, ffmpegOverride, audioBitrate, muted, enforceAudioTrack, proResProfile, pixelFormat, videoBitrate, numberOfGifLoops, audioCodec, disallowParallelEncoding, }: {
-    remotionRoot: string;
-    fullEntryPoint: string;
-    entryPointReason: string;
-    browserExecutable: BrowserExecutable;
-    chromiumOptions: ChromiumOptions;
-    logLevel: LogLevel;
-    browser: Browser;
-    scale: number;
-    indent: boolean;
-    shouldOutputImageSequence: boolean;
-    publicDir: string | null;
-    inputProps: object;
-    envVariables: Record<string, string>;
-    puppeteerTimeout: number;
-    port: number | null;
-    height: number | null;
-    width: number | null;
-    remainingArgs: string[];
-    compositionIdFromUi: string | null;
-    outputLocationFromUI: string | null;
-    overwrite: boolean;
-    quiet: boolean;
-    concurrency: number | string | null;
-    frameRange: FrameRange | null;
-    everyNthFrame: number;
-    jpegQuality: number | undefined;
-    onProgress: JobProgressCallback;
-    addCleanupCallback: (cb: () => void) => void;
-    crf: Crf | null;
-    cancelSignal: CancelSignal | null;
-    uiCodec: Codec | null;
-    uiImageFormat: VideoImageFormat | null;
-    ffmpegOverride: FfmpegOverrideFn;
-    audioBitrate: string | null;
-    videoBitrate: string | null;
-    muted: boolean;
-    enforceAudioTrack: boolean;
-    proResProfile: ProResProfile | undefined;
-    pixelFormat: PixelFormat;
-    numberOfGifLoops: Loop;
-    audioCodec: AudioCodec | null;
-    disallowParallelEncoding: boolean;
-}) => Promise<void>;