lol-constants 2.25.0 → 3.0.0-rc.0

package/dist/lol.js

@@ -0,0 +1,182 @@
+import { Patch } from './Patch';
+import { ChampionClasses, isChampionClass } from './constants/custom';
+import { BuildingTypes, DragonTypes, isBuildingType, isDragonType, isKillType, isMonsterType, isTowerType, isWardType, KillTypes, MonsterTypes, TowerTypes, WardTypes, } from './constants/events';
+import { GameModes, GameTypes, isGameMode, isGameType, isQueueType, QueueTypes, } from './constants/history';
+import { isRankedRank, isRankedTier, RankedRanks, RankedTiers } from './constants/leagues';
+import { isLocale, Locales } from './constants/locales';
+import { isLane, isLaneType, isPosition, isRole, isTeamId, Lanes, LaneTypes, Positions, Roles, TeamIds, } from './constants/participants';
+import { ItemSrTypes } from './enums/ItemSrTypes';
+import { StatRuneSlots } from './enums/StatRuneSlots';
+import { getChampion, isChampionId, isChampionKey, isChampionName, } from './helpers/champion';
+import { getItem, isBasicItem, isBootsItem, isConsumableItem, isEpicItem, isItemAvailableForMap, isItemId, isItemName, isLegendaryItem, isStarterItem, isTrinketItem, } from './helpers/item';
+import { makeRiotId, splitRiotId, validateRiotId } from './helpers/riotId';
+import { getRune, getRuneTree, getStatRune, isRuneId, isRuneKey, isRuneName, isRuneTreeId, isRuneTreeKey, isRuneTreeName, isStatRuneId, isStatRuneName, } from './helpers/rune';
+import { getSpell, isSpellId, isSpellKey, isSpellName, } from './helpers/spell';
+import { getMap, isMapId, isMapTitle, MapsArr } from './objects/Maps';
+import { getQueue, isQueueId, isQueueTitle, QueuesArr, } from './objects/Queues';
+import { getRegion, isPlatform, isRegion, RegionsArr, } from './objects/Regions';
+import { ChampionsArr } from './objects/generated/Champions';
+import { ItemsArr } from './objects/generated/Items';
+import { RunesArr, RuneTreesArr, StatRunesArr } from './objects/generated/Runes';
+import { SpellsArr } from './objects/generated/Spells';
+export const lol = {
+    /**
+     * ## Current patch version
+     * What patch the library is currently on. *(read-only)*
+     */
+    version: Patch.version,
+    /**
+     * ## Constants
+     * Riot API defined constants.
+     */
+    const: {
+        ChampionClasses,
+        MonsterTypes,
+        DragonTypes,
+        KillTypes,
+        BuildingTypes,
+        TowerTypes,
+        WardTypes,
+        QueueTypes,
+        GameModes,
+        GameTypes,
+        RankedTiers,
+        RankedRanks,
+        Locales,
+        Positions,
+        Roles,
+        Lanes,
+        LaneTypes,
+        TeamIds,
+    },
+    /**
+     * ## Enums
+     * Library specific enums.
+     */
+    enum: {
+        /**
+         * ### Item (Summoner's Rift) Types
+         * Enumerates `lol-constants`-specific item category types,
+         * tailored for Summoner's Rift.
+         */
+        ItemSrTypes: ItemSrTypes,
+        /**
+         * ### Stat Rune Slots
+         * Enumerates the three types of stat runes.
+         * Generally, should be used together with `lol.rune.stat.get`/`getStatRune`.
+         */
+        StatRuneSlots: StatRuneSlots,
+    },
+    /** ## Champions */
+    champion: {
+        /** Array of champion objects, containing information about all champions. */
+        list: ChampionsArr,
+        get: getChampion,
+    },
+    /** ## Items */
+    item: {
+        /** Array of item objects, containing information about all items. */
+        list: ItemsArr,
+        get: getItem,
+        isStarter: isStarterItem,
+        isBasic: isBasicItem,
+        isEpic: isEpicItem,
+        isLegendary: isLegendaryItem,
+        isTrinket: isTrinketItem,
+        isBoots: isBootsItem,
+        isConsumable: isConsumableItem,
+        isAvailable: isItemAvailableForMap,
+    },
+    /** ## Runes, Stat Runes, and Rune Trees */
+    rune: {
+        /** Array of rune objects, containing information about runes (excl. stat runes). */
+        list: RunesArr,
+        get: getRune,
+        stat: {
+            /** Array of stat rune objects, containing information about little stat runes. */
+            list: StatRunesArr,
+            get: getStatRune,
+        },
+        tree: {
+            /** Array of rune tree objects, containing information about rune trees. */
+            list: RuneTreesArr,
+            get: getRuneTree,
+        },
+    },
+    /** ## Summoner Spells */
+    spell: {
+        /** Array of spell objects, containing information about summoner spells. */
+        list: SpellsArr,
+        get: getSpell,
+    },
+    /** ## Maps */
+    map: {
+        /** Array of map objects, containing information about maps. */
+        list: MapsArr,
+        get: getMap,
+    },
+    /** ## Queues */
+    queue: {
+        /** Array of queue objects, containing information about queues. */
+        list: QueuesArr,
+        get: getQueue,
+    },
+    /** ## Regions, Platforms, Locales, and Riot ID */
+    region: {
+        /** Array of region objects, containing information about regions/platforms. */
+        list: RegionsArr,
+        get: getRegion,
+        /**
+         * ### Riot ID
+         * Helper functions for processing Riot ID.
+         */
+        riotId: {
+            make: makeRiotId,
+            split: splitRiotId,
+            validate: validateRiotId,
+        },
+    },
+    /** ## Type validators */
+    type: {
+        isChampionClass,
+        isKillType,
+        isMapId,
+        isMapTitle,
+        isDragonType,
+        isMonsterType,
+        isLane,
+        isLaneType,
+        isPosition,
+        isRole,
+        isTeamId,
+        isGameMode,
+        isGameType,
+        isQueueId,
+        isQueueTitle,
+        isQueueType,
+        isRankedRank,
+        isRankedTier,
+        isLocale,
+        isPlatform,
+        isRegion,
+        isBuildingType,
+        isTowerType,
+        isWardType,
+        isChampionId,
+        isChampionKey,
+        isChampionName,
+        isItemId,
+        isItemName,
+        isRuneId,
+        isRuneKey,
+        isRuneName,
+        isStatRuneId,
+        isStatRuneName,
+        isRuneTreeId,
+        isRuneTreeKey,
+        isRuneTreeName,
+        isSpellId,
+        isSpellKey,
+        isSpellName,
+    },
+};

