libram 0.4.2 → 0.4.6

package/dist/Clan.js

@@ -9,6 +9,7 @@ import { getFoldGroup } from "./lib";
 import logger from "./logger";
 import { arrayToCountedMap, countedMapToArray, countedMapToString, notNull, parseNumber, } from "./utils";
 export class ClanError extends Error {
+    reason;
     constructor(message, reason) {
         super(message);
         this.reason = reason;
@@ -38,10 +39,8 @@ const toPlayerId = (player) => typeof player === "string" ? getPlayerId(player)
 const LOG_FAX_PATTERN = /(\d{2}\/\d{2}\/\d{2}, \d{2}:\d{2}(?:AM|PM): )<a [^>]+>([^<]+)<\/a>(?: faxed in a (?<monster>.*?))<br>/;
 const WHITELIST_DEGREE_PATTERN = /(?<name>.*?) \(°(?<degree>\d+)\)/;
 export class Clan {
-    constructor(id, name) {
-        this.id = id;
-        this.name = name;
-    }
+    id;
+    name;
     static _join(id) {
         const result = visitUrl(`showclan.php?recruiter=1&whichclan=${id}&pwd&whichclan=${id}&action=joinclan&apply=Apply+to+this+Clan&confirm=on`);
         if (!result.includes("clanhalltop.gif")) {
@@ -143,6 +142,10 @@ export class Clan {
             return new Clan(id, name);
         });
     }
+    constructor(id, name) {
+        this.id = id;
+        this.name = name;
+    }
     /**
      * Join clan
      */

package/dist/Copier.js

@@ -1,6 +1,10 @@
 export class Copier {
+    couldCopy;
+    prepare;
+    canCopy;
+    copiedMonster;
+    fightCopy = null;
     constructor(couldCopy, prepare, canCopy, copiedMonster, fightCopy) {
-        this.fightCopy = null;
         this.couldCopy = couldCopy;
         this.prepare = prepare;
         this.canCopy = canCopy;

package/dist/Kmail.js

@@ -2,18 +2,12 @@ import "core-js/modules/es.object.entries";
 import { extractItems, extractMeat, isGiftable, toInt, visitUrl, } from "kolmafia";
 import { arrayToCountedMap, chunk } from "./utils";
 export default class Kmail {
-    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.type = rawKmail.type;
-        this.senderId = Number(rawKmail.fromid);
-        this.senderName = rawKmail.fromname;
-        this.rawMessage = rawKmail.message;
-    }
+    id;
+    date;
+    type;
+    senderId;
+    senderName;
+    rawMessage;
     /**
      * Parses a kmail from KoL's native format
      *
@@ -99,6 +93,18 @@ export default class Kmail {
         const baseUrl = `town_sendgift.php?action=Yep.&pwd&fromwhere=0&note=${message}&insidenote=${insideNote}&towho=${to}`;
         return Kmail._genericSend(to, message, items, meat, 3, (m, itemsQuery, chunkSize) => `${baseUrl}&whichpackage=${chunkSize}${itemsQuery ? `&${itemsQuery}` : ""}&sendmeat=${m}`, ">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.type = rawKmail.type;
+        this.senderId = Number(rawKmail.fromid);
+        this.senderName = rawKmail.fromname;
+        this.rawMessage = rawKmail.message;
+    }
     /**
      * Delete the kmail
      *

package/dist/Path.js

@@ -1,5 +1,14 @@
 import { $classes } from "./template-string";
 export class Path {
+    name;
+    id;
+    hasAllPerms; //here, we define avatar-ness around being its own class
+    hasCampground;
+    hasTerrarium;
+    stomachSize;
+    liverSize; //Defined as the lowest inebriety that makes you unable to drink more, just to make it fifteens across the board
+    spleenSize;
+    classes;
     /**
      *
      * @param name Name of path

package/dist/combat.d.ts

@@ -10,6 +10,8 @@ declare type SkillOrName = Skill | string;
 declare type Constructor<T> = {
     new (): T;
 };
+export declare class InvalidMacroError extends Error {
+}
 /**
  * BALLS macro builder for direct submission to KoL.
  * Create a new macro with `new Macro()` and add steps using the instance methods.
@@ -84,14 +86,14 @@ export declare class Macro {
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
      */
-    if_(condition: string, ifTrue: string | Macro): this;
+    if_(condition: string | Monster | Effect | Skill | Item | Location | Class | Stat, ifTrue: string | Macro): this;
     /**
      * Create a new macro with an "if" statement.
      * @param condition The BALLS condition for the if statement.
      * @param ifTrue Continuation if the condition is true.
      * @returns {Macro} This object itself.
      */
-    static if_<T extends Macro>(this: Constructor<T>, condition: string, ifTrue: string | Macro): T;
+    static if_<T extends Macro>(this: Constructor<T>, condition: Parameters<T["if_"]>[0], ifTrue: string | Macro): T;
     /**
      * Add a "while" statement to this macro.
      * @param condition The BALLS condition for the if statement.
@@ -118,9 +120,10 @@ export declare class Macro {
      * Create a new macro with a condition evaluated at the time of building the macro.
      * @param condition The JS condition.
      * @param ifTrue Continuation to add if the condition is true.
+     * @param ifFalse Optional input to turn this into an if...else statement.
      * @returns {Macro} This object itself.
      */
-    static externalIf<T extends Macro>(this: Constructor<T>, condition: boolean, ifTrue: string | Macro): T;
+    static externalIf<T extends Macro>(this: Constructor<T>, condition: boolean, ifTrue: string | Macro, ifFalse?: string | Macro): T;
     /**
      * Add a repeat step to the macro.
      * @returns {Macro} This object itself.
@@ -197,17 +200,25 @@ export declare class Macro {
      */
     static attack<T extends Macro>(this: Constructor<T>): T;
     /**
-     * Create an if_ statement that triggers only against a particular monster
-     * @param monster The monster in question
-     * @param macro The macro to trigger when the monster is found
+     * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, unmutated.
+     * @param macro The macro to place in the if_ statement
+     */
+    ifHolidayWanderer(macro: Macro): this;
+    /**
+     * Create a new macro starting with an ifHolidayWanderer step.
+     * @param macro The macro to place inside the if_ statement
+     */
+    static ifHolidayWanderer<T extends Macro>(this: Constructor<T>, macro: Macro): T;
+    /**
+     * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, with the input macro appended.
+     * @param macro The macro to place in the if_ statement.
      */
-    ifMonster(monster: Monster, macro: Macro): Macro;
+    ifNotHolidayWanderer(macro: Macro): this;
     /**
-     * Create a new macro with an if_ statement that triggers only against a particular monster
-     * @param monster The monster in question
-     * @param macro The macro to trigger when the monster is found
+     * Create a new macro starting with an ifNotHolidayWanderer step.
+     * @param macro The macro to place inside the if_ statement
      */
-    static ifMonster(monster: Monster, macro: Macro): Macro;
+    static ifNotHolidayWanderer<T extends Macro>(this: Constructor<T>, macro: Macro): T;
 }
 /**
  * Adventure in a location and handle all combats with a given macro.

package/dist/combat.js

@@ -1,6 +1,7 @@
 import { adv1, choiceFollowsFight, getAutoAttack, inMultiFight, removeProperty, runCombat, setAutoAttack, toInt, urlEncode, visitUrl, xpath, } from "kolmafia";
 import { $items, $skills } from "./template-string";
 import { get, set } from "./property";
+import { getTodaysHolidayWanderers } from "./lib";
 const MACRO_NAME = "Script Autoattack Macro";
 /**
  * Get the KoL native ID of the macro with name Script Autoattack Macro.
@@ -58,6 +59,8 @@ function skillBallsMacroName(skillOrName) {
         ? skill.name
         : toInt(skill);
 }
+export class InvalidMacroError extends Error {
+}
 /**
  * BALLS macro builder for direct submission to KoL.
  * Create a new macro with `new Macro()` and add steps using the instance methods.
@@ -66,9 +69,10 @@ function skillBallsMacroName(skillOrName) {
  * For example, you can do `Macro.skill('Saucestorm').attack()`.
  */
 export class Macro {
-    constructor() {
-        this.components = [];
-    }
+    static SAVED_MACRO_PROPERTY = "libram_savedMacro";
+    static cachedMacroId = null;
+    static cachedAutoAttack = null;
+    components = [];
     /**
      * Convert macro to string.
      */
@@ -171,7 +175,42 @@ export class Macro {
      * @returns {Macro} This object itself.
      */
     if_(condition, ifTrue) {
-        return this.step(`if ${condition}`).step(ifTrue).step("endif");
+        let ballsCondition = "";
+        if (condition instanceof Monster) {
+            ballsCondition = `monsterid ${condition.id}`;
+        }
+        else if (condition instanceof Effect) {
+            ballsCondition = `haseffect ${toInt(condition)}`;
+        }
+        else if (condition instanceof Skill) {
+            ballsCondition = `hasskill ${skillBallsMacroName(condition)}`;
+        }
+        else if (condition instanceof Item) {
+            if (!condition.combat) {
+                throw new InvalidMacroError(`Item ${condition} cannot be made a valid BALLS predicate (it is not combat-usable)`);
+            }
+            ballsCondition = `hascombatitem ${itemOrItemsBallsMacroName(condition)}`;
+        }
+        else if (condition instanceof Location) {
+            const snarfblat = condition.id;
+            if (snarfblat < 1) {
+                throw new InvalidMacroError(`Location ${condition} cannot be made a valid BALLS predicate (it has no location id)`);
+            }
+            ballsCondition = `snarfblat ${snarfblat}`;
+        }
+        else if (condition instanceof Class) {
+            if (toInt(condition) > 6) {
+                throw new InvalidMacroError(`Class ${condition} cannot be made a valid BALLS predicate (it is not a standard class)`);
+            }
+            ballsCondition = condition.toString().replaceAll(" ", "").toLowerCase();
+        }
+        else if (condition instanceof Stat) {
+            ballsCondition = `${condition.toString().toLowerCase()}class`;
+        }
+        else {
+            ballsCondition = condition;
+        }
+        return this.step(`if ${ballsCondition}`).step(ifTrue).step("endif");
     }
     /**
      * Create a new macro with an "if" statement.
@@ -219,10 +258,11 @@ export class Macro {
      * Create a new macro with a condition evaluated at the time of building the macro.
      * @param condition The JS condition.
      * @param ifTrue Continuation to add if the condition is true.
+     * @param ifFalse Optional input to turn this into an if...else statement.
      * @returns {Macro} This object itself.
      */
-    static externalIf(condition, ifTrue) {
-        return new this().externalIf(condition, ifTrue);
+    static externalIf(condition, ifTrue, ifFalse) {
+        return new this().externalIf(condition, ifTrue, ifFalse);
     }
     /**
      * Add a repeat step to the macro.
@@ -336,25 +376,40 @@ export class Macro {
         return new this().attack();
     }
     /**
-     * Create an if_ statement that triggers only against a particular monster
-     * @param monster The monster in question
-     * @param macro The macro to trigger when the monster is found
+     * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, unmutated.
+     * @param macro The macro to place in the if_ statement
+     */
+    ifHolidayWanderer(macro) {
+        const todaysWanderers = getTodaysHolidayWanderers();
+        if (todaysWanderers.length === 0)
+            return this;
+        return this.if_(todaysWanderers.map((monster) => `monsterid ${monster.id}`).join(" || "), macro);
+    }
+    /**
+     * Create a new macro starting with an ifHolidayWanderer step.
+     * @param macro The macro to place inside the if_ statement
+     */
+    static ifHolidayWanderer(macro) {
+        return new this().ifHolidayWanderer(macro);
+    }
+    /**
+     * Create an if_ statement based on what holiday of loathing it currently is. On non-holidays, returns the original macro, with the input macro appended.
+     * @param macro The macro to place in the if_ statement.
      */
-    ifMonster(monster, macro) {
-        return this.if_(`monsterid ${monster.id}`, macro);
+    ifNotHolidayWanderer(macro) {
+        const todaysWanderers = getTodaysHolidayWanderers();
+        if (todaysWanderers.length === 0)
+            return this.step(macro);
+        return this.if_(todaysWanderers.map((monster) => `!monsterid ${monster.id}`).join(" && "), macro);
     }
     /**
-     * Create a new macro with an if_ statement that triggers only against a particular monster
-     * @param monster The monster in question
-     * @param macro The macro to trigger when the monster is found
+     * Create a new macro starting with an ifNotHolidayWanderer step.
+     * @param macro The macro to place inside the if_ statement
      */
-    static ifMonster(monster, macro) {
-        return new Macro().ifMonster(monster, macro);
+    static ifNotHolidayWanderer(macro) {
+        return new this().ifNotHolidayWanderer(macro);
     }
 }
-Macro.SAVED_MACRO_PROPERTY = "libram_savedMacro";
-Macro.cachedMacroId = null;
-Macro.cachedAutoAttack = null;
 /**
  * Adventure in a location and handle all combats with a given macro.
  * To use this function you will need to create a consult script that runs Macro.load().submit() and a CCS that calls that consult script.

package/dist/diet/index.d.ts

@@ -13,6 +13,15 @@ export declare class MenuItem {
     additionalValue?: number;
     wishEffect?: Effect;
     static defaultOptions: Map<Item, MenuItemOptions>;
+    /**
+     * Construct a new menu item, possibly with extra properties. Items in MenuItem.defaultOptions have intelligent defaults.
+     * @param item Item to add to menu.
+     * @param options.organ Designate item as belonging to a specific organ.
+     * @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.
+     */
     constructor(item: Item, options?: MenuItemOptions);
     equals(other: MenuItem): boolean;
     toString(): string;