@defold-typescript/transpiler 0.21.1 → 0.23.0

package/dist/editor-script-erasure.d.ts

@@ -0,0 +1,6 @@
+import * as ts from "typescript";
+import { type Plugin } from "typescript-to-lua";
+export declare const EDITOR_FACTORY_MODULE = "@defold-typescript/types";
+export declare const EDITOR_FACTORY_NAME = "defineEditorScript";
+export declare function isEditorFactoryOnlyImport(node: ts.ImportDeclaration): boolean;
+export declare const editorScriptErasurePlugin: Plugin;

package/dist/index.js

@@ -529,9 +529,83 @@ 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 ts9 from "typescript";
+import * as ts10 from "typescript";
 import * as tstl3 from "typescript-to-lua";
 
+// src/editor-script-erasure.ts
+import * as ts8 from "typescript";
+import {
+  createReturnStatement as createReturnStatement2
+} from "typescript-to-lua";
+var EDITOR_FACTORY_MODULE = "@defold-typescript/types";
+var EDITOR_FACTORY_NAME = "defineEditorScript";
+var EDITOR_FACTORY_SPECIFIERS = new Set([EDITOR_FACTORY_MODULE]);
+function resolvesToEditorFactoryExport(callee, checker) {
+  let symbol = checker.getSymbolAtLocation(callee);
+  if (symbol === undefined) {
+    return false;
+  }
+  if (symbol.flags & ts8.SymbolFlags.Alias) {
+    symbol = checker.getAliasedSymbol(symbol);
+  }
+  if (symbol.getName() !== EDITOR_FACTORY_NAME) {
+    return false;
+  }
+  const declaration = symbol.valueDeclaration ?? symbol.declarations?.[0];
+  if (declaration === undefined) {
+    return false;
+  }
+  return declaration.getSourceFile().fileName.includes(EDITOR_FACTORY_MODULE);
+}
+function lowerEditorFactoryCall(expression, context) {
+  if (!ts8.isCallExpression(expression)) {
+    return;
+  }
+  if (!resolvesToEditorFactoryExport(expression.expression, context.checker)) {
+    return;
+  }
+  const module = expression.arguments[0];
+  if (module === undefined) {
+    return;
+  }
+  return [createReturnStatement2([context.transformExpression(module)])];
+}
+function isEditorFactoryOnlyImport(node) {
+  if (!ts8.isStringLiteral(node.moduleSpecifier) || !EDITOR_FACTORY_SPECIFIERS.has(node.moduleSpecifier.text)) {
+    return false;
+  }
+  const clause = node.importClause;
+  if (clause === undefined || clause.name !== undefined) {
+    return false;
+  }
+  if (clause.isTypeOnly) {
+    return false;
+  }
+  const bindings = clause.namedBindings;
+  if (bindings === undefined || !ts8.isNamedImports(bindings)) {
+    return false;
+  }
+  const runtime = bindings.elements.filter((element) => !element.isTypeOnly);
+  if (runtime.length === 0) {
+    return false;
+  }
+  return runtime.every((element) => (element.propertyName ?? element.name).text === EDITOR_FACTORY_NAME);
+}
+var editorScriptErasurePlugin = {
+  visitors: {
+    [ts8.SyntaxKind.ExportAssignment]: (node, context) => {
+      if (!node.isExportEquals) {
+        const lowered = lowerEditorFactoryCall(node.expression, context);
+        if (lowered !== undefined) {
+          return lowered;
+        }
+      }
+      return context.superTransformStatements(node);
+    },
+    [ts8.SyntaxKind.ImportDeclaration]: (node, context) => isEditorFactoryOnlyImport(node) ? [] : context.superTransformStatements(node)
+  }
+};
+
 // src/transpile.ts
 import { readdirSync, readFileSync } from "node:fs";
 import { createRequire } from "node:module";
@@ -539,17 +613,17 @@ import * as path from "node:path";
 import * as tstl2 from "typescript-to-lua";
 
 // src/go-property-direct-call.ts
