@remotion/studio 4.0.152 → 4.0.154

package/dist/components/RenderQueue/actions.js

@@ -2,32 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.canUpdateDefaultProps = exports.callUpdateDefaultPropsApi = exports.getProjectInfo = exports.updateAvailable = exports.cancelRenderJob = exports.removeRenderJob = exports.applyCodemod = exports.copyToClipboard = exports.openInFileExplorer = exports.subscribeToFileExistenceWatcher = exports.unsubscribeFromFileExistenceWatcher = exports.addVideoRenderJob = exports.addSequenceRenderJob = exports.addStillRenderJob = void 0;
 const no_react_1 = require("remotion/no-react");
-const callApi = (endpoint, body, signal) => {
-    return new Promise((resolve, reject) => {
-        fetch(endpoint, {
-            method: 'post',
-            headers: {
-                'content-type': 'application/json',
-            },
-            signal,
-            body: JSON.stringify(body),
-        })
-            .then((res) => res.json())
-            .then((data) => {
-            if (data.success) {
-                resolve(data.data);
-            }
-            else {
-                reject(new Error(data.error));
-            }
-        })
-            .catch((err) => {
-            reject(err);
-        });
-    });
-};
+const call_api_1 = require("../call-api");
 const addStillRenderJob = ({ compositionId, outName, imageFormat, jpegQuality, frame, scale, logLevel, chromiumOptions, delayRenderTimeout, envVariables, inputProps, offthreadVideoCacheSizeInBytes, multiProcessOnLinux, beepOnFinish, }) => {
-    return callApi('/api/render', {
+    return (0, call_api_1.callApi)('/api/render', {
         compositionId,
         type: 'still',
         outName,
@@ -51,7 +28,7 @@ const addStillRenderJob = ({ compositionId, outName, imageFormat, jpegQuality, f
 };
 exports.addStillRenderJob = addStillRenderJob;
 const addSequenceRenderJob = ({ compositionId, outName, imageFormat, startFrame, endFrame, scale, logLevel, chromiumOptions, delayRenderTimeout, envVariables, inputProps, concurrency, offthreadVideoCacheSizeInBytes, jpegQuality, disallowParallelEncoding, multiProcessOnLinux, beepOnFinish, repro, }) => {
-    return callApi('/api/render', {
+    return (0, call_api_1.callApi)('/api/render', {
         compositionId,
         type: 'sequence',
         outName,
@@ -79,7 +56,7 @@ const addSequenceRenderJob = ({ compositionId, outName, imageFormat, startFrame,
 };
 exports.addSequenceRenderJob = addSequenceRenderJob;
 const addVideoRenderJob = ({ compositionId, outName, imageFormat, jpegQuality, scale, logLevel, codec, concurrency, crf, startFrame, endFrame, muted, enforceAudioTrack, proResProfile, x264Preset, pixelFormat, audioBitrate, videoBitrate, everyNthFrame, numberOfGifLoops, delayRenderTimeout, audioCodec, disallowParallelEncoding, chromiumOptions, envVariables, inputProps, offthreadVideoCacheSizeInBytes, colorSpace, multiProcessOnLinux, encodingMaxRate, encodingBufferSize, beepOnFinish, repro, forSeamlessAacConcatenation, separateAudioTo, }) => {
-    return callApi('/api/render', {
+    return (0, call_api_1.callApi)('/api/render', {
         compositionId,
         type: 'video',
         outName,
@@ -124,11 +101,11 @@ const addVideoRenderJob = ({ compositionId, outName, imageFormat, jpegQuality, s
 };
 exports.addVideoRenderJob = addVideoRenderJob;
 const unsubscribeFromFileExistenceWatcher = ({ file, clientId, }) => {
-    return callApi('/api/unsubscribe-from-file-existence', { file, clientId });
+    return (0, call_api_1.callApi)('/api/unsubscribe-from-file-existence', { file, clientId });
 };
 exports.unsubscribeFromFileExistenceWatcher = unsubscribeFromFileExistenceWatcher;
 const subscribeToFileExistenceWatcher = async ({ file, clientId, }) => {
-    const { exists } = await callApi('/api/subscribe-to-file-existence', {
+    const { exists } = await (0, call_api_1.callApi)('/api/subscribe-to-file-existence', {
         file,
         clientId,
     });
@@ -139,7 +116,7 @@ const openInFileExplorer = ({ directory }) => {
     const body = {
         directory,
     };
-    return callApi('/api/open-in-file-explorer', body);
+    return (0, call_api_1.callApi)('/api/open-in-file-explorer', body);
 };
 exports.openInFileExplorer = openInFileExplorer;
 const copyToClipboard = ({ outName, binariesDirectory, }) => {
@@ -147,7 +124,7 @@ const copyToClipboard = ({ outName, binariesDirectory, }) => {
         outName,
         binariesDirectory,
     };
-    return callApi('/api/copy-still-to-clipboard', body);
+    return (0, call_api_1.callApi)('/api/copy-still-to-clipboard', body);
 };
 exports.copyToClipboard = copyToClipboard;
 const applyCodemod = ({ codemod, dryRun, signal, }) => {
@@ -155,31 +132,31 @@ const applyCodemod = ({ codemod, dryRun, signal, }) => {
         codemod,
         dryRun,
     };
-    return callApi('/api/apply-codemod', body, signal);
+    return (0, call_api_1.callApi)('/api/apply-codemod', body, signal);
 };
 exports.applyCodemod = applyCodemod;
 const removeRenderJob = (job) => {
-    return callApi('/api/remove-render', {
+    return (0, call_api_1.callApi)('/api/remove-render', {
         jobId: job.id,
     });
 };
 exports.removeRenderJob = removeRenderJob;
 const cancelRenderJob = (job) => {
-    return callApi('/api/cancel', {
+    return (0, call_api_1.callApi)('/api/cancel', {
         jobId: job.id,
     });
 };
 exports.cancelRenderJob = cancelRenderJob;
 const updateAvailable = (signal) => {
-    return callApi('/api/update-available', {}, signal);
+    return (0, call_api_1.callApi)('/api/update-available', {}, signal);
 };
 exports.updateAvailable = updateAvailable;
 const getProjectInfo = (signal) => {
-    return callApi('/api/project-info', {}, signal);
+    return (0, call_api_1.callApi)('/api/project-info', {}, signal);
 };
 exports.getProjectInfo = getProjectInfo;
 const callUpdateDefaultPropsApi = (compositionId, defaultProps, enumPaths) => {
-    return callApi('/api/update-default-props', {
+    return (0, call_api_1.callApi)('/api/update-default-props', {
         compositionId,
         defaultProps: no_react_1.NoReactInternals.serializeJSONWithDate({
             data: defaultProps,
@@ -197,7 +174,7 @@ const canUpdateDefaultProps = (compositionId, readOnlyStudio) => {
             reason: 'Read-only studio',
         });
     }
-    return callApi('/api/can-update-default-props', {
+    return (0, call_api_1.callApi)('/api/can-update-default-props', {
         compositionId,
     });
 };

package/dist/components/TopPanel.d.ts

@@ -2,9 +2,9 @@ import type { Size } from '@remotion/player';
 import React from 'react';
 export declare const useResponsiveSidebarStatus: () => 'collapsed' | 'expanded';
 export declare const TopPanel: React.FC<{
-    readOnlyStudio: boolean;
-    onMounted: () => void;
-    size: Size | null;
-    drawRef: React.RefObject<HTMLDivElement>;
-    bufferStateDelayInMilliseconds: number;
+    readonly readOnlyStudio: boolean;
+    readonly onMounted: () => void;
+    readonly size: Size | null;
+    readonly drawRef: React.RefObject<HTMLDivElement>;
+    readonly bufferStateDelayInMilliseconds: number;
 }>;

package/dist/components/call-api.d.ts

@@ -0,0 +1,2 @@
+import type { ApiRoutes } from '@remotion/studio-shared';
+export declare const callApi: <Endpoint extends keyof ApiRoutes>(endpoint: Endpoint, body: ApiRoutes[Endpoint]["Request"], signal?: AbortSignal) => Promise<ApiRoutes[Endpoint]["Response"]>;

package/dist/components/call-api.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callApi = void 0;
+const callApi = (endpoint, body, signal) => {
+    return new Promise((resolve, reject) => {
+        fetch(endpoint, {
+            method: 'post',
+            headers: {
+                'content-type': 'application/json',
+            },
+            signal,
+            body: JSON.stringify(body),
+        })
+            .then((res) => res.json())
+            .then((data) => {
+            if (data.success) {
+                resolve(data.data);
+            }
+            else {
+                reject(new Error(data.error));
+            }
+        })
+            .catch((err) => {
+            reject(err);
+        });
+    });
+};
+exports.callApi = callApi;

package/dist/esm/index.mjs

@@ -4212,6 +4212,43 @@ var init_lib = __esm(() => {
   });
 });
 
+// src/api/delete-static-file.ts
+import {getRemotionEnvironment} from "remotion";
+
+// src/components/call-api.ts
+var callApi = (endpoint, body, signal) => {
+  return new Promise((resolve, reject) => {
+    fetch(endpoint, {
+      method: "post",
+      headers: {
+        "content-type": "application/json"
+      },
+      signal,
+      body: JSON.stringify(body)
+    }).then((res) => res.json()).then((data) => {
+      if (data.success) {
+        resolve(data.data);
+      } else {
+        reject(new Error(data.error));
+      }
+    }).catch((err) => {
+      reject(err);
+    });
+  });
+};
+
+// src/api/delete-static-file.ts
+var deleteStaticFile = async (relativePath) => {
+  if (!getRemotionEnvironment().isStudio) {
+    throw new Error("deleteStaticFile() is only available in the Studio");
+  }
+  if (relativePath.startsWith(window.remotion_staticBase)) {
+    relativePath = relativePath.substring(window.remotion_staticBase.length + 1);
+  }
+  const res = await callApi("/api/delete-static-file", { relativePath });
+  return res;
+};
+
 // src/api/get-static-files.ts
 var warnedServer = false;
 var warnedPlayer = false;
@@ -4241,8 +4278,38 @@ var getStaticFiles = () => {
   return window.remotion_staticFiles;
 };
 
-// src/api/save-default-props.ts
-import {Internals, getRemotionEnvironment} from "remotion";
+// src/api/helpers/calc-new-props.ts
+import {Internals, getRemotionEnvironment as getRemotionEnvironment2} from "remotion";
+var calcNewProps = (compositionId, defaultProps) => {
+  if (!getRemotionEnvironment2().isStudio) {
+    throw new Error("saveDefaultProps can only be called in the Remotion Studio.");
+  }
+  const { compositionsRef, editorPropsProviderRef } = Internals;
+  const compositionsStore = compositionsRef.current;
+  if (!compositionsStore) {
+    throw new Error("No compositions ref found. Are you in the Remotion Studio and are the Remotion versions aligned?");
+  }
+  const compositions = compositionsStore.getCompositions();
+  const composition = compositions.find((c) => c.id === compositionId);
+  if (!composition) {
+    throw new Error(`No composition with the ID ${compositionId} found. Available compositions: ${compositions.map((c) => c.id).join(", ")}`);
+  }
+  const propsStore = editorPropsProviderRef.current;
+  if (!propsStore) {
+    throw new Error("No props store found. Are you in the Remotion Studio and are the Remotion versions aligned?");
+  }
+  const savedDefaultProps = composition.defaultProps ?? {};
+  const unsavedDefaultProps = propsStore.getProps()[compositionId] ?? savedDefaultProps;
+  const generatedDefaultProps = defaultProps({
+    schema: composition.schema,
+    savedDefaultProps,
+    unsavedDefaultProps
+  });
+  return {
+    composition,
+    generatedDefaultProps
+  };
+};
 
 // src/components/RenderModal/SchemaEditor/extract-enum-json-paths.ts
 var extractEnumJsonPaths = (schema, zodRuntime, currentPath) => {
@@ -4359,26 +4426,6 @@ var extractEnumJsonPaths = (schema, zodRuntime, currentPath) => {
 
 // src/components/RenderQueue/actions.ts
 import {NoReactInternals} from "remotion/no-react";
-var callApi = (endpoint, body, signal) => {
-  return new Promise((resolve, reject) => {
-    fetch(endpoint, {
-      method: "post",
-      headers: {
-        "content-type": "application/json"
-      },
-      signal,
-      body: JSON.stringify(body)
-    }).then((res) => res.json()).then((data) => {
-      if (data.success) {
-        resolve(data.data);
-      } else {
-        reject(new Error(data.error));
-      }
-    }).catch((err) => {
-      reject(err);
-    });
-  });
-};
 var callUpdateDefaultPropsApi = (compositionId, defaultProps, enumPaths) => {
   return callApi("/api/update-default-props", {
     compositionId,
@@ -4396,36 +4443,13 @@ var saveDefaultProps = async ({
   compositionId,
   defaultProps
 }) => {
-  if (!getRemotionEnvironment().isStudio) {
-    throw new Error("saveDefaultProps can only be called in the Remotion Studio.");
-  }
   try {
     await Promise.resolve().then(() => (init_lib(), exports_lib));
   } catch {
     throw new Error('"zod" is required to use saveDefaultProps(), but is not installed.');
   }
   const z2 = await Promise.resolve().then(() => (init_lib(), exports_lib));
-  const { compositionsRef, editorPropsProviderRef } = Internals;
-  const compositionsStore = compositionsRef.current;
-  if (!compositionsStore) {
-    throw new Error("No compositions ref found. Are you in the Remotion Studio and are the Remotion versions aligned?");
-  }
-  const compositions = compositionsStore.getCompositions();
-  const composition = compositions.find((c) => c.id === compositionId);
-  if (!composition) {
-    throw new Error(`No composition with the ID ${compositionId} found. Available compositions: ${compositions.map((c) => c.id).join(", ")}`);
-  }
-  const propsStore = editorPropsProviderRef.current;
-  if (!propsStore) {
-    throw new Error("No props store found. Are you in the Remotion Studio and are the Remotion versions aligned?");
-  }
-  const savedDefaultProps = composition.defaultProps ?? {};
-  const unsavedDefaultProps = propsStore.getProps()[compositionId] ?? savedDefaultProps;
-  const generatedDefaultProps = defaultProps({
-    schema: composition.schema,
-    savedDefaultProps,
-    unsavedDefaultProps
-  });
+  const { generatedDefaultProps, composition } = calcNewProps(compositionId, defaultProps);
   const res = await callUpdateDefaultPropsApi(compositionId, generatedDefaultProps, composition.schema ? extractEnumJsonPaths(composition.schema, z2, []) : []);
   if (res.success) {
     return Promise.resolve();
@@ -4435,11 +4459,51 @@ var saveDefaultProps = async ({
   return Promise.reject(err);
 };
 
-// src/api/watch-static-file.ts
-import {getRemotionEnvironment as getRemotionEnvironment2} from "remotion";
+// src/api/update-default-props.ts
+import {Internals as Internals2} from "remotion";
+var PROPS_UPDATED_EXTERNALLY = "remotion.propsUpdatedExternally";
+var updateDefaultProps = ({
+  compositionId,
+  defaultProps
+}) => {
+  const { generatedDefaultProps, composition } = calcNewProps(compositionId, defaultProps);
+  const propsStore = Internals2.editorPropsProviderRef.current;
+  if (!propsStore) {
+    throw new Error("No props store found. Are you in the Remotion Studio and are the Remotion versions aligned?");
+  }
+  propsStore.setProps((prev) => {
+    return {
+      ...prev,
+      [composition.id]: generatedDefaultProps
+    };
+  });
+  window.dispatchEvent(new CustomEvent(PROPS_UPDATED_EXTERNALLY));
+};
+
+// src/api/watch-public-folder.ts
+import {getRemotionEnvironment as getRemotionEnvironment3} from "remotion";
 var WATCH_REMOTION_STATIC_FILES = "remotion_staticFilesChanged";
+var watchPublicFolder = (callback) => {
+  if (!getRemotionEnvironment3().isStudio) {
+    console.warn("The API is only available while using the Remotion Studio.");
+    return { cancel: () => {
+      return;
+    } };
+  }
+  const emitUpdate = () => {
+    callback(getStaticFiles());
+  };
+  window.addEventListener(WATCH_REMOTION_STATIC_FILES, emitUpdate);
+  const cancel = () => {
+    return window.removeEventListener(WATCH_REMOTION_STATIC_FILES, emitUpdate);
+  };
+  return { cancel };
+};
+
+// src/api/watch-static-file.ts
+import {getRemotionEnvironment as getRemotionEnvironment4} from "remotion";
 var watchStaticFile = (fileName, callback) => {
-  if (!getRemotionEnvironment2().isStudio) {
+  if (!getRemotionEnvironment4().isStudio) {
     console.warn("The API is only available while using the Remotion Studio.");
     return { cancel: () => {
       return;
@@ -4448,8 +4512,7 @@ var watchStaticFile = (fileName, callback) => {
   const withoutStaticBase = fileName.startsWith(window.remotion_staticBase) ? fileName.replace(window.remotion_staticBase, "") : fileName;
   const withoutLeadingSlash = withoutStaticBase.startsWith("/") ? withoutStaticBase.slice(1) : withoutStaticBase;
   let prevFileData = window.remotion_staticFiles.find((file) => file.name === withoutLeadingSlash);
-  const checkFile = (event) => {
-    const staticFiles = event.detail.files;
+  const { cancel } = watchPublicFolder((staticFiles) => {
     const newFileData = staticFiles.find((file) => file.name === withoutLeadingSlash);
     if (!newFileData) {
       if (prevFileData !== undefined) {
@@ -4462,11 +4525,7 @@ var watchStaticFile = (fileName, callback) => {
       callback(newFileData);
       prevFileData = newFileData;
     }
-  };
-  window.addEventListener(WATCH_REMOTION_STATIC_FILES, checkFile);
-  const cancel = () => {
-    return window.removeEventListener(WATCH_REMOTION_STATIC_FILES, checkFile);
-  };
+  });
   return { cancel };
 };
 
@@ -4494,6 +4553,9 @@ var writeStaticFile = async ({
 export {
   writeStaticFile,
   watchStaticFile,
+  watchPublicFolder,
+  updateDefaultProps,
   saveDefaultProps,
-  getStaticFiles
+  getStaticFiles,
+  deleteStaticFile
 };