package/dist/objects/Maps.d.ts

@@ -0,0 +1,113 @@
+export declare const Maps: {
+    /** Tutorial map */
+    readonly 3: {
+        readonly id: 3;
+        readonly title: "The Proving Grounds";
+    };
+    /** Last TT map */
+    readonly 10: {
+        readonly id: 10;
+        readonly title: "Twisted Treeline";
+    };
+    /** Current version */
+    readonly 11: {
+        readonly id: 11;
+        readonly title: "Summoner's Rift";
+    };
+    /** ARAM map */
+    readonly 12: {
+        readonly id: 12;
+        readonly title: "Howling Abyss";
+    };
+    /** Alternate ARAM map */
+    readonly 14: {
+        readonly id: 14;
+        readonly title: "Butcher's Bridge";
+    };
+    /** Dark Star: Singularity map */
+    readonly 16: {
+        readonly id: 16;
+        readonly title: "Cosmic Ruins";
+    };
+    /** Star Guardian Invasion map */
+    readonly 18: {
+        readonly id: 18;
+        readonly title: "Valoran City Park";
+    };
+    /** PROJECT: Hunters map */
+    readonly 19: {
+        readonly id: 19;
+        readonly title: "Substructure 43";
+    };
+    /** Odyssey: Extraction map */
+    readonly 20: {
+        readonly id: 20;
+        readonly title: "Crash Site";
+    };
+    /** Nexus Blitz map */
+    readonly 21: {
+        readonly id: 21;
+        readonly title: "Nexus Blitz";
+    };
+    /** Teamfight Tactics map */
+    readonly 22: {
+        readonly id: 22;
+        readonly title: "Convergence";
+    };
+    /** Arena map */
+    readonly 30: {
+        readonly id: 30;
+        readonly title: "Rings of Wrath";
+    };
+    /** 2024 Swarm event map */
+    readonly 33: {
+        readonly id: 33;
+        readonly title: "Swarm";
+    };
+};
+export declare const MapsArr: ({
+    readonly id: 3;
+    readonly title: "The Proving Grounds";
+} | {
+    readonly id: 10;
+    readonly title: "Twisted Treeline";
+} | {
+    readonly id: 11;
+    readonly title: "Summoner's Rift";
+} | {
+    readonly id: 12;
+    readonly title: "Howling Abyss";
+} | {
+    readonly id: 14;
+    readonly title: "Butcher's Bridge";
+} | {
+    readonly id: 16;
+    readonly title: "Cosmic Ruins";
+} | {
+    readonly id: 18;
+    readonly title: "Valoran City Park";
+} | {
+    readonly id: 19;
+    readonly title: "Substructure 43";
+} | {
+    readonly id: 20;
+    readonly title: "Crash Site";
+} | {
+    readonly id: 21;
+    readonly title: "Nexus Blitz";
+} | {
+    readonly id: 22;
+    readonly title: "Convergence";
+} | {
+    readonly id: 30;
+    readonly title: "Rings of Wrath";
+} | {
+    readonly id: 33;
+    readonly title: "Swarm";
+})[];
+export type MapId = typeof MapsArr[number]['id'];
+export type MapTitle = typeof MapsArr[number]['title'];
+export declare function isMapId(id: number | null | undefined): id is MapId;
+export declare function isMapTitle(title: string | null | undefined): title is MapTitle;
+/** Get map by its **id** or **title**. */
+export declare function getMap(id_title: MapId | MapTitle): typeof Maps[keyof typeof Maps];