-import * as ts8 from "typescript";
+import * as ts9 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 (ts8.isCallExpression(node) && ts8.isPropertyAccessExpression(node.expression) && node.expression.name.text === "property" && ts8.isIdentifier(node.expression.expression) && node.expression.expression.text === "go") {
+    if (ts9.isCallExpression(node) && ts9.isPropertyAccessExpression(node.expression) && node.expression.name.text === "property" && ts9.isIdentifier(node.expression.expression) && node.expression.expression.text === "go") {
       calls.push(node);
     }
-    ts8.forEachChild(node, visit);
+    ts9.forEachChild(node, visit);
   };
-  ts8.forEachChild(sourceFile, visit);
+  ts9.forEachChild(sourceFile, visit);
   return calls;
 }
 
@@ -600,10 +674,13 @@ function buildAmbientFiles() {
     "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/editor.ts": readAmbient("src/editor.ts"),
     "node_modules/@defold-typescript/types/src/timers.d.ts": readAmbient("src/timers.d.ts"),
     "node_modules/@defold-typescript/types/index.ts": [
       'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";',
       'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks, ScriptProperties, ScriptProperty } from "./src/lifecycle";',
+      'export { defineEditorScript } from "./src/editor";',
+      'export type { EditorCommand, EditorScriptModule } from "./src/editor";',
       'export type { Hash, Matrix4, Quaternion, Url, Vector, Vector3, Vector4 } from "./src/core-types";',
       ""
     ].join(`
@@ -705,6 +782,7 @@ function transpileProject(input) {
     noImplicitSelf: true,
     luaPlugins: [
       { plugin: lifecycleErasurePlugin },
+      { plugin: editorScriptErasurePlugin },
       { plugin: messageGuardLoweringPlugin },
       { plugin: windowEventGuardLoweringPlugin },
       { plugin: messageDispatchLoweringPlugin },
@@ -732,6 +810,7 @@ var COMPILER_OPTIONS = {
   noImplicitSelf: true,
   luaPlugins: [
     { plugin: lifecycleErasurePlugin },
+    { plugin: editorScriptErasurePlugin },
     { plugin: messageGuardLoweringPlugin },
     { plugin: windowEventGuardLoweringPlugin },
     { plugin: messageDispatchLoweringPlugin },
@@ -776,7 +855,7 @@ function createTranspileSession() {
       if (cached) {
         return cached;
       }
-      const created = ts9.createSourceFile(fileName, content, ts9.ScriptTarget.Latest, false);
+      const created = ts10.createSourceFile(fileName, content, ts10.ScriptTarget.Latest, false);
       sourceFileCache.set(normalized, created);
       return created;
     }
@@ -795,7 +874,7 @@ function createTranspileSession() {
         return cached;
       }
       const fileContent = readFileSync2(filePath, "utf8");
-      const created = ts9.createSourceFile(filePath, fileContent, ts9.ScriptTarget.Latest, false);
+      const created = ts10.createSourceFile(filePath, fileContent, ts10.ScriptTarget.Latest, false);
       libCache.set(fileName, created);
       return created;
     }
@@ -808,10 +887,10 @@ function createTranspileSession() {
     return AMBIENT_FILES[normalized];
   }
   const host = {
-    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts9.sys.fileExists(fileName),
+    fileExists: (fileName) => mergedContent(normalizeSlashes(fileName)) !== undefined || ts10.sys.fileExists(fileName),
     getCanonicalFileName: (fileName) => fileName,
     getCurrentDirectory: () => "",
-    getDefaultLibFileName: ts9.getDefaultLibFileName,
+    getDefaultLibFileName: ts10.getDefaultLibFileName,
     readFile: () => "",
     getNewLine: () => `
 `,
@@ -832,15 +911,15 @@ function createTranspileSession() {
     }
     const userKeys = new Set(userFiles.keys());
     const rootNames = [...Object.keys(AMBIENT_FILES).map(normalizeSlashes), ...userKeys];
-    program = ts9.createProgram(rootNames, COMPILER_OPTIONS, host, program);
-    const preEmitDiagnostics = ts9.getPreEmitDiagnostics(program);
+    program = ts10.createProgram(rootNames, COMPILER_OPTIONS, host, program);
+    const preEmitDiagnostics = ts10.getPreEmitDiagnostics(program);
     const collector = createOutputCollector();
     const { diagnostics: transpileDiagnostics } = new tstl3.Transpiler().emit({
       program,
       writeFile: collector.writeFile
     });
     const diagnostics = [
-      ...ts9.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
+      ...ts10.sortAndDeduplicateDiagnostics([...preEmitDiagnostics, ...transpileDiagnostics])
     ];
     return collectOutputs(collector.files, diagnostics, userKeys);
   }

package/package.json

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

package/src/editor-script-erasure.ts

@@ -0,0 +1,102 @@
+import * as ts from "typescript";
+import {
+  createReturnStatement,
+  type Plugin,
+  type Statement,
+  type TransformationContext,
+} from "typescript-to-lua";
+
+export const EDITOR_FACTORY_MODULE = "@defold-typescript/types";
+export const EDITOR_FACTORY_NAME = "defineEditorScript";
+// Only the bare main entry for now; the walled `@defold-typescript/types/editor-script`
+// subpath import arrives with the per-kind editor wall (a deferred slice).
+const EDITOR_FACTORY_SPECIFIERS = new Set([EDITOR_FACTORY_MODULE]);
+
+function resolvesToEditorFactoryExport(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() !== EDITOR_FACTORY_NAME) {
+    return false;
+  }
+  const declaration = symbol.valueDeclaration ?? symbol.declarations?.[0];
+  if (declaration === undefined) {
+    return false;
+  }
+  return declaration.getSourceFile().fileName.includes(EDITOR_FACTORY_MODULE);
+}
+
+// Unlike the runtime kinds (lowered to flat top-level lifecycle globals), the
+// editor loads the chunk and uses its return value, so the hooks table must be
+// the chunk's return. Unwrap `defineEditorScript(OBJ)` and emit `return OBJ`
+// directly — not `export default`, whose TSTL lowering returns `{ default = OBJ }`.
+function lowerEditorFactoryCall(
+  expression: ts.Expression,
+  context: TransformationContext,
+): Statement[] | undefined {
+  if (!ts.isCallExpression(expression)) {
+    return undefined;
+  }
+  if (!resolvesToEditorFactoryExport(expression.expression, context.checker)) {
+    return undefined;
+  }
+  const module = expression.arguments[0];
+  if (module === undefined) {
+    return undefined;
+  }
+  return [createReturnStatement([context.transformExpression(module)])];
+}
+
+export function isEditorFactoryOnlyImport(node: ts.ImportDeclaration): boolean {
+  if (
+    !ts.isStringLiteral(node.moduleSpecifier) ||
+    !EDITOR_FACTORY_SPECIFIERS.has(node.moduleSpecifier.text)
+  ) {
+    return false;
+  }
+  const clause = node.importClause;
+  if (clause === undefined || clause.name !== undefined) {
+    return false;
+  }
+  // A whole-clause `import type { ... }` binds nothing at runtime; leave it for
+  // the normal transform, which elides it.
+  if (clause.isTypeOnly) {
+    return false;
+  }
+  const bindings = clause.namedBindings;
+  if (bindings === undefined || !ts.isNamedImports(bindings)) {
+    return false;
+  }
+  // Type-only specifiers ride along and drop with the erased statement; erase
+  // only when every runtime specifier is the editor factory itself.
+  const runtime = bindings.elements.filter((element) => !element.isTypeOnly);
+  if (runtime.length === 0) {
+    return false;
+  }
+  return runtime.every(
+    (element) => (element.propertyName ?? element.name).text === EDITOR_FACTORY_NAME,
+  );
+}
+
+// The editor-factory recognition is disjoint from the runtime factories, so this
+// plugin composes with `lifecycleErasurePlugin` in either order: each visitor
+// lowers its own kind and delegates the rest via `superTransformStatements`.
+export const editorScriptErasurePlugin: Plugin = {
+  visitors: {
+    [ts.SyntaxKind.ExportAssignment]: (node, context) => {
+      if (!node.isExportEquals) {
+        const lowered = lowerEditorFactoryCall(node.expression, context);
+        if (lowered !== undefined) {
+          return lowered;
+        }
+      }
+      return context.superTransformStatements(node);
+    },
+    [ts.SyntaxKind.ImportDeclaration]: (node, context) =>
+      isEditorFactoryOnlyImport(node) ? [] : context.superTransformStatements(node),
+  },
+};

package/src/session.ts

@@ -3,6 +3,7 @@ import { createRequire } from "node:module";
 import * as path from "node:path";
 import * as ts from "typescript";
 import * as tstl from "typescript-to-lua";
+import { editorScriptErasurePlugin } from "./editor-script-erasure";
 import { lifecycleErasurePlugin } from "./lifecycle-erasure";
 import { messageDispatchLoweringPlugin } from "./message-dispatch-lowering";
 import { messageGuardLoweringPlugin } from "./message-guard-lowering";
@@ -32,6 +33,7 @@ const COMPILER_OPTIONS: tstl.CompilerOptions = {
   noImplicitSelf: true,
   luaPlugins: [
     { plugin: lifecycleErasurePlugin },
+    { plugin: editorScriptErasurePlugin },
     { plugin: messageGuardLoweringPlugin },
     { plugin: windowEventGuardLoweringPlugin },
     { plugin: messageDispatchLoweringPlugin },

package/src/transpile.ts

@@ -3,6 +3,7 @@ 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 { editorScriptErasurePlugin } from "./editor-script-erasure";
 import {
   findDirectGoPropertyCalls,
   GO_PROPERTY_DIRECT_CALL_MESSAGE,
@@ -128,6 +129,9 @@ function buildAmbientFiles(): Record<string, string> {
       "src/message-dispatch.d.ts",
     ),
     "node_modules/@defold-typescript/types/src/lifecycle.ts": readAmbient("src/lifecycle.ts"),
+    // The editor-script factory + hook types. A `.ts` (not `.d.ts`), so it needs
+    // explicit seeding like lifecycle.ts — the `src/*.d.ts` loop below skips it.
+    "node_modules/@defold-typescript/types/src/editor.ts": readAmbient("src/editor.ts"),
     // Ambient `declare module "@defold-typescript/types/timers"` so user code
     // type-resolves the polyfill import in the virtual program; the lowering
     // rewrites the specifier to a flat require at emit.
@@ -137,6 +141,8 @@ function buildAmbientFiles(): Record<string, string> {
     "node_modules/@defold-typescript/types/index.ts": [
       'export { defineGuiScript, defineRenderScript, defineScript } from "./src/lifecycle";',
       'export type { GuiScriptHooks, InputAction, InputTouch, RenderScriptHooks, ScriptHooks, ScriptProperties, ScriptProperty } from "./src/lifecycle";',
+      'export { defineEditorScript } from "./src/editor";',
+      'export type { EditorCommand, EditorScriptModule } from "./src/editor";',
       'export type { Hash, Matrix4, Quaternion, Url, Vector, Vector3, Vector4 } from "./src/core-types";',
       "",
     ].join("\n"),
@@ -282,6 +288,7 @@ export function transpileProject(input: TranspileProjectInput): TranspileProject
     noImplicitSelf: true,
     luaPlugins: [
       { plugin: lifecycleErasurePlugin },
+      { plugin: editorScriptErasurePlugin },
       { plugin: messageGuardLoweringPlugin },
       { plugin: windowEventGuardLoweringPlugin },
       { plugin: messageDispatchLoweringPlugin },