typescript-to-lua 1.6.2 → 1.7.1

package/language-extensions/index.d.ts

@@ -3,12 +3,24 @@ type AnyTable = Record<any, any>;
 type AnyNotNil = {};
 
 /**
- * Indicates a type is a language extension provided by TypescriptToLua.
+ * Indicates a type is a language extension provided by TypescriptToLua when used as a value or function call.
  * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
  *
  * @param TBrand A string used to uniquely identify the language extension type
  */
-declare type LuaExtension<TBrand extends string> = { [T in TBrand]: { readonly __luaExtensionSymbol: unique symbol } };
+declare interface LuaExtension<TBrand extends string> {
+    readonly __tstlExtension: TBrand;
+}
+
+/**
+ * Indicates a type is a language extension provided by TypescriptToLua when used in a for-of loop.
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ *
+ * @param TBrand A string used to uniquely identify the language extension type
+ */
+declare interface LuaIterationExtension<TBrand extends string> {
+    readonly __tstlIterable: TBrand;
+}
 
 /**
  * Returns multiple values from a function, by wrapping them in a LuaMultiReturn tuple.
@@ -17,7 +29,7 @@ declare type LuaExtension<TBrand extends string> = { [T in TBrand]: { readonly _
  * @param T A tuple type with each element type representing a return value's type.
  * @param values Return values.
  */
-declare const $multi: (<T extends any[]>(...values: T) => LuaMultiReturn<T>) & LuaExtension<"__luaMultiFunctionBrand">;
+declare const $multi: (<T extends any[]>(...values: T) => LuaMultiReturn<T>) & LuaExtension<"MultiFunction">;
 
 /**
  * Represents multiple return values as a tuple.
@@ -25,7 +37,9 @@ declare const $multi: (<T extends any[]>(...values: T) => LuaMultiReturn<T>) & L
  *
  * @param T A tuple type with each element type representing a return value's type.
  */
-declare type LuaMultiReturn<T extends any[]> = T & LuaExtension<"__luaMultiReturnBrand">;
+declare type LuaMultiReturn<T extends any[]> = T & {
+    readonly __tstlMultiReturn: any;
+};
 
 /**
  * Creates a Lua-style numeric for loop (for i=start,limit,step) when used in for...of. Not valid in any other context.
@@ -36,13 +50,13 @@ declare type LuaMultiReturn<T extends any[]> = T & LuaExtension<"__luaMultiRetur
  * @param step The amount to increment each iteration.
  */
 declare const $range: ((start: number, limit: number, step?: number) => Iterable<number>) &
-    LuaExtension<"__luaRangeFunctionBrand">;
+    LuaExtension<"RangeFunction">;
 
 /**
  * Transpiles to the global vararg (`...`)
  * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
  */
-declare const $vararg: string[] & LuaExtension<"__luaVarargConstantBrand">;
+declare const $vararg: string[] & LuaExtension<"VarargConstant">;
 
 /**
  * Represents a Lua-style iterator which is returned from a LuaIterable.
@@ -76,7 +90,7 @@ declare type LuaIterator<TValue, TState> = TState extends undefined
  */
 declare type LuaIterable<TValue, TState = undefined> = Iterable<TValue> &
     LuaIterator<TValue, TState> &
-    LuaExtension<"__luaIterableBrand">;
+    LuaIterationExtension<"Iterable">;
 
 /**
  * Represents an object that can be iterated with pairs()
@@ -86,7 +100,14 @@ declare type LuaIterable<TValue, TState = undefined> = Iterable<TValue> &
  * @param TValue The type of the value returned each iteration.
  */
 declare type LuaPairsIterable<TKey extends AnyNotNil, TValue> = Iterable<[TKey, TValue]> &
