@defold-typescript/transpiler 0.8.3 → 0.9.0

package/README.md

@@ -13,7 +13,7 @@ Most users do not depend on this directly — the
 drives it for you.
 
 See the repository [README](https://github.com/defold-typescript/toolchain#readme)
-and [`docs/guide/`](https://github.com/defold-typescript/toolchain/tree/main/docs/guide)
+and [`packages/docs/guide/`](https://github.com/defold-typescript/toolchain/tree/main/packages/docs/guide)
 for the full workflow.
 
 ## License

package/dist/index.js

@@ -355,7 +355,7 @@ function findMainEntryFactoryImports(fileName, source) {
   return factories;
 }
 // src/program-diagnostics.ts
-import * as ts6 from "typescript";
+import * as ts7 from "typescript";
 import * as tstl from "typescript-to-lua";
 
 // src/message-guard-lowering.ts
@@ -466,10 +466,50 @@ var timersLoweringPlugin = {
   }
 };
 
+// src/window-event-guard-lowering.ts
+import * as ts6 from "typescript";
+import {
+  createBinaryExpression as createBinaryExpression4,
+  SyntaxKind as SyntaxKind9
+} from "typescript-to-lua";
+var GUARD_MODULE2 = "@defold-typescript/types";
+var GUARD_NAME2 = "isWindowEvent";
+function resolvesToGuardExport2(callee, checker) {
+  let symbol = checker.getSymbolAtLocation(callee);
+  if (symbol === undefined) {
+    return false;
+  }
+  if (symbol.flags & ts6.SymbolFlags.Alias) {
+    symbol = checker.getAliasedSymbol(symbol);
+  }
+  if (symbol.getName() !== GUARD_NAME2) {
+    return false;
+  }
+  const declaration = symbol.valueDeclaration ?? symbol.declarations?.[0];
+  if (declaration === undefined) {
+    return false;
+  }
+  return declaration.getSourceFile().fileName.includes(GUARD_MODULE2);
+}
+var windowEventGuardLoweringPlugin = {
+  visitors: {
+    [ts6.SyntaxKind.CallExpression]: (node, context) => {
+      const [eventArg, , expectedArg] = node.arguments;
+      if (node.arguments.length === 3 && eventArg !== undefined && expectedArg !== undefined && resolvesToGuardExport2(node.expression, context.checker)) {
+        const event = context.transformExpression(eventArg);
+        const expected = context.transformExpression(expectedArg);
+        return createBinaryExpression4(event, expected, SyntaxKind9.EqualityOperator, node);
+      }
+      return context.superTransformExpression(node);
+    }
+  }
+};
+
 // src/program-diagnostics.ts
 var LUA_PLUGINS = [
   lifecycleErasurePlugin,
   messageGuardLoweringPlugin,
+  windowEventGuardLoweringPlugin,
   messageDispatchLoweringPlugin,
   timersLoweringPlugin
 ];
@@ -478,7 +518,7 @@ function isAmbient(fileName) {
   return /[\\/]node_modules[\\/]/.test(fileName) || /(^|[\\/])lib\.[^\\/]*\.d\.ts$/.test(fileName);
 }
 function getProgramDiagnostics(program, sourceFile) {
-  const { diagnostics } = tstl.getProgramTranspileResult(ts6.sys, noopWriteFile, {
+  const { diagnostics } = tstl.getProgramTranspileResult(ts7.sys, noopWriteFile, {
     program,
     plugins: LUA_PLUGINS,
     ...sourceFile ? { sourceFiles: [sourceFile] } : {}
@@ -489,7 +529,7 @@ function getProgramDiagnostics(program, sourceFile) {
 import { readFileSync as readFileSync2 } from "node:fs";
 import { createRequire as createRequire2 } from "node:module";
 import * as path2 from "node:path";
-import * as ts8 from "typescript";
+import * as ts9 from "typescript";
 import * as tstl3 from "typescript-to-lua";
 
 // src/transpile.ts
@@ -499,17 +539,17 @@ import * as path from "node:path";
 import * as tstl2 from "typescript-to-lua";
 
 // src/go-property-direct-call.ts
-import * as ts7 from "typescript";
+import * as ts8 from "typescript";
 var GO_PROPERTY_DIRECT_CALL_MESSAGE = "`go.property` called directly is deprecated; declare the property in `defineScript({ properties })` so it types onto `self` (the transpiler emits the registration for you).";
 function findDirectGoPropertyCalls(sourceFile) {
   const calls = [];
   const visit = (node) => {
-    if (ts7.isCallExpression(node) && ts7.isPropertyAccessExpression(node.expression) && node.expression.name.text === "property" && ts7.isIdentifier(node.expression.expression) && node.expression.expression.text === "go") {
+    if (ts8.isCallExpression(node) && ts8.isPropertyAccessExpression(node.expression) && node.expression.name.text === "property" && ts8.isIdentifier(node.expression.expression) && node.expression.expression.text === "go") {
       calls.push(node);
     }
-    ts7.forEachChild(node, visit);
+    ts8.forEachChild(node, visit);
   };
-  ts7.forEachChild(sourceFile, visit);
+  ts8.forEachChild(sourceFile, visit);
   return calls;
 }
 
@@ -557,6 +597,7 @@ function buildAmbientFiles() {
     "node_modules/@defold-typescript/types/src/go-overloads.d.ts": readAmbient("src/go-overloads.d.ts"),
     "node_modules/@defold-typescript/types/src/msg-overloads.d.ts": readAmbient("src/msg-overloads.d.ts"),
     "node_modules/@defold-typescript/types/src/message-guard.d.ts": readAmbient("src/message-guard.d.ts"),
+    "node_modules/@defold-typescript/types/src/window-event-guard.d.ts": readAmbient("src/window-event-guard.d.ts"),
     "node_modules/@defold-typescript/types/src/message-dispatch.d.ts": readAmbient("src/message-dispatch.d.ts"),
     "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
     "node_modules/@defold-typescript/types/src/timers.d.ts": readAmbient("src/timers.d.ts"),
@@ -653,6 +694,7 @@ function transpileProject(input) {
     luaPlugins: [
       { plugin: lifecycleErasurePlugin },
       { plugin: messageGuardLoweringPlugin },
+      { plugin: windowEventGuardLoweringPlugin },
       { plugin: messageDispatchLoweringPlugin },
       { plugin: timersLoweringPlugin }
     ]
@@ -679,6 +721,7 @@ var COMPILER_OPTIONS = {
   luaPlugins: [
     { plugin: lifecycleErasurePlugin },
     { plugin: messageGuardLoweringPlugin },
+    { plugin: windowEventGuardLoweringPlugin },
     { plugin: messageDispatchLoweringPlugin },
     { plugin: timersLoweringPlugin }
   ]
@@ -721,7 +764,7 @@ function createTranspileSession() {
       if (cached) {
         return cached;
       }
-      const created = ts8.createSourceFile(fileName, content, ts8.ScriptTarget.Latest, false);
+      const created = ts9.createSourceFile(fileName, content, ts9.ScriptTarget.Latest, false);
       sourceFileCache.set(normalized, created);
       return created;
     }
@@ -740,7 +783,7 @@ function createTranspileSession() {
         return cached;
       }
       const fileContent = readFileSync2(filePath, "utf8");
-      const created = ts8.createSourceFile(filePath, fileContent, ts8.ScriptTarget.Latest, false);
+      const created = ts9.createSourceFile(filePath, fileContent, ts9.ScriptTarget.Latest, false);
       libCache.set(fileName, created);
       return created;
     }
@@ -753,10 +796,10 @@ function createTranspileSession() {
     return AMBIENT_FILES[normalized];
   }
   const host = {
-    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts8.sys.fileExists(fileName),
+    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts9.sys.fileExists(fileName),
     getCanonicalFileName: (fileName) => fileName,
     getCurrentDirectory: () => "",
-    getDefaultLibFileName: ts8.getDefaultLibFileName,
+    getDefaultLibFileName: ts9.getDefaultLibFileName,
     readFile: () => "",
     getNewLine: () => `
 `,
@@ -777,15 +820,15 @@ function createTranspileSession() {
     }
     const userKeys = new Set(userFiles.keys());
     const rootNames = [...Object.keys(AMBIENT_FILES).map(normalizeSlashes), ...userKeys];
-    program = ts8.createProgram(rootNames, COMPILER_OPTIONS, host, program);
-    const preEmitDiagnostics = ts8.getPreEmitDiagnostics(program);
+    program = ts9.createProgram(rootNames, COMPILER_OPTIONS, host, program);
+    const preEmitDiagnostics = ts9.getPreEmitDiagnostics(program);
     const collector = createOutputCollector();
     const { diagnostics: transpileDiagnostics } = new tstl3.Transpiler().emit({
       program,
       writeFile: collector.writeFile
     });
     const diagnostics = [
-      ...ts8.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
+      ...ts9.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
     ];
     return collectOutputs(collector.files, diagnostics, userKeys);
   }

package/dist/window-event-guard-lowering.d.ts

@@ -0,0 +1,2 @@
+import { type Plugin } from "typescript-to-lua";
+export declare const windowEventGuardLoweringPlugin: Plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/transpiler",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "TypeScript-to-Lua build pipeline tuned for Defold's runtime.",
   "license": "MIT",
   "repository": {
@@ -35,7 +35,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@defold-typescript/types": "0.8.3",
+    "@defold-typescript/types": "0.9.0",
     "@typescript-to-lua/language-extensions": "1.19.0",
     "typescript-to-lua": "^1.36.0"
   }

package/src/program-diagnostics.ts

@@ -4,12 +4,14 @@ import { lifecycleErasurePlugin } from "./lifecycle-erasure";
 import { messageDispatchLoweringPlugin } from "./message-dispatch-lowering";
 import { messageGuardLoweringPlugin } from "./message-guard-lowering";
 import { timersLoweringPlugin } from "./timers-lowering";
+import { windowEventGuardLoweringPlugin } from "./window-event-guard-lowering";
 
-// The same four lua plugins the build path lists (transpile.ts / session.ts),
-// so the editor and the build agree on what is unsupported.
+// The same lua plugins the build path lists (transpile.ts / session.ts), so the
+// editor and the build agree on what is unsupported.
 const LUA_PLUGINS: tstl.Plugin[] = [
   lifecycleErasurePlugin,
   messageGuardLoweringPlugin,
+  windowEventGuardLoweringPlugin,
   messageDispatchLoweringPlugin,
   timersLoweringPlugin,
 ];

package/src/session.ts

@@ -8,6 +8,7 @@ import { messageDispatchLoweringPlugin } from "./message-dispatch-lowering";
 import { messageGuardLoweringPlugin } from "./message-guard-lowering";
 import { timersLoweringPlugin } from "./timers-lowering";
 import { AMBIENT_FILES, collectOutputs, type TranspileProjectResult } from "./transpile";
+import { windowEventGuardLoweringPlugin } from "./window-event-guard-lowering";
 
 export interface TranspileSession {
   update(changes: Readonly<Record<string, string | null>>): TranspileProjectResult;
@@ -32,6 +33,7 @@ const COMPILER_OPTIONS: tstl.CompilerOptions = {
   luaPlugins: [
     { plugin: lifecycleErasurePlugin },
     { plugin: messageGuardLoweringPlugin },
+    { plugin: windowEventGuardLoweringPlugin },
     { plugin: messageDispatchLoweringPlugin },
     { plugin: timersLoweringPlugin },
   ],

package/src/transpile.ts

@@ -12,6 +12,7 @@ import { messageDispatchLoweringPlugin } from "./message-dispatch-lowering";
 import { messageGuardLoweringPlugin } from "./message-guard-lowering";
 import { importsTimersModule, timersLoweringPlugin } from "./timers-lowering";
 import { TIMERS_RUNTIME } from "./timers-runtime";
+import { windowEventGuardLoweringPlugin } from "./window-event-guard-lowering";
 
 export interface TranspileResult {
   readonly lua: string;
@@ -115,6 +116,9 @@ function buildAmbientFiles(): Record<string, string> {
       readAmbient("src/msg-overloads.d.ts"),
     "node_modules/@defold-typescript/types/src/message-guard.d.ts":
       readAmbient("src/message-guard.d.ts"),
+    "node_modules/@defold-typescript/types/src/window-event-guard.d.ts": readAmbient(
+      "src/window-event-guard.d.ts",
+    ),
     "node_modules/@defold-typescript/types/src/message-dispatch.d.ts": readAmbient(
       "src/message-dispatch.d.ts",
     ),
@@ -259,6 +263,7 @@ export function transpileProject(input: TranspileProjectInput): TranspileProject
     luaPlugins: [
       { plugin: lifecycleErasurePlugin },
       { plugin: messageGuardLoweringPlugin },
+      { plugin: windowEventGuardLoweringPlugin },
       { plugin: messageDispatchLoweringPlugin },
       { plugin: timersLoweringPlugin },
     ],

package/src/window-event-guard-lowering.ts

@@ -0,0 +1,47 @@
+import * as ts from "typescript";
+import {
+  createBinaryExpression,
+  type Expression,
+  type Plugin,
+  SyntaxKind,
+} from "typescript-to-lua";
+
+const GUARD_MODULE = "@defold-typescript/types";
+const GUARD_NAME = "isWindowEvent";
+
+function resolvesToGuardExport(callee: ts.Expression, checker: ts.TypeChecker): boolean {
+  let symbol = checker.getSymbolAtLocation(callee);
+  if (symbol === undefined) {
+    return false;
+  }
+  if (symbol.flags & ts.SymbolFlags.Alias) {
+    symbol = checker.getAliasedSymbol(symbol);
+  }
+  if (symbol.getName() !== GUARD_NAME) {
+    return false;
+  }
+  const declaration = symbol.valueDeclaration ?? symbol.declarations?.[0];
+  if (declaration === undefined) {
+    return false;
+  }
+  return declaration.getSourceFile().fileName.includes(GUARD_MODULE);
+}
+
+export const windowEventGuardLoweringPlugin: Plugin = {
+  visitors: {
+    [ts.SyntaxKind.CallExpression]: (node, context): Expression => {
+      const [eventArg, , expectedArg] = node.arguments;
+      if (
+        node.arguments.length === 3 &&
+        eventArg !== undefined &&
+        expectedArg !== undefined &&
+        resolvesToGuardExport(node.expression, context.checker)
+      ) {
+        const event = context.transformExpression(eventArg);
+        const expected = context.transformExpression(expectedArg);
+        return createBinaryExpression(event, expected, SyntaxKind.EqualityOperator, node);
+      }
+      return context.superTransformExpression(node);
+    },
+  },
+};