remotion 4.1.0-alpha5 → 4.1.0-alpha8

package/dist/cjs/internals.js

@@ -34,6 +34,7 @@ const delay_render_js_1 = require("./delay-render.js");
 const EditorProps_js_1 = require("./EditorProps.js");
 const get_environment_js_1 = require("./get-environment.js");
 const get_preview_dom_element_js_1 = require("./get-preview-dom-element.js");
+const input_props_serialization_js_1 = require("./input-props-serialization.js");
 const interpolate_colors_js_1 = require("./interpolate-colors.js");
 const is_player_js_1 = require("./is-player.js");
 const nonce_js_1 = require("./nonce.js");
@@ -47,6 +48,7 @@ const ResolveCompositionConfig_js_1 = require("./ResolveCompositionConfig.js");
 const SequenceContext_js_1 = require("./SequenceContext.js");
 const SequenceManager_js_1 = require("./SequenceManager.js");
 const setup_env_variables_js_1 = require("./setup-env-variables.js");
+const timeline_position_state_js_1 = require("./timeline-position-state.js");
 const TimelinePosition = __importStar(require("./timeline-position-state.js"));
 const truthy_js_1 = require("./truthy.js");
 const use_lazy_component_js_1 = require("./use-lazy-component.js");
@@ -117,4 +119,9 @@ exports.Internals = {
     REMOTION_STUDIO_CONTAINER_ELEMENT: get_preview_dom_element_js_1.REMOTION_STUDIO_CONTAINER_ELEMENT,
     AssetManager: AssetManager_js_1.AssetManager,
     bundleName: 'bundle.js',
+    persistCurrentFrame: timeline_position_state_js_1.persistCurrentFrame,
+    useTimelineSetFrame: timeline_position_state_js_1.useTimelineSetFrame,
+    serializeJSONWithDate: input_props_serialization_js_1.serializeJSONWithDate,
+    deserializeJSONWithCustomFields: input_props_serialization_js_1.deserializeJSONWithCustomFields,
+    FILE_TOKEN: input_props_serialization_js_1.FILE_TOKEN,
 };

package/dist/cjs/loop/index.js

