🎥 Make videos programmatically with React
Declare source mutation metadata on Studio operations
Jonny Burger6c8eab72f6bb
diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.tsindex a6b667affe..f6d8c14076 100644--- a/packages/studio-shared/src/api-requests.ts+++ b/packages/studio-shared/src/api-requests.ts@@ -187,10 +187,16 @@ export type CopyStillToClipboardRequest = {binariesDirectory: string | null;};-type ReqAndRes<A, B> = {- Request: A;- Response: B;-};+class StudioOperation<Request, Response> {+ // Type-only fields keep request/response contracts on the operation definition.+ declare readonly Request: Request;+ declare readonly Response: Response;+ readonly mutatesSource: boolean;++ constructor({mutatesSource}: {mutatesSource: boolean}) {+ this.mutatesSource = mutatesSource;+ }+}type AddRenderRequestDynamicFields =| {@@ -1499,251 +1505,337 @@ export type LogStudioErrorResponse = {};// When adding a route, also update the Browser Studio parity checklist:// https://github.com/remotion-dev/remotion/issues/9807-export type ApiRoutes = {- '/api/shared-memory-capture-support': {- Request: {+export const studioOperations = {+ '/api/shared-memory-capture-support': new StudioOperation<+ {browserExecutable: string | null;chromeMode: ChromeMode;chromiumOptions: RequiredChromiumOptions;- };- Response: {supported: boolean};- };- '/api/invalidate-bundle': ReqAndRes<+ },+ {supported: boolean}+ >({mutatesSource: false}),+ '/api/invalidate-bundle': new StudioOperation<Record<string, never>,{didInvalidate: boolean}- >;- '/api/composition-component-info': ReqAndRes<+ >({mutatesSource: true}),+ '/api/composition-component-info': new StudioOperation<CompositionComponentInfoRequest,CompositionComponentInfoResponse- >;- '/api/cancel': ReqAndRes<CancelRenderRequest, CancelRenderResponse>;- '/api/render': ReqAndRes<AddRenderRequest, undefined>;- '/api/unsubscribe-from-file-existence': ReqAndRes<+ >({mutatesSource: false}),+ '/api/cancel': new StudioOperation<CancelRenderRequest, CancelRenderResponse>(+ {mutatesSource: false},+ ),+ '/api/render': new StudioOperation<AddRenderRequest, undefined>({+ mutatesSource: false,+ }),+ '/api/unsubscribe-from-file-existence': new StudioOperation<UnsubscribeFromFileExistenceRequest,undefined- >;- '/api/subscribe-to-file-existence': ReqAndRes<+ >({mutatesSource: false}),+ '/api/subscribe-to-file-existence': new StudioOperation<SubscribeToFileExistenceRequest,SubscribeToFileExistenceResponse- >;- '/api/remove-render': ReqAndRes<RemoveRenderRequest, undefined>;- '/api/open-in-editor': ReqAndRes<OpenInEditorRequest, OpenInEditorResponse>;- '/api/open-in-coding-agent': ReqAndRes<+ >({mutatesSource: false}),+ '/api/remove-render': new StudioOperation<RemoveRenderRequest, undefined>({+ mutatesSource: false,+ }),+ '/api/open-in-editor': new StudioOperation<+ OpenInEditorRequest,+ OpenInEditorResponse+ >({mutatesSource: false}),+ '/api/open-in-coding-agent': new StudioOperation<OpenInCodingAgentRequest,OpenInCodingAgentResponse- >;- '/api/app-info': ReqAndRes<GetAppInfoRequest, GetAppInfoResponse>;- '/api/find-in-file': ReqAndRes<FindInFileRequest, FindInFileResponse>;- '/api/open-in-file-explorer': ReqAndRes<OpenInFileExplorerRequest, void>;- '/api/open-in-terminal': ReqAndRes<+ >({mutatesSource: false}),+ '/api/app-info': new StudioOperation<GetAppInfoRequest, GetAppInfoResponse>({+ mutatesSource: false,+ }),+ '/api/find-in-file': new StudioOperation<+ FindInFileRequest,+ FindInFileResponse+ >({mutatesSource: false}),+ '/api/open-in-file-explorer': new StudioOperation<+ OpenInFileExplorerRequest,+ void+ >({mutatesSource: false}),+ '/api/open-in-terminal': new StudioOperation<OpenInTerminalRequest,OpenInTerminalResponse- >;- '/api/open-in-git-client': ReqAndRes<+ >({mutatesSource: false}),+ '/api/open-in-git-client': new StudioOperation<OpenInGitClientRequest,OpenInGitClientResponse- >;- '/api/register-client-render': ReqAndRes<CompletedClientRender, void>;- '/api/unregister-client-render': ReqAndRes<{id: string}, void>;- '/api/update-default-props': ReqAndRes<+ >({mutatesSource: false}),+ '/api/register-client-render': new StudioOperation<+ CompletedClientRender,+ void+ >({mutatesSource: false}),+ '/api/unregister-client-render': new StudioOperation<{id: string}, void>({+ mutatesSource: false,+ }),+ '/api/update-default-props': new StudioOperation<UpdateDefaultPropsRequest,UpdateDefaultPropsResponse- >;- '/api/apply-visual-control-change': ReqAndRes<+ >({mutatesSource: true}),+ '/api/apply-visual-control-change': new StudioOperation<ApplyVisualControlRequest,ApplyVisualControlResponse- >;- '/api/subscribe-to-default-props': ReqAndRes<+ >({mutatesSource: true}),+ '/api/subscribe-to-default-props': new StudioOperation<SubscribeToDefaultPropsRequest,SubscribeToDefaultPropsResponse- >;- '/api/unsubscribe-from-default-props': ReqAndRes<+ >({mutatesSource: false}),+ '/api/unsubscribe-from-default-props': new StudioOperation<UnsubscribeFromDefaultPropsRequest,undefined- >;- '/api/subscribe-to-sequence-props': ReqAndRes<+ >({mutatesSource: false}),+ '/api/subscribe-to-sequence-props': new StudioOperation<SubscribeToSequencePropsBatchRequest,SubscribeToSequencePropsBatchResponse- >;- '/api/unsubscribe-from-sequence-props': ReqAndRes<+ >({mutatesSource: false}),+ '/api/unsubscribe-from-sequence-props': new StudioOperation<UnsubscribeFromSequencePropsRequest,undefined- >;- '/api/save-sequence-props': ReqAndRes<+ >({mutatesSource: false}),+ '/api/save-sequence-props': new StudioOperation<SaveSequencePropsRequest,SaveSequencePropsResponse- >;- '/api/save-effect-props': ReqAndRes<+ >({mutatesSource: true}),+ '/api/save-effect-props': new StudioOperation<SaveEffectPropsRequest,SaveEffectPropsResponse- >;- '/api/save-multiple-effect-props': ReqAndRes<+ >({mutatesSource: true}),+ '/api/save-multiple-effect-props': new StudioOperation<SaveMultipleEffectPropsRequest,SaveMultipleEffectPropsResponse- >;- '/api/add-effect': ReqAndRes<AddEffectRequest, AddEffectResponse>;- '/api/reorder-effect': ReqAndRes<ReorderEffectRequest, ReorderEffectResponse>;- '/api/duplicate-effect': ReqAndRes<+ >({mutatesSource: true}),+ '/api/add-effect': new StudioOperation<AddEffectRequest, AddEffectResponse>({+ mutatesSource: true,+ }),+ '/api/reorder-effect': new StudioOperation<+ ReorderEffectRequest,+ ReorderEffectResponse+ >({mutatesSource: true}),+ '/api/duplicate-effect': new StudioOperation<DuplicateEffectRequest,DuplicateEffectResponse- >;- '/api/reorder-sequence': ReqAndRes<+ >({mutatesSource: true}),+ '/api/reorder-sequence': new StudioOperation<ReorderSequenceRequest,ReorderSequenceResponse- >;- '/api/delete-keyframes': ReqAndRes<+ >({mutatesSource: true}),+ '/api/delete-keyframes': new StudioOperation<DeleteKeyframesRequest,DeleteKeyframesResponse- >;- '/api/move-keyframes': ReqAndRes<MoveKeyframesRequest, MoveKeyframesResponse>;- '/api/add-sequence-keyframe': ReqAndRes<+ >({mutatesSource: true}),+ '/api/move-keyframes': new StudioOperation<+ MoveKeyframesRequest,+ MoveKeyframesResponse+ >({mutatesSource: true}),+ '/api/add-sequence-keyframe': new StudioOperation<AddSequenceKeyframeRequest,AddSequenceKeyframeResponse- >;- '/api/add-effect-keyframe': ReqAndRes<+ >({mutatesSource: true}),+ '/api/add-effect-keyframe': new StudioOperation<AddEffectKeyframeRequest,AddEffectKeyframeResponse- >;- '/api/add-keyframes': ReqAndRes<AddKeyframesRequest, AddKeyframesResponse>;- '/api/update-sequence-keyframe-settings': ReqAndRes<+ >({mutatesSource: true}),+ '/api/add-keyframes': new StudioOperation<+ AddKeyframesRequest,+ AddKeyframesResponse+ >({mutatesSource: true}),+ '/api/update-sequence-keyframe-settings': new StudioOperation<UpdateSequenceKeyframeSettingsRequest,UpdateSequenceKeyframeSettingsResponse- >;- '/api/update-effect-keyframe-settings': ReqAndRes<+ >({mutatesSource: true}),+ '/api/update-effect-keyframe-settings': new StudioOperation<UpdateEffectKeyframeSettingsRequest,UpdateEffectKeyframeSettingsResponse- >;- '/api/batch-update-keyframe-settings': ReqAndRes<+ >({mutatesSource: true}),+ '/api/batch-update-keyframe-settings': new StudioOperation<BatchUpdateKeyframeSettingsRequest,BatchUpdateKeyframeSettingsResponse- >;- '/api/delete-effect': ReqAndRes<DeleteEffectRequest, DeleteEffectResponse>;- '/api/paste-effects': ReqAndRes<PasteEffectsRequest, PasteEffectsResponse>;- '/api/delete-nodes': ReqAndRes<DeleteNodesRequest, DeleteNodesResponse>;- '/api/duplicate-nodes': ReqAndRes<+ >({mutatesSource: true}),+ '/api/delete-effect': new StudioOperation<+ DeleteEffectRequest,+ DeleteEffectResponse+ >({mutatesSource: true}),+ '/api/paste-effects': new StudioOperation<+ PasteEffectsRequest,+ PasteEffectsResponse+ >({mutatesSource: true}),+ '/api/delete-nodes': new StudioOperation<+ DeleteNodesRequest,+ DeleteNodesResponse+ >({mutatesSource: true}),+ '/api/duplicate-nodes': new StudioOperation<DuplicateNodesRequest,DuplicateNodesResponse- >;- '/api/precompose-jsx-nodes': ReqAndRes<+ >({mutatesSource: true}),+ '/api/precompose-jsx-nodes': new StudioOperation<PrecomposeJsxNodesRequest,PrecomposeJsxNodesResponse- >;- '/api/wrap-node': ReqAndRes<WrapNodeRequest, WrapNodeResponse>;- '/api/split-sequences': ReqAndRes<+ >({mutatesSource: true}),+ '/api/wrap-node': new StudioOperation<WrapNodeRequest, WrapNodeResponse>({+ mutatesSource: true,+ }),+ '/api/split-sequences': new StudioOperation<SplitSequencesRequest,SplitSequencesResponse- >;- '/api/split-video-from-audio': ReqAndRes<+ >({mutatesSource: true}),+ '/api/split-video-from-audio': new StudioOperation<SplitVideoFromAudioRequest,SplitVideoFromAudioResponse- >;- '/api/insert-basic-captions': ReqAndRes<+ >({mutatesSource: true}),+ '/api/insert-basic-captions': new StudioOperation<InsertBasicCaptionsRequest,InsertBasicCaptionsResponse- >;- '/api/replace-video-source': ReqAndRes<+ >({mutatesSource: true}),+ '/api/replace-video-source': new StudioOperation<ReplaceVideoSourceRequest,ReplaceVideoSourceResponse- >;- '/api/insert-composition-element': ReqAndRes<+ >({mutatesSource: true}),+ '/api/insert-composition-element': new StudioOperation<InsertCompositionElementRequest,InsertCompositionElementResponse- >;- '/api/convert-figma-clipboard-to-svg': ReqAndRes<+ >({mutatesSource: true}),+ '/api/convert-figma-clipboard-to-svg': new StudioOperation<ConvertFigmaClipboardToSvgRequest,ConvertFigmaClipboardToSvgResponse- >;- '/api/insert-element': ReqAndRes<InsertElementRequest, InsertElementResponse>;- '/api/prepare-element-install': ReqAndRes<+ >({mutatesSource: false}),+ '/api/insert-element': new StudioOperation<+ InsertElementRequest,+ InsertElementResponse+ >({mutatesSource: true}),+ '/api/prepare-element-install': new StudioOperation<PrepareElementInstallRequest,PrepareElementInstallResponse- >;- '/api/update-element-install-target': ReqAndRes<+ >({mutatesSource: true}),+ '/api/update-element-install-target': new StudioOperation<UpdateElementInstallTargetRequest,UpdateElementInstallTargetResponse- >;- '/api/download-remote-asset': ReqAndRes<+ >({mutatesSource: false}),+ '/api/download-remote-asset': new StudioOperation<DownloadRemoteAssetRequest,DownloadRemoteAssetResponse- >;- '/api/update-available': ReqAndRes<+ >({mutatesSource: false}),+ '/api/update-available': new StudioOperation<UpdateAvailableRequest,UpdateAvailableResponse- >;- '/api/release-notes': ReqAndRes<+ >({mutatesSource: false}),+ '/api/release-notes': new StudioOperation<GetReleaseNotesRequest,GetReleaseNotesResponse- >;- '/api/remotion-skills-info': ReqAndRes<+ >({mutatesSource: false}),+ '/api/remotion-skills-info': new StudioOperation<GetRemotionSkillsInfoRequest,GetRemotionSkillsInfoResponse- >;- '/api/install-remotion-skill': ReqAndRes<+ >({mutatesSource: false}),+ '/api/install-remotion-skill': new StudioOperation<InstallRemotionSkillRequest,GetRemotionSkillsInfoResponse- >;- '/api/remove-remotion-skill': ReqAndRes<+ >({mutatesSource: false}),+ '/api/remove-remotion-skill': new StudioOperation<RemoveRemotionSkillRequest,GetRemotionSkillsInfoResponse- >;- '/api/upgrade-remotion-skill': ReqAndRes<+ >({mutatesSource: false}),+ '/api/upgrade-remotion-skill': new StudioOperation<UpgradeRemotionSkillRequest,GetRemotionSkillsInfoResponse- >;- '/api/open-remotion-skill': ReqAndRes<OpenRemotionSkillRequest, void>;- '/api/add-composition': ReqAndRes<+ >({mutatesSource: false}),+ '/api/open-remotion-skill': new StudioOperation<+ OpenRemotionSkillRequest,+ void+ >({mutatesSource: false}),+ '/api/add-composition': new StudioOperation<AddCompositionRequest,CompositionEditResponse- >;- '/api/duplicate-composition': ReqAndRes<+ >({mutatesSource: true}),+ '/api/duplicate-composition': new StudioOperation<DuplicateCompositionRequest,CompositionEditResponse- >;- '/api/rename-composition': ReqAndRes<+ >({mutatesSource: true}),+ '/api/rename-composition': new StudioOperation<RenameCompositionRequest,CompositionEditResponse- >;- '/api/update-composition-metadata': ReqAndRes<+ >({mutatesSource: true}),+ '/api/update-composition-metadata': new StudioOperation<UpdateCompositionMetadataRequest,CompositionEditResponse- >;- '/api/delete-composition': ReqAndRes<+ >({mutatesSource: true}),+ '/api/delete-composition': new StudioOperation<DeleteCompositionRequest,CompositionEditResponse- >;- '/api/move-composition': ReqAndRes<+ >({mutatesSource: true}),+ '/api/move-composition': new StudioOperation<MoveCompositionRequest,CompositionEditResponse- >;- '/api/add-folder': ReqAndRes<AddFolderRequest, CompositionEditResponse>;- '/api/rename-folder': ReqAndRes<RenameFolderRequest, CompositionEditResponse>;- '/api/unwrap-folder': ReqAndRes<UnwrapFolderRequest, CompositionEditResponse>;- '/api/move-folder': ReqAndRes<MoveFolderRequest, CompositionEditResponse>;- '/api/project-info': ReqAndRes<ProjectInfoRequest, ProjectInfoResponse>;- '/api/delete-static-file': ReqAndRes<+ >({mutatesSource: true}),+ '/api/add-folder': new StudioOperation<+ AddFolderRequest,+ CompositionEditResponse+ >({mutatesSource: true}),+ '/api/rename-folder': new StudioOperation<+ RenameFolderRequest,+ CompositionEditResponse+ >({mutatesSource: true}),+ '/api/unwrap-folder': new StudioOperation<+ UnwrapFolderRequest,+ CompositionEditResponse+ >({mutatesSource: true}),+ '/api/move-folder': new StudioOperation<+ MoveFolderRequest,+ CompositionEditResponse+ >({mutatesSource: true}),+ '/api/project-info': new StudioOperation<+ ProjectInfoRequest,+ ProjectInfoResponse+ >({mutatesSource: false}),+ '/api/delete-static-file': new StudioOperation<DeleteStaticFileRequest,DeleteStaticFileResponse- >;- '/api/rename-static-file': ReqAndRes<+ >({mutatesSource: false}),+ '/api/rename-static-file': new StudioOperation<RenameStaticFileRequest,RenameStaticFileResponse- >;- '/api/copy-render-output-to-asset': ReqAndRes<+ >({mutatesSource: false}),+ '/api/copy-render-output-to-asset': new StudioOperation<CopyRenderOutputToAssetRequest,CopyRenderOutputToAssetResponse- >;- '/api/upgrade-remotion': ReqAndRes<{version: string}, {}>;- '/api/shutdown-studio': ReqAndRes<{}, ShutdownStudioResponse>;- '/api/restart-studio': ReqAndRes<RestartStudioRequest, RestartStudioResponse>;- '/api/update-config': ReqAndRes<UpdateConfigRequest, UpdateConfigResponse>;- '/api/install-package': ReqAndRes<+ >({mutatesSource: false}),+ '/api/upgrade-remotion': new StudioOperation<{version: string}, {}>({+ mutatesSource: false,+ }),+ '/api/shutdown-studio': new StudioOperation<{}, ShutdownStudioResponse>({+ mutatesSource: false,+ }),+ '/api/restart-studio': new StudioOperation<+ RestartStudioRequest,+ RestartStudioResponse+ >({mutatesSource: false}),+ '/api/update-config': new StudioOperation<+ UpdateConfigRequest,+ UpdateConfigResponse+ >({mutatesSource: false}),+ '/api/install-package': new StudioOperation<InstallPackageRequest,InstallPackageResponse- >;- '/api/undo': ReqAndRes<UndoRequest, UndoResponse>;- '/api/redo': ReqAndRes<RedoRequest, RedoResponse>;- '/api/log-studio-error': ReqAndRes<+ >({mutatesSource: false}),+ '/api/undo': new StudioOperation<UndoRequest, UndoResponse>({+ mutatesSource: true,+ }),+ '/api/redo': new StudioOperation<RedoRequest, RedoResponse>({+ mutatesSource: true,+ }),+ '/api/log-studio-error': new StudioOperation<LogStudioErrorRequest,LogStudioErrorResponse+ >({mutatesSource: false}),+};++export type ApiRoutes = {+ [Endpoint in keyof typeof studioOperations]: Pick<+ (typeof studioOperations)[Endpoint],+ 'Request' | 'Response'>;};diff --git a/packages/studio-shared/src/index.ts b/packages/studio-shared/src/index.tsindex f35b12a439..3c046a229d 100644--- a/packages/studio-shared/src/index.ts+++ b/packages/studio-shared/src/index.ts@@ -1,3 +1,4 @@+export {studioOperations} from './api-requests';export {splitAnsi, stripAnsi} from './ansi';export type {TerminalId} from './terminal';export type {GitClientId} from './git-client';diff --git a/packages/studio/src/components/call-api.ts b/packages/studio/src/components/call-api.tsindex f06d625fae..a1ea6b9785 100644--- a/packages/studio/src/components/call-api.ts+++ b/packages/studio/src/components/call-api.ts@@ -1,7 +1,6 @@-import type {ApiRoutes} from '@remotion/studio-shared';+import {studioOperations, type ApiRoutes} from '@remotion/studio-shared';import {enqueueStudioSourceMutation} from '../helpers/enqueue-studio-source-mutation';import {queueSequenceNodePathMutationFromApiResponse} from '../helpers/sequence-node-path-mutations';-import {sourceMutationEndpoints} from '../helpers/source-mutation-endpoints';const callApiImmediately = <Endpoint extends keyof ApiRoutes>(endpoint: Endpoint,@@ -43,7 +42,7 @@ export const callApi = <Endpoint extends keyof ApiRoutes>(body: ApiRoutes[Endpoint]['Request'],signal?: AbortSignal,): Promise<ApiRoutes[Endpoint]['Response']> => {- if (!sourceMutationEndpoints.has(endpoint)) {+ if (!studioOperations[endpoint].mutatesSource) {return callApiImmediately(endpoint, body, signal);}diff --git a/packages/studio/src/helpers/browser-studio-operations.ts b/packages/studio/src/helpers/browser-studio-operations.tsindex 24e11eb833..c85d224ae1 100644--- a/packages/studio/src/helpers/browser-studio-operations.ts+++ b/packages/studio/src/helpers/browser-studio-operations.ts@@ -1,6 +1,9 @@-import type {ApiRoutes, BrowserStudioOperations} from '@remotion/studio-shared';+import {+ studioOperations,+ type ApiRoutes,+ type BrowserStudioOperations,+} from '@remotion/studio-shared';import {enqueueStudioSourceMutation} from './enqueue-studio-source-mutation';-import {sourceMutationEndpoints} from './source-mutation-endpoints';const queuedOperations = new WeakMap<object, object>();@@ -35,7 +38,7 @@ const withMutationQueue = <T extends object>(operations: T): T => {: property;const endpoint =`/api/${name.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`)}` as keyof ApiRoutes;- const queued = sourceMutationEndpoints.has(endpoint)+ const queued = studioOperations[endpoint]?.mutatesSource? (...args: unknown[]) =>enqueueStudioSourceMutation(endpoint, args[0], () =>value.apply(target, args),diff --git a/packages/studio/src/helpers/source-mutation-endpoints.ts b/packages/studio/src/helpers/source-mutation-endpoints.tsdeleted file mode 100644index 212358441a..0000000000--- a/packages/studio/src/helpers/source-mutation-endpoints.ts+++ /dev/null@@ -1,49 +0,0 @@-import type {ApiRoutes} from '@remotion/studio-shared';--// Source mutations share one command stream with undo/redo. Reads and long-running-// asset processing must remain independent of this queue.-export const sourceMutationEndpoints: ReadonlySet<keyof ApiRoutes> = new Set([- '/api/add-composition',- '/api/add-effect',- '/api/add-effect-keyframe',- '/api/add-folder',- '/api/add-keyframes',- '/api/add-sequence-keyframe',- '/api/apply-visual-control-change',- '/api/batch-update-keyframe-settings',- '/api/delete-composition',- '/api/delete-effect',- '/api/delete-keyframes',- '/api/delete-nodes',- '/api/duplicate-composition',- '/api/duplicate-effect',- '/api/duplicate-nodes',- '/api/insert-composition-element',- '/api/insert-element',- '/api/insert-basic-captions',- '/api/replace-video-source',- '/api/invalidate-bundle',- '/api/move-composition',- '/api/move-folder',- '/api/move-keyframes',- '/api/paste-effects',- '/api/precompose-jsx-nodes',- '/api/prepare-element-install',- '/api/redo',- '/api/rename-composition',- '/api/rename-folder',- '/api/reorder-effect',- '/api/reorder-sequence',- '/api/save-effect-props',- '/api/save-multiple-effect-props',- '/api/save-sequence-props',- '/api/split-sequences',- '/api/split-video-from-audio',- '/api/undo',- '/api/unwrap-folder',- '/api/update-composition-metadata',- '/api/update-default-props',- '/api/update-effect-keyframe-settings',- '/api/update-sequence-keyframe-settings',- '/api/wrap-node',-]);