isaacscript-common 87.9.5 → 87.9.7

package/dist/functions/deepCopy.js

@@ -56,40 +56,31 @@ function deepCopy(value, serializationType = SerializationType_1.SerializationTy
         }
     }
 }
-function deepCopyTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap) {
-    // First, handle the cases of TSTL classes or serialized TSTL classes.
-    if ((0, tstlClass_1.isDefaultMap)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.DEFAULT_MAP)) {
-        return deepCopyDefaultMap(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
-    }
-    if ((0, tstlClass_1.isTSTLMap)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.MAP)) {
-        return deepCopyMap(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
-    }
-    if ((0, tstlClass_1.isTSTLSet)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.SET)) {
-        return deepCopySet(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
-    }
-    const className = (0, tstlClass_1.getTSTLClassName)(luaMap);
-    if (className === "WeakMap") {
-        error(`The deep copy function does not support copying the "WeakMap" class for: ${traversalDescription}`);
-    }
-    if (className === "WeakSet") {
-        error(`The deep copy function does not support copying the "WeakSet" class for: ${traversalDescription}`);
-    }
-    if (className !== undefined || luaMap.has(SerializationBrand_1.SerializationBrand.TSTL_CLASS)) {
-        return deepCopyTSTLClass(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+/**
+ * Lua tables can have metatables, which make writing a generic deep cloner impossible. The deep
+ * copy function will refuse to copy a table type that has a metatable, outside of specifically
+ * supported TSTL objects.
+ */
+function checkMetatable(luaMap, traversalDescription) {
+    const metatable = getmetatable(luaMap);
+    if (metatable === undefined) {
+        return;
     }
-    // This is not a TSTL Map/Set/class. If it has a metatable, abort.
-    checkMetatable(luaMap, traversalDescription);
-    // Handle the special case of serialized Isaac API classes.
-    if ((0, serialization_2.isSerializedIsaacAPIClass)(luaMap)
-        && serializationType === SerializationType_1.SerializationType.DESERIALIZE) {
-        return (0, serialization_2.deserializeIsaacAPIClass)(luaMap);
+    const tableDescription = traversalDescription === ""
+        ? "the table to copy"
+        : `"${traversalDescription}"`;
+    error(`The deepCopy function detected that ${tableDescription} has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. TypeScriptToLua Maps, TypeScriptToLua Sets, etc.)`);
+}
+function deepCopyArray(array, serializationType, traversalDescription, classConstructors, insideMap) {
+    if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
+        (0, log_1.log)("deepCopy is copying an array.");
     }
-    // Handle the special case of an array.
-    if ((0, array_1.isArray)(luaMap)) {
-        return deepCopyArray(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    const newArray = [];
+    for (const value of array) {
+        const newValue = deepCopy(value, serializationType, traversalDescription, classConstructors, insideMap);
+        newArray.push(newValue);
     }
-    // Base case: copy a normal Lua table
-    return deepCopyNormalLuaTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    return newArray;
 }
 function deepCopyDefaultMap(defaultMap, serializationType, traversalDescription, classConstructors, insideMap) {
     if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
@@ -126,6 +117,7 @@ function deepCopyDefaultMap(defaultMap, serializationType, traversalDescription,
         // the proper set method call.
         if ((0, tstlClass_1.isDefaultMap)(newDefaultMap)) {
             newDefaultMap.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
+            // eslint-disable-next-line unicorn/no-duplicate-if-branches
         }
         else {
             newDefaultMap.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
@@ -136,6 +128,7 @@ function deepCopyDefaultMap(defaultMap, serializationType, traversalDescription,
         // the proper set method call.
         if ((0, tstlClass_1.isDefaultMap)(newDefaultMap)) {
             newDefaultMap.set(key, value);
+            // eslint-disable-next-line unicorn/no-duplicate-if-branches
         }
         else {
             newDefaultMap.set(key, value);
@@ -143,35 +136,6 @@ function deepCopyDefaultMap(defaultMap, serializationType, traversalDescription,
     }
     return newDefaultMap;
 }
-/**
- * The new copied default map with either be a TSTL `DefaultMap` class or a Lua table, depending on
- * whether we are serializing.
- */
-function getNewDefaultMap(defaultMap, serializationType, traversalDescription, constructorArg) {
-    switch (serializationType) {
-        case SerializationType_1.SerializationType.NONE: {
-            // eslint-disable-next-line isaacscript/no-invalid-default-map
-            return new DefaultMap_1.DefaultMap(constructorArg);
-        }
-        case SerializationType_1.SerializationType.SERIALIZE: {
-            // Since we are serializing, the new object will be a Lua table. (At this point, we already
-            // handled the special case of a DefaultMap instantiated with a factory function.)
-            const newDefaultMap = new LuaMap();
-            newDefaultMap.set(SerializationBrand_1.SerializationBrand.DEFAULT_MAP, "");
-            newDefaultMap.set(SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE, constructorArg);
-            return newDefaultMap;
-        }
-        case SerializationType_1.SerializationType.DESERIALIZE: {
-            if ((0, tstlClass_1.isDefaultMap)(defaultMap)) {
-                error(`Failed to deserialize a default map of "${traversalDescription}", since it was not a Lua table.`);
-            }
-            const defaultMapValue = defaultMap.get(SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE);
-            (0, utils_1.assertDefined)(defaultMapValue, `Failed to deserialize a default map of "${traversalDescription}", since there was no serialization brand of: ${SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE}`);
-            // eslint-disable-next-line isaacscript/no-invalid-default-map
-            return new DefaultMap_1.DefaultMap(defaultMapValue);
-        }
-    }
-}
 function deepCopyMap(map, serializationType, traversalDescription, classConstructors, insideMap) {
     if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
         (0, log_1.log)("deepCopy is copying a Map.");
@@ -192,6 +156,7 @@ function deepCopyMap(map, serializationType, traversalDescription, classConstruc
         // the proper set method call.
         if ((0, tstlClass_1.isTSTLMap)(newMap)) {
             newMap.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
+            // eslint-disable-next-line unicorn/no-duplicate-if-branches
         }
         else {
             newMap.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
@@ -202,6 +167,7 @@ function deepCopyMap(map, serializationType, traversalDescription, classConstruc
         // the proper set method call.
         if ((0, tstlClass_1.isTSTLMap)(newMap)) {
             newMap.set(key, value);
+            // eslint-disable-next-line unicorn/no-duplicate-if-branches
         }
         else {
             newMap.set(key, value);
@@ -209,6 +175,20 @@ function deepCopyMap(map, serializationType, traversalDescription, classConstruc
     }
     return newMap;
 }
+function deepCopyNormalLuaTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap) {
+    if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
+        (0, log_1.log)("deepCopy is copying a normal Lua table.");
+    }
+    const newTable = new LuaMap();
+    const { entries, convertedNumberKeysToStrings } = getCopiedEntries(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    if (convertedNumberKeysToStrings) {
+        newTable.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
+    }
+    for (const [key, value] of entries) {
+        newTable.set(key, value);
+    }
+    return newTable;
+}
 function deepCopySet(set, serializationType, traversalDescription, classConstructors, insideMap) {
     if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
         (0, log_1.log)("deepCopy is copying a Set.");
@@ -247,6 +227,38 @@ function deepCopySet(set, serializationType, traversalDescription, classConstruc
     }
     return newSet;
 }
+function deepCopyTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap) {
+    // First, handle the cases of TSTL classes or serialized TSTL classes.
+    if ((0, tstlClass_1.isDefaultMap)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.DEFAULT_MAP)) {
+        return deepCopyDefaultMap(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    }
+    if ((0, tstlClass_1.isTSTLMap)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.MAP)) {
+        return deepCopyMap(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    }
+    if ((0, tstlClass_1.isTSTLSet)(luaMap) || luaMap.has(SerializationBrand_1.SerializationBrand.SET)) {
+        return deepCopySet(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    }
+    const className = (0, tstlClass_1.getTSTLClassName)(luaMap);
+    if (className === "WeakMap" || className === "WeakSet") {
+        error(`The deep copy function does not support copying the "${className}" class for: ${traversalDescription}`);
+    }
+    if (className !== undefined || luaMap.has(SerializationBrand_1.SerializationBrand.TSTL_CLASS)) {
+        return deepCopyTSTLClass(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    }
+    // This is not a TSTL Map/Set/class. If it has a metatable, abort.
+    checkMetatable(luaMap, traversalDescription);
+    // Handle the special case of serialized Isaac API classes.
+    if ((0, serialization_2.isSerializedIsaacAPIClass)(luaMap)
+        && serializationType === SerializationType_1.SerializationType.DESERIALIZE) {
+        return (0, serialization_2.deserializeIsaacAPIClass)(luaMap);
+    }
+    // Handle the special case of an array.
+    if ((0, array_1.isArray)(luaMap)) {
+        return deepCopyArray(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+    }
+    // Base case: copy a normal Lua table
+    return deepCopyNormalLuaTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
+}
 function deepCopyTSTLClass(tstlClass, serializationType, traversalDescription, classConstructors, insideMap) {
     if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
         (0, log_1.log)("deepCopy is copying a TSTL class.");
@@ -287,30 +299,23 @@ function deepCopyTSTLClass(tstlClass, serializationType, traversalDescription, c
     }
     return newClass;
 }
-function deepCopyArray(array, serializationType, traversalDescription, classConstructors, insideMap) {
-    if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
-        (0, log_1.log)("deepCopy is copying an array.");
-    }
-    const newArray = [];
-    for (const value of array) {
-        const newValue = deepCopy(value, serializationType, traversalDescription, classConstructors, insideMap);
-        newArray.push(newValue);
-    }
-    return newArray;
-}
-function deepCopyNormalLuaTable(luaMap, serializationType, traversalDescription, classConstructors, insideMap) {
-    if (constants_1.SAVE_DATA_MANAGER_DEBUG) {
-        (0, log_1.log)("deepCopy is copying a normal Lua table.");
-    }
-    const newTable = new LuaMap();
-    const { entries, convertedNumberKeysToStrings } = getCopiedEntries(luaMap, serializationType, traversalDescription, classConstructors, insideMap);
-    if (convertedNumberKeysToStrings) {
-        newTable.set(SerializationBrand_1.SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "");
+/** Isaac API classes are of type "userdata". End-user code cannot create userdata. */
+function deepCopyUserdata(value, serializationType, traversalDescription) {
+    if (!(0, serialization_2.isCopyableIsaacAPIClass)(value)) {
+        const className = (0, isaacAPIClass_1.getIsaacAPIClassName)(value) ?? "Unknown";
+        error(`The deep copy function does not support serializing "${traversalDescription}", since it is an Isaac API class of type: ${className}`);
     }
-    for (const [key, value] of entries) {
-        newTable.set(key, value);
+    switch (serializationType) {
+        case SerializationType_1.SerializationType.NONE: {
+            return (0, serialization_2.copyIsaacAPIClass)(value);
+        }
+        case SerializationType_1.SerializationType.SERIALIZE: {
+            return (0, serialization_2.serializeIsaacAPIClass)(value);
+        }
+        case SerializationType_1.SerializationType.DESERIALIZE: {
+            return error(`The deep copy function can not deserialize "${traversalDescription}", since it is userdata.`);
+        }
     }
-    return newTable;
 }
 /**
  * Recursively clones the object's entries, automatically converting number keys to strings, if
@@ -369,35 +374,31 @@ function getCopiedEntries(object, serializationType, traversalDescription, class
     };
 }
 /**
- * Lua tables can have metatables, which make writing a generic deep cloner impossible. The deep
- * copy function will refuse to copy a table type that has a metatable, outside of specifically
- * supported TSTL objects.
+ * The new copied default map with either be a TSTL `DefaultMap` class or a Lua table, depending on
+ * whether we are serializing.
  */
-function checkMetatable(luaMap, traversalDescription) {
-    const metatable = getmetatable(luaMap);
-    if (metatable === undefined) {
-        return;
-    }
-    const tableDescription = traversalDescription === ""
-        ? "the table to copy"
-        : `"${traversalDescription}"`;
-    error(`The deepCopy function detected that ${tableDescription} has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. TypeScriptToLua Maps, TypeScriptToLua Sets, etc.)`);
-}
-/** Isaac API classes are of type "userdata". End-user code cannot create userdata. */
-function deepCopyUserdata(value, serializationType, traversalDescription) {
-    if (!(0, serialization_2.isCopyableIsaacAPIClass)(value)) {
-        const className = (0, isaacAPIClass_1.getIsaacAPIClassName)(value) ?? "Unknown";
-        error(`The deep copy function does not support serializing "${traversalDescription}", since it is an Isaac API class of type: ${className}`);
-    }
+function getNewDefaultMap(defaultMap, serializationType, traversalDescription, constructorArg) {
     switch (serializationType) {
         case SerializationType_1.SerializationType.NONE: {
-            return (0, serialization_2.copyIsaacAPIClass)(value);
+            // eslint-disable-next-line isaacscript/no-invalid-default-map
+            return new DefaultMap_1.DefaultMap(constructorArg);
         }
         case SerializationType_1.SerializationType.SERIALIZE: {
-            return (0, serialization_2.serializeIsaacAPIClass)(value);
+            // Since we are serializing, the new object will be a Lua table. (At this point, we already
+            // handled the special case of a DefaultMap instantiated with a factory function.)
+            const newDefaultMap = new LuaMap();
+            newDefaultMap.set(SerializationBrand_1.SerializationBrand.DEFAULT_MAP, "");
+            newDefaultMap.set(SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE, constructorArg);
+            return newDefaultMap;
         }
         case SerializationType_1.SerializationType.DESERIALIZE: {
-            return error(`The deep copy function can not deserialize "${traversalDescription}", since it is userdata.`);
+            if ((0, tstlClass_1.isDefaultMap)(defaultMap)) {
+                error(`Failed to deserialize a default map of "${traversalDescription}", since it was not a Lua table.`);
+            }
+            const defaultMapValue = defaultMap.get(SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE);
+            (0, utils_1.assertDefined)(defaultMapValue, `Failed to deserialize a default map of "${traversalDescription}", since there was no serialization brand of: ${SerializationBrand_1.SerializationBrand.DEFAULT_MAP_VALUE}`);
+            // eslint-disable-next-line isaacscript/no-invalid-default-map
+            return new DefaultMap_1.DefaultMap(defaultMapValue);
         }
     }
 }