-    LuaExtension<"__luaPairsIterableBrand">;
+    LuaIterationExtension<"Pairs">;
+
+/**
+ * Represents an object that can be iterated with pairs(), where only the key value is used.
+ *
+ * @param TKey The type of the key returned each iteration.
+ */
+declare type LuaPairsKeyIterable<TKey extends AnyNotNil> = Iterable<TKey> & LuaIterationExtension<"PairsKey">;
 
 /**
  * Calls to functions with this type are translated to `left + right`.
@@ -96,8 +117,7 @@ declare type LuaPairsIterable<TKey extends AnyNotNil, TValue> = Iterable<[TKey,
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaAddition<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaAdditionBrand">;
+declare type LuaAddition<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"Addition">;
 
 /**
  * Calls to methods with this type are translated to `left + right`, where `left` is the object with the method.
@@ -106,8 +126,7 @@ declare type LuaAddition<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight)
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaAdditionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaAdditionMethodBrand">;
+declare type LuaAdditionMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"AdditionMethod">;
 
 /**
  * Calls to functions with this type are translated to `left - right`.
@@ -118,7 +137,7 @@ declare type LuaAdditionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaSubtraction<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaSubtractionBrand">;
+    LuaExtension<"Subtraction">;
 
 /**
  * Calls to methods with this type are translated to `left - right`, where `left` is the object with the method.
@@ -127,8 +146,7 @@ declare type LuaSubtraction<TLeft, TRight, TReturn> = ((left: TLeft, right: TRig
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaSubtractionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaSubtractionMethodBrand">;
+declare type LuaSubtractionMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"SubtractionMethod">;
 
 /**
  * Calls to functions with this type are translated to `left * right`.
@@ -139,7 +157,7 @@ declare type LuaSubtractionMethod<TRight, TReturn> = ((right: TRight) => TReturn
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaMultiplication<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaMultiplicationBrand">;
+    LuaExtension<"Multiplication">;
 
 /**
  * Calls to methods with this type are translated to `left * right`, where `left` is the object with the method.
@@ -149,7 +167,7 @@ declare type LuaMultiplication<TLeft, TRight, TReturn> = ((left: TLeft, right: T
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaMultiplicationMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaMultiplicationMethodBrand">;
+    LuaExtension<"MultiplicationMethod">;
 
 /**
  * Calls to functions with this type are translated to `left / right`.
@@ -159,8 +177,7 @@ declare type LuaMultiplicationMethod<TRight, TReturn> = ((right: TRight) => TRet
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaDivision<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaDivisionBrand">;
+declare type LuaDivision<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"Division">;
 
 /**
  * Calls to methods with this type are translated to `left / right`, where `left` is the object with the method.
@@ -169,8 +186,7 @@ declare type LuaDivision<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight)
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaDivisionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaDivisionMethodBrand">;
+declare type LuaDivisionMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"DivisionMethod">;
 
 /**
  * Calls to functions with this type are translated to `left % right`.
@@ -180,8 +196,7 @@ declare type LuaDivisionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaModulo<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaModuloBrand">;
+declare type LuaModulo<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"Modulo">;
 
 /**
  * Calls to methods with this type are translated to `left % right`, where `left` is the object with the method.
@@ -190,7 +205,7 @@ declare type LuaModulo<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) =
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaModuloMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"__luaModuloMethodBrand">;
+declare type LuaModuloMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"ModuloMethod">;
 
 /**
  * Calls to functions with this type are translated to `left ^ right`.
@@ -200,8 +215,7 @@ declare type LuaModuloMethod<TRight, TReturn> = ((right: TRight) => TReturn) & L
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaPower<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaPowerBrand">;
+declare type LuaPower<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"Power">;
 
 /**
  * Calls to methods with this type are translated to `left ^ right`, where `left` is the object with the method.
@@ -210,7 +224,7 @@ declare type LuaPower<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) =>
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaPowerMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"__luaPowerMethodBrand">;
+declare type LuaPowerMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"PowerMethod">;
 
 /**
  * Calls to functions with this type are translated to `left // right`.
@@ -221,7 +235,7 @@ declare type LuaPowerMethod<TRight, TReturn> = ((right: TRight) => TReturn) & Lu
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaFloorDivision<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaFloorDivisionBrand">;
+    LuaExtension<"FloorDivision">;
 
 /**
  * Calls to methods with this type are translated to `left // right`, where `left` is the object with the method.
@@ -231,7 +245,7 @@ declare type LuaFloorDivision<TLeft, TRight, TReturn> = ((left: TLeft, right: TR
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaFloorDivisionMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaFloorDivisionMethodBrand">;
+    LuaExtension<"FloorDivisionMethod">;
 
 /**
  * Calls to functions with this type are translated to `left & right`.
@@ -242,7 +256,7 @@ declare type LuaFloorDivisionMethod<TRight, TReturn> = ((right: TRight) => TRetu
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseAnd<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseAndBrand">;
+    LuaExtension<"BitwiseAnd">;
 
 /**
  * Calls to methods with this type are translated to `left & right`, where `left` is the object with the method.
@@ -251,8 +265,7 @@ declare type LuaBitwiseAnd<TLeft, TRight, TReturn> = ((left: TLeft, right: TRigh
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaBitwiseAndMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseAndMethodBrand">;
+declare type LuaBitwiseAndMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"BitwiseAndMethod">;
 
 /**
  * Calls to functions with this type are translated to `left | right`.
@@ -263,7 +276,7 @@ declare type LuaBitwiseAndMethod<TRight, TReturn> = ((right: TRight) => TReturn)
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseOr<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseOrBrand">;
+    LuaExtension<"BitwiseOr">;
 
 /**
  * Calls to methods with this type are translated to `left | right`, where `left` is the object with the method.
@@ -272,8 +285,7 @@ declare type LuaBitwiseOr<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaBitwiseOrMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseOrMethodBrand">;
+declare type LuaBitwiseOrMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"BitwiseOrMethod">;
 
 /**
  * Calls to functions with this type are translated to `left ~ right`.
@@ -284,7 +296,7 @@ declare type LuaBitwiseOrMethod<TRight, TReturn> = ((right: TRight) => TReturn)
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseExclusiveOr<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseExclusiveOrBrand">;
+    LuaExtension<"BitwiseExclusiveOr">;
 
 /**
  * Calls to methods with this type are translated to `left ~ right`, where `left` is the object with the method.
@@ -294,7 +306,7 @@ declare type LuaBitwiseExclusiveOr<TLeft, TRight, TReturn> = ((left: TLeft, righ
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseExclusiveOrMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseExclusiveOrMethodBrand">;
+    LuaExtension<"BitwiseExclusiveOrMethod">;
 
 /**
  * Calls to functions with this type are translated to `left << right`.
@@ -305,7 +317,7 @@ declare type LuaBitwiseExclusiveOrMethod<TRight, TReturn> = ((right: TRight) =>
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseLeftShift<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseLeftShiftBrand">;
+    LuaExtension<"BitwiseLeftShift">;
 
 /**
  * Calls to methods with this type are translated to `left << right`, where `left` is the object with the method.
@@ -315,7 +327,7 @@ declare type LuaBitwiseLeftShift<TLeft, TRight, TReturn> = ((left: TLeft, right:
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseLeftShiftMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseLeftShiftMethodBrand">;
+    LuaExtension<"BitwiseLeftShiftMethod">;
 
 /**
  * Calls to functions with this type are translated to `left >> right`.
@@ -326,7 +338,7 @@ declare type LuaBitwiseLeftShiftMethod<TRight, TReturn> = ((right: TRight) => TR
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseRightShift<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseRightShiftBrand">;
+    LuaExtension<"BitwiseRightShift">;
 
 /**
  * Calls to methods with this type are translated to `left >> right`, where `left` is the object with the method.
@@ -336,7 +348,7 @@ declare type LuaBitwiseRightShift<TLeft, TRight, TReturn> = ((left: TLeft, right
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaBitwiseRightShiftMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaBitwiseRightShiftMethodBrand">;
+    LuaExtension<"BitwiseRightShiftMethod">;
 
 /**
  * Calls to functions with this type are translated to `left .. right`.
@@ -346,8 +358,7 @@ declare type LuaBitwiseRightShiftMethod<TRight, TReturn> = ((right: TRight) => T
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaConcat<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaConcatBrand">;
+declare type LuaConcat<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"Concat">;
 
 /**
  * Calls to methods with this type are translated to `left .. right`, where `left` is the object with the method.
@@ -356,7 +367,7 @@ declare type LuaConcat<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) =
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaConcatMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"__luaConcatMethodBrand">;
+declare type LuaConcatMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"ConcatMethod">;
 
 /**
  * Calls to functions with this type are translated to `left < right`.
@@ -366,8 +377,7 @@ declare type LuaConcatMethod<TRight, TReturn> = ((right: TRight) => TReturn) & L
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaLessThan<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaLessThanBrand">;
+declare type LuaLessThan<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) & LuaExtension<"LessThan">;
 
 /**
  * Calls to methods with this type are translated to `left < right`, where `left` is the object with the method.
@@ -376,8 +386,7 @@ declare type LuaLessThan<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight)
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaLessThanMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaLessThanMethodBrand">;
+declare type LuaLessThanMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"LessThanMethod">;
 
 /**
  * Calls to functions with this type are translated to `left > right`.
@@ -388,7 +397,7 @@ declare type LuaLessThanMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
  * @param TReturn The resulting (return) type of the operation.
  */
 declare type LuaGreaterThan<TLeft, TRight, TReturn> = ((left: TLeft, right: TRight) => TReturn) &
