libram 0.6.5 → 0.6.8

package/dist/resources/2020/RetroCape.js

@@ -0,0 +1,111 @@
+import { cliExecute } from "kolmafia";
+import { have as haveItem } from "../../lib";
+import { get } from "../../property";
+import { $item, $skill } from "../../template-string";
+export const item = $item `unwrapped knock-off retro superhero cape`;
+/**
+ * Determines whether you have() the Retro Cape.
+ * @returns Whether you have the Retro Cape available.
+ */
+export function have() {
+    return haveItem(item);
+}
+const Heroes = {
+    vampire: {
+        "Muscle Percent": 30,
+        "Maximum HP": 50,
+    },
+    heck: {
+        "Mysticality Percent": 30,
+        "Maximum MP": 50,
+    },
+    robot: {
+        "Moxie Percent": 30,
+        "Maximum HP": 25,
+        "Maximum MP": 25,
+    },
+};
+export const currentHero = () => get("retroCapeSuperhero");
+export const currentMode = () => get("retroCapeWashingInstructions");
+const modeMap = new Map([
+    [
+        ["vampire", "hold"],
+        {
+            "Hot Resistance": 3,
+            "Cold Resistance": 3,
+            "Stench Resistance": 3,
+            "Spooky Resistance": 3,
+            "Sleaze Resistance": 3,
+        },
+    ],
+    [
+        ["vampire", "thrill"],
+        {
+            "Muscle Experience": 3,
+        },
+    ],
+    [
+        ["vampire", "kiss"],
+        {
+            Skill: $skill `Smooch of the Daywalker`,
+        },
+    ],
+    [
+        ["vampire", "kill"],
+        {
+            Skill: $skill `Slay the Dead`,
+        },
+    ],
+    [["heck", "thrill"], { "Mysticality Experience": 3 }],
+    [["heck", "kiss"], { Skill: $skill `Unleash the Devil's Kiss` }],
+    [["robot", "hold"], { Skill: $skill `Deploy Robo-Handcuffs` }],
+    [["robot", "thrill"], { "Moxie Experience": 3 }],
+    [["robot", "kiss"], { Skill: $skill `Blow a Robo-Kiss` }],
+    [["robot", "kill"], { Skill: $skill `Precision Shot` }],
+]);
+/**
+ * Tunes retro cape to a given setting
+ * @param hero The Superhero to set it to
+ * @param mode The washing instructions to set it to
+ * @returns Whether we successfully tuned the Retro Cape.
+ */
+export function set(hero, mode) {
+    if (!have())
+        return false;
+    if (currentHero() === hero && currentMode() === mode)
+        return true;
+    cliExecute(`retrocape ${hero} ${mode}`);
+    return currentHero() === hero && currentMode() === mode;
+}
+/**
+ * Returns the expected Modifiers of the Retro Cape for a particular setting
+ * @param hero The Superhero setting
+ * @param mode The washing instructions setting
+ * @returns A Modifiers object describing the Retro Cape were it to be tuned to that setting.
+ */
+export function getModifier(hero = currentHero(), mode = currentMode()) {
+    return {
+        ...Heroes[hero],
+        ...(modeMap.get([hero, mode]) ?? {}),
+    };
+}
+const skills = new Map([
+    [$skill `Smooch of the Daywalker`, ["vampire", "kiss"]],
+    [$skill `Slay the Dead`, ["vampire", "kill"]],
+    [$skill `Unleash the Devil's Kiss`, ["heck", "kiss"]],
+    [$skill `Deploy Robo-Handcuffs`, ["robot", "hold"]],
+    [$skill `Blow a Robo-Kiss`, ["robot", "kiss"]],
+    [$skill `Precision Shot`, ["robot", "kill"]],
+]);
+/**
+ * Tunes the Retro Cape to allow it to grant a particular skill.
+ * @param skill The skill to tune the Retro Cape to.
+ * @returns Whether we successfully tuned the cape.
+ */
+export function tuneToSkill(skill) {
+    const setting = skills.get(skill);
+    if (!setting || !have())
+        return false;
+    set(...setting);
+    return [currentHero(), currentMode()].every((element, index) => element === setting[index]);
+}

package/dist/resources/2022/CombatLoversLocket.d.ts

