Skip to content

🎥 Make videos programmatically with React

@remotion/studio-codemods: Add public addSolid() API

JonnyBurger11737494cd49
diff --git a/bun.lock b/bun.lock
index 7a6ef295b6..5103d4b2f8 100644
--- a/bun.lock
+++ b/bun.lock
@@ -604,6 +604,7 @@
"@remotion/skia": "workspace:*",
"@remotion/starburst": "workspace:*",
"@remotion/studio": "workspace:*",
+ "@remotion/studio-codemods": "workspace:*",
"@remotion/studio-protocol": "workspace:*",
"@remotion/studio-shared": "workspace:*",
"@remotion/svg-3d-engine": "workspace:*",
@@ -1477,6 +1478,7 @@
"@remotion/media": "workspace:*",
"@remotion/player": "workspace:*",
"@remotion/preload": "workspace:*",
+ "@remotion/studio-codemods": "workspace:*",
"next": "catalog:",
"react": "catalog:",
"react-dom": "catalog:",
diff --git a/packages/browser-studio/src/browser-studio-operations.ts b/packages/browser-studio/src/browser-studio-operations.ts
index cccb54d14f..8b621ec32b 100644
--- a/packages/browser-studio/src/browser-studio-operations.ts
+++ b/packages/browser-studio/src/browser-studio-operations.ts
@@ -35,7 +35,7 @@ import {
updateSequenceKeyframes,
type EffectKeyframeUpdate,
type SequenceKeyframeUpdate,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import {
StudioProtocolInternals,
type StudioElementPayload,
@@ -100,7 +100,7 @@ const getStructuredError = (error: unknown) => ({
export {
insertSolidIntoProject,
insertSolidIntoProjectWithNodePathRemappings,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
export type BrowserStudioOperationsController = BrowserStudioOperations & {
emitEvent: (event: EventSourceEvent) => void;
diff --git a/packages/browser-studio/src/browser-studio-project-controller.ts b/packages/browser-studio/src/browser-studio-project-controller.ts
index 6e2f755891..5c02ca2c66 100644
--- a/packages/browser-studio/src/browser-studio-project-controller.ts
+++ b/packages/browser-studio/src/browser-studio-project-controller.ts
@@ -1,4 +1,4 @@
-import {findSearchPosition} from '@remotion/studio-codemods';
+import {findSearchPosition} from '@remotion/studio-codemods/internal';
import type {
BrowserStudioOperations,
EventSourceEvent,
diff --git a/packages/browser-studio/src/save-sequence-props.ts b/packages/browser-studio/src/save-sequence-props.ts
index dd849cc082..6e5f0a40e4 100644
--- a/packages/browser-studio/src/save-sequence-props.ts
+++ b/packages/browser-studio/src/save-sequence-props.ts
@@ -4,7 +4,7 @@ import {
updateInlineCaptionPatches,
type SequencePropsNodeUpdate,
updateMultipleSequenceProps,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {
SaveSequencePropEdit,
SaveSequencePropsRequest,
diff --git a/packages/browser-studio/src/test/browser-studio-operations.test.ts b/packages/browser-studio/src/test/browser-studio-operations.test.ts
index 20dda6bf17..619b5632fd 100644
--- a/packages/browser-studio/src/test/browser-studio-operations.test.ts
+++ b/packages/browser-studio/src/test/browser-studio-operations.test.ts
@@ -1,5 +1,5 @@
import {expect, test} from 'bun:test';
-import {basicCaptionsElementSource} from '@remotion/studio-codemods';
+import {basicCaptionsElementSource} from '@remotion/studio-codemods/internal';
import {createElementPayload} from '@remotion/studio-protocol';
import type {EventSourceEvent} from '@remotion/studio-shared';
import type {InteractivitySchema} from 'remotion';
diff --git a/packages/docs/docs/studio-codemods/add-solid.mdx b/packages/docs/docs/studio-codemods/add-solid.mdx
new file mode 100644
index 0000000000..18ef9f9cf7
--- /dev/null
+++ b/packages/docs/docs/studio-codemods/add-solid.mdx
@@ -0,0 +1,81 @@
+---
+image: /generated/articles-docs-studio-codemods-add-solid.png
+title: 'addSolid()'
+crumb: '@remotion/studio-codemods'
+---
+
+# addSolid()<AvailableFrom v="4.0.527" />
+
+Adds a [`<Solid>`](/docs/solid) to a composition component and adds the required imports.
+
+```ts twoslash title="add-solid.ts"
+import {addSolid, type CodemodProject} from '@remotion/studio-codemods';
+
+declare const project: CodemodProject;
+
+const result = addSolid({
+ project,
+ compositionFile: 'src/Root.tsx',
+ compositionId: 'MyComposition',
+ width: 1920,
+ height: 1080,
+});
+
+console.log(result.project.files);
+console.log(result.changes);
+```
+
+The input project is not mutated.
+
+## Options
+
+Pass an object with the following properties.
+
+### project
+
+An in-memory Remotion project containing `rootDir` and a `files` record.
+
+### compositionFile
+
+The path to the file that registers the composition. The component may be declared in that file or imported from another project file.
+
+### compositionId
+
+The ID of the [`<Composition>`](/docs/composition) to edit.
+
+### width
+
+The width of the inserted [`<Solid>`](/docs/solid).
+
+### height
+
+The height of the inserted [`<Solid>`](/docs/solid).
+
+### from?
+
+Wraps the [`<Solid>`](/docs/solid) in a [`<Sequence>`](/docs/sequence) starting at this frame. By default, the solid is not wrapped in a sequence.
+
+### position?
+
+Positions the solid at `{x, y}` pixels and adds a CSS translation. By default, the solid starts at the composition origin.
+
+## Return value
+
+An object with the following properties.
+
+### project
+
+A new project containing the transformed source. Unchanged project fields are preserved.
+
+### changes
+
+An array describing each changed file with its `filePath`, `previousContents`, and `nextContents`.
+
+## Compatibility
+
+<CompatibilityTable chrome firefox safari nodejs bun serverlessFunctions clientSideRendering serverSideRendering player studio />
+
+## See also
+
+- [`<Solid>`](/docs/solid)
+- [`@remotion/browser-bundler`](/docs/browser-bundler)
diff --git a/packages/docs/docs/studio-codemods/index.mdx b/packages/docs/docs/studio-codemods/index.mdx
new file mode 100644
index 0000000000..5597a58a1c
--- /dev/null
+++ b/packages/docs/docs/studio-codemods/index.mdx
@@ -0,0 +1,41 @@
+---
+image: /generated/articles-docs-studio-codemods-index.png
+sidebar_label: Overview
+title: '@remotion/studio-codemods'
+crumb: '@remotion/studio-codemods'
+---
+
+# @remotion/studio-codemods<AvailableFrom v="4.0.527" />
+
+Apply source-to-source transforms to an in-memory Remotion project.
+
+The package accepts a record of file paths and source code and returns a new project together with the files that changed. It does not read from or write to the filesystem, so it can run in browsers and server-side JavaScript runtimes.
+
+## Installation
+
+<Installation pkg="@remotion/studio-codemods" />
+
+Keep the version aligned with the other Remotion packages in the project.
+
+## Project model
+
+A codemod project contains a `rootDir` and a `files` record. File paths may be project-relative or absolute, but they must consistently identify imports within the project.
+
+```ts twoslash title="project.ts"
+import type {CodemodProject} from '@remotion/studio-codemods';
+
+export const project: CodemodProject = {
+ rootDir: '/',
+ files: {
+ 'src/Root.tsx': `export const Root = () => null;`,
+ },
+};
+```
+
+import {TableOfContents} from './table-of-contents';
+
+<TableOfContents />
+
+## Compatibility
+
+<CompatibilityTable chrome firefox safari nodejs bun serverlessFunctions clientSideRendering serverSideRendering player studio />
diff --git a/packages/docs/docs/studio-codemods/table-of-contents.tsx b/packages/docs/docs/studio-codemods/table-of-contents.tsx
new file mode 100644
index 0000000000..895a955164
--- /dev/null
+++ b/packages/docs/docs/studio-codemods/table-of-contents.tsx
@@ -0,0 +1,14 @@
+import React from 'react';
+import {Grid} from '../../components/TableOfContents/Grid';
+import {TOCItem} from '../../components/TableOfContents/TOCItem';
+
+export const TableOfContents: React.FC = () => {
+ return (
+ <Grid>
+ <TOCItem link="/docs/studio-codemods/add-solid">
+ <strong>addSolid()</strong>
+ <div>Add a Solid to a composition source file</div>
+ </TOCItem>
+ </Grid>
+ );
+};
diff --git a/packages/docs/package.json b/packages/docs/package.json
index 625321c73d..57ce557545 100644
--- a/packages/docs/package.json
+++ b/packages/docs/package.json
@@ -91,6 +91,7 @@
"@remotion/skia": "workspace:*",
"@remotion/starburst": "workspace:*",
"@remotion/studio": "workspace:*",
+ "@remotion/studio-codemods": "workspace:*",
"@remotion/studio-shared": "workspace:*",
"@remotion/svg-3d-engine": "workspace:*",
"@remotion/tailwind": "workspace:*",
diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.ts
index d04b94b83c..0f64593197 100644
--- a/packages/docs/sidebars.ts
+++ b/packages/docs/sidebars.ts
@@ -2031,6 +2031,17 @@ const sidebars: SidebarsConfig = {
],
},
],
+ studioCodemodsSidebar: [
+ {
+ type: 'category',
+ label: '@remotion/studio-codemods',
+ link: {
+ type: 'doc',
+ id: 'studio-codemods/index',
+ },
+ items: ['studio-codemods/add-solid'],
+ },
+ ],
};
export default sidebars;
diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.ts
index 3e4d23052e..15c5d59fa3 100644
--- a/packages/docs/src/data/articles.ts
+++ b/packages/docs/src/data/articles.ts
@@ -7157,6 +7157,24 @@ export const articles = [
noAi: false,
slug: 'studio-into-app',
},
+ {
+ id: 'studio-codemods/add-solid',
+ title: 'addSolid()',
+ relativePath: 'docs/studio-codemods/add-solid.mdx',
+ compId: 'articles-docs-studio-codemods-add-solid',
+ crumb: '@remotion/studio-codemods',
+ noAi: false,
+ slug: 'studio-codemods/add-solid',
+ },
+ {
+ id: 'studio-codemods/index',
+ title: '@remotion/studio-codemods',
+ relativePath: 'docs/studio-codemods/index.mdx',
+ compId: 'articles-docs-studio-codemods-index',
+ crumb: '@remotion/studio-codemods',
+ noAi: false,
+ slug: 'studio-codemods/index',
+ },
{
id: 'studio-protocol/add-element-library-to-studio',
title: 'addElementLibraryToStudio()',
diff --git a/packages/docs/static/generated/articles-docs-studio-codemods-add-solid.png b/packages/docs/static/generated/articles-docs-studio-codemods-add-solid.png
new file mode 100644
index 0000000000..805afb6218
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-studio-codemods-add-solid.png differ
diff --git a/packages/docs/static/generated/articles-docs-studio-codemods-index.png b/packages/docs/static/generated/articles-docs-studio-codemods-index.png
new file mode 100644
index 0000000000..f25f3091cf
Binary files /dev/null and b/packages/docs/static/generated/articles-docs-studio-codemods-index.png differ
diff --git a/packages/player-example/e2e/browser-bundler.test.ts b/packages/player-example/e2e/browser-bundler.test.ts
index 1c63a9be10..14520cab9b 100644
--- a/packages/player-example/e2e/browser-bundler.test.ts
+++ b/packages/player-example/e2e/browser-bundler.test.ts
@@ -51,6 +51,17 @@ test('Fast Refresh preserves an isolated Canvas, video state and editor focus th
await composition
.getByRole('button', {name: 'Clicks: 1', exact: true})
.click();
+ await page.getByRole('button', {name: 'Add Solid', exact: true}).click();
+ await expect(page.getByRole('status')).toHaveText('Up to date');
+ await expect(
+ mountedLayers.getByRole('heading', {name: 'Layers (6)'}),
+ ).toBeVisible();
+ await expect(page.getByRole('textbox', {name: 'Video.tsx'})).toHaveValue(
+ /<Solid width=\{1280\} height=\{720\}/,
+ );
+ await expect(
+ composition.getByRole('button', {name: 'Clicks: 2', exact: true}),
+ ).toBeVisible();
const playbackRate = composition.getByRole('button', {
name: 'Change playback rate',
exact: true,
@@ -87,7 +98,7 @@ test('Fast Refresh preserves an isolated Canvas, video state and editor focus th
await expect(frame).toHaveText(pausedFrame);
await expect(playbackRate).toHaveText('1.5x');
await expect(
- mountedLayers.getByRole('heading', {name: 'Layers (5)'}),
+ mountedLayers.getByRole('heading', {name: 'Layers (6)'}),
).toBeVisible();
await expect(
composition.getByRole('button', {name: 'Play video', exact: true}),
diff --git a/packages/player-example/package.json b/packages/player-example/package.json
index ebc87b339d..3de40d12d3 100644
--- a/packages/player-example/package.json
+++ b/packages/player-example/package.json
@@ -19,6 +19,7 @@
"@remotion/google-fonts": "workspace:*",
"@remotion/player": "workspace:*",
"@remotion/preload": "workspace:*",
+ "@remotion/studio-codemods": "workspace:*",
"next": "catalog:",
"react": "catalog:",
"react-dom": "catalog:",
diff --git a/packages/player-example/src/BrowserBundlerExample.tsx b/packages/player-example/src/BrowserBundlerExample.tsx
index a5d047433a..d2cd3c01b3 100644
--- a/packages/player-example/src/BrowserBundlerExample.tsx
+++ b/packages/player-example/src/BrowserBundlerExample.tsx
@@ -3,6 +3,7 @@ import {
createBrowserBundler,
type VirtualProject,
} from '@remotion/browser-bundler';
+import {addSolid} from '@remotion/studio-codemods';
import Link from 'next/link';
import React, {useCallback, useEffect, useRef, useState} from 'react';
import type {BrowserBundlerPreview} from './browser-bundler-preview/bridge';
@@ -350,6 +351,49 @@ export const BrowserBundlerExample: React.FC = () => {
Fast Refresh · live layers
</div>
</div>
+ <button
+ type="button"
+ disabled={state.type === 'loading'}
+ onClick={() => {
+ try {
+ const result = addSolid({
+ compositionFile: 'src/Root.tsx',
+ compositionId: 'BrowserDemo',
+ height: 720,
+ project: {
+ ...project,
+ files: {...project.files, 'src/Video.tsx': source},
+ rootDir: '/',
+ },
+ width: 1280,
+ });
+ const nextSource = result.project.files['src/Video.tsx'];
+ if (!nextSource) {
+ throw new Error('The codemod did not return Video.tsx.');
+ }
+
+ setSource(nextSource);
+ void compile(nextSource);
+ } catch (error) {
+ setState({
+ message: getCompilationErrorMessage(error),
+ type: 'error',
+ });
+ }
+ }}
+ style={{
+ backgroundColor: '#4f46e5',
+ border: 0,
+ borderRadius: 5,
+ color: 'white',
+ fontSize: 12,
+ fontWeight: 600,
+ marginLeft: 'auto',
+ padding: '7px 11px',
+ }}
+ >
+ Add Solid
+ </button>
<p
role="status"
aria-live="polite"
@@ -359,7 +403,7 @@ export const BrowserBundlerExample: React.FC = () => {
borderRadius: 999,
color: state.type === 'error' ? '#fecaca' : '#bfdbfe',
fontSize: 12,
- margin: '0 0 0 auto',
+ margin: 0,
padding: '5px 10px',
}}
>
diff --git a/packages/player-example/tsconfig.json b/packages/player-example/tsconfig.json
index aaa0f7547a..de582e9cbd 100644
--- a/packages/player-example/tsconfig.json
+++ b/packages/player-example/tsconfig.json
@@ -33,6 +33,9 @@
{
"path": "../player"
},
+ {
+ "path": "../studio-codemods"
+ },
{
"path": "../google-fonts"
},
diff --git a/packages/studio-codemods/README.md b/packages/studio-codemods/README.md
index 94f05bc22a..28817ea5ad 100644
--- a/packages/studio-codemods/README.md
+++ b/packages/studio-codemods/README.md
@@ -1,7 +1,28 @@
# @remotion/studio-codemods
-Shared codemods for Remotion Studio
+Codemods for editing Remotion projects without a filesystem dependency.
## Usage
-This is an internal package and has no documentation.
+```tsx
+import {addSolid} from '@remotion/studio-codemods';
+
+const result = addSolid({
+ project: {
+ rootDir: '/',
+ files: {
+ 'src/Root.tsx': rootSource,
+ 'src/Video.tsx': videoSource,
+ },
+ },
+ compositionFile: 'src/Root.tsx',
+ compositionId: 'MyComposition',
+ width: 1920,
+ height: 1080,
+});
+
+console.log(result.project.files);
+console.log(result.changes);
+```
+
+See the [documentation](https://www.remotion.dev/docs/studio-codemods).
diff --git a/packages/studio-codemods/bundle.ts b/packages/studio-codemods/bundle.ts
index 35f2c00014..28a5a8b1ea 100644
--- a/packages/studio-codemods/bundle.ts
+++ b/packages/studio-codemods/bundle.ts
@@ -10,6 +10,7 @@ const external = ['@remotion/studio-shared', 'recast'];
console.time('Generated.');
const esmOutput = await build({
entrypoints: [
+ 'src/public.ts',
'src/index.ts',
'src/resolve-composition-component-location.ts',
],
@@ -18,6 +19,7 @@ const esmOutput = await build({
});
const cjsOutput = await build({
entrypoints: [
+ 'src/public.ts',
'src/index.ts',
'src/resolve-composition-component-location.ts',
],
diff --git a/packages/studio-codemods/package.json b/packages/studio-codemods/package.json
index b48f7f018e..2498278237 100644
--- a/packages/studio-codemods/package.json
+++ b/packages/studio-codemods/package.json
@@ -1,10 +1,10 @@
{
"name": "@remotion/studio-codemods",
"version": "4.0.526",
- "description": "Shared codemods for Remotion Studio",
- "main": "dist/index.cjs",
- "types": "dist/index.d.ts",
- "module": "dist/esm/index.mjs",
+ "description": "Codemods for Remotion projects",
+ "main": "dist/public.cjs",
+ "types": "dist/public.d.ts",
+ "module": "dist/esm/public.mjs",
"repository": {
"url": "https://github.com/remotion-dev/remotion/tree/main/packages/studio-codemods"
},
@@ -33,6 +33,12 @@
},
"exports": {
".": {
+ "types": "./dist/public.d.ts",
+ "require": "./dist/public.cjs",
+ "module": "./dist/esm/public.mjs",
+ "import": "./dist/esm/public.mjs"
+ },
+ "./internal": {
"types": "./dist/index.d.ts",
"require": "./dist/index.cjs",
"module": "./dist/esm/index.mjs",
diff --git a/packages/studio-codemods/src/index.ts b/packages/studio-codemods/src/index.ts
index 7b6602d3f1..2730660c8a 100644
--- a/packages/studio-codemods/src/index.ts
+++ b/packages/studio-codemods/src/index.ts
@@ -1005,7 +1005,7 @@ const getNodePathRemappings = ({
return remappings;
};
-export const insertSolidIntoProjectWithNodePathRemappings = <
+const insertSolidIntoProjectWithoutNodePathRemappings = <
Project extends CodemodProject,
>({
project,
@@ -1016,7 +1016,8 @@ export const insertSolidIntoProjectWithNodePathRemappings = <
}): {
project: Project;
filePath: string;
- nodePathRemappings: SequenceNodePathRemapping[];
+ previousSource: string;
+ nextSource: string;
} => {
if (request.element.type !== 'solid') {
throw new Error('This codemod only supports adding <Solid>');
@@ -1058,14 +1059,10 @@ export const insertSolidIntoProjectWithNodePathRemappings = <
source: resolved.source,
width: request.element.width,
});
- const nodePathRemappings = getNodePathRemappings({
- afterSource: output,
- beforeSource: resolved.source,
- });
-
return {
filePath: resolved.filePath,
- nodePathRemappings,
+ nextSource: output,
+ previousSource: resolved.source,
project: {
...project,
files: {
@@ -1076,6 +1073,34 @@ export const insertSolidIntoProjectWithNodePathRemappings = <
};
};
+export const insertSolidIntoProjectWithNodePathRemappings = <
+ Project extends CodemodProject,
+>({
+ project,
+ request,
+}: {
+ project: Project;
+ request: InsertJsxElementRequest;
+}): {
+ project: Project;
+ filePath: string;
+ nodePathRemappings: SequenceNodePathRemapping[];
+} => {
+ const result = insertSolidIntoProjectWithoutNodePathRemappings({
+ project,
+ request,
+ });
+
+ return {
+ filePath: result.filePath,
+ nodePathRemappings: getNodePathRemappings({
+ afterSource: result.nextSource,
+ beforeSource: result.previousSource,
+ }),
+ project: result.project,
+ };
+};
+
export const insertSolidIntoProject = <Project extends CodemodProject>({
project,
request,
@@ -1083,7 +1108,7 @@ export const insertSolidIntoProject = <Project extends CodemodProject>({
project: Project;
request: InsertJsxElementRequest;
}): Project => {
- return insertSolidIntoProjectWithNodePathRemappings({project, request})
+ return insertSolidIntoProjectWithoutNodePathRemappings({project, request})
.project;
};
diff --git a/packages/studio-codemods/src/public.ts b/packages/studio-codemods/src/public.ts
new file mode 100644
index 0000000000..2023bbcd53
--- /dev/null
+++ b/packages/studio-codemods/src/public.ts
@@ -0,0 +1,65 @@
+import {insertSolidIntoProject} from './index';
+
+export type CodemodProject = {
+ files: Record<string, string>;
+ rootDir: string;
+};
+
+export type CodemodFileChange = {
+ filePath: string;
+ previousContents: string | null;
+ nextContents: string | null;
+};
+
+export type CodemodResult<Project extends CodemodProject> = {
+ project: Project;
+ changes: CodemodFileChange[];
+};
+
+export type AddSolidOptions<Project extends CodemodProject> = {
+ project: Project;
+ compositionId: string;
+ compositionFile: string;
+ width: number;
+ height: number;
+ from?: number;
+ position?: {x: number; y: number};
+};
+
+export const addSolid = <Project extends CodemodProject>({
+ project,
+ compositionId,
+ compositionFile,
+ width,
+ height,
+ from,
+ position,
+}: AddSolidOptions<Project>): CodemodResult<Project> => {
+ const nextProject = insertSolidIntoProject({
+ project,
+ request: {
+ compositionFile,
+ compositionId,
+ element: {
+ height,
+ position: position ?? null,
+ type: 'solid',
+ width,
+ },
+ from: from ?? null,
+ },
+ });
+ const filePaths = new Set([
+ ...Object.keys(project.files),
+ ...Object.keys(nextProject.files),
+ ]);
+ const changes = [...filePaths].flatMap((filePath): CodemodFileChange[] => {
+ const previousContents = project.files[filePath] ?? null;
+ const nextContents = nextProject.files[filePath] ?? null;
+ return previousContents === nextContents
+ ? []
+ : [{filePath, previousContents, nextContents}];
+ });
+
+ return {changes, project: nextProject};
+};
diff --git a/packages/studio-codemods/src/test/public-api.test.ts b/packages/studio-codemods/src/test/public-api.test.ts
new file mode 100644
index 0000000000..3ad32a489e
--- /dev/null
+++ b/packages/studio-codemods/src/test/public-api.test.ts
@@ -0,0 +1,45 @@
+import {expect, test} from 'bun:test';
+import {addSolid} from '../public';
+
+const makeProject = () => ({
+ entryPoint: 'src/index.ts',
+ rootDir: '/',
+ files: {
+ 'src/index.ts': `import {registerRoot} from 'remotion';
+import {Root} from './Root';
+registerRoot(Root);
+`,
+ 'src/Root.tsx': `import {Composition} from 'remotion';
+import {Video} from './Video';
+export const Root = () => <Composition id="Demo" component={Video} width={1280} height={720} fps={30} durationInFrames={90} />;
+`,
+ 'src/Video.tsx': `import {AbsoluteFill} from 'remotion';
+export const Video = () => <AbsoluteFill>Existing</AbsoluteFill>;
+`,
+ },
+});
+
+test('addSolid() immutably updates a virtual project', () => {
+ const project = makeProject();
+ const result = addSolid({
+ compositionFile: 'src/Root.tsx',
+ compositionId: 'Demo',
+ height: 720,
+ project,
+ width: 1280,
+ });
+
+ expect(result.project.entryPoint).toBe('src/index.ts');
+ expect(result.project).not.toBe(project);
+ expect(project.files['src/Video.tsx']).not.toContain('<Solid');
+ expect(result.project.files['src/Video.tsx']).toContain(
+ '<Solid width={1280} height={720}',
+ );
+ expect(result.changes).toEqual([
+ {
+ filePath: 'src/Video.tsx',
+ previousContents: project.files['src/Video.tsx'],
+ nextContents: result.project.files['src/Video.tsx'],
+ },
+ ]);
+});
diff --git a/packages/studio-server/src/codemods/add-effect.ts b/packages/studio-server/src/codemods/add-effect.ts
index 9525aba841..7de9b12603 100644
--- a/packages/studio-server/src/codemods/add-effect.ts
+++ b/packages/studio-server/src/codemods/add-effect.ts
@@ -3,4 +3,4 @@ export {
assertValidEffect,
ensureEffectImport,
makeConfigObjectExpression,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/apply-codemod-to-file.ts b/packages/studio-server/src/codemods/apply-codemod-to-file.ts
index 8363441b73..69faa835c4 100644
--- a/packages/studio-server/src/codemods/apply-codemod-to-file.ts
+++ b/packages/studio-server/src/codemods/apply-codemod-to-file.ts
@@ -1,5 +1,5 @@
import {existsSync, readFileSync} from 'node:fs';
-import {parseAndApplyCodemod} from '@remotion/studio-codemods';
+import {parseAndApplyCodemod} from '@remotion/studio-codemods/internal';
import type {
RecastCodemod,
SymbolicatedStackFrame,
diff --git a/packages/studio-server/src/codemods/delete-effect.ts b/packages/studio-server/src/codemods/delete-effect.ts
index 071bbe9c97..2794c9fe52 100644
--- a/packages/studio-server/src/codemods/delete-effect.ts
+++ b/packages/studio-server/src/codemods/delete-effect.ts
@@ -2,4 +2,4 @@ export {
deleteEffect,
deleteEffects,
type EffectDeletionTarget,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/delete-jsx-node.ts b/packages/studio-server/src/codemods/delete-jsx-node.ts
index 3306bc8b6a..a5f00e0615 100644
--- a/packages/studio-server/src/codemods/delete-jsx-node.ts
+++ b/packages/studio-server/src/codemods/delete-jsx-node.ts
@@ -4,7 +4,7 @@ import {
deleteJsxNodes as deleteJsxNodesCodemod,
findJsxElementPathForDeletion,
getJsxElementTagLabel,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {SequenceNodePath} from 'remotion';
export {
diff --git a/packages/studio-server/src/codemods/duplicate-effect.ts b/packages/studio-server/src/codemods/duplicate-effect.ts
index fa2e21efc5..140c23999c 100644
--- a/packages/studio-server/src/codemods/duplicate-effect.ts
+++ b/packages/studio-server/src/codemods/duplicate-effect.ts
@@ -2,4 +2,4 @@ export {
duplicateEffect,
duplicateEffects,
type EffectTarget as EffectDuplicationTarget,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/insert-basic-captions.ts b/packages/studio-server/src/codemods/insert-basic-captions.ts
index 22bfc8371b..4a9f21b1a6 100644
--- a/packages/studio-server/src/codemods/insert-basic-captions.ts
+++ b/packages/studio-server/src/codemods/insert-basic-captions.ts
@@ -1 +1 @@
-export {insertBasicCaptions} from '@remotion/studio-codemods';
+export {insertBasicCaptions} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/paste-effects.ts b/packages/studio-server/src/codemods/paste-effects.ts
index a81aca431a..20e9ebd1ec 100644
--- a/packages/studio-server/src/codemods/paste-effects.ts
+++ b/packages/studio-server/src/codemods/paste-effects.ts
@@ -1,4 +1,4 @@
-import {pasteEffects as pasteEffectsCodemod} from '@remotion/studio-codemods';
+import {pasteEffects as pasteEffectsCodemod} from '@remotion/studio-codemods/internal';
type PasteEffectsInput = Parameters<typeof pasteEffectsCodemod>[0] & {
readonly targetFileName: string;
diff --git a/packages/studio-server/src/codemods/reorder-effect.ts b/packages/studio-server/src/codemods/reorder-effect.ts
index 9b529eb719..0d532f627e 100644
--- a/packages/studio-server/src/codemods/reorder-effect.ts
+++ b/packages/studio-server/src/codemods/reorder-effect.ts
@@ -1 +1 @@
-export {reorderEffect} from '@remotion/studio-codemods';
+export {reorderEffect} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/reorder-sequence.ts b/packages/studio-server/src/codemods/reorder-sequence.ts
index 1a19b60220..8ec34c24d0 100644
--- a/packages/studio-server/src/codemods/reorder-sequence.ts
+++ b/packages/studio-server/src/codemods/reorder-sequence.ts
@@ -1 +1 @@
-export {reorderSequence} from '@remotion/studio-codemods';
+export {reorderSequence} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/split-jsx-sequence.ts b/packages/studio-server/src/codemods/split-jsx-sequence.ts
index 6f6425a845..0d1ac51825 100644
--- a/packages/studio-server/src/codemods/split-jsx-sequence.ts
+++ b/packages/studio-server/src/codemods/split-jsx-sequence.ts
@@ -1,7 +1,7 @@
import {
splitJsxSequence as splitJsxSequenceCodemod,
splitJsxSequences as splitJsxSequencesCodemod,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {SequenceNodePath} from 'remotion';
export const splitJsxSequence = ({
diff --git a/packages/studio-server/src/codemods/split-video-from-audio.ts b/packages/studio-server/src/codemods/split-video-from-audio.ts
index a0b0085c03..c413d33b7c 100644
--- a/packages/studio-server/src/codemods/split-video-from-audio.ts
+++ b/packages/studio-server/src/codemods/split-video-from-audio.ts
@@ -1 +1 @@
-export {splitVideoFromAudio} from '@remotion/studio-codemods';
+export {splitVideoFromAudio} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/update-default-props.ts b/packages/studio-server/src/codemods/update-default-props.ts
index eaaead7d3f..d24056fba3 100644
--- a/packages/studio-server/src/codemods/update-default-props.ts
+++ b/packages/studio-server/src/codemods/update-default-props.ts
@@ -1,4 +1,4 @@
export {
getCompositionDefaultPropsLine,
updateDefaultProps,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/update-effect-props/update-effect-props.ts b/packages/studio-server/src/codemods/update-effect-props/update-effect-props.ts
index 5c7ceb3b52..e252679c43 100644
--- a/packages/studio-server/src/codemods/update-effect-props/update-effect-props.ts
+++ b/packages/studio-server/src/codemods/update-effect-props/update-effect-props.ts
@@ -1,5 +1,5 @@
import type {JSXAttribute} from '@babel/types';
-import {findEffectsAttr as findEffectsAttrCodemod} from '@remotion/studio-codemods';
+import {findEffectsAttr as findEffectsAttrCodemod} from '@remotion/studio-codemods/internal';
export {
enumerateEffectArrayElements,
@@ -10,7 +10,7 @@ export {
type UpdateEffectPropsResult,
updateEffectProps,
updateEffectPropsAst,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
export const findEffectsAttr = (
attrs: readonly (JSXAttribute | unknown)[],
diff --git a/packages/studio-server/src/codemods/update-inline-caption-patches.ts b/packages/studio-server/src/codemods/update-inline-caption-patches.ts
index 414559c532..cb426990bf 100644
--- a/packages/studio-server/src/codemods/update-inline-caption-patches.ts
+++ b/packages/studio-server/src/codemods/update-inline-caption-patches.ts
@@ -1 +1 @@
-export {updateInlineCaptionPatches} from '@remotion/studio-codemods';
+export {updateInlineCaptionPatches} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/update-keyframes/ensure-imports-and-frame-hook.ts b/packages/studio-server/src/codemods/update-keyframes/ensure-imports-and-frame-hook.ts
index 14959b842f..6a61abd81b 100644
--- a/packages/studio-server/src/codemods/update-keyframes/ensure-imports-and-frame-hook.ts
+++ b/packages/studio-server/src/codemods/update-keyframes/ensure-imports-and-frame-hook.ts
@@ -2,4 +2,4 @@ export {
ensureRemotionImports,
ensureUseCurrentFrameHook,
findEnclosingFunctionPath,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
diff --git a/packages/studio-server/src/codemods/update-keyframes/update-keyframes.ts b/packages/studio-server/src/codemods/update-keyframes/update-keyframes.ts
index 8e865022ab..1008f87c65 100644
--- a/packages/studio-server/src/codemods/update-keyframes/update-keyframes.ts
+++ b/packages/studio-server/src/codemods/update-keyframes/update-keyframes.ts
@@ -1,7 +1,7 @@
import {
updateEffectKeyframes as updateEffectKeyframesCodemod,
updateSequenceKeyframes as updateSequenceKeyframesCodemod,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
export {
type EffectKeyframeUpdate,
@@ -10,7 +10,7 @@ export {
type SequenceKeyframeUpdate,
updateEffectKeyframesAst,
updateSequenceKeyframesAst,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
type UpdateSequenceKeyframesInput = Omit<
Parameters<typeof updateSequenceKeyframesCodemod>[0],
diff --git a/packages/studio-server/src/codemods/update-sequence-props/update-sequence-props.ts b/packages/studio-server/src/codemods/update-sequence-props/update-sequence-props.ts
index 5e781acfaf..71f74eaccd 100644
--- a/packages/studio-server/src/codemods/update-sequence-props/update-sequence-props.ts
+++ b/packages/studio-server/src/codemods/update-sequence-props/update-sequence-props.ts
@@ -6,7 +6,7 @@ import {
type SequencePropUpdate,
updateMultipleSequenceProps as updateMultipleSequencePropsCodemod,
updateSequencePropsAst,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {
InteractivitySchema,
SequenceNodePath,
diff --git a/packages/studio-server/src/helpers/resolve-composition-component.ts b/packages/studio-server/src/helpers/resolve-composition-component.ts
index 0c5c973c6e..e27882178f 100644
--- a/packages/studio-server/src/helpers/resolve-composition-component.ts
+++ b/packages/studio-server/src/helpers/resolve-composition-component.ts
@@ -7,7 +7,7 @@ import {
type InsertJsxElementCodemodEnvironment,
type ResolvedCompositionComponent,
type ResolvedCompositionComponentWithFile,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {
InsertableCompositionElement,
InsertableCompositionElementPosition,
diff --git a/packages/studio-server/src/index.ts b/packages/studio-server/src/index.ts
index 3c9d750fed..d2a3a212cd 100644
--- a/packages/studio-server/src/index.ts
+++ b/packages/studio-server/src/index.ts
@@ -23,7 +23,7 @@ export type {
UiOpenGlOptions,
} from '@remotion/studio-shared';
-import {parseAndApplyCodemod} from '@remotion/studio-codemods';
+import {parseAndApplyCodemod} from '@remotion/studio-codemods/internal';
import {AnsiDiff} from './ansi-diff';
import {
addCompletedClientRender,
diff --git a/packages/studio-server/src/preview-server/routes/apply-codemod.ts b/packages/studio-server/src/preview-server/routes/apply-codemod.ts
index 8d9c23f829..c3dcfa863b 100644
--- a/packages/studio-server/src/preview-server/routes/apply-codemod.ts
+++ b/packages/studio-server/src/preview-server/routes/apply-codemod.ts
@@ -4,7 +4,7 @@ import {RenderInternals} from '@remotion/renderer';
import {
makeNewCompositionComponentSource,
simpleDiff,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {
ApplyCodemodRequest,
ApplyCodemodResponse,
diff --git a/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts b/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
index c95e2ef099..0ba1e3dd89 100644
--- a/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
+++ b/packages/studio-server/src/preview-server/routes/apply-visual-control-change.ts
@@ -1,7 +1,7 @@
import {readFileSync} from 'node:fs';
import type {File} from '@babel/types';
import {RenderInternals} from '@remotion/renderer';
-import {applyVisualControl} from '@remotion/studio-codemods';
+import {applyVisualControl} from '@remotion/studio-codemods/internal';
import type {
ApplyVisualControlRequest,
ApplyVisualControlResponse,
diff --git a/packages/studio-server/src/preview-server/routes/can-update-default-props.ts b/packages/studio-server/src/preview-server/routes/can-update-default-props.ts
index 6b8bb37f54..82d6ddd45e 100644
--- a/packages/studio-server/src/preview-server/routes/can-update-default-props.ts
+++ b/packages/studio-server/src/preview-server/routes/can-update-default-props.ts
@@ -1,9 +1,9 @@
import {readFileSync} from 'node:fs';
-import {computeCanUpdateDefaultPropsFromContent} from '@remotion/studio-codemods';
+import {computeCanUpdateDefaultPropsFromContent} from '@remotion/studio-codemods/internal';
import type {CanUpdateDefaultPropsResponse} from '@remotion/studio-shared';
import {getProjectInfo} from '../project-info';
-export {computeCanUpdateDefaultPropsFromContent} from '@remotion/studio-codemods';
+export {computeCanUpdateDefaultPropsFromContent} from '@remotion/studio-codemods/internal';
export const checkIfTypeScriptFile = (file: string) => {
if (
diff --git a/packages/studio-server/src/preview-server/routes/duplicate-jsx-node.ts b/packages/studio-server/src/preview-server/routes/duplicate-jsx-node.ts
index de86996c7e..a94aaeea88 100644
--- a/packages/studio-server/src/preview-server/routes/duplicate-jsx-node.ts
+++ b/packages/studio-server/src/preview-server/routes/duplicate-jsx-node.ts
@@ -1,6 +1,6 @@
import {readFileSync} from 'node:fs';
import {RenderInternals} from '@remotion/renderer';
-import {duplicateJsxNodes} from '@remotion/studio-codemods';
+import {duplicateJsxNodes} from '@remotion/studio-codemods/internal';
import type {
DuplicateJsxNodeRequest,
DuplicateJsxNodeResponse,
diff --git a/packages/studio-server/src/preview-server/routes/find-in-file.ts b/packages/studio-server/src/preview-server/routes/find-in-file.ts
index fedc6d44a9..0e7147fb06 100644
--- a/packages/studio-server/src/preview-server/routes/find-in-file.ts
+++ b/packages/studio-server/src/preview-server/routes/find-in-file.ts
@@ -1,13 +1,13 @@
import fs from 'node:fs';
import path from 'node:path';
-import {findSearchPosition} from '@remotion/studio-codemods';
+import {findSearchPosition} from '@remotion/studio-codemods/internal';
import type {
FindInFileRequest,
FindInFileResponse,
} from '@remotion/studio-shared';
import type {ApiHandler} from '../api-types';
-export {findSearchPosition} from '@remotion/studio-codemods';
+export {findSearchPosition} from '@remotion/studio-codemods/internal';
export const findInFileHandler: ApiHandler<
FindInFileRequest,
diff --git a/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts b/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts
index 806af05f3e..a8e203cdc9 100644
--- a/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts
+++ b/packages/studio-server/src/preview-server/routes/insert-basic-captions.ts
@@ -3,7 +3,7 @@ import {RenderInternals} from '@remotion/renderer';
import {
basicCaptionsElementSource,
getBasicCaptionsElementFile,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import type {
InsertBasicCaptionsRequest,
InsertBasicCaptionsResponse,
diff --git a/packages/studio-server/src/test/apply-codemod.test.ts b/packages/studio-server/src/test/apply-codemod.test.ts
index dcff46162c..f347f6a90b 100644
--- a/packages/studio-server/src/test/apply-codemod.test.ts
+++ b/packages/studio-server/src/test/apply-codemod.test.ts
@@ -8,7 +8,7 @@ import {
} from 'node:fs';
import {tmpdir} from 'node:os';
import path from 'node:path';
-import {parseAndApplyCodemod} from '@remotion/studio-codemods';
+import {parseAndApplyCodemod} from '@remotion/studio-codemods/internal';
import type {RecastCodemod} from '@remotion/studio-shared';
import {applyCodemodToFile} from '../codemods/apply-codemod-to-file';
import {
diff --git a/packages/studio-server/src/test/duplicate-jsx-node.test.ts b/packages/studio-server/src/test/duplicate-jsx-node.test.ts
index 407897285f..123a950037 100644
--- a/packages/studio-server/src/test/duplicate-jsx-node.test.ts
+++ b/packages/studio-server/src/test/duplicate-jsx-node.test.ts
@@ -1,5 +1,5 @@
import {expect, test} from 'bun:test';
-import {duplicateJsxNodes} from '@remotion/studio-codemods';
+import {duplicateJsxNodes} from '@remotion/studio-codemods/internal';
import {lineColumnToNodePath, lineContainingToNodePath} from './test-utils';
const sample = `import React from 'react';
diff --git a/packages/studio-server/src/test/generate-canvas-capture-composition.test.ts b/packages/studio-server/src/test/generate-canvas-capture-composition.test.ts
index 056fa80ba6..41915eef18 100644
--- a/packages/studio-server/src/test/generate-canvas-capture-composition.test.ts
+++ b/packages/studio-server/src/test/generate-canvas-capture-composition.test.ts
@@ -1,7 +1,7 @@
import {expect, test} from 'bun:test';
import {readFileSync} from 'node:fs';
import path from 'node:path';
-import {generateCanvasCaptureComposition} from '@remotion/studio-codemods';
+import {generateCanvasCaptureComposition} from '@remotion/studio-codemods/internal';
import {
CANVAS_CAPTURE_METADATA_TAG,
parseCanvasCaptureData,
diff --git a/packages/studio-server/src/test/insert-basic-captions.test.ts b/packages/studio-server/src/test/insert-basic-captions.test.ts
index ab8256dad6..ecb4a79769 100644
--- a/packages/studio-server/src/test/insert-basic-captions.test.ts
+++ b/packages/studio-server/src/test/insert-basic-captions.test.ts
@@ -11,7 +11,7 @@ import path from 'node:path';
import {
basicCaptionsElementSource,
getBasicCaptionsElementFile,
-} from '@remotion/studio-codemods';
+} from '@remotion/studio-codemods/internal';
import {insertBasicCaptions} from '../codemods/insert-basic-captions';
import {
createFileWatcherRegistry,
diff --git a/packages/studio-server/src/test/recast-mods.test.ts b/packages/studio-server/src/test/recast-mods.test.ts
index 1c06859c8d..c47e34a9d3 100644
--- a/packages/studio-server/src/test/recast-mods.test.ts
+++ b/packages/studio-server/src/test/recast-mods.test.ts
@@ -1,5 +1,5 @@
import {expect, test} from 'bun:test';
-import {parseAndApplyCodemod} from '@remotion/studio-codemods';
+import {parseAndApplyCodemod} from '@remotion/studio-codemods/internal';
const compositionInRoot = `import {Composition} from 'remotion';
import {NewVideo} from './NewVideo';
diff --git a/packages/studio-server/src/test/split-jsx-sequence.test.ts b/packages/studio-server/src/test/split-jsx-sequence.test.ts
index 308bfb8a24..592aa3d898 100644
--- a/packages/studio-server/src/test/split-jsx-sequence.test.ts
+++ b/packages/studio-server/src/test/split-jsx-sequence.test.ts
@@ -2,7 +2,7 @@ import {expect, test} from 'bun:test';
import {mkdtempSync, readFileSync, rmSync, writeFileSync} from 'node:fs';
import {tmpdir} from 'node:os';
import path from 'node:path';
-import {splitJsxSequence as splitJsxSequenceCodemod} from '@remotion/studio-codemods';
+import {splitJsxSequence as splitJsxSequenceCodemod} from '@remotion/studio-codemods/internal';
import {splitJsxSequence} from '../codemods/split-jsx-sequence';
import {
createFileWatcherRegistry,
diff --git a/packages/studio-shared/src/package-info.ts b/packages/studio-shared/src/package-info.ts
index b58ee6e2e3..bd849da276 100644
--- a/packages/studio-shared/src/package-info.ts
+++ b/packages/studio-shared/src/package-info.ts
@@ -190,7 +190,7 @@ export const descriptions: {[key in Pkgs]: string | null} = {
'browser-bundler': 'Compile virtual Remotion projects in the browser',
'browser-studio': 'Run Remotion Studio in the browser',
canvas: 'Headless primitives for Remotion authoring interfaces',
- 'studio-codemods': 'Shared codemods for Remotion Studio',
+ 'studio-codemods': 'Codemods for Remotion projects',
'studio-server': 'Run a Remotion Studio with a server backend',
'install-whisper-cpp': 'Helpers for installing and using Whisper.cpp',
'whisper-web': 'Helpers for using Whisper.cpp in browser using WASM',
@@ -432,7 +432,7 @@ export const apiDocs: {[key in Pkgs]: string | null} = {
'browser-bundler': 'https://www.remotion.dev/docs/browser-bundler',
'browser-studio': null,
canvas: null,
- 'studio-codemods': null,
+ 'studio-codemods': 'https://www.remotion.dev/docs/studio-codemods',
'lambda-client': null,
'serverless-client': null,
'studio-server': null,