isaacscript-common 8.1.0 → 8.2.0

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

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAEA,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAO1D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAuBzB;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAGA,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAO1D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAgBzB;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}

package/dist/functions/map.lua

@@ -3,13 +3,11 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__Spread = ____lualib.__TS__Spread
-local __TS__ArraySort = ____lualib.__TS__ArraySort
-local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
-local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
-local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____array = require("functions.array")
 local sumArray = ____array.sumArray
+local ____string = require("functions.string")
+local getPartialMatch = ____string.getPartialMatch
 --- Helper function to copy a map. (You can also use a Map constructor to accomplish this task.)
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
@@ -39,24 +37,13 @@ end
 -- ```
 function ____exports.getMapPartialMatch(self, searchText, map)
     local keys = {__TS__Spread(map:keys())}
-    __TS__ArraySort(keys)
-    searchText = string.lower(searchText)
-    searchText = __TS__StringReplaceAll(searchText, " ", "")
-    local matchingKeys = __TS__ArrayFilter(
-        keys,
-        function(____, key) return __TS__StringStartsWith(
-            string.lower(key),
-            searchText
-        ) end
-    )
-    __TS__ArraySort(matchingKeys)
-    local matchingKey = matchingKeys[1]
+    local matchingKey = getPartialMatch(nil, searchText, keys)
     if matchingKey == nil then
         return nil
     end
     local value = map:get(matchingKey)
     if value == nil then
-        return nil
+        error("Failed to get the map value corresponding to the partial match of: " .. matchingKey)
     end
     return {matchingKey, value}
 end

package/dist/functions/string.d.ts

@@ -1,4 +1,21 @@
 export declare function capitalizeFirstLetter(string: string): string;
+/**
+ * Helper function to get the closest value from an array of strings based on partial search text.
+ * For the purposes of this function, both search text and the array are converted to lowercase
+ * before attempting to find a match.
+ *
+ * For example:
+ *
+ * ```ts
+ * const array = ["foo", "bar"];
+ * const searchText = "f";
+ * const match = getPartialMatch(array, searchText); // match is now equal to "foo"
+ *
+ * @returns If a match was found, returns the array element. If a match was not
+ * found, returns undefined.
+ * ```
+ */
+export declare function getPartialMatch(searchText: string, array: string[]): string | undefined;
 export declare function removeAllCharacters(string: string, character: string): string;
 /**
  * Helper function to remove all of the characters in a string before a given substring. Returns the

package/dist/functions/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAM5D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,UAAU,EAAE,MAAM,EAAE,GACtB,MAAM,CAMR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAM5D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EAAE,GACd,MAAM,GAAG,SAAS,CAYpB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,UAAU,EAAE,MAAM,EAAE,GACtB,MAAM,CAMR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE"}

package/dist/functions/string.lua

@@ -1,7 +1,9 @@
 local ____lualib = require("lualib_bundle")
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
-local __TS__StringSlice = ____lualib.__TS__StringSlice
 local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__StringSlice = ____lualib.__TS__StringSlice
 local __TS__StringEndsWith = ____lualib.__TS__StringEndsWith
 local ____exports = {}
 function ____exports.capitalizeFirstLetter(self, ____string)
@@ -10,6 +12,34 @@ function ____exports.capitalizeFirstLetter(self, ____string)
     local restOfString = string.sub(____string, 2)
     return capitalizedFirstLetter .. restOfString
 end
+--- Helper function to get the closest value from an array of strings based on partial search text.
+-- For the purposes of this function, both search text and the array are converted to lowercase
+-- before attempting to find a match.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const array = ["foo", "bar"];
+-- const searchText = "f";
+-- const match = getPartialMatch(array, searchText); // match is now equal to "foo"
+-- 
+-- @returns If a match was found, returns the array element. If a match was not
+-- found, returns undefined.
+-- ```
+function ____exports.getPartialMatch(self, searchText, array)
+    __TS__ArraySort(array)
+    searchText = string.lower(searchText)
+    searchText = __TS__StringReplaceAll(searchText, " ", "")
+    local matchingElements = __TS__ArrayFilter(
+        array,
+        function(____, element) return __TS__StringStartsWith(
+            string.lower(element),
+            searchText
+        ) end
+    )
+    __TS__ArraySort(matchingElements)
+    return matchingElements[1]
+end
 function ____exports.removeAllCharacters(self, ____string, character)
     return __TS__StringReplaceAll(____string, character, "")
 end

package/dist/functions/utils.d.ts

@@ -80,13 +80,13 @@ export declare function repeat(n: int, func: (i: int) => void): void;
 /**
  * Helper function to signify that the enclosing code block is not yet complete. Using this function
  * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
- * early returns.
+ * unused variables or early returns.
  *
  * When you see this function, it simply means that the programmer intends to add in more code to
  * this spot later.
  *
  * This function is variadic, meaning that you can pass as many arguments as you want. (This is
- * useful as a means to prevent lint warnings.)
+ * useful as a means to prevent unused variables.)
  *
  * This function does not actually do anything. (It is an "empty" function.)
  */

package/dist/functions/utils.lua