@@ -0,0 +1,36 @@
+import { Monster } from "kolmafia";
+export declare const locket: import("kolmafia").Item;
+export declare function have(): boolean;
+/**
+ * Filters the set of all unlocked locket monsters to only the ones available to be locketed right now.
+ * @returns An array consisting of all Monsters you can fight with your locket right now.
+ */
+export declare function availableLocketMonsters(): Monster[];
+/**
+ * Parses getLocketMonsters and returns the collection of all Monsters as an Array.
+ * @returns An array consisting of all Monsters you can hypothetically fight, regardless of whether they've been fought today.
+ */
+export declare function unlockedLocketMonsters(): Monster[];
+/**
+ * Determines how many reminisces remain by parsing the _locketMonstersFought property.
+ * @returns The number of reminisces a player has available; 0 if they lack the Locket.
+ */
+export declare function reminiscesLeft(): number;
+/**
+ * Determines which monsters were reminisced today by parsing the _locketMonstersFought property.
+ * @returns An array consisting of the Monsters reminisced today.
+ */
+export declare function monstersReminisced(): Monster[];
+/**
+ * Fight a Monster using the Combat Lover's Locket
+ * @param monster The Monster to fight
+ * @returns false if we are unable to reminisce about this monster. Else, returns whether, at the end of all things, we have reminisced about this monster.
+ */
+export declare function reminisce(monster: Monster): boolean;
+/**
+ * Find a reminiscable monster that meets certain criteria and optionally maximizes a valuation function.
+ * @param criteria A function for delineating which monsters are "fair game" for the search.
+ * @param value A function for deciding which monsters are "better" than others.
+ * @returns A monster that fulfills the criteria function and maximizes the value function.
+ */
+export declare function findMonster(criteria: (monster: Monster) => boolean, value?: (monster: Monster) => number): Monster | null;

package/dist/resources/2022/CombatLoversLocket.js

@@ -0,0 +1,73 @@
+import { cliExecute, getLocketMonsters, runCombat, toMonster, } from "kolmafia";
+import { have as haveItem } from "../../lib";
+import { get } from "../../property";
+import { $item } from "../../template-string";
+import { clamp } from "../../utils";
+// eslint-disable-next-line libram/verify-constants
+export const locket = $item `Combat Lover's Locket`;
+export function have() {
+    return haveItem(locket);
+}
+/**
+ * Filters the set of all unlocked locket monsters to only the ones available to be locketed right now.
+ * @returns An array consisting of all Monsters you can fight with your locket right now.
+ */
+export function availableLocketMonsters() {
+    if (reminiscesLeft() === 0)
+        return [];
+    return Object.entries(getLocketMonsters())
+        .filter(([, unused]) => unused)
+        .map(([name]) => toMonster(name));
+}
+/**
+ * Parses getLocketMonsters and returns the collection of all Monsters as an Array.
+ * @returns An array consisting of all Monsters you can hypothetically fight, regardless of whether they've been fought today.
+ */
+export function unlockedLocketMonsters() {
+    return Object.entries(getLocketMonsters()).map(([name]) => toMonster(name));
+}
+function parseLocketProperty() {
+    return get("_locketMonstersFought")
+        .split(",")
+        .filter((id) => id.trim().length > 0);
+}
+/**
+ * Determines how many reminisces remain by parsing the _locketMonstersFought property.
+ * @returns The number of reminisces a player has available; 0 if they lack the Locket.
+ */
+export function reminiscesLeft() {
+    return have() ? clamp(3 - parseLocketProperty().length, 0, 3) : 0;
+}
+/**
+ * Determines which monsters were reminisced today by parsing the _locketMonstersFought property.
+ * @returns An array consisting of the Monsters reminisced today.
+ */
+export function monstersReminisced() {
+    return parseLocketProperty().map((id) => toMonster(id));
+}
+/**
+ * Fight a Monster using the Combat Lover's Locket
+ * @param monster The Monster to fight
+ * @returns false if we are unable to reminisce about this monster. Else, returns whether, at the end of all things, we have reminisced about this monster.
+ */
+export function reminisce(monster) {
+    if (!have() || reminiscesLeft() === 0 || !getLocketMonsters()[monster.name]) {
+        return false;
+    }
+    cliExecute(`reminisce ${monster}`);
+    runCombat();
+    return monstersReminisced().includes(monster);
+}
+/**
+ * Find a reminiscable monster that meets certain criteria and optionally maximizes a valuation function.
+ * @param criteria A function for delineating which monsters are "fair game" for the search.
+ * @param value A function for deciding which monsters are "better" than others.
+ * @returns A monster that fulfills the criteria function and maximizes the value function.
+ */
+export function findMonster(criteria, value = () => 1) {
+    if (!have() || reminiscesLeft() === 0)
+        return null;
+    return (availableLocketMonsters()
+        .filter(criteria)
+        .sort((a, b) => value(b) - value(a))[0] ?? null);
+}

package/dist/resources/index.d.ts

@@ -12,6 +12,7 @@ import * as MayoClinic from "./2015/MayoClinic";
 import * as SourceTerminal from "./2016/SourceTerminal";
 import * as Witchess from "./2016/Witchess";
 import * as AsdonMartin from "./2017/AsdonMartin";
