libram 0.8.27 → 0.8.28

package/dist/template-string.d.ts

@@ -1,324 +0,0 @@
-import { Bounty, Class, Coinmaster, Effect, Element, Familiar, Item, Location, Modifier, Monster, Path, Phylum, Servant, Skill, Slot, Stat, Thrall } from "kolmafia";
-/**
- * A Bounty specified by name.
- *
- * @category In-game constant
- */
-export declare const $bounty: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Bounty;
-    none: Bounty;
-};
-/**
- * A list of Bounties specified by a comma-separated list of names.
- * For a list of all possible Bounties, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $bounties: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Bounty[];
-    all(): Bounty[];
-};
-/**
- * A Class specified by name.
- *
- * @category In-game constant
- */
-export declare const $class: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Class;
-    none: Class;
-};
-/**
- * A list of Classes specified by a comma-separated list of names.
- * For a list of all possible Classes, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $classes: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Class[];
-    all(): Class[];
-};
-/**
- * A Coinmaster specified by name.
- *
- * @category In-game constant
- */
-export declare const $coinmaster: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Coinmaster;
-    none: Coinmaster;
-};
-/**
- * A list of Coinmasters specified by a comma-separated list of names.
- * For a list of all possible Coinmasters, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $coinmasters: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Coinmaster[];
-    all(): Coinmaster[];
-};
-/**
- * An Effect specified by name.
- *
- * @category In-game constant
- */
-export declare const $effect: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Effect;
-    none: Effect;
-};
-/**
- * A list of Effects specified by a comma-separated list of names.
- * For a list of all possible Effects, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $effects: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Effect[];
-    all(): Effect[];
-};
-/**
- * An Element specified by name.
- *
- * @category In-game constant
- */
-export declare const $element: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Element;
-    none: Element;
-};
-/**
- * A list of Elements specified by a comma-separated list of names.
- * For a list of all possible Elements, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $elements: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Element[];
-    all(): Element[];
-};
-/**
- * A Familiar specified by name.
- *
- * @category In-game constant
- */
-export declare const $familiar: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Familiar;
-    none: Familiar;
-};
-/**
- * A list of Familiars specified by a comma-separated list of names.
- * For a list of all possible Familiars, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $familiars: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Familiar[];
-    all(): Familiar[];
-};
-/**
- * An Item specified by name.
- *
- * @category In-game constant
- */
-export declare const $item: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Item;
-    none: Item;
-};
-/**
- * A list of Items specified by a comma-separated list of names.
- * For a list of all possible Items, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $items: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Item[];
-    all(): Item[];
-};
-/**
- * A Location specified by name.
- *
- * @category In-game constant
- */
-export declare const $location: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Location;
-    none: Location;
-};
-/**
- * A list of Locations specified by a comma-separated list of names.
- * For a list of all possible Locations, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $locations: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Location[];
-    all(): Location[];
-};
-/**
- * A Modifier specified by name.
- *
- * @category In-game constant
- */
-export declare const $modifier: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Modifier;
-    none: Modifier;
-};
-/**
- * A list of Modifiers specified by a comma-separated list of names.
- * For a list of all possible Modifiers, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $modifiers: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Modifier[];
-    all(): Modifier[];
-};
-/**
- * A Monster specified by name.
- *
- * @category In-game constant
- */
-export declare const $monster: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Monster;
-    none: Monster;
-};
-/**
- * A list of Monsters specified by a comma-separated list of names.
- * For a list of all possible Monsters, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $monsters: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Monster[];
-    all(): Monster[];
-};
-/**
- * A Phylum specified by name.
- *
- * @category In-game constant
- */
-export declare const $phylum: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Phylum;
-    none: Phylum;
-};
-/**
- * A list of Phyla specified by a comma-separated list of names.
- * For a list of all possible Phyla, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $phyla: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Phylum[];
-    all(): Phylum[];
-};
-/**
- * A Servant specified by name.
- *
- * @category In-game constant
- */
-export declare const $servant: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Servant;
-    none: Servant;
-};
-/**
- * A list of Servants specified by a comma-separated list of names.
- * For a list of all possible Servants, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $servants: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Servant[];
-    all(): Servant[];
-};
-/**
- * A Skill specified by name.
- *
- * @category In-game constant
- */
-export declare const $skill: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Skill;
-    none: Skill;
-};
-/**
- * A list of Skills specified by a comma-separated list of names.
- * For a list of all possible Skills, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $skills: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Skill[];
-    all(): Skill[];
-};
-/**
- * A Slot specified by name.
- *
- * @category In-game constant
- */
-export declare const $slot: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Slot;
-    none: Slot;
-};
-/**
- * A list of Slots specified by a comma-separated list of names.
- * For a list of all possible Slots, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $slots: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Slot[];
-    all(): Slot[];
-};
-/**
- * A Stat specified by name.
- *
- * @category In-game constant
- */
-export declare const $stat: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Stat;
-    none: Stat;
-};
-/**
- * A list of Stats specified by a comma-separated list of names.
- * For a list of all possible Stats, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $stats: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Stat[];
-    all(): Stat[];
-};
-/**
- * A Thrall specified by name.
- *
- * @category In-game constant
- */
-export declare const $thrall: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Thrall;
-    none: Thrall;
-};
-/**
- * A list of Thralls specified by a comma-separated list of names.
- * For a list of all possible Thralls, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $thralls: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Thrall[];
-    all(): Thrall[];
-};
-/**
- * A Path specified by name.
- *
- * @category In-game constant
- */
-export declare const $path: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Path;
-    none: Path;
-};
-/**
- * A list of Paths specified by a comma-separated list of names.
- * For a list of all possible Paths, leave the template string blank.
- *
- * @category In-game constant
- */
-export declare const $paths: {
-    (literals: TemplateStringsArray, ...placeholders: string[]): Path[];
-    all(): Path[];
-};

