isaacscript-common 24.1.1 → 25.0.1

package/dist/src/index.lua

@@ -135,14 +135,6 @@ do
         end
     end
 end
-do
-    local ____export = require("src.enums.SerializationBrand")
-    for ____exportKey, ____exportValue in pairs(____export) do
-        if ____exportKey ~= "default" then
-            ____exports[____exportKey] = ____exportValue
-        end
-    end
-end
 do
     local ____export = require("src.enums.SerializationType")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/src/objects/isaacAPIClassTypeToBrand.d.ts

@@ -1,4 +1,4 @@
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 export declare const ISAAC_API_CLASS_TYPE_TO_BRAND: {
     readonly BitSet128: SerializationBrand.BIT_SET_128;
     readonly Color: SerializationBrand.COLOR;

package/dist/src/objects/isaacAPIClassTypeToBrand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isaacAPIClassTypeToBrand.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToBrand.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,eAAO,MAAM,6BAA6B;;;;;;CAMgC,CAAC"}
+{"version":3,"file":"isaacAPIClassTypeToBrand.d.ts","sourceRoot":"","sources":["../../../src/objects/isaacAPIClassTypeToBrand.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,eAAO,MAAM,6BAA6B;;;;;;CAMgC,CAAC"}

package/dist/src/objects/isaacAPIClassTypeToBrand.lua

@@ -1,7 +1,7 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CopyableIsaacAPIClassType = ____isaac_2Dtypescript_2Ddefinitions.CopyableIsaacAPIClassType
-local ____SerializationBrand = require("src.enums.SerializationBrand")
+local ____SerializationBrand = require("src.enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 ____exports.ISAAC_API_CLASS_TYPE_TO_BRAND = {
     [CopyableIsaacAPIClassType.BIT_SET_128] = SerializationBrand.BIT_SET_128,

package/dist/src/serialization.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 declare function isSerializationBrand(key: unknown): boolean;
+//# sourceMappingURL=serialization.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../../src/serialization.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAM1D"}

package/dist/src/serialization.lua

@@ -0,0 +1,22 @@
+local ____lualib = require("lualib_bundle")
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____cachedEnumValues = require("src.arrays.cachedEnumValues")
+local SERIALIZATION_BRAND_VALUES = ____cachedEnumValues.SERIALIZATION_BRAND_VALUES
+local ____types = require("src.functions.types")
+local isString = ____types.isString
+local ____ReadonlySet = require("src.types.ReadonlySet")
+local ReadonlySet = ____ReadonlySet.ReadonlySet
+local SERIALIZATION_BRAND_SET = __TS__New(ReadonlySet, 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.
+function ____exports.isSerializationBrand(self, key)
+    if not isString(nil, key) then
+        return false
+    end
+    return SERIALIZATION_BRAND_SET:has(key)
+end
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "24.1.1",
+  "version": "25.0.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/arrays/cachedEnumValues.ts

@@ -20,7 +20,7 @@ import {
   TrinketSlot,
 } from "isaac-typescript-definitions";
 import { HealthType } from "../enums/HealthType";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { StatType } from "../enums/StatType";
 import { getEnumValues } from "../functions/enums";
 

package/src/core/constantsFirstLast.ts

@@ -10,7 +10,7 @@ import {
   RoomType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { getEnumLength, getLastEnumValue } from "../functions/enums";
+import { getEnumLength, getHighestEnumValue } from "../functions/enums";
 import { iRange } from "../functions/utils";
 
 // ------------
@@ -26,7 +26,8 @@ export const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
  * Note that this cannot be calculated from the length of the enum, because unlike all of the other
  * enums, collectible types are not contiguous.
  */
-export const LAST_VANILLA_COLLECTIBLE_TYPE = getLastEnumValue(CollectibleType);
+export const LAST_VANILLA_COLLECTIBLE_TYPE =
+  getHighestEnumValue(CollectibleType);
 
 /** Calculated from the `CollectibleType` enum. (`CollectibleType.NULL` is not included.) */
 export const NUM_VANILLA_COLLECTIBLE_TYPES = getEnumLength(CollectibleType) - 1;
@@ -39,7 +40,7 @@ export const NUM_VANILLA_COLLECTIBLE_TYPES = getEnumLength(CollectibleType) - 1;
 export const FIRST_TRINKET_TYPE = TrinketType.SWALLOWED_PENNY;
 
 /** Calculated from the `TrinketType` enum. */
-export const LAST_VANILLA_TRINKET_TYPE = getLastEnumValue(TrinketType);
+export const LAST_VANILLA_TRINKET_TYPE = getHighestEnumValue(TrinketType);
 
 /** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
 export const NUM_VANILLA_TRINKET_TYPES = getEnumLength(TrinketType) - 1;
@@ -52,7 +53,7 @@ export const NUM_VANILLA_TRINKET_TYPES = getEnumLength(TrinketType) - 1;
 export const FIRST_CARD_TYPE = CardType.FOOL;
 
 /** Calculated from the `Card` enum. */
-export const LAST_VANILLA_CARD_TYPE = getLastEnumValue(CardType);
+export const LAST_VANILLA_CARD_TYPE = getHighestEnumValue(CardType);
 
 /** Calculated from the `Card` enum. `Card.NULL` is not included. */
 export const NUM_VANILLA_CARD_TYPES = getEnumLength(CardType) - 1;
@@ -65,7 +66,7 @@ export const NUM_VANILLA_CARD_TYPES = getEnumLength(CardType) - 1;
 export const FIRST_PILL_EFFECT = PillEffect.BAD_GAS;
 
 /** Calculated from the `PillEffect` enum. */
-export const LAST_VANILLA_PILL_EFFECT = getLastEnumValue(PillEffect);
+export const LAST_VANILLA_PILL_EFFECT = getHighestEnumValue(PillEffect);
 
 /**
  * Calculated from the `PillEffect` enum. (There is no `PillEffect.NULL` in the custom enum, so we
@@ -114,18 +115,18 @@ export const FIRST_CHARACTER = PlayerType.ISAAC;
 // It is not possible to determine "LAST_PLAYER_TYPE", since there is no associated config.
 
 /** Calculated from the `PlayerType` enum. */
-export const LAST_VANILLA_CHARACTER = getLastEnumValue(PlayerType);
+export const LAST_VANILLA_CHARACTER = getHighestEnumValue(PlayerType);
 
 // ----------
 // Room Types
 // ----------
 
 export const FIRST_ROOM_TYPE = RoomType.DEFAULT;
-export const LAST_ROOM_TYPE = getLastEnumValue(RoomType);
+export const LAST_ROOM_TYPE = getHighestEnumValue(RoomType);
 
 // ------
 // Stages
 // ------
 
 export const FIRST_STAGE = LevelStage.BASEMENT_1;
-export const LAST_STAGE = getLastEnumValue(LevelStage);
+export const LAST_STAGE = getHighestEnumValue(LevelStage);

package/src/functions/bitSet128.ts

@@ -1,5 +1,5 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isIsaacAPIClassOfType } from "./isaacAPIClass";
 import {
   copyUserdataValuesToTable,

package/src/functions/color.ts

@@ -1,5 +1,5 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandom } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";

package/src/functions/deepCopy.ts

@@ -1,7 +1,8 @@
 import { DefaultMap } from "../classes/DefaultMap";
 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 { TSTLClass } from "../types/TSTLClass";
 import { isArray } from "./array";
@@ -11,7 +12,6 @@ import {
   copyIsaacAPIClass,
   deserializeIsaacAPIClass,
   isCopyableIsaacAPIClass,
-  isSerializationBrand,
   isSerializedIsaacAPIClass,
   serializeIsaacAPIClass,
 } from "./serialization";

package/src/functions/deepCopyTests.ts

@@ -1,5 +1,5 @@
 import { DefaultMap } from "../classes/DefaultMap";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
 import { arrayEquals } from "./array";
 import { deepCopy } from "./deepCopy";

package/src/functions/enums.ts

@@ -97,7 +97,7 @@ export function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]> {
  * Note that this is not necessarily the enum value that is declared last, since there is no way to
  * infer that at run-time.
  */
-export function getLastEnumValue<T>(transpiledEnum: T): T[keyof T] {
+export function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T] {
   const enumValues = getEnumValues(transpiledEnum);
 
   const lastElement = enumValues[enumValues.length - 1];

package/src/functions/kColor.ts

@@ -1,5 +1,5 @@
 import { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
-import { SerializationBrand } from "../enums/SerializationBrand";
+import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { getRandom } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";

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);
+}