isaacscript-common 14.1.2 → 14.2.0

package/dist/src/functions/merge.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="@typescript-to-lua/language-extensions" />
+import { AnyClass } from "../types/AnyClass";
+/**
+ * `merge` takes the values from a new table and recursively merges them into an old object (while
+ * performing appropriate deserialization).
+ *
+ * This function is used to merge incoming data from the "save#.dat" file into a mod's variables.
+ * Merging is useful instead of blowing away a table entirely because mod code often relies on the
+ * local table/object references.
+ *
+ * This function always assumes that the new table is serialized data and will attempt to perform
+ * deserialization on the objects within. In other words, unlike the `deepCopy` function, the
+ * `merge` function will always operates in the mode of `SerializationType.DESERIALIZE`. For the
+ * types of objects that will be deserialized, see the documentation for the `deepCopy` function.
+ *
+ * This function does not iterate over the old object, like you would naively expect. This is
+ * because it is common for a variable to have a type of `something | null`. If this is the case,
+ * the key would not appear when iterating over the old object (because a value of null transpiles
+ * to nil, which means the table key does not exist). Thus, we must instead iterate over the new
+ * object and copy the values backwards. The consequence of this is that `merge` can copy over old
+ * variables that are no longer used in the code, or copy over old variables of a different type,
+ * which can cause run-time errors. In such cases, users will have to manually delete their save
+ * data.
+ *
+ * @param oldObject The old object to merge the values into. This can be either a Lua table, a TSTL
+ *                  map, or a TSTL set.
+ * @param newTable The new table to merge the values from. This must be a Lua table that represents
+ *                 serialized data. In other words, it should be created with the `deepCopy`
+ *                 function using `SerializationType.SERIALIZE`.
+ * @param traversalDescription Used to track the current key that we are operating on for debugging
+ *                             purposes. Use a name that corresponds to the name of the merging
+ *                             table.
+ * @param classConstructors Optional. A Lua table that maps the name of a user-defined TSTL class to
+ *                          its corresponding constructor. If the `deepCopy` function finds any
+ *                          user-defined TSTL classes when recursively iterating through the given
+ *                          object, it will use this map to instantiate a new class. Default is an
+ *                          empty Lua table.
+ */
+export declare function merge(oldObject: LuaMap<AnyNotNil, unknown> | Map<AnyNotNil, unknown> | Set<AnyNotNil>, newTable: LuaMap<AnyNotNil, unknown>, traversalDescription: string, classConstructors?: LuaMap<string, AnyClass>): void;
+//# sourceMappingURL=merge.d.ts.map

package/dist/src/functions/merge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.d.ts","sourceRoot":"","sources":["../../../src/functions/merge.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAc7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,KAAK,CACnB,SAAS,EACL,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAC1B,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GACvB,GAAG,CAAC,SAAS,CAAC,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EACpC,oBAAoB,EAAE,MAAM,EAC5B,iBAAiB,2BAAiC,GACjD,IAAI,CAyCN"}

package/dist/src/{features/saveDataManager → functions}/merge.lua

