@remotion/studio-server 4.0.468 → 4.0.470

package/dist/codemods/delete-effect.d.ts

@@ -1,4 +1,22 @@
 import type { SequenceNodePath } from 'remotion';
+export type EffectDeletionTarget = {
+    sequenceNodePath: SequenceNodePath;
+} & ({
+    type: 'single-effect';
+    effectIndex: number;
+} | {
+    type: 'all-effects';
+});
+export declare const deleteEffects: ({ input, effects, prettierConfigOverride, }: {
+    input: string;
+    effects: EffectDeletionTarget[];
+    prettierConfigOverride?: Record<string, unknown> | null | undefined;
+}) => Promise<{
+    output: string;
+    formatted: boolean;
+    effectLabels: string[];
+    logLines: number[];
+}>;
 export declare const deleteEffect: ({ input, sequenceNodePath, effectIndex, prettierConfigOverride, }: {
     input: string;
     sequenceNodePath: SequenceNodePath;

package/dist/codemods/delete-effect.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteEffect = void 0;
+exports.deleteEffect = exports.deleteEffects = void 0;
 const can_update_sequence_props_1 = require("../preview-server/routes/can-update-sequence-props");
 const format_file_content_1 = require("./format-file-content");
 const parse_ast_1 = require("./parse-ast");
@@ -15,28 +15,88 @@ const getEffectsArray = (attr) => {
     }
     return expr;
 };
-const deleteEffect = async ({ input, sequenceNodePath, effectIndex, prettierConfigOverride, }) => {
+const getAllEffectLabels = (effectsArray, attr) => {
+    if (effectsArray.elements.length === 0) {
+        throw new Error('Cannot delete effect: no effects found');
+    }
+    const elements = (0, update_effect_props_1.enumerateEffectArrayElements)(effectsArray);
+    return {
+        effectLabels: elements.map((effect) => effect.kind === 'call' ? `${effect.callee}()` : 'effect'),
+        logLines: elements.map((effect) => {
+            var _a, _b, _c;
+            var _d, _e, _f;
+            return effect.kind === 'call'
+                ? ((_e = (_d = (_a = effect.node.loc) === null || _a === void 0 ? void 0 : _a.start.line) !== null && _d !== void 0 ? _d : (_b = attr.loc) === null || _b === void 0 ? void 0 : _b.start.line) !== null && _e !== void 0 ? _e : 1)
+                : ((_f = (_c = attr.loc) === null || _c === void 0 ? void 0 : _c.start.line) !== null && _f !== void 0 ? _f : 1);
+        }),
+    };
+};
+const deleteEffects = async ({ input, effects, prettierConfigOverride, }) => {
     var _a, _b;
     var _c, _d, _e;
-    const ast = (0, parse_ast_1.parseAst)(input);
-    const jsx = (0, can_update_sequence_props_1.findJsxElementAtNodePath)(ast, sequenceNodePath);
-    if (!jsx) {
-        throw new Error('Could not find a JSX element at the specified location to delete effect');
+    if (effects.length === 0) {
+        throw new Error('No effects were specified for deletion');
     }
-    const attr = (0, update_effect_props_1.findEffectsAttr)((_c = jsx.attributes) !== null && _c !== void 0 ? _c : []);
-    if (!attr) {
-        throw new Error('Could not find effects on the target JSX element');
-    }
-    const effectsArray = getEffectsArray(attr);
-    const found = (0, update_effect_props_1.findEffectCallExpression)({ attr, effectIndex });
-    if (found.kind === 'error') {
-        throw new Error(`Cannot delete effect: ${found.reason}`);
+    const ast = (0, parse_ast_1.parseAst)(input);
+    const deletionsByAttr = new Map();
+    for (const effect of effects) {
+        const { sequenceNodePath } = effect;
+        const jsx = (0, can_update_sequence_props_1.findJsxElementAtNodePath)(ast, sequenceNodePath);
+        if (!jsx) {
+            throw new Error('Could not find a JSX element at the specified location to delete effect');
+        }
+        const attr = (0, update_effect_props_1.findEffectsAttr)((_c = jsx.attributes) !== null && _c !== void 0 ? _c : []);
+        if (!attr) {
+            throw new Error('Could not find effects on the target JSX element');
+        }
+        const effectsArray = getEffectsArray(attr);
+        const existingDeletion = deletionsByAttr.get(attr);
+        const deletion = existingDeletion !== null && existingDeletion !== void 0 ? existingDeletion : {
+            jsxAttributes: jsx.attributes,
+            attr,
+            effectsArray,
+            allEffects: false,
+            effectIndices: new Set(),
+            effectLabels: [],
+            logLines: [],
+        };
+        deletionsByAttr.set(attr, deletion);
+        if (effect.type === 'all-effects') {
+            const { effectLabels, logLines } = getAllEffectLabels(effectsArray, attr);
+            deletion.allEffects = true;
+            deletion.effectIndices.clear();
+            deletion.effectLabels = effectLabels;
+            deletion.logLines = logLines;
+            continue;
+        }
+        const { effectIndex } = effect;
+        if (deletion.allEffects || deletion.effectIndices.has(effectIndex)) {
+            continue;
+        }
+        const found = (0, update_effect_props_1.findEffectCallExpression)({ attr, effectIndex });
+        if (found.kind === 'error') {
+            throw new Error(`Cannot delete effect: ${found.reason}`);
+        }
+        deletion.effectIndices.add(effectIndex);
+        deletion.effectLabels.push(`${found.callee}()`);
+        deletion.logLines.push((_e = (_d = (_a = found.call.loc) === null || _a === void 0 ? void 0 : _a.start.line) !== null && _d !== void 0 ? _d : (_b = jsx.loc) === null || _b === void 0 ? void 0 : _b.start.line) !== null && _e !== void 0 ? _e : 1);
     }
-    effectsArray.elements.splice(effectIndex, 1);
-    if (effectsArray.elements.length === 0) {
-        const attrIndex = jsx.attributes.indexOf(attr);
-        if (attrIndex !== -1) {
-            jsx.attributes.splice(attrIndex, 1);
+    for (const deletion of deletionsByAttr.values()) {
+        if (deletion.allEffects) {
+            const attrIndex = deletion.jsxAttributes.indexOf(deletion.attr);
+            if (attrIndex !== -1) {
+                deletion.jsxAttributes.splice(attrIndex, 1);
+            }
+            continue;
+        }
+        for (const effectIndex of [...deletion.effectIndices].sort((a, b) => b - a)) {
+            deletion.effectsArray.elements.splice(effectIndex, 1);
+        }
+        if (deletion.effectsArray.elements.length === 0) {
+            const attrIndex = deletion.jsxAttributes.indexOf(deletion.attr);
+            if (attrIndex !== -1) {
+                deletion.jsxAttributes.splice(attrIndex, 1);
+            }
         }
     }
     const finalFile = (0, parse_ast_1.serializeAst)(ast);
@@ -47,8 +107,22 @@ const deleteEffect = async ({ input, sequenceNodePath, effectIndex, prettierConf
     return {
         output,
         formatted,
-        effectLabel: `${found.callee}()`,
-        logLine: (_e = (_d = (_a = found.call.loc) === null || _a === void 0 ? void 0 : _a.start.line) !== null && _d !== void 0 ? _d : (_b = jsx.loc) === null || _b === void 0 ? void 0 : _b.start.line) !== null && _e !== void 0 ? _e : 1,
+        effectLabels: [...deletionsByAttr.values()].flatMap((deletion) => deletion.effectLabels),
+        logLines: [...deletionsByAttr.values()].flatMap((deletion) => deletion.logLines),
+    };
+};
+exports.deleteEffects = deleteEffects;
+const deleteEffect = async ({ input, sequenceNodePath, effectIndex, prettierConfigOverride, }) => {
+    const { output, formatted, effectLabels, logLines } = await (0, exports.deleteEffects)({
+        input,
+        effects: [{ type: 'single-effect', sequenceNodePath, effectIndex }],
+        prettierConfigOverride,
+    });
+    return {
+        output,
+        formatted,
+        effectLabel: effectLabels[0],
+        logLine: logLines[0],
     };
 };
 exports.deleteEffect = deleteEffect;

package/dist/codemods/delete-jsx-node.d.ts

@@ -4,6 +4,16 @@ import type { SequenceNodePath } from 'remotion';
 export declare const getJsxElementTagLabel: (element: JSXElement) => string;
 export declare const findJsxElementPathForDeletion: (ast: File, nodePath: SequenceNodePath) => import("ast-types/lib/node-path").NodePath<N, V> | null;
 export declare const deleteJsxElementAtPath: (jsxPath: import("ast-types/lib/node-path").NodePath<N, V>) => void;
+export declare const deleteJsxNodes: ({ input, nodePaths, prettierConfigOverride, }: {
+    input: string;
+    nodePaths: SequenceNodePath[];
+    prettierConfigOverride?: Record<string, unknown> | null | undefined;
+}) => Promise<{
+    output: string;
+    formatted: boolean;
+    nodeLabels: string[];
+    logLines: number[];
+}>;
 export declare const deleteJsxNode: ({ input, nodePath, prettierConfigOverride, }: {
     input: string;
     nodePath: SequenceNodePath;

package/dist/codemods/delete-jsx-node.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteJsxNode = exports.deleteJsxElementAtPath = exports.findJsxElementPathForDeletion = exports.getJsxElementTagLabel = void 0;
+exports.deleteJsxNode = exports.deleteJsxNodes = exports.deleteJsxElementAtPath = exports.findJsxElementPathForDeletion = exports.getJsxElementTagLabel = void 0;
 const recast = __importStar(require("recast"));
 const get_ast_node_path_1 = require("../helpers/get-ast-node-path");
 const format_file_content_1 = require("./format-file-content");
@@ -287,18 +287,28 @@ const deleteJsxElementAtPath = (jsxPath) => {
     jsxPath.replace(b.nullLiteral());
 };
 exports.deleteJsxElementAtPath = deleteJsxElementAtPath;
-const deleteJsxNode = async ({ input, nodePath, prettierConfigOverride, }) => {
-    var _a, _b;
-    var _c, _d;
+const deleteJsxNodes = async ({ input, nodePaths, prettierConfigOverride, }) => {
+    if (nodePaths.length === 0) {
+        throw new Error('No JSX nodes were specified for deletion');
+    }
     const ast = (0, parse_ast_1.parseAst)(input);
-    const jsxPath = (0, exports.findJsxElementPathForDeletion)(ast, nodePath);
-    if (!jsxPath) {
-        throw new Error('Could not find a JSX element at the specified location to delete');
-    }
-    const jsxElement = jsxPath.node;
-    const nodeLabel = (0, exports.getJsxElementTagLabel)(jsxElement);
-    const logLine = (_d = (_c = (_a = jsxElement.openingElement.loc) === null || _a === void 0 ? void 0 : _a.start.line) !== null && _c !== void 0 ? _c : (_b = jsxElement.loc) === null || _b === void 0 ? void 0 : _b.start.line) !== null && _d !== void 0 ? _d : 1;
-    (0, exports.deleteJsxElementAtPath)(jsxPath);
+    const pathsToDelete = nodePaths.map((nodePath) => {
+        var _a, _b;
+        var _c, _d;
+        const jsxPath = (0, exports.findJsxElementPathForDeletion)(ast, nodePath);
+        if (!jsxPath) {
+            throw new Error('Could not find a JSX element at the specified location to delete');
+        }
+        const jsxElement = jsxPath.node;
+        return {
+            jsxPath,
+            nodeLabel: (0, exports.getJsxElementTagLabel)(jsxElement),
+            logLine: (_d = (_c = (_a = jsxElement.openingElement.loc) === null || _a === void 0 ? void 0 : _a.start.line) !== null && _c !== void 0 ? _c : (_b = jsxElement.loc) === null || _b === void 0 ? void 0 : _b.start.line) !== null && _d !== void 0 ? _d : 1,
+        };
+    });
+    for (const { jsxPath } of pathsToDelete) {
+        (0, exports.deleteJsxElementAtPath)(jsxPath);
+    }
     const finalFile = (0, parse_ast_1.serializeAst)(ast);
     const { output, formatted } = await (0, format_file_content_1.formatFileContent)({
         input: finalFile,
@@ -307,8 +317,22 @@ const deleteJsxNode = async ({ input, nodePath, prettierConfigOverride, }) => {
     return {
         output,
         formatted,
-        nodeLabel,
-        logLine,
+        nodeLabels: pathsToDelete.map(({ nodeLabel }) => nodeLabel),
+        logLines: pathsToDelete.map(({ logLine }) => logLine),
+    };
+};
+exports.deleteJsxNodes = deleteJsxNodes;
+const deleteJsxNode = async ({ input, nodePath, prettierConfigOverride, }) => {
+    const { output, formatted, nodeLabels, logLines } = await (0, exports.deleteJsxNodes)({
+        input,
+        nodePaths: [nodePath],
+        prettierConfigOverride,
+    });
+    return {
+        output,
+        formatted,
+        nodeLabel: nodeLabels[0],
+        logLine: logLines[0],
     };
 };
 exports.deleteJsxNode = deleteJsxNode;

package/dist/codemods/update-keyframes/ensure-imports-and-frame-hook.d.ts

@@ -0,0 +1,4 @@
+import type { File } from '@babel/types';
+export declare const findEnclosingFunctionPath: (path: import("ast-types/lib/node-path").NodePath<N, V>) => import("ast-types/lib/node-path").NodePath<N, V> | null;
+export declare const ensureRemotionImports: (ast: File, names: ReadonlySet<string>) => void;
+export declare const ensureUseCurrentFrameHook: (functionPath: import("ast-types/lib/node-path").NodePath<N, V>) => void;

package/dist/codemods/update-keyframes/ensure-imports-and-frame-hook.js

@@ -0,0 +1,152 @@
+"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.ensureUseCurrentFrameHook = exports.ensureRemotionImports = exports.findEnclosingFunctionPath = void 0;
+const recast = __importStar(require("recast"));
+const b = recast.types.builders;
+const n = recast.types.namedTypes;
+const isFunctionNode = (value) => {
+    return (n.FunctionDeclaration.check(value) ||
+        n.FunctionExpression.check(value) ||
+        n.ArrowFunctionExpression.check(value));
+};
+const findEnclosingFunctionPath = (path) => {
+    let current = path.parentPath;
+    while (current) {
+        if (isFunctionNode(current.value)) {
+            return current;
+        }
+        current = current.parentPath;
+    }
+    return null;
+};
+exports.findEnclosingFunctionPath = findEnclosingFunctionPath;
+const findRemotionImport = (ast) => {
+    for (const stmt of ast.program.body) {
+        if (stmt.type === 'ImportDeclaration' &&
+            stmt.source.type === 'StringLiteral' &&
+            stmt.source.value === 'remotion') {
+            return stmt;
+        }
+    }
+    return null;
+};
+const insertImportDeclaration = (ast, importDecl) => {
+    const { body } = ast.program;
+    let lastImportIndex = -1;
+    for (let i = 0; i < body.length; i++) {
+        if (body[i].type === 'ImportDeclaration') {
+            lastImportIndex = i;
+        }
+    }
+    body.splice(lastImportIndex + 1, 0, importDecl);
+};
+const ensureRemotionImports = (ast, names) => {
+    var _a, _b;
+    if (names.size === 0) {
+        return;
+    }
+    let remotionImport = findRemotionImport(ast);
+    if (!remotionImport) {
+        remotionImport = b.importDeclaration([], b.stringLiteral('remotion'));
+        insertImportDeclaration(ast, remotionImport);
+    }
+    const existingNames = new Set();
+    for (const specifier of (_a = remotionImport.specifiers) !== null && _a !== void 0 ? _a : []) {
+        if (specifier.type !== 'ImportSpecifier') {
+            continue;
+        }
+        const { imported } = specifier;
+        if (imported.type === 'Identifier') {
+            existingNames.add(imported.name);
+        }
+        else if (imported.type === 'StringLiteral') {
+            existingNames.add(imported.value);
+        }
+    }
+    for (const name of names) {
+        if (existingNames.has(name)) {
+            continue;
+        }
+        remotionImport.specifiers = (_b = remotionImport.specifiers) !== null && _b !== void 0 ? _b : [];
+        remotionImport.specifiers.push(b.importSpecifier(b.identifier(name)));
+        existingNames.add(name);
+    }
+};
+exports.ensureRemotionImports = ensureRemotionImports;
+const componentBodyHasFrameDeclaration = (body) => {
+    if (!n.BlockStatement.check(body)) {
+        return false;
+    }
+    for (const stmt of body.body) {
+        if (stmt.type !== 'VariableDeclaration') {
+            continue;
+        }
+        for (const decl of stmt.declarations) {
+            if (decl.type !== 'VariableDeclarator') {
+                continue;
+            }
+            if (decl.id.type === 'Identifier' &&
+                decl.id.name === 'frame' &&
+                decl.init &&
+                decl.init.type === 'CallExpression' &&
+                decl.init.callee.type === 'Identifier' &&
+                decl.init.callee.name === 'useCurrentFrame') {
+                return true;
+            }
+        }
+    }
+    return false;
+};
+const ensureUseCurrentFrameHook = (functionPath) => {
+    const fn = functionPath.value;
+    if (!n.BlockStatement.check(fn.body)) {
+        // Arrow function with expression body: wrap the expression in a block so
+        // we can prepend the hook call before returning the original expression.
+        const expression = fn.body;
+        fn.body = b.blockStatement([
+            b.returnStatement(expression),
+        ]);
+    }
+    if (componentBodyHasFrameDeclaration(fn.body)) {
+        return;
+    }
+    const block = fn.body;
+    const frameDecl = b.variableDeclaration('const', [
+        b.variableDeclarator(b.identifier('frame'), b.callExpression(b.identifier('useCurrentFrame'), [])),
+    ]);
+    block.body.unshift(frameDecl);
+};
+exports.ensureUseCurrentFrameHook = ensureUseCurrentFrameHook;

package/dist/codemods/update-keyframes/update-keyframes.d.ts

@@ -15,6 +15,10 @@ export type EffectKeyframeUpdate = {
     key: string;
     operation: KeyframeOperation;
 };
+export type IntroducedKeyframeIdentifiers = {
+    calleeName: 'interpolate' | 'interpolateColors' | null;
+    needsFrameHook: boolean;
+};
 export declare const updateSequenceKeyframesAst: ({ input, nodePath, updates, }: {
     input: string;
     nodePath: SequenceNodePath;
@@ -22,6 +26,7 @@ export declare const updateSequenceKeyframesAst: ({ input, nodePath, updates, }:
 }) => {
     serialized: string;
     oldValueStrings: string[];
+    newValueStrings: string[];
     logLine: number;
 };
 export declare const updateSequenceKeyframes: ({ input, nodePath, updates, prettierConfigOverride, }: {
@@ -33,6 +38,7 @@ export declare const updateSequenceKeyframes: ({ input, nodePath, updates, prett
     output: string;
     formatted: boolean;
     oldValueStrings: string[];
+    newValueStrings: string[];
     logLine: number;
 }>;
 export declare const updateEffectKeyframesAst: ({ input, sequenceNodePath, effectIndex, updates, }: {
@@ -43,6 +49,7 @@ export declare const updateEffectKeyframesAst: ({ input, sequenceNodePath, effec
 }) => {
     serialized: string;
     oldValueStrings: string[];
+    newValueStrings: string[];
     logLine: number;
     effectCallee: string;
 };
@@ -56,6 +63,7 @@ export declare const updateEffectKeyframes: ({ input, sequenceNodePath, effectIn
     output: string;
     formatted: boolean;
     oldValueStrings: string[];
+    newValueStrings: string[];
     logLine: number;
     effectCallee: string;
 }>;