@@ -153,13 +153,13 @@ ____exports["repeat"] = function(self, n, func)
 end
 --- Helper function to signify that the enclosing code block is not yet complete. Using this function
 -- is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
--- early returns.
+-- unused variables or early returns.
 -- 
 -- When you see this function, it simply means that the programmer intends to add in more code to
 -- this spot later.
 -- 
 -- This function is variadic, meaning that you can pass as many arguments as you want. (This is
--- useful as a means to prevent lint warnings.)
+-- useful as a means to prevent unused variables.)
 -- 
 -- This function does not actually do anything. (It is an "empty" function.)
 function ____exports.todo(self, ...)

package/dist/index.d.ts

@@ -3790,6 +3790,24 @@ export declare function getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | unde
  */
 export declare function getOtherPlayers(player: EntityPlayer): EntityPlayer[];
 
+/**
+ * Helper function to get the closest value from an array of strings based on partial search text.
+ * For the purposes of this function, both search text and the array are converted to lowercase
+ * before attempting to find a match.
+ *
+ * For example:
+ *
+ * ```ts
+ * const array = ["foo", "bar"];
+ * const searchText = "f";
+ * const match = getPartialMatch(array, searchText); // match is now equal to "foo"
+ *
+ * @returns If a match was found, returns the array element. If a match was not
+ * found, returns undefined.
+ * ```
+ */
+export declare function getPartialMatch(searchText: string, array: string[]): string | undefined;
+
 /**
  * Helper function to get the associated pill effect after PHD is acquired. If a pill effect is not
  * altered by PHD, then the same pill effect will be returned.
@@ -11212,13 +11230,13 @@ export declare function texelEquals(sprite1: Sprite, sprite2: Sprite, position:
 /**
  * Helper function to signify that the enclosing code block is not yet complete. Using this function
  * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
- * early returns.
+ * unused variables or early returns.
  *
  * When you see this function, it simply means that the programmer intends to add in more code to
  * this spot later.
  *
  * This function is variadic, meaning that you can pass as many arguments as you want. (This is
- * useful as a means to prevent lint warnings.)
+ * useful as a means to prevent unused variables.)
  *
  * This function does not actually do anything. (It is an "empty" function.)
  */

package/package.json

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

package/src/functions/map.ts

@@ -1,4 +1,5 @@
 import { sumArray } from "./array";
+import { getPartialMatch } from "./string";
 
 /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
 export function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V> {
@@ -34,24 +35,17 @@ export function getMapPartialMatch<T>(
   map: ReadonlyMap<string, T>,
 ): [string, T] | undefined {
   const keys = [...map.keys()];
-  keys.sort();
 
-  searchText = searchText.toLowerCase();
-  searchText = searchText.replaceAll(" ", "");
-
-  const matchingKeys = keys.filter((key) =>
-    key.toLowerCase().startsWith(searchText),
-  );
-  matchingKeys.sort();
-
-  const matchingKey = matchingKeys[0];
+  const matchingKey = getPartialMatch(searchText, keys);
   if (matchingKey === undefined) {
     return undefined;
   }
 
   const value = map.get(matchingKey);
   if (value === undefined) {
-    return undefined;
+    error(
+      `Failed to get the map value corresponding to the partial match of: ${matchingKey}`,
+    );
   }
 
   return [matchingKey, value];

package/src/functions/string.ts

@@ -6,6 +6,39 @@ export function capitalizeFirstLetter(string: string): string {
   return `${capitalizedFirstLetter}${restOfString}`;
 }
 
+/**
+ * Helper function to get the closest value from an array of strings based on partial search text.
+ * For the purposes of this function, both search text and the array are converted to lowercase
+ * before attempting to find a match.
+ *
+ * For example:
+ *
+ * ```ts
+ * const array = ["foo", "bar"];
+ * const searchText = "f";
+ * const match = getPartialMatch(array, searchText); // match is now equal to "foo"
+ *
+ * @returns If a match was found, returns the array element. If a match was not
+ * found, returns undefined.
+ * ```
+ */
+export function getPartialMatch(
+  searchText: string,
+  array: string[],
+): string | undefined {
+  array.sort();
+
+  searchText = searchText.toLowerCase();
+  searchText = searchText.replaceAll(" ", "");
+
+  const matchingElements = array.filter((element) =>
+    element.toLowerCase().startsWith(searchText),
+  );
+  matchingElements.sort();
+
+  return matchingElements[0];
+}
+
 export function removeAllCharacters(string: string, character: string): string {
   return string.replaceAll(character, "");
 }

package/src/functions/utils.ts

@@ -182,13 +182,13 @@ export function repeat(n: int, func: (i: int) => void): void {
 /**
  * Helper function to signify that the enclosing code block is not yet complete. Using this function
  * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
- * early returns.
+ * unused variables or early returns.
  *
  * When you see this function, it simply means that the programmer intends to add in more code to
  * this spot later.
  *
  * This function is variadic, meaning that you can pass as many arguments as you want. (This is
- * useful as a means to prevent lint warnings.)
+ * useful as a means to prevent unused variables.)
  *
  * This function does not actually do anything. (It is an "empty" function.)
  */