modality-ts 0.0.3 → 0.0.5

package/dist/extraction/index.js

@@ -1,4 +1,5 @@
 import * as ts from "typescript";
+import { effectReads, effectWrites } from "modality-ts/kernel";
 export * from "./pipeline/index.js";
 export * from "./spi/index.js";
 function setterBindingFromDecl(decl) {
@@ -48,6 +49,8 @@ export function extractUseStateSkeleton(sourceText, options = {}) {
     const warnings = [];
     const route = options.route ?? "/";
     const effectApis = new Set(options.effectApis ?? []);
+    const sourcePlugins = options.sourcePlugins ?? [];
+    const routerPlugin = options.routerPlugin;
     const setters = new Map();
     const globalTaints = new Set();
     const components = componentDeclarations(source);
@@ -137,7 +140,7 @@ export function extractUseStateSkeleton(sourceText, options = {}) {
             }
         }
         if (ts.isJsxAttribute(node) && ts.isIdentifier(node.name) && node.initializer && isForwardablePropName(node.name.text) && !isIntrinsicJsxAttribute(node)) {
-            const extracted = transitionsFromComponentPropAttribute(source, fileName, node, setters, handlers, components, nextComponent ?? "Anonymous", effectApis, options.asyncOutcomes ?? {}, warnings);
+            const extracted = transitionsFromComponentPropAttribute(source, fileName, node, setters, handlers, components, nextComponent ?? "Anonymous", effectApis, options.asyncOutcomes ?? {}, sourcePlugins, routerPlugin, warnings);
             transitions.push(...extracted);
             if (extracted.length === 0) {
                 warnings.push({ message: `Unextractable handler ${nextComponent ?? "Anonymous"}.${node.name.text}`, ...lineAndColumn(source, node) });
@@ -167,7 +170,7 @@ export function extractUseStateSkeleton(sourceText, options = {}) {
                 renderGuardFor(node, setters, warnings, source, nextComponent ?? "Anonymous", guardLocals),
                 disabledGuardFor(node, setters, warnings, source, nextComponent ?? "Anonymous", guardLocals)
             ]);
-            const extracted = transitionsFromJsxAttribute(source, fileName, node, setters, handlers, nextComponent ?? "Anonymous", effectApis, options.asyncOutcomes ?? {}, guard, warnings);
+            const extracted = transitionsFromJsxAttribute(source, fileName, node, setters, handlers, nextComponent ?? "Anonymous", effectApis, options.asyncOutcomes ?? {}, sourcePlugins, routerPlugin, guard, warnings);
             transitions.push(...extracted);
             if (extracted.length === 0 && !forwardsComponentProp(node, handlers, components.get(nextComponent ?? "")) && !handlerSchedulesModeledTimer(node, handlers, setters)) {
                 warnings.push({ message: `Unextractable handler ${nextComponent ?? "Anonymous"}.${node.name.text}`, ...lineAndColumn(source, node) });
@@ -501,7 +504,7 @@ function handlerSchedulesModeledTimer(attribute, handlers, setters) {
     visit(handler.body);
     return found;
 }
-function transitionsFromJsxAttribute(source, fileName, node, setters, handlers, component, effectApis, asyncOutcomes, disabledGuard, warnings) {
+function transitionsFromJsxAttribute(source, fileName, node, setters, handlers, component, effectApis, asyncOutcomes, sourcePlugins, routerPlugin, disabledGuard, warnings) {
     if (!node.initializer)
         return [];
     const expression = ts.isJsxExpression(node.initializer) ? node.initializer.expression : undefined;
@@ -512,9 +515,9 @@ function transitionsFromJsxAttribute(source, fileName, node, setters, handlers,
         return [];
     const attr = node.name.text;
     const locator = locatorForEventAttribute(node);
-    return tagStableIdKey(transitionsFromResolvedHandler(source, fileName, node, attr, handler, setters, handlers, component, effectApis, asyncOutcomes, disabledGuard, locator, warnings), handler);
+    return tagStableIdKey(transitionsFromResolvedHandler(source, fileName, node, attr, handler, setters, handlers, component, effectApis, asyncOutcomes, sourcePlugins, routerPlugin, disabledGuard, locator, warnings), handler);
 }
-function transitionsFromComponentPropAttribute(source, fileName, node, setters, handlers, components, component, effectApis, asyncOutcomes, warnings) {
+function transitionsFromComponentPropAttribute(source, fileName, node, setters, handlers, components, component, effectApis, asyncOutcomes, sourcePlugins, routerPlugin, warnings) {
     if (!node.initializer || !ts.isIdentifier(node.name))
         return [];
     const tag = jsxTagName(node);
@@ -535,7 +538,7 @@ function transitionsFromComponentPropAttribute(source, fileName, node, setters,
         renderGuardFor(node, setters, warnings, source, component, guardLocals),
         disabledGuardFor(node, setters, warnings, source, component, guardLocals)
     ]);
-    return tagStableIdKey(transitionsFromResolvedHandler(source, fileName, node, trigger.attr, handler, setters, handlers, component, effectApis, asyncOutcomes, combineParsedGuards([trigger.guard, callerGuard]), trigger.locator, warnings), handler);
+    return tagStableIdKey(transitionsFromResolvedHandler(source, fileName, node, trigger.attr, handler, setters, handlers, component, effectApis, asyncOutcomes, sourcePlugins, routerPlugin, combineParsedGuards([trigger.guard, callerGuard]), trigger.locator, warnings), handler);
 }
 function transitionsFromBoundedListAttribute(source, fileName, node, setters, handlers, component, listInfo) {
     if (!node.initializer || !ts.isIdentifier(node.name))
@@ -595,7 +598,7 @@ function normalizedAstKey(node) {
         .replace(/\/\/.*$/gm, "")
         .replace(/\s+/g, "");
 }
-function transitionsFromResolvedHandler(source, fileName, node, attr, handler, setters, handlers, component, effectApis, asyncOutcomes, disabledGuard, locator, warnings) {
+function transitionsFromResolvedHandler(source, fileName, node, attr, handler, setters, handlers, component, effectApis, asyncOutcomes, sourcePlugins, routerPlugin, disabledGuard, locator, warnings) {
     const asyncTransitions = transitionsFromAsyncHandler(source, fileName, attr, handler, setters, component, effectApis, asyncOutcomes, locator, warnings);
     if (asyncTransitions.length > 0)
         return applyParsedGuard(asyncTransitions, disabledGuard);
@@ -614,15 +617,18 @@ function transitionsFromResolvedHandler(source, fileName, node, attr, handler, s
     const inlined = inlinedHelperCall(summary.call, handlers, setters);
     const inlinedCall = inlined?.call ?? summary.call;
     const locals = inlined?.locals ?? summary.locals;
-    const navigation = navigationTransition(source, fileName, node, attr, component, inlinedCall, locator);
+    const navigation = navigationTransition(source, fileName, node, attr, component, inlinedCall, locator, routerPlugin);
     if (navigation)
         return applyParsedGuard([navigation], disabledGuard);
+    const pluginWrite = pluginWriteTransition(source, fileName, node, attr, component, inlinedCall, setters, locals, sourcePlugins, locator);
+    if (pluginWrite)
+        return applyParsedGuard([pluginWrite], disabledGuard);
     const swrMutate = swrMutateTransition(source, fileName, node, attr, component, inlinedCall, locator);
     if (swrMutate)
         return applyParsedGuard([swrMutate], disabledGuard);
     const setterCall = setterCallFrom(inlinedCall, setters);
     if (!setterCall) {
-        const escaped = escapedSetters(inlinedCall, setters);
+        const escaped = escapedSetters(inlinedCall, setters, locals);
         if (escaped.length === 0)
             return [];
         return applyParsedGuard(escapedSetterTransitions(source, fileName, node, attr, component, escaped, locator), disabledGuard);
@@ -818,6 +824,10 @@ function valueExpr(expression, setters, locals) {
     }
     if (ts.isParenthesizedExpression(expression))
         return valueExpr(expression.expression, setters, locals);
+    if (ts.isBinaryExpression(expression) &&
+        (expression.operatorToken.kind === ts.SyntaxKind.AmpersandAmpersandToken || expression.operatorToken.kind === ts.SyntaxKind.BarBarToken)) {
+        return booleanExpr(expression, setters, locals);
+    }
     if (ts.isBinaryExpression(expression) && expression.operatorToken.kind === ts.SyntaxKind.QuestionQuestionToken) {
         return nullishOptionalReadExpr(expression, setters, locals);
     }
@@ -1076,6 +1086,66 @@ function callSummaryFromHandler(handler, setters, initialLocals = new Map()) {
     }
     return undefined;
 }
+function pluginWriteTransition(source, fileName, node, attr, component, call, setters, locals, sourcePlugins, locator) {
+    const callee = callName(call.expression);
+    if (!callee)
+        return undefined;
+    const ctx = {
+        read: (name, path) => {
+            const local = locals.get(name);
+            if (local?.expr.kind === "read") {
+                return { kind: "read", var: local.expr.var, path: [...(local.expr.path ?? []), ...(path ?? [])] };
+            }
+            const varId = stateVarForName(name, setters) ?? name;
+            return { kind: "read", var: varId, ...(path && path.length > 0 ? { path } : {}) };
+        },
+        locator
+    };
+    const callSite = {
+        callee,
+        arguments: call.arguments.map(callArgumentValue),
+        source: { file: fileName, ...lineAndColumn(source, call) }
+    };
+    for (const plugin of sourcePlugins) {
+        const summary = plugin.summarizeWrite?.(callSite, ctx);
+        if (!summary || summary === "unsupported")
+            continue;
+        const reads = [...effectReads(summary)].sort();
+        const writes = [...effectWrites(summary)].sort();
+        return {
+            id: `${component}.${attr}.${safeId(plugin.id)}.${safeId(callee)}`,
+            cls: "user",
+            label: labelForEvent(attr, locator),
+            source: [{ file: fileName, ...lineAndColumn(source, node) }],
+            guard: { kind: "lit", value: true },
+            effect: summary,
+            reads,
+            writes,
+            confidence: "exact"
+        };
+    }
+    return undefined;
+}
+function callArgumentValue(argument) {
+    const literal = literalValue(argument);
+    if (literal !== undefined)
+        return literal;
+    if (ts.isIdentifier(argument))
+        return argument.text;
+    if (ts.isObjectLiteralExpression(argument)) {
+        const fields = {};
+        for (const property of argument.properties) {
+            if (!ts.isPropertyAssignment(property))
+                return argument.getText();
+            const name = propertyName(property.name);
+            if (!name)
+                return argument.getText();
+            fields[name] = callArgumentValue(property.initializer);
+        }
+        return fields;
+    }
+    return argument.getText();
+}
 function swrMutateTransition(source, fileName, node, attr, component, call, locator) {
     if (!ts.isIdentifier(call.expression) || call.expression.text !== "mutate")
         return undefined;
@@ -1099,7 +1169,8 @@ function bindConstStatement(statement, setters, locals, partialBoolean = false)
     for (const declaration of statement.declarationList.declarations) {
         if (!ts.isIdentifier(declaration.name) || !declaration.initializer)
             return false;
-        const binding = valueExpr(declaration.initializer, setters, locals) ??
+        const setterAlias = ts.isIdentifier(declaration.initializer) ? setters.get(declaration.initializer.text) ?? locals.get(declaration.initializer.text)?.setter : undefined;
+        const binding = setterAlias ? { expr: { kind: "lit", value: null }, reads: [], setter: setterAlias } : valueExpr(declaration.initializer, setters, locals) ??
             (partialBoolean ? parseConjunctiveGuardExpression(declaration.initializer, setters, locals) : booleanExpr(declaration.initializer, setters, locals));
         if (!binding)
             return false;
@@ -1113,8 +1184,8 @@ function inlinedHelperCall(call, handlers, setters) {
     const helper = handlers.get(call.expression.text);
     return helper ? callSummaryFromHandler(helper, setters) : undefined;
 }
-function navigationTransition(source, fileName, node, attr, component, call, locator) {
-    const navigation = navigationCall(call);
+function navigationTransition(source, fileName, node, attr, component, call, locator, routerPlugin) {
+    const navigation = navigationCall(call, routerPlugin);
     if (!navigation)
         return undefined;
     const routeId = navigation.to ? safeId(navigation.to) : "back";
@@ -1138,10 +1209,13 @@ function navigationTransition(source, fileName, node, attr, component, call, loc
         confidence: "exact"
     };
 }
-function navigationCall(call) {
+function navigationCall(call, routerPlugin) {
     const name = callName(call.expression);
     if (!name)
         return undefined;
+    const pluginNavigation = routerPlugin?.navigationCall(name, call.arguments.map(callArgumentValue));
+    if (pluginNavigation && pluginNavigation !== "unsupported")
+        return pluginNavigation;
     if (name === "navigate" && call.arguments.length === 1) {
         const to = literalValue(call.arguments[0]);
         return typeof to === "string" ? { mode: "push", to } : undefined;
@@ -1157,10 +1231,10 @@ function navigationCall(call) {
     }
     return undefined;
 }
-function escapedSetters(call, setters) {
+function escapedSetters(call, setters, locals = new Map()) {
     return call.arguments
         .filter(ts.isIdentifier)
-        .map((arg) => setters.get(arg.text))
+        .map((arg) => setters.get(arg.text) ?? locals.get(arg.text)?.setter)
         .filter((setter) => Boolean(setter));
 }
 function escapedSetterTransitions(source, fileName, node, attr, component, setters, locator) {
@@ -1990,6 +2064,7 @@ function renderGuardFor(eventAttribute, setters, warnings, source, component, lo
     const element = jsxElementForAttribute(eventAttribute);
     if (!element)
         return undefined;
+    const guards = [];
     let current = element;
     while (current.parent) {
         const parent = current.parent;
@@ -2001,7 +2076,9 @@ function renderGuardFor(eventAttribute, setters, warnings, source, component, lo
                 warnings.push({ message: `Unsupported render guard ${component}.${eventAttribute.name.getText(source)}`, ...lineAndColumn(source, parent.left) });
                 return undefined;
             }
-            return parsed;
+            guards.push(parsed);
+            current = parent;
+            continue;
         }
         if (ts.isConditionalExpression(parent) && parent.whenTrue === current) {
             const parsed = parseConjunctiveGuardExpression(parent.condition, setters, locals);
@@ -2009,7 +2086,9 @@ function renderGuardFor(eventAttribute, setters, warnings, source, component, lo
                 warnings.push({ message: `Unsupported render guard ${component}.${eventAttribute.name.getText(source)}`, ...lineAndColumn(source, parent.condition) });
                 return undefined;
             }
-            return parsed;
+            guards.push(parsed);
+            current = parent;
+            continue;
         }
         if (ts.isConditionalExpression(parent) && parent.whenFalse === current) {
             const parsed = parseConjunctiveGuardExpression(parent.condition, setters, locals);
@@ -2017,15 +2096,17 @@ function renderGuardFor(eventAttribute, setters, warnings, source, component, lo
                 warnings.push({ message: `Unsupported render guard ${component}.${eventAttribute.name.getText(source)}`, ...lineAndColumn(source, parent.condition) });
                 return undefined;
             }
-            return { expr: { kind: "not", args: [parsed.expr] }, reads: parsed.reads };
+            guards.push({ expr: { kind: "not", args: [parsed.expr] }, reads: parsed.reads });
+            current = parent;
+            continue;
         }
-        if (ts.isParenthesizedExpression(parent) || ts.isJsxExpression(parent)) {
+        if (ts.isParenthesizedExpression(parent) || ts.isJsxExpression(parent) || ts.isJsxElement(parent) || ts.isJsxFragment(parent)) {
             current = parent;
             continue;
         }
-        return undefined;
+        return combineParsedGuards(guards);
     }
-    return undefined;
+    return combineParsedGuards(guards);
 }
 function jsxElementForAttribute(attribute) {
     const attrs = attribute.parent;