-    LuaExtension<"__luaGreaterThanBrand">;
+    LuaExtension<"GreaterThan">;
 
 /**
  * Calls to methods with this type are translated to `left > right`, where `left` is the object with the method.
@@ -397,8 +406,7 @@ declare type LuaGreaterThan<TLeft, TRight, TReturn> = ((left: TLeft, right: TRig
  * @param TRight The type of the right-hand-side of the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaGreaterThanMethod<TRight, TReturn> = ((right: TRight) => TReturn) &
-    LuaExtension<"__luaGreaterThanMethodBrand">;
+declare type LuaGreaterThanMethod<TRight, TReturn> = ((right: TRight) => TReturn) & LuaExtension<"GreaterThanMethod">;
 
 /**
  * Calls to functions with this type are translated to `-operand`.
@@ -407,7 +415,7 @@ declare type LuaGreaterThanMethod<TRight, TReturn> = ((right: TRight) => TReturn
  * @param TOperand The type of the value in the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaNegation<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"__luaNegationBrand">;
+declare type LuaNegation<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"Negation">;
 
 /**
  * Calls to method with this type are translated to `-operand`, where `operand` is the object with the method.
@@ -415,7 +423,7 @@ declare type LuaNegation<TOperand, TReturn> = ((operand: TOperand) => TReturn) &
  *
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaNegationMethod<TReturn> = (() => TReturn) & LuaExtension<"__luaNegationMethodBrand">;
+declare type LuaNegationMethod<TReturn> = (() => TReturn) & LuaExtension<"NegationMethod">;
 
 /**
  * Calls to functions with this type are translated to `~operand`.
@@ -424,7 +432,7 @@ declare type LuaNegationMethod<TReturn> = (() => TReturn) & LuaExtension<"__luaN
  * @param TOperand The type of the value in the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaBitwiseNot<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"__luaBitwiseNotBrand">;
+declare type LuaBitwiseNot<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"BitwiseNot">;
 
 /**
  * Calls to method with this type are translated to `~operand`, where `operand` is the object with the method.
@@ -432,7 +440,7 @@ declare type LuaBitwiseNot<TOperand, TReturn> = ((operand: TOperand) => TReturn)
  *
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaBitwiseNotMethod<TReturn> = (() => TReturn) & LuaExtension<"__luaBitwiseNotMethodBrand">;
+declare type LuaBitwiseNotMethod<TReturn> = (() => TReturn) & LuaExtension<"BitwiseNotMethod">;
 
 /**
  * Calls to functions with this type are translated to `#operand`.
@@ -441,7 +449,7 @@ declare type LuaBitwiseNotMethod<TReturn> = (() => TReturn) & LuaExtension<"__lu
  * @param TOperand The type of the value in the operation.
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaLength<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"__luaLengthBrand">;
+declare type LuaLength<TOperand, TReturn> = ((operand: TOperand) => TReturn) & LuaExtension<"Length">;
 
 /**
  * Calls to method with this type are translated to `#operand`, where `operand` is the object with the method.
@@ -449,7 +457,7 @@ declare type LuaLength<TOperand, TReturn> = ((operand: TOperand) => TReturn) & L
  *
  * @param TReturn The resulting (return) type of the operation.
  */
