playlist-data-engine 1.1.0

package/dist/utils/EnchantmentLibrary.d.ts

@@ -0,0 +1,378 @@
+/**
+ * Enchantment Library Class
+ *
+ * A utility class for accessing enchantments and curses that can be applied to equipment.
+ * This class provides static methods for looking up enchantments by ID, retrieving all
+ * enchantments of a specific type, and creating stat-boosting enchantments.
+ *
+ * The actual enchantment data is stored in `ENCHANTMENT_LIBRARY` in src/constants/DefaultEnchantments.ts,
+ * organized by category:
+ * - WEAPON_ENCHANTMENTS: Individual weapon enchantments (+1, flaming, frost, etc.)
+ * - ARMOR_ENCHANTMENTS: Individual armor enchantments (+1, +2)
+ * - RESISTANCE_ENCHANTMENTS: Individual resistance enchantments (fire, cold, etc.)
+ * - COMBO_ENCHANTMENTS: Special multi-effect enchantments (Holy Avenger, Dragon Slayer, etc.)
+ * - CURSES: All curses (penalties, stat curses, vulnerabilities, special curses)
+ * - ALL_ENCHANTMENTS: Flattened combination of WEAPON + ARMOR + RESISTANCE + COMBO
+ *
+ * Usage:
+ * ```typescript
+ * import { EnchantmentLibrary } from './utils/EnchantmentLibrary.js';
+ * import { ENCHANTMENT_LIBRARY } from './utils/equipmentConstants.js';
+ *
+ * // Lookup by ID (searches ALL_ENCHANTMENTS)
+ * const plusOne = EnchantmentLibrary.getEnchantment('plus_one');
+ * const curse = EnchantmentLibrary.getCurse('berserker');
+ *
+ * // Get by type
+ * const weapons = EnchantmentLibrary.getEnchantmentsByType('weapon');
+ *
+ * // Get all as arrays
+ * const allEnchantments = EnchantmentLibrary.getAllEnchantments();
+ * const allCurses = EnchantmentLibrary.getAllCurses();
+ *
+ * // Create stat-boosting enchantments
+ * const strEnchant = EnchantmentLibrary.createStrengthEnchantment(2);
+ *
+ * // Direct access (import ENCHANTMENT_LIBRARY from equipmentConstants)
+ * const direct = ENCHANTMENT_LIBRARY.WEAPON_ENCHANTMENTS.plusOne;
+ * ```
+ *
+ * @module utils/EnchantmentLibrary
+ */
+import type { EquipmentModification } from '../core/types/Equipment.js';
+/**
+ * Enchantment Library Class
+ *
+ * Provides static methods for accessing enchantments and curses from the centralized
+ * ENCHANTMENT_LIBRARY (re-exported from src/constants/DefaultEnchantments.ts).
+ */
+export declare class EnchantmentLibrary {
+    /**
+     * Private constructor to prevent instantiation.
+     * This is a utility class with only static methods.
+     *
+     * @throws {Error} Always - instantiation is not allowed
+     */
+    private constructor();
+    /**
+     * Get enchantment by ID
+     *
+     * Searches ALL_ENCHANTMENTS for an enchantment matching the given ID.
+     * The ALL_ENCHANTMENTS collection includes WEAPON, ARMOR, RESISTANCE, and COMBO enchantments.
+     *
+     * @param id - The enchantment ID to look up (e.g., 'plus_one', 'flaming', 'berserker')
+     * @returns The enchantment if found, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * const plusOne = EnchantmentLibrary.getEnchantment('plus_one');
+     * const flaming = EnchantmentLibrary.getEnchantment('flaming');
+     * const holyAvenger = EnchantmentLibrary.getEnchantment('holy_avenger');
+     * ```
+     */
+    static getEnchantment(id: string): EquipmentModification | undefined;
+    /**
+     * Get curse by ID
+     *
+     * Searches the CURSES collection for a curse matching the given ID.
+     *
+     * @param id - The curse ID to look up (e.g., 'minus_one', 'berserker', 'weakness')
+     * @returns The curse if found, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * const curse = EnchantmentLibrary.getCurse('berserker');
+     * const weakness = EnchantmentLibrary.getCurse('weakness');
+     * ```
+     */
+    static getCurse(id: string): EquipmentModification | undefined;
+    /**
+     * Get all enchantments
+     *
+     * Returns all enchantments as an array, excluding curses.
+     * Includes WEAPON, ARMOR, RESISTANCE, and COMBO enchantments.
+     *
+     * @returns Array of all enchantments
+     *
+     * @example
+     * ```typescript
+     * const allEnchantments = EnchantmentLibrary.getAllEnchantments();
+     * console.log(`Total enchantments: ${allEnchantments.length}`);
+     * ```
+     */
+    static getAllEnchantments(): EquipmentModification[];
+    /**
+     * Get all curses
+     *
+     * Returns all curses as an array.
+     *
+     * @returns Array of all curses
+     *
+     * @example
+     * ```typescript
+     * const allCurses = EnchantmentLibrary.getAllCurses();
+     * console.log(`Total curses: ${allCurses.length}`);
+     * ```
+     */
+    static getAllCurses(): EquipmentModification[];
+    /**
+     * Get enchantments by type
+     *
+     * Returns all enchantments of a specific type as an array.
+     *
+     * @param type - The type of enchantments to retrieve
+     * @returns Array of enchantments of the specified type, or empty array if type is invalid
+     *
+     * @example
+     * ```typescript
+     * const weaponEnchantments = EnchantmentLibrary.getEnchantmentsByType('weapon');
+     * const armorEnchantments = EnchantmentLibrary.getEnchantmentsByType('armor');
+     * const resistanceEnchantments = EnchantmentLibrary.getEnchantmentsByType('resistance');
+     * const comboEnchantments = EnchantmentLibrary.getEnchantmentsByType('combo');
+     * ```
+     */
+    static getEnchantmentsByType(type: 'weapon' | 'armor' | 'resistance' | 'combo'): EquipmentModification[];
+    /**
+     * Create a Strength boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Strength ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Strength boost
+     *
+     * @example
+     * ```typescript
+     * const strPlus2 = EnchantmentLibrary.createStrengthEnchantment(2);
+     * // Returns: { id: 'strength_2', name: 'Strength +2', ... }
+     * ```
+     */
+    static createStrengthEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+    /**
+     * Create a Dexterity boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Dexterity ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Dexterity boost
+     *
+     * @example
+     * ```typescript
+     * const dexPlus2 = EnchantmentLibrary.createDexterityEnchantment(2);
+     * // Returns: { id: 'dexterity_2', name: 'Dexterity +2', ... }
+     * ```
+     */
+    static createDexterityEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+    /**
+     * Create a Constitution boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Constitution ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Constitution boost
+     *
+     * @example
+     * ```typescript
+     * const conPlus2 = EnchantmentLibrary.createConstitutionEnchantment(2);
+     * // Returns: { id: 'constitution_2', name: 'Constitution +2', ... }
+     * ```
+     */
+    static createConstitutionEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+    /**
+     * Create an Intelligence boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Intelligence ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Intelligence boost
+     *
+     * @example
+     * ```typescript
+     * const intPlus2 = EnchantmentLibrary.createIntelligenceEnchantment(2);
+     * // Returns: { id: 'intelligence_2', name: 'Intelligence +2', ... }
+     * ```
+     */
+    static createIntelligenceEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+    /**
+     * Create a Wisdom boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Wisdom ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Wisdom boost
+     *
+     * @example
+     * ```typescript
+     * const wisPlus2 = EnchantmentLibrary.createWisdomEnchantment(2);
+     * // Returns: { id: 'wisdom_2', name: 'Wisdom +2', ... }
+     * ```
+     */
+    static createWisdomEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+    /**
+     * Create a Charisma boosting enchantment
+     *
+     * Creates an enchantment that adds a bonus to the Charisma ability score.
+     *
+     * @param bonus - The bonus amount (1-4)
+     * @returns A new EquipmentModification for the Charisma boost
+     *
+     * @example
+     * ```typescript
+     * const chaPlus2 = EnchantmentLibrary.createCharismaEnchantment(2);
+     * // Returns: { id: 'charisma_2', name: 'Charisma +2', ... }
+     * ```
+     */
+    static createCharismaEnchantment(bonus: 1 | 2 | 3 | 4): EquipmentModification;
+}
+/**
+ * Re-export individual enchantment collections for backward compatibility.
+ *
+ * These are re-exported from ENCHANTMENT_LIBRARY in equipmentConstants.ts.
+ * Direct import from equipmentConstants.ts is recommended for new code.
+ */
+export declare const WEAPON_ENCHANTMENTS: {
+    readonly plusOne: EquipmentModification;
+    readonly plusTwo: EquipmentModification;
+    readonly plusThree: EquipmentModification;
+    readonly flaming: EquipmentModification;
+    readonly frost: EquipmentModification;
+    readonly shocking: EquipmentModification;
+    readonly thundering: EquipmentModification;
+    readonly acidic: EquipmentModification;
+    readonly poison: EquipmentModification;
+    readonly holy: EquipmentModification;
+    readonly vampiric: EquipmentModification;
+    readonly vorpalEdge: EquipmentModification;
+    readonly keenEdge: EquipmentModification;
+    readonly mighty: EquipmentModification;
+    readonly returning: EquipmentModification;
+    readonly lifestealing: EquipmentModification;
+};
+export declare const ARMOR_ENCHANTMENTS: {
+    readonly plusOne: EquipmentModification;
+    readonly plusTwo: EquipmentModification;
+};
+export declare const RESISTANCE_ENCHANTMENTS: {
+    readonly fire: EquipmentModification;
+    readonly cold: EquipmentModification;
+    readonly lightning: EquipmentModification;
+    readonly acid: EquipmentModification;
+    readonly poison: EquipmentModification;
+    readonly necrotic: EquipmentModification;
+    readonly radiant: EquipmentModification;
+    readonly thunder: EquipmentModification;
+    readonly all: EquipmentModification;
+};
+export declare const CURSES: {
+    readonly minusOne: EquipmentModification;
+    readonly minusTwo: EquipmentModification;
+    readonly weakness: EquipmentModification;
+    readonly feeblemind: EquipmentModification;
+    readonly clumsiness: EquipmentModification;
+    readonly frailty: EquipmentModification;
+    readonly foolishness: EquipmentModification;
+    readonly repulsiveness: EquipmentModification;
+    readonly fireVulnerability: EquipmentModification;
+    readonly coldVulnerability: EquipmentModification;
+    readonly lifesteal: EquipmentModification;
+    readonly attunement: EquipmentModification;
+    readonly berserker: EquipmentModification;
+    readonly heavyBurden: EquipmentModification;
+    readonly lightSensitivity: EquipmentModification;
+    readonly invisibility: EquipmentModification;
+    readonly hallucinations: EquipmentModification;
+    readonly bloodMoney: EquipmentModification;
+};
+export declare const ALL_ENCHANTMENTS: Record<string, EquipmentModification>;
+/**
+ * Re-export utility functions as standalone functions for backward compatibility.
+ *
+ * New code should use the class methods: `EnchantmentLibrary.getEnchantment(...)`
+ * Legacy code can continue using: `getEnchantment(...)`
+ */
+export declare const getEnchantment: (id: string) => EquipmentModification | undefined;
+export declare const getCurse: (id: string) => EquipmentModification | undefined;
+export declare const getAllEnchantments: () => EquipmentModification[];
+export declare const getAllCurses: () => EquipmentModification[];
+export declare const getEnchantmentsByType: (type: "weapon" | "armor" | "resistance" | "combo") => EquipmentModification[];
+/**
+ * Re-export stat boosting factory functions for backward compatibility.
+ *
+ * New code should use the class methods: `EnchantmentLibrary.createStrengthEnchantment(...)`
+ * Legacy code can continue using: `createStrengthEnchantment(...)`
+ */
+export declare const createStrengthEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+export declare const createDexterityEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+export declare const createConstitutionEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+export declare const createIntelligenceEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+export declare const createWisdomEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+export declare const createCharismaEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+declare const _default: {
+    EnchantmentLibrary: typeof EnchantmentLibrary;
+    WEAPON_ENCHANTMENTS: {
+        readonly plusOne: EquipmentModification;
+        readonly plusTwo: EquipmentModification;
+        readonly plusThree: EquipmentModification;
+        readonly flaming: EquipmentModification;
+        readonly frost: EquipmentModification;
+        readonly shocking: EquipmentModification;
+        readonly thundering: EquipmentModification;
+        readonly acidic: EquipmentModification;
+        readonly poison: EquipmentModification;
+        readonly holy: EquipmentModification;
+        readonly vampiric: EquipmentModification;
+        readonly vorpalEdge: EquipmentModification;
+        readonly keenEdge: EquipmentModification;
+        readonly mighty: EquipmentModification;
+        readonly returning: EquipmentModification;
+        readonly lifestealing: EquipmentModification;
+    };
+    ARMOR_ENCHANTMENTS: {
+        readonly plusOne: EquipmentModification;
+        readonly plusTwo: EquipmentModification;
+    };
+    RESISTANCE_ENCHANTMENTS: {
+        readonly fire: EquipmentModification;
+        readonly cold: EquipmentModification;
+        readonly lightning: EquipmentModification;
+        readonly acid: EquipmentModification;
+        readonly poison: EquipmentModification;
+        readonly necrotic: EquipmentModification;
+        readonly radiant: EquipmentModification;
+        readonly thunder: EquipmentModification;
+        readonly all: EquipmentModification;
+    };
+    CURSES: {
+        readonly minusOne: EquipmentModification;
+        readonly minusTwo: EquipmentModification;
+        readonly weakness: EquipmentModification;
+        readonly feeblemind: EquipmentModification;
+        readonly clumsiness: EquipmentModification;
+        readonly frailty: EquipmentModification;
+        readonly foolishness: EquipmentModification;
+        readonly repulsiveness: EquipmentModification;
+        readonly fireVulnerability: EquipmentModification;
+        readonly coldVulnerability: EquipmentModification;
+        readonly lifesteal: EquipmentModification;
+        readonly attunement: EquipmentModification;
+        readonly berserker: EquipmentModification;
+        readonly heavyBurden: EquipmentModification;
+        readonly lightSensitivity: EquipmentModification;
+        readonly invisibility: EquipmentModification;
+        readonly hallucinations: EquipmentModification;
+        readonly bloodMoney: EquipmentModification;
+    };
+    ALL_ENCHANTMENTS: Record<string, EquipmentModification>;
+    getEnchantment: (id: string) => EquipmentModification | undefined;
+    getCurse: (id: string) => EquipmentModification | undefined;
+    getAllEnchantments: () => EquipmentModification[];
+    getAllCurses: () => EquipmentModification[];
+    getEnchantmentsByType: (type: "weapon" | "armor" | "resistance" | "combo") => EquipmentModification[];
+    createStrengthEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+    createDexterityEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+    createConstitutionEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+    createIntelligenceEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+    createWisdomEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+    createCharismaEnchantment: (bonus: 1 | 2 | 3 | 4) => EquipmentModification;
+};
+export default _default;
+//# sourceMappingURL=EnchantmentLibrary.d.ts.map

