isaacscript-common 20.18.1 → 21.0.0

package/src/sets/familiarsThatShootPlayerTearsSet.ts

@@ -1,7 +1,8 @@
 import { FamiliarVariant } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET: ReadonlySet<FamiliarVariant> =
-  new Set([
+export const FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET =
+  new ReadonlySet<FamiliarVariant>([
     FamiliarVariant.SCISSORS,
     FamiliarVariant.INCUBUS,
     FamiliarVariant.FATES_REWARD,

package/src/sets/itemConfigCardTypesForCardsSet.ts

@@ -0,0 +1,11 @@
+import { ItemConfigCardType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
+
+/** The set of all `ItemConfigCardType` values that are not a rune or special object. */
+export const ITEM_CONFIG_CARD_TYPES_FOR_CARDS_SET =
+  new ReadonlySet<ItemConfigCardType>([
+    ItemConfigCardType.TAROT,
+    ItemConfigCardType.SUIT,
+    ItemConfigCardType.SPECIAL,
+    ItemConfigCardType.TAROT_REVERSE,
+  ]);

package/src/sets/lostStyleCharactersSet.ts

@@ -1,10 +1,11 @@
 import { PlayerType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
 /**
  * This is the set of characters that look like The Lost and play the "LostDeath" animation when
  * they die.
  */
-export const LOST_STYLE_CHARACTERS_SET: ReadonlySet<PlayerType> = new Set([
+export const LOST_STYLE_CHARACTERS_SET = new ReadonlySet<PlayerType>([
   PlayerType.LOST, // 10
   PlayerType.SOUL, // 17
   PlayerType.LOST_B, // 31

package/src/sets/mineShaftRoomSubTypesSet.ts

@@ -1,10 +1,10 @@
 import { MinesRoomSubType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const MINE_SHAFT_ROOM_SUB_TYPE_SET: ReadonlySet<MinesRoomSubType> =
-  new Set([
-    MinesRoomSubType.MINESHAFT_ENTRANCE,
-    MinesRoomSubType.MINESHAFT_LOBBY,
-    MinesRoomSubType.MINESHAFT_KNIFE_PIECE,
-    MinesRoomSubType.MINESHAFT_ROOM_PRE_CHASE,
-    MinesRoomSubType.MINESHAFT_ROOM_POST_CHASE,
-  ]);
+export const MINE_SHAFT_ROOM_SUB_TYPE_SET = new ReadonlySet<MinesRoomSubType>([
+  MinesRoomSubType.MINESHAFT_ENTRANCE,
+  MinesRoomSubType.MINESHAFT_LOBBY,
+  MinesRoomSubType.MINESHAFT_KNIFE_PIECE,
+  MinesRoomSubType.MINESHAFT_ROOM_PRE_CHASE,
+  MinesRoomSubType.MINESHAFT_ROOM_POST_CHASE,
+]);

package/src/sets/narrowRoomShapesSet.ts

@@ -1,6 +1,7 @@
 import { RoomShape } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const NARROW_ROOM_SHAPES_SET: ReadonlySet<RoomShape> = new Set([
+export const NARROW_ROOM_SHAPES_SET = new ReadonlySet<RoomShape>([
   RoomShape.IH, // 2
   RoomShape.IV, // 3
   RoomShape.IIV, // 5

package/src/sets/redHeartSubTypesSet.ts

@@ -1,6 +1,7 @@
 import { HeartSubType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const RED_HEART_SUB_TYPES_SET: ReadonlySet<HeartSubType> = new Set([
+export const RED_HEART_SUB_TYPES_SET = new ReadonlySet<HeartSubType>([
   HeartSubType.FULL, // 1
   HeartSubType.HALF, // 2
   HeartSubType.DOUBLE_PACK, // 5

package/src/sets/sinEntityTypesSet.ts

@@ -1,6 +1,7 @@
 import { EntityType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const SIN_ENTITY_TYPES_SET: ReadonlySet<EntityType> = new Set([
+export const SIN_ENTITY_TYPES_SET = new ReadonlySet<EntityType>([
   EntityType.SLOTH, // 46
   EntityType.LUST, // 47
   EntityType.WRATH, // 48

package/src/sets/singleUseActiveCollectibleTypesSet.ts

@@ -1,7 +1,8 @@
 import { CollectibleType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET: ReadonlySet<CollectibleType> =
-  new Set([
+export const SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET =
+  new ReadonlySet<CollectibleType>([
     CollectibleType.FORGET_ME_NOW, // 127
     CollectibleType.EDENS_SOUL, // 490
     CollectibleType.ALABASTER_BOX, // 585

package/src/sets/storyBossesSet.ts

@@ -1,6 +1,7 @@
 import { EntityType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
 
-export const STORY_BOSSES_SET: ReadonlySet<EntityType> = new Set([
+export const STORY_BOSSES_SET = new ReadonlySet<EntityType>([
   EntityType.MOM, // 45
   EntityType.MOMS_HEART, // 78
   EntityType.SATAN, // 84

package/src/types/PickingUpItem.ts

@@ -9,6 +9,7 @@ import {
   ItemType,
   TrinketType,
 } from "isaac-typescript-definitions";
+import { ReadonlySet } from "./ReadonlySet";
 
 export type PickingUpItem =
   | PickingUpItemNull
@@ -57,7 +58,7 @@ export function resetPickingUpItem(pickingUpItem: PickingUpItem): void {
   pickingUpItem.subType = DEFAULT_SUB_TYPE;
 }
 
-const COLLECTIBLE_ITEM_TYPES: ReadonlySet<ItemType> = new Set([
+const COLLECTIBLE_ITEM_TYPES = new ReadonlySet<ItemType>([
   ItemType.PASSIVE, // 1
   ItemType.ACTIVE, // 3
   ItemType.FAMILIAR, // 4

package/src/types/ReadonlyMap.ts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+interface ReadonlyMapConstructor {
+  new (): ReadonlyMap<any, any>;
+  new <K, V>(entries?: ReadonlyArray<readonly [K, V]> | null): ReadonlyMap<
+    K,
+    V
+  >;
+  readonly prototype: ReadonlyMap<any, any>;
+}
+
+/** An alias for the `Map` constructor that returns a read-only map. */
+export const ReadonlyMap = Map as ReadonlyMapConstructor;

package/src/types/ReadonlySet.ts

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+interface ReadonlySetConstructor {
+  new <T = any>(values?: readonly T[] | null): ReadonlySet<T>;
+  readonly prototype: ReadonlySet<any>;
+}
+
+/** An alias for the `Set` constructor that returns a read-only set. */
+export const ReadonlySet = Set as ReadonlySetConstructor;

package/dist/src/types/HasAllEnumKeys.d.ts

@@ -1,26 +0,0 @@
-/**
- * Helper type to ensure that an object contains a key for every enum member. Use this with `as
- * const` and `satisfies` to prevent narrowing the type of the object.
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * const MyEnumToString = {
- *   [MyEnum.Value1]: "foo",
- *   [MyEnum.Value2]: "bar",
- *   [MyEnum.Value3]: "baz",
- * } as const satisfies HasAllEnumKeys<MyEnum, string>;
- *
- * const value = MyEnumToString[MyEnum.Value2];
- * ```
- */
-export type HasAllEnumKeys<Enum extends string | number, T> = {
-    readonly [Key in Enum]: T;
-};
-//# sourceMappingURL=HasAllEnumKeys.d.ts.map

package/dist/src/types/HasAllEnumKeys.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HasAllEnumKeys.d.ts","sourceRoot":"","sources":["../../../src/types/HasAllEnumKeys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI;IAC5D,QAAQ,EAAE,GAAG,IAAI,IAAI,GAAG,CAAC;CAC1B,CAAC"}

package/dist/src/types/HasAllEnumKeys.lua

@@ -1,2 +0,0 @@
-local ____exports = {}
-return ____exports

package/src/types/HasAllEnumKeys.ts

@@ -1,25 +0,0 @@
-/**
- * Helper type to ensure that an object contains a key for every enum member. Use this with `as
- * const` and `satisfies` to prevent narrowing the type of the object.
- *
- * For example:
- *
- * ```ts
- * enum MyEnum {
- *   Value1,
- *   Value2,
- *   Value3,
- * }
- *
- * const MyEnumToString = {
- *   [MyEnum.Value1]: "foo",
- *   [MyEnum.Value2]: "bar",
- *   [MyEnum.Value3]: "baz",
- * } as const satisfies HasAllEnumKeys<MyEnum, string>;
- *
- * const value = MyEnumToString[MyEnum.Value2];
- * ```
- */
-export type HasAllEnumKeys<Enum extends string | number, T> = {
-  readonly [Key in Enum]: T;
-};