@@ -14,8 +14,7 @@ const validate_duration_in_frames_js_1 = require("../validation/validate-duratio
 const Loop = ({ durationInFrames, times = Infinity, children, name, ...props }) => {
     const currentFrame = (0, use_current_frame_js_1.useCurrentFrame)();
     const { durationInFrames: compDuration } = (0, use_video_config_js_1.useVideoConfig)();
-    (0, validate_duration_in_frames_js_1.validateDurationInFrames)({
-        durationInFrames,
+    (0, validate_duration_in_frames_js_1.validateDurationInFrames)(durationInFrames, {
         component: 'of the <Loop /> component',
         allowFloats: true,
     });

package/dist/cjs/resolve-video-config.d.ts

@@ -1,8 +1,9 @@
 import type { AnyZodObject } from 'zod';
 import type { TCompMetadataWithCalcFunction } from './CompositionManager.js';
 import type { VideoConfig } from './video-config.js';
-export declare const resolveVideoConfig: ({ composition, editorProps: editorPropsOrUndefined, signal, }: {
+export declare const resolveVideoConfig: ({ composition, editorProps: editorPropsOrUndefined, signal, inputProps, }: {
     composition: TCompMetadataWithCalcFunction<AnyZodObject, Record<string, unknown>>;
     editorProps: object;
     signal: AbortSignal;
+    inputProps: Record<string, unknown>;
 }) => VideoConfig | Promise<VideoConfig>;

package/dist/cjs/resolve-video-config.js

@@ -1,23 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveVideoConfig = void 0;
-const input_props_js_1 = require("./config/input-props.js");
-const get_environment_js_1 = require("./get-environment.js");
 const validate_dimensions_js_1 = require("./validation/validate-dimensions.js");
 const validate_duration_in_frames_js_1 = require("./validation/validate-duration-in-frames.js");
-const resolveVideoConfig = ({ composition, editorProps: editorPropsOrUndefined, signal, }) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+const validate_fps_js_1 = require("./validation/validate-fps.js");
+const resolveVideoConfig = ({ composition, editorProps: editorPropsOrUndefined, signal, inputProps, }) => {
+    var _a, _b, _c, _d, _e, _f, _g;
     const calculatedProm = composition.calculateMetadata
         ? composition.calculateMetadata({
             defaultProps: (_a = composition.defaultProps) !== null && _a !== void 0 ? _a : {},
             props: {
                 ...((_b = composition.defaultProps) !== null && _b !== void 0 ? _b : {}),
                 ...(editorPropsOrUndefined !== null && editorPropsOrUndefined !== void 0 ? editorPropsOrUndefined : {}),
-                ...(typeof window === 'undefined' ||
-                    (0, get_environment_js_1.getRemotionEnvironment)() === 'player-development' ||
-                    (0, get_environment_js_1.getRemotionEnvironment)() === 'player-production'
-                    ? {}
-                    : (_c = (0, input_props_js_1.getInputProps)()) !== null && _c !== void 0 ? _c : {}),
+                ...inputProps,
             },
             abortSignal: signal,
         })
@@ -50,43 +45,35 @@ const resolveVideoConfig = ({ composition, editorProps: editorPropsOrUndefined,
         return {
             ...data,
             id: composition.id,
-            defaultProps: (_d = composition.defaultProps) !== null && _d !== void 0 ? _d : {},
-            props: (_e = composition.defaultProps) !== null && _e !== void 0 ? _e : {},
+            defaultProps: (_c = composition.defaultProps) !== null && _c !== void 0 ? _c : {},
+            props: {
+                ...((_d = composition.defaultProps) !== null && _d !== void 0 ? _d : {}),
+                ...(inputProps !== null && inputProps !== void 0 ? inputProps : {}),
+            },
         };
     }
     return {
         ...data,
         id: composition.id,
-        defaultProps: (_f = composition.defaultProps) !== null && _f !== void 0 ? _f : {},
-        props: (_h = (_g = calculatedProm.props) !== null && _g !== void 0 ? _g : composition.defaultProps) !== null && _h !== void 0 ? _h : {},
+        defaultProps: (_e = composition.defaultProps) !== null && _e !== void 0 ? _e : {},
+        props: (_g = (_f = calculatedProm.props) !== null && _f !== void 0 ? _f : composition.defaultProps) !== null && _g !== void 0 ? _g : {},
     };
 };
 exports.resolveVideoConfig = resolveVideoConfig;
 const validateCalculated = ({ composition, calculated, }) => {
     var _a, _b, _c, _d, _e, _f, _g, _h;
-    const potentialErrorLocation = `calculated by calculateMetadata() for the composition "${composition.id}"`;
-    const width = (_b = (_a = calculated === null || calculated === void 0 ? void 0 : calculated.width) !== null && _a !== void 0 ? _a : composition.width) !== null && _b !== void 0 ? _b : null;
-    if (!width) {
-        throw new TypeError('Composition width was neither specified via the `width` prop nor the `calculateMetadata()` function.');
-    }
-    (0, validate_dimensions_js_1.validateDimension)(width, 'width', potentialErrorLocation);
-    const height = (_d = (_c = calculated === null || calculated === void 0 ? void 0 : calculated.height) !== null && _c !== void 0 ? _c : composition.height) !== null && _d !== void 0 ? _d : null;
-    if (!height) {
-        throw new TypeError('Composition height was neither specified via the `height` prop nor the `calculateMetadata()` function.');
-    }
-    (0, validate_dimensions_js_1.validateDimension)(width, 'height', potentialErrorLocation);
+    const calculateMetadataErrorLocation = `calculated by calculateMetadata() for the composition "${composition.id}"`;
+    const defaultErrorLocation = `of the "<Composition />" component with the id "${composition.id}"`;
+    const width = (_b = (_a = calculated === null || calculated === void 0 ? void 0 : calculated.width) !== null && _a !== void 0 ? _a : composition.width) !== null && _b !== void 0 ? _b : undefined;
+    (0, validate_dimensions_js_1.validateDimension)(width, 'width', (calculated === null || calculated === void 0 ? void 0 : calculated.width) ? calculateMetadataErrorLocation : defaultErrorLocation);
+    const height = (_d = (_c = calculated === null || calculated === void 0 ? void 0 : calculated.height) !== null && _c !== void 0 ? _c : composition.height) !== null && _d !== void 0 ? _d : undefined;
+    (0, validate_dimensions_js_1.validateDimension)(height, 'height', (calculated === null || calculated === void 0 ? void 0 : calculated.height) ? calculateMetadataErrorLocation : defaultErrorLocation);
     const fps = (_f = (_e = calculated === null || calculated === void 0 ? void 0 : calculated.fps) !== null && _e !== void 0 ? _e : composition.fps) !== null && _f !== void 0 ? _f : null;
-    if (!fps) {
-        throw new TypeError('Composition fps was neither specified via the `fps` prop nor the `calculateMetadata()` function.');
-    }
+    (0, validate_fps_js_1.validateFps)(fps, (calculated === null || calculated === void 0 ? void 0 : calculated.fps) ? calculateMetadataErrorLocation : defaultErrorLocation, false);
     const durationInFrames = (_h = (_g = calculated === null || calculated === void 0 ? void 0 : calculated.durationInFrames) !== null && _g !== void 0 ? _g : composition.durationInFrames) !== null && _h !== void 0 ? _h : null;
-    if (!durationInFrames) {
-        throw new TypeError('Composition durationInFrames was neither specified via the `durationInFrames` prop nor the `calculateMetadata()` function.');
-    }
-    (0, validate_duration_in_frames_js_1.validateDurationInFrames)({
-        durationInFrames,
-        component: potentialErrorLocation,
+    (0, validate_duration_in_frames_js_1.validateDurationInFrames)(durationInFrames, {
         allowFloats: false,
+        component: `of the "<Composition />" component with the id "${composition.id}"`,
     });
     return { width, height, fps, durationInFrames };
 };

package/dist/cjs/series/index.js

@@ -41,8 +41,7 @@ const Series = ({ children }) => {
             const { durationInFrames, children: _children, from, ...passedProps } = castedChild.props; // `from` is not accepted and must be filtered out if used in JS
             if (i !== flattenedChildren.length - 1 ||
                 durationInFramesProp !== Infinity) {
-                (0, validate_duration_in_frames_js_1.validateDurationInFrames)({
-                    durationInFrames: durationInFramesProp,
+                (0, validate_duration_in_frames_js_1.validateDurationInFrames)(durationInFramesProp, {
                     component: `of a <Series.Sequence /> component`,
                     allowFloats: true,
                 });

package/dist/cjs/spring/index.js

@@ -52,7 +52,7 @@ function spring({ frame: passedFrame, fps, config = {}, from = 0, to = 1, durati
         };
     const frame = (reverse
         ? (passedDurationInFrames !== null && passedDurationInFrames !== void 0 ? passedDurationInFrames : naturalDurationGetter.get()) - passedFrame
-        : passedFrame) - delay;
+        : passedFrame) - (reverse ? -delay : delay);
     const spr = (0, spring_utils_js_1.springCalculation)({
         fps,
         frame: passedDurationInFrames === undefined

package/dist/cjs/static-file.js

@@ -49,6 +49,14 @@ const inner = (path) => {
     }
     return `/${trimLeadingSlash(path)}`;
 };
+const encodeBySplitting = (path) => {
+    const splitBySlash = path.split('/');
+    const encodedArray = splitBySlash.map((element) => {
+        return encodeURIComponent(element);
+    });
+    const merged = encodedArray.join('/');
+    return merged;
+};
 /**
  * @description Reference a file from the public/ folder. If the file does not appear in the autocomplete, type the path manually.
  * @see [Documentation](https://www.remotion.dev/docs/staticfile)
@@ -76,9 +84,10 @@ const staticFile = (path) => {
     }
     const includesHex = (0, exports.includesHexOfUnsafeChar)(path);
     if (includesHex.containsHex) {
-        warnOnce(`WARNING: You seem to pass an already encoded path (path contains ${includesHex.hexCode}). The encoding gets automatically handled by staticFile()  `);
+        warnOnce(`WARNING: You seem to pass an already encoded path (path contains ${includesHex.hexCode}). Since Remotion 4.0, the encoding is done by staticFile() itself. You may want to remove a encodeURIComponent() wrapping.`);
     }
-    const preparsed = inner(encodeURIComponent(path));
+    const preprocessed = encodeBySplitting(path);
+    const preparsed = inner(preprocessed);
     if (!preparsed.startsWith('/')) {
         return `/${preparsed}`;
     }

package/dist/cjs/timeline-position-state.d.ts

@@ -4,7 +4,7 @@ export type PlayableMediaTag = {
     id: string;
 };
 export type TimelineContextValue = {
-    frame: number;
+    frame: Record<string, number>;
     playing: boolean;
     rootId: string;
     playbackRate: number;
@@ -13,13 +13,15 @@ export type TimelineContextValue = {
     audioAndVideoTags: MutableRefObject<PlayableMediaTag[]>;
 };
 export type SetTimelineContextValue = {
-    setFrame: (u: React.SetStateAction<number>) => void;
+    setFrame: (u: React.SetStateAction<Record<string, number>>) => void;
     setPlaying: (u: React.SetStateAction<boolean>) => void;
 };
 export declare const TimelineContext: import("react").Context<TimelineContextValue>;
 export declare const SetTimelineContext: import("react").Context<SetTimelineContextValue>;
+export declare const persistCurrentFrame: (frame: number, composition: string) => void;
+export declare const getFrameForComposition: (composition: string) => number;
 export declare const useTimelinePosition: () => number;
-export declare const useTimelineSetFrame: () => (u: React.SetStateAction<number>) => void;
+export declare const useTimelineSetFrame: () => (u: React.SetStateAction<Record<string, number>>) => void;
 type PlayingReturnType = readonly [
     boolean,
     (u: React.SetStateAction<boolean>) => void,

package/dist/cjs/timeline-position-state.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.usePlayingState = exports.useTimelineSetFrame = exports.useTimelinePosition = exports.SetTimelineContext = exports.TimelineContext = void 0;
+exports.usePlayingState = exports.useTimelineSetFrame = exports.useTimelinePosition = exports.getFrameForComposition = exports.persistCurrentFrame = exports.SetTimelineContext = exports.TimelineContext = void 0;
 const react_1 = require("react");
 const use_video_js_1 = require("./use-video.js");
 exports.TimelineContext = (0, react_1.createContext)({
-    frame: 0,
+    frame: {},
     playing: false,
     playbackRate: 1,
     rootId: '',
@@ -24,16 +24,34 @@ exports.SetTimelineContext = (0, react_1.createContext)({
         throw new Error('default');
     },
 });
+const makeKey = (composition) => {
+    return `remotion.time.${composition}`;
+};
+const persistCurrentFrame = (frame, composition) => {
+    localStorage.setItem(makeKey(composition), String(frame));
+};
+exports.persistCurrentFrame = persistCurrentFrame;
+const getFrameForComposition = (composition) => {
+    var _a, _b;
+    const frame = localStorage.getItem(makeKey(composition));
+    return frame
+        ? Number(frame)
+        : (_b = (typeof window === 'undefined' ? 0 : (_a = window.remotion_initialFrame) !== null && _a !== void 0 ? _a : 0)) !== null && _b !== void 0 ? _b : 0;
+};
+exports.getFrameForComposition = getFrameForComposition;
 const useTimelinePosition = () => {
+    var _a, _b;
     const videoConfig = (0, use_video_js_1.useVideo)();
     const state = (0, react_1.useContext)(exports.TimelineContext);
-    // A dynamically calculated duration using calculateMetadata()
-    // may lead to the frame being bigger than the duration.
-    // If we have the config, we clamp the frame to the duration.
     if (!videoConfig) {
-        return state.frame;
+        return typeof window === 'undefined'
+            ? 0
+            : (_a = window.remotion_initialFrame) !== null && _a !== void 0 ? _a : 0;
     }
-    return Math.min(videoConfig.durationInFrames - 1, state.frame);
+    const unclamped = (_b = state.frame[videoConfig.id]) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && window.remotion_isPlayer
+        ? 0
+        : (0, exports.getFrameForComposition)(videoConfig.id));
+    return Math.min(videoConfig.durationInFrames - 1, unclamped);
 };
 exports.useTimelinePosition = useTimelinePosition;
 const useTimelineSetFrame = () => {

package/dist/cjs/validation/validate-dimensions.d.ts

@@ -1 +1 @@
-export declare const validateDimension: (amount: number, nameOfProp: string, location: string) => void;
+export declare function validateDimension(amount: unknown, nameOfProp: string, location: string): asserts amount is number;

package/dist/cjs/validation/validate-dimensions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateDimension = void 0;
-const validateDimension = (amount, nameOfProp, location) => {
+function validateDimension(amount, nameOfProp, location) {
     if (typeof amount !== 'number') {
         throw new Error(`The "${nameOfProp}" prop ${location} must be a number, but you passed a value of type ${typeof amount}`);
     }
@@ -17,5 +17,5 @@ const validateDimension = (amount, nameOfProp, location) => {
     if (amount <= 0) {
         throw new TypeError(`The "${nameOfProp}" prop ${location} must be positive, but got ${amount}.`);
     }
-};
+}
 exports.validateDimension = validateDimension;

package/dist/cjs/validation/validate-duration-in-frames.d.ts

@@ -1,5 +1,4 @@
-export declare const validateDurationInFrames: ({ allowFloats, component, durationInFrames, }: {
-    durationInFrames: number;
+export declare function validateDurationInFrames(durationInFrames: unknown, options: {
     component: string;
     allowFloats: boolean;
-}) => void;
+}): asserts durationInFrames is number;

package/dist/cjs/validation/validate-duration-in-frames.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateDurationInFrames = void 0;
-const validateDurationInFrames = ({ allowFloats, component, durationInFrames, }) => {
+function validateDurationInFrames(durationInFrames, options) {
+    const { allowFloats, component } = options;
+    if (typeof durationInFrames === 'undefined') {
+        throw new Error(`The "durationInFrames" prop ${component} is missing.`);
+    }
     if (typeof durationInFrames !== 'number') {
         throw new Error(`The "durationInFrames" prop ${component} must be a number, but you passed a value of type ${typeof durationInFrames}`);
     }
@@ -14,5 +18,5 @@ const validateDurationInFrames = ({ allowFloats, component, durationInFrames, })
     if (!Number.isFinite(durationInFrames)) {
         throw new TypeError(`The "durationInFrames" prop ${component} must be finite, but got ${durationInFrames}.`);
     }
-};
+}
 exports.validateDurationInFrames = validateDurationInFrames;

package/dist/cjs/validation/validate-fps.d.ts

@@ -1 +1 @@
-export declare const validateFps: (fps: number, location: string, isGif: boolean) => void;
+export declare function validateFps(fps: unknown, location: string, isGif: boolean): asserts fps is number;

package/dist/cjs/validation/validate-fps.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateFps = void 0;
-const validateFps = (fps, location, isGif) => {
+function validateFps(fps, location, isGif) {
     if (typeof fps !== 'number') {
         throw new Error(`"fps" must be a number, but you passed a value of type ${typeof fps} ${location}`);
     }
@@ -17,5 +17,5 @@ const validateFps = (fps, location, isGif) => {
     if (isGif && fps > 50) {
         throw new TypeError(`The FPS for a GIF cannot be higher than 50. Use the --every-nth-frame option to lower the FPS: https://remotion.dev/docs/render-as-gif`);
     }
-};
+}
 exports.validateFps = validateFps;

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.1.0-alpha5";
+export declare const VERSION = "4.1.0-alpha8";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // Automatically generated on publish
-exports.VERSION = '4.1.0-alpha5';
+exports.VERSION = '4.1.0-alpha8';

package/dist/cjs/video/Video.d.ts

@@ -4,7 +4,7 @@ import type { RemotionMainVideoProps } from './props.js';
  * @description allows you to include a video file in your Remotion project. It wraps the native HTMLVideoElement.
  * @see [Documentation](https://www.remotion.dev/docs/video)
  */
-export declare const Video: (props: Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "nonce" | "onEnded" | "autoPlay" | "controls"> & {
+export declare const Video: (props: Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "autoPlay" | "controls" | "onEnded" | "nonce"> & {
     volume?: import("../volume-prop.js").VolumeProp | undefined;
     playbackRate?: number | undefined;
     acceptableTimeShiftInSeconds?: number | undefined;

package/dist/cjs/video/VideoForDevelopment.d.ts

@@ -1,6 +1,6 @@
 import type { ForwardRefExoticComponent, RefAttributes } from 'react';
 import React from 'react';
-export declare const VideoForDevelopment: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "nonce" | "onEnded" | "autoPlay" | "controls"> & {
+export declare const VideoForDevelopment: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "autoPlay" | "controls" | "onEnded" | "nonce"> & {
     volume?: import("../volume-prop.js").VolumeProp | undefined;
     playbackRate?: number | undefined;
     acceptableTimeShiftInSeconds?: number | undefined;

package/dist/cjs/video/VideoForRendering.d.ts

@@ -1,6 +1,6 @@
 import type { ForwardRefExoticComponent, RefAttributes } from 'react';
 import React from 'react';
-export declare const VideoForRendering: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "nonce" | "onEnded" | "autoPlay" | "controls"> & {
+export declare const VideoForRendering: ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, "autoPlay" | "controls" | "onEnded" | "nonce"> & {
     volume?: import("../volume-prop.js").VolumeProp | undefined;
     playbackRate?: number | undefined;
     acceptableTimeShiftInSeconds?: number | undefined;