@@ -3,10 +3,12 @@ local Set = ____lualib.Set
 local Map = ____lualib.Map
 local ____exports = {}
 local mergeSerializedArray, mergeSerializedTSTLObject, mergeSerializedTable
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("src.enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
+local ____constants = require("src.features.saveDataManager.constants")
+local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local ____array = require("src.functions.array")
 local isArray = ____array.isArray
 local ____deepCopy = require("src.functions.deepCopy")
@@ -15,6 +17,7 @@ local ____log = require("src.functions.log")
 local log = ____log.log
 local ____serialization = require("src.functions.serialization")
 local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
+local isSerializationBrand = ____serialization.isSerializationBrand
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____table = require("src.functions.table")
 local clearTable = ____table.clearTable
@@ -27,32 +30,44 @@ local ____types = require("src.functions.types")
 local isTable = ____types.isTable
 local ____utils = require("src.functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
-local ____constants = require("src.features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local ____serializationBrands = require("src.features.saveDataManager.serializationBrands")
-local isSerializationBrand = ____serializationBrands.isSerializationBrand
 --- `merge` takes the values from a new table and recursively merges them into an old object (while
 -- performing appropriate deserialization).
 -- 
--- It supports the following object types:
+-- This function is used to merge incoming data from the "save#.dat" file into a mod's variables.
+-- Merging is useful instead of blowing away a table entirely because mod code often relies on the
+-- local table/object references.
 -- 
--- - Basic TSTL objects / tables
--- - TSTL `Map`
--- - TSTL `Set`
--- - TSTL classes
--- - `DefaultMap`
--- - Isaac `BitSet128` objects
--- - Isaac `Color` objects
--- - Isaac `KColor` objects
--- - Isaac `RNG` objects
--- - Isaac `Vector` objects
+-- This function always assumes that the new table is serialized data and will attempt to perform
+-- deserialization on the objects within. In other words, unlike the `deepCopy` function, the
+-- `merge` function will always operates in the mode of `SerializationType.DESERIALIZE`. For the
+-- types of objects that will be deserialized, see the documentation for the `deepCopy` function.
 -- 
--- Since it is common for a variable to have a type of `something | null`, we must iterate over the
--- new object and copy over all of the values. (A value of null transpiles to nil, which means the
--- table key does not exist.) The consequence of this is that it can copy over old variables that
--- are no longer used in the code, or copy over old variables of a different type, which can cause
--- run-time errors. In such cases, users will have to manually delete their save data.
-function ____exports.merge(self, oldObject, newTable, traversalDescription)
+-- This function does not iterate over the old object, like you would naively expect. This is
+-- because it is common for a variable to have a type of `something | null`. If this is the case,
+-- the key would not appear when iterating over the old object (because a value of null transpiles
+-- to nil, which means the table key does not exist). Thus, we must instead iterate over the new
+-- object and copy the values backwards. The consequence of this is that `merge` can copy over old
+-- variables that are no longer used in the code, or copy over old variables of a different type,
+-- which can cause run-time errors. In such cases, users will have to manually delete their save
+-- data.
+-- 
+-- @param oldObject The old object to merge the values into. This can be either a Lua table, a TSTL
+-- map, or a TSTL set.
+-- @param newTable The new table to merge the values from. This must be a Lua table that represents
+-- serialized data. In other words, it should be created with the `deepCopy`
+-- function using `SerializationType.SERIALIZE`.
+-- @param traversalDescription Used to track the current key that we are operating on for debugging
+-- purposes. Use a name that corresponds to the name of the merging
+-- table.
+-- @param classConstructors Optional. A Lua table that maps the name of a user-defined TSTL class to
+-- its corresponding constructor. If the `deepCopy` function finds any
+-- user-defined TSTL classes when recursively iterating through the given
+-- object, it will use this map to instantiate a new class. Default is an
+-- empty Lua table.
+function ____exports.merge(self, oldObject, newTable, traversalDescription, classConstructors)
+    if classConstructors == nil then
+        classConstructors = {}
+    end
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "merge is traversing: " .. traversalDescription)
     end
@@ -63,16 +78,34 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
         error("The second argument given to the merge function is not a table.")
     end
     if isArray(nil, oldObject) and isArray(nil, newTable) then
-        mergeSerializedArray(nil, oldObject, newTable, traversalDescription)
+        mergeSerializedArray(
+            nil,
+            oldObject,
+            newTable,
+            traversalDescription,
+            classConstructors
+        )
         return
     end
     if isTSTLMap(nil, oldObject) or isTSTLSet(nil, oldObject) or isDefaultMap(nil, oldObject) then
-        mergeSerializedTSTLObject(nil, oldObject, newTable, traversalDescription)
+        mergeSerializedTSTLObject(
+            nil,
+            oldObject,
+            newTable,
+            traversalDescription,
+            classConstructors
+        )
     else
-        mergeSerializedTable(nil, oldObject, newTable, traversalDescription)
+        mergeSerializedTable(
+            nil,
+            oldObject,
+            newTable,
+            traversalDescription,
+            classConstructors
+        )
     end
 end
-function mergeSerializedArray(self, oldArray, newArray, traversalDescription)
+function mergeSerializedArray(self, oldArray, newArray, traversalDescription, classConstructors)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "merge encountered an array: " .. traversalDescription)
     end
@@ -81,12 +114,19 @@ function mergeSerializedArray(self, oldArray, newArray, traversalDescription)
         nil,
         newArray,
         function(____, key, value)
-            oldArray[key] = value
+            local deserializedValue = deepCopy(
+                nil,
+                value,
+                SerializationType.DESERIALIZE,
+                traversalDescription,
+                classConstructors
+            )
+            oldArray[key] = deserializedValue
         end,
         SAVE_DATA_MANAGER_DEBUG
     )
 end
