xray16 1.3.4 → 1.5.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 stalker-xrts
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 stalker-xrts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,106 +1,112 @@
-# [📡 XRay-16 engine typescript definitions](https://github.com/xray-forge/xray-16-types)
-
-[![types](https://img.shields.io/badge/docs-types-blue.svg?style=flat)](https://xray-forge.github.io/xray-16-types/index.html)
-[![book](https://img.shields.io/badge/docs-book-blue.svg?style=flat)](https://xray-forge.github.io/stalker-xrf-book)
-<br/>
-[![Node.js CI](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml)
-
-X-Ray16 engine bindings documentation and types. <br/>
-For usage with [TypeScriptToLua](https://typescripttolua.github.io/docs/getting-started).
-
-<p>
-Module contains xray engine globals typedefs for typescript. <br/>
-By default x-ray export many bindings that can be used from lua scripts, but without game API documentation.
-
-To check more details / correct typing you always can reference X-Ray source code.
-
-</p>
-
-## 🗻 Docs
-
-Types documentation can be checked [here](https://xray-forge.github.io/xray-16-types/modules.html).
-
-## 🧱 Usage
-
-Types are used with [xrf template](https://github.com/xray-forge/stalker-xrf-engine) and can be referenced as an example.
-
-## 🎮 Updating types
-
-For easier navigation over codebase and typing following rules are applied:
-
-- Type declaration should have \@source docblock with matching c++ counterpart signature
-- Variable and class namings follow c++ conventions for easier binding and matching engine codebase
-- XRay types should be prefixed with IXR or TXR if they do not have runtime representation
-
-## 📦Extending C++ classes and overriding virtual methods
-
-### Lua
-
-<p>
-C++ classes can be extended in Lua code with 'class' keyword. 
-Class declaration registers table as userdata and adds constructor/destructor metamethods. <br/>
-</p>
-
-### Typescript
-
-<p>
-In TS codebase 'LuabindClass' decorator can be used to modify transformation and enable virtual calls. <br/>
-Separate transformer is needed to build luabind classes instead of table-based classes.
-</p>
-
-## 🧱 Getting up-to-date LUA bindings
-
-- Run game engine with `-dump_bindings` flag
-- Check userdata folder _(where game saves are stored)_ `scriptbindings_*.txt` files
-
-## 🧲 References
-
-- X-Ray C++ source code
-- LuaBind sources and docs
-- LuaJit sources and docs
-
-## 🧱 Plugins
-
-Package includes plugins for typescript-to-lua for easier work with xray16 typings. <br/>
-Following ones are available:
-
-- transform_luabind_class - transforms LuaBind decorated classes in a specific way
-- built_at_info - adds build information in resulting files
-- from_cast_utils - additional utils that should be removed in runtime
-- global_declarations_transform - transforms xray16 imports and removes them from runtime
-- inject_filename - adds $filename global variable to access current file name
-- strip_lua_logger - removes lua logger from runtime (if path param is provided or ENV variable is set)
-- inject_tracy_zones - removes lua logger from runtime (if path param is provided or ENV variable is set)
-
-Path params:
-
-- `--no-lua-logs`
-- `--inject-tracy-zones`
-
-Env variables:
-
-- `XR_NO_LUA_LOGS `
-- `XR_INJECT_TRACY_ZONES `
-
-export const IS_LUA_LOGGER_DISABLED: boolean = process.argv.includes("--no-lua-logs")
-|| process.env.NO_LUA_LOGS === "true";
-export const IS_TRACY_ZONES_INJECTION_ENABLED: boolean = process.argv.includes("--inject-tracy-zones")
-|| process.env.INJECT_TRACY_ZONES === "true";
-
-Plugins can be included in tsconfig file as following:
-
-```json
-{
-  "tstl": {
-    "luaPlugins": [
-      { "name": "xray16/plugins/transform_luabind_class/plugin" },
-      { "name": "xray16/plugins/global_declarations_transform" },
-      { "name": "xray16/plugins/built_at_info" },
-      { "name": "xray16/plugins/strip_lua_logger" },
-      { "name": "xray16/plugins/inject_filename" },
-      { "name": "xray16/plugins/from_cast_utils" },
-      { "name": "xray16/plugins/inject_tracy_zones" }
-    ]
-  }
-}
-```
+# [📡 XRay-16 engine typescript definitions](https://github.com/xray-forge/xray-16-types)
+
+[![types](https://img.shields.io/badge/docs-types-blue.svg?style=flat)](https://xray-forge.github.io/xray-16-types/index.html)
+[![book](https://img.shields.io/badge/docs-book-blue.svg?style=flat)](https://xray-forge.github.io/stalker-xrf-book)
+<br/>
+[![Node.js CI](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml)
+
+X-Ray16 engine bindings documentation and types. <br/>
+For usage with [TypeScriptToLua](https://typescripttolua.github.io/docs/getting-started).
+
+<p>
+Module contains xray engine globals typedefs for typescript. <br/>
+By default x-ray export bindings that can be accessed from lua scripts, but without any API documentation.
+
+To check more details / correct typing you always can reference X-Ray source code.
+
+</p>
+
+## 🗻 Docs
+
+Types documentation can be checked [here](https://xray-forge.github.io/xray-16-types/modules.html).
+
+## 🧱 Usage
+
+Types are used with [xrf template](https://github.com/xray-forge/stalker-xrf-engine) and can be referenced as an example.
+
+## 📦Extending C++ classes and overriding virtual methods
+
+### Lua
+
+<p>
+C++ classes can be extended in Lua code with 'class' keyword. 
+Class declaration registers table as userdata and adds constructor/destructor metamethods. <br/>
+</p>
+
+### Typescript
+
+<p>
+In TS codebase 'LuabindClass' decorator can be used to modify transformation and enable virtual calls. <br/>
+Separate transformer is needed to build luabind classes instead of table-based classes.
+</p>
+
+## 🧱 Getting up-to-date LUA bindings
+
+- Run game engine with `-dump_bindings` flag
+- Check userdata folder _(where game saves are stored)_ `scriptbindings_*.txt` files
+
+## 🧲 Plugins
+
+Package includes plugins for typescript-to-lua for easier work with xray16 typings.\
+Plugins can be included in [tstl tsconfig](https://typescripttolua.github.io/docs/configuration) file as following section:
+
+```json
+{
+  "tstl": {
+    "luaPlugins": [
+      { "name": "xray16/plugins/transform_luabind_class/plugin" },
+      { "name": "xray16/plugins/global_declarations_transform" },
+      { "name": "xray16/plugins/built_at_info" },
+      { "name": "xray16/plugins/strip_lua_logger" },
+      { "name": "xray16/plugins/inject_filename" },
+      { "name": "xray16/plugins/from_cast_utils" },
+      { "name": "xray16/plugins/inject_tracy_zones" }
+    ]
+  }
+}
+```
+
+Arguments for TSTL:
+
+- `--no-lua-logs`
+- `--inject-tracy-zones`
+
+Env variables for custom CLI scripts:
+
+- `XR_NO_LUA_LOGS`
+- `XR_INJECT_TRACY_ZONES `
+
+### transform_luabind_class
+
+Custom plugin overriding transformation of classes marked with `@LuaClass` decorator.\
+Instead of using prototypes and metatables use luabind API to declare such classes.\
+
+### built_at_info
+
+Plugin injecting time and generic metadata on top of built lua scripts.
+
+### global_declarations_transform
+
+Plugin stripping all the runtime imports from `xray16` package.
+Default `tstl` behaviour does not work well with engine imports and I tried to avoid implicit globals.
+
+### strip_lua_logger
+
+Plugin to strip all `LuaLogger` calls from runtime if env variable is set or path param is provided.\
+Logger can consume a lot of processing time that does not benefit player.
+
+### inject_filename
+
+Plugin adding `$filename` global variable replaced with actual file name on build time.\
+Lua does not provide convenient API do get filename in runtime and static step is much simpler.
+
+### from_cast_utils
+
+Plugin to simplify casting from `LuaTable` to typescript array/map objects.\
+All the calls are completely gets stripped and removed from runtime.
+
+### from_cast_utils
+
+Plugin designed to work specifically with [tracy profiler](https://github.com/wolfpld/tracy).\
+Once it is enabled with env variable or path parameter, tracy zone marking calls are injected for every method.\
+This way you will be able to build profiling bundle to understand bottlenecks and what takes CPU time.

package/package.json

@@ -1,42 +1,45 @@
-{
-  "name": "xray16",
-  "version": "1.3.4",
-  "author": "Neloreck",
-  "repository": "https://github.com/stalker-xrts/xray-16-types",
-  "private": false,
-  "main": "types/index.d.ts",
-  "types": "types/index.d.ts",
-  "scripts": {
-    "prepublish": "npm run build:plugins",
-    "build:plugins": "tsc -p ./src/tsconfig.json",
-    "build:types": "typedoc",
-    "typecheck": "tsc --noEmit",
-    "typedoc": "typedoc",
-    "format": "prettier --write \"**/*.(js|ts|tsx|md)\" && eslint . --ext .ts,.tsx,.js --fix",
-    "lint": "eslint . --ext .ts,.tsx,.js"
-  },
-  "peerDependencies": {
-    "typescript-to-lua": "^1.28.1"
-  },
-  "devDependencies": {
-    "@types/node": "22.10.2",
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "@typescript-eslint/parser": "^5.54.0",
-    "@typescript-to-lua/language-extensions": "1.0.0",
-    "eslint": "^8.49.0",
-    "eslint-config-standard-with-typescript": "^34.0.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^46.8.0",
-    "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "prettier": "^3.4.2",
-    "typedoc": "^0.27.5",
-    "typescript": "^5.7.2"
-  },
-  "files": [
-    "plugins/**/*",
-    "types/**/*",
-    "README.md",
-    "LICENSE"
-  ]
-}
+{
+  "name": "xray16",
+  "version": "1.5.0",
+  "author": "Neloreck",
+  "repository": "https://github.com/xray-forge/xray-16-types",
+  "private": false,
+  "main": "types/index.d.ts",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "prepublish": "npm run build:plugins",
+    "build:plugins": "tsc -p ./src/tsconfig.json",
+    "build:types": "typedoc",
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc",
+    "format": "prettier --write \"**/*.(js|ts|tsx|md)\" && eslint . --fix",
+    "lint": "eslint ."
+  },
+  "peerDependencies": {
+    "typescript-to-lua": "^1.28.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.4",
+    "@types/node": "22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.62.0",
+    "@typescript-eslint/parser": "^8.62.0",
+    "@typescript-to-lua/language-extensions": "1.0.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.15.2",
+    "eslint-plugin-jsdoc": "^63.0.7",
+    "globals": "^17.7.0",
+    "prettier": "^3.4.2",
+    "typedoc": "^0.27.5",
+    "typescript": "5.7.2",
+    "typescript-eslint": "^8.62.0",
+    "typescript-to-lua": "1.28.1"
+  },
+  "files": [
+    "plugins/**/*",
+    "types/**/*",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/plugins/built_at_info.d.ts

@@ -1,3 +1,3 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 declare const plugin: Plugin;
 export default plugin;

package/plugins/from_cast_utils.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin for transformation of casting methods.
  * Simplifies TS/Lua testing and interoperation.

package/plugins/global_declarations_transform.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin that removes imports from 'global' libraries like engine typedefs.
  */

package/plugins/inject_file_meta.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin that injects FILE_NAME in compile-time.
  */

package/plugins/inject_tracy_zones.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin that injects FILE_NAME in compile-time.
  */

package/plugins/inject_tracy_zones.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
 const typescript_1 = require("typescript");
-const tracy_1 = require("./utils/tracy");
+const sourceFile_1 = require("typescript-to-lua/dist/transformation/visitors/sourceFile");
 const ast_1 = require("./utils/ast");
 const environment_1 = require("./utils/environment");
-const sourceFile_1 = require("typescript-to-lua/dist/transformation/visitors/sourceFile");
+const tracy_1 = require("./utils/tracy");
 /**
  * Plugin that injects FILE_NAME in compile-time.
  */

package/plugins/strip_lua_logger.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin that removes all LuaLogger instance creations and calls when possible.
  */

package/plugins/strip_lua_logger.js

@@ -17,7 +17,7 @@ const plugin = {
                     const checker = context.program.getTypeChecker();
                     const typeSymbol = checker.getTypeAtLocation(it);
                     if (typeSymbol.symbol?.name === LUA_LOGGER_STRIP_TARGET) {
-                        // nothing
+                        // Nothing
                     }
                     else {
                         nodes.push(it);

package/plugins/transform_luabind_class/plugin.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from "typescript-to-lua";
+import { type Plugin } from "typescript-to-lua";
 /**
  * Plugin that transform TS classes marked with decorator to luabind class declaration.
  */

package/plugins/transform_luabind_class/transformation/class_declaration.d.ts

@@ -1,6 +1,6 @@
-import { ClassLikeDeclaration, ExpressionWithTypeArguments } from "typescript";
+import { type ClassLikeDeclaration, type ExpressionWithTypeArguments } from "typescript";
 import * as tstl from "typescript-to-lua";
-import { TransformationContext } from "typescript-to-lua";
+import { type TransformationContext } from "typescript-to-lua";
 export interface ITransformationContext extends TransformationContext {
     classSuperInfos: Array<ClassSuperInfo>;
 }
@@ -13,6 +13,6 @@ export interface ClassSuperInfo {
     extendedTypeNode?: ExpressionWithTypeArguments;
 }
 export declare function transformClassLikeDeclaration(classDeclaration: ClassLikeDeclaration, context: ITransformationContext, nameOverride?: tstl.Identifier): {
-    statements: tstl.Statement[];
+    statements: Array<tstl.Statement>;
     name: tstl.Identifier;
 };

package/plugins/transform_luabind_class/transformation/decorators.d.ts

@@ -1,6 +1,9 @@
-import { Decorator } from "typescript";
-import { TransformationContext } from "typescript-to-lua";
+import { type Decorator } from "typescript";
+import { type TransformationContext } from "typescript-to-lua";
 /**
  * Transform decorator call expressions for luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param decorator - Class decorator to validate.
  */
 export declare function checkLuabindClassDecoratorExpression(context: TransformationContext, decorator: Decorator): void;

package/plugins/transform_luabind_class/transformation/decorators.js

@@ -5,6 +5,9 @@ const constants_1 = require("./constants");
 const errors_1 = require("./errors");
 /**
  * Transform decorator call expressions for luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param decorator - Class decorator to validate.
  */
 function checkLuabindClassDecoratorExpression(context, decorator) {
     const expression = decorator.expression;

package/plugins/transform_luabind_class/transformation/members/accessors.d.ts

@@ -1,3 +1,3 @@
-import { AllAccessorDeclarations, TransformationContext } from "typescript-to-lua";
+import { type AllAccessorDeclarations, type TransformationContext } from "typescript-to-lua";
 import * as lua from "typescript-to-lua";
 export declare function transformAccessorDeclarations(context: TransformationContext, { firstAccessor, getAccessor, setAccessor }: AllAccessorDeclarations, className: lua.Identifier): lua.Statement | undefined;

package/plugins/transform_luabind_class/transformation/members/constructor.d.ts

@@ -1,5 +1,5 @@
-import { ClassLikeDeclaration, ConstructorDeclaration, PropertyDeclaration } from "typescript";
-import { TransformationContext } from "typescript-to-lua";
+import { type ClassLikeDeclaration, type ConstructorDeclaration, type PropertyDeclaration } from "typescript";
+import { type TransformationContext } from "typescript-to-lua";
 import * as lua from "typescript-to-lua";
 export declare function createConstructorName(className: lua.Identifier): lua.TableIndexExpression;
 export declare function transformConstructorDeclaration(context: TransformationContext, statement: ConstructorDeclaration, className: lua.Identifier, instanceFields: Array<PropertyDeclaration>, classDeclaration: ClassLikeDeclaration): lua.Statement | undefined;

package/plugins/transform_luabind_class/transformation/members/constructor.js

@@ -45,11 +45,11 @@ function transformConstructorDeclaration(context, statement, className, instance
     // Add in instance field declarations
     for (const declaration of constructorFieldsDeclarations) {
         if ((0, typescript_1.isIdentifier)(declaration.name)) {
-            // self.declarationName = declarationName
+            // Self.declarationName = declarationName
             const assignment = lua.createAssignmentStatement(lua.createTableIndexExpression((0, lua_ast_1.createSelfIdentifier)(), lua.createStringLiteral(declaration.name.text)), (0, identifier_1.transformIdentifier)(context, declaration.name));
             bodyWithFieldInitializers.push(assignment);
         }
-        // else { TypeScript error: A parameter property may not be declared using a binding pattern }
+        // Else { TypeScript error: A parameter property may not be declared using a binding pattern }
     }
     bodyWithFieldInitializers.push(...classInstanceFields);
     bodyWithFieldInitializers.push(...body);

package/plugins/transform_luabind_class/transformation/members/fields.d.ts

@@ -1,8 +1,11 @@
-import { AccessorDeclaration, PropertyDeclaration } from "typescript";
-import { TransformationContext } from "typescript-to-lua";
+import { type AccessorDeclaration, type PropertyDeclaration } from "typescript";
+import { type TransformationContext } from "typescript-to-lua";
 import * as tstl from "typescript-to-lua";
 /**
  * Verify whether decorators provided for luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class property or accessor to inspect.
  */
 export declare function verifyPropertyDecoratingExpression(context: TransformationContext, node: PropertyDeclaration | AccessorDeclaration): void;
 export declare function transformClassInstanceFields(context: TransformationContext, instanceFields: Array<PropertyDeclaration>): Array<tstl.Statement>;

package/plugins/transform_luabind_class/transformation/members/fields.js

@@ -10,6 +10,9 @@ const literal_1 = require("typescript-to-lua/dist/transformation/visitors/litera
 const errors_1 = require("../errors");
 /**
  * Verify whether decorators provided for luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class property or accessor to inspect.
  */
 function verifyPropertyDecoratingExpression(context, node) {
     if (!(0, typescript_1.canHaveDecorators)(node))
@@ -28,9 +31,9 @@ function transformClassInstanceFields(context, instanceFields) {
             // Get identifier
             const fieldName = (0, literal_1.transformPropertyName)(context, f.name);
             const value = f.initializer ? context.transformExpression(f.initializer) : undefined;
-            // self[fieldName]
+            // Self[fieldName]
             const selfIndex = tstl.createTableIndexExpression((0, lua_ast_1.createSelfIdentifier)(), fieldName);
-            // self[fieldName] = value
+            // Self[fieldName] = value
             const assignClassField = tstl.createAssignmentStatement(selfIndex, value, f);
             return assignClassField;
         });

package/plugins/transform_luabind_class/transformation/members/method.d.ts

@@ -1,10 +1,13 @@
-import { AccessorDeclaration, MethodDeclaration, PropertyDeclaration } from "typescript";
-import { TransformationContext } from "typescript-to-lua";
+import { type AccessorDeclaration, type MethodDeclaration, type PropertyDeclaration } from "typescript";
+import { type TransformationContext } from "typescript-to-lua";
 import * as lua from "typescript-to-lua";
 export declare function transformMemberExpressionOwnerName(node: PropertyDeclaration | MethodDeclaration | AccessorDeclaration, className: lua.Identifier): lua.Expression;
 export declare function transformMethodName(context: TransformationContext, node: MethodDeclaration): lua.Expression;
 export declare function transformMethodDeclaration(context: TransformationContext, node: MethodDeclaration, className: lua.Identifier): lua.Statement | undefined;
 /**
- * Verify that method statement is not using decorators for methods/parameters.
+ * Verify that a method does not use method or parameter decorators.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class method to inspect.
  */
 export declare function verifyMethodDecoratingExpression(context: TransformationContext, node: MethodDeclaration): void;

package/plugins/transform_luabind_class/transformation/members/method.js

@@ -35,7 +35,10 @@ function transformMethodDeclaration(context, node, className) {
     return lua.createAssignmentStatement(lua.createTableIndexExpression(methodTable, methodName), functionExpression, node);
 }
 /**
- * Verify that method statement is not using decorators for methods/parameters.
+ * Verify that a method does not use method or parameter decorators.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class method to inspect.
  */
 function verifyMethodDecoratingExpression(context, node) {
     node.parameters.flatMap((parameter, index) => {

package/plugins/transform_luabind_class/transformation/new.d.ts

@@ -1,7 +1,11 @@
-import { NewExpression } from "typescript";
+import { type NewExpression } from "typescript";
 import * as tstl from "typescript-to-lua";
-import { ITransformationContext } from "./index";
+import { type ITransformationContext } from "./index";
 /**
- * Transform new call for luabind class as ClassConstructor() instead of TS_NEW from tstl.
+ * Transform a new expression into a luabind constructor call.
+ *
+ * @param expression - New expression to transform.
+ * @param context - Active transformation context.
+ * @returns Lua call expression for the class constructor.
  */
 export declare function transformNewCallExpression(expression: NewExpression, context: ITransformationContext): tstl.CallExpression;

package/plugins/transform_luabind_class/transformation/new.js

@@ -4,7 +4,11 @@ exports.transformNewCallExpression = transformNewCallExpression;
 const tstl = require("typescript-to-lua");
 const call_1 = require("typescript-to-lua/dist/transformation/visitors/call");
 /**
- * Transform new call for luabind class as ClassConstructor() instead of TS_NEW from tstl.
+ * Transform a new expression into a luabind constructor call.
+ *
+ * @param expression - New expression to transform.
+ * @param context - Active transformation context.
+ * @returns Lua call expression for the class constructor.
  */
 function transformNewCallExpression(expression, context) {
     return tstl.createCallExpression(context.transformExpression(expression.expression), (0, call_1.transformArguments)(context, expression.arguments ?? []));

package/plugins/transform_luabind_class/transformation/setup.d.ts

@@ -1,8 +1,14 @@
-import { ClassLikeDeclarationBase } from "typescript";
+import { type ClassLikeDeclarationBase } from "typescript";
 import * as tstl from "typescript-to-lua";
-import { TransformationContext } from "typescript-to-lua";
+import { type TransformationContext } from "typescript-to-lua";
 /**
- * Create full class setup statement with name/super calls/methods/declaration/fields etc.
+ * Build the full set of statements that define a luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param statement - Class declaration being transformed.
+ * @param className - Exported class identifier.
+ * @param localClassName - Local class identifier.
+ * @returns Lua statements that set up the class.
  */
 export declare function createClassSetup(context: TransformationContext, statement: ClassLikeDeclarationBase, className: tstl.Identifier, localClassName: tstl.Identifier): tstl.Statement[];
 export declare function getReflectionClassName(declaration: ClassLikeDeclarationBase, className: tstl.Identifier): tstl.Expression;