@remotion/studio-server 4.0.502 → 4.0.504

package/dist/helpers/resolve-editor.d.ts

@@ -0,0 +1,27 @@
+import type { BuiltInEditor, CustomEditor, DefaultEditor } from '@remotion/renderer';
+import { type ResolvedCustomEditorExecutable } from './custom-editor';
+import type { InstalledEditor } from './editor-registry';
+import type { ProcessAndCommand } from './open-in-editor';
+export type ResolvedEditor = (ProcessAndCommand & {
+    type: 'built-in';
+    id: BuiltInEditor | null;
+    name: string;
+}) | (ResolvedCustomEditorExecutable & {
+    type: 'custom';
+    id: 'custom';
+    name: string;
+    editor: CustomEditor;
+});
+type ResolveEditorDependencies = {
+    getInstalledEditors: () => Promise<readonly InstalledEditor[]>;
+    getLegacyEditors: () => Promise<readonly ProcessAndCommand[]>;
+    resolveCustomEditor: (editor: CustomEditor) => ResolvedCustomEditorExecutable | null;
+    warn: (message: string) => void;
+    warnedEditors: Set<string>;
+};
+export declare const resolveEditor: ({ defaultEditor, logLevel, preferredEditor, }: {
+    defaultEditor: DefaultEditor | null;
+    logLevel: "error" | "info" | "trace" | "verbose" | "warn";
+    preferredEditor: "cursor" | "custom" | "sublime-text" | "vscode" | "vscodium" | "webstorm" | "windsurf" | "zed" | null;
+}, overrides?: Partial<ResolveEditorDependencies>) => Promise<ResolvedEditor | null>;
+export {};

package/dist/helpers/resolve-editor.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveEditor = void 0;
+const renderer_1 = require("@remotion/renderer");
+const custom_editor_1 = require("./custom-editor");
+const editor_registry_1 = require("./editor-registry");
+const open_in_editor_1 = require("./open-in-editor");
+let legacyEditors = null;
+const getLegacyEditors = () => {
+    legacyEditors !== null && legacyEditors !== void 0 ? legacyEditors : (legacyEditors = (0, open_in_editor_1.guessEditor)());
+    return legacyEditors;
+};
+const warnedEditors = new Set();
+const defaultDependencies = {
+    getInstalledEditors: editor_registry_1.getAvailableEditors,
+    getLegacyEditors,
+    resolveCustomEditor: custom_editor_1.resolveCustomEditorExecutable,
+    warn: () => undefined,
+    warnedEditors,
+};
+const resolveEditor = async ({ defaultEditor, logLevel, preferredEditor, }, overrides = {}) => {
+    var _a;
+    const dependencies = {
+        ...defaultDependencies,
+        warn: (message) => {
+            renderer_1.RenderInternals.Log.warn({ indent: false, logLevel }, message);
+        },
+        ...overrides,
+    };
+    if (preferredEditor === 'custom') {
+        if (!defaultEditor || typeof defaultEditor !== 'object') {
+            return null;
+        }
+        const resolvedExecutable = dependencies.resolveCustomEditor(defaultEditor);
+        if (!resolvedExecutable) {
+            return null;
+        }
+        return {
+            ...resolvedExecutable,
+            type: 'custom',
+            id: 'custom',
+            name: defaultEditor.name,
+            editor: defaultEditor,
+        };
+    }
+    if (preferredEditor !== null) {
+        const installedEditors = await dependencies.getInstalledEditors();
+        const installedEditor = installedEditors.find((editor) => editor.id === preferredEditor);
+        return installedEditor ? { ...installedEditor, type: 'built-in' } : null;
+    }
+    if (defaultEditor && typeof defaultEditor === 'object') {
+        const resolvedExecutable = dependencies.resolveCustomEditor(defaultEditor);
+        if (resolvedExecutable) {
+            return {
+                ...resolvedExecutable,
+                type: 'custom',
+                id: 'custom',
+                name: defaultEditor.name,
+                editor: defaultEditor,
+            };
+        }
+        const warningId = `custom:${defaultEditor.executable}`;
+        if (!dependencies.warnedEditors.has(warningId)) {
+            dependencies.warnedEditors.add(warningId);
+            dependencies.warn(`The executable for custom editor ${defaultEditor.name} (${defaultEditor.executable}) was not found or is not executable. Falling back to automatic editor detection.`);
+        }
+    }
+    if (typeof defaultEditor === 'string') {
+        const installedEditors = await dependencies.getInstalledEditors();
+        const installedEditor = installedEditors.find((editor) => editor.id === defaultEditor);
+        if (installedEditor) {
+            return { ...installedEditor, type: 'built-in' };
+        }
+        if (!dependencies.warnedEditors.has(defaultEditor)) {
+            dependencies.warnedEditors.add(defaultEditor);
+            dependencies.warn(`The default editor ${(0, editor_registry_1.getDefaultEditorName)(defaultEditor)} (${defaultEditor}) is not installed. Falling back to automatic editor detection.`);
+        }
+    }
+    const [legacyEditor] = await dependencies.getLegacyEditors();
+    if (!legacyEditor) {
+        return null;
+    }
+    return {
+        ...legacyEditor,
+        type: 'built-in',
+        id: null,
+        name: (_a = (0, open_in_editor_1.getDisplayNameForEditor)(legacyEditor.command)) !== null && _a !== void 0 ? _a : legacyEditor.command,
+    };
+};
+exports.resolveEditor = resolveEditor;

