@defold-typescript/transpiler 0.5.5 → 0.6.0

package/dist/go-property-direct-call.d.ts

@@ -0,0 +1,3 @@
+import * as ts from "typescript";
+export declare const 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).";
+export declare function findDirectGoPropertyCalls(sourceFile: ts.SourceFile): ts.CallExpression[];

package/dist/index.js

@@ -2,7 +2,7 @@
 import { readFileSync as readFileSync2 } from "node:fs";
 import { createRequire as createRequire2 } from "node:module";
 import * as path2 from "node:path";
-import * as ts4 from "typescript";
+import * as ts5 from "typescript";
 import * as tstl2 from "typescript-to-lua";
 
 // src/lifecycle-erasure.ts
@@ -19,6 +19,7 @@ import {
   createIfStatement as createIfStatement2,
   createNilLiteral,
   createReturnStatement,
+  createStringLiteral as createStringLiteral2,
   createTableIndexExpression,
   createVariableDeclarationStatement as createVariableDeclarationStatement2,
   NodeFlags as NodeFlags2,
@@ -141,6 +142,12 @@ var messageDispatchLoweringPlugin = {
 // src/lifecycle-erasure.ts
 var FACTORY_MODULE = "@defold-typescript/types";
 var FACTORY_NAMES = new Set(["defineScript", "defineGuiScript", "defineRenderScript"]);
+var FACTORY_SPECIFIERS = new Set([
+  FACTORY_MODULE,
+  `${FACTORY_MODULE}/script`,
+  `${FACTORY_MODULE}/gui-script`,
+  `${FACTORY_MODULE}/render-script`
+]);
 function resolvesToFactoryExport(callee, checker) {
   let symbol = checker.getSymbolAtLocation(callee);
   if (symbol === undefined) {
@@ -236,6 +243,23 @@ function emitInitMerge(fn, context, property) {
   const initFn = createFunctionExpression2(createBlock2([stateDecl, guard]), [createIdentifier2("self")], undefined, NodeFlags2.Declaration, fn);
   return [builderDecl, createAssignmentStatement(createIdentifier2("init"), initFn, property)];
 }
+function emitPropertyRegistrations(property, context) {
+  if (!ts2.isPropertyAssignment(property) || !ts2.isObjectLiteralExpression(property.initializer)) {
+    return [];
+  }
+  const registrations = [];
+  for (const member of property.initializer.properties) {
+    if (!ts2.isPropertyAssignment(member)) {
+      continue;
+    }
+    const key = member.name;
+    if (!ts2.isIdentifier(key) && !ts2.isStringLiteral(key)) {
+      continue;
+    }
+    registrations.push(createExpressionStatement(createCallExpression2(createTableIndexExpression(createIdentifier2("go"), createStringLiteral2("property")), [createStringLiteral2(key.text), context.transformExpression(member.initializer)])));
+  }
+  return registrations;
+}
 function eraseFactoryCall(expression, context) {
   if (!ts2.isCallExpression(expression)) {
     return;
@@ -247,12 +271,17 @@ function eraseFactoryCall(expression, context) {
   if (hooks === undefined || !ts2.isObjectLiteralExpression(hooks)) {
     return;
   }
+  const registrations = [];
   const statements = [];
   for (const property of hooks.properties) {
     const name = hookName(property);
     if (name === undefined) {
       continue;
     }
+    if (name === "properties") {
+      registrations.push(...emitPropertyRegistrations(property, context));
+      continue;
+    }
     const fn = hookFunction(property);
     if (fn === undefined) {
       const dispatch = dispatcherInitializer(property, context.checker);
@@ -269,10 +298,10 @@ function eraseFactoryCall(expression, context) {
     const fnExpression = createFunctionExpression2(createBlock2(transformHookBody(fn, context)), params, undefined, NodeFlags2.Declaration, fn);
     statements.push(createAssignmentStatement(createIdentifier2(name), fnExpression, property));
   }
-  return statements;
+  return [...registrations, ...statements];
 }
 function isFactoryOnlyImport(node) {
-  if (!ts2.isStringLiteral(node.moduleSpecifier) || node.moduleSpecifier.text !== FACTORY_MODULE) {
+  if (!ts2.isStringLiteral(node.moduleSpecifier) || !FACTORY_SPECIFIERS.has(node.moduleSpecifier.text)) {
     return false;
   }
   const clause = node.importClause;
@@ -347,6 +376,23 @@ import { readdirSync, readFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import * as path from "node:path";
 import * as tstl from "typescript-to-lua";
+
+// src/go-property-direct-call.ts
+import * as ts4 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 (ts4.isCallExpression(node) && ts4.isPropertyAccessExpression(node.expression) && node.expression.name.text === "property" && ts4.isIdentifier(node.expression.expression) && node.expression.expression.text === "go") {
+      calls.push(node);
+    }
+    ts4.forEachChild(node, visit);
+  };
+  ts4.forEachChild(sourceFile, visit);
+  return calls;
+}
+
+// src/transpile.ts
 function flattenDiagnosticMessage(text) {
   if (typeof text === "string") {
     return text;
@@ -363,22 +409,27 @@ 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/engine-globals.d.ts": readAmbient("src/engine-globals.d.ts"),
+    "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/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/index.ts": [
       'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";',
-      'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks } from "./src/lifecycle";',
+      'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks, ScriptProperties, ScriptProperty } 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/script.d.ts": `export { defineScript } from "./src/lifecycle.js";
+export type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";
 `,
-    "node_modules/@defold-typescript/types/gui-script.d.ts": `export {};
+    "node_modules/@defold-typescript/types/gui-script.d.ts": `export { defineGuiScript } from "./src/lifecycle.js";
+export type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";
 `,
-    "node_modules/@defold-typescript/types/render-script.d.ts": `export {};
+    "node_modules/@defold-typescript/types/render-script.d.ts": `export { defineRenderScript } from "./src/lifecycle.js";
+export type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";
 `
   };
   for (const entry of readdirSync(path.join(TYPES_PKG_ROOT, "generated"))) {
@@ -407,6 +458,22 @@ function collectOutputs(transpiledFiles, diagnostics, userKeys) {
     const message = flattenDiagnosticMessage(d.messageText);
     return fileName !== undefined && userKeys.has(fileName) ? { file: fileName, message } : { message };
   });
+  const scanned = new Set;
+  for (const file of transpiledFiles) {
+    for (const sourceFile of file.sourceFiles) {
+      if (!userKeys.has(sourceFile.fileName) || scanned.has(sourceFile.fileName)) {
+        continue;
+      }
+      scanned.add(sourceFile.fileName);
+      if (findDirectGoPropertyCalls(sourceFile).length > 0) {
+        collectedDiagnostics.push({
+          file: sourceFile.fileName,
+          message: GO_PROPERTY_DIRECT_CALL_MESSAGE,
+          category: "warning"
+        });
+      }
+    }
+  }
   return { lua, sourceMaps, diagnostics: collectedDiagnostics };
 }
 function transpileProject(input) {
@@ -485,7 +552,7 @@ function createTranspileSession() {
       if (cached) {
         return cached;
       }
-      const created = ts4.createSourceFile(fileName, content, ts4.ScriptTarget.Latest, false);
+      const created = ts5.createSourceFile(fileName, content, ts5.ScriptTarget.Latest, false);
       sourceFileCache.set(normalized, created);
       return created;
     }
@@ -504,7 +571,7 @@ function createTranspileSession() {
         return cached;
       }
       const fileContent = readFileSync2(filePath, "utf8");
-      const created = ts4.createSourceFile(filePath, fileContent, ts4.ScriptTarget.Latest, false);
+      const created = ts5.createSourceFile(filePath, fileContent, ts5.ScriptTarget.Latest, false);
       libCache.set(fileName, created);
       return created;
     }
@@ -517,10 +584,10 @@ function createTranspileSession() {
     return AMBIENT_FILES[normalized];
   }
   const host = {
-    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts4.sys.fileExists(fileName),
+    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts5.sys.fileExists(fileName),
     getCanonicalFileName: (fileName) => fileName,
     getCurrentDirectory: () => "",
-    getDefaultLibFileName: ts4.getDefaultLibFileName,
+    getDefaultLibFileName: ts5.getDefaultLibFileName,
     readFile: () => "",
     getNewLine: () => `
 `,
@@ -541,15 +608,15 @@ function createTranspileSession() {
     }
     const userKeys = new Set(userFiles.keys());
     const rootNames = [...Object.keys(AMBIENT_FILES).map(normalizeSlashes), ...userKeys];
-    program = ts4.createProgram(rootNames, COMPILER_OPTIONS, host, program);
-    const preEmitDiagnostics = ts4.getPreEmitDiagnostics(program);
+    program = ts5.createProgram(rootNames, COMPILER_OPTIONS, host, program);
+    const preEmitDiagnostics = ts5.getPreEmitDiagnostics(program);
     const collector = createOutputCollector();
     const { diagnostics: transpileDiagnostics } = new tstl2.Transpiler().emit({
       program,
       writeFile: collector.writeFile
     });
     const diagnostics = [
-      ...ts4.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
+      ...ts5.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
     ];
     return collectOutputs(collector.files, diagnostics, userKeys);
   }

package/dist/lifecycle-erasure.d.ts

@@ -1,2 +1,4 @@
+import * as ts from "typescript";
 import { type Plugin } from "typescript-to-lua";
+export declare function isFactoryOnlyImport(node: ts.ImportDeclaration): boolean;
 export declare const lifecycleErasurePlugin: Plugin;

package/dist/transpile.d.ts

@@ -7,6 +7,7 @@ export interface TranspileResult {
 export interface TranspileDiagnostic {
     readonly file?: string;
     readonly message: string;
+    readonly category?: "warning";
 }
 export interface TranspileProjectInput {
     readonly files: Readonly<Record<string, string>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/transpiler",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "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.5.5",
+    "@defold-typescript/types": "0.6.0",
     "@typescript-to-lua/language-extensions": "1.19.0",
     "typescript-to-lua": "^1.36.0"
   }

package/src/go-property-direct-call.ts

@@ -0,0 +1,26 @@
+import * as ts from "typescript";
+
+export const 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).";
+
+// Match a user-source `go.property(...)` call — a `property` access on the `go`
+// identifier. The blessed `properties`-field form never produces such a call;
+// the synthesized registrations live only in emitted Lua, which this scan never
+// sees (it walks the user TypeScript AST).
+export function findDirectGoPropertyCalls(sourceFile: ts.SourceFile): ts.CallExpression[] {
+  const calls: ts.CallExpression[] = [];
+  const visit = (node: ts.Node): void => {
+    if (
+      ts.isCallExpression(node) &&
+      ts.isPropertyAccessExpression(node.expression) &&
+      node.expression.name.text === "property" &&
+      ts.isIdentifier(node.expression.expression) &&
+      node.expression.expression.text === "go"
+    ) {
+      calls.push(node);
+    }
+    ts.forEachChild(node, visit);
+  };
+  ts.forEachChild(sourceFile, visit);
+  return calls;
+}

package/src/lifecycle-erasure.ts

@@ -11,6 +11,7 @@ import {
   createIfStatement,
   createNilLiteral,
   createReturnStatement,
+  createStringLiteral,
   createTableIndexExpression,
   createVariableDeclarationStatement,
   type Identifier,
@@ -24,6 +25,15 @@ import { resolvesToDispatchExport } from "./message-dispatch-lowering";
 
 const FACTORY_MODULE = "@defold-typescript/types";
 const FACTORY_NAMES = new Set(["defineScript", "defineGuiScript", "defineRenderScript"]);
+// A walled source imports its factory from the matching kind subpath
+// (`@defold-typescript/types/gui-script`) to avoid pulling the cross-kind
+// `declare global` namespaces; those imports erase exactly like the bare one.
+const FACTORY_SPECIFIERS = new Set([
+  FACTORY_MODULE,
+  `${FACTORY_MODULE}/script`,
+  `${FACTORY_MODULE}/gui-script`,
+  `${FACTORY_MODULE}/render-script`,
+]);
 
 function resolvesToFactoryExport(callee: ts.Expression, checker: ts.TypeChecker): boolean {
   let symbol = checker.getSymbolAtLocation(callee);
@@ -185,6 +195,38 @@ function emitInitMerge(
   return [builderDecl, createAssignmentStatement(createIdentifier("init"), initFn, property)];
 }
 
+// The value-keyed `properties` field maps each `key: default` to a chunk-scope
+// `go.property("key", default)` the editor reads. Emitted before the hook
+// assignments and after the source's `local` consts, so a default referencing a
+// module const resolves.
+function emitPropertyRegistrations(
+  property: ts.ObjectLiteralElementLike,
+  context: TransformationContext,
+): Statement[] {
+  if (!ts.isPropertyAssignment(property) || !ts.isObjectLiteralExpression(property.initializer)) {
+    return [];
+  }
+  const registrations: Statement[] = [];
+  for (const member of property.initializer.properties) {
+    if (!ts.isPropertyAssignment(member)) {
+      continue;
+    }
+    const key = member.name;
+    if (!ts.isIdentifier(key) && !ts.isStringLiteral(key)) {
+      continue;
+    }
+    registrations.push(
+      createExpressionStatement(
+        createCallExpression(
+          createTableIndexExpression(createIdentifier("go"), createStringLiteral("property")),
+          [createStringLiteral(key.text), context.transformExpression(member.initializer)],
+        ),
+      ),
+    );
+  }
+  return registrations;
+}
+
 function eraseFactoryCall(
   expression: ts.Expression,
   context: TransformationContext,
@@ -199,12 +241,17 @@ function eraseFactoryCall(
   if (hooks === undefined || !ts.isObjectLiteralExpression(hooks)) {
     return undefined;
   }
+  const registrations: Statement[] = [];
   const statements: Statement[] = [];
   for (const property of hooks.properties) {
     const name = hookName(property);
     if (name === undefined) {
       continue;
     }
+    if (name === "properties") {
+      registrations.push(...emitPropertyRegistrations(property, context));
+      continue;
+    }
     const fn = hookFunction(property);
     if (fn === undefined) {
       // A hook whose initializer is a recognized `onMessage({...})` call: let it
@@ -238,11 +285,14 @@ function eraseFactoryCall(
     );
     statements.push(createAssignmentStatement(createIdentifier(name), fnExpression, property));
   }
-  return statements;
+  return [...registrations, ...statements];
 }
 
-function isFactoryOnlyImport(node: ts.ImportDeclaration): boolean {
-  if (!ts.isStringLiteral(node.moduleSpecifier) || node.moduleSpecifier.text !== FACTORY_MODULE) {
+export function isFactoryOnlyImport(node: ts.ImportDeclaration): boolean {
+  if (
+    !ts.isStringLiteral(node.moduleSpecifier) ||
+    !FACTORY_SPECIFIERS.has(node.moduleSpecifier.text)
+  ) {
     return false;
   }
   const clause = node.importClause;

package/src/transpile.ts

@@ -3,6 +3,10 @@ import { createRequire } from "node:module";
 import * as path from "node:path";
 import type * as ts from "typescript";
 import * as tstl from "typescript-to-lua";
+import {
+  findDirectGoPropertyCalls,
+  GO_PROPERTY_DIRECT_CALL_MESSAGE,
+} from "./go-property-direct-call";
 import { lifecycleErasurePlugin } from "./lifecycle-erasure";
 import { messageDispatchLoweringPlugin } from "./message-dispatch-lowering";
 import { messageGuardLoweringPlugin } from "./message-guard-lowering";
@@ -16,6 +20,10 @@ export interface TranspileResult {
 export interface TranspileDiagnostic {
   readonly file?: string;
   readonly message: string;
+  // Present only on advisory diagnostics (e.g. the deprecated direct
+  // `go.property` call). Absent means a hard failure, so `collectFailures`
+  // keeps treating uncategorized diagnostics as fatal.
+  readonly category?: "warning";
 }
 
 export interface TranspileProjectInput {
@@ -56,6 +64,10 @@ function buildAmbientFiles(): Record<string, string> {
       "utf8",
     ),
     "node_modules/@defold-typescript/types/src/core-types.ts": readAmbient("src/core-types.ts"),
+    "node_modules/@defold-typescript/types/src/engine-globals.d.ts":
+      readAmbient("src/engine-globals.d.ts"),
+    "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":
@@ -68,16 +80,22 @@ function buildAmbientFiles(): Record<string, string> {
     // 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 { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks, ScriptProperties, ScriptProperty } 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",
+    // Their namespaces are already seeded ambiently below; mirror slice A's
+    // generated `generateKindIndex` output by re-exporting only the matching
+    // factory, so a walled source's subpath import resolves to it and the
+    // call-site erasure fires (otherwise the import lowers to a broken
+    // `require("@defold-typescript/types/gui-script")`).
+    "node_modules/@defold-typescript/types/script.d.ts":
+      'export { defineScript } from "./src/lifecycle.js";\nexport type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";\n',
+    "node_modules/@defold-typescript/types/gui-script.d.ts":
+      'export { defineGuiScript } from "./src/lifecycle.js";\nexport type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";\n',
+    "node_modules/@defold-typescript/types/render-script.d.ts":
+      'export { defineRenderScript } from "./src/lifecycle.js";\nexport type { ScriptProperties, ScriptProperty } from "./src/lifecycle.js";\n',
   };
   // Seed every generated namespace so real multi-namespace user code (sprite,
   // physics, label, ...) resolves — not just the historical vmath/msg/go subset.
@@ -125,6 +143,26 @@ export function collectOutputs(
       : { message };
   });
 
+  // Advisory scan of the user TypeScript AST for the deprecated direct
+  // `go.property` call. Run here (shared by transpileProject and the watch
+  // session) so both paths report it identically.
+  const scanned = new Set<string>();
+  for (const file of transpiledFiles) {
+    for (const sourceFile of file.sourceFiles) {
+      if (!userKeys.has(sourceFile.fileName) || scanned.has(sourceFile.fileName)) {
+        continue;
+      }
+      scanned.add(sourceFile.fileName);
+      if (findDirectGoPropertyCalls(sourceFile).length > 0) {
+        collectedDiagnostics.push({
+          file: sourceFile.fileName,
+          message: GO_PROPERTY_DIRECT_CALL_MESSAGE,
+          category: "warning",
+        });
+      }
+    }
+  }
+
   return { lua, sourceMaps, diagnostics: collectedDiagnostics };
 }