libram 0.9.3 → 0.9.5

package/dist/Macro.test.js

@@ -16,7 +16,7 @@ describe(Macro, () => {
         expect(Macro.if_("mock", Macro.abort()).toString()).toEqual(`if mock;abort;endif;`);
     });
     it("ifNot", () => {
-        expect(Macro.ifNot("mock", Macro.abort()).toString()).toEqual(`if !(mock);abort;endif;`);
+        expect(Macro.ifNot("mock", Macro.abort()).toString()).toEqual(`if !mock;abort;endif;`);
     });
     it("while_", () => {
         expect(Macro.while_("mock", Macro.abort()).toString()).toEqual(`while mock;abort;endwhile;`);

package/dist/actions/ActionSource.js

@@ -1,7 +1,7 @@
 import { mallPrice, useFamiliar } from "kolmafia";
 import { Macro } from "../combat.js";
 import { Requirement } from "../maximize.js";
-import { sum, flat } from "../utils.js";
+import { sum } from "../utils.js";
 /**
  * Merge a set of constraints into one
  *
@@ -97,7 +97,7 @@ export class ActionSource {
             // Inconsistent constraints - no path forward here.
             return null;
         }
-        return new ActionSource([...flat(actions.map((action) => action.source))], () => sum(actions, (action) => action.potential()), Macro.step(...actions.map((action) => action.macro)), constraints);
+        return new ActionSource(actions.flatMap((action) => action.source), () => sum(actions, (action) => action.potential()), Macro.step(...actions.map((action) => action.macro)), constraints);
     }
     /**
      * Perform all preparation necessary to make this action available.

package/dist/combat.js

@@ -349,9 +349,7 @@ export class Macro {
      * @returns {Macro} This object itself.
      */
     ifNot(condition, ifTrue) {
-        return this.step(`if !(${Macro.makeBALLSPredicate(condition)})`)
-            .step(ifTrue)
-            .step("endif");
+        return this.if_(`!${Macro.makeBALLSPredicate(condition)}`, ifTrue);
     }
     /**
      * Create a new macro with an "if" statement, inverting the condition.

package/dist/lib.d.ts

@@ -507,4 +507,16 @@ export declare function haveIntrinsic(effect: Effect): boolean;
  */
 export declare function extractItems(text: string): Map<Item, number>;
 export type CombatParams = Parameters<typeof runCombat>;
+/**
+ * Calculate & return the scaling rate of a monster--`0` for non-scalers.
+ * @param monster The monster to check
+ * @returns The current scaling rate of the monster, based on your current in-game state
+ */
+export declare const getScalingRate: (monster: Monster) => number;
+/**
+ * Calculate & return the scaling cap of a monster--`0` for non-scalers.
+ * @param monster The monster to check
+ * @returns The current scaling cap of the monster, based on your current in-game state
+ */
+export declare const getScalingCap: (monster: Monster) => number;
 export {};

package/dist/lib.js

@@ -1,9 +1,9 @@
 /** @module GeneralLibrary */
-import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, equip, equippedItem, extractItems as kolmafiaExtractItems, Familiar, fullnessLimit, getCampground, getCounters, getPlayerId, getPlayerName, getRelated, handlingChoice, haveEffect, haveFamiliar, haveServant, haveSkill, holiday, inebrietyLimit, inMultiFight, Item, Location, mallPrice, Monster, myClass, myEffects, myFamiliar, myFullness, myInebriety, myPath, myPrimestat, mySpleenUse, myThrall, myTurncount, numericModifier, Path, Servant, Skill, Slot, spleenLimit, Thrall, todayToString, toItem, toSkill, totalTurnsPlayed, visitUrl, xpath, } from "kolmafia";
+import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, equip, equippedItem, extractItems as kolmafiaExtractItems, Familiar, fullnessLimit, getCampground, getCounters, getPlayerId, getPlayerName, getRelated, handlingChoice, haveEffect, haveFamiliar, haveServant, haveSkill, holiday, inebrietyLimit, inMultiFight, Item, Location, mallPrice, Monster, myClass, myEffects, myFamiliar, myFullness, myInebriety, myPath, myPrimestat, mySpleenUse, myThrall, myTurncount, numericModifier, Path, Servant, Skill, Slot, spleenLimit, Thrall, todayToString, toItem, toSkill, totalTurnsPlayed, visitUrl, xpath, monsterEval, } from "kolmafia";
 import logger from "./logger.js";
 import { get } from "./property.js";
 import { $class, $effect, $element, $familiar, $item, $items, $monsters, $skill, $stat, } from "./template-string.js";
