Skip to content

🎥 Make videos programmatically with React

2.5 KB
Raw Blame
import {Internals} from 'remotion';
import type {CodemodProject} from './codemod-project';
import {getNodeProps} from './get-node-props';
import {getNodes} from './get-nodes';
import type {ResolveCompositionComponentOptions} from './resolve-composition-component';

export type CompositionTarget = {
	compositionFile: string;
	compositionId: string;
};

export type CompositionMetadata = {
	width: number;
	height: number;
	fps: number;
	durationInFrames: number;
};

export type FolderReference = {
	name: string;
	parentName: string | null;
};

const getCompositionNodes = ({
	project,
	compositionFile,
}: {
	project: CodemodProject;
	compositionFile: string;
}) => {
	return getNodes({project, filePath: compositionFile})
		.filter(
			(node) =>
				node.componentIdentity === 'dev.remotion.remotion.Composition' ||
				node.componentIdentity === 'dev.remotion.remotion.Still',
		)
		.map((node) => {
			const status = getNodeProps({project, node, keys: ['id']}).props.id;
			return {
				node: {
					...node,
					tagName:
						node.componentIdentity === 'dev.remotion.remotion.Still'
							? 'Still'
							: 'Composition',
				},
				id: status.status === 'static' ? status.codeValue : null,
			};
		});
};

export const requireComposition = ({
	project,
	compositionFile,
	compositionId,
}: ResolveCompositionComponentOptions) => {
	const matches = getCompositionNodes({project, compositionFile}).filter(
		({id}) => id === compositionId,
	);
	if (matches.length !== 1) {
		throw new Error(
			`Expected one composition with ID "${compositionId}" in "${compositionFile}", found ${matches.length}`,
		);
	}

	return matches[0].node;
};

export const assertNewCompositionId = ({
	project,
	compositionFile,
	compositionId,
}: ResolveCompositionComponentOptions) => {
	if (!Internals.isCompositionIdValid(compositionId)) {
		throw new Error(Internals.invalidCompositionErrorMessage);
	}

	if (
		getCompositionNodes({project, compositionFile}).some(
			({id}) => id === compositionId,
		)
	) {
		throw new Error(
			`Composition "${compositionId}" already exists in "${compositionFile}"`,
		);
	}
};

export const validateMetadata = (metadata: Partial<CompositionMetadata>) => {
	for (const [key, value] of Object.entries(metadata)) {
		if (value === undefined) {
			continue;
		}

		if (
			!Number.isFinite(value) ||
			value <= 0 ||
			(key !== 'fps' && !Number.isInteger(value))
		) {
			throw new Error(
				`${key} must be ${key === 'fps' ? 'a positive finite number' : 'a positive integer'}`,
			);
		}
	}
};