add stock option(s)

README.md

@@ -57,6 +57,8 @@ All options are supported in all tabs, unless specified. They are white space se
 
 * `keepN`
   * Keeps `N` copies of the item after running
+* `stockN`
+  * (only supported by `mall`, `display`, and `closet`). Ensures `N` copies of the item are stocked in the relevant locations, keeps the rest in your inventory
 * `<N`
   * Only performs the given operation on items that have a `mallPrice` that is less than `N`
 * `>N`

src/actions.ts

@@ -2,13 +2,16 @@ import {
   autosell,
   autosellPrice,
   cliExecute,
+  closetAmount,
+  displayAmount,
   Item,
   itemAmount,
   mallPrice,
   print,
   putCloset,
   putDisplay,
   putShop,
+  shopAmount,
   use,
   wellStocked,
 } from "kolmafia";
@@ -41,6 +44,17 @@ export const actions: {
   };
 } = {
   mall: (options: Options) => {
+    if (options.stock) {
+      return {
+        action: (item: Item) =>
+          putShop(
+            0,
+            0,
+            Math.min(Math.max(0, (options.stock ?? 0) - shopAmount(item)), amount(item, options)),
+            item
+          ),
+      };
+    }
     return { action: (item: Item) => putShop(0, 0, amount(item, options), item) };
   },
   sell: (options: Options) => {
@@ -55,6 +69,18 @@ export const actions: {
     };
   },
   display: (options: Options) => {
+    if (options.stock) {
+      return {
+        action: (item: Item) =>
+          putDisplay(
+            Math.min(
+              Math.max(0, (options.stock ?? 0) - displayAmount(item)),
+              amount(item, options)
+            ),
+            item
+          ),
+      };
+    }
     return { action: (item: Item) => putDisplay(amount(item, options), item) };
   },
   use: (options: Options) => {
@@ -79,6 +105,15 @@ export const actions: {
     };
   },
   closet: (options: Options) => {
+    if (options.stock) {
+      return {
+        action: (item: Item) =>
+          putDisplay(
+            Math.min(Math.max(0, (options.stock ?? 0) - closetAmount(item)), amount(item, options)),
+            item
+          ),
+      };
+    }
     return {
       action: (item: Item) => putCloset(amount(item, options), item),
     };

src/options.ts

@@ -2,6 +2,7 @@ import { Item } from "kolmafia";
 
 export class Options {
   keep?: number;
+  stock?: number;
   target?: string;
   body?: string;
   priceUpperThreshold?: number;
@@ -18,6 +19,11 @@ export class Options {
         options.keep = parseInt(keep[1]);
         continue;
       }
+      const stock = optionStr.match(/stock(\d+)/);
+      if (stock && stock[1]) {
+        options.stock = parseInt(stock[1]);
+        continue;
+      }
       const target = optionStr.match(/#(.*)/);
       if (target && target[1]) {
         options.target = target[1];
@@ -50,6 +56,9 @@ export class Options {
     if (this.keep) {
       optionsStr.push(`keep: ${this.keep}`);
     }
+    if (this.stock) {
+      optionsStr.push(`stock: ${this.stock}`);
+    }
     if (this.target) {
       optionsStr.push(`target: ${this.target}`);
     }

src/types.ts

@@ -18,7 +18,7 @@ export function isTabTitle(value: string): value is TabTitle {
   return ALL_TAB_TITLES.includes(value as TabTitle);
 }
 
-const ALL_ACTION_OPTIONS = ["keep", "target"] as const;
+const ALL_ACTION_OPTIONS = ["keep", "stock", "target"] as const;
 export type ActionOption = typeof ALL_ACTION_OPTIONS[number];
 
 export function isActionOption(value: string): value is ActionOption {