package/dist/template-string.js

@@ -1,265 +0,0 @@
-import { abort, Bounty, Class, Coinmaster, Effect, Element, Familiar, Item, Location, Modifier, Monster, Path, Phylum, print, Servant, Skill, Slot, Stat, Thrall, } from "kolmafia";
-import { splitByCommasWithEscapes } from "./utils";
-const concatTemplateString = (literals, ...placeholders) => literals.raw.reduce((acc, literal, i) => acc + literal + (placeholders[i] ?? ""), "");
-const handleTypeGetError = (Type, error) => {
-    const message = `${error}`;
-    const match = message.match(RegExp(`Bad ${Type.name.toLowerCase()} value: .*`));
-    if (match) {
-        print(`${match[0]}; if you're certain that this ${Type.name} exists and is spelled correctly, please update KoLMafia`, "red");
-    }
-    else {
-        print(message);
-    }
-};
-const createSingleConstant = (Type) => {
-    const tagFunction = (literals, ...placeholders) => {
-        const input = concatTemplateString(literals, ...placeholders);
-        try {
-            return Type.get(input);
-        }
-        catch (error) {
-            handleTypeGetError(Type, error);
-        }
-        abort();
-    };
-    tagFunction.none = Type.none;
-    return tagFunction;
-};
-const createPluralConstant = (Type) => {
-    const tagFunction = (literals, ...placeholders) => {
-        const input = concatTemplateString(literals, ...placeholders);
-        if (input === "") {
-            return Type.all();
-        }
-        try {
-            return Type.get(splitByCommasWithEscapes(input));
-        }
-        catch (error) {
-            handleTypeGetError(Type, error);
-        }
-        abort();
-    };
-    tagFunction.all = () => Type.all();
-    return tagFunction;
-};
-/**
- * A Bounty specified by name.
- *
- * @category In-game constant
- */
-export const $bounty = createSingleConstant(Bounty);
-/**
- * A list of Bounties specified by a comma-separated list of names.
- * For a list of all possible Bounties, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $bounties = createPluralConstant(Bounty);
-/**
- * A Class specified by name.
- *
- * @category In-game constant
- */
-export const $class = createSingleConstant(Class);
-/**
- * A list of Classes specified by a comma-separated list of names.
- * For a list of all possible Classes, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $classes = createPluralConstant(Class);
-/**
- * A Coinmaster specified by name.
- *
- * @category In-game constant
- */
-export const $coinmaster = createSingleConstant(Coinmaster);
-/**
- * A list of Coinmasters specified by a comma-separated list of names.
- * For a list of all possible Coinmasters, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $coinmasters = createPluralConstant(Coinmaster);
-/**
- * An Effect specified by name.
- *
- * @category In-game constant
- */
-export const $effect = createSingleConstant(Effect);
-/**
- * A list of Effects specified by a comma-separated list of names.
- * For a list of all possible Effects, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $effects = createPluralConstant(Effect);
-/**
- * An Element specified by name.
- *
- * @category In-game constant
- */
-export const $element = createSingleConstant(Element);
-/**
- * A list of Elements specified by a comma-separated list of names.
- * For a list of all possible Elements, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $elements = createPluralConstant(Element);
-/**
- * A Familiar specified by name.
- *
- * @category In-game constant
- */
-export const $familiar = createSingleConstant(Familiar);
-/**
- * A list of Familiars specified by a comma-separated list of names.
- * For a list of all possible Familiars, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $familiars = createPluralConstant(Familiar);
-/**
- * An Item specified by name.
- *
- * @category In-game constant
- */
-export const $item = createSingleConstant(Item);
-/**
- * A list of Items specified by a comma-separated list of names.
- * For a list of all possible Items, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $items = createPluralConstant(Item);
-/**
- * A Location specified by name.
- *
- * @category In-game constant
- */
-export const $location = createSingleConstant(Location);
-/**
- * A list of Locations specified by a comma-separated list of names.
- * For a list of all possible Locations, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $locations = createPluralConstant(Location);
-/**
- * A Modifier specified by name.
- *
- * @category In-game constant
- */
-export const $modifier = createSingleConstant(Modifier);
-/**
- * A list of Modifiers specified by a comma-separated list of names.
- * For a list of all possible Modifiers, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $modifiers = createPluralConstant(Modifier);
-/**
- * A Monster specified by name.
- *
- * @category In-game constant
- */
-export const $monster = createSingleConstant(Monster);
-/**
- * A list of Monsters specified by a comma-separated list of names.
- * For a list of all possible Monsters, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $monsters = createPluralConstant(Monster);
-/**
- * A Phylum specified by name.
- *
- * @category In-game constant
- */
-export const $phylum = createSingleConstant(Phylum);
-/**
- * A list of Phyla specified by a comma-separated list of names.
- * For a list of all possible Phyla, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $phyla = createPluralConstant(Phylum);
-/**
- * A Servant specified by name.
- *
- * @category In-game constant
- */
-export const $servant = createSingleConstant(Servant);
-/**
- * A list of Servants specified by a comma-separated list of names.
- * For a list of all possible Servants, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $servants = createPluralConstant(Servant);
-/**
- * A Skill specified by name.
- *
- * @category In-game constant
- */
-export const $skill = createSingleConstant(Skill);
-/**
- * A list of Skills specified by a comma-separated list of names.
- * For a list of all possible Skills, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $skills = createPluralConstant(Skill);
-/**
- * A Slot specified by name.
- *
- * @category In-game constant
- */
-export const $slot = createSingleConstant(Slot);
-/**
- * A list of Slots specified by a comma-separated list of names.
- * For a list of all possible Slots, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $slots = createPluralConstant(Slot);
-/**
- * A Stat specified by name.
- *
- * @category In-game constant
- */
-export const $stat = createSingleConstant(Stat);
-/**
- * A list of Stats specified by a comma-separated list of names.
- * For a list of all possible Stats, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $stats = createPluralConstant(Stat);
-/**
- * A Thrall specified by name.
- *
- * @category In-game constant
- */
-export const $thrall = createSingleConstant(Thrall);
-/**
- * A list of Thralls specified by a comma-separated list of names.
- * For a list of all possible Thralls, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $thralls = createPluralConstant(Thrall);
-/**
- * A Path specified by name.
- *
- * @category In-game constant
- */
-export const $path = createSingleConstant(Path);
-/**
- * A list of Paths specified by a comma-separated list of names.
- * For a list of all possible Paths, leave the template string blank.
- *
- * @category In-game constant
- */
-export const $paths = createPluralConstant(Path);

