🎥 Make videos programmatically with React
Merge pull request #10985 from remotion-dev/studio-shared-decouple-protocol
Igor Samokhovetsaa8cf57c355b
diff --git a/bun.lock b/bun.lockindex 74d8cdd310..0f008ba620 100644--- a/bun.lock+++ b/bun.lock@@ -1901,7 +1901,6 @@"name": "@remotion/studio-shared","version": "4.0.519","dependencies": {- "@remotion/studio-protocol": "workspace:*","remotion": "workspace:*",},"devDependencies": {diff --git a/packages/browser-studio/src/browser-studio-operations.ts b/packages/browser-studio/src/browser-studio-operations.tsindex f770bc031b..21e307f160 100644--- a/packages/browser-studio/src/browser-studio-operations.ts+++ b/packages/browser-studio/src/browser-studio-operations.ts@@ -1952,7 +1952,11 @@ export const createBrowserStudioOperations = ({return value === null? null: {- element: value.payload.element,+ element: {+ ...value.payload.element,+ durationInFrames: value.payload.element.durationInFrames ?? null,+ installationMode: value.payload.element.installationMode ?? null,+ },sourceOrigin: value.sourceOrigin,};},diff --git a/packages/browser-studio/src/test/browser-studio-operations.test.ts b/packages/browser-studio/src/test/browser-studio-operations.test.tsindex 4055645dc0..562b3c159e 100644--- a/packages/browser-studio/src/test/browser-studio-operations.test.ts+++ b/packages/browser-studio/src/test/browser-studio-operations.test.ts@@ -52,7 +52,11 @@ test('consumes an initial Element payload only once', () => {});expect(operations.consumeInitialElement()).toEqual({- element: payload.element,+ element: {+ ...payload.element,+ durationInFrames: 60,+ installationMode: 'wrapped',+ },sourceOrigin: 'https://elements.example.test',});expect(operations.consumeInitialElement()).toBe(null);diff --git a/packages/studio-shared/src/test/asset-drag-data.test.ts b/packages/studio-protocol/src/test/asset-drag-data.test.tssimilarity index 94%rename from packages/studio-shared/src/test/asset-drag-data.test.tsrename to packages/studio-protocol/src/test/asset-drag-data.test.tsindex 2255b9f337..0eea34e659 100644--- a/packages/studio-shared/src/test/asset-drag-data.test.ts+++ b/packages/studio-protocol/src/test/asset-drag-data.test.ts@@ -1,5 +1,5 @@import {expect, test} from 'bun:test';-import {StudioProtocolInternals} from '@remotion/studio-protocol';+import {StudioProtocolInternals} from '../index';const assetMimeType = StudioProtocolInternals.makeDragData({type: 'asset',diff --git a/packages/studio-shared/src/test/component-drag-data.test.ts b/packages/studio-protocol/src/test/component-drag-data.test.tssimilarity index 99%rename from packages/studio-shared/src/test/component-drag-data.test.tsrename to packages/studio-protocol/src/test/component-drag-data.test.tsindex c4e24746ea..49cb475270 100644--- a/packages/studio-shared/src/test/component-drag-data.test.ts+++ b/packages/studio-protocol/src/test/component-drag-data.test.ts@@ -2,7 +2,7 @@ import {expect, test} from 'bun:test';import {StudioProtocolInternals,type MakeComponentDragDataInput,-} from '@remotion/studio-protocol';+} from '../index';const makeComponentDragData = (input: Omit<MakeComponentDragDataInput, 'type'>,diff --git a/packages/studio-shared/src/test/element-drag-data.test.ts b/packages/studio-protocol/src/test/element-drag-data.test.tssimilarity index 98%rename from packages/studio-shared/src/test/element-drag-data.test.tsrename to packages/studio-protocol/src/test/element-drag-data.test.tsindex 5f4a0c8508..90259658c0 100644--- a/packages/studio-shared/src/test/element-drag-data.test.ts+++ b/packages/studio-protocol/src/test/element-drag-data.test.ts@@ -1,8 +1,5 @@import {expect, test} from 'bun:test';-import {- StudioProtocolInternals,- type ElementDragData,-} from '@remotion/studio-protocol';+import {StudioProtocolInternals, type ElementDragData} from '../index';type ElementInput = Omit<ElementDragData['element'], 'durationInFrames'>;diff --git a/packages/studio-shared/src/test/sfx-drag-data.test.ts b/packages/studio-protocol/src/test/sfx-drag-data.test.tssimilarity index 84%rename from packages/studio-shared/src/test/sfx-drag-data.test.tsrename to packages/studio-protocol/src/test/sfx-drag-data.test.tsindex 85fb70285c..582501297c 100644--- a/packages/studio-shared/src/test/sfx-drag-data.test.ts+++ b/packages/studio-protocol/src/test/sfx-drag-data.test.ts@@ -1,9 +1,5 @@import {expect, test} from 'bun:test';-import {- StudioProtocolInternals,- type SfxDragData,-} from '@remotion/studio-protocol';-import {isUrl} from '../url';+import {StudioProtocolInternals, type SfxDragData} from '../index';const sfxMimeType = StudioProtocolInternals.makeDragData({type: 'sfx',@@ -44,9 +40,6 @@ test('accepts any URL in SFX drag data', () => {expect(parseSfxDragData(JSON.stringify(nonRemotionUrlDragData))).toEqual(nonRemotionUrlDragData,);- expect(isUrl('https://remotion.media/whip.wav')).toBe(true);- expect(isUrl('https://example.com/whip.wav')).toBe(true);- expect(isUrl('not-a-url')).toBe(false);});test('rejects invalid SFX drag data', () => {diff --git a/packages/studio-server/src/preview-server/routes/insert-element.ts b/packages/studio-server/src/preview-server/routes/insert-element.tsindex 254871d741..f80a484463 100644--- a/packages/studio-server/src/preview-server/routes/insert-element.ts+++ b/packages/studio-server/src/preview-server/routes/insert-element.ts@@ -74,7 +74,10 @@ export const insertElementHandler: ApiHandler<throw new Error('from must be a non-negative integer');}- const installationMode = element.installationMode ?? 'wrapped';+ const installationMode =+ element.installationMode === null+ ? 'wrapped'+ : element.installationMode;const componentOwnsSequence =installationMode === 'component-owned-sequence';@@ -150,7 +153,7 @@ export const insertElementHandler: ApiHandler<importPath: plan.importPath,props: componentOwnsSequence? [- ...(element.durationInFrames === undefined+ ...(element.durationInFrames === null? []: [{@@ -169,7 +172,7 @@ export const insertElementHandler: ApiHandler<? null: {dimensions: element.dimensions,- durationInFrames: element.durationInFrames ?? null,+ durationInFrames: element.durationInFrames,from,name: element.displayName,position,diff --git a/packages/studio-server/src/preview-server/studio-protocol/handle-install.ts b/packages/studio-server/src/preview-server/studio-protocol/handle-install.tsindex c786510aa0..0981c85ac4 100644--- a/packages/studio-server/src/preview-server/studio-protocol/handle-install.ts+++ b/packages/studio-server/src/preview-server/studio-protocol/handle-install.ts@@ -1,5 +1,8 @@import type {IncomingMessage, ServerResponse} from 'node:http';-import {StudioProtocolInternals} from '@remotion/studio-protocol';+import {+ StudioProtocolInternals,+ type StudioElementPayload,+} from '@remotion/studio-protocol';import type {ElementInstallRequest} from '@remotion/studio-shared';import type {getElementInstallTarget} from '../element-install-state';import {consumeStudioProtocolTarget} from '../element-install-state';@@ -24,7 +27,7 @@ const deliverElementInstall = ({origin,target,}: {- readonly element: ElementInstallRequest['element'];+ readonly element: StudioElementPayload['element'];readonly focusStudioTab: FocusStudioTab;readonly liveEventsServer: LiveEventsServer;readonly origin: string;@@ -40,7 +43,11 @@ const deliverElementInstall = ({createdAt: Date.now(),compositionFile: target.compositionFile,compositionId: target.compositionId,- element,+ element: {+ ...element,+ durationInFrames: element.durationInFrames ?? null,+ installationMode: element.installationMode ?? null,+ },from: null,position: null,source: {diff --git a/packages/studio-server/src/test/insert-element.test.ts b/packages/studio-server/src/test/insert-element.test.tsindex f8dcc79577..8ac0c98243 100644--- a/packages/studio-server/src/test/insert-element.test.ts+++ b/packages/studio-server/src/test/insert-element.test.ts@@ -54,6 +54,7 @@ const element: InsertElementRequest['element'] = {dependencies: [],dimensions: {width: 900, height: 260},durationInFrames: 72,+ installationMode: null,displayName: 'Lower Third',slug: 'overlays/lower-third',sourceCode: incomingElementSource,diff --git a/packages/studio-shared/package.json b/packages/studio-shared/package.jsonindex 53455a48d3..bdfe8a8358 100644--- a/packages/studio-shared/package.json+++ b/packages/studio-shared/package.json@@ -21,7 +21,6 @@"url": "https://github.com/remotion-dev/remotion/issues"},"dependencies": {- "@remotion/studio-protocol": "workspace:*","remotion": "workspace:*"},"devDependencies": {diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.tsindex 986d990962..22c0c503c6 100644--- a/packages/studio-shared/src/api-requests.ts+++ b/packages/studio-shared/src/api-requests.ts@@ -12,7 +12,6 @@ import type {X264Preset,} from '@remotion/renderer';import type {HardwareAccelerationOption} from '@remotion/renderer/client';-import type {ComponentProp, ElementDragData} from '@remotion/studio-protocol';import type {_InternalTypes,CannotUpdateSequenceReason,@@ -46,6 +45,54 @@ import type {SymbolicatedStackFrame} from './stack-types';import type {EnumPath} from './stringify-default-props';import type {TerminalId} from './terminal';+export type ComponentProp = {+ name: string;+ value: string | number | boolean;+};++export type EffectConfigValue =+ | string+ | number+ | boolean+ | null+ | EffectConfig+ | readonly EffectConfigValue[];++export type EffectConfig = {+ readonly [key: string]: EffectConfigValue;+};++export type EffectDefinition = {+ readonly name: string;+ readonly importPath: string;+ readonly config: EffectConfig;+};++export type ElementInstallationMode = 'wrapped' | 'component-owned-sequence';++export type ElementDependency =+ | {+ readonly name: `@remotion/${string}`;+ readonly version: null;+ }+ | {+ readonly name: string;+ readonly version: string;+ };++export type InstallableElement = {+ dependencies: ElementDependency[];+ durationInFrames: number | null;+ installationMode: ElementInstallationMode | null;+ slug: string;+ displayName: string;+ sourceCode: string;+ dimensions: {+ height: number;+ width: number;+ } | null;+};+type KeyframeEasing = Extract<CanUpdateSequencePropStatus,{status: 'keyframed'}@@ -508,7 +555,7 @@ export type AddEffectRequest = {sequenceNodePath: SequencePropsSubscriptionKey;effectName: string;effectImportPath: string;- effectConfig: Record<string, unknown>;+ effectConfig: EffectConfig;clientId: string;};@@ -962,7 +1009,7 @@ export type ElementInstallDestination =export type PrepareElementInstallRequest = {destination: ElementInstallDestination;- element: ElementDragData['element'];+ element: InstallableElement;};export type PrepareElementInstallResponse =@@ -983,7 +1030,7 @@ export type PrepareElementInstallResponse =export type InsertElementRequest = {compositionFile: string;compositionId: string;- element: ElementDragData['element'];+ element: InstallableElement;expectedFileState: ElementInstallExpectedFileState | null;from: number | null;position: InsertableCompositionElementPosition | null;@@ -1032,7 +1079,7 @@ export type ElementInstallRequest = {createdAt: number;compositionFile: string;compositionId: string;- element: ElementDragData['element'];+ element: InstallableElement;from: number | null;position: InsertableCompositionElementPosition | null;source: ElementInstallSource;diff --git a/packages/studio-shared/src/browser-studio-operations.ts b/packages/studio-shared/src/browser-studio-operations.tsindex 4ca5240ac0..0e4aed619c 100644--- a/packages/studio-shared/src/browser-studio-operations.ts+++ b/packages/studio-shared/src/browser-studio-operations.ts@@ -1,4 +1,3 @@-import type {ElementDragData} from '@remotion/studio-protocol';import type {AddEffectKeyframeRequest,AddEffectKeyframeResponse,@@ -35,6 +34,7 @@ import type {InsertElementRequest,InsertElementResponse,InstallPackageRequest,+ InstallableElement,MoveKeyframesRequest,MoveKeyframesResponse,PasteEffectsRequest,@@ -160,7 +160,7 @@ export type BrowserStudioPackageInstallationOperations = {export type BrowserStudioOperations = {consumeInitialElement: () => {- element: ElementDragData['element'];+ element: InstallableElement;sourceOrigin: string | null;} | null;applyCodemod: (request: ApplyCodemodRequest) => Promise<ApplyCodemodResponse>;diff --git a/packages/studio-shared/src/effect-catalog.ts b/packages/studio-shared/src/effect-catalog.tsindex d8c5a7f47b..062fe9f731 100644--- a/packages/studio-shared/src/effect-catalog.ts+++ b/packages/studio-shared/src/effect-catalog.ts@@ -1,11 +1,11 @@-import type {EffectDragData} from '@remotion/studio-protocol';+import type {EffectDefinition} from './api-requests';export type EffectCatalogItem = {readonly id: string;readonly category: string;readonly label: string;readonly description: string;- readonly effect: EffectDragData['effect'];+ readonly effect: EffectDefinition;};export type EffectCatalogCategory = {diff --git a/packages/studio-shared/src/index.ts b/packages/studio-shared/src/index.tsindex b669e4fdd3..a7f05eddf8 100644--- a/packages/studio-shared/src/index.ts+++ b/packages/studio-shared/src/index.ts@@ -27,6 +27,7 @@ export {CaptionPatch,CompositionComponentInfoRequest,CompositionComponentInfoResponse,+ ComponentProp,ConvertFigmaClipboardToSvgRequest,ConvertFigmaClipboardToSvgResponse,CopyRenderOutputToAssetRequest,@@ -53,6 +54,7 @@ export {DuplicateJsxNodeRequestItem,DuplicateJsxNodeResponse,EditorPickerId,+ EffectDefinition,ElementInstallDestination,ElementInstallExpectedFileState,ElementInstallRequest,@@ -75,6 +77,7 @@ export {InsertJsxElementResponse,InsertableCompositionElement,InsertableCompositionElementPosition,+ InstallableElement,InstallPackageRequest,InstallPackageResponse,LogStudioErrorRequest,diff --git a/packages/studio-shared/tsconfig.json b/packages/studio-shared/tsconfig.jsonindex 1fe83c1c7b..ba4199362d 100644--- a/packages/studio-shared/tsconfig.json+++ b/packages/studio-shared/tsconfig.json@@ -8,9 +8,6 @@},"include": ["src"],"references": [- {- "path": "../studio-protocol"- },{"path": "../renderer"}diff --git a/packages/studio/src/components/effect-drag-and-drop.ts b/packages/studio/src/components/effect-drag-and-drop.tsindex 7885b1693e..50f8d12c57 100644--- a/packages/studio/src/components/effect-drag-and-drop.ts+++ b/packages/studio/src/components/effect-drag-and-drop.ts@@ -2,7 +2,10 @@ import {StudioProtocolInternals,type EffectDragData,} from '@remotion/studio-protocol';-import {getRequiredPackageForEffectImportPath} from '@remotion/studio-shared';+import {+ type EffectDefinition,+ getRequiredPackageForEffectImportPath,+} from '@remotion/studio-shared';import type {SequencePropsSubscriptionKey} from 'remotion';import {getBrowserStudioEffectOperations} from '../helpers/browser-studio-operations';import {installRequiredPackages} from '../helpers/install-required-package';@@ -53,7 +56,7 @@ export const addEffectToSequence = async ({nodePath,}: {readonly clientId: string;- readonly effect: EffectDragData['effect'];+ readonly effect: EffectDefinition;readonly fileName: string;readonly nodePath: SequencePropsSubscriptionKey;}) => {diff --git a/packages/studio/src/components/handle-drop.ts b/packages/studio/src/components/handle-drop.tsindex c21412aea4..7f7de6890c 100644--- a/packages/studio/src/components/handle-drop.ts+++ b/packages/studio/src/components/handle-drop.ts@@ -137,7 +137,11 @@ export const handleDrop = async ({createdAt: Date.now(),compositionFile,compositionId,- element: element.element,+ element: {+ ...element.element,+ durationInFrames: element.element.durationInFrames ?? null,+ installationMode: element.element.installationMode ?? null,+ },from: getFromForDrop({durationInFrames: element.element.durationInFrames,from,diff --git a/packages/studio/src/components/import-assets.ts b/packages/studio/src/components/import-assets.tsindex 64b6dbe768..9b6b5425e1 100644--- a/packages/studio/src/components/import-assets.ts+++ b/packages/studio/src/components/import-assets.ts@@ -1,17 +1,15 @@-import {- type ComponentDragData,- type ComponentProp,- type ElementDragData,-} from '@remotion/studio-protocol';+import type {ComponentDragData} from '@remotion/studio-protocol';import {detectFileType,getRequiredPackageForInsertableElement,isUrl,+ type ComponentProp,type DownloadRemoteAssetResponse,type ElementInstallExpectedFileState,type FileType,type InsertableCompositionElement,type InsertableCompositionElementPosition,+ type InstallableElement,} from '@remotion/studio-shared';import {Internals, staticFile} from 'remotion';import {NoReactInternals} from 'remotion/no-react';@@ -1330,7 +1328,7 @@ export const insertElement = async ({}: {compositionFile: string;compositionId: string;- element: ElementDragData['element'];+ element: InstallableElement;expectedFileState: ElementInstallExpectedFileState;position: InsertableCompositionElementPosition | null;from: number | null;