-declare type LuaLengthMethod<TReturn> = (() => TReturn) & LuaExtension<"__luaLengthMethodBrand">;
+declare type LuaLengthMethod<TReturn> = (() => TReturn) & LuaExtension<"LengthMethod">;
 
 /**
  * Calls to functions with this type are translated to `table[key]`.
@@ -463,7 +471,7 @@ declare type LuaTableGet<TTable extends AnyTable, TKey extends AnyNotNil, TValue
     table: TTable,
     key: TKey
 ) => TValue) &
-    LuaExtension<"__luaTableGetBrand">;
+    LuaExtension<"TableGet">;
 
 /**
  * Calls to methods with this type are translated to `table[key]`, where `table` is the object with the method.
@@ -473,7 +481,7 @@ declare type LuaTableGet<TTable extends AnyTable, TKey extends AnyNotNil, TValue
  * @param TValue The type of the value stored in the table.
  */
 declare type LuaTableGetMethod<TKey extends AnyNotNil, TValue> = ((key: TKey) => TValue) &
-    LuaExtension<"__luaTableGetMethodBrand">;
+    LuaExtension<"TableGetMethod">;
 
 /**
  * Calls to functions with this type are translated to `table[key] = value`.
@@ -488,7 +496,7 @@ declare type LuaTableSet<TTable extends AnyTable, TKey extends AnyNotNil, TValue
     key: TKey,
     value: TValue
 ) => void) &
-    LuaExtension<"__luaTableSetBrand">;
+    LuaExtension<"TableSet">;
 
 /**
  * Calls to methods with this type are translated to `table[key] = value`, where `table` is the object with the method.
@@ -498,7 +506,24 @@ declare type LuaTableSet<TTable extends AnyTable, TKey extends AnyNotNil, TValue
  * @param TValue The type of the value to assign to the table.
  */
 declare type LuaTableSetMethod<TKey extends AnyNotNil, TValue> = ((key: TKey, value: TValue) => void) &
