libram 0.4.6 → 0.5.0

package/dist/combat.d.ts

@@ -4,7 +4,7 @@
  * @category Combat
  * @returns {number} The macro ID.
  */
-export declare function getMacroId(): number;
+export declare function getMacroId(name?: string): number;
 declare type ItemOrName = Item | string;
 declare type SkillOrName = Skill | string;
 declare type Constructor<T> = {
@@ -21,13 +21,20 @@ export declare class InvalidMacroError extends Error {
  */
 export declare class Macro {
     static SAVED_MACRO_PROPERTY: string;
-    static cachedMacroId: number | null;
-    static cachedAutoAttack: string | null;
+    static cachedMacroIds: Map<string, number>;
+    static cachedAutoAttacks: Map<string, string>;
     components: string[];
+    name: string;
     /**
      * Convert macro to string.
      */
     toString(): string;
+    /**
+     * Gives your macro a new name to be used when saving an autoattack.
+     * @param name The name to be used when saving as an autoattack.
+     * @returns The previous name assigned to this macro.
+     */
+    rename(name: string): string;
     /**
      * Save a macro to a Mafia property for use in a consult script.
      */
@@ -60,6 +67,15 @@ export declare class Macro {
      * Set this macro as a KoL native autoattack.
      */
     setAutoAttack(): void;
+    /**
+     * Renames the macro, then sets it as an autoattack.
+     * @param name The name to save the macro under as an autoattack.
+     */
+    setAutoAttackAs(name: string): void;
+    /**
+     * Clear all cached autoattacks, and delete all stored macros server-side.
+     */
+    static clearAutoAttackMacros(): void;
     /**
      * Add an "abort" step to this macro.
      * @returns {Macro} This object itself.

package/dist/combat.js

@@ -9,11 +9,11 @@ const MACRO_NAME = "Script Autoattack Macro";
  * @category Combat
  * @returns {number} The macro ID.
  */
-export function getMacroId() {
-    const macroMatches = xpath(visitUrl("account_combatmacros.php"), `//select[@name="macroid"]/option[text()="${MACRO_NAME}"]/@value`);
+export function getMacroId(name = MACRO_NAME) {
+    const macroMatches = xpath(visitUrl("account_combatmacros.php"), `//select[@name="macroid"]/option[text()="${name}"]/@value`);
     if (macroMatches.length === 0) {
         visitUrl("account_combatmacros.php?action=new");
-        const newMacroText = visitUrl(`account_combatmacros.php?macroid=0&name=${MACRO_NAME}&macrotext=abort&action=save`);
+        const newMacroText = visitUrl(`account_combatmacros.php?macroid=0&name=${name}&macrotext=abort&action=save`);
         return parseInt(xpath(newMacroText, "//input[@name=macroid]/@value")[0], 10);
     }
     else {
@@ -70,15 +70,26 @@ export class InvalidMacroError extends Error {
  */
 export class Macro {
     static SAVED_MACRO_PROPERTY = "libram_savedMacro";
-    static cachedMacroId = null;
-    static cachedAutoAttack = null;
+    static cachedMacroIds = new Map();
+    static cachedAutoAttacks = new Map();
     components = [];
+    name = MACRO_NAME;
     /**
      * Convert macro to string.
      */
     toString() {
         return this.components.join(";");
     }
+    /**
+     * Gives your macro a new name to be used when saving an autoattack.
+     * @param name The name to be used when saving as an autoattack.
+     * @returns The previous name assigned to this macro.
+     */
+    rename(name) {
+        const returnValue = this.name;
+        this.name = name;
+        return returnValue;
+    }
     /**
      * Save a macro to a Mafia property for use in a consult script.
      */
@@ -129,16 +140,36 @@ export class Macro {
      * Set this macro as a KoL native autoattack.
      */
     setAutoAttack() {
-        if (Macro.cachedMacroId === null)
-            Macro.cachedMacroId = getMacroId();
-        if (getAutoAttack() === 99000000 + Macro.cachedMacroId &&
-            this.toString() === Macro.cachedAutoAttack) {
+        let id = Macro.cachedMacroIds.get(this.name);
+        if (id === undefined)
+            Macro.cachedMacroIds.set(this.name, getMacroId(this.name));
+        id = getMacroId(this.name);
+        if (getAutoAttack() === 99000000 + id &&
+            this.toString() === Macro.cachedAutoAttacks.get(this.name)) {
             // This macro is already set. Don"t make the server request.
             return;
         }
-        visitUrl(`account_combatmacros.php?macroid=${Macro.cachedMacroId}&name=${urlEncode(MACRO_NAME)}&macrotext=${urlEncode(this.toString())}&action=save`, true, true);
-        visitUrl(`account.php?am=1&action=autoattack&value=${99000000 + Macro.cachedMacroId}&ajax=1`);
-        Macro.cachedAutoAttack = this.toString();
+        visitUrl(`account_combatmacros.php?macroid=${id}&name=${urlEncode(this.name)}&macrotext=${urlEncode(this.toString())}&action=save`, true, true);
+        visitUrl(`account.php?am=1&action=autoattack&value=${99000000 + id}&ajax=1`);
+        Macro.cachedAutoAttacks.set(this.name, this.toString());
+    }
+    /**
+     * Renames the macro, then sets it as an autoattack.
+     * @param name The name to save the macro under as an autoattack.
+     */
+    setAutoAttackAs(name) {
+        this.name = name;
+        this.setAutoAttack();
+    }
+    /**
+     * Clear all cached autoattacks, and delete all stored macros server-side.
+     */
+    static clearAutoAttackMacros() {
+        for (const name of Macro.cachedAutoAttacks.keys()) {
+            const id = Macro.cachedMacroIds.get(name) ?? getMacroId(name);
+            visitUrl(`account_combatmacros.php?macroid=${id}&action=edit&what=Delete&confirm=1`);
+            Macro.cachedAutoAttacks.delete(name);
+        }
     }
     /**
      * Add an "abort" step to this macro.

package/dist/diet/index.d.ts

@@ -1,18 +1,26 @@
-declare type MenuItemOptions = {
+declare type RawDietEntry<T> = [MenuItem<T>[], number];
+declare type RawDiet<T> = RawDietEntry<T>[];
+declare type MenuItemOptions<T> = {
     organ?: Organ;
     size?: number;
     maximum?: number | "auto";
     additionalValue?: number;
-    wishEffect?: Effect;
+    effect?: Effect;
+    priceOverride?: number;
+    mayo?: Item;
+    data?: T;
 };
-export declare class MenuItem {
+export declare class MenuItem<T> {
     item: Item;
     organ?: Organ;
     size: number;
     maximum?: number;
     additionalValue?: number;
-    wishEffect?: Effect;
-    static defaultOptions: Map<Item, MenuItemOptions>;
+    effect?: Effect;
+    priceOverride?: number;
+    mayo?: Item;
+    data?: T;
+    static defaultOptions<T>(): Map<Item, MenuItemOptions<T>>;
     /**
      * Construct a new menu item, possibly with extra properties. Items in MenuItem.defaultOptions have intelligent defaults.
      * @param item Item to add to menu.
@@ -20,21 +28,48 @@ export declare class MenuItem {
      * @param options.size Override item organ size. Necessary for any non-food/booze/spleen item.
      * @param options.maximum Maximum uses remaining today, or "auto" to check dailyusesleft Mafia property.
      * @param options.additionalValue Additional value (positive) or cost (negative) to consider with item, e.g. from buffs.
-     * @param options.wishEffect If item is a pocket wish, effect to wish for.
+     * @param options.effect Effect associated with this menu item (pocket wish effect, sweet synthesis effect, pill keeper potion extension)
+     * @param options.mayo Which mayo to use before item (ignored if mayo clinic is not installed or item is not a food)
+     * @param options.note Any note to track information about item, to be used later
      */
-    constructor(item: Item, options?: MenuItemOptions);
-    equals(other: MenuItem): boolean;
+    constructor(item: Item, options?: MenuItemOptions<T>);
+    equals(other: MenuItem<T>): boolean;
     toString(): string;
     price(): number;
 }
 declare const organs: readonly ["food", "booze", "spleen item"];
 declare type Organ = typeof organs[number];
+declare class DietEntry<T> {
+    readonly menuItems: MenuItem<T>[];
+    quantity: number;
+    constructor(menuItems: MenuItem<T>[], quantity: number);
+    target(): MenuItem<T>;
+    helpers(): MenuItem<T>[];
+    expectedAdventures(diet: Diet<T>): number;
+    expectedValue(mpa: number, diet: Diet<T>, method?: "gross" | "net"): number;
+    expectedPrice(): number;
+}
+interface OrganCapacity {
+    food?: number | "auto";
+    booze?: number | "auto";
+    spleen?: number | "auto";
+}
 /**
- * Plan out an optimal diet using a knapsack algorithm.
- * @param mpa Meat per adventure value.
- * @param menu Array of MenuItems to consider for diet purposes.
- * @param organCapacities Optional override of each organ's capacity.
- * @returns Array of [menu item and helpers, count].
+ * A representation of a potential diet
  */
-export declare function planDiet(mpa: number, menu: MenuItem[], organCapacities?: [Organ, number | null][]): [MenuItem[], number][];
+export declare class Diet<T> {
+    entries: DietEntry<T>[];
+    constructor(entries?: DietEntry<T>[]);
+    get refinedPalate(): boolean;
+    get garish(): boolean;
+    get saucemaven(): boolean;
+    get tuxedoShirt(): boolean;
+    get pinkyRing(): boolean;
+    expectedAdventures(): number;
+    expectedValue(mpa: number, method?: "gross" | "net"): number;
+    expectedPrice(): number;
+    copy(): Diet<T>;
+    static from<T>(rawDiet: RawDiet<T>): Diet<T>;
+    static plan<T>(mpa: number, menu: MenuItem<T>[], organCapacities?: OrganCapacity): Diet<T>;
+}
 export {};

package/dist/diet/index.js

@@ -1,10 +1,11 @@
-import { canEquip, fullnessLimit, getWorkshed, inebrietyLimit, itemType, mallPrice, mallPrices, myFullness, myInebriety, myLevel, myPrimestat, mySpleenUse, npcPrice, spleenLimit, } from "kolmafia";
+import { canEquip, fullnessLimit, inebrietyLimit, itemType, mallPrice, mallPrices, myFullness, myInebriety, myLevel, myPrimestat, mySpleenUse, npcPrice, spleenLimit, } from "kolmafia";
 import { knapsack } from "./knapsack";
 import { have } from "../lib";
 import { get as getModifier } from "../modifier";
 import { get } from "../property";
 import { $effect, $item, $items, $skill, $stat } from "../template-string";
-import { sum } from "../utils";
+import { sum, sumNumbers } from "../utils";
+import { Mayo, installed as mayoInstalled } from "../resources/2015/MayoClinic";
 function isMonday() {
     // Checking Tuesday's ruby is a hack to see if it's Monday in Arizona.
     return getModifier("Muscle Percent", $item `Tuesday's ruby`) > 0;
@@ -55,59 +56,64 @@ export class MenuItem {
     size;
     maximum;
     additionalValue;
-    wishEffect;
-    static defaultOptions = new Map([
-        [
-            $item `distention pill`,
-            {
-                organ: "food",
-                maximum: !have($item `distention pill`) || get("_distentionPillUsed") ? 0 : 1,
-                size: -1,
-            },
-        ],
-        [
-            $item `synthetic dog hair pill`,
-            {
-                organ: "booze",
-                maximum: !have($item `synthetic dog hair pill`) ||
-                    get("_syntheticDogHairPillUsed")
-                    ? 0
-                    : 1,
-                size: -1,
-            },
-        ],
-        [
-            $item `cuppa Voraci tea`,
-            { organ: "food", maximum: get("_voraciTeaUsed") ? 0 : 1, size: -1 },
-        ],
-        [
-            $item `cuppa Sobrie tea`,
-            { organ: "booze", maximum: get("_sobrieTeaUsed") ? 0 : 1, size: -1 },
-        ],
-        [
-            $item `mojo filter`,
-            {
-                organ: "spleen item",
-                maximum: 3 - get("currentMojoFilters"),
-                size: -1,
-            },
-        ],
-        [$item `spice melange`, { maximum: get("spiceMelangeUsed") ? 0 : 1 }],
-        [
-            $item `Ultra Mega Sour Ball`,
-            { maximum: get("_ultraMegaSourBallUsed") ? 0 : 1 },
-        ],
-        [
-            $item `The Plumber's mushroom stew`,
-            { maximum: get("_plumbersMushroomStewEaten") ? 0 : 1 },
-        ],
-        [$item `The Mad Liquor`, { maximum: get("_madLiquorDrunk") ? 0 : 1 }],
-        [
-            $item `Doc Clock's thyme cocktail`,
-            { maximum: get("_docClocksThymeCocktailDrunk") ? 0 : 1 },
-        ],
-        [$item `Mr. Burnsger`, { maximum: get("_mrBurnsgerEaten") ? 0 : 1 }],
-    ]);
+    effect;
+    priceOverride;
+    mayo;
+    data;
+    static defaultOptions() {
+        return new Map([
+            [
+                $item `distention pill`,
+                {
+                    organ: "food",
+                    maximum: !have($item `distention pill`) || get("_distentionPillUsed") ? 0 : 1,
+                    size: -1,
+                },
+            ],
+            [
+                $item `synthetic dog hair pill`,
+                {
+                    organ: "booze",
+                    maximum: !have($item `synthetic dog hair pill`) ||
+                        get("_syntheticDogHairPillUsed")
+                        ? 0
+                        : 1,
+                    size: -1,
+                },
+            ],
+            [
+                $item `cuppa Voraci tea`,
+                { organ: "food", maximum: get("_voraciTeaUsed") ? 0 : 1, size: -1 },
+            ],
+            [
+                $item `cuppa Sobrie tea`,
+                { organ: "booze", maximum: get("_sobrieTeaUsed") ? 0 : 1, size: -1 },
+            ],
+            [
+                $item `mojo filter`,
+                {
+                    organ: "spleen item",
+                    maximum: 3 - get("currentMojoFilters"),
+                    size: -1,
+                },
+            ],
+            [$item `spice melange`, { maximum: get("spiceMelangeUsed") ? 0 : 1 }],
+            [
+                $item `Ultra Mega Sour Ball`,
+                { maximum: get("_ultraMegaSourBallUsed") ? 0 : 1 },
+            ],
+            [
+                $item `The Plumber's mushroom stew`,
+                { maximum: get("_plumbersMushroomStewEaten") ? 0 : 1 },
+            ],
+            [$item `The Mad Liquor`, { maximum: get("_madLiquorDrunk") ? 0 : 1 }],
+            [
+                $item `Doc Clock's thyme cocktail`,
+                { maximum: get("_docClocksThymeCocktailDrunk") ? 0 : 1 },
+            ],
+            [$item `Mr. Burnsger`, { maximum: get("_mrBurnsgerEaten") ? 0 : 1 }],
+        ]);
+    }
     /**
      * Construct a new menu item, possibly with extra properties. Items in MenuItem.defaultOptions have intelligent defaults.
      * @param item Item to add to menu.
@@ -115,17 +121,22 @@ export class MenuItem {
      * @param options.size Override item organ size. Necessary for any non-food/booze/spleen item.
      * @param options.maximum Maximum uses remaining today, or "auto" to check dailyusesleft Mafia property.
      * @param options.additionalValue Additional value (positive) or cost (negative) to consider with item, e.g. from buffs.
-     * @param options.wishEffect If item is a pocket wish, effect to wish for.
+     * @param options.effect Effect associated with this menu item (pocket wish effect, sweet synthesis effect, pill keeper potion extension)
+     * @param options.mayo Which mayo to use before item (ignored if mayo clinic is not installed or item is not a food)
+     * @param options.note Any note to track information about item, to be used later
      */
     constructor(item, options = {}) {
-        const { size, organ, maximum, additionalValue, wishEffect } = {
+        const { size, organ, maximum, additionalValue, effect, priceOverride, mayo, data, } = {
             ...options,
-            ...(MenuItem.defaultOptions.get(item) ?? {}),
+            ...(MenuItem.defaultOptions().get(item) ?? {}),
         };
         this.item = item;
         this.maximum = maximum === "auto" ? item.dailyusesleft : maximum;
         this.additionalValue = additionalValue;
-        this.wishEffect = wishEffect;
+        this.effect = effect;
+        this.priceOverride = priceOverride;
+        this.mayo = mayo;
+        this.data = data;
         const typ = itemType(this.item);
         this.organ = organ ?? (isOrgan(typ) ? typ : undefined);
         this.size =
@@ -139,13 +150,17 @@ export class MenuItem {
                             : 0);
     }
     equals(other) {
-        return this.item === other.item && this.wishEffect === other.wishEffect;
+        return this.item === other.item && this.effect === other.effect;
     }
     toString() {
+        if (this.effect) {
+            return `${this.item}:${this.effect}`;
+        }
         return this.item.toString();
     }
     price() {
-        return npcPrice(this.item) > 0 ? npcPrice(this.item) : mallPrice(this.item);
+        return (this.priceOverride ??
+            (npcPrice(this.item) > 0 ? npcPrice(this.item) : mallPrice(this.item)));
     }
 }
 const organs = ["food", "booze", "spleen item"];
@@ -155,20 +170,24 @@ function isOrgan(x) {
 class DietPlanner {
     mpa;
     menu;
+    mayoLookup;
     fork;
     mug;
     seasoning;
-    mayoflex;
     spleenValue = 0;
     constructor(mpa, menu) {
         this.mpa = mpa;
         this.fork = menu.find((item) => item.item === $item `Ol' Scratch's salad fork`);
         this.mug = menu.find((item) => item.item === $item `Frosty's frosty mug`);
         this.seasoning = menu.find((item) => item.item === $item `Special Seasoning`);
-        this.mayoflex =
-            getWorkshed() === $item `portable Mayo Clinic`
-                ? menu.find((item) => item.item === $item `Mayoflex`)
-                : undefined;
+        this.mayoLookup = new Map();
+        if (mayoInstalled()) {
+            for (const mayo of [Mayo.flex, Mayo.zapine]) {
+                const menuItem = menu.find((item) => item.item === mayo);
+                if (menuItem)
+                    this.mayoLookup.set(mayo, menuItem);
+            }
+        }
         this.menu = menu.filter((item) => item.organ);
         if (menu.length > 100) {
             mallPrices("food");
@@ -203,15 +222,19 @@ class DietPlanner {
             this.mpa > mallPrice($item `Special Seasoning`)) {
             helpers.push(this.seasoning);
         }
-        if (this.mayoflex &&
-            itemType(menuItem.item) === "food" &&
-            this.mpa > npcPrice($item `Mayoflex`)) {
-            helpers.push(this.mayoflex);
+        if (itemType(menuItem.item) === "food" && this.mayoLookup.size) {
+            const mayo = menuItem.mayo
+                ? this.mayoLookup.get(menuItem.mayo)
+                : this.mayoLookup.get(Mayo.flex);
+            if (mayo)
+                helpers.push(mayo);
         }
         const defaultModifiers = {
             forkMug: false,
             seasoning: this.seasoning ? helpers.includes(this.seasoning) : false,
-            mayoflex: this.mayoflex ? helpers.includes(this.mayoflex) : false,
+            mayoflex: this.mayoLookup.size
+                ? helpers.some((item) => item.item === Mayo.flex)
+                : false,
             refinedPalate: have($effect `Refined Palate`),
             garish: have($effect `Gar-ish`),
             saucemaven: have($skill `Saucemaven`),
@@ -297,10 +320,10 @@ class DietPlanner {
         }
         const organCapacitiesWith = [...organCapacitiesWithMap];
         const isRefinedPalate = (trialItem.item === $item `pocket wish` &&
-            trialItem.wishEffect === $effect `Refined Palate`) ||
+            trialItem.effect === $effect `Refined Palate`) ||
             trialItem.item === $item `toasted brie`;
         const isGarish = (trialItem.item === $item `pocket wish` &&
-            trialItem.wishEffect === $effect `Gar-ish`) ||
+            trialItem.effect === $effect `Gar-ish`) ||
             trialItem.item === $item `potion of the field gar`;
         const [valueWithout, planWithout] = this.planOrgansWithTrials(organCapacities, trialItems.slice(1), overrideModifiers);
         const [valueWith, planWith] = this.planOrgansWithTrials(organCapacitiesWith, trialItems.slice(1), {
@@ -374,7 +397,7 @@ const interactingItems = [
  * @param organCapacities Optional override of each organ's capacity.
  * @returns Array of [menu item and helpers, count].
  */
-export function planDiet(mpa, menu, organCapacities = [
+function planDiet(mpa, menu, organCapacities = [
     ["food", null],
     ["booze", null],
     ["spleen item", null],
@@ -400,7 +423,7 @@ export function planDiet(mpa, menu, organCapacities = [
         .map((menuItem) => {
         const interacting = interactingItems.find(([itemOrEffect]) => menuItem.item === itemOrEffect ||
             (menuItem.item === $item `pocket wish` &&
-                menuItem.wishEffect === itemOrEffect));
+                menuItem.effect === itemOrEffect));
         if (interacting) {
             const [, organSizes] = interacting;
             return [menuItem, organSizes];
@@ -434,3 +457,127 @@ export function planDiet(mpa, menu, organCapacities = [
         return planFoodBooze;
     }
 }
+class DietEntry {
+    menuItems;
+    quantity;
+    constructor(menuItems, quantity) {
+        this.menuItems = menuItems;
+        this.quantity = quantity;
+    }
+    target() {
+        return this.menuItems[this.menuItems.length - 1];
+    }
+    helpers() {
+        if (this.menuItems.length > 1) {
+            return this.menuItems.slice(0, -1);
+        }
+        return [];
+    }
+    expectedAdventures(diet) {
+        {
+            if (this.menuItems.length === 0 || this.quantity === 0) {
+                return 0;
+            }
+            else {
+                const items = this.menuItems.map((m) => m.item);
+                const targetItem = this.menuItems[this.menuItems.length - 1].item;
+                const fork = itemType(targetItem) === "food" &&
+                    items.includes($item `Ol' Scratch's salad fork`);
+                const mug = itemType(targetItem) === "booze" &&
+                    items.includes($item `Frosty's frosty mug`);
+                return (this.quantity *
+                    expectedAdventures(this.menuItems[this.menuItems.length - 1].item, {
+                        forkMug: fork || mug,
+                        seasoning: items.includes($item `Special Seasoning`),
+                        mayoflex: items.includes(Mayo.flex),
+                        refinedPalate: diet.refinedPalate,
+                        garish: diet.garish,
+                        saucemaven: diet.saucemaven,
+                        pinkyRing: diet.pinkyRing,
+                        tuxedoShirt: diet.tuxedoShirt,
+                    }));
+            }
+        }
+    }
+    expectedValue(mpa, diet, method = "gross") {
+        const adventures = this.expectedAdventures(diet);
+        const gross = this.quantity *
+            (mpa * adventures +
+                sumNumbers(this.menuItems.map((menuItem) => menuItem.additionalValue ?? 0)));
+        if (method === "gross") {
+            return gross;
+        }
+        else {
+            return gross - this.expectedPrice();
+        }
+    }
+    expectedPrice() {
+        return (this.quantity *
+            sumNumbers(this.menuItems.map((menuItem) => menuItem.price())));
+    }
+}
+/**
+ * A representation of a potential diet
+ */
+export class Diet {
+    entries;
+    constructor(entries = []) {
+        this.entries = entries;
+    }
+    get refinedPalate() {
+        return this.entries.some((dietEntry) => dietEntry.menuItems.some((trialItem) => (trialItem.item === $item `pocket wish` &&
+            trialItem.effect === $effect `Refined Palate`) ||
+            trialItem.item === $item `toasted brie`));
+    }
+    get garish() {
+        return this.entries.some((dietEntry) => dietEntry.menuItems.some((trialItem) => (trialItem.item === $item `pocket wish` &&
+            trialItem.effect === $effect `Gar-ish`) ||
+            trialItem.item === $item `potion of the field gar`));
+    }
+    get saucemaven() {
+        return have($skill `Saucemaven`);
+    }
+    get tuxedoShirt() {
+        return have($item `tuxedo shirt`) && canEquip($item `tuxedo shirt`);
+    }
+    get pinkyRing() {
+        return have($item `mafia pinky ring`) && canEquip($item `mafia pinky ring`);
+    }
+    expectedAdventures() {
+        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedAdventures(this)));
+    }
+    expectedValue(mpa, method = "gross") {
+        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedValue(mpa, this, method)));
+    }
+    expectedPrice() {
+        return sumNumbers(this.entries.map((dietEntry) => dietEntry.expectedPrice()));
+    }
+    copy() {
+        return new Diet([...this.entries]);
+    }
+    static from(rawDiet) {
+        const diet = rawDiet.map((item) => {
+            const [menuItems, quantity] = item;
+            return new DietEntry(menuItems, quantity);
+        });
+        return new Diet(diet);
+    }
+    static plan(mpa, menu, organCapacities = {
+        food: "auto",
+        booze: "auto",
+        spleen: "auto",
+    }) {
+        const { food, booze, spleen } = organCapacities;
+        const plannerCapacity = [];
+        if (food) {
+            plannerCapacity.push(["food", food === "auto" ? null : food]);
+        }
+        if (booze) {
+            plannerCapacity.push(["booze", booze === "auto" ? null : booze]);
+        }
+        if (spleen) {
+            plannerCapacity.push(["spleen item", spleen === "auto" ? null : spleen]);
+        }
+        return Diet.from(planDiet(mpa, menu, plannerCapacity));
+    }
+}

package/dist/freerun.d.ts

@@ -20,4 +20,5 @@ export declare class FreeRun {
     options?: FreeRunOptions;
     constructor(name: string, available: () => boolean, macro: Macro, options?: FreeRunOptions);
 }
-export declare function findFreeRun(useFamiliar?: boolean, buyStuff?: boolean): FreeRun | undefined;
+export declare function tryFindFreeRun(useFamiliar?: boolean): FreeRun | null;
+export declare function ensureFreeRun(useFamiliar?: boolean): FreeRun;

package/dist/freerun.js

@@ -87,10 +87,13 @@ function cheapestRunSource() {
 }
 function cheapestItemRun() {
     const cheapestRun = cheapestRunSource();
-    return new FreeRun("Cheap Combat Item", () => retrieveItem(cheapestRun), Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`).item(cheapestRunSource()), {
+    return new FreeRun("Cheap Combat Item", () => retrieveItem(cheapestRun), Macro.trySkill($skill `Asdon Martin: Spring-Loaded Front Bumper`).item(cheapestRun), {
         preparation: () => retrieveItem(cheapestRun),
     });
 }
-export function findFreeRun(useFamiliar = true, buyStuff = true) {
-    return (freeRuns.find((run) => run.available() && (useFamiliar || run?.options?.familiar)) ?? (buyStuff ? cheapestItemRun() : undefined));
+export function tryFindFreeRun(useFamiliar = true) {
+    return (freeRuns.find((run) => run.available() && (useFamiliar || run?.options?.familiar)) ?? null);
+}
+export function ensureFreeRun(useFamiliar = true) {
+    return tryFindFreeRun(useFamiliar) ?? cheapestItemRun();
 }

package/dist/lib.d.ts

@@ -1,5 +1,6 @@
 /** @module GeneralLibrary */
 import "core-js/modules/es.object.entries";
+import "core-js/features/array/flat";
 /**
  * Returns the current maximum Accordion Thief songs the player can have in their head
  *