isaacscript-common 17.4.3 → 17.5.0

package/src/objects/pillEffectTypes.ts

@@ -2,12 +2,11 @@ import {
   ItemConfigPillEffectType,
   PillEffect,
 } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
 export const DEFAULT_PILL_EFFECT_TYPE = ItemConfigPillEffectType.MODDED;
 
-export const PILL_EFFECT_TYPES: {
-  readonly [key in PillEffect]: ItemConfigPillEffectType;
-} = {
+export const PILL_EFFECT_TYPES = {
   [PillEffect.BAD_GAS]: ItemConfigPillEffectType.POSITIVE,
   [PillEffect.BAD_TRIP]: ItemConfigPillEffectType.NEGATIVE,
   [PillEffect.BALLS_OF_STEEL]: ItemConfigPillEffectType.POSITIVE,
@@ -59,4 +58,4 @@ export const PILL_EFFECT_TYPES: {
   [PillEffect.SHOT_SPEED_DOWN]: ItemConfigPillEffectType.NEGATIVE,
   [PillEffect.SHOT_SPEED_UP]: ItemConfigPillEffectType.POSITIVE,
   [PillEffect.EXPERIMENTAL]: ItemConfigPillEffectType.NEUTRAL,
-} as const;
+} as const satisfies HasAllEnumKeys<PillEffect, ItemConfigPillEffectType>;

package/src/objects/playerNamePNGFileNames.ts

@@ -1,11 +1,10 @@
 // cspell:disable
 
 import { PlayerType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
 /** Used when rendering the "versusscreen.anm2" sprite. */
-export const PLAYER_NAME_PNG_FILE_NAMES: {
-  readonly [key in PlayerType]: string | undefined;
-} = {
+export const PLAYER_NAME_PNG_FILE_NAMES = {
   [PlayerType.POSSESSOR]: undefined, // -1
   [PlayerType.ISAAC]: "playername_01_isaac.png", // 0
   [PlayerType.MAGDALENE]: "playername_02_magdalene.png", // 1
@@ -55,4 +54,4 @@ export const PLAYER_NAME_PNG_FILE_NAMES: {
   [PlayerType.JACOB_2_B]: "playername_02x_jacob.png", // 39
   // Tainted The Soul uses the same name as Tainted Forgotten.
   [PlayerType.SOUL_B]: "playername_16_theforgotten.png", // 40
-} as const;
+} as const satisfies HasAllEnumKeys<PlayerType, string | undefined>;

package/src/objects/playerPortraitPNGFileNames.ts

@@ -1,11 +1,10 @@
 // cspell:disable
 
 import { PlayerType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
 /** Used when rendering the "versusscreen.anm2" sprite. */
-export const PLAYER_PORTRAIT_PNG_FILE_NAMES: {
-  readonly [key in PlayerType]: string | undefined;
-} = {
+export const PLAYER_PORTRAIT_PNG_FILE_NAMES = {
   [PlayerType.POSSESSOR]: undefined, // -1
   [PlayerType.ISAAC]: "playerportrait_isaac.png", // 0
   [PlayerType.MAGDALENE]: "playerportrait_magdalene.png", // 1
@@ -52,4 +51,4 @@ export const PLAYER_PORTRAIT_PNG_FILE_NAMES: {
   [PlayerType.JACOB_2_B]: "playerportrait_jacob_b.png", // 39
   // Tainted The Soul uses the same name as Tainted Forgotten.
   [PlayerType.SOUL_B]: "playerportrait_theforgotten_b.png", // 40
-} as const;
+} as const satisfies HasAllEnumKeys<PlayerType, string | undefined>;

package/src/objects/roomShapeBounds.ts

@@ -15,8 +15,10 @@ const TWO_BY_TWO_BOUNDS: [width: int, height: int] = [
  * The size of a room shape's contents. This does not include the tiles that the walls are on. L
  * rooms use the same bounds as a 2x2 room.
  */
+// We need the tuples to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_BOUNDS: {
-  readonly [key in RoomShape]: readonly [width: int, height: int];
+  readonly [Key in RoomShape]: readonly [width: int, height: int];
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: [

package/src/objects/roomShapeCorners.ts

@@ -8,8 +8,10 @@ import { Corner } from "../interfaces/Corner";
  * Note that these corner locations are not accurate for the Mother Boss Room and the Home closet
  * rooms. (Those rooms have custom shapes.)
  */
+// We need the arrays to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_CORNERS: {
-  readonly [key in RoomShape]: readonly Corner[];
+  readonly [Key in RoomShape]: readonly Corner[];
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: [

package/src/objects/roomShapeLayoutSizes.ts

@@ -27,8 +27,10 @@ const TWO_BY_TWO_LAYOUT_SIZE: readonly [width: int, height: int] = [
  *
  * For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
  */
+// We need the tuples to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_LAYOUT_SIZES: {
-  readonly [key in RoomShape]: readonly [width: int, height: int];
+  readonly [Key in RoomShape]: readonly [width: int, height: int];
 } = {
   [RoomShape.SHAPE_1x1]: ONE_BY_ONE_LAYOUT_SIZE, // 1
   [RoomShape.IH]: ONE_BY_ONE_LAYOUT_SIZE, // 2

package/src/objects/roomShapeToBottomRightPosition.ts

@@ -1,14 +1,19 @@
 import { RoomShape } from "isaac-typescript-definitions";
 
-const TWO_BY_TWO_BOTTOM_RIGHT_POSITION = Vector(25, 13);
-const ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION = Vector(12, 13);
+const TWO_BY_TWO_BOTTOM_RIGHT_POSITION: Readonly<Vector> = Vector(25, 13);
+const ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION: Readonly<Vector> = Vector(
+  12,
+  13,
+);
 
 /**
  * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
  * wall would be at "Vector(-1, -1)".)
  */
+// We need the vectors to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION: {
-  readonly [key in RoomShape]: Readonly<Vector>;
+  readonly [Key in RoomShape]: Readonly<Vector>;
 } = {
   [RoomShape.SHAPE_1x1]: Vector(12, 6), // 1
   [RoomShape.IH]: Vector(12, 4), // 2

package/src/objects/roomShapeToDoorSlotCoordinates.ts

@@ -5,8 +5,10 @@ import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
  *
  * e.g. `<door exists="False" x="-1" y="3" />`
  */
+// We need the maps to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES: {
-  readonly [key in RoomShape]: ReadonlyMap<DoorSlot, [x: int, y: int]>;
+  readonly [Key in RoomShape]: ReadonlyMap<DoorSlot, [x: int, y: int]>;
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: new Map([

package/src/objects/roomShapeToDoorSlots.ts

@@ -11,8 +11,10 @@ const ALL_DOOR_SLOTS_SET: ReadonlySet<DoorSlot> = new Set([
   DoorSlot.DOWN_1, // 7
 ]);
 
+// We need the sets to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_TO_DOOR_SLOTS: {
-  readonly [key in RoomShape]: ReadonlySet<DoorSlot>;
+  readonly [Key in RoomShape]: ReadonlySet<DoorSlot>;
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: new Set([

package/src/objects/roomShapeToDoorSlotsToGridIndexDelta.ts

@@ -10,8 +10,10 @@ const DOWN = LEVEL_GRID_ROW_WIDTH;
  * Deltas are considered to be from the safe grid index of the room (i.e. the top left corner, or
  * top right corner in the case of `RoomShape.LTL`).
  */
+// We need the maps to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: {
-  readonly [key in RoomShape]: Map<DoorSlot, int>;
+  readonly [Key in RoomShape]: ReadonlyMap<DoorSlot, int>;
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: new Map([

package/src/objects/roomShapeToGridWidth.ts

@@ -1,11 +1,10 @@
 import { RoomShape } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
 const ONE_BY_ONE_WIDTH = 15;
 const TWO_BY_ONE_WIDTH = 28;
 
-export const ROOM_SHAPE_TO_GRID_WIDTH: {
-  readonly [key in RoomShape]: int;
-} = {
+export const ROOM_SHAPE_TO_GRID_WIDTH = {
   [RoomShape.SHAPE_1x1]: ONE_BY_ONE_WIDTH, // 1
   [RoomShape.IH]: ONE_BY_ONE_WIDTH, // 2
   [RoomShape.IV]: ONE_BY_ONE_WIDTH, // 3
@@ -18,4 +17,4 @@ export const ROOM_SHAPE_TO_GRID_WIDTH: {
   [RoomShape.LTR]: TWO_BY_ONE_WIDTH, // 10
   [RoomShape.LBL]: TWO_BY_ONE_WIDTH, // 11
   [RoomShape.LBR]: TWO_BY_ONE_WIDTH, // 12
-} as const;
+} as const satisfies HasAllEnumKeys<RoomShape, int>;

package/src/objects/roomShapeToTopLeftPosition.ts

@@ -1,15 +1,17 @@
 import { RoomShape } from "isaac-typescript-definitions";
 import { VectorZero } from "../core/constants";
 
-const NARROW_HORIZONTAL_TOP_LEFT_POSITION = Vector(0, 2);
-const NARROW_VERTICAL_TOP_LEFT_POSITION = Vector(4, 0);
+const NARROW_HORIZONTAL_TOP_LEFT_POSITION: Readonly<Vector> = Vector(0, 2);
+const NARROW_VERTICAL_TOP_LEFT_POSITION: Readonly<Vector> = Vector(4, 0);
 
 /**
  * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
  * wall would be at "Vector(-1, -1)".)
  */
+// We need the vectors to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const ROOM_SHAPE_TO_TOP_LEFT_POSITION: {
-  readonly [key in RoomShape]: Readonly<Vector>;
+  readonly [Key in RoomShape]: Readonly<Vector>;
 } = {
   [RoomShape.SHAPE_1x1]: VectorZero, // 1
   [RoomShape.IH]: NARROW_HORIZONTAL_TOP_LEFT_POSITION, // 2

package/src/objects/roomShapeVolumes.ts

@@ -1,4 +1,5 @@
 import { RoomShape } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
 export const ONE_BY_ONE_CONTENTS_WIDTH = 13;
 export const ONE_BY_ONE_CONTENTS_HEIGHT = 7;
@@ -20,9 +21,7 @@ const L_ROOM_VOLUME = ONE_BY_ONE_VOLUME * 3;
  *
  * (This cannot be directly calculated from the bounds since L rooms are a special case.)
  */
-export const ROOM_SHAPE_VOLUMES: {
-  readonly [key in RoomShape]: int;
-} = {
+export const ROOM_SHAPE_VOLUMES = {
   [RoomShape.SHAPE_1x1]: ONE_BY_ONE_VOLUME, // 1
   [RoomShape.IH]: NARROW_HORIZONTAL_VOLUME, // 2
   [RoomShape.IV]: NARROW_VERTICAL_VOLUME, // 3
@@ -35,4 +34,4 @@ export const ROOM_SHAPE_VOLUMES: {
   [RoomShape.LTR]: L_ROOM_VOLUME, // 10
   [RoomShape.LBL]: L_ROOM_VOLUME, // 11
   [RoomShape.LBR]: L_ROOM_VOLUME, // 12
-} as const;
+} as const satisfies HasAllEnumKeys<RoomShape, int>;

package/src/objects/roomTypeGotoPrefixes.ts

@@ -1,8 +1,7 @@
 import { RoomType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
-export const ROOM_TYPE_GOTO_PREFIXES: {
-  readonly [key in RoomType]: string;
-} = {
+export const ROOM_TYPE_GOTO_PREFIXES = {
   [RoomType.DEFAULT]: "s.default", // 1
   [RoomType.SHOP]: "s.shop", // 2
   [RoomType.ERROR]: "s.error", // 3
@@ -32,4 +31,4 @@ export const ROOM_TYPE_GOTO_PREFIXES: {
   [RoomType.SECRET_EXIT]: "s.secretexit", // 27
   [RoomType.BLUE]: "s.blue", // 28
   [RoomType.ULTRA_SECRET]: "s.ultrasecret", // 29
-} as const;
+} as const satisfies HasAllEnumKeys<RoomType, string>;

package/src/objects/roomTypeNames.ts

@@ -1,6 +1,7 @@
 import { RoomType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
-export const ROOM_TYPE_NAMES: { readonly [key in RoomType]: string } = {
+export const ROOM_TYPE_NAMES = {
   [RoomType.DEFAULT]: "default room", // 1
   [RoomType.SHOP]: "shop", // 2
   [RoomType.ERROR]: "I AM ERROR Room", // 3
@@ -30,4 +31,4 @@ export const ROOM_TYPE_NAMES: { readonly [key in RoomType]: string } = {
   [RoomType.SECRET_EXIT]: "Secret Exit", // 27
   [RoomType.BLUE]: "Blue Room", // 28
   [RoomType.ULTRA_SECRET]: "Ultra Secret Room", // 29
-} as const;
+} as const satisfies HasAllEnumKeys<RoomType, string>;

package/src/objects/stageTypeSuffixes.ts

@@ -1,12 +1,11 @@
 import { StageType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
-export const STAGE_TYPE_SUFFIXES: {
-  readonly [key in StageType]: string;
-} = {
+export const STAGE_TYPE_SUFFIXES = {
   [StageType.ORIGINAL]: "", // 0
   [StageType.WRATH_OF_THE_LAMB]: "a", // 1
   [StageType.AFTERBIRTH]: "b", // 2
   [StageType.GREED_MODE]: "", // 3
   [StageType.REPENTANCE]: "c", // 4
   [StageType.REPENTANCE_B]: "d", // 5
-} as const;
+} as const satisfies HasAllEnumKeys<StageType, string>;

package/src/objects/stageTypeToLetter.ts

@@ -1,6 +1,7 @@
 import { StageType } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
-export const STAGE_TYPE_TO_LETTER: { readonly [key in StageType]: string } = {
+export const STAGE_TYPE_TO_LETTER = {
   // For example, to go to Basement 2, the command is simply "stage 2" without a letter suffix.
   [StageType.ORIGINAL]: "", // 0
 
@@ -12,4 +13,4 @@ export const STAGE_TYPE_TO_LETTER: { readonly [key in StageType]: string } = {
 
   [StageType.REPENTANCE]: "c", // 4
   [StageType.REPENTANCE_B]: "d", // 5
-} as const;
+} as const satisfies HasAllEnumKeys<StageType, string>;

package/src/objects/transformationNames.ts

@@ -1,6 +1,7 @@
 import { PlayerForm } from "isaac-typescript-definitions";
+import { HasAllEnumKeys } from "../types/HasAllEnumKeys";
 
-export const TRANSFORMATION_NAMES: { readonly [key in PlayerForm]: string } = {
+export const TRANSFORMATION_NAMES = {
   [PlayerForm.GUPPY]: "Guppy", // 0
   [PlayerForm.BEELZEBUB]: "Beelzebub", // 1
   [PlayerForm.FUN_GUY]: "Fun Guy", // 2
@@ -15,4 +16,4 @@ export const TRANSFORMATION_NAMES: { readonly [key in PlayerForm]: string } = {
   [PlayerForm.ADULT]: "Adult", // 11
   [PlayerForm.SPIDER_BABY]: "Spider Baby", // 12
   [PlayerForm.STOMPY]: "Stompy", // 13
-} as const;
+} as const satisfies HasAllEnumKeys<PlayerForm, string>;

package/src/objects/versusScreenBackgroundColors.ts

@@ -1,11 +1,13 @@
 import { StageID } from "isaac-typescript-definitions";
 
 /** We arbitrarily specify a default color equal to that of Basement. */
-const DEFAULT_COLOR = Color(26 / 255, 14 / 255, 12 / 255);
+const DEFAULT_COLOR: Readonly<Color> = Color(26 / 255, 14 / 255, 12 / 255);
 
 /** These values are taken from StageAPI. */
+// We need the colors to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const VERSUS_SCREEN_BACKGROUND_COLORS: {
-  readonly [key in StageID]: Color;
+  readonly [Key in StageID]: Readonly<Color>;
 } = {
   [StageID.SPECIAL_ROOMS]: DEFAULT_COLOR, // 0
   [StageID.BASEMENT]: Color(26 / 255, 14 / 255, 12 / 255), // 1

package/src/objects/versusScreenDirtSpotColors.ts

@@ -1,11 +1,13 @@
 import { StageID } from "isaac-typescript-definitions";
 
 /** We arbitrarily specify a default color equal to that of Basement. */
-const DEFAULT_COLOR = Color(201 / 255, 114 / 255, 96 / 255);
+const DEFAULT_COLOR: Readonly<Color> = Color(201 / 255, 114 / 255, 96 / 255);
 
 /** These values are taken from StageAPI. */
+// We need the colors to be read-only, so we specify the type instead of using the `satisfies`
+// operator.
 export const VERSUS_SCREEN_DIRT_SPOT_COLORS: {
-  readonly [key in StageID]: Color;
+  readonly [Key in StageID]: Readonly<Color>;
 } = {
   [StageID.SPECIAL_ROOMS]: DEFAULT_COLOR, // 0
   [StageID.BASEMENT]: Color(201 / 255, 114 / 255, 96 / 255), // 1

package/src/types/HasAllEnumKeys.ts

@@ -15,11 +15,11 @@
  *   [MyEnum.Value1]: "foo",
  *   [MyEnum.Value2]: "bar",
  *   [MyEnum.Value3]: "baz",
- * } as const satisfies HasAllEnumKeys<MyEnum>;
+ * } as const satisfies HasAllEnumKeys<MyEnum, string>;
  *
  * const value = MyEnumToString[MyEnum.Value2];
  * ```
  */
 export type HasAllEnumKeys<Enum extends string | number, T> = {
-  readonly [key in Enum]: T;
+  readonly [Key in Enum]: T;
 };