-    LuaExtension<"__luaTableSetMethodBrand">;
+    LuaExtension<"TableSetMethod">;
+
+/**
+ * Calls to functions with this type are translated to `table[key] = true`.
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ *
+ * @param TTable The type to access as a Lua table.
+ * @param TKey The type of the key to use to access the table.
+ */
+declare type LuaTableAddKey<TTable extends AnyTable, TKey extends AnyNotNil> = ((table: TTable, key: TKey) => void) &
+    LuaExtension<"TableAddKey">;
+
+/**
+ * Calls to methods with this type are translated to `table[key] = true`, where `table` is the object with the method.
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ * @param TKey The type of the key to use to access the table.
+ */
+declare type LuaTableAddKeyMethod<TKey extends AnyNotNil> = ((key: TKey) => void) & LuaExtension<"TableAddKeyMethod">;
 
 /**
  * Calls to functions with this type are translated to `table[key] ~= nil`.
@@ -508,7 +533,7 @@ declare type LuaTableSetMethod<TKey extends AnyNotNil, TValue> = ((key: TKey, va
  * @param TKey The type of the key to use to access the table.
  */
 declare type LuaTableHas<TTable extends AnyTable, TKey extends AnyNotNil> = ((table: TTable, key: TKey) => boolean) &
-    LuaExtension<"__luaTableHasBrand">;
+    LuaExtension<"TableHas">;
 
 /**
  * Calls to methods with this type are translated to `table[key] ~= nil`, where `table` is the object with the method.
@@ -516,8 +541,7 @@ declare type LuaTableHas<TTable extends AnyTable, TKey extends AnyNotNil> = ((ta
  *
  * @param TKey The type of the key to use to access the table.
  */
