Skip to content

🎥 Make videos programmatically with React

Split composition edit handlers by operation

JonnyBurger0807574e716c
diff --git a/packages/studio-server/src/preview-server/api-routes.ts b/packages/studio-server/src/preview-server/api-routes.ts
index 177ddbae32..a19017eb63 100644
--- a/packages/studio-server/src/preview-server/api-routes.ts
+++ b/packages/studio-server/src/preview-server/api-routes.ts
@@ -1,7 +1,9 @@
import type {ApiRoutes} from '@remotion/studio-shared';
import type {ApiHandler} from './api-types';
+import {addCompositionHandler} from './routes/add-composition';
import {addEffectHandler} from './routes/add-effect';
import {addEffectKeyframeHandler} from './routes/add-effect-keyframe';
+import {addFolderHandler} from './routes/add-folder';
import {addKeyframesHandler} from './routes/add-keyframes';
import {handleAddRender} from './routes/add-render';
import {addSequenceKeyframeHandler} from './routes/add-sequence-keyframe';
@@ -9,18 +11,6 @@ import {applyVisualControlHandler} from './routes/apply-visual-control-change';
import {batchUpdateKeyframeSettingsHandler} from './routes/batch-update-keyframe-settings';
import {handleCancelRender} from './routes/cancel-render';
import {compositionComponentInfoHandler} from './routes/composition-component-info';
-import {
- addCompositionHandler,
- addFolderHandler,
- deleteCompositionHandler,
- duplicateCompositionHandler,
- moveCompositionHandler,
- moveFolderHandler,
- renameCompositionHandler,
- renameFolderHandler,
- unwrapFolderHandler,
- updateCompositionMetadataHandler,
-} from './routes/composition-edits';
import {convertFigmaClipboardToSvgHandler} from './routes/convert-figma-clipboard-to-svg';
import {copyRenderOutputToAssetHandler} from './routes/copy-render-output-to-asset';
import {
@@ -28,11 +18,13 @@ import {
openInCodingAgentHandler,
} from './routes/default-coding-agent';
import {getDefaultEditorInfoHandler} from './routes/default-editor';
+import {deleteCompositionHandler} from './routes/delete-composition';
import {deleteEffectHandler} from './routes/delete-effect';
import {deleteKeyframesHandler} from './routes/delete-keyframes';
import {deleteNodesHandler} from './routes/delete-nodes';
import {deleteStaticFileHandler} from './routes/delete-static-file';
import {downloadRemoteAssetHandler} from './routes/download-remote-asset';
+import {duplicateCompositionHandler} from './routes/duplicate-composition';
import {duplicateEffectHandler} from './routes/duplicate-effect';
import {duplicateNodesHandler} from './routes/duplicate-nodes';
import {findInFileHandler} from './routes/find-in-file';
@@ -45,6 +37,8 @@ import {
} from './routes/install-remotion-skill';
import {invalidateBundleHandler} from './routes/invalidate-bundle';
import {logStudioErrorHandler} from './routes/log-studio-error';
+import {moveCompositionHandler} from './routes/move-composition';
+import {moveFolderHandler} from './routes/move-folder';
import {moveKeyframesHandler} from './routes/move-keyframes';
import {openInEditorHandler} from './routes/open-in-editor';
import {handleOpenInFileExplorer} from './routes/open-in-file-explorer';
@@ -59,6 +53,8 @@ import {registerClientRenderHandler} from './routes/register-client-render';
import {getReleaseNotesHandler} from './routes/release-notes';
import {remotionSkillsInfoHandler} from './routes/remotion-skills-info';
import {handleRemoveRender} from './routes/remove-render';
+import {renameCompositionHandler} from './routes/rename-composition';
+import {renameFolderHandler} from './routes/rename-folder';
import {renameStaticFileHandler} from './routes/rename-static-file';
import {reorderEffectHandler} from './routes/reorder-effect';
import {reorderSequenceHandler} from './routes/reorder-sequence';
@@ -78,7 +74,9 @@ import {unregisterClientRenderHandler} from './routes/unregister-client-render';
import {unsubscribeFromDefaultProps} from './routes/unsubscribe-from-default-props';
import {unsubscribeFromFileExistence} from './routes/unsubscribe-from-file-existence';
import {unsubscribeFromSequenceProps} from './routes/unsubscribe-from-sequence-props';
+import {unwrapFolderHandler} from './routes/unwrap-folder';
import {handleUpdate} from './routes/update-available';
+import {updateCompositionMetadataHandler} from './routes/update-composition-metadata';
import {updateDefaultPropsHandler} from './routes/update-default-props';
import {updateEffectKeyframeSettingsHandler} from './routes/update-effect-keyframe-settings';
import {updateElementInstallTargetHandler} from './routes/update-element-install-target';
diff --git a/packages/studio-server/src/preview-server/routes/add-composition.ts b/packages/studio-server/src/preview-server/routes/add-composition.ts
new file mode 100644
index 0000000000..cb221ecef6
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/add-composition.ts
@@ -0,0 +1,14 @@
+import type {AddCompositionRequest} from '@remotion/studio-shared';
+import {addCompositionToFile} from '../../codemods/add-composition-to-file';
+import {runCompositionEdit} from './run-composition-edit';
+
+export const addCompositionHandler = runCompositionEdit<AddCompositionRequest>({
+ entryType: 'new-composition',
+ getDescription: ({options}) => ({
+ undoMessage: `↩️ Creation of composition "${options.newId}"`,
+ redoMessage: `↪️ Creation of composition "${options.newId}"`,
+ }),
+ getLogMessage: ({options}) => `Created composition "${options.newId}"`,
+ getResult: ({filePath, request}) =>
+ addCompositionToFile({filePath, options: request.options}),
+});
diff --git a/packages/studio-server/src/preview-server/routes/add-folder.ts b/packages/studio-server/src/preview-server/routes/add-folder.ts
new file mode 100644
index 0000000000..c2c67659fb
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/add-folder.ts
@@ -0,0 +1,25 @@
+import {addFolder} from '@remotion/codemods';
+import type {AddFolderRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const addFolderHandler = runCompositionEdit<AddFolderRequest>({
+ entryType: 'new-folder',
+ getDescription: ({folderName, parentName}) => {
+ const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
+ return {
+ undoMessage: `↩️ Creation of folder "${folderPath}"`,
+ redoMessage: `↪️ Creation of folder "${folderPath}"`,
+ };
+ },
+ getLogMessage: ({folderName, parentName}) =>
+ `Created folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
+ getResult: ({filePath, request}) =>
+ addFolder({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ folder: {name: request.folderName, parentName: request.parentName},
+ }),
+});
diff --git a/packages/studio-server/src/preview-server/routes/composition-edits.ts b/packages/studio-server/src/preview-server/routes/composition-edits.ts
deleted file mode 100644
index cfa832cae5..0000000000
--- a/packages/studio-server/src/preview-server/routes/composition-edits.ts
+++ /dev/null
@@ -1,426 +0,0 @@
-import {existsSync, readFileSync} from 'node:fs';
-import path from 'node:path';
-import {
- addFolder,
- deleteComposition,
- duplicateComposition,
- moveComposition,
- moveFolder,
- renameComposition,
- renameFolder,
- unwrapFolder,
- updateCompositionMetadata,
- type CodemodNodeResult,
- type CodemodResult,
- type CompositionDestination as CodemodCompositionDestination,
-} from '@remotion/codemods';
-import {RenderInternals} from '@remotion/renderer';
-import type {
- AddCompositionRequest,
- AddFolderRequest,
- CompositionDestination,
- CompositionEditResponse,
- DeleteCompositionRequest,
- DuplicateCompositionRequest,
- MoveCompositionRequest,
- MoveFolderRequest,
- RenameCompositionRequest,
- RenameFolderRequest,
- SymbolicatedStackFrame,
- UnwrapFolderRequest,
- UpdateCompositionMetadataRequest,
-} from '@remotion/studio-shared';
-import {addCompositionToFile} from '../../codemods/add-composition-to-file';
-import {writeFileAndNotifyFileWatchers} from '../../file-watcher';
-import {resolveFileInsideProject} from '../../helpers/resolve-file-inside-project';
-import type {ApiHandler} from '../api-types';
-import {formatLogFileLocation} from '../format-log-file-location';
-import {getProjectInfo} from '../project-info';
-import {broadcastSequenceNodePathMutation} from '../sequence-node-path-mutation';
-import {
- printUndoHint,
- pushTransactionToUndoStack,
- suppressUndoStackInvalidation,
-} from '../undo-stack';
-import {checkIfTypeScriptFile} from './can-update-default-props';
-import {
- getCodemodTimingPrefix,
- withSourceFileWriteQueue,
-} from './source-file-write-queue';
-
-const resolveCompositionFile = async ({
- entryPoint,
- remotionRoot,
- symbolicatedStack,
-}: {
- entryPoint: string;
- remotionRoot: string;
- symbolicatedStack: SymbolicatedStackFrame | null;
-}) => {
- if (symbolicatedStack?.originalFileName) {
- return resolveFileInsideProject({
- remotionRoot,
- fileName: symbolicatedStack.originalFileName,
- action: 'apply composition edit to',
- }).absolutePath;
- }
-
- const filePath = (await getProjectInfo(remotionRoot, entryPoint)).rootFile;
- if (filePath === null) {
- throw new Error('Cannot find the Remotion root file');
- }
-
- return filePath;
-};
-
-const toCodemodDestination = (
- destination: CompositionDestination,
-): CodemodCompositionDestination =>
- destination.type === 'folder'
- ? {
- type: 'folder',
- folder: {
- name: destination.folderName,
- parentName: destination.parentName,
- },
- }
- : destination.type === 'root'
- ? destination
- : {
- type: destination.type,
- target:
- destination.target.type === 'composition'
- ? destination.target
- : {
- type: 'folder',
- name: destination.target.folderName,
- parentName: destination.target.parentName,
- },
- };
-
-type EditResult = CodemodResult | CodemodNodeResult;
-type UndoEntryType = Parameters<
- typeof pushTransactionToUndoStack
->[0]['entryType'];
-
-const runCompositionEdit = <
- Request extends {
- symbolicatedStack: SymbolicatedStackFrame | null;
- undoRedoNavigation: AddCompositionRequest['undoRedoNavigation'];
- },
->({
- entryType,
- getDescription,
- getLogMessage,
- getResult,
-}: {
- entryType: UndoEntryType;
- getDescription: (request: Request) => {
- undoMessage: string;
- redoMessage: string;
- };
- getLogMessage: (request: Request) => string;
- getResult: (options: {
- filePath: string;
- request: Request;
- }) => EditResult | Promise<EditResult>;
-}): ApiHandler<Request, CompositionEditResponse> => {
- return ({input: request, logLevel, remotionRoot, entryPoint}) =>
- withSourceFileWriteQueue(async () => {
- try {
- const filePath = await resolveCompositionFile({
- entryPoint,
- remotionRoot,
- symbolicatedStack: request.symbolicatedStack,
- });
- checkIfTypeScriptFile(filePath);
- const result = await getResult({filePath, request});
- for (const change of result.changes) {
- const currentContents = existsSync(change.filePath)
- ? readFileSync(change.filePath, 'utf-8')
- : null;
- if (currentContents !== change.previousContents) {
- throw new Error(
- `Source changed before applying codemod: ${change.filePath}`,
- );
- }
- }
-
- const remappings =
- 'nodePathRemappings' in result ? result.nodePathRemappings : [];
- const mutationFiles = [
- ...new Set(remappings.map((remapping) => remapping.filePath)),
- ].map((absolutePath) => ({
- absolutePath,
- remappings: remappings
- .filter((remapping) => remapping.filePath === absolutePath)
- .map(({oldNodePath, newNodePath}) => ({
- oldNodePath,
- newNodePath,
- })),
- }));
- const nodePathMutation =
- mutationFiles.length === 0
- ? null
- : broadcastSequenceNodePathMutation(mutationFiles, null);
-
- if (result.changes.length > 0) {
- const logLine = request.symbolicatedStack?.originalLineNumber ?? 1;
- pushTransactionToUndoStack({
- snapshots: result.changes.map((change) => {
- const fileRemappings = mutationFiles.find(
- (file) => file.absolutePath === change.filePath,
- )?.remappings;
- return {
- filePath: change.filePath,
- oldContents: change.previousContents,
- newContents: change.nextContents,
- logLine: change.filePath === filePath ? logLine : 1,
- nodePathRemappings: fileRemappings ?? null,
- };
- }),
- logLevel,
- remotionRoot,
- description: getDescription(request),
- entryType,
- suppressHmrOnFileRestore: false,
- undoRedoNavigation: request.undoRedoNavigation,
- });
-
- for (const change of result.changes) {
- if (change.nextContents === null) {
- throw new Error('Composition edits cannot remove source files');
- }
-
- suppressUndoStackInvalidation(change.filePath);
- writeFileAndNotifyFileWatchers({
- file: change.filePath,
- content: change.nextContents,
- originatorClientId: undefined,
- metadata: mutationFiles.some(
- (mutation) => mutation.absolutePath === change.filePath,
- )
- ? {skipSequencePropsUpdate: true}
- : null,
- });
- }
-
- const editMessage = `${getCodemodTimingPrefix(logLevel)}${RenderInternals.chalk.blueBright(
- formatLogFileLocation({
- remotionRoot,
- absolutePath: filePath,
- line: logLine,
- }),
- )} ${getLogMessage(request)}`;
- RenderInternals.Log.info({indent: false, logLevel}, editMessage);
- printUndoHint(logLevel);
- }
-
- return {success: true, nodePathMutation};
- } catch (error) {
- return {
- success: false,
- reason: error instanceof Error ? error.message : String(error),
- stack: error instanceof Error ? (error.stack ?? '') : '',
- };
- }
- });
-};
-
-const getProject = (filePath: string) => ({
- files: {[filePath]: readFileSync(filePath, 'utf-8')},
- rootDir: path.dirname(filePath),
-});
-
-export const addCompositionHandler = runCompositionEdit<AddCompositionRequest>({
- entryType: 'new-composition',
- getDescription: ({options}) => ({
- undoMessage: `↩️ Creation of composition "${options.newId}"`,
- redoMessage: `↪️ Creation of composition "${options.newId}"`,
- }),
- getLogMessage: ({options}) => `Created composition "${options.newId}"`,
- getResult: ({filePath, request}) =>
- addCompositionToFile({filePath, options: request.options}),
-});
-
-export const duplicateCompositionHandler =
- runCompositionEdit<DuplicateCompositionRequest>({
- entryType: 'duplicate-composition',
- getDescription: ({idToDuplicate, newId}) => ({
- undoMessage: `↩️ Duplication of composition "${idToDuplicate}" to "${newId}"`,
- redoMessage: `↪️ Duplication of composition "${idToDuplicate}" to "${newId}"`,
- }),
- getLogMessage: ({idToDuplicate, newId}) =>
- `Duplicated composition "${idToDuplicate}" to "${newId}"`,
- getResult: ({filePath, request}) =>
- duplicateComposition({
- project: getProject(filePath),
- compositionFile: filePath,
- compositionId: request.idToDuplicate,
- newId: request.newId,
- tag: request.tag,
- metadata: {
- width: request.newWidth ?? undefined,
- height: request.newHeight ?? undefined,
- fps:
- request.tag === 'Still' ? undefined : (request.newFps ?? undefined),
- durationInFrames:
- request.tag === 'Still'
- ? undefined
- : (request.newDurationInFrames ?? undefined),
- },
- }),
- });
-
-export const renameCompositionHandler =
- runCompositionEdit<RenameCompositionRequest>({
- entryType: 'rename-composition',
- getDescription: ({idToRename, newId}) => ({
- undoMessage: `↩️ Rename of composition "${idToRename}" to "${newId}"`,
- redoMessage: `↪️ Rename of composition "${idToRename}" to "${newId}"`,
- }),
- getLogMessage: ({idToRename, newId}) =>
- `Renamed composition "${idToRename}" to "${newId}"`,
- getResult: ({filePath, request}) =>
- renameComposition({
- project: getProject(filePath),
- compositionFile: filePath,
- compositionId: request.idToRename,
- newId: request.newId,
- }),
- });
-
-export const updateCompositionMetadataHandler =
- runCompositionEdit<UpdateCompositionMetadataRequest>({
- entryType: 'update-composition-metadata',
- getDescription: ({idToUpdate}) => ({
- undoMessage: `↩️ Update of metadata of composition "${idToUpdate}"`,
- redoMessage: `↪️ Update of metadata of composition "${idToUpdate}"`,
- }),
- getLogMessage: ({idToUpdate}) =>
- `Updated metadata of composition "${idToUpdate}"`,
- getResult: ({filePath, request}) =>
- updateCompositionMetadata({
- project: getProject(filePath),
- compositionFile: filePath,
- compositionId: request.idToUpdate,
- metadata: {
- width: request.newWidth ?? undefined,
- height: request.newHeight ?? undefined,
- fps: request.newFps ?? undefined,
- durationInFrames: request.newDurationInFrames ?? undefined,
- },
- }),
- });
-
-export const deleteCompositionHandler =
- runCompositionEdit<DeleteCompositionRequest>({
- entryType: 'delete-composition',
- getDescription: ({idToDelete}) => ({
- undoMessage: `↩️ Deletion of composition "${idToDelete}"`,
- redoMessage: `↪️ Deletion of composition "${idToDelete}"`,
- }),
- getLogMessage: ({idToDelete}) => `Deleted composition "${idToDelete}"`,
- getResult: ({filePath, request}) =>
- deleteComposition({
- project: getProject(filePath),
- compositionFile: filePath,
- compositionId: request.idToDelete,
- }),
- });
-
-export const moveCompositionHandler =
- runCompositionEdit<MoveCompositionRequest>({
- entryType: 'move-composition-or-folder',
- getDescription: ({compositionId}) => ({
- undoMessage: `↩️ Move of composition "${compositionId}"`,
- redoMessage: `↪️ Move of composition "${compositionId}"`,
- }),
- getLogMessage: ({compositionId}) => `Moved composition "${compositionId}"`,
- getResult: ({filePath, request}) =>
- moveComposition({
- project: getProject(filePath),
- compositionFile: filePath,
- compositionId: request.compositionId,
- destination: toCodemodDestination(request.destination),
- }),
- });
-
-export const addFolderHandler = runCompositionEdit<AddFolderRequest>({
- entryType: 'new-folder',
- getDescription: ({folderName, parentName}) => {
- const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
- return {
- undoMessage: `↩️ Creation of folder "${folderPath}"`,
- redoMessage: `↪️ Creation of folder "${folderPath}"`,
- };
- },
- getLogMessage: ({folderName, parentName}) =>
- `Created folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
- getResult: ({filePath, request}) =>
- addFolder({
- project: getProject(filePath),
- compositionFile: filePath,
- folder: {name: request.folderName, parentName: request.parentName},
- }),
-});
-
-export const renameFolderHandler = runCompositionEdit<RenameFolderRequest>({
- entryType: 'rename-folder',
- getDescription: ({folderName, parentName, newName}) => {
- const oldPath = parentName ? `${parentName}/${folderName}` : folderName;
- const newPath = parentName ? `${parentName}/${newName}` : newName;
- return {
- undoMessage: `↩️ Rename of folder "${oldPath}" to "${newPath}"`,
- redoMessage: `↪️ Rename of folder "${oldPath}" to "${newPath}"`,
- };
- },
- getLogMessage: ({folderName, parentName}) =>
- `Renamed folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
- getResult: ({filePath, request}) =>
- renameFolder({
- project: getProject(filePath),
- compositionFile: filePath,
- folder: {name: request.folderName, parentName: request.parentName},
- newName: request.newName,
- }),
-});
-
-export const unwrapFolderHandler = runCompositionEdit<UnwrapFolderRequest>({
- entryType: 'delete-folder',
- getDescription: ({folderName, parentName}) => {
- const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
- return {
- undoMessage: `↩️ Deletion of folder "${folderPath}"`,
- redoMessage: `↪️ Deletion of folder "${folderPath}"`,
- };
- },
- getLogMessage: ({folderName, parentName}) =>
- `Deleted folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
- getResult: ({filePath, request}) =>
- unwrapFolder({
- project: getProject(filePath),
- compositionFile: filePath,
- folder: {name: request.folderName, parentName: request.parentName},
- }),
-});
-
-export const moveFolderHandler = runCompositionEdit<MoveFolderRequest>({
- entryType: 'move-composition-or-folder',
- getDescription: ({folderName, parentName}) => {
- const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
- return {
- undoMessage: `↩️ Move of folder "${folderPath}"`,
- redoMessage: `↪️ Move of folder "${folderPath}"`,
- };
- },
- getLogMessage: ({folderName, parentName}) =>
- `Moved folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
- getResult: ({filePath, request}) =>
- moveFolder({
- project: getProject(filePath),
- compositionFile: filePath,
- folder: {name: request.folderName, parentName: request.parentName},
- destination: toCodemodDestination(request.destination),
- }),
-});
diff --git a/packages/studio-server/src/preview-server/routes/delete-composition.ts b/packages/studio-server/src/preview-server/routes/delete-composition.ts
new file mode 100644
index 0000000000..1addef6ace
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/delete-composition.ts
@@ -0,0 +1,22 @@
+import {deleteComposition} from '@remotion/codemods';
+import type {DeleteCompositionRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const deleteCompositionHandler =
+ runCompositionEdit<DeleteCompositionRequest>({
+ entryType: 'delete-composition',
+ getDescription: ({idToDelete}) => ({
+ undoMessage: `↩️ Deletion of composition "${idToDelete}"`,
+ redoMessage: `↪️ Deletion of composition "${idToDelete}"`,
+ }),
+ getLogMessage: ({idToDelete}) => `Deleted composition "${idToDelete}"`,
+ getResult: ({filePath, request}) =>
+ deleteComposition({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ compositionId: request.idToDelete,
+ }),
+ });
diff --git a/packages/studio-server/src/preview-server/routes/duplicate-composition.ts b/packages/studio-server/src/preview-server/routes/duplicate-composition.ts
new file mode 100644
index 0000000000..84d6b8952f
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/duplicate-composition.ts
@@ -0,0 +1,35 @@
+import {duplicateComposition} from '@remotion/codemods';
+import type {DuplicateCompositionRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const duplicateCompositionHandler =
+ runCompositionEdit<DuplicateCompositionRequest>({
+ entryType: 'duplicate-composition',
+ getDescription: ({idToDuplicate, newId}) => ({
+ undoMessage: `↩️ Duplication of composition "${idToDuplicate}" to "${newId}"`,
+ redoMessage: `↪️ Duplication of composition "${idToDuplicate}" to "${newId}"`,
+ }),
+ getLogMessage: ({idToDuplicate, newId}) =>
+ `Duplicated composition "${idToDuplicate}" to "${newId}"`,
+ getResult: ({filePath, request}) =>
+ duplicateComposition({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ compositionId: request.idToDuplicate,
+ newId: request.newId,
+ tag: request.tag,
+ metadata: {
+ width: request.newWidth ?? undefined,
+ height: request.newHeight ?? undefined,
+ fps:
+ request.tag === 'Still' ? undefined : (request.newFps ?? undefined),
+ durationInFrames:
+ request.tag === 'Still'
+ ? undefined
+ : (request.newDurationInFrames ?? undefined),
+ },
+ }),
+ });
diff --git a/packages/studio-server/src/preview-server/routes/move-composition.ts b/packages/studio-server/src/preview-server/routes/move-composition.ts
new file mode 100644
index 0000000000..5b346dd641
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/move-composition.ts
@@ -0,0 +1,24 @@
+import {moveComposition} from '@remotion/codemods';
+import type {MoveCompositionRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+ toCodemodDestination,
+} from './run-composition-edit';
+
+export const moveCompositionHandler =
+ runCompositionEdit<MoveCompositionRequest>({
+ entryType: 'move-composition-or-folder',
+ getDescription: ({compositionId}) => ({
+ undoMessage: `↩️ Move of composition "${compositionId}"`,
+ redoMessage: `↪️ Move of composition "${compositionId}"`,
+ }),
+ getLogMessage: ({compositionId}) => `Moved composition "${compositionId}"`,
+ getResult: ({filePath, request}) =>
+ moveComposition({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ compositionId: request.compositionId,
+ destination: toCodemodDestination(request.destination),
+ }),
+ });
diff --git a/packages/studio-server/src/preview-server/routes/move-folder.ts b/packages/studio-server/src/preview-server/routes/move-folder.ts
new file mode 100644
index 0000000000..c3648365d2
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/move-folder.ts
@@ -0,0 +1,27 @@
+import {moveFolder} from '@remotion/codemods';
+import type {MoveFolderRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+ toCodemodDestination,
+} from './run-composition-edit';
+
+export const moveFolderHandler = runCompositionEdit<MoveFolderRequest>({
+ entryType: 'move-composition-or-folder',
+ getDescription: ({folderName, parentName}) => {
+ const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
+ return {
+ undoMessage: `↩️ Move of folder "${folderPath}"`,
+ redoMessage: `↪️ Move of folder "${folderPath}"`,
+ };
+ },
+ getLogMessage: ({folderName, parentName}) =>
+ `Moved folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
+ getResult: ({filePath, request}) =>
+ moveFolder({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ folder: {name: request.folderName, parentName: request.parentName},
+ destination: toCodemodDestination(request.destination),
+ }),
+});
diff --git a/packages/studio-server/src/preview-server/routes/rename-composition.ts b/packages/studio-server/src/preview-server/routes/rename-composition.ts
new file mode 100644
index 0000000000..73896ec03e
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/rename-composition.ts
@@ -0,0 +1,24 @@
+import {renameComposition} from '@remotion/codemods';
+import type {RenameCompositionRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const renameCompositionHandler =
+ runCompositionEdit<RenameCompositionRequest>({
+ entryType: 'rename-composition',
+ getDescription: ({idToRename, newId}) => ({
+ undoMessage: `↩️ Rename of composition "${idToRename}" to "${newId}"`,
+ redoMessage: `↪️ Rename of composition "${idToRename}" to "${newId}"`,
+ }),
+ getLogMessage: ({idToRename, newId}) =>
+ `Renamed composition "${idToRename}" to "${newId}"`,
+ getResult: ({filePath, request}) =>
+ renameComposition({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ compositionId: request.idToRename,
+ newId: request.newId,
+ }),
+ });
diff --git a/packages/studio-server/src/preview-server/routes/rename-folder.ts b/packages/studio-server/src/preview-server/routes/rename-folder.ts
new file mode 100644
index 0000000000..fb51bf35d6
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/rename-folder.ts
@@ -0,0 +1,27 @@
+import {renameFolder} from '@remotion/codemods';
+import type {RenameFolderRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const renameFolderHandler = runCompositionEdit<RenameFolderRequest>({
+ entryType: 'rename-folder',
+ getDescription: ({folderName, parentName, newName}) => {
+ const oldPath = parentName ? `${parentName}/${folderName}` : folderName;
+ const newPath = parentName ? `${parentName}/${newName}` : newName;
+ return {
+ undoMessage: `↩️ Rename of folder "${oldPath}" to "${newPath}"`,
+ redoMessage: `↪️ Rename of folder "${oldPath}" to "${newPath}"`,
+ };
+ },
+ getLogMessage: ({folderName, parentName}) =>
+ `Renamed folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
+ getResult: ({filePath, request}) =>
+ renameFolder({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ folder: {name: request.folderName, parentName: request.parentName},
+ newName: request.newName,
+ }),
+});
diff --git a/packages/studio-server/src/preview-server/routes/run-composition-edit.ts b/packages/studio-server/src/preview-server/routes/run-composition-edit.ts
new file mode 100644
index 0000000000..306fe20a08
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/run-composition-edit.ts
@@ -0,0 +1,214 @@
+import {existsSync, readFileSync} from 'node:fs';
+import path from 'node:path';
+import type {
+ CodemodNodeResult,
+ CodemodResult,
+ CompositionDestination as CodemodCompositionDestination,
+} from '@remotion/codemods';
+import {RenderInternals} from '@remotion/renderer';
+import type {
+ CompositionDestination,
+ CompositionEditResponse,
+ SymbolicatedStackFrame,
+ UndoRedoNavigation,
+} from '@remotion/studio-shared';
+import {writeFileAndNotifyFileWatchers} from '../../file-watcher';
+import {resolveFileInsideProject} from '../../helpers/resolve-file-inside-project';
+import type {ApiHandler} from '../api-types';
+import {formatLogFileLocation} from '../format-log-file-location';
+import {getProjectInfo} from '../project-info';
+import {broadcastSequenceNodePathMutation} from '../sequence-node-path-mutation';
+import {
+ printUndoHint,
+ pushTransactionToUndoStack,
+ suppressUndoStackInvalidation,
+} from '../undo-stack';
+import {checkIfTypeScriptFile} from './can-update-default-props';
+import {
+ getCodemodTimingPrefix,
+ withSourceFileWriteQueue,
+} from './source-file-write-queue';
+
+const resolveCompositionFile = async ({
+ entryPoint,
+ remotionRoot,
+ symbolicatedStack,
+}: {
+ entryPoint: string;
+ remotionRoot: string;
+ symbolicatedStack: SymbolicatedStackFrame | null;
+}) => {
+ if (symbolicatedStack?.originalFileName) {
+ return resolveFileInsideProject({
+ remotionRoot,
+ fileName: symbolicatedStack.originalFileName,
+ action: 'apply composition edit to',
+ }).absolutePath;
+ }
+
+ const filePath = (await getProjectInfo(remotionRoot, entryPoint)).rootFile;
+ if (filePath === null) {
+ throw new Error('Cannot find the Remotion root file');
+ }
+
+ return filePath;
+};
+
+export const toCodemodDestination = (
+ destination: CompositionDestination,
+): CodemodCompositionDestination =>
+ destination.type === 'folder'
+ ? {
+ type: 'folder',
+ folder: {
+ name: destination.folderName,
+ parentName: destination.parentName,
+ },
+ }
+ : destination.type === 'root'
+ ? destination
+ : {
+ type: destination.type,
+ target:
+ destination.target.type === 'composition'
+ ? destination.target
+ : {
+ type: 'folder',
+ name: destination.target.folderName,
+ parentName: destination.target.parentName,
+ },
+ };
+
+type EditResult = CodemodResult | CodemodNodeResult;
+type UndoEntryType = Parameters<
+ typeof pushTransactionToUndoStack
+>[0]['entryType'];
+
+export const runCompositionEdit = <
+ Request extends {
+ symbolicatedStack: SymbolicatedStackFrame | null;
+ undoRedoNavigation: UndoRedoNavigation | null;
+ },
+>({
+ entryType,
+ getDescription,
+ getLogMessage,
+ getResult,
+}: {
+ entryType: UndoEntryType;
+ getDescription: (request: Request) => {
+ undoMessage: string;
+ redoMessage: string;
+ };
+ getLogMessage: (request: Request) => string;
+ getResult: (options: {
+ filePath: string;
+ request: Request;
+ }) => EditResult | Promise<EditResult>;
+}): ApiHandler<Request, CompositionEditResponse> => {
+ return ({input: request, logLevel, remotionRoot, entryPoint}) =>
+ withSourceFileWriteQueue(async () => {
+ try {
+ const filePath = await resolveCompositionFile({
+ entryPoint,
+ remotionRoot,
+ symbolicatedStack: request.symbolicatedStack,
+ });
+ checkIfTypeScriptFile(filePath);
+ const result = await getResult({filePath, request});
+ for (const change of result.changes) {
+ const currentContents = existsSync(change.filePath)
+ ? readFileSync(change.filePath, 'utf-8')
+ : null;
+ if (currentContents !== change.previousContents) {
+ throw new Error(
+ `Source changed before applying codemod: ${change.filePath}`,
+ );
+ }
+ }
+
+ const remappings =
+ 'nodePathRemappings' in result ? result.nodePathRemappings : [];
+ const mutationFiles = [
+ ...new Set(remappings.map((remapping) => remapping.filePath)),
+ ].map((absolutePath) => ({
+ absolutePath,
+ remappings: remappings
+ .filter((remapping) => remapping.filePath === absolutePath)
+ .map(({oldNodePath, newNodePath}) => ({
+ oldNodePath,
+ newNodePath,
+ })),
+ }));
+ const nodePathMutation =
+ mutationFiles.length === 0
+ ? null
+ : broadcastSequenceNodePathMutation(mutationFiles, null);
+
+ if (result.changes.length > 0) {
+ const logLine = request.symbolicatedStack?.originalLineNumber ?? 1;
+ pushTransactionToUndoStack({
+ snapshots: result.changes.map((change) => {
+ const fileRemappings = mutationFiles.find(
+ (file) => file.absolutePath === change.filePath,
+ )?.remappings;
+ return {
+ filePath: change.filePath,
+ oldContents: change.previousContents,
+ newContents: change.nextContents,
+ logLine: change.filePath === filePath ? logLine : 1,
+ nodePathRemappings: fileRemappings ?? null,
+ };
+ }),
+ logLevel,
+ remotionRoot,
+ description: getDescription(request),
+ entryType,
+ suppressHmrOnFileRestore: false,
+ undoRedoNavigation: request.undoRedoNavigation,
+ });
+
+ for (const change of result.changes) {
+ if (change.nextContents === null) {
+ throw new Error('Composition edits cannot remove source files');
+ }
+
+ suppressUndoStackInvalidation(change.filePath);
+ writeFileAndNotifyFileWatchers({
+ file: change.filePath,
+ content: change.nextContents,
+ originatorClientId: undefined,
+ metadata: mutationFiles.some(
+ (mutation) => mutation.absolutePath === change.filePath,
+ )
+ ? {skipSequencePropsUpdate: true}
+ : null,
+ });
+ }
+
+ const editMessage = `${getCodemodTimingPrefix(logLevel)}${RenderInternals.chalk.blueBright(
+ formatLogFileLocation({
+ remotionRoot,
+ absolutePath: filePath,
+ line: logLine,
+ }),
+ )} ${getLogMessage(request)}`;
+ RenderInternals.Log.info({indent: false, logLevel}, editMessage);
+ printUndoHint(logLevel);
+ }
+
+ return {success: true, nodePathMutation};
+ } catch (error) {
+ return {
+ success: false,
+ reason: error instanceof Error ? error.message : String(error),
+ stack: error instanceof Error ? (error.stack ?? '') : '',
+ };
+ }
+ });
+};
+
+export const getCompositionEditProject = (filePath: string) => ({
+ files: {[filePath]: readFileSync(filePath, 'utf-8')},
+ rootDir: path.dirname(filePath),
+});
diff --git a/packages/studio-server/src/preview-server/routes/unwrap-folder.ts b/packages/studio-server/src/preview-server/routes/unwrap-folder.ts
new file mode 100644
index 0000000000..9c6ea2759a
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/unwrap-folder.ts
@@ -0,0 +1,25 @@
+import {unwrapFolder} from '@remotion/codemods';
+import type {UnwrapFolderRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const unwrapFolderHandler = runCompositionEdit<UnwrapFolderRequest>({
+ entryType: 'delete-folder',
+ getDescription: ({folderName, parentName}) => {
+ const folderPath = parentName ? `${parentName}/${folderName}` : folderName;
+ return {
+ undoMessage: `↩️ Deletion of folder "${folderPath}"`,
+ redoMessage: `↪️ Deletion of folder "${folderPath}"`,
+ };
+ },
+ getLogMessage: ({folderName, parentName}) =>
+ `Deleted folder "${parentName ? `${parentName}/${folderName}` : folderName}"`,
+ getResult: ({filePath, request}) =>
+ unwrapFolder({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ folder: {name: request.folderName, parentName: request.parentName},
+ }),
+});
diff --git a/packages/studio-server/src/preview-server/routes/update-composition-metadata.ts b/packages/studio-server/src/preview-server/routes/update-composition-metadata.ts
new file mode 100644
index 0000000000..bc5725cad9
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/update-composition-metadata.ts
@@ -0,0 +1,29 @@
+import {updateCompositionMetadata} from '@remotion/codemods';
+import type {UpdateCompositionMetadataRequest} from '@remotion/studio-shared';
+import {
+ getCompositionEditProject,
+ runCompositionEdit,
+} from './run-composition-edit';
+
+export const updateCompositionMetadataHandler =
+ runCompositionEdit<UpdateCompositionMetadataRequest>({
+ entryType: 'update-composition-metadata',
+ getDescription: ({idToUpdate}) => ({
+ undoMessage: `↩️ Update of metadata of composition "${idToUpdate}"`,
+ redoMessage: `↪️ Update of metadata of composition "${idToUpdate}"`,
+ }),
+ getLogMessage: ({idToUpdate}) =>
+ `Updated metadata of composition "${idToUpdate}"`,
+ getResult: ({filePath, request}) =>
+ updateCompositionMetadata({
+ project: getCompositionEditProject(filePath),
+ compositionFile: filePath,
+ compositionId: request.idToUpdate,
+ metadata: {
+ width: request.newWidth ?? undefined,
+ height: request.newHeight ?? undefined,
+ fps: request.newFps ?? undefined,
+ durationInFrames: request.newDurationInFrames ?? undefined,
+ },
+ }),
+ });
diff --git a/packages/studio-server/src/test/composition-edits.test.ts b/packages/studio-server/src/test/composition-edits.test.ts
index d7e1a73d64..046f017d0d 100644
--- a/packages/studio-server/src/test/composition-edits.test.ts
+++ b/packages/studio-server/src/test/composition-edits.test.ts
@@ -20,16 +20,14 @@ import {
} from '../file-watcher';
import type {ApiHandler} from '../preview-server/api-types';
import {setLiveEventsListener} from '../preview-server/live-events';
+import {addCompositionHandler} from '../preview-server/routes/add-composition';
+import {addFolderHandler} from '../preview-server/routes/add-folder';
import {applyVisualControlHandler} from '../preview-server/routes/apply-visual-control-change';
-import {
- addCompositionHandler,
- addFolderHandler,
- deleteCompositionHandler,
- duplicateCompositionHandler,
- moveCompositionHandler,
- renameCompositionHandler,
-} from '../preview-server/routes/composition-edits';
+import {deleteCompositionHandler} from '../preview-server/routes/delete-composition';
+import {duplicateCompositionHandler} from '../preview-server/routes/duplicate-composition';
+import {moveCompositionHandler} from '../preview-server/routes/move-composition';
import {redoHandler} from '../preview-server/routes/redo';
+import {renameCompositionHandler} from '../preview-server/routes/rename-composition';
import {undoHandler} from '../preview-server/routes/undo';
import {getRedoStack, getUndoStack} from '../preview-server/undo-stack';