package/dist/url.d.ts

@@ -1,35 +0,0 @@
-export declare const EMPTY_VALUE: unique symbol;
-declare type QValue = string | number | boolean | typeof EMPTY_VALUE;
-export declare type QueryList = readonly (readonly [key: string, value: QValue])[];
-export declare type QueryObject = Record<string, QValue>;
-export declare type Query = QueryList | QueryObject;
-declare type Options = {
-    method?: "GET" | "POST";
-};
-/**
- * Fetches a URL and returns the response
- * @param path Path to resource, e.g. "clan_basement.php"
- * @param query Query parameters,
- *  either as an object, e.g. { action: "cleansewer" },
- *  or as a list of [key, value] pairs, e.g. [["action", "cleansewer"]]
- * @param options Additional options
- * @param options.method HTTP method to use, either "GET" or "POST", defaults to "POST"
- * @returns the response from visiting the URL
- */
-export declare function fetchUrl(path: string, query?: Query, options?: Options): string;
-/**
- * Builds a URL from a path and query
- * @param path Path to resource, e.g. "clan_basement.php"
- * @param query Query parameters,
- *  either as an object, e.g. { action: "cleansewer" },
- *  or as a list of [key, value] pairs, e.g. [["action", "cleansewer"]]
- * @returns the constructed URL, e.g. "clan_basement.php?action=cleansewer"
- */
-export declare function buildUrl(path: string, query?: Query): string;
-/**
- * Combines a list of queries into a single query
- * @param queries a list of query objects and/or arrays, can be mixed
- * @returns a single query
- */
-export declare function combineQuery(...queries: Query[]): Query;
-export {};