-declare type LuaTableHasMethod<TKey extends AnyNotNil> = ((key: TKey) => boolean) &
-    LuaExtension<"__luaTableHasMethodBrand">;
+declare type LuaTableHasMethod<TKey extends AnyNotNil> = ((key: TKey) => boolean) & LuaExtension<"TableHasMethod">;
 
 /**
  * Calls to functions with this type are translated to `table[key] = nil`.
@@ -527,7 +551,7 @@ declare type LuaTableHasMethod<TKey extends AnyNotNil> = ((key: TKey) => boolean
  * @param TKey The type of the key to use to access the table.
  */
 declare type LuaTableDelete<TTable extends AnyTable, TKey extends AnyNotNil> = ((table: TTable, key: TKey) => boolean) &
-    LuaExtension<"__luaTableDeleteBrand">;
+    LuaExtension<"TableDelete">;
 
 /**
  * Calls to methods with this type are translated to `table[key] = nil`, where `table` is the object with the method.
@@ -536,7 +560,7 @@ declare type LuaTableDelete<TTable extends AnyTable, TKey extends AnyNotNil> = (
  * @param TKey The type of the key to use to access the table.
  */
 declare type LuaTableDeleteMethod<TKey extends AnyNotNil> = ((key: TKey) => boolean) &
-    LuaExtension<"__luaTableDeleteMethodBrand">;
+    LuaExtension<"TableDeleteMethod">;
 
 /**
  * A convenience type for working directly with a Lua table.
@@ -564,7 +588,7 @@ declare type LuaTableConstructor = (new <TKey extends AnyNotNil = AnyNotNil, TVa
     TKey,
     TValue
 >) &
-    LuaExtension<"__luaTableNewBrand">;
+    LuaExtension<"TableNew">;
 
 /**
  * A convenience type for working directly with a Lua table.
@@ -574,3 +598,79 @@ declare type LuaTableConstructor = (new <TKey extends AnyNotNil = AnyNotNil, TVa
  * @param TValue The type of the values stored in the table.
  */
 declare const LuaTable: LuaTableConstructor;