package/dist/objects/Maps.js

@@ -0,0 +1,69 @@
+export const Maps = {
+    /** Tutorial map */
+    3: { id: 3, title: "The Proving Grounds" },
+    /** Last TT map */
+    10: { id: 10, title: "Twisted Treeline" },
+    /** Current version */
+    11: { id: 11, title: "Summoner's Rift" },
+    /** ARAM map */
+    12: { id: 12, title: "Howling Abyss" },
+    /** Alternate ARAM map */
+    14: { id: 14, title: "Butcher's Bridge" },
+    /** Dark Star: Singularity map */
+    16: { id: 16, title: "Cosmic Ruins" },
+    /** Star Guardian Invasion map */
+    18: { id: 18, title: "Valoran City Park" },
+    /** PROJECT: Hunters map */
+    19: { id: 19, title: "Substructure 43" },
+    /** Odyssey: Extraction map */
+    20: { id: 20, title: "Crash Site" },
+    /** Nexus Blitz map */
+    21: { id: 21, title: "Nexus Blitz" },
+    /** Teamfight Tactics map */
+    22: { id: 22, title: "Convergence" },
+    /** Arena map */
+    30: { id: 30, title: "Rings of Wrath" },
+    /** 2024 Swarm event map */
+    33: { id: 33, title: "Swarm" },
+};
+export const MapsArr = Object.values(Maps);
+const mapTitles = {
+    /** Tutorial map */
+    'The Proving Grounds': 3,
+    /** Last TT map */
+    'Twisted Treeline': 10,
+    /** Current version */
+    "Summoner's Rift": 11,
+    /** ARAM map */
+    'Howling Abyss': 12,
+    /** Alternate ARAM map */
+    "Butcher's Bridge": 14,
+    /** Dark Star: Singularity map */
+    'Cosmic Ruins': 16,
+    /** Star Guardian Invasion map */
+    'Valoran City Park': 18,
+    /** PROJECT: Hunters map */
+    'Substructure 43': 19,
+    /** Odyssey: Extraction map */
+    'Crash Site': 20,
+    /** Nexus Blitz map */
+    'Nexus Blitz': 21,
+    /** Teamfight Tactics map */
+    'Convergence': 22,
+    /** Arena map */
+    'Rings of Wrath': 30,
+    /** 2024 Swarm event map */
+    'Swarm': 33,
+};
+export function isMapId(id) {
+    return typeof id == 'number' && id in Maps;
+}
+export function isMapTitle(title) {
+    return typeof title == 'string' && title in mapTitles;
+}
+/** Get map by its **id** or **title**. */
+export function getMap(id_title) {
+    if (typeof id_title == 'number')
+        return Maps[id_title];
+    return Maps[mapTitles[id_title]];
+}

package/dist/objects/Queues.d.ts