+import * as MummingTrunk from "./2017/MummingTrunk";
 import * as Pantogram from "./2017/Pantogram";
 import * as TunnelOfLove from "./2017/TunnelOfLove";
 import * as Latte from "./2018/LatteLoversMembersMug";
@@ -19,8 +20,10 @@ import * as SongBoom from "./2018/SongBoom";
 import * as BeachComb from "./2019/BeachComb";
 import * as Snapper from "./2019/Snapper";
 import * as Guzzlr from "./2020/Guzzlr";
+import * as RetroCape from "./2020/RetroCape";
 import * as CrystalBall from "./2021/CrystalBall";
 import * as DaylightShavings from "./2021/DaylightShavings";
-export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DaylightShavings, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, Pantogram, RainDoh, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
+import * as CombatLoversLocket from "./2022/CombatLoversLocket";
+export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CombatLoversLocket, CrownOfThrones, CrystalBall, DaylightShavings, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, MummingTrunk, ObtuseAngel, Pantogram, RainDoh, RetroCape, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
 export * from "./putty-likes";
 export * from "./LibramSummon";

package/dist/resources/index.js

@@ -12,6 +12,7 @@ import * as MayoClinic from "./2015/MayoClinic";
 import * as SourceTerminal from "./2016/SourceTerminal";
 import * as Witchess from "./2016/Witchess";
 import * as AsdonMartin from "./2017/AsdonMartin";
+import * as MummingTrunk from "./2017/MummingTrunk";
 import * as Pantogram from "./2017/Pantogram";
 import * as TunnelOfLove from "./2017/TunnelOfLove";
 import * as Latte from "./2018/LatteLoversMembersMug";
@@ -19,8 +20,10 @@ import * as SongBoom from "./2018/SongBoom";
 import * as BeachComb from "./2019/BeachComb";
 import * as Snapper from "./2019/Snapper";
 import * as Guzzlr from "./2020/Guzzlr";
+import * as RetroCape from "./2020/RetroCape";
 import * as CrystalBall from "./2021/CrystalBall";
 import * as DaylightShavings from "./2021/DaylightShavings";
-export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CrownOfThrones, CrystalBall, DaylightShavings, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, ObtuseAngel, Pantogram, RainDoh, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
+import * as CombatLoversLocket from "./2022/CombatLoversLocket";
+export { AsdonMartin, Bandersnatch, BeachComb, ChateauMantegna, CombatLoversLocket, CrownOfThrones, CrystalBall, DaylightShavings, DNALab, FloristFriar, Guzzlr, Latte, MayoClinic, MummingTrunk, ObtuseAngel, Pantogram, RainDoh, RetroCape, Snapper, SongBoom, SourceTerminal, SpookyPutty, StompingBoots, TunnelOfLove, WinterGarden, Witchess, };
 export * from "./putty-likes";
 export * from "./LibramSummon";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libram",
-  "version": "0.6.5",
+  "version": "0.6.8",
   "description": "JavaScript helper library for KoLmafia",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,10 @@
   "license": "MIT",
   "private": false,
   "scripts": {
-    "build": "yarn run tsc",
+    "build": "yarn run build:tsc && yarn run build:bundled",
+    "build:tsc": "tsc",
+    "build:bundled": "webpack",
+    "build:watch": "tsc --watch",
     "clean": "rm -rf dist",
     "docs": "yarn run typedoc",
     "format": "yarn run prettier --write .",
@@ -22,13 +25,12 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/compat-data": "^7.15.0",
-    "@babel/core": "^7.15.0",
+    "@babel/compat-data": "^7.17.0",
+    "@babel/core": "^7.17.2",
     "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/plugin-proposal-decorators": "^7.14.5",
+    "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.0",
+    "@babel/preset-env": "^7.16.11",
     "@babel/preset-typescript": "^7.15.0",
     "@tsconfig/node16": "^1.0.2",
     "@types/jest": "^27.0.1",
@@ -37,7 +39,7 @@
     "@types/node-fetch": "^2.5.7",
     "@typescript-eslint/eslint-plugin": "^5.5.0",
     "@typescript-eslint/parser": "^5.5.0",
-    "babel-loader": "^8.2.2",
+    "babel-loader": "^8.2.3",
     "eslint": "^7.16.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-import-resolver-typescript": "^2.5.0",
@@ -54,13 +56,13 @@
     "ts-node": "^10.4.0",
     "typedoc": "^0.22.10",
     "typescript": "^4.5.2",
-    "webpack": "^5.10.0",
-    "webpack-cli": "^4.2.0"
+    "webpack": "^5.67.0",
+    "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.14.9",
-    "core-js": "3.15.2",
-    "kolmafia": "^2.0.0",
+    "@babel/runtime-corejs3": "^7.17.2",
+    "core-js": "^3.21.0",
+    "kolmafia": "^2.1.1",
     "lodash": "^4.17.21"
   },
   "husky": {