@esportsplus/reactivity 0.23.0 → 0.23.1

package/src/transformer/transforms/reactive-primitives.ts

@@ -0,0 +1,461 @@
+import { uid, type Range } from '@esportsplus/typescript/transformer';
+import type { BindingType, Bindings } from '~/types';
+import { addMissingImports, applyReplacements, Replacement } from './utilities';
+import ts from 'typescript';
+
+
+interface ArgContext {
+    argStart: number;
+    innerReplacements: Replacement[];
+    neededImports: Set<string>;
+    scopedBindings: ScopeBinding[];
+    sourceFile: ts.SourceFile;
+}
+
+interface ScopeBinding {
+    name: string;
+    scope: ts.Node;
+    type: BindingType;
+}
+
+interface TransformContext {
+    bindings: Bindings;
+    computedArgRanges: Range[];
+    hasReactiveImport: boolean;
+    neededImports: Set<string>;
+    replacements: Replacement[];
+    scopedBindings: ScopeBinding[];
+    sourceFile: ts.SourceFile;
+}
+
+
+function classifyReactiveArg(arg: ts.Expression): 'computed' | 'signal' | null {
+    if (ts.isArrowFunction(arg) || ts.isFunctionExpression(arg)) {
+        return 'computed';
+    }
+
+    if (ts.isObjectLiteralExpression(arg) || ts.isArrayLiteralExpression(arg)) {
+        return null;
+    }
+
+    return 'signal';
+}
+
+function findBinding(bindings: ScopeBinding[], name: string, node: ts.Node): ScopeBinding | undefined {
+    for (let i = 0, n = bindings.length; i < n; i++) {
+        let b = bindings[i];
+
+        if (b.name === name && isInScope(node, b)) {
+            return b;
+        }
+    }
+
+    return undefined;
+}
+
+function findEnclosingScope(node: ts.Node): ts.Node {
+    let current = node.parent;
+
+    while (current) {
+        if (
+            ts.isBlock(current) ||
+            ts.isSourceFile(current) ||
+            ts.isFunctionDeclaration(current) ||
+            ts.isFunctionExpression(current) ||
+            ts.isArrowFunction(current) ||
+            ts.isForStatement(current) ||
+            ts.isForInStatement(current) ||
+            ts.isForOfStatement(current)
+        ) {
+            return current;
+        }
+
+        current = current.parent;
+    }
+
+    return node.getSourceFile();
+}
+
+function getCompoundOperator(kind: ts.SyntaxKind): string {
+    if (kind === ts.SyntaxKind.PlusEqualsToken) {
+        return '+';
+    }
+    else if (kind === ts.SyntaxKind.MinusEqualsToken) {
+        return '-';
+    }
+    else if (kind === ts.SyntaxKind.AsteriskEqualsToken) {
+        return '*';
+    }
+    else if (kind === ts.SyntaxKind.SlashEqualsToken) {
+        return '/';
+    }
+    else if (kind === ts.SyntaxKind.PercentEqualsToken) {
+        return '%';
+    }
+    else if (kind === ts.SyntaxKind.AsteriskAsteriskEqualsToken) {
+        return '**';
+    }
+    else if (kind === ts.SyntaxKind.AmpersandEqualsToken) {
+        return '&';
+    }
+    else if (kind === ts.SyntaxKind.BarEqualsToken) {
+        return '|';
+    }
+    else if (kind === ts.SyntaxKind.CaretEqualsToken) {
+        return '^';
+    }
+    else if (kind === ts.SyntaxKind.LessThanLessThanEqualsToken) {
+        return '<<';
+    }
+    else if (kind === ts.SyntaxKind.GreaterThanGreaterThanEqualsToken) {
+        return '>>';
+    }
+    else if (kind === ts.SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken) {
+        return '>>>';
+    }
+    else if (kind === ts.SyntaxKind.AmpersandAmpersandEqualsToken) {
+        return '&&';
+    }
+    else if (kind === ts.SyntaxKind.BarBarEqualsToken) {
+        return '||';
+    }
+    else if (kind === ts.SyntaxKind.QuestionQuestionEqualsToken) {
+        return '??';
+    }
+    else {
+        return '+';
+    }
+}
+
+function isInComputedRange(ranges: Range[], start: number, end: number): boolean {
+    for (let i = 0, n = ranges.length; i < n; i++) {
+        let r = ranges[i];
+
+        if (start >= r.start && end <= r.end) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+function isInDeclarationInit(node: ts.Node): boolean {
+    let parent = node.parent;
+
+    if (ts.isVariableDeclaration(parent) && parent.initializer === node) {
+        return true;
+    }
+
+    return false;
+}
+
+function isInScope(reference: ts.Node, binding: ScopeBinding): boolean {
+    let current: ts.Node | undefined = reference;
+
+    while (current) {
+        if (current === binding.scope) {
+            return true;
+        }
+
+        current = current.parent;
+    }
+
+    return false;
+}
+
+function isReactiveReassignment(node: ts.Node): boolean {
+    let parent = node.parent;
+
+    if (
+        ts.isBinaryExpression(parent) &&
+        parent.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
+        parent.right === node &&
+        ts.isCallExpression(node) &&
+        ts.isIdentifier((node as ts.CallExpression).expression) &&
+        ((node as ts.CallExpression).expression as ts.Identifier).text === 'reactive'
+    ) {
+        return true;
+    }
+
+    return false;
+}
+
+function isWriteContext(node: ts.Identifier): 'simple' | 'compound' | 'increment' | false {
+    let parent = node.parent;
+
+    if (ts.isBinaryExpression(parent) && parent.left === node) {
+        let op = parent.operatorToken.kind;
+
+        if (op === ts.SyntaxKind.EqualsToken) {
+            return 'simple';
+        }
+
+        if (op >= ts.SyntaxKind.PlusEqualsToken && op <= ts.SyntaxKind.CaretEqualsToken) {
+            return 'compound';
+        }
+
+        if (
+            op === ts.SyntaxKind.AmpersandAmpersandEqualsToken ||
+            op === ts.SyntaxKind.BarBarEqualsToken ||
+            op === ts.SyntaxKind.QuestionQuestionEqualsToken
+        ) {
+            return 'compound';
+        }
+    }
+
+    if (ts.isPostfixUnaryExpression(parent) || ts.isPrefixUnaryExpression(parent)) {
+        let op = parent.operator;
+
+        if (op === ts.SyntaxKind.PlusPlusToken || op === ts.SyntaxKind.MinusMinusToken) {
+            return 'increment';
+        }
+    }
+
+    return false;
+}
+
+function visit(ctx: TransformContext, node: ts.Node): void {
+    if (
+        ts.isImportDeclaration(node) &&
+        ts.isStringLiteral(node.moduleSpecifier) &&
+        node.moduleSpecifier.text.includes('@esportsplus/reactivity')
+    ) {
+        let clause = node.importClause;
+
+        if (clause?.namedBindings && ts.isNamedImports(clause.namedBindings)) {
+            for (let i = 0, n = clause.namedBindings.elements.length; i < n; i++) {
+                if (clause.namedBindings.elements[i].name.text === 'reactive') {
+                    ctx.hasReactiveImport = true;
+                    break;
+                }
+            }
+        }
+    }
+
+    if (
+        ctx.hasReactiveImport &&
+        ts.isCallExpression(node) &&
+        ts.isIdentifier(node.expression) &&
+        node.expression.text === 'reactive' &&
+        node.arguments.length > 0
+    ) {
+        let arg = node.arguments[0],
+            classification = classifyReactiveArg(arg);
+
+        if (classification) {
+            let varName: string | null = null;
+
+            if (ts.isVariableDeclaration(node.parent) && ts.isIdentifier(node.parent.name)) {
+                varName = node.parent.name.text;
+            }
+            else if (
+                ts.isBinaryExpression(node.parent) &&
+                node.parent.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
+                ts.isIdentifier(node.parent.left)
+            ) {
+                varName = node.parent.left.text;
+            }
+
+            if (varName) {
+                let scope = findEnclosingScope(node);
+
+                ctx.scopedBindings.push({ name: varName, scope, type: classification });
+                ctx.bindings.set(varName, classification);
+            }
+
+            if (classification === 'computed') {
+                ctx.computedArgRanges.push({
+                    end: arg.end,
+                    start: arg.getStart(ctx.sourceFile)
+                });
+
+                let argCtx: ArgContext = {
+                    argStart: arg.getStart(ctx.sourceFile),
+                    innerReplacements: [],
+                    neededImports: ctx.neededImports,
+                    scopedBindings: ctx.scopedBindings,
+                    sourceFile: ctx.sourceFile
+                };
+
+                visitArg(argCtx, arg);
+
+                let argText = applyReplacements(arg.getText(ctx.sourceFile), argCtx.innerReplacements);
+
+                ctx.replacements.push({
+                    end: node.end,
+                    newText: `computed(${argText})`,
+                    start: node.pos
+                });
+
+                ctx.neededImports.add('computed');
+            }
+            else {
+                let argText = arg.getText(ctx.sourceFile);
+
+                ctx.replacements.push({
+                    end: node.end,
+                    newText: `signal(${argText})`,
+                    start: node.pos
+                });
+
+                ctx.neededImports.add('signal');
+            }
+        }
+    }
+
+    if (ts.isIdentifier(node) && !isInDeclarationInit(node.parent)) {
+        if (ts.isPropertyAccessExpression(node.parent) && node.parent.name === node) {
+            ts.forEachChild(node, n => visit(ctx, n));
+            return;
+        }
+
+        let nodeStart = node.getStart(ctx.sourceFile);
+
+        if (isInComputedRange(ctx.computedArgRanges, nodeStart, node.end)) {
+            ts.forEachChild(node, n => visit(ctx, n));
+            return;
+        }
+
+        let binding = findBinding(ctx.scopedBindings, node.text, node),
+            name = node.text;
+
+        if (binding) {
+            if (
+                !isReactiveReassignment(node.parent) &&
+                !(ts.isTypeOfExpression(node.parent) && node.parent.expression === node)
+            ) {
+                let writeCtx = isWriteContext(node);
+
+                if (writeCtx) {
+                    if (binding.type !== 'computed') {
+                        ctx.neededImports.add('set');
+
+                        let parent = node.parent;
+
+                        if (writeCtx === 'simple' && ts.isBinaryExpression(parent)) {
+                            let valueText = parent.right.getText(ctx.sourceFile);
+
+                            ctx.replacements.push({
+                                end: parent.end,
+                                newText: `set(${name}, ${valueText})`,
+                                start: parent.pos
+                            });
+                        }
+                        else if (writeCtx === 'compound' && ts.isBinaryExpression(parent)) {
+                            let op = getCompoundOperator(parent.operatorToken.kind),
+                                valueText = parent.right.getText(ctx.sourceFile);
+
+                            ctx.replacements.push({
+                                end: parent.end,
+                                newText: `set(${name}, ${name}.value ${op} ${valueText})`,
+                                start: parent.pos
+                            });
+                        }
+                        else if (writeCtx === 'increment') {
+                            let isPrefix = ts.isPrefixUnaryExpression(parent),
+                                op = (parent as ts.PrefixUnaryExpression | ts.PostfixUnaryExpression).operator,
+                                delta = op === ts.SyntaxKind.PlusPlusToken ? '+ 1' : '- 1';
+
+                            if (ts.isExpressionStatement(parent.parent)) {
+                                ctx.replacements.push({
+                                    end: parent.end,
+                                    newText: `set(${name}, ${name}.value ${delta})`,
+                                    start: parent.pos
+                                });
+                            }
+                            else if (isPrefix) {
+                                ctx.replacements.push({
+                                    end: parent.end,
+                                    newText: `(set(${name}, ${name}.value ${delta}), ${name}.value)`,
+                                    start: parent.pos
+                                });
+                            }
+                            else {
+                                let tmp = uid('tmp');
+
+                                ctx.replacements.push({
+                                    end: parent.end,
+                                    newText: `((${tmp}) => (set(${name}, ${tmp} ${delta}), ${tmp}))(${name}.value)`,
+                                    start: parent.pos
+                                });
+                            }
+                        }
+                    }
+                }
+                else {
+                    ctx.neededImports.add('read');
+
+                    ctx.replacements.push({
+                        end: node.end,
+                        newText: `read(${name})`,
+                        start: node.pos
+                    });
+                }
+            }
+        }
+    }
+
+    ts.forEachChild(node, n => visit(ctx, n));
+}
+
+function visitArg(ctx: ArgContext, node: ts.Node): void {
+    if (ts.isIdentifier(node)) {
+        if (ts.isPropertyAccessExpression(node.parent) && node.parent.name === node) {
+            ts.forEachChild(node, n => visitArg(ctx, n));
+            return;
+        }
+
+        if (ts.isCallExpression(node.parent) && node.parent.expression === node) {
+            ts.forEachChild(node, n => visitArg(ctx, n));
+            return;
+        }
+
+        let binding = findBinding(ctx.scopedBindings, node.text, node);
+
+        if (binding) {
+            ctx.neededImports.add('read');
+
+            ctx.innerReplacements.push({
+                end: node.end - ctx.argStart,
+                newText: `read(${node.text})`,
+                start: node.getStart(ctx.sourceFile) - ctx.argStart
+            });
+        }
+    }
+
+    ts.forEachChild(node, n => visitArg(ctx, n));
+}
+
+
+const transformReactivePrimitives = (
+    sourceFile: ts.SourceFile,
+    bindings: Bindings
+): string => {
+    let code = sourceFile.getFullText(),
+        ctx: TransformContext = {
+            bindings,
+            computedArgRanges: [],
+            hasReactiveImport: false,
+            neededImports: new Set<string>(),
+            replacements: [],
+            scopedBindings: [],
+            sourceFile
+        };
+
+    visit(ctx, sourceFile);
+
+    if (ctx.replacements.length === 0) {
+        return code;
+    }
+
+    let result = applyReplacements(code, ctx.replacements);
+
+    if (ctx.neededImports.size > 0) {
+        result = addMissingImports(result, ctx.neededImports);
+    }
+
+    return result;
+};
+
+
+export { transformReactivePrimitives };

package/src/transformer/transforms/utilities.ts

@@ -0,0 +1,119 @@
+import { applyReplacements, type Replacement } from '@esportsplus/typescript/transformer';
+import ts from 'typescript';
+
+
+type ExtraImport = {
+    module: string;
+    specifier: string;
+};
+
+
+function findReactivityImport(sourceFile: ts.SourceFile): ts.ImportDeclaration | null {
+    for (let i = 0, n = sourceFile.statements.length; i < n; i++) {
+        let stmt = sourceFile.statements[i];
+
+        if (
+            ts.isImportDeclaration(stmt) &&
+            ts.isStringLiteral(stmt.moduleSpecifier) &&
+            stmt.moduleSpecifier.text === '@esportsplus/reactivity' &&
+            stmt.importClause?.namedBindings &&
+            ts.isNamedImports(stmt.importClause.namedBindings)
+        ) {
+            return stmt;
+        }
+    }
+
+    return null;
+}
+
+function getExistingSpecifiers(namedImports: ts.NamedImports): Set<string> {
+    let existing = new Set<string>();
+
+    for (let i = 0, n = namedImports.elements.length; i < n; i++) {
+        let el = namedImports.elements[i],
+            name = el.propertyName?.text ?? el.name.text;
+
+        existing.add(name);
+    }
+
+    return existing;
+}
+
+function getFirstImportPos(sourceFile: ts.SourceFile): number {
+    for (let i = 0, n = sourceFile.statements.length; i < n; i++) {
+        if (ts.isImportDeclaration(sourceFile.statements[i])) {
+            return sourceFile.statements[i].getStart(sourceFile);
+        }
+    }
+
+    return 0;
+}
+
+
+const addMissingImports = (code: string, needed: Set<string>, extraImports?: ExtraImport[]): string => {
+    let sourceFile = ts.createSourceFile('temp.ts', code, ts.ScriptTarget.Latest, true),
+        reactivityImport = findReactivityImport(sourceFile);
+
+    if (!reactivityImport) {
+        return code;
+    }
+
+    let extraSpecifiers = new Set<string>(),
+        namedImports = reactivityImport.importClause!.namedBindings as ts.NamedImports,
+        existing = getExistingSpecifiers(namedImports),
+        toAdd: string[] = [];
+
+    if (extraImports) {
+        for (let i = 0, n = extraImports.length; i < n; i++) {
+            extraSpecifiers.add(extraImports[i].specifier);
+        }
+    }
+
+    for (let imp of needed) {
+        if (!extraSpecifiers.has(imp) && !existing.has(imp)) {
+            toAdd.push(imp);
+        }
+    }
+
+    if (toAdd.length > 0) {
+        let combined: string[] = [];
+
+        for (let item of existing) {
+            combined.push(item);
+        }
+
+        for (let i = 0, n = toAdd.length; i < n; i++) {
+            combined.push(toAdd[i]);
+        }
+
+        combined.sort();
+
+        let newSpecifiers = `{ ${combined.join(', ')} }`,
+            bindingsStart = namedImports.getStart(sourceFile),
+            bindingsEnd = namedImports.getEnd();
+
+        code = code.substring(0, bindingsStart) + newSpecifiers + code.substring(bindingsEnd);
+    }
+
+    if (extraImports) {
+        let insertPos = getFirstImportPos(
+            ts.createSourceFile('temp.ts', code, ts.ScriptTarget.Latest, true)
+        );
+
+        for (let i = 0, n = extraImports.length; i < n; i++) {
+            let extra = extraImports[i];
+
+            if (needed.has(extra.specifier) && !code.includes(extra.module)) {
+                code = code.substring(0, insertPos) +
+                       `import { ${extra.specifier} } from '${extra.module}';\n` +
+                       code.substring(insertPos);
+            }
+        }
+    }
+
+    return code;
+};
+
+
+export { addMissingImports, applyReplacements };
+export type { ExtraImport, Replacement };

package/build/transformer/core/detector.js

@@ -1,6 +0,0 @@
-import { mightNeedTransform as checkTransform } from '@esportsplus/typescript/transformer';
-let regex = /import\s*\{[^}]*\breactive\b[^}]*\}\s*from\s*['"]@esportsplus\/reactivity/;
-const mightNeedTransform = (code) => {
-    return checkTransform(code, { regex });
-};
-export { mightNeedTransform };

package/build/transformer/core/transforms/auto-dispose.js

@@ -1,116 +0,0 @@
-import { uid } from '@esportsplus/typescript/transformer';
-import ts from 'typescript';
-import { applyReplacements } from './utilities.js';
-const TRAILING_SEMICOLON = /;$/;
-function visitFunctionBody(body, parentBody) {
-    let disposables = [], effectsToCapture = [], returnStatement = null;
-    function visit(n) {
-        if (ts.isVariableDeclaration(n) &&
-            ts.isIdentifier(n.name) &&
-            n.initializer &&
-            ts.isCallExpression(n.initializer) &&
-            ts.isIdentifier(n.initializer.expression) &&
-            n.initializer.expression.text === 'reactive') {
-            disposables.push({ name: n.name.text, type: 'reactive' });
-        }
-        if (ts.isCallExpression(n) &&
-            ts.isIdentifier(n.expression) &&
-            n.expression.text === 'effect') {
-            if (ts.isVariableDeclaration(n.parent) && ts.isIdentifier(n.parent.name)) {
-                disposables.push({ name: n.parent.name.text, type: 'effect' });
-            }
-            else if (ts.isExpressionStatement(n.parent)) {
-                let name = uid('effect');
-                effectsToCapture.push({
-                    end: n.parent.end,
-                    name,
-                    start: n.parent.pos
-                });
-                disposables.push({ name, type: 'effect' });
-            }
-        }
-        if (ts.isReturnStatement(n) &&
-            n.expression &&
-            (ts.isArrowFunction(n.expression) || ts.isFunctionExpression(n.expression)) &&
-            n.parent === parentBody) {
-            returnStatement = n;
-        }
-        ts.forEachChild(n, visit);
-    }
-    visit(body);
-    return { disposables, effectsToCapture, returnStatement };
-}
-function processFunction(node, sourceFile, edits) {
-    if (!node.body || !ts.isBlock(node.body)) {
-        return;
-    }
-    let result = visitFunctionBody(node.body, node.body), disposables = result.disposables, effectsToCapture = result.effectsToCapture, returnStatement = result.returnStatement;
-    if (disposables.length === 0 || !returnStatement || !returnStatement.expression) {
-        return;
-    }
-    let cleanupFn = returnStatement.expression;
-    if (!cleanupFn.body) {
-        return;
-    }
-    let disposeStatements = [];
-    for (let i = disposables.length - 1; i >= 0; i--) {
-        let d = disposables[i];
-        if (d.type === 'reactive') {
-            disposeStatements.push(`${d.name}.dispose();`);
-        }
-        else {
-            disposeStatements.push(`${d.name}();`);
-        }
-    }
-    let disposeCode = disposeStatements.join('\n');
-    if (ts.isBlock(cleanupFn.body)) {
-        edits.push({
-            cleanupBodyEnd: cleanupFn.body.statements[0]?.pos ?? cleanupFn.body.end - 1,
-            cleanupBodyStart: cleanupFn.body.pos + 1,
-            disposeCode,
-            effectsToCapture
-        });
-    }
-    else {
-        edits.push({
-            cleanupBodyEnd: cleanupFn.body.end,
-            cleanupBodyStart: cleanupFn.body.pos,
-            disposeCode: `{ ${disposeCode}\n return ${cleanupFn.body.getText(sourceFile)}; }`,
-            effectsToCapture
-        });
-    }
-}
-const injectAutoDispose = (sourceFile) => {
-    let code = sourceFile.getFullText(), edits = [];
-    function visit(node) {
-        if (ts.isFunctionDeclaration(node) ||
-            ts.isFunctionExpression(node) ||
-            ts.isArrowFunction(node)) {
-            processFunction(node, sourceFile, edits);
-        }
-        ts.forEachChild(node, visit);
-    }
-    visit(sourceFile);
-    if (edits.length === 0) {
-        return code;
-    }
-    let replacements = [];
-    for (let i = 0, n = edits.length; i < n; i++) {
-        let edit = edits[i], effects = edit.effectsToCapture;
-        for (let j = 0, m = effects.length; j < m; j++) {
-            let effect = effects[j], original = code.substring(effect.start, effect.end).trim();
-            replacements.push({
-                end: effect.end,
-                newText: `const ${effect.name} = ${original.replace(TRAILING_SEMICOLON, '')}`,
-                start: effect.start
-            });
-        }
-        replacements.push({
-            end: edit.cleanupBodyEnd,
-            newText: `\n${edit.disposeCode}`,
-            start: edit.cleanupBodyStart
-        });
-    }
-    return applyReplacements(code, replacements);
-};
-export { injectAutoDispose };