@@ -0,0 +1,192 @@
+export declare const Queues: {
+    readonly 0: {
+        readonly id: 0;
+        readonly title: "Custom";
+    };
+    readonly 400: {
+        readonly id: 400;
+        readonly title: "5v5 Draft Pick";
+    };
+    readonly 420: {
+        readonly id: 420;
+        readonly title: "5v5 Ranked Solo";
+    };
+    readonly 430: {
+        readonly id: 430;
+        readonly title: "5v5 Blind Pick";
+    };
+    readonly 440: {
+        readonly id: 440;
+        readonly title: "5v5 Ranked Flex";
+    };
+    readonly 450: {
+        readonly id: 450;
+        readonly title: "5v5 ARAM";
+    };
+    readonly 700: {
+        readonly id: 700;
+        readonly title: "Clash";
+    };
+    readonly 720: {
+        readonly id: 720;
+        readonly title: "ARAM Clash";
+    };
+    readonly 830: {
+        readonly id: 830;
+        readonly title: "Co-op vs. AI: Intro";
+    };
+    readonly 840: {
+        readonly id: 840;
+        readonly title: "Co-op vs. AI: Beginner";
+    };
+    readonly 850: {
+        readonly id: 850;
+        readonly title: "Co-op vs. AI: Intermediate";
+    };
+    readonly 900: {
+        readonly id: 900;
+        readonly title: "ARURF";
+    };
+    readonly 920: {
+        readonly id: 920;
+        readonly title: "Legend of the Poro King";
+    };
+    readonly 1010: {
+        readonly id: 1010;
+        readonly title: "Snow ARURF";
+    };
+    readonly 1020: {
+        readonly id: 1020;
+        readonly title: "One for All";
+    };
+    readonly 1090: {
+        readonly id: 1090;
+        readonly title: "Teamfight Tactics";
+    };
+    readonly 1100: {
+        readonly id: 1100;
+        readonly title: "Teamfight Tactics (Ranked)";
+    };
+    readonly 1110: {
+        readonly id: 1110;
+        readonly title: "Teamfight Tactics (Tutorial)";
+    };
+    readonly 1111: {
+        readonly id: 1111;
+        readonly title: "Teamfight Tactics (Test)";
+    };
+    readonly 1300: {
+        readonly id: 1300;
+        readonly title: "Nexus Blitz";
+    };
+    readonly 1400: {
+        readonly id: 1400;
+        readonly title: "Ultimate Spellbook";
+    };
+    readonly 1700: {
+        readonly id: 1700;
+        readonly title: "Arena";
+    };
+    /** ‘Pick’ URF games */
+    readonly 1900: {
+        readonly id: 1900;
+        readonly title: "URF";
+    };
+    readonly 2000: {
+        readonly id: 2000;
+        readonly title: "Tutorial 1";
+    };
+    readonly 2010: {
+        readonly id: 2010;
+        readonly title: "Tutorial 2";
+    };
+    readonly 2020: {
+        readonly id: 2020;
+        readonly title: "Tutorial 3";
+    };
+};
+export declare const QueuesArr: ({
+    readonly id: 0;
+    readonly title: "Custom";
+} | {
+    readonly id: 400;
+    readonly title: "5v5 Draft Pick";
+} | {
+    readonly id: 420;
+    readonly title: "5v5 Ranked Solo";
+} | {
+    readonly id: 430;
+    readonly title: "5v5 Blind Pick";
+} | {
+    readonly id: 440;
+    readonly title: "5v5 Ranked Flex";
+} | {
+    readonly id: 450;
+    readonly title: "5v5 ARAM";
+} | {
+    readonly id: 700;
+    readonly title: "Clash";
+} | {
+    readonly id: 720;
+    readonly title: "ARAM Clash";
+} | {
+    readonly id: 830;
+    readonly title: "Co-op vs. AI: Intro";
+} | {
+    readonly id: 840;
+    readonly title: "Co-op vs. AI: Beginner";
+} | {
+    readonly id: 850;
+    readonly title: "Co-op vs. AI: Intermediate";
+} | {
+    readonly id: 900;
+    readonly title: "ARURF";
+} | {
+    readonly id: 920;
+    readonly title: "Legend of the Poro King";
+} | {
+    readonly id: 1010;
+    readonly title: "Snow ARURF";
+} | {
+    readonly id: 1020;
+    readonly title: "One for All";
+} | {
+    readonly id: 1090;
+    readonly title: "Teamfight Tactics";
+} | {
+    readonly id: 1100;
+    readonly title: "Teamfight Tactics (Ranked)";
+} | {
+    readonly id: 1110;
+    readonly title: "Teamfight Tactics (Tutorial)";
+} | {
+    readonly id: 1111;
+    readonly title: "Teamfight Tactics (Test)";
+} | {
+    readonly id: 1300;
+    readonly title: "Nexus Blitz";
+} | {
+    readonly id: 1400;
+    readonly title: "Ultimate Spellbook";
+} | {
+    readonly id: 1700;
+    readonly title: "Arena";
+} | {
+    readonly id: 1900;
+    readonly title: "URF";
+} | {
+    readonly id: 2000;
+    readonly title: "Tutorial 1";
+} | {
+    readonly id: 2010;
+    readonly title: "Tutorial 2";
+} | {
+    readonly id: 2020;
+    readonly title: "Tutorial 3";
+})[];
+export type QueueId = typeof QueuesArr[number]['id'];
+export type QueueTitle = typeof QueuesArr[number]['title'];
+export declare function isQueueId(id: number | null | undefined): id is QueueId;
+export declare function isQueueTitle(title: string | null | undefined): title is QueueTitle;
+/** Get queue by its **id** or **title**. */
+export declare function getQueue(id_title: QueueId | QueueTitle): typeof Queues[keyof typeof Queues];

