@defold-typescript/transpiler 0.4.3 → 0.5.1

package/dist/index.js

@@ -9,11 +9,20 @@ import * as tstl2 from "typescript-to-lua";
 import * as ts from "typescript";
 import {
   createAssignmentStatement,
+  createBinaryExpression,
   createBlock,
+  createCallExpression,
   createExpressionStatement,
+  createForInStatement,
   createFunctionExpression,
   createIdentifier,
-  NodeFlags
+  createIfStatement,
+  createNilLiteral,
+  createReturnStatement,
+  createTableIndexExpression,
+  createVariableDeclarationStatement,
+  NodeFlags,
+  SyntaxKind as SyntaxKind2
 } from "typescript-to-lua";
 var FACTORY_MODULE = "@defold-typescript/types";
 var FACTORY_NAMES = new Set(["defineScript", "defineGuiScript", "defineRenderScript"]);
@@ -65,6 +74,43 @@ function transformHookBody(fn, context) {
   }
   return [createExpressionStatement(context.transformExpression(fn.body))];
 }
+function crossesFunctionBoundary(node) {
+  return ts.isFunctionDeclaration(node) || ts.isFunctionExpression(node) || ts.isArrowFunction(node) || ts.isMethodDeclaration(node) || ts.isGetAccessorDeclaration(node) || ts.isSetAccessorDeclaration(node);
+}
+function initReturnsValue(fn) {
+  if (!ts.isBlock(fn.body)) {
+    return true;
+  }
+  let found = false;
+  const visit = (node) => {
+    if (found || crossesFunctionBoundary(node)) {
+      return;
+    }
+    if (ts.isReturnStatement(node) && node.expression !== undefined) {
+      found = true;
+      return;
+    }
+    ts.forEachChild(node, visit);
+  };
+  ts.forEachChild(fn.body, visit);
+  return found;
+}
+function initBuilderBody(fn, context) {
+  if (ts.isBlock(fn.body)) {
+    return context.transformStatements(fn.body.statements);
+  }
+  return [createReturnStatement([context.transformExpression(fn.body)])];
+}
+function emitInitMerge(fn, context, property) {
+  const builder = createFunctionExpression(createBlock(initBuilderBody(fn, context)), [], undefined, NodeFlags.Declaration, fn);
+  const builderDecl = createVariableDeclarationStatement(createIdentifier("____init"), builder);
+  const stateDecl = createVariableDeclarationStatement(createIdentifier("____s"), createCallExpression(createIdentifier("____init"), []));
+  const mergeAssignment = createAssignmentStatement(createTableIndexExpression(createIdentifier("self"), createIdentifier("____k")), createIdentifier("____v"));
+  const forIn = createForInStatement(createBlock([mergeAssignment]), [createIdentifier("____k"), createIdentifier("____v")], [createCallExpression(createIdentifier("pairs"), [createIdentifier("____s")])]);
+  const guard = createIfStatement(createBinaryExpression(createIdentifier("____s"), createNilLiteral(), SyntaxKind2.InequalityOperator), createBlock([forIn]));
+  const initFn = createFunctionExpression(createBlock([stateDecl, guard]), [createIdentifier("self")], undefined, NodeFlags.Declaration, fn);
+  return [builderDecl, createAssignmentStatement(createIdentifier("init"), initFn, property)];
+}
 function eraseFactoryCall(expression, context) {
   if (!ts.isCallExpression(expression)) {
     return;
@@ -83,6 +129,10 @@ function eraseFactoryCall(expression, context) {
     if (name === undefined || fn === undefined) {
       continue;
     }
+    if (name === "init" && initReturnsValue(fn)) {
+      statements.push(...emitInitMerge(fn, context, property));
+      continue;
+    }
     const params = fn.parameters.filter((param) => !isThisParameter(param) && ts.isIdentifier(param.name)).map((param) => context.transformExpression(param.name));
     const fnExpression = createFunctionExpression(createBlock(transformHookBody(fn, context)), params, undefined, NodeFlags.Declaration, fn);
     statements.push(createAssignmentStatement(createIdentifier(name), fnExpression, property));
@@ -120,7 +170,7 @@ var lifecycleErasurePlugin = {
 };
 
 // src/transpile.ts
-import { readFileSync } from "node:fs";
+import { readdirSync, readFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import * as path from "node:path";
 import * as tstl from "typescript-to-lua";
@@ -136,18 +186,34 @@ var TSTL_LANG_EXT_ROOT = path.dirname(requireFromHere.resolve("@typescript-to-lu
 function readAmbient(rel) {
   return readFileSync(path.join(TYPES_PKG_ROOT, rel), "utf8");
 }
-var AMBIENT_FILES = {
-  "node_modules/@typescript-to-lua/language-extensions/index.d.ts": readFileSync(path.join(TSTL_LANG_EXT_ROOT, "index.d.ts"), "utf8"),
-  "node_modules/@defold-typescript/types/generated/vmath.d.ts": readAmbient("generated/vmath.d.ts"),
-  "node_modules/@defold-typescript/types/generated/msg.d.ts": readAmbient("generated/msg.d.ts"),
-  "node_modules/@defold-typescript/types/generated/go.d.ts": readAmbient("generated/go.d.ts"),
-  "node_modules/@defold-typescript/types/generated/builtin-messages.d.ts": readAmbient("generated/builtin-messages.d.ts"),
-  "node_modules/@defold-typescript/types/src/core-types.ts": readAmbient("src/core-types.ts"),
-  "node_modules/@defold-typescript/types/src/msg-overloads.d.ts": readAmbient("src/msg-overloads.d.ts"),
-  "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
-  "node_modules/@defold-typescript/types/index.ts": `export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";
+function buildAmbientFiles() {
+  const files = {
+    "node_modules/@typescript-to-lua/language-extensions/index.d.ts": readFileSync(path.join(TSTL_LANG_EXT_ROOT, "index.d.ts"), "utf8"),
+    "node_modules/@defold-typescript/types/src/core-types.ts": readAmbient("src/core-types.ts"),
+    "node_modules/@defold-typescript/types/src/msg-overloads.d.ts": readAmbient("src/msg-overloads.d.ts"),
+    "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
+    "node_modules/@defold-typescript/types/index.ts": [
+      'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";',
+      'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks } from "./src/lifecycle";',
+      'export type { Hash, Matrix4, Quaternion, Url, Vector, Vector3, Vector4 } from "./src/core-types";',
+      ""
+    ].join(`
+`),
+    "node_modules/@defold-typescript/types/script.d.ts": `export {};
+`,
+    "node_modules/@defold-typescript/types/gui-script.d.ts": `export {};
+`,
+    "node_modules/@defold-typescript/types/render-script.d.ts": `export {};
 `
-};
+  };
+  for (const entry of readdirSync(path.join(TYPES_PKG_ROOT, "generated"))) {
+    if (entry.endsWith(".d.ts")) {
+      files[`node_modules/@defold-typescript/types/generated/${entry}`] = readAmbient(`generated/${entry}`);
+    }
+  }
+  return files;
+}
+var AMBIENT_FILES = buildAmbientFiles();
 function collectOutputs(transpiledFiles, diagnostics, userKeys) {
   const lua = {};
   const sourceMaps = {};
@@ -174,6 +240,7 @@ function transpileProject(input) {
   const result = tstl.transpileVirtualProject(merged, {
     luaTarget: tstl.LuaTarget.Lua54,
     sourceMap: true,
+    skipLibCheck: true,
     luaPlugins: [{ plugin: lifecycleErasurePlugin }]
   });
   return collectOutputs(result.transpiledFiles, result.diagnostics, userKeys);
@@ -192,6 +259,7 @@ var requireFromHere2 = createRequire2(import.meta.url);
 var COMPILER_OPTIONS = {
   luaTarget: tstl2.LuaTarget.Lua54,
   sourceMap: true,
+  skipLibCheck: true,
   luaPlugins: [{ plugin: lifecycleErasurePlugin }]
 };
 function normalizeSlashes(p) {

package/package.json

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

package/src/lifecycle-erasure.ts

@@ -1,14 +1,23 @@
 import * as ts from "typescript";
 import {
   createAssignmentStatement,
+  createBinaryExpression,
   createBlock,
+  createCallExpression,
   createExpressionStatement,
+  createForInStatement,
   createFunctionExpression,
   createIdentifier,
+  createIfStatement,
+  createNilLiteral,
+  createReturnStatement,
+  createTableIndexExpression,
+  createVariableDeclarationStatement,
   type Identifier,
   NodeFlags,
   type Plugin,
   type Statement,
+  SyntaxKind,
   type TransformationContext,
 } from "typescript-to-lua";
 
@@ -75,6 +84,92 @@ function transformHookBody(fn: HookFunction, context: TransformationContext): St
   return [createExpressionStatement(context.transformExpression(fn.body))];
 }
 
+function crossesFunctionBoundary(node: ts.Node): boolean {
+  return (
+    ts.isFunctionDeclaration(node) ||
+    ts.isFunctionExpression(node) ||
+    ts.isArrowFunction(node) ||
+    ts.isMethodDeclaration(node) ||
+    ts.isGetAccessorDeclaration(node) ||
+    ts.isSetAccessorDeclaration(node)
+  );
+}
+
+function initReturnsValue(fn: HookFunction): boolean {
+  if (!ts.isBlock(fn.body)) {
+    return true;
+  }
+  let found = false;
+  const visit = (node: ts.Node): void => {
+    if (found || crossesFunctionBoundary(node)) {
+      return;
+    }
+    if (ts.isReturnStatement(node) && node.expression !== undefined) {
+      found = true;
+      return;
+    }
+    ts.forEachChild(node, visit);
+  };
+  ts.forEachChild(fn.body, visit);
+  return found;
+}
+
+function initBuilderBody(fn: HookFunction, context: TransformationContext): Statement[] {
+  if (ts.isBlock(fn.body)) {
+    return context.transformStatements(fn.body.statements);
+  }
+  return [createReturnStatement([context.transformExpression(fn.body)])];
+}
+
+// init-merge: Defold owns `self` (a userdata-backed table) and a script can
+// populate but not replace it, so a returning `init(): TSelf` can't be emitted
+// verbatim. Wrap the body in a `____init` builder and merge its result onto the
+// engine `self`; a `nil` return (stateless script) merges nothing.
+function emitInitMerge(
+  fn: HookFunction,
+  context: TransformationContext,
+  property: ts.ObjectLiteralElementLike,
+): Statement[] {
+  const builder = createFunctionExpression(
+    createBlock(initBuilderBody(fn, context)),
+    [],
+    undefined,
+    NodeFlags.Declaration,
+    fn,
+  );
+  const builderDecl = createVariableDeclarationStatement(createIdentifier("____init"), builder);
+
+  const stateDecl = createVariableDeclarationStatement(
+    createIdentifier("____s"),
+    createCallExpression(createIdentifier("____init"), []),
+  );
+  const mergeAssignment = createAssignmentStatement(
+    createTableIndexExpression(createIdentifier("self"), createIdentifier("____k")),
+    createIdentifier("____v"),
+  );
+  const forIn = createForInStatement(
+    createBlock([mergeAssignment]),
+    [createIdentifier("____k"), createIdentifier("____v")],
+    [createCallExpression(createIdentifier("pairs"), [createIdentifier("____s")])],
+  );
+  const guard = createIfStatement(
+    createBinaryExpression(
+      createIdentifier("____s"),
+      createNilLiteral(),
+      SyntaxKind.InequalityOperator,
+    ),
+    createBlock([forIn]),
+  );
+  const initFn = createFunctionExpression(
+    createBlock([stateDecl, guard]),
+    [createIdentifier("self")],
+    undefined,
+    NodeFlags.Declaration,
+    fn,
+  );
+  return [builderDecl, createAssignmentStatement(createIdentifier("init"), initFn, property)];
+}
+
 function eraseFactoryCall(
   expression: ts.Expression,
   context: TransformationContext,
@@ -96,6 +191,10 @@ function eraseFactoryCall(
     if (name === undefined || fn === undefined) {
       continue;
     }
+    if (name === "init" && initReturnsValue(fn)) {
+      statements.push(...emitInitMerge(fn, context, property));
+      continue;
+    }
     const params: Identifier[] = fn.parameters
       .filter((param) => !isThisParameter(param) && ts.isIdentifier(param.name))
       .map((param) => context.transformExpression(param.name as ts.Identifier) as Identifier);

package/src/session.ts

@@ -16,6 +16,9 @@ const requireFromHere = createRequire(import.meta.url);
 const COMPILER_OPTIONS: tstl.CompilerOptions = {
   luaTarget: tstl.LuaTarget.Lua54,
   sourceMap: true,
+  // Don't cross-check the seeded ambient .d.ts surface against itself; only user
+  // files matter (mirrors transpileProject and the editor's skipLibCheck).
+  skipLibCheck: true,
   luaPlugins: [{ plugin: lifecycleErasurePlugin }],
 };
 

package/src/transpile.ts

@@ -1,4 +1,4 @@
-import { readFileSync } from "node:fs";
+import { readdirSync, readFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import * as path from "node:path";
 import type * as ts from "typescript";
@@ -47,24 +47,44 @@ function readAmbient(rel: string): string {
   return readFileSync(path.join(TYPES_PKG_ROOT, rel), "utf8");
 }
 
-export const AMBIENT_FILES: Readonly<Record<string, string>> = {
-  "node_modules/@typescript-to-lua/language-extensions/index.d.ts": readFileSync(
-    path.join(TSTL_LANG_EXT_ROOT, "index.d.ts"),
-    "utf8",
-  ),
-  "node_modules/@defold-typescript/types/generated/vmath.d.ts": readAmbient("generated/vmath.d.ts"),
-  "node_modules/@defold-typescript/types/generated/msg.d.ts": readAmbient("generated/msg.d.ts"),
-  "node_modules/@defold-typescript/types/generated/go.d.ts": readAmbient("generated/go.d.ts"),
-  "node_modules/@defold-typescript/types/generated/builtin-messages.d.ts": readAmbient(
-    "generated/builtin-messages.d.ts",
-  ),
-  "node_modules/@defold-typescript/types/src/core-types.ts": readAmbient("src/core-types.ts"),
-  "node_modules/@defold-typescript/types/src/msg-overloads.d.ts":
-    readAmbient("src/msg-overloads.d.ts"),
-  "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
-  "node_modules/@defold-typescript/types/index.ts":
-    'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";\n',
-};
+function buildAmbientFiles(): Record<string, string> {
+  const files: Record<string, string> = {
+    "node_modules/@typescript-to-lua/language-extensions/index.d.ts": readFileSync(
+      path.join(TSTL_LANG_EXT_ROOT, "index.d.ts"),
+      "utf8",
+    ),
+    "node_modules/@defold-typescript/types/src/core-types.ts": readAmbient("src/core-types.ts"),
+    "node_modules/@defold-typescript/types/src/msg-overloads.d.ts":
+      readAmbient("src/msg-overloads.d.ts"),
+    "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
+    // Mirror the consumer-facing re-exports of the real package index so a user
+    // file can `import { defineScript }` and `import type { Hash, Vector3 }`.
+    "node_modules/@defold-typescript/types/index.ts": [
+      'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";',
+      'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks } from "./src/lifecycle";',
+      'export type { Hash, Matrix4, Quaternion, Url, Vector, Vector3, Vector4 } from "./src/core-types";',
+      "",
+    ].join("\n"),
+    // Per-kind subpath entrypoints exist as package exports for the editor.
+    // Their namespaces are already seeded ambiently below, so the transpiler
+    // only needs the specifiers to resolve — an empty module is enough.
+    "node_modules/@defold-typescript/types/script.d.ts": "export {};\n",
+    "node_modules/@defold-typescript/types/gui-script.d.ts": "export {};\n",
+    "node_modules/@defold-typescript/types/render-script.d.ts": "export {};\n",
+  };
+  // Seed every generated namespace so real multi-namespace user code (sprite,
+  // physics, label, ...) resolves — not just the historical vmath/msg/go subset.
+  for (const entry of readdirSync(path.join(TYPES_PKG_ROOT, "generated"))) {
+    if (entry.endsWith(".d.ts")) {
+      files[`node_modules/@defold-typescript/types/generated/${entry}`] = readAmbient(
+        `generated/${entry}`,
+      );
+    }
+  }
+  return files;
+}
+
+export const AMBIENT_FILES: Readonly<Record<string, string>> = buildAmbientFiles();
 
 interface CollectableFile {
   readonly sourceFiles: readonly ts.SourceFile[];
@@ -108,6 +128,9 @@ export function transpileProject(input: TranspileProjectInput): TranspileProject
   const result = tstl.transpileVirtualProject(merged, {
     luaTarget: tstl.LuaTarget.Lua54,
     sourceMap: true,
+    // Don't cross-check the seeded ambient .d.ts surface against itself; we only
+    // care about diagnostics on user files (mirrors the editor's skipLibCheck).
+    skipLibCheck: true,
     luaPlugins: [{ plugin: lifecycleErasurePlugin }],
   });