isaacscript-common 34.0.0 → 34.1.0

package/dist/index.rollup.d.ts

@@ -5581,6 +5581,8 @@ export declare function getHighestArrayElement(array: number[]): number | undefi
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export declare function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T];
 
@@ -5745,6 +5747,16 @@ export declare function getLevelBossIDs(): BossID[];
  */
 export declare function getLowestArrayElement(array: number[]): number | undefined;
 
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export declare function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T];
+
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
  * purposes of this function, both search text and map keys are converted to lowercase before

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 34.0.0
+isaacscript-common 34.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17221,6 +17221,7 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayAt = ____lualib.__TS__ArrayAt
 local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
@@ -17287,10 +17288,16 @@ function ____exports.getEnumValues(self, transpiledEnum)
 end
 function ____exports.getHighestEnumValue(self, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastElement = enumValues[#enumValues]
+    local lastElement = __TS__ArrayAt(enumValues, -1)
     assertDefined(nil, lastElement, "Failed to get the last value from an enum since the enum was empty.")
     return lastElement
 end
+function ____exports.getLowestEnumValue(self, transpiledEnum)
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    local firstElement = enumValues[1]
+    assertDefined(nil, firstElement, "Failed to get the first value from an enum since the enum was empty.")
+    return firstElement
+end
 function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -17316,7 +17323,7 @@ function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum
 end
 function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)
     local values = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastValue = values[#values]
+    local lastValue = __TS__ArrayAt(values, -1)
     assertDefined(nil, lastValue, "Failed to validate that an enum was contiguous, since the last value was undefined.")
     if not isNumber(nil, lastValue) then
         error("Failed to validate that an enum was contiguous, since the last value was not a number.")
@@ -34680,7 +34687,7 @@ function RoomHistory.prototype.getRoomHistory(self)
 end
 __TS__DecorateLegacy({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 function RoomHistory.prototype.getPreviousRoomDescription(self)
-    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    local previousRoomDescription = __TS__ArrayAt(v.run.roomHistory, -2)
     if previousRoomDescription ~= nil then
         return previousRoomDescription
     end

package/dist/src/classes/features/other/RoomHistory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAgC/B;IAEF;;;;OAIG;IAEI,yBAAyB,IAAI,IAAI;IAIxC;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}
+{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAgC/B;IAEF;;;;OAIG;IAEI,yBAAyB,IAAI,IAAI;IAIxC;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAgB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}

package/dist/src/classes/features/other/RoomHistory.lua

@@ -78,7 +78,7 @@ function RoomHistory.prototype.getRoomHistory(self)
 end
 __TS__DecorateLegacy({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 function RoomHistory.prototype.getPreviousRoomDescription(self)
-    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    local previousRoomDescription = __TS__ArrayAt(v.run.roomHistory, -2)
     if previousRoomDescription ~= nil then
         return previousRoomDescription
     end

package/dist/src/functions/enums.d.ts

@@ -60,8 +60,19 @@ export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export declare function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T];
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export declare function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T];
 /**
  * Helper function to get a random value from the provided enum.
  *

package/dist/src/functions/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,OAAO,CAGT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUnE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,OAAO,CAGT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}

package/dist/src/functions/enums.lua

@@ -1,6 +1,7 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayAt = ____lualib.__TS__ArrayAt
 local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
@@ -113,12 +114,26 @@ end
 -- 
 -- Note that this is not necessarily the enum value that is declared last in the code, since there
 -- is no way to infer that at run-time.
+-- 
+-- Throws an error if the provided enum is empty.
 function ____exports.getHighestEnumValue(self, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastElement = enumValues[#enumValues]
+    local lastElement = __TS__ArrayAt(enumValues, -1)
     assertDefined(nil, lastElement, "Failed to get the last value from an enum since the enum was empty.")
     return lastElement
 end
+--- Helper function to get the enum value with the lowest value.
+-- 
+-- Note that this is not necessarily the enum value that is declared first in the code, since there
+-- is no way to infer that at run-time.
+-- 
+-- Throws an error if the provided enum is empty.
+function ____exports.getLowestEnumValue(self, transpiledEnum)
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    local firstElement = enumValues[1]
+    assertDefined(nil, firstElement, "Failed to get the first value from an enum since the enum was empty.")
+    return firstElement
+end
 --- Helper function to get a random value from the provided enum.
 -- 
 -- @param transpiledEnum The enum to get the value from.
@@ -167,7 +182,7 @@ end
 -- This is useful to automate checking large enums for typos.
 function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)
     local values = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastValue = values[#values]
+    local lastValue = __TS__ArrayAt(values, -1)
     assertDefined(nil, lastValue, "Failed to validate that an enum was contiguous, since the last value was undefined.")
     if not isNumber(nil, lastValue) then
         error("Failed to validate that an enum was contiguous, since the last value was not a number.")

package/package.json

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

package/src/classes/features/other/RoomHistory.ts

@@ -110,8 +110,7 @@ export class RoomHistory extends Feature {
    */
   @Exported
   public getPreviousRoomDescription(): Readonly<RoomDescription> {
-    const previousRoomDescription =
-      v.run.roomHistory[v.run.roomHistory.length - 2];
+    const previousRoomDescription = v.run.roomHistory.at(-2);
     if (previousRoomDescription !== undefined) {
       return previousRoomDescription;
     }

package/src/functions/enums.ts

@@ -101,11 +101,13 @@ export function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]> {
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T] {
   const enumValues = getEnumValues(transpiledEnum);
 
-  const lastElement = enumValues[enumValues.length - 1];
+  const lastElement = enumValues.at(-1);
   assertDefined(
     lastElement,
     "Failed to get the last value from an enum since the enum was empty.",
@@ -114,6 +116,26 @@ export function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T] {
   return lastElement;
 }
 
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T] {
+  const enumValues = getEnumValues(transpiledEnum);
+
+  const firstElement = enumValues[0];
+  assertDefined(
+    firstElement,
+    "Failed to get the first value from an enum since the enum was empty.",
+  );
+
+  return firstElement;
+}
+
 /**
  * Helper function to get a random value from the provided enum.
  *
@@ -178,7 +200,7 @@ export function validateEnumContiguous<T>(
   transpiledEnum: T,
 ): void {
   const values = getEnumValues(transpiledEnum);
-  const lastValue = values[values.length - 1];
+  const lastValue = values.at(-1);
   assertDefined(
     lastValue,
     "Failed to validate that an enum was contiguous, since the last value was undefined.",