🎥 Make videos programmatically with React
// Must keep this file in sync with the one in packages/lambda/src/shared/serialize-props.ts!
import {getRemotionEnvironment} from './get-remotion-environment.js';
export type SerializedJSONWithCustomFields = {
serializedString: string;
customDateUsed: boolean;
customFileUsed: boolean;
mapUsed: boolean;
setUsed: boolean;
};
export const DATE_TOKEN = 'remotion-date:';
export const FILE_TOKEN = 'remotion-file:';
export const serializeJSONWithSpecialTypes = ({
data,
indent,
staticBase,
}: {
data: Record<string, unknown>;
indent: number | undefined;
staticBase: string | null;
}): SerializedJSONWithCustomFields => {
let customDateUsed = false;
let customFileUsed = false;
let mapUsed = false;
let setUsed = false;
try {
const serializedString = JSON.stringify(
data,
function (key, value) {
const item = (this as Record<string, unknown>)[key];
if (item instanceof Date) {
customDateUsed = true;
return `${DATE_TOKEN}${item.toISOString()}`;
}
if (item instanceof Map) {
mapUsed = true;
return value;
}
if (item instanceof Set) {
setUsed = true;
return value;
}
if (
typeof item === 'string' &&
staticBase !== null &&
staticBase !== '' &&
item.startsWith(staticBase)
) {
customFileUsed = true;
return `${FILE_TOKEN}${item.replace(staticBase + '/', '')}`;
}
return value;
},
indent,
);
return {serializedString, customDateUsed, customFileUsed, mapUsed, setUsed};
} catch (err) {
throw new Error(
'Could not serialize the passed input props to JSON: ' +
(err as Error).message,
);
}
};
export const resolveFileTokenToUrl = (value: string) => {
const encodedName = value.replace(FILE_TOKEN, '');
let name = encodedName;
try {
name = encodedName.split('/').map(decodeURIComponent).join('/');
} catch {
// Keep the encoded name if it contains an invalid escape sequence.
}
const matchingStaticFile = window.remotion_staticFiles?.find(
(file) => file.name === name,
);
if (matchingStaticFile) {
return matchingStaticFile.src;
}
return `${window.remotion_staticBase}/${encodedName}`;
};
export const deserializeJSONWithSpecialTypes = <T = Record<string, unknown>>(
data: string,
): T => {
return JSON.parse(data, (_, value) => {
if (typeof value === 'string' && value.startsWith(DATE_TOKEN)) {
return new Date(value.replace(DATE_TOKEN, ''));
}
if (typeof value === 'string' && value.startsWith(FILE_TOKEN)) {
return resolveFileTokenToUrl(value);
}
return value;
});
};
export const serializeThenDeserialize = (props: Record<string, unknown>) => {
return deserializeJSONWithSpecialTypes(
serializeJSONWithSpecialTypes({
data: props,
indent: 2,
staticBase: window.remotion_staticBase,
}).serializedString,
);
};
export const serializeThenDeserializeInStudio = (
props: Record<string, unknown>,
) => {
// Serializing once in the Studio, to catch potential serialization errors before
// you only get them during rendering
if (getRemotionEnvironment().isStudio) {
return serializeThenDeserialize(props);
}
return props;
};