isaacscript-common 14.1.3 → 15.0.0

package/src/features/saveDataManager/main.ts

@@ -1,351 +0,0 @@
-import { CollectibleType, ModCallback } from "isaac-typescript-definitions";
-import { game } from "../../core/cachedClasses";
-import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
-import { SaveDataKey } from "../../enums/SaveDataKey";
-import { SerializationType } from "../../enums/SerializationType";
-import { deepCopy } from "../../functions/deepCopy";
-import { logError } from "../../functions/logMisc";
-import { onFirstFloor } from "../../functions/stage";
-import { clearTable, iterateTableInOrder } from "../../functions/table";
-import { SaveData } from "../../interfaces/SaveData";
-import { CallbackTuple } from "../../types/private/CallbackTuple";
-import {
-  SAVE_DATA_MANAGER_DEBUG,
-  SAVE_DATA_MANAGER_FEATURE_NAME,
-  SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS,
-  SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY,
-} from "./constants";
-import { loadFromDisk } from "./load";
-import {
-  saveDataConditionalFuncMap,
-  saveDataDefaultsMap,
-  saveDataGlowingHourGlassMap,
-  saveDataMap,
-} from "./maps";
-import { merge } from "./merge";
-import { saveToDisk } from "./save";
-
-const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey> = new Set([
-  SaveDataKey.RUN,
-  SaveDataKey.LEVEL,
-  SaveDataKey.ROOM,
-]);
-
-let mod: Mod | null = null;
-let loadedDataOnThisRun = false;
-let restoreGlowingHourGlassDataOnNextRoom = false;
-
-export const SAVE_DATA_MANAGER_CALLBACKS: CallbackTuple[] = [
-  [
-    ModCallback.POST_USE_ITEM,
-    [postUseItemGlowingHourGlass, CollectibleType.GLOWING_HOUR_GLASS],
-  ], // 3
-  [ModCallback.POST_PLAYER_INIT, [postPlayerInit]], // 9
-  [ModCallback.PRE_GAME_EXIT, [preGameExit]], // 17
-  [ModCallback.POST_NEW_LEVEL, [postNewLevel]], // 18
-];
-
-// TODO: add tuple type annotation
-export const SAVE_DATA_MANAGER_CUSTOM_CALLBACKS = [
-  [ModCallbackCustom.POST_NEW_ROOM_EARLY, [postNewRoomEarly]],
-] as const;
-
-export function saveDataManagerInit(incomingMod: Mod): void {
-  mod = incomingMod;
-}
-
-// ModCallback.POST_USE_ITEM (3)
-// CollectibleType.GLOWING_HOUR_GLASS (422)
-function postUseItemGlowingHourGlass(): boolean | undefined {
-  restoreGlowingHourGlassDataOnNextRoom = true;
-  return undefined;
-}
-
-// ModCallback.POST_PLAYER_INIT (9)
-// eslint-disable-next-line isaacscript/no-void-return-type
-function postPlayerInit(): void {
-  if (mod === null) {
-    error(
-      `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
-    );
-  }
-
-  // We want to only load data once per run to handle the case of a player using Genesis, a second
-  // player joining the run, and so on.
-  if (loadedDataOnThisRun) {
-    return;
-  }
-  loadedDataOnThisRun = true;
-
-  // Handle the race-condition of using the Glowing Hour Glass and then resetting the run.
-  restoreGlowingHourGlassDataOnNextRoom = false;
-
-  // We want to unconditionally load save data on every new run since there might be persistent data
-  // that is not tied to an individual run.
-  loadFromDisk(mod, saveDataMap);
-
-  const gameFrameCount = game.GetFrameCount();
-  const isContinued = gameFrameCount !== 0;
-  if (!isContinued) {
-    restoreDefaultsAll();
-  }
-
-  // On continued runs, the `POST_NEW_LEVEL` callback will not fire, so we do not have to worry
-  // about saved data based on level getting overwritten.
-}
-
-// ModCallback.PRE_GAME_EXIT (17)
-// eslint-disable-next-line isaacscript/no-void-return-type
-function preGameExit(): void {
-  if (mod === null) {
-    error(
-      `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
-    );
-  }
-
-  // We unconditionally save variables to disk (because regardless of a save & quit or a death,
-  // persistent variables should be recorded).
-  saveToDisk(mod, saveDataMap, saveDataConditionalFuncMap);
-
-  restoreDefaultsAll();
-  loadedDataOnThisRun = false;
-}
-
-// ModCallback.POST_NEW_LEVEL (18)
-// eslint-disable-next-line isaacscript/no-void-return-type
-function postNewLevel(): void {
-  if (mod === null) {
-    error(
-      `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
-    );
-  }
-
-  restoreDefaults(SaveDataKey.LEVEL);
-
-  // We save data to disk at the beginning of every floor (for the 2nd floor and beyond) to emulate
-  // what the game does internally. (This mitigates data loss in the event of a crash).
-  if (!onFirstFloor()) {
-    saveToDisk(mod, saveDataMap, saveDataConditionalFuncMap);
-  }
-}
-
-// ModCallbackCustom.POST_NEW_ROOM_EARLY
-// eslint-disable-next-line isaacscript/no-void-return-type
-function postNewRoomEarly(): void {
-  restoreDefaults(SaveDataKey.ROOM);
-
-  // Handle the Glowing Hour Glass.
-  if (restoreGlowingHourGlassDataOnNextRoom) {
-    restoreGlowingHourGlassDataOnNextRoom = false;
-    restoreGlowingHourGlassBackup();
-  } else {
-    makeGlowingHourGlassBackup();
-  }
-}
-
-function makeGlowingHourGlassBackup() {
-  iterateTableInOrder(
-    saveDataMap,
-    (subscriberName, saveData) => {
-      // We make the Glowing Hour Glass backup using `SerializationType.SERIALIZE`, which means that
-      // we cannot operate on unserializable data, such as functions. Save data that utilizes
-      // unserializable data will typically be marked using a conditional function that evaluates to
-      // false, so we skip all save data that matches this criteria.
-      const conditionalFunc = saveDataConditionalFuncMap.get(subscriberName);
-      if (conditionalFunc !== undefined) {
-        const shouldSave = conditionalFunc();
-        if (!shouldSave) {
-          return;
-        }
-      }
-
-      for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
-        const childTable = saveData[saveDataKey];
-        if (childTable === undefined) {
-          // This feature does not happen to store any variables on this particular child table.
-          continue;
-        }
-
-        // Ignore child tables that the end-user has explicitly annotated.
-        const childTableLuaMap = childTable as LuaMap<AnyNotNil, unknown>;
-        if (
-          childTableLuaMap.has(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY)
-        ) {
-          continue;
-        }
-
-        let saveDataGlowingHourGlass =
-          saveDataGlowingHourGlassMap.get(subscriberName);
-        if (saveDataGlowingHourGlass === undefined) {
-          saveDataGlowingHourGlass = new LuaMap<string, unknown>() as SaveData;
-          saveDataGlowingHourGlassMap.set(
-            subscriberName,
-            saveDataGlowingHourGlass,
-          );
-        }
-
-        // We serialize the table so that we can use the `merge` function later on with no other
-        // modifications.
-        const copiedChildTable = deepCopy(
-          childTable,
-          SerializationType.SERIALIZE,
-        ) as Record<string, unknown>;
-        saveDataGlowingHourGlass[saveDataKey] = copiedChildTable;
-      }
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}
-
-function restoreGlowingHourGlassBackup() {
-  iterateTableInOrder(
-    saveDataMap,
-    (subscriberName, saveData) => {
-      // We make the Glowing Hour Glass backup using `SerializationType.SERIALIZE`, which means that
-      // we cannot operate on unserializable data, such as functions. Save data that utilizes
-      // unserializable data will typically be marked using a conditional function that evaluates to
-      // false, so we skip all save data that matches this criteria.
-      const conditionalFunc = saveDataConditionalFuncMap.get(subscriberName);
-      if (conditionalFunc !== undefined) {
-        const shouldSave = conditionalFunc();
-        if (!shouldSave) {
-          return;
-        }
-      }
-
-      for (const saveDataKey of SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS) {
-        const childTable = saveData[saveDataKey];
-        if (childTable === undefined) {
-          // This feature does not happen to store any variables on this particular child table.
-          continue;
-        }
-
-        // Ignore child tables that the end-user has explicitly annotated.
-        const childTableLuaMap = childTable as LuaMap<AnyNotNil, unknown>;
-        if (
-          childTableLuaMap.has(SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY)
-        ) {
-          continue;
-        }
-
-        const saveDataGlowingHourGlass =
-          saveDataGlowingHourGlassMap.get(subscriberName);
-        if (saveDataGlowingHourGlass === undefined) {
-          // This should never happen.
-          continue;
-        }
-
-        const childTableBackup = saveDataGlowingHourGlass[saveDataKey];
-        if (childTableBackup === undefined) {
-          // This should never happen.
-          continue;
-        }
-
-        merge(
-          childTable as LuaMap<AnyNotNil, unknown>,
-          childTableBackup as LuaMap<AnyNotNil, unknown>,
-          // Append an arbitrary suffix for better error messages.
-          `${subscriberName}__glowingHourGlass`,
-        );
-      }
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}
-
-function restoreDefaultsAll() {
-  restoreDefaults(SaveDataKey.RUN);
-  restoreDefaults(SaveDataKey.LEVEL);
-  restoreDefaults(SaveDataKey.ROOM);
-}
-
-function restoreDefaults(saveDataKey: SaveDataKey) {
-  iterateTableInOrder(
-    saveDataMap,
-    (subscriberName, saveData) => {
-      restoreDefaultSaveData(subscriberName, saveData, saveDataKey);
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}
-
-export function restoreDefaultSaveData(
-  subscriberName: string,
-  saveData: SaveData,
-  saveDataKey: SaveDataKey,
-): void {
-  // Only allow certain save data keys to be reset.
-  if (!RESETTABLE_SAVE_DATA_KEYS.has(saveDataKey)) {
-    error(`Unknown save data key name of: ${saveDataKey}`);
-  }
-
-  const childTable = saveData[saveDataKey];
-  if (childTable === undefined) {
-    // This feature does not happen to store any variables on this particular child table.
-    return;
-  }
-
-  // Get the default values for this feature.
-  const saveDataDefaults = saveDataDefaultsMap.get(subscriberName);
-  if (saveDataDefaults === undefined) {
-    logError(
-      `Failed to find the default copy of the save data for subscriber: ${subscriberName}`,
-    );
-    return;
-  }
-
-  // Get the default values for the specific sub-table of this feature.
-  const childTableDefaults = saveDataDefaults[saveDataKey];
-  if (childTableDefaults === undefined) {
-    logError(
-      `Failed to find the default copy of the child table "${saveDataKey}" for subscriber "${subscriberName}". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data`,
-    );
-    return;
-  }
-
-  // Make a new copy of the default child table.
-  const childTableDefaultsCopy = deepCopy(
-    childTableDefaults,
-    SerializationType.NONE,
-    `${subscriberName} --> ${saveDataKey}`,
-  ) as LuaMap<AnyNotNil, unknown>;
-
-  // We do not want to blow away the existing child table because we don't want to break any
-  // existing references. Instead, empty the table and copy all of the elements from the copy of the
-  // defaults table.
-  clearAndCopyAllElements(
-    childTable as unknown as LuaMap<AnyNotNil, unknown>,
-    childTableDefaultsCopy,
-  );
-}
-
-/**
- * Will empty the old table of all elements, and then shallow copy all the elements from the new
- * table to the old table.
- */
-function clearAndCopyAllElements(
-  oldTable: LuaMap<AnyNotNil, unknown>,
-  newTable: LuaMap<AnyNotNil, unknown>,
-) {
-  clearTable(oldTable);
-
-  for (const [key, value] of newTable) {
-    oldTable.set(key, value);
-  }
-}
-
-export function forceSaveDataManagerSave(): void {
-  if (mod === null) {
-    return;
-  }
-
-  saveToDisk(mod, saveDataMap, saveDataConditionalFuncMap);
-}
-
-export function forceSaveDataManagerLoad(): void {
-  if (mod === null) {
-    return;
-  }
-
-  loadFromDisk(mod, saveDataMap);
-}

package/src/features/saveDataManager/maps.ts

@@ -1,20 +0,0 @@
-import { SaveData } from "../../interfaces/SaveData";
-
-/**
- * The save data map is indexed by subscriber name. We use Lua tables instead of TypeScriptToLua
- * Maps for the master map so that we can access the variables via the in-game console when
- * debugging. (TSTL Maps don't expose the map keys as normal keys.)
- */
-export const saveDataMap = new LuaMap<string, SaveData>();
-
-export const saveDataDefaultsMap = new LuaMap<string, SaveData>();
-export const saveDataConditionalFuncMap = new LuaMap<string, () => boolean>();
-
-/**
- * We backup some save data keys on every new room for the purposes of restoring it when Glowing
- * Hour Glass is used.
- *
- * Note that the save data is backed up in serialized form so that we can use the `merge` function
- * to restore it.
- */
-export const saveDataGlowingHourGlassMap = new LuaMap<string, SaveData>();

package/src/features/saveDataManager/merge.ts

@@ -1,205 +0,0 @@
-import { SerializationBrand } from "../../enums/private/SerializationBrand";
-import { SerializationType } from "../../enums/SerializationType";
-import { isArray } from "../../functions/array";
-import { deepCopy } from "../../functions/deepCopy";
-import { log } from "../../functions/log";
-import {
-  deserializeIsaacAPIClass,
-  isSerializedIsaacAPIClass,
-} from "../../functions/serialization";
-import { clearTable, iterateTableInOrder } from "../../functions/table";
-import { isDefaultMap, isTSTLMap, isTSTLSet } from "../../functions/tstlClass";
-import { isTable } from "../../functions/types";
-import { getTraversalDescription } from "../../functions/utils";
-import { SAVE_DATA_MANAGER_DEBUG } from "./constants";
-import { isSerializationBrand } from "./serializationBrands";
-
-/**
- * `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:
- *
- * - 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
- *
- * 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.
- */
-export function merge(
-  oldObject:
-    | LuaMap<AnyNotNil, unknown>
-    | Map<AnyNotNil, unknown>
-    | Set<AnyNotNil>,
-  newTable: LuaMap<AnyNotNil, unknown>,
-  traversalDescription: string,
-): void {
-  if (SAVE_DATA_MANAGER_DEBUG) {
-    log(`merge is traversing: ${traversalDescription}`);
-  }
-
-  if (!isTable(oldObject)) {
-    error("The first argument given to the merge function is not a table.");
-  }
-
-  if (!isTable(newTable)) {
-    error("The second argument given to the merge function is not a table.");
-  }
-
-  // First, handle the special case of an array with a shallow copy.
-  if (isArray(oldObject) && isArray(newTable)) {
-    mergeSerializedArray(oldObject, newTable, traversalDescription);
-    return;
-  }
-
-  // Depending on whether we are working on a Lua table or a TypeScriptToLua object, we need to
-  // iterate in a specific way.
-  if (isTSTLMap(oldObject) || isTSTLSet(oldObject) || isDefaultMap(oldObject)) {
-    mergeSerializedTSTLObject(oldObject, newTable, traversalDescription);
-  } else {
-    mergeSerializedTable(oldObject, newTable, traversalDescription);
-  }
-}
-
-function mergeSerializedArray(
-  oldArray: LuaMap<AnyNotNil, unknown>,
-  newArray: LuaMap<AnyNotNil, unknown>,
-  traversalDescription: string,
-) {
-  if (SAVE_DATA_MANAGER_DEBUG) {
-    log(`merge encountered an array: ${traversalDescription}`);
-  }
-
-  // Assume that we should blow away all array values with whatever is present in the incoming
-  // array.
-  clearTable(oldArray);
-  iterateTableInOrder(
-    newArray,
-    (key, value) => {
-      oldArray.set(key, value);
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}
-
-function mergeSerializedTSTLObject(
-  oldObject: Map<AnyNotNil, unknown> | Set<AnyNotNil>,
-  newTable: LuaMap<AnyNotNil, unknown>,
-  traversalDescription: string,
-) {
-  if (SAVE_DATA_MANAGER_DEBUG) {
-    log(`merge encountered a TSTL object: ${traversalDescription}`);
-  }
-
-  // We blow away the old object and recursively copy over all of the incoming values.
-  oldObject.clear();
-
-  // During serialization, we brand some Lua tables with a special identifier to signify that it has
-  // keys that should be deserialized to numbers.
-  const convertStringKeysToNumbers = newTable.has(
-    SerializationBrand.OBJECT_WITH_NUMBER_KEYS,
-  );
-
-  iterateTableInOrder(
-    newTable,
-    (key, value) => {
-      if (isSerializationBrand(key)) {
-        return;
-      }
-
-      let keyToUse = key;
-      if (convertStringKeysToNumbers) {
-        const numberKey = tonumber(key);
-        if (numberKey === undefined) {
-          return;
-        }
-        keyToUse = numberKey;
-      }
-
-      if (isTSTLMap(oldObject) || isDefaultMap(oldObject)) {
-        let valueCopy: unknown;
-        if (isTable(value)) {
-          valueCopy = deepCopy(
-            value,
-            SerializationType.DESERIALIZE,
-            traversalDescription,
-          );
-        } else {
-          valueCopy = value;
-        }
-
-        oldObject.set(keyToUse, valueCopy);
-      } else if (isTSTLSet(oldObject)) {
-        oldObject.add(keyToUse);
-      }
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}
-
-function mergeSerializedTable(
-  oldTable: LuaMap<AnyNotNil, unknown>,
-  newTable: LuaMap<AnyNotNil, unknown>,
-  traversalDescription: string,
-) {
-  if (SAVE_DATA_MANAGER_DEBUG) {
-    log(`merge encountered a Lua table: ${traversalDescription}`);
-  }
-
-  iterateTableInOrder(
-    newTable,
-    (key, value) => {
-      if (SAVE_DATA_MANAGER_DEBUG) {
-        const valueToPrint = value === "" ? "(empty string)" : `${value}`;
-        log(`merge is merging: ${traversalDescription} --> ${valueToPrint}`);
-      }
-
-      if (isSerializationBrand(key)) {
-        return;
-      }
-
-      // Handle the special case of serialized Isaac API classes.
-      if (isSerializedIsaacAPIClass(value)) {
-        if (SAVE_DATA_MANAGER_DEBUG) {
-          log("merge found a serialized Isaac API class.");
-        }
-
-        const deserializedObject = deserializeIsaacAPIClass(value);
-        oldTable.set(key, deserializedObject);
-        return;
-      }
-
-      if (isTable(value)) {
-        let oldValue = oldTable.get(key) as LuaMap<AnyNotNil, unknown>;
-        if (!isTable(oldValue)) {
-          // The child table does not exist on the old table. However, we still need to copy over
-          // the new table, because we need to handle data types like "Foo | null". Thus, set up a
-          // blank sub-table on the old table, and continue to recursively merge..
-          oldValue = new LuaMap();
-          oldTable.set(key, oldValue);
-        }
-
-        traversalDescription = getTraversalDescription(
-          key,
-          traversalDescription,
-        );
-        merge(oldValue, value, traversalDescription);
-      } else {
-        // Base case: copy the value
-        oldTable.set(key, value);
-      }
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-}

package/src/features/saveDataManager/save.ts

@@ -1,75 +0,0 @@
-import { SerializationType } from "../../enums/SerializationType";
-import { deepCopy } from "../../functions/deepCopy";
-import { jsonEncode } from "../../functions/jsonHelpers";
-import { log } from "../../functions/log";
-import { isTableEmpty, iterateTableInOrder } from "../../functions/table";
-import { SaveData } from "../../interfaces/SaveData";
-import {
-  SAVE_DATA_MANAGER_DEBUG,
-  SAVE_DATA_MANAGER_FEATURE_NAME,
-} from "./constants";
-
-export function saveToDisk(
-  mod: Mod,
-  saveDataMap: LuaMap<string, SaveData>,
-  saveDataConditionalFuncMap: LuaMap<string, () => boolean>,
-): void {
-  const allSaveData = getAllSaveDataToWriteToDisk(
-    saveDataMap,
-    saveDataConditionalFuncMap,
-  );
-  const jsonString = jsonEncode(allSaveData);
-  mod.SaveData(jsonString); // Write it to the "save#.dat" file
-  log(
-    `The ${SAVE_DATA_MANAGER_FEATURE_NAME} wrote data to the "save#.dat" file.`,
-  );
-}
-
-function getAllSaveDataToWriteToDisk(
-  saveDataMap: LuaMap<string, SaveData>,
-  saveDataConditionalFuncMap: LuaMap<string, () => boolean>,
-) {
-  const allSaveData = new LuaMap<AnyNotNil, unknown>();
-
-  iterateTableInOrder(
-    saveDataMap,
-    (subscriberName, saveData) => {
-      // Handle the feature of the save data manager where certain mod features can conditionally
-      // write their data to disk.
-      const conditionalFunc = saveDataConditionalFuncMap.get(subscriberName);
-      if (conditionalFunc !== undefined) {
-        const shouldSave = conditionalFunc();
-        if (!shouldSave) {
-          return;
-        }
-      }
-
-      // Strip out the room part of the save data (and any other arbitrary fields that they might
-      // have added).
-      const saveDataWithoutRoom: SaveData = {
-        persistent: saveData.persistent,
-        run: saveData.run,
-        level: saveData.level,
-      };
-
-      // If there is no data, then we can move on to the next feature.
-      if (isTableEmpty(saveDataWithoutRoom as LuaTable<AnyNotNil, unknown>)) {
-        return;
-      }
-
-      // If we encode TypeScriptToLua Maps into JSON, it will result in a lot of extraneous data
-      // that is unnecessary. Make a copy of the data and recursively convert all TypeScriptToLua
-      // Maps into Lua tables.
-      const saveDataCopy = deepCopy(
-        saveDataWithoutRoom,
-        SerializationType.SERIALIZE,
-        subscriberName,
-      );
-
-      allSaveData.set(subscriberName, saveDataCopy);
-    },
-    SAVE_DATA_MANAGER_DEBUG,
-  );
-
-  return allSaveData;
-}

package/src/features/saveDataManager/serializationBrands.ts

@@ -1,16 +0,0 @@
-import { SerializationBrand } from "../../enums/private/SerializationBrand";
-import { getEnumValues } from "../../functions/enums";
-import { isString } from "../../functions/types";
-
-const SERIALIZATION_BRANDS = getEnumValues(SerializationBrand);
-const SERIALIZATION_BRAND_SET: ReadonlySet<string> = new Set(
-  SERIALIZATION_BRANDS,
-);
-
-export function isSerializationBrand(key: unknown): boolean {
-  if (!isString(key)) {
-    return false;
-  }
-
-  return SERIALIZATION_BRAND_SET.has(key);
-}