package/dist/utils/EnchantmentLibrary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnchantmentLibrary.d.ts","sourceRoot":"","sources":["../../src/utils/EnchantmentLibrary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGxE;;;;;GAKG;AACH,qBAAa,kBAAkB;IAK3B;;;;;OAKG;IACH,OAAO;IAQP;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAIpE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ9D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,kBAAkB,IAAI,qBAAqB,EAAE;IAIpD;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,YAAY,IAAI,qBAAqB,EAAE;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,GAAG,qBAAqB,EAAE;IAmBxG;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;IAkB7E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,0BAA0B,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;IAkB9E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;IAkBjF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;IAkBjF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;IAkB3E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,qBAAqB;CAiBhF;AAMD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;CAA0C,CAAC;AAC3E,eAAO,MAAM,kBAAkB;;;CAAyC,CAAC;AACzE,eAAO,MAAM,uBAAuB;;;;;;;;;;CAA8C,CAAC;AACnF,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;CAA6B,CAAC;AACjD,eAAO,MAAM,gBAAgB,uCAAuC,CAAC;AAErE;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,IAAI,MAAM,sCAA0C,CAAC;AACpF,eAAO,MAAM,QAAQ,GAAI,IAAI,MAAM,sCAAoC,CAAC;AACxE,eAAO,MAAM,kBAAkB,+BAAgD,CAAC;AAChF,eAAO,MAAM,YAAY,+BAA0C,CAAC;AACpE,eAAO,MAAM,qBAAqB,GAAI,MAAM,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,4BACrC,CAAC;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;AACxD,eAAO,MAAM,0BAA0B,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;AACzD,eAAO,MAAM,6BAA6B,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;AAC5D,eAAO,MAAM,6BAA6B,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;AAC5D,eAAO,MAAM,uBAAuB,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;AACtD,eAAO,MAAM,yBAAyB,GAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,0BACP,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAxBrB,MAAM;mBACZ,MAAM;;;kCAGS,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO;uCAStC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;wCAEZ,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;2CAEV,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;2CAEb,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;qCAEnB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;uCAEX,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;;AAG9D,wBAkBE"}