libram 0.8.35 → 0.8.36

package/dist/combat.d.ts

@@ -119,7 +119,7 @@ export declare class Macro {
      * Create a new macro with an "abort" step to this macro, with a warning message to print
      *
      * @param warning The warning message to print
-     * @returns  {Macro} This object itself.
+     * @returns {Macro} This object itself.
      */
     static abortWithWarning<T extends Macro>(this: Constructor<T>, warning: string): T;
     /**
@@ -134,7 +134,12 @@ export declare class Macro {
      * @returns {Macro} This object itself.
      */
     static runaway<T extends Macro>(this: Constructor<T>): T;
-    private static makeBALLSPredicate;
+    /**
+     *
+     * @param condition The BALLS condition or a type to make a condition for (Monster, Item, Skill, etc.)
+     * @returns {string} The BALLS condition string
+     */
+    static makeBALLSPredicate(condition: PreBALLSPredicate): string;
     /**
      * Add an "if" statement to this macro.
      *
@@ -170,19 +175,19 @@ export declare class Macro {
     /**
      * Add a "while" statement to this macro.
      *
-     * @param condition The BALLS condition for the if statement.
+     * @param condition The BALLS condition for the while statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
      */
-    while_(condition: string, contents: string | Macro): this;
+    while_(condition: PreBALLSPredicate, contents: string | Macro): this;
     /**
      * Create a new macro with a "while" statement.
      *
-     * @param condition The BALLS condition for the if statement.
+     * @param condition The BALLS condition for the while statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
      */
-    static while_<T extends Macro>(this: Constructor<T>, condition: string, contents: string | Macro): T;
+    static while_<T extends Macro>(this: Constructor<T>, condition: PreBALLSPredicate, contents: string | Macro): T;
     /**
      * Conditionally add a step to a macro based on a condition evaluated at the time of building the macro.
      *
@@ -204,9 +209,10 @@ export declare class Macro {
     /**
      * Add a repeat step to the macro.
      *
+     * @param condition The BALLS condition for the repeat statement, optional.
      * @returns {Macro} This object itself.
      */
-    repeat(): this;
+    repeat(condition?: PreBALLSPredicate): this;
     /**
      * Add one or more skill cast steps to the macro.
      *

package/dist/combat.js

@@ -246,7 +246,7 @@ export class Macro {
      * Create a new macro with an "abort" step to this macro, with a warning message to print
      *
      * @param warning The warning message to print
-     * @returns  {Macro} This object itself.
+     * @returns {Macro} This object itself.
      */
     static abortWithWarning(warning) {
         return new this().abortWithWarning(warning);
@@ -267,49 +267,49 @@ export class Macro {
     static runaway() {
         return new this().runaway();
     }
+    /**
+     *
+     * @param condition The BALLS condition or a type to make a condition for (Monster, Item, Skill, etc.)
+     * @returns {string} The BALLS condition string
+     */
     static makeBALLSPredicate(condition) {
-        let ballsCondition = "";
         if (condition instanceof Monster) {
-            ballsCondition = `monsterid ${condition.id}`;
+            return `monsterid ${condition.id}`;
         }
         else if (condition instanceof Array) {
-            ballsCondition = condition
-                .map((mon) => `monsterid ${mon.id}`)
-                .join(" || ");
-            ballsCondition = `(${ballsCondition})`;
+            return `(${condition
+                .map((entry) => Macro.makeBALLSPredicate(entry))
+                .join(" || ")})`;
         }
         else if (condition instanceof Effect) {
-            ballsCondition = `haseffect ${condition.id}`;
+            return `haseffect ${condition.id}`;
         }
         else if (condition instanceof Skill) {
-            ballsCondition = `hasskill ${skillBallsMacroName(condition)}`;
+            return `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)}`;
+            return `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}`;
+            return `snarfblat ${snarfblat}`;
         }
         else if (condition instanceof Class) {
             if (condition.id > 6) {
                 throw new InvalidMacroError(`Class ${condition} cannot be made a valid BALLS predicate (it is not a standard class)`);
             }
-            ballsCondition = condition.toString().replaceAll(" ", "").toLowerCase();
+            return condition.toString().replaceAll(" ", "").toLowerCase();
         }
         else if (condition instanceof Stat) {
-            ballsCondition = `${condition.toString().toLowerCase()}class`;
+            return `${condition.toString().toLowerCase()}class`;
         }
-        else {
-            ballsCondition = condition;
-        }
-        return ballsCondition;
+        return condition;
     }
     /**
      * Add an "if" statement to this macro.
@@ -358,17 +358,19 @@ export class Macro {
     /**
      * Add a "while" statement to this macro.
      *
-     * @param condition The BALLS condition for the if statement.
+     * @param condition The BALLS condition for the while statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
      */
     while_(condition, contents) {
-        return this.step(`while ${condition}`).step(contents).step("endwhile");
+        return this.step(`while ${Macro.makeBALLSPredicate(condition)}`)
+            .step(contents)
+            .step("endwhile");
     }
     /**
      * Create a new macro with a "while" statement.
      *
-     * @param condition The BALLS condition for the if statement.
+     * @param condition The BALLS condition for the while statement.
      * @param contents Loop to repeat while the condition is true.
      * @returns {Macro} This object itself.
      */
@@ -405,10 +407,13 @@ export class Macro {
     /**
      * Add a repeat step to the macro.
      *
+     * @param condition The BALLS condition for the repeat statement, optional.
      * @returns {Macro} This object itself.
      */
-    repeat() {
-        return this.step("repeat");
+    repeat(condition) {
+        return condition === undefined
+            ? this.step("repeat")
+            : this.step(`repeat ${Macro.makeBALLSPredicate(condition)}`);
     }
     /**
      * Add one or more skill cast steps to the macro.
@@ -457,8 +462,10 @@ export class Macro {
      * @returns {Macro} This object itself.
      */
     trySkillRepeat(...skills) {
-        return this.step(...skills.map((skill) => {
-            return Macro.if_(`hasskill ${skillBallsMacroName(skill)}`, Macro.skill(skill).repeat());
+        return this.step(...skills
+            .map((skillOrName) => skillOrNameToSkill(skillOrName))
+            .map((skill) => {
+            return Macro.if_(Macro.makeBALLSPredicate(skill), Macro.skill(skill).repeat(skill));
         }));
     }
     /**

package/dist/lib.d.ts

@@ -388,16 +388,18 @@ export declare function examine(thing: Item | Familiar | Effect | Skill): string
  * Picks an option based on your primestat
  *
  * @param options An object keyed by stat; it must either contain all stats, or have a `default` parameter.
+ * @param alternateSource An optional alternate way of determining which Stat to choose by.
  * @returns The option corresponding to your primestat.
  */
-export declare const byStat: <S>(options: import("./utils").Switch<import("kolmafia").StatType, S>) => S;
+export declare const byStat: <S>(options: import("./utils").Switch<import("kolmafia").StatType, S>, alternateSource?: import("kolmafia").StatType | ((...args: never[]) => import("kolmafia").StatType) | undefined) => S;
 /**
  * Picks an option based on your player class
  *
  * @param options An object keyed by player class; it must either contain all classes, or have a `default` parameter.
+ * @param alternateSource An optional anternate way of determining which Class to choose by.
  * @returns The option corresponding to your player class.
  */
-export declare const byClass: <S>(options: import("./utils").Switch<import("kolmafia").ClassType, S>) => S;
+export declare const byClass: <S>(options: import("./utils").Switch<import("kolmafia").ClassType, S>, alternateSource?: import("kolmafia").ClassType | ((...args: never[]) => import("kolmafia").ClassType) | undefined) => S;
 /**
  * Use an item with visitUrl instead of `use`; this is sometimes useful
  *

package/dist/lib.js

@@ -771,6 +771,7 @@ export function examine(thing) {
  * Picks an option based on your primestat
  *
  * @param options An object keyed by stat; it must either contain all stats, or have a `default` parameter.
+ * @param alternateSource An optional alternate way of determining which Stat to choose by.
  * @returns The option corresponding to your primestat.
  */
 export const byStat = makeByXFunction(() => myPrimestat().toString());
@@ -778,6 +779,7 @@ export const byStat = makeByXFunction(() => myPrimestat().toString());
  * Picks an option based on your player class
  *
  * @param options An object keyed by player class; it must either contain all classes, or have a `default` parameter.
+ * @param alternateSource An optional anternate way of determining which Class to choose by.
  * @returns The option corresponding to your player class.
  */
 export const byClass = makeByXFunction(() => myClass().toString());

package/dist/resources/2023/ClosedCircuitPayphone.d.ts

@@ -68,9 +68,10 @@ export declare function rifts(): Location[];
  * Picks an option based on your current shadow rift ingress
  *
  * @param options An object keyed by shadow rift ingress; it must either contain all possible ingresses, or have a `default` parameter.
+ * @param alternateSource An optional alternate way of determining which Ingress to choose by.
  * @returns The option corresponding to your current shadow rift ingress.
  */
-export declare const byIngress: <S>(options: import("../../utils").Switch<Ingress, S>) => S;
+export declare const byIngress: <S>(options: import("../../utils").Switch<Ingress, S>, alternateSource?: Ingress | ((...args: never[]) => Ingress) | undefined) => S;
 /**
  * Submit your Rufus quest
  *

package/dist/resources/2023/ClosedCircuitPayphone.js

@@ -112,6 +112,7 @@ export function rifts() {
  * Picks an option based on your current shadow rift ingress
  *
  * @param options An object keyed by shadow rift ingress; it must either contain all possible ingresses, or have a `default` parameter.
+ * @param alternateSource An optional alternate way of determining which Ingress to choose by.
  * @returns The option corresponding to your current shadow rift ingress.
  */
 export const byIngress = makeByXFunction(currentIngress);

package/dist/utils.d.ts

@@ -156,7 +156,7 @@ export type Switch<T extends string, S> = Record<T, S> | (Partial<{
  * @param source A method for finding your stat, or class, or whatever X is in this context
  * @returns A function akin to byStat or byClass; it accepts an object that either is "complete" in the sense that it has a key for every conceivable value, or contains a `default` parameter. If an inappropriate input is provided, returns undefined.
  */
-export declare function makeByXFunction<T extends string>(source: Delayed<T>): <S>(options: Switch<T, S>) => S;
+export declare function makeByXFunction<T extends string>(source: Delayed<T>): <S>(options: Switch<T, S>, alternateSource?: Delayed<T>) => S;
 /**
  * Flattens an array. Basically replacing Array.prototype.flat for which Rhino doesn't yet have an implementation
  *

package/dist/utils.js

@@ -221,8 +221,8 @@ export function undelay(delayedObject, ...args) {
  * @returns A function akin to byStat or byClass; it accepts an object that either is "complete" in the sense that it has a key for every conceivable value, or contains a `default` parameter. If an inappropriate input is provided, returns undefined.
  */
 export function makeByXFunction(source) {
-    return function (options) {
-        const val = undelay(source);
+    return function (options, alternateSource) {
+        const val = undelay(alternateSource ?? source);
         if ("default" in options)
             return options[val] ?? options.default;
         return options[val];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libram",
-  "version": "0.8.35",
+  "version": "0.8.36",
   "description": "JavaScript helper library for KoLmafia",
   "type": "module",
   "main": "dist/index.js",