-function mergeSerializedTSTLObject(self, oldObject, newTable, traversalDescription)
+function mergeSerializedTSTLObject(self, oldObject, newTable, traversalDescription, classConstructors)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "merge encountered a TSTL object: " .. traversalDescription)
     end
@@ -108,13 +148,14 @@ function mergeSerializedTSTLObject(self, oldObject, newTable, traversalDescripti
                 keyToUse = numberKey
             end
             if isTSTLMap(nil, oldObject) or isDefaultMap(nil, oldObject) then
-                local valueCopy
-                if isTable(nil, value) then
-                    valueCopy = deepCopy(nil, value, SerializationType.DESERIALIZE, traversalDescription)
-                else
-                    valueCopy = value
-                end
-                oldObject:set(keyToUse, valueCopy)
+                local deserializedValue = deepCopy(
+                    nil,
+                    value,
+                    SerializationType.DESERIALIZE,
+                    traversalDescription,
+                    classConstructors
+                )
+                oldObject:set(keyToUse, deserializedValue)
             elseif isTSTLSet(nil, oldObject) then
                 oldObject:add(keyToUse)
             end
@@ -122,7 +163,7 @@ function mergeSerializedTSTLObject(self, oldObject, newTable, traversalDescripti
         SAVE_DATA_MANAGER_DEBUG
     )
 end
-function mergeSerializedTable(self, oldTable, newTable, traversalDescription)
+function mergeSerializedTable(self, oldTable, newTable, traversalDescription, classConstructors)
     if SAVE_DATA_MANAGER_DEBUG then
         log(nil, "merge encountered a Lua table: " .. traversalDescription)
     end
@@ -152,7 +193,13 @@ function mergeSerializedTable(self, oldTable, newTable, traversalDescription)
                     oldTable[key] = oldValue
                 end
                 traversalDescription = getTraversalDescription(nil, key, traversalDescription)
-                ____exports.merge(nil, oldValue, value, traversalDescription)
+                ____exports.merge(
+                    nil,
+                    oldValue,
+                    value,
+                    traversalDescription,
+                    classConstructors
+                )
             else
                 oldTable[key] = value
             end

package/dist/src/functions/mergeTests.d.ts

@@ -1,6 +1,5 @@
 /**
- * Run the suite of tests that prove that the "merge" function works properly. (This function is not
- * exported but is used internally in the save data manager.)
+ * Run the suite of tests that prove that the "merge" function works properly.
  *
  * This function is only useful if you are troubleshooting the save data manager.
  */

package/dist/src/functions/mergeTests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mergeTests.d.ts","sourceRoot":"","sources":["../../../src/functions/mergeTests.ts"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAkBpC"}
+{"version":3,"file":"mergeTests.d.ts","sourceRoot":"","sources":["../../../src/functions/mergeTests.ts"],"names":[],"mappings":"AAUA;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAkBpC"}

package/dist/src/functions/mergeTests.lua