package/dist/url.js

@@ -1,67 +0,0 @@
-import { visitUrl } from "kolmafia";
-export const EMPTY_VALUE = Symbol("empty");
-/**
- * Fetches a URL and returns the response
- * @param path Path to resource, e.g. "clan_basement.php"
- * @param query Query parameters,
- *  either as an object, e.g. { action: "cleansewer" },
- *  or as a list of [key, value] pairs, e.g. [["action", "cleansewer"]]
- * @param options Additional options
- * @param options.method HTTP method to use, either "GET" or "POST", defaults to "POST"
- * @returns the response from visiting the URL
- */
-export function fetchUrl(path, query = [], options = {}) {
-    const { method = "POST" } = options;
-    const url = buildUrl(path, query);
-    return visitUrl(url, method === "POST", true);
-}
-/**
- * Builds a URL from a path and query
- * @param path Path to resource, e.g. "clan_basement.php"
- * @param query Query parameters,
- *  either as an object, e.g. { action: "cleansewer" },
- *  or as a list of [key, value] pairs, e.g. [["action", "cleansewer"]]
- * @returns the constructed URL, e.g. "clan_basement.php?action=cleansewer"
- */
-export function buildUrl(path, query = []) {
-    const urlParams = Array.isArray(query) ? query : Object.entries(query);
-    if (urlParams.length === 0) {
-        return path;
-    }
-    const chunks = [path];
-    let sep = path.includes("?") ? "&" : "?";
-    for (const param of urlParams) {
-        if (param.length !== 2) {
-            throw new Error(`Query parameter array may only contain pair elements`);
-        }
-        const [key, value] = param;
-        chunks.push(sep);
-        sep = "&";
-        chunks.push(encodeURIComponent(key));
-        if (value !== EMPTY_VALUE) {
-            chunks.push("=");
-            chunks.push(encodeURIComponent(value));
-        }
-    }
-    return chunks.join("");
-}
-/**
- * Combines a list of queries into a single query
- * @param queries a list of query objects and/or arrays, can be mixed
- * @returns a single query
- */
-export function combineQuery(...queries) {
-    if (queries.length === 1) {
-        return queries[0];
-    }
-    const result = [];
-    for (const query of queries) {
-        if (Array.isArray(query)) {
-            result.push(...query);
-        }
-        else {
-            result.push(...Object.entries(query));
-        }
-    }
-    return result;
-}