libram 0.11.0 → 0.11.1

package/dist/modifier.d.ts

@@ -35,17 +35,17 @@ export declare function get(name: BooleanModifier, subject?: string | Item | Eff
 export declare function get(name: NumericModifier, subject?: string | Item | Effect | Skill | Familiar): number;
 export declare function get(name: StringModifier, subject?: string | Effect | Item): string;
 export declare function get(name: MultiStringModifier, subject?: string | Item | Effect | Skill | Familiar): string[];
-export type ModifierValue<T> = T extends BooleanModifier ? boolean : T extends NumericModifier ? number : T extends StringModifier ? string : string;
+export type ModifierValue<T> = T extends BooleanModifier ? boolean : T extends NumericModifier ? number : T extends MultiStringModifier ? string[] : string;
 export type Modifiers<T extends ModifierType = ModifierType> = Partial<{
     [K in T]: ModifierValue<K>;
 }>;
 /**
  * Merge arbitrarily many Modifiers objects into one, summing all numeric modifiers, and ||ing all boolean modifiers.
  *
- * @param modifierss Modifiers objects to be merged together.
+ * @param modifiers Modifiers objects to be merged together.
  * @returns A single Modifiers object obtained by merging.
  */
-export declare function mergeModifiers(...modifierss: Modifiers[]): Modifiers;
+export declare function mergeModifiers(...modifiers: Modifiers[]): Modifiers;
 /**
  * Prints the modtrace to the log.
  * Example: printModtrace("Meat Drop") or printModtrace(["Item Drop", "Booze Drop"])
@@ -70,21 +70,19 @@ export type ModifierParser = {
     numeric: (value: string) => number;
     str: (value: string) => string;
     bool: (value: string) => boolean;
+    multiString: (value: string) => string[];
 };
 /**
  * Translate a pref into a `Modifiers` object by wrapping mafia's `splitModifiers`
  * @param pref The name of the mafia preference in question
- * @param translator Optional object to help translate fields into their appropriate values
- * @param translator.numeric How to translate the values from `splitModifiers` into numbers for numeric modifiers; defaults to Number
- * @param translator.str How to translate the values from `splitModifiers` into strings for string modifiers; defaults to String
- * @param translator.bool How to translate the values from `splitModifiers` into booleans for boolean modifiers; defaults to comparing to the string `"true"`
+ * @param parsers Optional object to help translate fields into their appropriate values
+ * @param parsers.numeric How to translate the values from `splitModifiers` into numbers for numeric modifiers; defaults to Number
+ * @param parsers.str How to translate the values from `splitModifiers` into strings for string modifiers; defaults to String
+ * @param parsers.bool How to translate the values from `splitModifiers` into booleans for boolean modifiers; defaults to comparing to the string `"true"`
+ * @param parsers.multiString How to translate the values from `splitModifiers` into string[]s for multistring modifiers; defaults to splitting by a comma
  * @returns A `Modifiers` object corresponding to the given preference.
  */
-export declare function parseModifiers(pref: StringProperty, { numeric, str, bool, }?: Partial<{
-    numeric: (value: string) => number;
-    str: (value: string) => string;
-    bool: (value: string) => boolean;
-}>): Modifiers;
+export declare function parseModifiers(pref: StringProperty, parsers?: Partial<ModifierParser>): Modifiers;
 /**
  * Compile together all `Modifiers` something has
  * @param thing An Item, Effect, or string to check all modifiers of

package/dist/modifier.js

@@ -1,6 +1,6 @@
 import { booleanModifier, cliExecuteOutput, Effect, familiarWeight, getProperty, Item, myFamiliar, numericModifier, print, splitModifiers, stringModifier, stringsModifier, } from "kolmafia";
 import { have } from "./lib.js";
-import { booleanModifiersSet, numericModifiersSet, stringModifiersSet, } from "./modifierTypes.js";
+import { booleanModifiersSet, multiStringModifiersSet, numericModifiersSet, stringModifiersSet, } from "./modifierTypes.js";
 import { $effect } from "./template-string.js";
 import { sum } from "./utils.js";
 /**
@@ -33,7 +33,7 @@ export function isStringModifier(modifier) {
  * @returns Whether the string in question is a valid multistring modifier
  */
 export function isMultiStringModifier(modifier) {
-    return stringModifiersSet.has(modifier);
+    return multiStringModifiersSet.has(modifier);
 }
 /**
  * Type guard that determines if a given string is a valid modifier
@@ -43,7 +43,8 @@ export function isMultiStringModifier(modifier) {
 export function isValidModifier(modifier) {
     return (isNumericModifier(modifier) ||
         isBooleanModifier(modifier) ||
-        isStringModifier(modifier));
+        isStringModifier(modifier) ||
+        isMultiStringModifier(modifier));
 }
 /**
  * Get the value of a modifier
@@ -93,6 +94,12 @@ function pairwiseMerge(modifiers1, modifiers2) {
                 returnValue[modifier] =
                     (modifiers1[modifier] ?? false) || (modifiers2[modifier] ?? false);
             }
+            if (isMultiStringModifier(modifier)) {
+                returnValue[modifier] = [
+                    ...(modifiers1[modifier] ?? []),
+                    ...(modifiers2[modifier] ?? []),
+                ];
+            }
         }
     }
     return returnValue;
@@ -100,11 +107,11 @@ function pairwiseMerge(modifiers1, modifiers2) {
 /**
  * Merge arbitrarily many Modifiers objects into one, summing all numeric modifiers, and ||ing all boolean modifiers.
  *
- * @param modifierss Modifiers objects to be merged together.
+ * @param modifiers Modifiers objects to be merged together.
  * @returns A single Modifiers object obtained by merging.
  */
-export function mergeModifiers(...modifierss) {
-    return modifierss.reduce((a, b) => pairwiseMerge(a, b), {});
+export function mergeModifiers(...modifiers) {
+    return modifiers.reduce((a, b) => pairwiseMerge(a, b), {});
 }
 /**
  * Prints the modtrace to the log.
@@ -190,27 +197,30 @@ baseModifier, componentColor = "purple", totalColor = "blue") {
 export function getTotalModifier(modifier, ...subjects) {
     return sum(subjects, (subject) => get(modifier, subject));
 }
-function parseModifierString(modifiers, { numeric = Number, str = String, bool = (val) => val === "true", } = {}) {
+function parseModifierString(modifiers, { numeric = Number, str = String, bool = (val) => val === "true", multiString = (val) => val.split(","), } = {}) {
     return Object.entries(splitModifiers(modifiers)).reduce((acc, [key, value]) => ({
         ...acc,
         [key]: isBooleanModifier(key)
             ? bool(value)
             : isNumericModifier(key)
                 ? numeric(value)
-                : str(value),
+                : isMultiStringModifier(key)
+                    ? multiString(value)
+                    : str(value),
     }), {});
 }
 /**
  * Translate a pref into a `Modifiers` object by wrapping mafia's `splitModifiers`
  * @param pref The name of the mafia preference in question
- * @param translator Optional object to help translate fields into their appropriate values
- * @param translator.numeric How to translate the values from `splitModifiers` into numbers for numeric modifiers; defaults to Number
- * @param translator.str How to translate the values from `splitModifiers` into strings for string modifiers; defaults to String
- * @param translator.bool How to translate the values from `splitModifiers` into booleans for boolean modifiers; defaults to comparing to the string `"true"`
+ * @param parsers Optional object to help translate fields into their appropriate values
+ * @param parsers.numeric How to translate the values from `splitModifiers` into numbers for numeric modifiers; defaults to Number
+ * @param parsers.str How to translate the values from `splitModifiers` into strings for string modifiers; defaults to String
+ * @param parsers.bool How to translate the values from `splitModifiers` into booleans for boolean modifiers; defaults to comparing to the string `"true"`
+ * @param parsers.multiString How to translate the values from `splitModifiers` into string[]s for multistring modifiers; defaults to splitting by a comma
  * @returns A `Modifiers` object corresponding to the given preference.
  */
-export function parseModifiers(pref, { numeric = Number, str = String, bool = (val) => val === "true", } = {}) {
-    return parseModifierString(getProperty(pref), { numeric, str, bool });
+export function parseModifiers(pref, parsers = {}) {
+    return parseModifierString(getProperty(pref), parsers);
 }
 const overloadedStringModifier = (thing, modifier) => thing instanceof Effect
     ? stringModifier(thing, modifier)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libram",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "JavaScript helper library for KoLmafia",
   "type": "module",
   "main": "dist/index.js",