@@ -7,12 +7,12 @@ local ____DefaultMap = require("src.classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
 local ____SerializationType = require("src.enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
-local ____merge = require("src.features.saveDataManager.merge")
-local merge = ____merge.merge
 local ____deepCopy = require("src.functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local ____log = require("src.functions.log")
 local log = ____log.log
+local ____merge = require("src.functions.merge")
+local merge = ____merge.merge
 local ____rng = require("src.functions.rng")
 local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
@@ -238,8 +238,7 @@ function oldTableHasRNGSerialized(self)
         error("The old table's seed not match: " .. tostring(seed))
     end
 end
---- Run the suite of tests that prove that the "merge" function works properly. (This function is not
--- exported but is used internally in the save data manager.)
+--- Run the suite of tests that prove that the "merge" function works properly.
 -- 
 -- This function is only useful if you are troubleshooting the save data manager.
 function ____exports.runMergeTests(self)

package/dist/src/functions/rng.d.ts

@@ -20,8 +20,8 @@ export declare function getRandomSeed(): Seed;
 /** Helper function to check if something is an instantiated `RNG` object. */
 export declare function isRNG(object: unknown): object is RNG;
 /**
- * Used to determine is the given table is a serialized `RNG` object created by the save data
- * manager and/or the `deepCopy` function.
+ * Used to determine is the given table is a serialized `RNG` object created by the `deepCopy`
+ * function.
  */
 export declare function isSerializedRNG(object: unknown): object is SerializedRNG;
 /**

package/dist/src/functions/rng.lua

@@ -4,7 +4,7 @@ local ____exports = {}
 local RECOMMENDED_SHIFT_IDX, OBJECT_NAME
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
@@ -72,8 +72,8 @@ function ____exports.deserializeRNG(self, rng)
     end
     return ____exports.newRNG(nil, seed)
 end
---- Used to determine is the given table is a serialized `RNG` object created by the save data
--- manager and/or the `deepCopy` function.
+--- Used to determine is the given table is a serialized `RNG` object created by the `deepCopy`
+-- function.
 function ____exports.isSerializedRNG(self, object)
     if not isTable(nil, object) then
         return false

package/dist/src/functions/serialization.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../../../src/functions/serialization.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,qBAAqB,EAErB,iCAAiC,EACjC,uBAAuB,EAEvB,uBAAuB,EACxB,MAAM,yCAAyC,CAAC;AAIjD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,EAC/D,aAAa,EAAE,CAAC,GACf,CAAC,CAoCH;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,SAAS,uBAAuB,EAE3C,uBAAuB,EAAE,WAAW,GACnC,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAkChD;AAoBD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,qBAAqB,CAIjC;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,uBAAuB,CAQnC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,qBAAqB,EACpE,aAAa,EAAE,CAAC,GACf,iCAAiC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAoChD"}
+{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../../../src/functions/serialization.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,qBAAqB,EAErB,iCAAiC,EACjC,uBAAuB,EAEvB,uBAAuB,EACxB,MAAM,yCAAyC,CAAC;AAUjD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,EAC/D,aAAa,EAAE,CAAC,GACf,CAAC,CAoCH;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,SAAS,uBAAuB,EAE3C,uBAAuB,EAAE,WAAW,GACnC,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAkChD;AAoBD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,qBAAqB,CAIjC;AAmBD;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,uBAAuB,CAQnC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,qBAAqB,EACpE,aAAa,EAAE,CAAC,GACf,iCAAiC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAoChD"}

package/dist/src/functions/serialization.lua

@@ -1,4 +1,6 @@
 local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local __TS__TypeOf = ____lualib.__TS__TypeOf
 local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
 local __TS__ObjectValues = ____lualib.__TS__ObjectValues
@@ -6,13 +8,18 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
 local getSerializedTableType
+local ____SerializationBrand = require("src.enums.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____isaacAPIClassTypeToBrand = require("src.objects.isaacAPIClassTypeToBrand")
 local ISAAC_API_CLASS_TYPE_TO_BRAND = ____isaacAPIClassTypeToBrand.ISAAC_API_CLASS_TYPE_TO_BRAND
 local ____isaacAPIClassTypeToFunctions = require("src.objects.isaacAPIClassTypeToFunctions")
 local ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = ____isaacAPIClassTypeToFunctions.ISAAC_API_CLASS_TYPE_TO_FUNCTIONS
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____types = require("src.functions.types")
+local isString = ____types.isString
 local isTable = ____types.isTable
 local isUserdata = ____types.isUserdata
 function getSerializedTableType(self, serializedIsaacAPIClass)
@@ -25,6 +32,8 @@ function getSerializedTableType(self, serializedIsaacAPIClass)
     end
     return nil
 end
+local SERIALIZATION_BRANDS = getEnumValues(nil, SerializationBrand)
+local SERIALIZATION_BRAND_SET = __TS__New(Set, SERIALIZATION_BRANDS)
 --- Helper function to generically copy an Isaac API class without knowing what specific type of
 -- class it is. (This is used by the save data manager.)
 -- 
@@ -78,6 +87,19 @@ function ____exports.isCopyableIsaacAPIClass(self, object)
         function(____, identityFunction) return identityFunction(nil, object) end
     )
 end
+--- Helper function to check if a key of a table in the "save#.dat" file is a serialization brand
+-- inserted by the save data manager (i.e. the `deepCopy` function).
+-- 
+-- This is marked internal because end-users would not normally be iterating through a serialized
+-- object directly.
+-- 
+-- @internal
+function ____exports.isSerializationBrand(self, key)
+    if not isString(nil, key) then
+        return false
+    end
+    return SERIALIZATION_BRAND_SET:has(key)
+end
 --- Helper function to generically check if a given Lua table is a serialized Isaac API class. (This
 -- is used by the save data manager when reading data from the "save#.dat" file.)
 -- 

package/dist/src/functions/tstlClass.d.ts

@@ -27,11 +27,6 @@ export declare function getTSTLClassName(object: unknown): string | undefined;
  * their own copies of the entire lualib and thus their own instantiated version of a `Map`.
  */
 export declare function isDefaultMap(object: unknown): object is DefaultMap<AnyNotNil, unknown>;
-/**
- * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
- * as a `DefaultMap`.
- */
-export declare function isIsaacScriptCommonClass(object: unknown): boolean;
 /**
  * Helper function to determine if a given object is a TypeScriptToLua `Map`.
  *
@@ -50,11 +45,6 @@ export declare function isTSTLMap(object: unknown): object is Map<AnyNotNil, unk
 export declare function isTSTLSet(object: unknown): object is Set<AnyNotNil>;
 /** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
 export declare function isUserDefinedTSTLClass(object: unknown): object is TSTLClass;
-/**
- * Returns whether or not this is a class that is provided as part of the TypeScriptToLua
- * transpiler, such as a `Map` or a `Set`.
- */
-export declare function isVanillaTSTLClass(object: unknown): boolean;
 /**
  * Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
  * it is. This function requires that you provide an instantiated class of the same type, as it will

package/dist/src/functions/tstlClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tstlClass.d.ts","sourceRoot":"","sources":["../../../src/functions/tstlClass.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAW/C;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,GACd,kBAAkB,CAAC,aAAa,CAAC,GAAG,SAAS,CAW/C;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAG1C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAEjE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAG5E;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAGnE;AAED,kGAAkG;AAClG,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,SAAS,CA4B3E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAiB3D"}
+{"version":3,"file":"tstlClass.d.ts","sourceRoot":"","sources":["../../../src/functions/tstlClass.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG/C;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,GACd,kBAAkB,CAAC,aAAa,CAAC,GAAG,SAAS,CAW/C;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAG1C;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAG5E;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAGnE;AAED,kGAAkG;AAClG,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,SAAS,CAG3E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAiB3D"}

package/dist/src/functions/tstlClass.lua

@@ -1,10 +1,5 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local VANILLA_TSTL_CLASSES
 local ____types = require("src.functions.types")
-local isString = ____types.isString
 local isTable = ____types.isTable
 --- Helper function to get the constructor from an instantiated TypeScriptToLua class, which is
 -- located on the metatable.
@@ -35,17 +30,6 @@ function ____exports.getTSTLClassName(self, object)
     end
     return constructor.name
 end
---- Returns whether or not this is a class that is provided as part of the TypeScriptToLua
--- transpiler, such as a `Map` or a `Set`.
-function ____exports.isVanillaTSTLClass(self, object)
-    local className = ____exports.getTSTLClassName(nil, object)
-    if className == nil then
-        return false
-    end
-    return VANILLA_TSTL_CLASSES:has(className)
-end
-VANILLA_TSTL_CLASSES = __TS__New(Set, {"Map", "Set", "WeakMap", "WeakSet"})
-local TSTL_CLASS_METATABLE_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
 --- Helper function to determine if a given object is a TypeScriptToLua `Map`.
 -- 
 -- It is not reliable to use the `instanceof` operator to determine this because each Lua module has
@@ -54,11 +38,6 @@ function ____exports.isDefaultMap(self, object)
     local className = ____exports.getTSTLClassName(nil, object)
     return className == "DefaultMap"
 end
---- Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
--- as a `DefaultMap`.
-function ____exports.isIsaacScriptCommonClass(self, object)
-    return ____exports.isDefaultMap(nil, object)
-end
 --- Helper function to determine if a given object is a TypeScriptToLua `Map`.
 -- 
 -- It is not reliable to use the `instanceof` operator to determine this because each Lua module
@@ -79,27 +58,8 @@ function ____exports.isTSTLSet(self, object)
 end
 --- TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys.
 function ____exports.isUserDefinedTSTLClass(self, object)
-    if ____exports.isVanillaTSTLClass(nil, object) or ____exports.isIsaacScriptCommonClass(nil, object) then
-        return false
-    end
-    if not isTable(nil, object) then
-        return false
-    end
-    local metatable = getmetatable(object)
-    if metatable == nil then
-        return false
-    end
-    local numKeys = 0
-    for key in pairs(metatable) do
-        numKeys = numKeys + 1
-        if not isString(nil, key) then
-            return false
-        end
-        if not TSTL_CLASS_METATABLE_KEYS:has(key) then
-            return false
-        end
-    end
-    return numKeys == TSTL_CLASS_METATABLE_KEYS.size
+    local tstlClassName = ____exports.getTSTLClassName(nil, object)
+    return tstlClassName ~= nil
 end
 --- Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
 -- it is. This function requires that you provide an instantiated class of the same type, as it will

package/dist/src/functions/vector.d.ts

@@ -23,8 +23,8 @@ export declare function deserializeVector(vector: SerializedVector): Vector;
  */
 export declare function getRandomVector(seedOrRNG?: Seed | RNG): Vector;
 /**
- * Used to determine is the given table is a serialized `Vector` object created by the save data
- * manager and/or the `deepCopy` function.
+ * Used to determine is the given table is a serialized `Vector` object created by the `deepCopy`
+ * function.
  */
 export declare function isSerializedVector(object: unknown): object is SerializedVector;
 /** Helper function to check if something is an instantiated `Vector` object. */

package/dist/src/functions/vector.lua

@@ -1,6 +1,6 @@
 local ____exports = {}
 local OBJECT_NAME
-local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local ____SerializationBrand = require("src.enums.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____direction = require("src.functions.direction")
 local angleToDirection = ____direction.angleToDirection
@@ -69,8 +69,8 @@ function ____exports.getRandomVector(self, seedOrRNG)
     local y = getRandomFloat(nil, -1, 1, rng)
     return Vector(x, y)
 end
---- Used to determine is the given table is a serialized `Vector` object created by the save data
--- manager and/or the `deepCopy` function.
+--- Used to determine is the given table is a serialized `Vector` object created by the `deepCopy`
+-- function.
 function ____exports.isSerializedVector(self, object)
     if not isTable(nil, object) then
         return false

package/dist/src/functions/weighted.d.ts

@@ -1,6 +1,17 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { WeightedArray } from "../types/WeightedArray";
-/** Get a random value from a `WeightedArray`. (The second element in the array is the weight.) */
+/**
+ * Get a random value from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
+ * first element in the tuple is a value, and the second element in the tuple is a float
+ * corresponding to the value's weight.)
+ */
 export declare function getRandomFromWeightedArray<T>(weightedArray: WeightedArray<T>, seedOrRNG?: Seed | RNG): T;
+/**
+ * Get a random index from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
+ * first element in the tuple is a value, and the second element in the tuple is a float
+ * corresponding to the value's weight.)
+ */
+export declare function getRandomIndexFromWeightedArray<T>(weightedArray: WeightedArray<T>, seedOrRNG?: Seed | RNG): int;
 //# sourceMappingURL=weighted.d.ts.map

package/dist/src/functions/weighted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"weighted.d.ts","sourceRoot":"","sources":["../../../src/functions/weighted.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAKvD,kGAAkG;AAClG,wBAAgB,0BAA0B,CAAC,CAAC,EAC1C,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,EAC/B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,CAAC,CA0BH"}
+{"version":3,"file":"weighted.d.ts","sourceRoot":"","sources":["../../../src/functions/weighted.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAKvD;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAC1C,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,EAC/B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,CAAC,CAKH;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,CAAC,EAC/C,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,EAC/B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,GAAG,CAwBL"}

package/dist/src/functions/weighted.lua

@@ -2,19 +2,20 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
 local ____array = require("src.functions.array")
-local arrayToString = ____array.arrayToString
 local sumArray = ____array.sumArray
 local ____random = require("src.functions.random")
 local getRandomFloat = ____random.getRandomFloat
 local ____rng = require("src.functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
---- Get a random value from a `WeightedArray`. (The second element in the array is the weight.)
-function ____exports.getRandomFromWeightedArray(self, weightedArray, seedOrRNG)
+--- Get a random index from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
+-- first element in the tuple is a value, and the second element in the tuple is a float
+-- corresponding to the value's weight.)
+function ____exports.getRandomIndexFromWeightedArray(self, weightedArray, seedOrRNG)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
     if #weightedArray == 0 then
-        error("Failed to get a random element from a weighted array since the provided array was empty.")
+        error("Failed to get a random index from a weighted array since the provided array was empty.")
     end
     local weights = __TS__ArrayMap(
         weightedArray,
@@ -23,13 +24,29 @@ function ____exports.getRandomFromWeightedArray(self, weightedArray, seedOrRNG)
     local totalWeight = sumArray(nil, weights)
     local randomWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
     local weightAccumulator = 0
-    for ____, tuple in ipairs(weightedArray) do
-        local element, weight = table.unpack(tuple)
-        weightAccumulator = weightAccumulator + weight
-        if weightAccumulator >= randomWeight then
-            return element
+    do
+        local i = 0
+        while i < #weightedArray do
+            local tuple = weightedArray[i + 1]
+            local _element, weight = table.unpack(tuple)
+            weightAccumulator = weightAccumulator + weight
+            if weightAccumulator >= randomWeight then
+                return i
+            end
+            i = i + 1
         end
     end
-    error("Failed to get a random element from a weighted array: " .. arrayToString(nil, weightedArray))
+    error("Failed to get a random index from a weighted array.")
+end
+--- Get a random value from a `WeightedArray`. (A `WeightedArray` is an array of tuples, where the
+-- first element in the tuple is a value, and the second element in the tuple is a float
+-- corresponding to the value's weight.)
+function ____exports.getRandomFromWeightedArray(self, weightedArray, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local randomIndex = ____exports.getRandomIndexFromWeightedArray(nil, weightedArray, seedOrRNG)
+    local randomElement = weightedArray[randomIndex + 1]
+    return randomElement[1]
 end
 return ____exports

package/dist/src/index.d.ts

@@ -15,6 +15,7 @@ export * from "./enums/ModCallbackCustom2";
 export * from "./enums/PocketItemType";
 export * from "./enums/RockAltType";
 export * from "./enums/SaveDataKey";
+export * from "./enums/SerializationBrand";
 export * from "./enums/SerializationType";
 export * from "./enums/SlotDestructionType";
 export * from "./enums/StatType";
@@ -23,6 +24,7 @@ export * from "./features/characterStats";
 export * from "./features/collectibleItemPoolType";
 export * from "./features/customGridEntity";
 export * from "./features/customHotkeys";
+export * from "./features/customItemPool";
 export * from "./features/customPickup";
 export * from "./features/customStage/exports";
 export * from "./features/customTrapdoor/exports";
@@ -107,6 +109,7 @@ export * from "./functions/logEntities";
 export * from "./functions/logMisc";
 export * from "./functions/map";
 export * from "./functions/math";
+export * from "./functions/merge";
 export * from "./functions/mergeTests";
 export * from "./functions/minimap";
 export * from "./functions/nextStage";
@@ -179,11 +182,13 @@ export * from "./objects/kColors";
 export * from "./types/AllButFirst";
 export * from "./types/AllButLast";
 export * from "./types/AnyEntity";
+export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
 export * from "./types/CollectibleIndex";
 export * from "./types/Constructor";
 export * from "./types/FunctionTuple";
 export * from "./types/HasAllEnumKeys";
+export * from "./types/HasFunction";
 export * from "./types/Immutable";
 export * from "./types/LowercaseKeys";
 export * from "./types/PickingUpItem";