package/dist/helpers/resolve-file-inside-project.d.ts

@@ -1,3 +1,5 @@
+export declare class FileOutsideProjectError extends Error {
+}
 export declare const resolveFileInsideProject: ({ remotionRoot, fileName, action, }: {
     remotionRoot: string;
     fileName: string;

package/dist/helpers/resolve-file-inside-project.js

@@ -3,9 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveFileInsideProject = void 0;
+exports.resolveFileInsideProject = exports.FileOutsideProjectError = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const formatOutsideProjectError = ({ action, fileName, absolutePath, remotionRoot, }) => `Cannot ${action} a file outside the project: "${fileName}" resolves to "${absolutePath}", but the project root is "${remotionRoot}".`;
+class FileOutsideProjectError extends Error {
+}
+exports.FileOutsideProjectError = FileOutsideProjectError;
 const resolveFileInsideProject = ({ remotionRoot, fileName, action, }) => {
     const resolvedRemotionRoot = node_path_1.default.resolve(remotionRoot);
     const absolutePath = node_path_1.default.resolve(resolvedRemotionRoot, fileName);
@@ -13,7 +16,7 @@ const resolveFileInsideProject = ({ remotionRoot, fileName, action, }) => {
     if (fileRelativeToRoot === '..' ||
         fileRelativeToRoot.startsWith(`..${node_path_1.default.sep}`) ||
         node_path_1.default.isAbsolute(fileRelativeToRoot)) {
-        throw new Error(formatOutsideProjectError({
+        throw new FileOutsideProjectError(formatOutsideProjectError({
             action,
             fileName,
             absolutePath,

package/dist/index.d.ts

@@ -1,8 +1,13 @@
 export { ApiRoutes, CopyStillToClipboardRequest, getDefaultOutLocation, OpenInFileExplorerRequest, } from '@remotion/studio-shared';
 export type { AggregateRenderProgress, BundlingState, CopyingState, DownloadProgress, HotMiddlewareOptions, JobProgressCallback, ModuleMap, PackageManager, ProjectInfo, RenderingProgressInput, RenderJob, RenderJobWithCleanup, RequiredChromiumOptions, StitchingProgressInput, UiOpenGlOptions, } from '@remotion/studio-shared';
 import { AnsiDiff } from './ansi-diff';
+import { detectOutdatedRemotionSkills, parseRemotionSkillVersion } from './detect-outdated-remotion-skills';
+import { remotionSkillNames } from './remotion-skill-names';
+export type { RemotionSkillsScope, RemotionSkillsStatus, } from './detect-outdated-remotion-skills';
+export type { RemotionSkillName } from './remotion-skill-names';
+export { detectOutdatedRemotionSkills, parseRemotionSkillVersion, remotionSkillNames, };
 export declare const StudioServerInternals: {
-    startStudio: ({ browserArgs, browserFlag, shouldOpenBrowser, fullEntryPath, logLevel, getCurrentInputProps, getEnvVariables, desiredPort, remotionRoot, relativePublicDir, bundlerOverride, rspackOverride, webpackOverride, poll, getRenderDefaults, getRenderQueue, getNumberOfAudioTags, queueMethods, previewEntry, gitSource, binariesDirectory, forceIPv4, getAudioLatencyHint, getPreviewSampleRate, enableCrossSiteIsolation, forceNew, rspack, getStudioRuntimeConfig, configFile, }: {
+    startStudio: ({ browserArgs, browserFlag, shouldOpenBrowser, fullEntryPath, logLevel, getCurrentInputProps, getEnvVariables, desiredPort, remotionRoot, relativePublicDir, bundlerOverride, rspackOverride, webpackOverride, poll, getRenderDefaults, getRenderQueue, getNumberOfAudioTags, queueMethods, previewEntry, gitSource, binariesDirectory, forceIPv4, getAudioLatencyHint, getPreviewSampleRate, enableCrossSiteIsolation, forceNew, rspack, getStudioRuntimeConfig, getDefaultEditor, configFile, }: {
         browserArgs: string;
         browserFlag: string;
         logLevel: "error" | "info" | "trace" | "verbose" | "warn";
@@ -31,6 +36,7 @@ export declare const StudioServerInternals: {
         forceNew: boolean;
         rspack: boolean;
         getStudioRuntimeConfig: () => import("@remotion/studio-shared").StudioRuntimeConfig;
+        getDefaultEditor: () => import("@remotion/renderer").DefaultEditor | null;
         configFile: string | null;
     }) => Promise<import("./start-studio").StartStudioResult>;
     getRemotionVersion: () => any;
@@ -120,4 +126,14 @@ export declare const StudioServerInternals: {
     }) => void;
     getCompletedClientRenders: () => import("@remotion/studio-shared").CompletedClientRender[];
     removeCompletedClientRender: (id: string) => void;
+    detectOutdatedRemotionSkills: ({ currentVersion, cwd, homeDirectory, }?: {
+        currentVersion?: string | undefined;
+        cwd?: string | undefined;
+        homeDirectory?: string | undefined;
+    }) => {
+        project: import("./detect-outdated-remotion-skills").RemotionSkillsStatus;
+        global: import("./detect-outdated-remotion-skills").RemotionSkillsStatus;
+    };
+    parseRemotionSkillVersion: (contents: string) => string | null;
+    remotionSkillNames: readonly ["remotion-best-practices", "remotion-captions", "remotion-create", "remotion-docs", "remotion-interactivity", "remotion-maps", "remotion-markup", "remotion-multimedia", "remotion-render", "remotion-saas", "remotion-upgrade"];
 };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StudioServerInternals = exports.getDefaultOutLocation = void 0;
+exports.StudioServerInternals = exports.remotionSkillNames = exports.parseRemotionSkillVersion = exports.detectOutdatedRemotionSkills = exports.getDefaultOutLocation = void 0;
 const studio_shared_1 = require("@remotion/studio-shared");
 const studio_shared_2 = require("@remotion/studio-shared");
 Object.defineProperty(exports, "getDefaultOutLocation", { enumerable: true, get: function () { return studio_shared_2.getDefaultOutLocation; } });
@@ -9,6 +9,9 @@ const client_render_queue_1 = require("./client-render-queue");
 const apply_codemod_to_file_1 = require("./codemods/apply-codemod-to-file");
 const duplicate_composition_1 = require("./codemods/duplicate-composition");
 const update_default_props_1 = require("./codemods/update-default-props");
+const detect_outdated_remotion_skills_1 = require("./detect-outdated-remotion-skills");
+Object.defineProperty(exports, "detectOutdatedRemotionSkills", { enumerable: true, get: function () { return detect_outdated_remotion_skills_1.detectOutdatedRemotionSkills; } });
+Object.defineProperty(exports, "parseRemotionSkillVersion", { enumerable: true, get: function () { return detect_outdated_remotion_skills_1.parseRemotionSkillVersion; } });
 const file_watcher_1 = require("./file-watcher");
 const get_latest_remotion_version_1 = require("./get-latest-remotion-version");
 const get_installed_dependencies_1 = require("./helpers/get-installed-dependencies");
@@ -18,6 +21,8 @@ const max_timeline_tracks_1 = require("./max-timeline-tracks");
 const get_package_manager_1 = require("./preview-server/get-package-manager");
 const live_events_1 = require("./preview-server/live-events");
 const update_available_1 = require("./preview-server/update-available");
+const remotion_skill_names_1 = require("./remotion-skill-names");
+Object.defineProperty(exports, "remotionSkillNames", { enumerable: true, get: function () { return remotion_skill_names_1.remotionSkillNames; } });
 const start_studio_1 = require("./start-studio");
 exports.StudioServerInternals = {
     startStudio: start_studio_1.startStudio,
@@ -46,4 +51,7 @@ exports.StudioServerInternals = {
     addCompletedClientRender: client_render_queue_1.addCompletedClientRender,
     getCompletedClientRenders: client_render_queue_1.getCompletedClientRenders,
     removeCompletedClientRender: client_render_queue_1.removeCompletedClientRender,
+    detectOutdatedRemotionSkills: detect_outdated_remotion_skills_1.detectOutdatedRemotionSkills,
+    parseRemotionSkillVersion: detect_outdated_remotion_skills_1.parseRemotionSkillVersion,
+    remotionSkillNames: remotion_skill_names_1.remotionSkillNames,
 };

package/dist/preview-server/api-routes.js

@@ -12,6 +12,7 @@ const batch_update_keyframe_settings_1 = require("./routes/batch-update-keyframe
 const cancel_render_1 = require("./routes/cancel-render");
 const composition_component_info_1 = require("./routes/composition-component-info");
 const convert_figma_clipboard_to_svg_1 = require("./routes/convert-figma-clipboard-to-svg");
+const default_editor_1 = require("./routes/default-editor");
 const delete_effect_1 = require("./routes/delete-effect");
 const delete_jsx_node_1 = require("./routes/delete-jsx-node");
 const delete_keyframes_1 = require("./routes/delete-keyframes");
@@ -28,6 +29,7 @@ const move_keyframes_1 = require("./routes/move-keyframes");
 const open_in_editor_1 = require("./routes/open-in-editor");
 const open_in_file_explorer_1 = require("./routes/open-in-file-explorer");
 const paste_effects_1 = require("./routes/paste-effects");
+const prepare_element_install_1 = require("./routes/prepare-element-install");
 const project_info_1 = require("./routes/project-info");
 const redo_1 = require("./routes/redo");
 const register_client_render_1 = require("./routes/register-client-render");
@@ -62,9 +64,9 @@ exports.allApiRoutes = {
     '/api/unsubscribe-from-file-existence': unsubscribe_from_file_existence_1.unsubscribeFromFileExistence,
     '/api/subscribe-to-file-existence': subscribe_to_file_existence_1.subscribeToFileExistence,
     '/api/remove-render': remove_render_1.handleRemoveRender,
-    '/api/open-in-editor': open_in_editor_1.openInEditorHandler,
     '/api/find-in-file': find_in_file_1.findInFileHandler,
     '/api/open-in-file-explorer': open_in_file_explorer_1.handleOpenInFileExplorer,
+    '/api/open-in-editor': open_in_editor_1.openInEditorHandler,
     '/api/register-client-render': register_client_render_1.registerClientRenderHandler,
     '/api/unregister-client-render': unregister_client_render_1.unregisterClientRenderHandler,
     '/api/update-default-props': update_default_props_1.updateDefaultPropsHandler,
@@ -100,9 +102,12 @@ exports.allApiRoutes = {
     '/api/rename-static-file': rename_static_file_1.renameStaticFileHandler,
     '/api/restart-studio': restart_studio_1.handleRestartStudio,
     '/api/update-public-license': update_public_license_1.updatePublicLicenseHandler,
+    '/api/default-editor-info': default_editor_1.getDefaultEditorInfoHandler,
+    '/api/update-default-editor': default_editor_1.updateDefaultEditorHandler,
     '/api/install-package': install_dependency_1.handleInstallPackage,
     '/api/insert-jsx-element': insert_jsx_element_1.insertJsxElementHandler,
     '/api/insert-element': insert_element_1.insertElementHandler,
+    '/api/prepare-element-install': prepare_element_install_1.prepareElementInstallHandler,
     '/api/update-element-install-target': update_element_install_target_1.updateElementInstallTargetHandler,
     '/api/download-remote-asset': download_remote_asset_1.downloadRemoteAssetHandler,
     '/api/undo': undo_1.undoHandler,

package/dist/preview-server/api-types.d.ts

@@ -1,5 +1,5 @@
 import type { IncomingMessage, ServerResponse } from 'node:http';
-import type { LogLevel } from '@remotion/renderer';
+import type { DefaultEditor, LogLevel } from '@remotion/renderer';
 import type { RenderJobWithCleanup } from '@remotion/studio-shared';
 export type QueueMethods = {
     removeJob: (jobId: string) => void;
@@ -22,4 +22,5 @@ export type ApiHandler<ReqData, ResData> = (params: {
     publicDir: string;
     binariesDirectory: string | null;
     configFile: string | null;
+    getDefaultEditor: () => DefaultEditor | null;
 }) => Promise<ResData>;

package/dist/preview-server/element-install-state.d.ts

@@ -11,20 +11,27 @@ export type ElementInstallTarget = {
     studioUrl: string;
     updatedAt: number;
 };
+export type StudioProtocolTargetPurpose = 'install-element' | 'set-license-key';
 type StudioProtocolTarget = {
     readonly id: string;
+    readonly origin: string;
+    readonly purpose: StudioProtocolTargetPurpose;
     readonly target: ElementInstallTarget;
     readonly expiresAt: number;
 };
 export declare const updateElementInstallTarget: (newTarget: Omit<ElementInstallTarget, "updatedAt">) => void;
 export declare const getElementInstallTargetByClientId: (clientId: string) => ElementInstallTarget | null;
 export declare const getElementInstallTarget: (requestId: string | null) => ElementInstallTarget | null;
-export declare const issueStudioProtocolTarget: ({ now, target, }: {
+export declare const issueStudioProtocolTarget: ({ now, origin, purpose, target, }: {
     readonly now: number;
+    readonly origin: string;
+    readonly purpose: StudioProtocolTargetPurpose;
     readonly target: ElementInstallTarget;
 }) => StudioProtocolTarget;
-export declare const consumeStudioProtocolTarget: ({ now, targetId, }: {
+export declare const consumeStudioProtocolTarget: ({ now, origin, purpose, targetId, }: {
     readonly now: number;
+    readonly origin: string;
+    readonly purpose: StudioProtocolTargetPurpose;
     readonly targetId: string;
 }) => ElementInstallTarget | null;
 export declare const clearElementInstallStateForTests: () => void;

package/dist/preview-server/element-install-state.js

@@ -45,7 +45,7 @@ const getElementInstallTarget = (requestId) => {
     return bestTarget;
 };
 exports.getElementInstallTarget = getElementInstallTarget;
-const issueStudioProtocolTarget = ({ now, target, }) => {
+const issueStudioProtocolTarget = ({ now, origin, purpose, target, }) => {
     for (const [id, existing] of studioProtocolTargets) {
         if (existing.expiresAt <= now) {
             studioProtocolTargets.delete(id);
@@ -53,6 +53,8 @@ const issueStudioProtocolTarget = ({ now, target, }) => {
     }
     const issued = {
         id: (0, node_crypto_1.randomUUID)(),
+        origin,
+        purpose,
         target: { ...target },
         expiresAt: now + exports.STUDIO_PROTOCOL_TARGET_MAX_AGE,
     };
@@ -60,17 +62,25 @@ const issueStudioProtocolTarget = ({ now, target, }) => {
     return issued;
 };
 exports.issueStudioProtocolTarget = issueStudioProtocolTarget;
-const consumeStudioProtocolTarget = ({ now, targetId, }) => {
+const consumeStudioProtocolTarget = ({ now, origin, purpose, targetId, }) => {
     const issued = studioProtocolTargets.get(targetId);
     studioProtocolTargets.delete(targetId);
-    if (issued === undefined || issued.expiresAt <= now) {
+    if (issued === undefined ||
+        issued.expiresAt <= now ||
+        issued.origin !== origin ||
+        issued.purpose !== purpose) {
         return null;
     }
     const current = (0, exports.getElementInstallTargetByClientId)(issued.target.clientId);
     if (current === null ||
         now - current.updatedAt >= exports.ELEMENT_INSTALL_TARGET_MAX_AGE ||
-        !current.canInstall ||
-        current.readOnly ||
+        current.readOnly) {
+        return null;
+    }
+    if (purpose === 'set-license-key') {
+        return issued.target;
+    }
+    if (!current.canInstall ||
         current.compositionFile !== issued.target.compositionFile ||
         current.compositionId !== issued.target.compositionId) {
         return null;

package/dist/preview-server/handler.d.ts

@@ -1,6 +1,7 @@
 import type { IncomingMessage, ServerResponse } from 'node:http';
+import type { DefaultEditor } from '@remotion/renderer';
 import type { ApiHandler, QueueMethods } from './api-types';
-export declare const handleRequest: <Req, Res>({ remotionRoot, request, response, entryPoint, handler, logLevel, methods, binariesDirectory, publicDir, configFile, }: {
+export declare const handleRequest: <Req, Res>({ remotionRoot, request, response, entryPoint, handler, logLevel, methods, binariesDirectory, publicDir, configFile, getDefaultEditor, }: {
     remotionRoot: string;
     publicDir: string;
     request: IncomingMessage;
@@ -8,6 +9,7 @@ export declare const handleRequest: <Req, Res>({ remotionRoot, request, response
     entryPoint: string;
     binariesDirectory: string | null;
     configFile: string | null;
+    getDefaultEditor: () => DefaultEditor | null;
     handler: ApiHandler<Req, Res>;
     logLevel: "error" | "info" | "trace" | "verbose" | "warn";
     methods: QueueMethods;

package/dist/preview-server/handler.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleRequest = void 0;
 const parse_body_1 = require("./parse-body");
 const validate_same_origin_1 = require("./validate-same-origin");
-const handleRequest = async ({ remotionRoot, request, response, entryPoint, handler, logLevel, methods, binariesDirectory, publicDir, configFile, }) => {
+const handleRequest = async ({ remotionRoot, request, response, entryPoint, handler, logLevel, methods, binariesDirectory, publicDir, configFile, getDefaultEditor, }) => {
     if (request.method === 'OPTIONS') {
         response.statusCode = 200;
         response.end();
@@ -25,6 +25,7 @@ const handleRequest = async ({ remotionRoot, request, response, entryPoint, hand
             binariesDirectory,
             publicDir,
             configFile,
+            getDefaultEditor,
         });
         response.end(JSON.stringify({
             success: true,

package/dist/preview-server/routes/can-update-sequence-props.js

@@ -1017,7 +1017,8 @@ const computeSequencePropsStatusFromFilenameByLocation = ({ fileName, line, colu
         };
     }
     catch (err) {
-        if (err instanceof jsx_component_identity_1.JsxElementIdentityMismatchError ||
+        if (err instanceof resolve_file_inside_project_1.FileOutsideProjectError ||
+            err instanceof jsx_component_identity_1.JsxElementIdentityMismatchError ||
             err instanceof jsx_element_not_found_at_location_error_1.JsxElementNotFoundAtLocationError) {
             return {
                 status: {

package/dist/preview-server/routes/default-editor.d.ts

@@ -0,0 +1,8 @@
+import type { GetDefaultEditorInfoRequest, GetDefaultEditorInfoResponse, UpdateDefaultEditorRequest, UpdateDefaultEditorResponse } from '@remotion/studio-shared';
+import type { ApiHandler } from '../api-types';
+export declare const updateDefaultEditorInConfig: ({ configContents, defaultEditor, }: {
+    configContents: string;
+    defaultEditor: "cursor" | "sublime-text" | "vscode" | "vscodium" | "webstorm" | "windsurf" | "zed" | null;
+}) => string;
+export declare const getDefaultEditorInfoHandler: ApiHandler<GetDefaultEditorInfoRequest, GetDefaultEditorInfoResponse>;
+export declare const updateDefaultEditorHandler: ApiHandler<UpdateDefaultEditorRequest, UpdateDefaultEditorResponse>;

package/dist/preview-server/routes/default-editor.js

@@ -0,0 +1,131 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateDefaultEditorHandler = exports.getDefaultEditorInfoHandler = exports.updateDefaultEditorInConfig = void 0;
+const node_fs_1 = require("node:fs");
+const renderer_1 = require("@remotion/renderer");
+const recast = __importStar(require("recast"));
+const parse_ast_1 = require("../../codemods/parse-ast");
+const file_watcher_1 = require("../../file-watcher");
+const editor_registry_1 = require("../../helpers/editor-registry");
+const updateDefaultEditorInConfig = ({ configContents, defaultEditor, }) => {
+    const ast = (0, parse_ast_1.parseAst)(configContents);
+    recast.types.visit(ast.program, {
+        visitExpressionStatement(path) {
+            const { expression } = path.node;
+            if (expression.type === 'CallExpression' &&
+                expression.callee.type === 'MemberExpression' &&
+                !expression.callee.computed &&
+                expression.callee.object.type === 'Identifier' &&
+                expression.callee.object.name === 'Config' &&
+                expression.callee.property.type === 'Identifier' &&
+                expression.callee.property.name === 'setDefaultEditor') {
+                path.prune();
+                return false;
+            }
+            this.traverse(path);
+        },
+    });
+    const configWithoutExistingCalls = recast.print(ast, {
+        lineTerminator: '\n',
+    }).code;
+    if (defaultEditor === null) {
+        return configWithoutExistingCalls;
+    }
+    const separator = configWithoutExistingCalls.endsWith('\n') ? '' : '\n';
+    return `${configWithoutExistingCalls}${separator}Config.setDefaultEditor('${defaultEditor}');\n`;
+};
+exports.updateDefaultEditorInConfig = updateDefaultEditorInConfig;
+const getDefaultEditorInfoHandler = async ({ getDefaultEditor }) => {
+    const installedEditors = await (0, editor_registry_1.getAvailableEditors)();
+    const configuredEditor = getDefaultEditor();
+    const customEditor = configuredEditor && typeof configuredEditor === 'object'
+        ? configuredEditor
+        : null;
+    return {
+        defaultEditor: typeof configuredEditor === 'object' ? 'custom' : configuredEditor,
+        installedEditors: [
+            ...installedEditors.map(({ id, name }) => ({ id, name })),
+            ...(customEditor
+                ? [{ id: 'custom', name: customEditor.name }]
+                : []),
+        ],
+    };
+};
+exports.getDefaultEditorInfoHandler = getDefaultEditorInfoHandler;
+const updateDefaultEditorHandler = async ({ input, configFile, getDefaultEditor }) => {
+    if (configFile === null || configFile === undefined) {
+        return {
+            success: false,
+            reason: 'No Remotion config file was loaded.',
+        };
+    }
+    if (input.defaultEditor === 'custom') {
+        const configuredEditor = getDefaultEditor();
+        if (!configuredEditor || typeof configuredEditor !== 'object') {
+            return {
+                success: false,
+                reason: 'No custom editor is configured.',
+            };
+        }
+        // The browser only knows the opaque "custom" ID. Keeping the existing
+        // config call untouched avoids exposing or rewriting its executable and
+        // arguments, which may have come from environment variables.
+        return { success: true };
+    }
+    if (input.defaultEditor !== null &&
+        !renderer_1.defaultEditorIds.includes(input.defaultEditor)) {
+        return {
+            success: false,
+            reason: `Unknown editor: ${input.defaultEditor}`,
+        };
+    }
+    if (input.defaultEditor !== null) {
+        const installedEditors = await (0, editor_registry_1.getAvailableEditors)();
+        if (!installedEditors.some(({ id }) => id === input.defaultEditor)) {
+            return {
+                success: false,
+                reason: 'The selected editor is not installed.',
+            };
+        }
+    }
+    const configContents = (0, node_fs_1.readFileSync)(configFile, 'utf8');
+    (0, file_watcher_1.writeFileAndNotifyFileWatchers)(configFile, (0, exports.updateDefaultEditorInConfig)({
+        configContents,
+        defaultEditor: input.defaultEditor,
+    }), undefined);
+    return { success: true };
+};
+exports.updateDefaultEditorHandler = updateDefaultEditorHandler;

package/dist/preview-server/routes/delete-effect-keyframe.d.ts

@@ -0,0 +1,3 @@
+import type { DeleteEffectKeyframeRequest, DeleteEffectKeyframeResponse } from '@remotion/studio-shared';
+import type { ApiHandler } from '../api-types';
+export declare const deleteEffectKeyframeHandler: ApiHandler<DeleteEffectKeyframeRequest, DeleteEffectKeyframeResponse>;

package/dist/preview-server/routes/delete-effect-keyframe.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteEffectKeyframeHandler = void 0;
+const node_fs_1 = require("node:fs");
+const renderer_1 = require("@remotion/renderer");
+const studio_shared_1 = require("@remotion/studio-shared");
+const parse_ast_1 = require("../../codemods/parse-ast");
+const update_keyframes_1 = require("../../codemods/update-keyframes/update-keyframes");
+const file_watcher_1 = require("../../file-watcher");
+const resolve_file_inside_project_1 = require("../../helpers/resolve-file-inside-project");
+const undo_stack_1 = require("../undo-stack");
+const watch_ignore_next_change_1 = require("../watch-ignore-next-change");
+const can_update_effect_props_1 = require("./can-update-effect-props");
+const can_update_sequence_props_1 = require("./can-update-sequence-props");
+const log_effect_update_1 = require("./log-updates/log-effect-update");
+const save_props_mutex_1 = require("./save-props-mutex");
+const deleteEffectKeyframeHandler = ({ input: { fileName, sequenceNodePath, effectIndex, key, frame, schema, clientId, }, remotionRoot, logLevel, }) => (0, save_props_mutex_1.withSavePropsLock)(async () => {
+    renderer_1.RenderInternals.Log.trace({ indent: false, logLevel }, `[delete-effect-keyframe] Received request for fileName="${fileName}" effectIndex=${effectIndex} key="${key}" frame=${frame}`);
+    const { absolutePath, fileRelativeToRoot } = (0, resolve_file_inside_project_1.resolveFileInsideProject)({
+        remotionRoot,
+        fileName,
+        action: 'modify',
+    });
+    const fileContents = (0, node_fs_1.readFileSync)(absolutePath, 'utf-8');
+    const { output, oldValueStrings, newValueStrings, formatted, logLine, effectCallee, } = await (0, update_keyframes_1.updateEffectKeyframes)({
+        input: fileContents,
+        sequenceNodePath: sequenceNodePath.nodePath,
+        effectIndex,
+        updates: [
+            {
+                key,
+                operation: {
+                    type: 'remove',
+                    frame,
+                },
+            },
+        ],
+    });
+    const oldValueString = oldValueStrings[0];
+    const newValueString = newValueStrings[0];
+    const undoPropChange = `${key} keyframe restored at frame ${frame}`;
+    const redoPropChange = `${key} keyframe deleted at frame ${frame}`;
+    (0, undo_stack_1.pushToUndoStack)({
+        filePath: absolutePath,
+        oldContents: fileContents,
+        newContents: null,
+        logLevel,
+        remotionRoot,
+        logLine,
+        description: {
+            undoMessage: `↩️  ${undoPropChange}`,
+            redoMessage: `↪️  ${redoPropChange}`,
+        },
+        entryType: 'effect-props',
+        suppressHmrOnFileRestore: true,
+    });
+    (0, undo_stack_1.suppressUndoStackInvalidation)(absolutePath);
+    (0, watch_ignore_next_change_1.suppressBundlerUpdateForFile)(absolutePath);
+    (0, file_watcher_1.writeFileAndNotifyFileWatchers)(absolutePath, output, clientId);
+    (0, log_effect_update_1.logEffectUpdate)({
+        fileRelativeToRoot,
+        line: logLine,
+        effectName: effectCallee,
+        propKey: key,
+        oldValueString,
+        newValueString,
+        defaultValueString: null,
+        formatted,
+        logLevel,
+        removedProps: [],
+        addedProps: [],
+    });
+    (0, undo_stack_1.printUndoHint)(logLevel);
+    const ast = (0, parse_ast_1.parseAst)((0, node_fs_1.readFileSync)(absolutePath, 'utf-8'));
+    const jsx = (0, can_update_sequence_props_1.findJsxElementAtNodePath)(ast, sequenceNodePath.nodePath);
+    if (!jsx) {
+        return {
+            canUpdate: false,
+            effectIndex,
+            reason: 'not-found',
+        };
+    }
+    return (0, can_update_effect_props_1.computeEffectPropStatus)({
+        jsx,
+        effectIndex,
+        keys: (0, studio_shared_1.getAllSchemaKeys)(schema),
+    });
+});
+exports.deleteEffectKeyframeHandler = deleteEffectKeyframeHandler;

package/dist/preview-server/routes/delete-sequence-keyframe.d.ts

@@ -0,0 +1,3 @@
+import type { DeleteSequenceKeyframeRequest, DeleteSequenceKeyframeResponse } from '@remotion/studio-shared';
+import type { ApiHandler } from '../api-types';
+export declare const deleteSequenceKeyframeHandler: ApiHandler<DeleteSequenceKeyframeRequest, DeleteSequenceKeyframeResponse>;