isaacscript-common 25.0.0 → 25.0.1

package/src/functions/merge.ts

@@ -1,13 +1,13 @@
 import { SAVE_DATA_MANAGER_DEBUG } from "../classes/features/other/saveDataManager/constants";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
+import { isSerializationBrand } from "../serialization";
 import { AnyClass } from "../types/AnyClass";
 import { isArray } from "./array";
 import { deepCopy } from "./deepCopy";
 import { log } from "./log";
 import {
   deserializeIsaacAPIClass,
-  isSerializationBrand,
   isSerializedIsaacAPIClass,
 } from "./serialization";
 import { clearTable, iterateTableInOrder } from "./table";

package/src/functions/rng.ts

@@ -1,6 +1,6 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";

package/src/functions/serialization.ts

@@ -1,5 +1,4 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SERIALIZATION_BRAND_VALUES } from "../arrays/cachedEnumValues";
 import { ISAAC_API_CLASS_TYPE_TO_BRAND } from "../objects/isaacAPIClassTypeToBrand";
 import {
   CopyableIsaacAPIClass,
@@ -9,13 +8,8 @@ import {
   ISAAC_API_CLASS_TYPE_TO_FUNCTIONS,
   SerializedIsaacAPIClass,
 } from "../objects/isaacAPIClassTypeToFunctions";
-import { ReadonlySet } from "../types/ReadonlySet";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
-import { isString, isTable, isUserdata } from "./types";
-
-const SERIALIZATION_BRAND_SET = new ReadonlySet<string>(
-  SERIALIZATION_BRAND_VALUES,
-);
+import { isTable, isUserdata } from "./types";
 
 /**
  * Helper function to generically copy an Isaac API class without knowing what specific type of
@@ -142,23 +136,6 @@ export function isCopyableIsaacAPIClass(
   return isFunctions.some((identityFunction) => identityFunction(object));
 }
 
-/**
- * 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
- */
-export function isSerializationBrand(key: unknown): boolean {
-  if (!isString(key)) {
-    return false;
-  }
-
-  return SERIALIZATION_BRAND_SET.has(key);
-}
-
 /**
  * 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/src/functions/vector.ts

@@ -2,7 +2,7 @@ import {
   CopyableIsaacAPIClassType,
   Direction,
 } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { angleToDirection } from "./direction";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandomFloat } from "./random";

package/src/index.ts

@@ -15,7 +15,6 @@ export * from "./enums/MysteriousPaperEffect";
 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";

package/src/objects/isaacAPIClassTypeToBrand.ts

@@ -1,5 +1,5 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 
 export const ISAAC_API_CLASS_TYPE_TO_BRAND = {
   [CopyableIsaacAPIClassType.BIT_SET_128]: SerializationBrand.BIT_SET_128,

package/src/serialization.ts

@@ -0,0 +1,22 @@
+import { SERIALIZATION_BRAND_VALUES } from "./arrays/cachedEnumValues";
+import { isString } from "./functions/types";
+import { ReadonlySet } from "./types/ReadonlySet";
+
+const SERIALIZATION_BRAND_SET = new ReadonlySet<string>(
+  SERIALIZATION_BRAND_VALUES,
+);
+
+/**
+ * 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 separated from the other serialization functions because end-users would not normally be
+ * iterating through a serialized object directly.
+ */
+export function isSerializationBrand(key: unknown): boolean {
+  if (!isString(key)) {
+    return false;
+  }
+
+  return SERIALIZATION_BRAND_SET.has(key);
+}