libram 0.8.27 → 0.8.29

package/dist/Kmail.d.ts

@@ -15,6 +15,7 @@ export default class Kmail {
     readonly senderId: number;
     readonly senderName: string;
     readonly rawMessage: string;
+    private _parsedMessageParts;
     /**
      * Parses a kmail from KoL's native format
      *
@@ -72,18 +73,46 @@ export default class Kmail {
      * @returns Whether the kmail was deleted
      */
     delete(): boolean;
+    private get _messageParts();
+    private _parseMessageParts;
     /**
      * Get message contents without any HTML from items or meat
      *
      * @returns Cleaned message contents
      */
     get message(): string;
+    /**
+     * Get the note on the outside of the gift. If the kmail is not a gift,
+     * this will be the entire message.
+     *
+     * @returns Note on the outside of the gift, or the entire message for non-gifts
+     */
+    get outsideNote(): string;
+    /**
+     * Get the note on the inside of the gift
+     *
+     * @returns Note on the inside of the gift
+     */
+    get insideNote(): string | null;
     /**
      * Get items attached to the kmail
      *
      * @returns Map of items attached to the kmail and their quantities
      */
     items(): Map<Item, number>;
+    /**
+     * Get items attached to the outside of the gift, which should be
+     * just the gift wrapper for giftshop items, and all items for normal kmails
+     *
+     * @returns Map of items attached to the kmail and their quantities
+     */
+    outsideItems(): Map<Item, number>;
+    /**
+     * Get items attached to the inside of the gift
+     *
+     * @returns Map of items attached to the kmail and their quantities
+     */
+    insideItems(): Map<Item, number>;
     /**
      * Get meat attached to the kmail
      *

package/dist/Kmail.js

@@ -1,4 +1,6 @@
-import { extractItems, extractMeat, isGiftable, Item, visitUrl, } from "kolmafia";
+import { decode as decodeEntities } from "html-entities";
+import { extractMeat, isGiftable, visitUrl } from "kolmafia";
+import { extractItems } from "./lib";
 import { combineQuery, EMPTY_VALUE, fetchUrl } from "./url";
 import { arrayToCountedMap, chunk } from "./utils";
 export default class Kmail {
@@ -8,6 +10,7 @@ export default class Kmail {
     senderId;
     senderName;
     rawMessage;
+    _parsedMessageParts;
     /**
      * Parses a kmail from KoL's native format
      *
@@ -123,12 +126,8 @@ export default class Kmail {
         }), ">Package sent.</");
     }
     constructor(rawKmail) {
-        const date = new Date(rawKmail.localtime);
-        // Date come from KoL formatted with YY and so will be parsed 19YY, which is wrong.
-        // We can safely add 100 because if 19YY was a leap year, 20YY will be too!
-        date.setFullYear(date.getFullYear() + 100);
         this.id = Number(rawKmail.id);
-        this.date = date;
+        this.date = new Date(Number(rawKmail.azunixtime) * 1000);
         this.type = rawKmail.type;
         this.senderId = Number(rawKmail.fromid);
         this.senderName = rawKmail.fromname;
@@ -142,14 +141,65 @@ export default class Kmail {
     delete() {
         return Kmail.delete([this]) === 1;
     }
+    get _messageParts() {
+        return (this._parsedMessageParts ??= this._parseMessageParts());
+    }
+    _parseMessageParts() {
+        let text = this.rawMessage;
+        let insideText;
+        if (this.type === "normal") {
+            // strip potential valentine
+            if (text.startsWith("<center>")) {
+                const endIdx = text.indexOf("</center>");
+                text = text.slice(endIdx + 9);
+            }
+        }
+        else if (this.type === "giftshop") {
+            [text, insideText] = text.split("<p>Inside Note:<p>");
+        }
+        const split = (s) => {
+            const idx = s.indexOf("<");
+            if (idx === -1)
+                return [s];
+            return [s.slice(0, idx), s.slice(idx)];
+        };
+        const [outsideNote, outsideAttachments = null] = split(text);
+        const [insideNote = null, insideAttachments = null] = insideText !== undefined ? split(insideText) : [];
+        return {
+            outsideNote: decodeEntities(outsideNote),
+            outsideAttachments,
+            insideNote: insideNote && decodeEntities(insideNote),
+            insideAttachments,
+        };
+    }
     /**
      * Get message contents without any HTML from items or meat
      *
      * @returns Cleaned message contents
      */
     get message() {
-        const match = this.rawMessage.match(/^(.*?)</s);
-        return match ? match[1] : this.rawMessage;
+        const { outsideNote, insideNote } = this._messageParts;
+        if (insideNote !== null) {
+            return `${outsideNote}\n\nInside Note:\n${insideNote}`;
+        }
+        return outsideNote;
+    }
+    /**
+     * Get the note on the outside of the gift. If the kmail is not a gift,
+     * this will be the entire message.
+     *
+     * @returns Note on the outside of the gift, or the entire message for non-gifts
+     */
+    get outsideNote() {
+        return this._messageParts.outsideNote;
+    }
+    /**
+     * Get the note on the inside of the gift
+     *
+     * @returns Note on the inside of the gift
+     */
+    get insideNote() {
+        return this._messageParts.insideNote;
     }
     /**
      * Get items attached to the kmail
@@ -157,7 +207,31 @@ export default class Kmail {
      * @returns Map of items attached to the kmail and their quantities
      */
     items() {
-        return new Map(Object.entries(extractItems(this.rawMessage)).map(([itemName, quantity]) => [Item.get(itemName), quantity]));
+        const { outsideAttachments, insideAttachments } = this._messageParts;
+        return extractItems(`${outsideAttachments}${insideAttachments}`);
+    }
+    /**
+     * Get items attached to the outside of the gift, which should be
+     * just the gift wrapper for giftshop items, and all items for normal kmails
+     *
+     * @returns Map of items attached to the kmail and their quantities
+     */
+    outsideItems() {
+        const { outsideAttachments } = this._messageParts;
+        if (!outsideAttachments)
+            return new Map();
+        return extractItems(outsideAttachments);
+    }
+    /**
+     * Get items attached to the inside of the gift
+     *
+     * @returns Map of items attached to the kmail and their quantities
+     */
+    insideItems() {
+        const { insideAttachments } = this._messageParts;
+        if (!insideAttachments)
+            return new Map();
+        return extractItems(insideAttachments);
     }
     /**
      * Get meat attached to the kmail
@@ -165,7 +239,10 @@ export default class Kmail {
      * @returns Meat attached to the kmail
      */
     meat() {
-        return extractMeat(this.rawMessage);
+        const { outsideAttachments, insideAttachments } = this._messageParts;
+        if (!outsideAttachments && !insideAttachments)
+            return 0;
+        return extractMeat(`${outsideAttachments}${insideAttachments}`);
     }
     /**
      * Reply to kmail

package/dist/actions/ActionSource.js

@@ -16,6 +16,7 @@ function mergeConstraints(...allConstraints) {
         // Inconsistent requirements.
         return null;
     }
+    const familiar = familiars.find((familiar) => familiar);
     return {
         equipmentRequirements: () => Requirement.merge([
             ...allConstraints.map((constraints) => constraints.equipmentRequirements?.() ?? new Requirement([], {})),
@@ -28,7 +29,7 @@ function mergeConstraints(...allConstraints) {
             }
             return success;
         },
-        familiar: familiars.find((familiar) => familiar),
+        ...(familiar ? { familiar } : {}),
         cost: () => sum(allConstraints, (constraints) => constraints.cost?.() ?? 0),
     };
 }

package/dist/actions/FreeRun.js

@@ -5,11 +5,15 @@ import { Requirement } from "../maximize";
 import { get } from "../property";
 import * as Bandersnatch from "../resources/2009/Bandersnatch";
 import * as StompingBoots from "../resources/2011/StompingBoots";
-import { $effect, $familiar, $item, $items } from "../template-string";
+import { $effect, $familiar, $item, $items, $skill } from "../template-string";
 import { ActionSource, findActionSource, } from "./ActionSource";
 // eslint-disable-next-line libram/verify-constants
 const EVERYTHING_LOOKS_GREEN = $effect `Everything Looks Green`;
 const freeRunSources = [
+    // Free unlimited source
+    new ActionSource($item `spring shoes`, () => (have(EVERYTHING_LOOKS_GREEN) ? 1 : 0), Macro.skill($skill `Spring Away`), {
+        equipmentRequirements: () => new Requirement([], { forceEquip: $items `spring shoes` }),
+    }),
     // Free limited sources
     new ActionSource($familiar `Frumious Bandersnatch`, () => (have($effect `Ode to Booze`) || getSongCount() < getSongLimit()) &&
         Bandersnatch.couldRunaway()

package/dist/ascend.d.ts

@@ -34,7 +34,7 @@ declare type InputMoonSign = number | Lowercase<MoonSign> | "degrassi" | "degras
  * Hops the gash, perming no skills by default
  *
  * @param options Configuration for the ascension
- * @param options.path path of choice, as a Path object--these exist as properties of Paths
+ * @param options.path Your path of choice for this ascension
  * @param options.playerClass Your class of choice for this ascension
  * @param options.lifestyle 1 for casual, 2 for softcore, 3 for hardcore. Alternately, use the Lifestyle enum
  * @param options.kolGender An entry from the KolGender enum: 1 for male, 2 for female (sorry that it's limited to those). Defaults to 2 or the corresponding value for defaultGenderOverride pref (which should be 'male' or 'female')

package/dist/ascend.js

@@ -137,7 +137,7 @@ function isInValhalla() {
  * Hops the gash, perming no skills by default
  *
  * @param options Configuration for the ascension
- * @param options.path path of choice, as a Path object--these exist as properties of Paths
+ * @param options.path Your path of choice for this ascension
  * @param options.playerClass Your class of choice for this ascension
  * @param options.lifestyle 1 for casual, 2 for softcore, 3 for hardcore. Alternately, use the Lifestyle enum
  * @param options.kolGender An entry from the KolGender enum: 1 for male, 2 for female (sorry that it's limited to those). Defaults to 2 or the corresponding value for defaultGenderOverride pref (which should be 'male' or 'female')

package/dist/diet/index.d.ts

@@ -1,17 +1,17 @@
 import { Effect, Item } from "kolmafia";
 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;
-    effect?: Effect;
-    priceOverride?: number;
-    mayo?: Item;
-    data?: T;
-    useRetrievePrice?: boolean;
-};
+declare type MenuItemOptions<T> = Partial<{
+    organ: Organ;
+    size: number;
+    maximum: number | "auto";
+    additionalValue: number;
+    effect: Effect;
+    priceOverride: number;
+    mayo: Item;
+    data: T;
+    useRetrievePrice: boolean;
+}>;
 export declare class MenuItem<T> {
     item: Item;
     organ?: Organ;

package/dist/diet/index.js

@@ -175,14 +175,24 @@ export class MenuItem {
             ...(MenuItem.defaultOptions().get(item) ?? {}),
         };
         this.item = item;
-        this.maximum = maximum === "auto" ? item.dailyusesleft : maximum;
-        this.additionalValue = additionalValue;
-        this.effect = effect;
-        this.priceOverride = priceOverride;
-        this.mayo = mayo;
-        this.data = data;
+        const maximum_ = maximum === "auto" ? item.dailyusesleft : maximum;
+        if (maximum_)
+            this.maximum = maximum_;
+        if (additionalValue)
+            this.additionalValue = additionalValue;
+        if (effect)
+            this.effect = effect;
+        if (priceOverride)
+            this.priceOverride = priceOverride;
+        if (mayo)
+            this.mayo = mayo;
+        if (data)
+            this.data = data;
         const typ = itemType(this.item);
-        this.organ = organ ?? (isOrgan(typ) ? typ : undefined);
+        if (organ)
+            this.organ = organ;
+        else if (isOrgan(typ))
+            this.organ = typ;
         this.size =
             size ??
                 (this.organ === "food"
@@ -225,10 +235,18 @@ class DietPlanner {
     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.whetStone = menu.find((item) => item.item === $item `whet stone`);
+        const fork = menu.find((item) => item.item === $item `Ol' Scratch's salad fork`);
+        if (fork)
+            this.fork = fork;
+        const mug = menu.find((item) => item.item === $item `Frosty's frosty mug`);
+        if (mug)
+            this.mug = mug;
+        const seasoning = menu.find((item) => item.item === $item `Special Seasoning`);
+        if (seasoning)
+            this.seasoning = seasoning;
+        const whetStone = menu.find((item) => item.item === $item `whet stone`);
+        if (whetStone)
+            this.whetStone = whetStone;
         this.mayoLookup = new Map();
         if (mayoInstalled()) {
             for (const mayo of [Mayo.flex, Mayo.zapine]) {

package/dist/lib.d.ts

@@ -494,4 +494,14 @@ export declare function withCombatFlags<T>(action: () => T, ...flags: {
  * @returns Whether you have that effect as an intrinsic. Alternately you could just have over 2147483647 turns of that effect, but that seems unlikely.
  */
 export declare function haveIntrinsic(effect: Effect): boolean;
+/**
+ * Extracts a map of gained items from a string, for example from the result
+ * of a combat.
+ *
+ * NOTE: Make sure you trust the source of that text.
+ *
+ * @param text The text to extract items from
+ * @returns A map of items and their quantities
+ */
+export declare function extractItems(text: string): Map<Item, number>;
 export {};

package/dist/lib.js

@@ -1,5 +1,5 @@
 /** @module GeneralLibrary */
-import { appearanceRates, autosellPrice, availableAmount, booleanModifier, choiceFollowsFight, cliExecute, currentRound, Effect, elementalResistance, equip, equippedItem, 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, } from "kolmafia";
 import logger from "./logger";
 import { get } from "./property";
 import { $class, $effect, $element, $familiar, $item, $items, $monsters, $skill, $stat, } from "./template-string";
@@ -743,13 +743,13 @@ const hedgeTrap3 = new Map([
  * @returns An object with all information the telescope gives you about the sorceress's contests and maze
  */
 export function telescope() {
-    return {
+    return Object.fromEntries(Object.entries({
         statContest: telescopeStats.get(get("telescope1")),
         elementContest: telescopeElements.get(get("telescope2")),
         hedge1: hedgeTrap1.get(get("telescope3")),
         hedge2: hedgeTrap2.get(get("telescope4")),
         hedge3: hedgeTrap3.get(get("telescope5")),
-    };
+    }).filter(([, value]) => value));
 }
 /**
  * Visit the desc_x.php page for a given thing
@@ -956,3 +956,15 @@ export function withCombatFlags(action, ...flags) {
 export function haveIntrinsic(effect) {
     return haveEffect(effect) >= 2147483647;
 }
+/**
+ * Extracts a map of gained items from a string, for example from the result
+ * of a combat.
+ *
+ * NOTE: Make sure you trust the source of that text.
+ *
+ * @param text The text to extract items from
+ * @returns A map of items and their quantities
+ */
+export function extractItems(text) {
+    return new Map(Object.entries(kolmafiaExtractItems(text)).map(([itemName, quantity]) => [Item.get(itemName), quantity]));
+}

package/dist/maximize.d.ts

@@ -92,6 +92,7 @@ export declare class Requirement {
      * Merges two requirements, concanating relevant arrays. Typically used in static form.
      *
      * @param other Requirement to merge with.
+     * @returns A new merged Requirement
      */
     merge(other: Requirement): Requirement;
     /**

package/dist/maximize.js

@@ -437,6 +437,14 @@ export function maximizeCached(objectives, options = {}) {
     saveCached(cacheKey, fullOptions);
     return result;
 }
+function mergeOptionalOptions(optionsA, optionsB, ...keys) {
+    return keys.reduce((current, key) => ({
+        ...current,
+        ...((optionsA[key] || optionsB[key]) === undefined
+            ? {}
+            : { [key]: optionsA[key] || optionsB[key] }),
+    }), {});
+}
 export class Requirement {
     #maximizeParameters;
     #maximizeOptions;
@@ -460,15 +468,14 @@ export class Requirement {
      * Merges two requirements, concanating relevant arrays. Typically used in static form.
      *
      * @param other Requirement to merge with.
+     * @returns A new merged Requirement
      */
     merge(other) {
         const optionsA = this.maximizeOptions;
         const optionsB = other.maximizeOptions;
+        const optionalBooleans = mergeOptionalOptions(optionsA, optionsB, "updateOnFamiliarChange", "updateOnCanEquipChanged", "forceUpdate");
         return new Requirement([...this.maximizeParameters, ...other.maximizeParameters], {
-            updateOnFamiliarChange: optionsA.updateOnFamiliarChange ||
-                other.maximizeOptions.updateOnFamiliarChange,
-            updateOnCanEquipChanged: optionsA.updateOnCanEquipChanged ||
-                other.maximizeOptions.updateOnCanEquipChanged,
+            ...optionalBooleans,
             forceEquip: [
                 ...(optionsA.forceEquip ?? []),
                 ...(other.maximizeOptions.forceEquip ?? []),
@@ -486,7 +493,6 @@ export class Requirement {
                 ...(optionsA.preventSlot ?? []),
                 ...(optionsB.preventSlot ?? []),
             ],
-            forceUpdate: optionsA.forceUpdate || optionsB.forceUpdate,
         });
     }
     /**

package/dist/resources/2021/CrystalBall.js

@@ -13,7 +13,9 @@ export function have() {
 }
 const parsedProp = () => get("crystalBallPredictions")
     .split("|")
+    .filter(Boolean)
     .map((element) => element.split(":"))
+    .filter((tuple) => tuple.length === 3)
     .map(([, location, monster]) => [toLocation(location), toMonster(monster)]);
 const getLastPondered = () => `${myTotalTurnsSpent()};${totalTurnsPlayed()};${get("lastAdventure")}`;
 let lastPondered = "";

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

@@ -33,3 +33,10 @@ export declare function receive(monster: Monster): boolean;
  * @returns Whether we successfully differentiated our egg
  */
 export declare function differentiate(monster: Monster, ...combat: Parameters<typeof runCombat>): boolean;
+/**
+ * Check how many of a monster is available to differentiate into
+ *
+ * @param monster The monster to differentiate your egg into; may behave weirdly with name collisions
+ * @returns How many of a Monster we can differentiate
+ */
+export declare function differentiableQuantity(monster: Monster): number;

package/dist/resources/2024/ChestMimic.js

@@ -1,7 +1,8 @@
-import { runChoice, runCombat, toMonster, visitUrl, xpath, } from "kolmafia";
-import { directlyUse, have as have_ } from "../../lib";
+import { availableAmount, runChoice, runCombat, toMonster, visitUrl, xpath, } from "kolmafia";
+import { directlyUse, examine, have as have_ } from "../../lib";
 import { get } from "../../property";
 import { $familiar, $item } from "../../template-string";
+import { clamp } from "../../utils";
 const familiar = $familiar `Chest Mimic`;
 /**
  * @returns Whether you `have` the Chest Mimic familiar.
@@ -106,3 +107,19 @@ export function differentiate(monster, ...combat) {
     runCombat(...combat);
     return true;
 }
+/**
+ * Check how many of a monster is available to differentiate into
+ *
+ * @param monster The monster to differentiate your egg into; may behave weirdly with name collisions
+ * @returns How many of a Monster we can differentiate
+ */
+export function differentiableQuantity(monster) {
+    if (!have_($item `mimic egg`))
+        return 0;
+    const regex = new RegExp(`${monster.name}\\s*(?:\\((\\d+)\\))?`);
+    const page = examine($item `mimic egg`);
+    const match = page.match(regex);
+    if (!match)
+        return 0;
+    return clamp(parseInt(match[1]), 0, availableAmount($item `mimic egg`)) || 1;
+}

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "libram",
-  "version": "0.8.27",
+  "version": "0.8.29",
   "description": "JavaScript helper library for KoLmafia",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/loathers/libram",
   "author": "Samuel Gaus <sam@gaus.co.uk>",
   "license": "MIT",
-  "private": false,
   "scripts": {
     "build": "yarn run updateOverlappingItemSkillNames && yarn run build:tsc && yarn run build:bundled",
     "build:tsc": "tsc",
@@ -16,7 +15,8 @@
     "docs": "yarn run typedoc",
     "format": "yarn run prettier --write .",
     "lint": "yarn run eslint src tools --ext .ts && yarn run prettier --check .",
-    "prepublishOnly": "yarn run build",
+    "test": "yarn run jest",
+    "prepack": "yarn run build",
     "updateProps": "yarn run ts-node ./tools/parseDefaultProperties.ts",
     "updateOverlappingItemSkillNames": "yarn run ts-node ./tools/parseItemSkillNames.ts"
   },
@@ -35,7 +35,7 @@
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-typescript": "^7.15.0",
     "@tsconfig/node16": "^1.0.2",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^29.5.12",
     "@types/lodash-es": "^4.17.4",
     "@types/node": "^16.11.11",
     "@types/node-fetch": "^2.5.7",
@@ -52,12 +52,12 @@
     "eslint-plugin-libram": "^0.4.5",
     "husky": "^4.3.6",
     "java-parser": "^1.4.0",
-    "jest": "^27.1.0",
-    "kolmafia": "^5.27901.0",
+    "jest": "^29.7.0",
+    "kolmafia": "^5.27916.0",
     "lint-staged": ">=10",
     "node-fetch": "^2.6.1",
     "prettier": "^2.1.2",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.4.0",
     "typedoc": "^0.22.10",
     "typescript": "^4.5.2"
@@ -73,5 +73,6 @@
   "lint-staged": {
     "src/**/*.{ts,js}": "prettier --write"
   },
-  "sideEffects": false
-}
+  "sideEffects": false,
+  "packageManager": "yarn@4.1.1"
+}