libram 0.6.6 → 0.6.9

package/dist/Clan.d.ts

@@ -4,10 +4,6 @@ export interface Rank {
     degree: number;
     id: number;
 }
-export declare class ClanError extends Error {
-    reason?: Error;
-    constructor(message: string, reason?: Error);
-}
 export declare class Clan {
     readonly id: number;
     readonly name: string;
@@ -43,6 +39,7 @@ export declare class Clan {
      */
     static getWhitelisted(): Clan[];
     private constructor();
+    private _check;
     /**
      * Join clan
      */

package/dist/Clan.js

@@ -1,39 +1,7 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
 import { availableAmount, cliExecute, getClanId, getClanName, getPlayerId, Monster, putStash, refreshStash, retrieveItem, stashAmount, takeStash, visitUrl, xpath, } from "kolmafia";
 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;
-        Object.setPrototypeOf(this, ClanError.prototype);
-    }
-}
-// It would be fantastic to have this function properly typed
-// But until someone can work out how to do it, it gets the
-// comment blocks of shame
-/* eslint-disable */
-function validate(target, propertyName, descriptor) {
-    if (!descriptor?.value)
-        return;
-    const method = descriptor.value;
-    // @ts-ignore
-    descriptor.value = function (...args) {
-        // @ts-ignore
-        if (this.id !== getClanId()) {
-            throw new Error("You are no longer a member of this clan");
-        }
-        return method.apply(this, args);
-    };
-}
-/* eslint-enable */
 const clanIdCache = {};
 const toPlayerId = (player) => typeof player === "string" ? getPlayerId(player) : player;
 const LOG_FAX_PATTERN = /(\d{2}\/\d{2}\/\d{2}, \d{2}:\d{2}(?:AM|PM): )<a [^>]+>([^<]+)<\/a>(?: faxed in a (?<monster>.*?))<br>/;
@@ -146,11 +114,16 @@ export class Clan {
         this.id = id;
         this.name = name;
     }