+
+/**
+ * A convenience type for working directly with a Lua table, used as a map.
+ *
+ * This differs from LuaTable in that the `get` method may return `nil`.
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ * @param K The type of the keys used to access the table.
+ * @param V The type of the values stored in the table.
+ */
+declare interface LuaMap<K extends AnyNotNil = AnyNotNil, V = any> extends LuaPairsIterable<K, V> {
+    get: LuaTableGetMethod<K, V | undefined>;
+    set: LuaTableSetMethod<K, V>;
+    has: LuaTableHasMethod<K>;
+    delete: LuaTableDeleteMethod<K>;
+}
+
+/**
+ * A convenience type for working directly with a Lua table, used as a map.
+ *
+ * This differs from LuaTable in that the `get` method may return `nil`.
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ * @param K The type of the keys used to access the table.
+ * @param V The type of the values stored in the table.
+ */
+declare const LuaMap: (new <K extends AnyNotNil = AnyNotNil, V = any>() => LuaMap<K, V>) & LuaExtension<"TableNew">;
+
+/**
+ * Readonly version of {@link LuaMap}.
+ *
+ * @param K The type of the keys used to access the table.
+ * @param V The type of the values stored in the table.
+ */
+declare interface ReadonlyLuaMap<K extends AnyNotNil = AnyNotNil, V = any> extends LuaPairsIterable<K, V> {
+    get: LuaTableGetMethod<K, V>;
+    has: LuaTableHasMethod<K>;
+}
+
+/**
+ * A convenience type for working directly with a Lua table, used as a set.
+ *
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ * @param T The type of the keys used to access the table.
+ */
+declare interface LuaSet<T extends AnyNotNil = AnyNotNil> extends LuaPairsKeyIterable<T> {
+    add: LuaTableAddKeyMethod<T>;
+    has: LuaTableHasMethod<T>;
+    delete: LuaTableDeleteMethod<T>;
+}
+
+/**
+ * A convenience type for working directly with a Lua table, used as a set.
+ *
+ * For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions
+ * @param T The type of the keys used to access the table.
+ */
+declare const LuaSet: (new <T extends AnyNotNil = AnyNotNil>() => LuaSet<T>) & LuaExtension<"TableNew">;
+
+/**
+ * Readonly version of {@link LuaSet}.
+ *
+ * @param T The type of the keys used to access the table.
+ */
+declare interface ReadonlyLuaSet<T extends AnyNotNil = AnyNotNil> extends LuaPairsKeyIterable<T> {
+    has: LuaTableHasMethod<T>;
+}
+
+interface ObjectConstructor {
+    /** Returns an array of keys of an object, when iterated with `pairs`. */
+    keys<K>(o: LuaPairsIterable<K, any> | LuaPairsKeyIterable<K>): K[];
+
+    /** Returns an array of values of an object, when iterated with `pairs`. */
+    values<V>(o: LuaPairsIterable<any, V>): V[];
+
+    /** Returns an array of key/values of an object, when iterated with `pairs`. */
+    entries<K, V>(o: LuaPairsIterable<K, V>): Array<[K, V]>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typescript-to-lua",
-    "version": "1.6.2",
+    "version": "1.7.1",
     "description": "A generic TypeScript to Lua transpiler. Write your code in TypeScript and publish Lua!",
     "repository": "https://github.com/TypeScriptToLua/TypeScriptToLua",
     "homepage": "https://typescripttolua.github.io/",
@@ -65,7 +65,7 @@
         "javascript-stringify": "^2.0.1",
         "jest": "^27.3.0",
         "jest-circus": "^27.3.0",
-        "lua-types": "2.10.1",
+        "lua-types": "^2.11.0",
         "lua-wasm-bindings": "^0.2.2",
         "prettier": "^2.3.2",
         "ts-jest": "^27.1.3",

package/dist/transformation/visitors/language-extensions/index.d.ts

@@ -1,4 +0,0 @@
-import { TransformationContext } from "../../context";
-import * as ts from "typescript";
-import * as lua from "../../../LuaAST";
-export declare function transformLanguageExtensionCallExpression(context: TransformationContext, node: ts.CallExpression, isOptionalCall: boolean): lua.Expression | undefined;

package/dist/transformation/visitors/language-extensions/index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformLanguageExtensionCallExpression = void 0;
-const operators_1 = require("./operators");
-const table_1 = require("./table");
-function transformLanguageExtensionCallExpression(context, node, isOptionalCall) {
-    const operatorMapping = (0, operators_1.transformOperatorMappingExpression)(context, node, isOptionalCall);
-    if (operatorMapping) {
-        return operatorMapping;
-    }
-    const tableCall = (0, table_1.transformTableExtensionCall)(context, node, isOptionalCall);
-    if (tableCall) {
-        return tableCall;
-    }
-}
-exports.transformLanguageExtensionCallExpression = transformLanguageExtensionCallExpression;
-//# sourceMappingURL=index.js.map

package/dist/transformation/visitors/language-extensions/pairsIterable.d.ts

@@ -1,5 +0,0 @@
-import * as ts from "typescript";
-import * as lua from "../../../LuaAST";
-import { TransformationContext } from "../../context";
-export declare function isPairsIterableExpression(context: TransformationContext, expression: ts.Expression): boolean;
-export declare function transformForOfPairsIterableStatement(context: TransformationContext, statement: ts.ForOfStatement, block: lua.Block): lua.Statement;