package/dist/objects/Queues.js

@@ -0,0 +1,71 @@
+export const Queues = {
+    0: { id: 0, title: 'Custom' },
+    400: { id: 400, title: '5v5 Draft Pick' },
+    420: { id: 420, title: '5v5 Ranked Solo' },
+    430: { id: 430, title: '5v5 Blind Pick' },
+    440: { id: 440, title: '5v5 Ranked Flex' },
+    450: { id: 450, title: '5v5 ARAM' },
+    700: { id: 700, title: 'Clash' },
+    720: { id: 720, title: 'ARAM Clash' },
+    830: { id: 830, title: 'Co-op vs. AI: Intro' },
+    840: { id: 840, title: 'Co-op vs. AI: Beginner' },
+    850: { id: 850, title: 'Co-op vs. AI: Intermediate' },
+    900: { id: 900, title: 'ARURF' },
+    920: { id: 920, title: 'Legend of the Poro King' },
+    1010: { id: 1010, title: 'Snow ARURF' },
+    1020: { id: 1020, title: 'One for All' },
+    1090: { id: 1090, title: 'Teamfight Tactics' },
+    1100: { id: 1100, title: 'Teamfight Tactics (Ranked)' },
+    1110: { id: 1110, title: 'Teamfight Tactics (Tutorial)' },
+    1111: { id: 1111, title: 'Teamfight Tactics (Test)' },
+    1300: { id: 1300, title: 'Nexus Blitz' },
+    1400: { id: 1400, title: 'Ultimate Spellbook' },
+    1700: { id: 1700, title: 'Arena' },
+    /** ‘Pick’ URF games */
+    1900: { id: 1900, title: 'URF' },
+    2000: { id: 2000, title: 'Tutorial 1' },
+    2010: { id: 2010, title: 'Tutorial 2' },
+    2020: { id: 2020, title: 'Tutorial 3' },
+};
+export const QueuesArr = Object.values(Queues);
+const queueTitles = {
+    'Custom': 0,
+    '5v5 Draft Pick': 400,
+    '5v5 Ranked Solo': 420,
+    '5v5 Blind Pick': 430,
+    '5v5 Ranked Flex': 440,
+    '5v5 ARAM': 450,
+    'Clash': 700,
+    'ARAM Clash': 720,
+    'Co-op vs. AI: Intro': 830,
+    'Co-op vs. AI: Beginner': 840,
+    'Co-op vs. AI: Intermediate': 850,
+    'ARURF': 900,
+    'Legend of the Poro King': 920,
+    'Snow ARURF': 1010,
+    'One for All': 1020,
+    'Teamfight Tactics': 1090,
+    'Teamfight Tactics (Ranked)': 1100,
+    'Teamfight Tactics (Tutorial)': 1110,
+    'Teamfight Tactics (Test)': 1111,
+    'Nexus Blitz': 1300,
+    'Ultimate Spellbook': 1400,
+    'Arena': 1700,
+    /** ‘Pick’ URF games */
+    'URF': 1900,
+    'Tutorial 1': 2000,
+    'Tutorial 2': 2010,
+    'Tutorial 3': 2020,
+};
+export function isQueueId(id) {
+    return typeof id == 'number' && id in Queues;
+}
+export function isQueueTitle(title) {
+    return typeof title == 'string' && title in queueTitles;
+}
+/** Get queue by its **id** or **title**. */
+export function getQueue(id_title) {
+    if (typeof id_title == 'number')
+        return Queues[id_title];
+    return Queues[queueTitles[id_title]];
+}