+    _check() {
+        if (this.id !== getClanId()) {
+            throw new Error("You are no longer a member of this clan");
+        }
+    }
     /**
      * Join clan
      */
     join() {
-        return Clan._join(this.id);
+        return Clan.join(this.id);
     }
     check() {
         return visitUrl("clan_hall.php").includes(`<b>${this.name}</b>`);
@@ -159,6 +132,7 @@ export class Clan {
      * Return the monster that is currently in the current clan's fax machine if any
      */
     getCurrentFax() {
+        this._check();
         const logs = visitUrl("clan_log.php");
         const lastFax = logs.match(LOG_FAX_PATTERN);
         if (!lastFax)
@@ -172,6 +146,7 @@ export class Clan {
      * List available ranks (name, degree and id) from the current clan
      */
     getRanks() {
+        this._check();
         const page = visitUrl("clan_whitelist.php");
         return xpath(page, '//select[@name="level"]//option')
             .map((option) => {
@@ -197,6 +172,7 @@ export class Clan {
      * @param title Title to give the player. If not provided, will be blank
      */
     addPlayerToWhitelist(player, rankName, title = "") {
+        this._check();
         const playerId = toPlayerId(player);
         const ranks = this.getRanks();
         const rank = rankName
@@ -213,6 +189,7 @@ export class Clan {
      * @param player Player id or name
      */
     removePlayerFromWhitelist(player) {
+        this._check();
         const playerId = toPlayerId(player);
         const result = visitUrl(`clan_whitelist.php?action=updatewl&pwd&who=${playerId}&remove=Remove`);
         return result.includes("Whitelist updated.");
@@ -221,6 +198,7 @@ export class Clan {
      * Return the amount of meat in the current clan's coffer.
      */
     getMeatInCoffer() {
+        this._check();
         const page = visitUrl("clan_stash.php");
         const [, meat] = page.match(/Your <b>Clan Coffer<\/b> contains ([\d,]+) Meat./) || ["0", "0"];
         return parseNumber(meat);
@@ -230,10 +208,12 @@ export class Clan {
      * @param amount Amount of meat to put in coffer
      */
     putMeatInCoffer(amount) {
+        this._check();
         const result = visitUrl(`clan_stash.php?pwd&action=contribute&howmuch=${amount}`);
         return result.includes("You contributed");
     }
     take(items) {
+        this._check();
         const map = arrayToCountedMap(items);
         map.forEach((quantity, item) => {
             let needed = Math.max(0, quantity - availableAmount(item));
@@ -271,6 +251,7 @@ export class Clan {
         return Array.isArray(items) ? countedMapToArray(map) : map;
     }
     put(items) {
+        this._check();
         const map = arrayToCountedMap(items);
         if (!this.check())
             throw new Error(`Wanted to return ${countedMapToString(map)} to ${this.name} but KoLmafia's clan data is out of sync`);
@@ -284,34 +265,8 @@ export class Clan {
     }
     withStash(items, callback // eslint-disable-line @typescript-eslint/no-explicit-any
     ) {
+        this._check();
         const map = arrayToCountedMap(items);
         return Clan._withStash(() => this.take(map), (borrowed) => this.put(borrowed), callback);
     }
 }
-__decorate([
-    validate
-], Clan.prototype, "getCurrentFax", null);
-__decorate([
-    validate
-], Clan.prototype, "getRanks", null);
-__decorate([
-    validate
-], Clan.prototype, "addPlayerToWhitelist", null);
-__decorate([
-    validate
-], Clan.prototype, "removePlayerFromWhitelist", null);
-__decorate([
-    validate
-], Clan.prototype, "getMeatInCoffer", null);
-__decorate([
-    validate
-], Clan.prototype, "putMeatInCoffer", null);
-__decorate([
-    validate
-], Clan.prototype, "take", null);
-__decorate([
-    validate
-], Clan.prototype, "put", null);
-__decorate([
-    validate
-], Clan.prototype, "withStash", null);

package/dist/Kmail.js

@@ -40,9 +40,7 @@ export default class Kmail {
     }
     static _genericSend(to, message, items, meat, chunkSize, constructUrl, successString) {
         let m = meat;
-        const sendableItems = [
-            ...arrayToCountedMap(items).entries(),
-        ].filter(([item]) => isGiftable(item));
+        const sendableItems = [...arrayToCountedMap(items).entries()].filter(([item]) => isGiftable(item));
         let result = true;
         const chunks = chunk(sendableItems, chunkSize);
         // Split the items to be sent into chunks of max 11 item types

package/dist/Path.d.ts

@@ -65,4 +65,5 @@ export declare const Paths: {
     readonly YouRobot: Path;
     readonly QuantumTerrarium: Path;
     readonly Wildfire: Path;
+    readonly GreyYou: Path;
 };

package/dist/Path.js

@@ -75,4 +75,6 @@ export const Paths = {
     YouRobot: new Path("You, Robot", 41, false, false, true, 0, 0, 0),
     QuantumTerrarium: new Path("Quantum Terrarium", 42, true, true, false),
     Wildfire: new Path("Wildfire", 43),
+    GreyYou: new Path("Grey You", 44, false, true, true, 0, 0, 0, // eslint-disable-next-line libram/verify-constants
+    $classes `Grey Goo`),
 };

package/dist/ascend.d.ts

@@ -28,10 +28,10 @@ declare type Eudora = typeof eudorae[number];
  * Sets up various iotms you may want to use in the coming ascension
  * @param ascensionItems.workshed Workshed to switch to.
  * @param ascensionItems.garden Garden to switch to.
- * @param ascensionItems An object potentially containing your workshed, garden, and eudora, all as items
+ * @param ascensionItems An object potentially containing your workshed, garden, chateau, and eudora, all as strings
  * @param throwOnFail If true, this will throw an error when it fails to switch something
  */
-export declare function prepareAscension({ workshed, garden, eudora, chateau, }?: {
+export declare function prepareAscension({ workshed, garden, eudora, chateau, throwOnFail, }?: {
     workshed?: Workshed;
     garden?: Garden;
     eudora?: Eudora;
@@ -40,5 +40,6 @@ export declare function prepareAscension({ workshed, garden, eudora, chateau, }?
         ceiling?: Ceiling;
         nightstand?: Nightstand;
     };
+    throwOnFail?: boolean;
 }): void;
 export {};

package/dist/ascend.js

@@ -1,4 +1,4 @@
-import { containsText, eudoraItem, getCampground, getWorkshed, Item, toInt, toItem, use, visitUrl, xpath, } from "kolmafia";
+import { containsText, eudoraItem, getCampground, getWorkshed, Item, toInt, use, visitUrl, xpath, } from "kolmafia";
 import { ChateauMantegna } from "./resources";
 import { $item, $items, $stat } from "./template-string";
 export var Lifestyle;
@@ -135,45 +135,51 @@ const eudorae = [
  * Sets up various iotms you may want to use in the coming ascension
  * @param ascensionItems.workshed Workshed to switch to.
  * @param ascensionItems.garden Garden to switch to.
- * @param ascensionItems An object potentially containing your workshed, garden, and eudora, all as items
+ * @param ascensionItems An object potentially containing your workshed, garden, chateau, and eudora, all as strings
  * @param throwOnFail If true, this will throw an error when it fails to switch something
  */
-export function prepareAscension({ workshed, garden, eudora, chateau, } = {}) {
-    if (workshed && getWorkshed() !== toItem(workshed)) {
+export function prepareAscension({ workshed, garden, eudora, chateau, throwOnFail, } = {}) {
+    throwOnFail = throwOnFail ?? true;
+    if (workshed && getWorkshed() !== Item.get(workshed)) {
         use(Item.get(workshed));
+        if (getWorkshed().name !== workshed && throwOnFail) {
+            throw new Error(`Failed to switch workshed to ${workshed}; it is currently still ${getWorkshed()}.`);
+        }
     }
     if (garden && !Object.getOwnPropertyNames(getCampground()).includes(garden)) {
         use(Item.get(garden));
-        if (!Object.getOwnPropertyNames(getCampground()).includes(garden)) {
+        if (!Object.getOwnPropertyNames(getCampground()).includes(garden) &&
+            throwOnFail) {
             throw new Error(`We really thought we changed your garden to a ${garden}, but Mafia is saying otherwise.`);
         }
     }
     if (eudora && eudoraItem().name !== eudora) {
         const eudoraNumber = 1 + eudorae.indexOf(eudora);
-        if (!xpath(visitUrl("account.php?tab=correspondence"), `//select[@name="whichpenpal"]/option/@value`).includes(eudoraNumber.toString())) {
+        if (!xpath(visitUrl("account.php?tab=correspondence"), `//select[@name="whichpenpal"]/option/@value`).includes(eudoraNumber.toString()) &&
+            throwOnFail) {
             throw new Error(`I'm sorry buddy, but you don't seem to be subscribed to ${eudora}. Which makes it REALLY hard to correspond with them.`);
         }
         else {
             visitUrl(`account.php?actions[]=whichpenpal&whichpenpal=${eudoraNumber}&action=Update`, true);
         }
-        if (eudoraItem() !== toItem(eudora)) {
+        if (eudoraItem() !== Item.get(eudora) && throwOnFail) {
             throw new Error(`We really thought we changed your eudora to a ${eudora}, but Mafia is saying otherwise.`);
         }
     }
     if (chateau && ChateauMantegna.have()) {
         const { desk, ceiling, nightstand } = chateau;
         if (ceiling && ChateauMantegna.getCeiling() !== ceiling) {
-            if (!ChateauMantegna.changeCeiling(ceiling)) {
+            if (!ChateauMantegna.changeCeiling(ceiling) && throwOnFail) {
                 throw new Error(`We tried, but were unable to change your chateau ceiling to ${ceiling}. Probably.`);
             }
         }
         if (desk && ChateauMantegna.getDesk() !== desk) {
-            if (!ChateauMantegna.changeDesk(desk)) {
+            if (!ChateauMantegna.changeDesk(desk) && throwOnFail) {
                 throw new Error(`We tried, but were unable to change your chateau desk to ${desk}. Probably.`);
             }
         }
         if (nightstand && ChateauMantegna.getNightstand() !== nightstand) {
-            if (!ChateauMantegna.changeNightstand(nightstand)) {
+            if (!ChateauMantegna.changeNightstand(nightstand) && throwOnFail) {
                 throw new Error(`We tried, but were unable to change your chateau nightstand to ${nightstand}. Probably.`);
             }
         }

package/dist/challengePaths/2015/CommunityService.d.ts

@@ -1,31 +1,27 @@
 import { Requirement } from "../../maximize";
-/**
- * A log of the predicted turns, actual turns, and duration of each CS test performed.
- */
-export declare const log: {
-    [index: string]: {
-        predictedTurns: number;
-        turnCost: number;
-        seconds: number;
-    };
-};
-declare class Test {
+export default class CommunityService {
     private choice;
+    private stat;
     private property;
     private predictor;
     private maximizeRequirements;
     /**
      * Class to store properties of various CS tests.
      * @param id The id the game HTML uses to identify the test; this is used primarily in runChoice.
+     * @param stat The principle stat the test measures, often used as more easily memorable shorthand for the specific tests
      * @param property The name of the test as a string, often used as part of the string property "csServicesPerformed".
      * @param predictor A function that returns an estimate for the number of turns that the test will take given your character's current state.
      * @param maximizeRequirements A Requirement object, if applicable, that aligns with the things needed to maximize for this particular test.
      */
-    constructor(id: number, property: string, predictor: () => number, maximizeRequirements?: Requirement | null);
+    private constructor();
     /**
      * @returns The id number of the test, used primarily in runChoice.
      */
     get id(): number;
+    /**
+     * @returns The primary stat the test measures, used primarily as memorable shorthand in place of test names.
+     */
+    get statName(): string;
     /**
      * @returns The name of the test, used primarily as part of the string property "csServicesPerformed"
      */
@@ -38,6 +34,7 @@ declare class Test {
      * @returns A Requirement object, if applicable, that aligns with the things needed to maximize for this particular test.
      */
     get requirement(): Requirement | null;
+    static logTask(name: string, action: () => number | void): void;
     /**
      * Checks the "csServicesPerformed" property to see whether mafia currently believes this test is complete.
      * @returns Whether mafia currently believes this test is complete.
@@ -54,33 +51,50 @@ declare class Test {
     do(): boolean;
     /**
      * Wrapper function that prepares for a test and then completes it, adding time and turn details to the log.
-     * @param prepare A function that does all necessary preparations for this CS test, including choosing your outfit.
-     * @param beCertain Whether we should check council.php instead of mafia to determine whether the test is complete.
-     * @param maxTurns We will run the test iff the predicted turns is less than or equal to this parameter.
-     * @returns The output of the prepare function given, or null if the test is already complete.
+     * @param prepare A function that does all necessary preparations for this CS test, including choosing your outfit. Optionally returns the number of turns you expect to spend preparing for the test.
+     * @param beCertain Whether we should check council.php instead of mafia to determine the test cost and whether the test is complete.
+     * @param maxTurns We will run the test iff the predicted/actual turns is less than or equal to this parameter.
+     * @returns "completed", "failed", or "already completed".
      */
-    run(prepare: () => void, beCertain?: boolean, maxTurns?: number): boolean;
+    run(prepare: () => void | number, maxTurns?: number): "completed" | "failed" | "already completed";
+    private _verifyIsDone;
     /**
      * Checks council.php to verify that a test is complete; more reliable than isDone, but requires an additional pagehit.
      * @returns Whether council.php suggests that the test is complete.
      */
     verifyIsDone(): boolean;
+    private _actualCost;
+    /**
+     * Checks council.php for the number of turns this test will take; more reliable than prediction, but requires an additional pagehit.
+     * @returns The number of turns to complete this test according to council.php.
+     */
+    actualCost(): number;
+    /**
+     * A log of the predicted turns, actual turns, and duration of each CS test performed.
+     */
+    static log: {
+        [index: string]: {
+            predictedTurns: number;
+            turnCost: number;
+            seconds: number;
+            type: "test" | "task";
+        };
+    };
+    /**
+     * Prints turncount and time details of the test in question.
+     * @param colour The colour (or color) you'd like the log to be printed in.
+     */
+    static printLog(colour?: string): void;
+    static HP: CommunityService;
+    static Muscle: CommunityService;
+    static Mysticality: CommunityService;
+    static Moxie: CommunityService;
+    static FamiliarWeight: CommunityService;
+    static WeaponDamage: CommunityService;
+    static SpellDamage: CommunityService;
+    static Noncombat: CommunityService;
+    static BoozeDrop: CommunityService;
+    static HotRes: CommunityService;
+    static CoilWire: CommunityService;
+    static donate: () => void;
 }
-export declare const HP: Test;
-export declare const Muscle: Test;
-export declare const Mysticality: Test;
-export declare const Moxie: Test;
-export declare const FamiliarWeight: Test;
-export declare const WeaponDamage: Test;
-export declare const SpellDamage: Test;
-export declare const Noncombat: Test;
-export declare const BoozeDrop: Test;
-export declare const HotRes: Test;
-export declare const CoilWire: Test;
-/**
- * Prints turncount and time details of the test in question.
- * @param colour The colour (or color) you'd like the log to be printed in.
- */
-export declare function printLog(colour?: string): void;
-export declare const donate: () => void;
-export {};