-import { makeByXFunction, chunk, flat, notNull } from "./utils.js";
+import { makeByXFunction, chunk, notNull } from "./utils.js";
 /**
  * Determines the current maximum Accordion Thief songs the player can have in their head
  *
@@ -645,9 +645,9 @@ export const holidayWanderers = new Map([
  * @returns List of holiday wanderer Monsters
  */
 export function getTodaysHolidayWanderers() {
-    return flat(holiday()
+    return holiday()
         .split("/")
-        .map((holiday) => holidayWanderers.get(holiday) ?? []));
+        .flatMap((holiday) => holidayWanderers.get(holiday) ?? []);
 }
 /**
  * Determines whether or not we can safely call visitUrl(), based on whether we're in a fight, multi-fight, choice, etc
@@ -924,10 +924,10 @@ export function getCombatFlags(flags = [...ACCOUNT_COMBAT_FLAGS]) {
  */
 export function setCombatFlags(...flags) {
     return visitUrl(`account.php?${([
-        ...flat(flags.map(({ flag, value }) => [
+        ...flags.flatMap(({ flag, value }) => [
             `actions[]=flag_${flag}`,
             `flag_${flag}=${Number(value)}`,
-        ])),
+        ]),
         "action=Update",
         "am=1",
         "ajax=1",
@@ -970,3 +970,29 @@ export function haveIntrinsic(effect) {
 export function extractItems(text) {
     return new Map(Object.entries(kolmafiaExtractItems(text)).map(([itemName, quantity]) => [Item.get(itemName), quantity]));
 }
+function makeScalerCalcFunction(cache, pattern) {
+    return function (monster) {
+        const current = cache.get(monster);
+        if (current !== undefined)
+            return monsterEval(current);
+        const result = pattern.exec(monster.attributes)?.[1] ?? "0";
+        cache.set(monster, result);
+        return monsterEval(result);
+    };
+}
+const scalerRates = new Map();
+const scalerCaps = new Map();
+const SCALE_RATE_PATTERN = /Scale: (?:\[([^\]]*)\]|(\d*))/;
+const SCALE_CAP_PATTERN = /Cap: (?:\[([^\]]*)\]|(\d*))/;
+/**
+ * Calculate & return the scaling rate of a monster--`0` for non-scalers.
+ * @param monster The monster to check
+ * @returns The current scaling rate of the monster, based on your current in-game state
+ */
+export const getScalingRate = makeScalerCalcFunction(scalerRates, SCALE_RATE_PATTERN);
+/**
+ * Calculate & return the scaling cap of a monster--`0` for non-scalers.
+ * @param monster The monster to check
+ * @returns The current scaling cap of the monster, based on your current in-game state
+ */
+export const getScalingCap = makeScalerCalcFunction(scalerCaps, SCALE_CAP_PATTERN);

package/dist/resources/2023/CursedMonkeyPaw.js

@@ -3,7 +3,7 @@ import { have as have_ } from "../../lib.js";
 import logger from "../../logger.js";
 import { get } from "../../property.js";
 import { $item } from "../../template-string.js";
-import { clamp, flat } from "../../utils.js";
+import { clamp } from "../../utils.js";
 const item = $item `cursed monkey's paw`;
 /**
  * @returns Whether or not we currently `have` the cursed monkey's paw
@@ -25,15 +25,15 @@ export function wishes() {
  * @returns A set of all items we expect to be able to wish; this doesn't actually constitute all items
  */
 export function wishableItems(filters = {}) {
-    return new Set(flat(Location.all()
+    return new Set(Location.all()
         .filter((l) => canAdventure(l) && (filters.location?.(l) ?? true))
-        .map((l) => getMonsters(l)
+        .flatMap((l) => getMonsters(l)
         .filter((m) => m.copyable && (filters.monster?.(m) ?? true))
-        .map((m) => itemDropsArray(m)
+        .flatMap((m) => itemDropsArray(m)
         .filter(({ type, rate, drop }) => !drop.quest &&
         (type !== "c" || rate >= 1) && // Remove random roll drops
         (filters.drop?.({ type, rate, drop }) ?? true))
-        .map(({ drop }) => drop)))));
+        .map(({ drop }) => drop))));
 }
 const INVALID_CHARACTERS = /[^a-z\d -]/g;
 let _unwishableEffects;

package/dist/resources/2024/MayamCalendar.d.ts

@@ -8,6 +8,10 @@ export type CombinationString = `${Ring<0>} ${Ring<1>} ${Ring<2>} ${Ring<3>}`;
  * @returns Whether you `have` the Mayam calendar
  */
 export declare function have(): boolean;
+/**
+ * @returns The Mayam calendar symbols you've used so far today.
+ */
+export declare function symbolsUsed(): MayamSymbol[];
 /**
  * Determine whether a certain Mayam symbol is available for use today
  *
@@ -57,6 +61,7 @@ export declare const RESONANCES: Readonly<{
     "chair yam2 yam3 clock": Effect;
     "yam1 yam2 cheese clock": Effect;
 }>;
+export declare const RESONANCE_KEYS: ("sword yam2 eyepatch explosion" | "yam1 meat cheese yam4" | "yam1 meat eyepatch yam4" | "yam1 lightning yam3 clock" | "yam1 yam2 yam3 explosion" | "yam1 yam2 cheese clock" | "eye yam2 eyepatch yam4" | "chair yam2 yam3 clock" | "fur lightning eyepatch yam4" | "fur yam2 wall yam4" | "vessel yam2 cheese explosion")[];
 /**
  * Find the combination needed to get a particular resonance
  * @param target The Item or Effect granted by the resonance

package/dist/resources/2024/MayamCalendar.js

@@ -14,7 +14,12 @@ export const RINGS = Object.freeze([
 export function have() {
     return have_($item `Mayam Calendar`);
 }
-const symbolsUsed = () => get("_mayamSymbolsUsed").split(",");
+/**
+ * @returns The Mayam calendar symbols you've used so far today.
+ */
+export function symbolsUsed() {
+    return get("_mayamSymbolsUsed").split(",");
+}
 /**
  * Determine whether certain Mayam symbols are available for use today
  *
@@ -59,7 +64,7 @@ export function submit(...combination) {
     if (!available(...toCombination(combination))) {
         return false;
     }
-    return cliExecute(`mayam ring ${combination.join(" ").replace(/yam\d/g, "yam")}`);
+    return cliExecute(`mayam rings ${combination.join(" ").replace(/yam\d/g, "yam")}`);
 }
 export const RESONANCES = Object.freeze({
     "eye yam2 eyepatch yam4": $item `Mayam spinach`,
@@ -74,6 +79,7 @@ export const RESONANCES = Object.freeze({
     "chair yam2 yam3 clock": $effect `Caught Yam-Handed`,
     "yam1 yam2 cheese clock": $effect `Memories of Cheesier Age`,
 });
+export const RESONANCE_KEYS = Object.keys(RESONANCES);
 /**
  * Find the combination needed to get a particular resonance
  * @param target The Item or Effect granted by the resonance

package/dist/utils.d.ts

@@ -116,6 +116,13 @@ export declare function maxBy<T>(array: T[] | readonly T[], optimizer: (element:
 export declare function maxBy<S extends string | number | symbol, T extends {
     [x in S]: number;
 }>(array: T[] | readonly T[], key: S, reverse?: boolean): T;
+/**
+ * Let Typescript see that you're working with tuples!
+ *
+ * @param args A spread array to interpret as a tuple
+ * @returns The given arg, its type now interpreted as a tuple
+ */
+export declare function tuple<T extends any[]>(...args: T): T;
 export type Tuple<T, N extends number> = N extends N ? number extends N ? T[] : _tupleOf<T, N, []> : never;
 type _tupleOf<T, N extends number, R extends unknown[]> = R["length"] extends N ? R : _tupleOf<T, N, [T, ...R]>;
 /**
@@ -159,6 +166,7 @@ export type Switch<T extends string, S> = Record<T, S> | (Partial<{
 export declare function makeByXFunction<T extends string>(source: Delayed<T>): <S>(options: Switch<T, S>, alternateSource?: Delayed<T>) => S;
 /**
  * Flattens an array. Basically replacing Array.prototype.flat for which Rhino doesn't yet have an implementation
+ * @deprecated KoLMafia now supports the `flat` and `flatMap` methods
  *
  * @param arr Array to flatten
  * @param depth Number of layers to flatten by; Infinity for a fully flat array

package/dist/utils.js

@@ -189,6 +189,16 @@ export function maxBy(array, optimizer, reverse = false) {
         return array.reduce((a, b) => a[optimizer] >= b[optimizer] !== reverse ? a : b);
     }
 }
+/**
+ * Let Typescript see that you're working with tuples!
+ *
+ * @param args A spread array to interpret as a tuple
+ * @returns The given arg, its type now interpreted as a tuple
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function tuple(...args) {
+    return args;
+}
 /**
  * Compare arrays shallowly
  *
@@ -230,6 +240,7 @@ export function makeByXFunction(source) {
 }
 /**
  * Flattens an array. Basically replacing Array.prototype.flat for which Rhino doesn't yet have an implementation
+ * @deprecated KoLMafia now supports the `flat` and `flatMap` methods
  *
  * @param arr Array to flatten
  * @param depth Number of layers to flatten by; Infinity for a fully flat array

package/package.json

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