lol-constants 0.10.0 → 0.10.1

package/dist/Constants/DDPaths.d.ts

@@ -1,3 +1,7 @@
+/**
+ * DataDragon CDN Paths.
+ * All paths end with '/'.
+ */
 export declare const DDPaths: {
     readonly CHAMPION_ICON_BASE: `${string}img/champion/`;
     readonly SPELL_ICON_BASE: `${string}img/spell/`;

package/dist/Constants/DDPaths.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DDPaths = void 0;
 const VERSION = '12.8.1';
 const BASE = `http://ddragon.leagueoflegends.com/cdn/${VERSION}/`;
+/**
+ * DataDragon CDN Paths.
+ * All paths end with '/'.
+ */
 exports.DDPaths = {
     CHAMPION_ICON_BASE: `${BASE}img/champion/`,
     SPELL_ICON_BASE: `${BASE}img/spell/`,

package/dist/Constants/RuneSets.d.ts

@@ -1,9 +1,33 @@
+/**
+ * There are 17 Keystone Runes in the game.
+ */
+export declare const Keystones: readonly ["8005", "8008", "8021", "8010", "8112", "8124", "8128", "9923", "8214", "8229", "8230", "8437", "8439", "8465", "8351", "8360", "8369"];
+/**
+ * Contains all Rune IDs
+ * that are known to man in the game of League of Legends.
+ * Sorted by various useful categories.
+ */
 export declare const RuneSets: {
     readonly PrimaryTrees: {
+        /**
+         * There are 13 Precision Runes in the game.
+         */
         readonly Precision: readonly ["8005", "8008", "8021", "8010", "9101", "9111", "8009", "9104", "9105", "9103", "8014", "8017", "8299"];
+        /**
+         * There are 13 Domination Runes in the game.
+         */
         readonly Domination: readonly ["8112", "8124", "8128", "9923", "8126", "8139", "8143", "8136", "8138", "8135", "8134", "8105", "8106"];
+        /**
+         * There are 12 Sorcery Runes in the game.
+         */
         readonly Sorcery: readonly ["8214", "8229", "8230", "8224", "8226", "8275", "8210", "8234", "8233", "8237", "8232", "8236"];
+        /**
+         * There are 11 Resolve Runes in the game.
+         */
         readonly Resolve: readonly ["8437", "8439", "8465", "8446", "8463", "8401", "8429", "8444", "8473", "8451", "8453", "8242"];
+        /**
+         * There are 12 Inspiration Runes in the game.
+         */
         readonly Inspiration: readonly ["8351", "8360", "8369", "8306", "8304", "8313", "8321", "8316", "8345", "8347", "8410", "8352"];
     };
     readonly SecondaryTrees: {
@@ -15,4 +39,5 @@ export declare const RuneSets: {
     };
     readonly Keystones: readonly ["8005", "8008", "8021", "8010", "8112", "8124", "8128", "9923", "8214", "8229", "8230", "8437", "8439", "8465", "8351", "8360", "8369"];
     readonly StatRunes: readonly ["5001", "5002", "5002f", "5003", "5003f", "5005", "5007", "5008", "5008f"];
+    readonly All: readonly ["8005", "8008", "8021", "8010", "9101", "9111", "8009", "9104", "9105", "9103", "8014", "8017", "8299", "8112", "8124", "8128", "9923", "8126", "8139", "8143", "8136", "8138", "8135", "8134", "8105", "8106", "8214", "8229", "8230", "8224", "8226", "8275", "8210", "8234", "8233", "8237", "8232", "8236", "8437", "8439", "8465", "8446", "8463", "8401", "8429", "8444", "8473", "8451", "8453", "8242", "8351", "8360", "8369", "8306", "8304", "8313", "8321", "8316", "8345", "8347", "8410", "8352", "5001", "5002", "5002f", "5003", "5003f", "5005", "5007", "5008", "5008f"];
 };

package/dist/Constants/RuneSets.js

@@ -1,166 +1,210 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RuneSets = void 0;
-exports.RuneSets = {
-    PrimaryTrees: {
-        'Precision': [
-            '8005',
-            '8008',
-            '8021',
-            '8010',
-            '9101',
-            '9111',
-            '8009',
-            '9104',
-            '9105',
-            '9103',
-            '8014',
-            '8017',
-            '8299',
-        ],
-        'Domination': [
-            '8112',
-            '8124',
-            '8128',
-            '9923',
-            '8126',
-            '8139',
-            '8143',
-            '8136',
-            '8138',
-            '8135',
-            '8134',
-            '8105',
-            '8106',
-        ],
-        'Sorcery': [
-            '8214',
-            '8229',
-            '8230',
-            '8224',
-            '8226',
-            '8275',
-            '8210',
-            '8234',
-            '8233',
-            '8237',
-            '8232',
-            '8236',
-        ],
-        'Resolve': [
-            '8437',
-            '8439',
-            '8465',
-            '8446',
-            '8463',
-            '8401',
-            '8429',
-            '8444',
-            '8473',
-            '8451',
-            '8453',
-            '8242',
-        ],
-        'Inspiration': [
-            '8351',
-            '8360',
-            '8369',
-            '8306',
-            '8304',
-            '8313',
-            '8321',
-            '8316',
-            '8345',
-            '8347',
-            '8410',
-            '8352',
-        ],
-    },
-    SecondaryTrees: {
-        'Precision': [
-            '9101',
-            '9111',
-            '8009',
-            '9104',
-            '9105',
-            '9103',
-            '8014',
-            '8017',
-            '8299',
-        ],
-        'Domination': [
-            '8126',
-            '8139',
-            '8143',
-            '8136',
-            '8138',
-            '8135',
-            '8134',
-            '8105',
-            '8106',
-        ],
-        'Sorcery': [
-            '8224',
-            '8226',
-            '8275',
-            '8210',
-            '8234',
-            '8233',
-            '8237',
-            '8232',
-            '8236',
-        ],
-        'Resolve': [
-            '8446',
-            '8463',
-            '8401',
-            '8429',
-            '8444',
-            '8473',
-            '8451',
-            '8453',
-            '8242',
-        ],
-        'Inspiration': [
-            '8306',
-            '8304',
-            '8313',
-            '8321',
-            '8316',
-            '8345',
-            '8347',
-            '8410',
-            '8352',
-        ],
-    },
-    Keystones: [
+exports.RuneSets = exports.Keystones = void 0;
+const PrimaryTrees = {
+    /**
+     * There are 13 Precision Runes in the game.
+     */
+    'Precision': [
         '8005',
         '8008',
         '8021',
         '8010',
+        '9101',
+        '9111',
+        '8009',
+        '9104',
+        '9105',
+        '9103',
+        '8014',
+        '8017',
+        '8299',
+    ],
+    /**
+     * There are 13 Domination Runes in the game.
+     */
+    'Domination': [
         '8112',
         '8124',
         '8128',
         '9923',
+        '8126',
+        '8139',
+        '8143',
+        '8136',
+        '8138',
+        '8135',
+        '8134',
+        '8105',
+        '8106',
+    ],
+    /**
+     * There are 12 Sorcery Runes in the game.
+     */
+    'Sorcery': [
         '8214',
         '8229',
         '8230',
+        '8224',
+        '8226',
+        '8275',
+        '8210',
+        '8234',
+        '8233',
+        '8237',
+        '8232',
+        '8236',
+    ],
+    /**
+     * There are 11 Resolve Runes in the game.
+     */
+    'Resolve': [
         '8437',
         '8439',
         '8465',
+        '8446',
+        '8463',
+        '8401',
+        '8429',
+        '8444',
+        '8473',
+        '8451',
+        '8453',
+        '8242',
+    ],
+    /**
+     * There are 12 Inspiration Runes in the game.
+     */
+    'Inspiration': [
         '8351',
         '8360',
         '8369',
+        '8306',
+        '8304',
+        '8313',
+        '8321',
+        '8316',
+        '8345',
+        '8347',
+        '8410',
+        '8352',
+    ],
+};
+const SecondaryTrees = {
+    'Precision': [
+        '9101',
+        '9111',
+        '8009',
+        '9104',
+        '9105',
+        '9103',
+        '8014',
+        '8017',
+        '8299',
+    ],
+    'Domination': [
+        '8126',
+        '8139',
+        '8143',
+        '8136',
+        '8138',
+        '8135',
+        '8134',
+        '8105',
+        '8106',
+    ],
+    'Sorcery': [
+        '8224',
+        '8226',
+        '8275',
+        '8210',
+        '8234',
+        '8233',
+        '8237',
+        '8232',
+        '8236',
     ],
-    StatRunes: [
-        '5001',
-        '5002',
-        '5002f',
-        '5003',
-        '5003f',
-        '5005',
-        '5007',
-        '5008',
-        '5008f',
+    'Resolve': [
+        '8446',
+        '8463',
+        '8401',
+        '8429',
+        '8444',
+        '8473',
+        '8451',
+        '8453',
+        '8242',
     ],
+    'Inspiration': [
+        '8306',
+        '8304',
+        '8313',
+        '8321',
+        '8316',
+        '8345',
+        '8347',
+        '8410',
+        '8352',
+    ],
+};
+/**
+ * There are 17 Keystone Runes in the game.
+ */
+exports.Keystones = [
+    // Precision
+    '8005',
+    '8008',
+    '8021',
+    '8010',
+    // Domination
+    '8112',
+    '8124',
+    '8128',
+    '9923',
+    // Sorcery
+    '8214',
+    '8229',
+    '8230',
+    // Resolve
+    '8437',
+    '8439',
+    '8465',
+    // Inspiration
+    '8351',
+    '8360',
+    '8369',
+];
+/**
+ * There are 9 Stat Runes in the game.
+ */
+const StatRunes = [
+    '5001',
+    '5002',
+    '5002f',
+    '5003',
+    '5003f',
+    '5005',
+    '5007',
+    '5008',
+    '5008f',
+];
+const All = [
+    ...PrimaryTrees.Precision,
+    ...PrimaryTrees.Domination,
+    ...PrimaryTrees.Sorcery,
+    ...PrimaryTrees.Resolve,
+    ...PrimaryTrees.Inspiration,
+    ...StatRunes,
+];
+/**
+ * Contains all Rune IDs
+ * that are known to man in the game of League of Legends.
+ * Sorted by various useful categories.
+ */
+exports.RuneSets = {
+    PrimaryTrees,
+    SecondaryTrees,
+    Keystones: exports.Keystones,
+    StatRunes,
+    All,
 };

package/dist/Helpers/generateChampionsByKey.js

@@ -11,12 +11,15 @@ function generateChampionsByKey() {
         data: {},
         version: '',
     };
+    // Add all champions' data to each corresponding key value
     let championId;
     for (championId in champion_json_1.default.data) {
         const championData = champion_json_1.default.data[championId];
         championsByKey.data[championData.key] = championData;
     }
+    // Add version to the product object
     championsByKey.version = champion_json_1.default.version;
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/championByKey.json`, JSON.stringify(championsByKey));
 }
 exports.generateChampionsByKey = generateChampionsByKey;

package/dist/Helpers/generateChampionsByName.js

@@ -11,12 +11,15 @@ function generateChampionsByName() {
         data: {},
         version: '',
     };
+    // Extract all champion names from `champion.json`
     let championId;
     for (championId in champion_json_1.default.data) {
         const championData = champion_json_1.default.data[championId];
         championsByName.data[championData.name] = championData;
     }
+    // Add version to the product object
     championsByName.version = champion_json_1.default.version;
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/championByName.json`, JSON.stringify(championsByName));
 }
 exports.generateChampionsByName = generateChampionsByName;

package/dist/Helpers/generateItemsByName.js

@@ -11,15 +11,20 @@ function generateItemsByName() {
         data: {},
         version: '',
     };
+    // Add all items' data to each corresponding name value
     let itemKey;
     for (itemKey in item_json_1.default.data) {
         const itemData = item_json_1.default.data[itemKey];
         itemByName.data[itemData.name] = {
             ...itemData,
+            // Add the extra variable: `key`
+            // because it is esentially being overwritten.
             key: itemKey,
         };
     }
+    // Add version to the product object
     itemByName.version = item_json_1.default.version;
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/itemByName.json`, JSON.stringify(itemByName));
 }
 exports.generateItemsByName = generateItemsByName;

package/dist/Helpers/generateRunesById.js

@@ -8,6 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const runesReforged_json_1 = __importDefault(require("../assets/runesReforged.json"));
 function generateRunesById() {
     const runesById = {};
+    // Construct the new data and assign it to product object
     for (const runeTree of runesReforged_json_1.default) {
         for (const { runes } of runeTree.slots) {
             for (const rune of runes) {
@@ -15,6 +16,7 @@ function generateRunesById() {
             }
         }
     }
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/runesById.json`, JSON.stringify(runesById));
 }
 exports.generateRunesById = generateRunesById;

package/dist/Helpers/generateRunesByName.js

@@ -8,6 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const runesReforged_json_1 = __importDefault(require("../assets/runesReforged.json"));
 function generateRunesByName() {
     const runesByName = {};
+    // Construct the new data and assign it to product object
     for (const runeTree of runesReforged_json_1.default) {
         for (const { runes } of runeTree.slots) {
             for (const rune of runes) {
@@ -15,6 +16,7 @@ function generateRunesByName() {
             }
         }
     }
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/runesByName.json`, JSON.stringify(runesByName));
 }
 exports.generateRunesByName = generateRunesByName;

package/dist/Helpers/generateSummonerSpellsByKey.js

@@ -11,6 +11,7 @@ function generateSummonerSpellsByKey() {
         data: {},
         version: '',
     };
+    // Add all summoners' data to each corresponding key value
     let summonerId;
     for (summonerId in summoner_json_1.default.data) {
         const summonerData = summoner_json_1.default.data[summonerId];
@@ -18,7 +19,9 @@ function generateSummonerSpellsByKey() {
             ...summonerData,
         };
     }
+    // Add version to the product object
     summonersByKey.version = summoner_json_1.default.version;
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/summonerByKey.json`, JSON.stringify(summonersByKey));
 }
 exports.generateSummonerSpellsByKey = generateSummonerSpellsByKey;

package/dist/Helpers/generateSummonerSpellsByName.js

@@ -11,6 +11,7 @@ function generateSummonerSpellsByName() {
         data: {},
         version: '',
     };
+    // Add all summoners' data to each corresponding name value
     let summonerId;
     for (summonerId in summoner_json_1.default.data) {
         const summonerData = summoner_json_1.default.data[summonerId];
@@ -18,7 +19,9 @@ function generateSummonerSpellsByName() {
             ...summonerData,
         };
     }
+    // Add version to the product object
     summonersByName.version = summoner_json_1.default.version;
+    // Write to file
     fs_1.default.writeFileSync(`src/generated/summonerByName.json`, JSON.stringify(summonersByName));
 }
 exports.generateSummonerSpellsByName = generateSummonerSpellsByName;

package/dist/Helpers/getRuneIdByName.js

@@ -14,6 +14,8 @@ function getRuneIdByName(name) {
             if (StatRunes_1.StatRunes[statRuneId] == name)
                 return statRuneId;
         }
+        // Code will never run this far
+        // but this to satisfy TypeScript and not put `statRuneName` in tree runes.
         return '5001';
     }
     return runesByName_json_1.default[name].id;

package/dist/index.d.ts

@@ -17232,6 +17232,7 @@ export { ItemKeys } from './Constants/ItemKeys';
 export { ItemNames } from './Constants/ItemNames';
 export { RuneIds } from './Constants/RuneIds';
 export { RuneNames } from './Constants/RuneNames';
+export { RuneSets } from './Constants/RuneSets';
 export { StatRuneIds } from './Constants/StatRuneIds';
 export { StatRuneNames } from './Constants/StatRuneNames';
 export { StatRunes } from './Constants/StatRunes';

package/dist/index.js

@@ -17,7 +17,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTreeRuneName = exports.isTreeRuneId = exports.isSummonerSpellName = exports.isSummonerSpellKey = exports.isSummonerSpellId = exports.isStatRuneName = exports.isStatRuneId = exports.isRuneName = exports.isRuneId = exports.isItemName = exports.isItemKey = exports.isChampionName = exports.isChampionKey = exports.getSummonerSpellNameByKey = exports.getSummonerSpellKeyByName = exports.getRuneNameById = exports.getRuneIdByName = exports.getItemNameByKey = exports.getItemKeyByName = exports.getChampionNameByKey = exports.getChampionKeyByName = exports.summonerByName = exports.summonerByKey = exports.runesByName = exports.runesById = exports.itemByName = exports.championByName = exports.championByKey = exports.TreeRuneNames = exports.TreeRuneIds = exports.SummonerSpellNames = exports.SummonerSpellKeys = exports.SummonerSpellIds = exports.StatRunes = exports.StatRuneNames = exports.StatRuneIds = exports.RuneNames = exports.RuneIds = exports.ItemNames = exports.ItemKeys = exports.DDPaths = exports.ChampionNames = exports.ChampionKeys = exports.summoner = exports.runesReforged = exports.item = exports.champion = void 0;
+exports.isTreeRuneName = exports.isTreeRuneId = exports.isSummonerSpellName = exports.isSummonerSpellKey = exports.isSummonerSpellId = exports.isStatRuneName = exports.isStatRuneId = exports.isRuneName = exports.isRuneId = exports.isItemName = exports.isItemKey = exports.isChampionName = exports.isChampionKey = exports.getSummonerSpellNameByKey = exports.getSummonerSpellKeyByName = exports.getRuneNameById = exports.getRuneIdByName = exports.getItemNameByKey = exports.getItemKeyByName = exports.getChampionNameByKey = exports.getChampionKeyByName = exports.summonerByName = exports.summonerByKey = exports.runesByName = exports.runesById = exports.itemByName = exports.championByName = exports.championByKey = exports.TreeRuneNames = exports.TreeRuneIds = exports.SummonerSpellNames = exports.SummonerSpellKeys = exports.SummonerSpellIds = exports.StatRunes = exports.StatRuneNames = exports.StatRuneIds = exports.RuneSets = exports.RuneNames = exports.RuneIds = exports.ItemNames = exports.ItemKeys = exports.DDPaths = exports.ChampionNames = exports.ChampionKeys = exports.summoner = exports.runesReforged = exports.item = exports.champion = void 0;
+// # assets
 const champion_json_1 = __importDefault(require("./assets/champion.json"));
 const item_json_1 = __importDefault(require("./assets/item.json"));
 const runesReforged_json_1 = __importDefault(require("./assets/runesReforged.json"));
@@ -26,6 +27,7 @@ exports.champion = champion_json_1.default;
 exports.item = item_json_1.default;
 exports.runesReforged = runesReforged_json_1.default;
 exports.summoner = summoner_json_1.default;
+// # Constants
 var ChampionKeys_1 = require("./Constants/ChampionKeys");
 Object.defineProperty(exports, "ChampionKeys", { enumerable: true, get: function () { return ChampionKeys_1.ChampionKeys; } });
 var ChampionNames_1 = require("./Constants/ChampionNames");
@@ -40,6 +42,8 @@ var RuneIds_1 = require("./Constants/RuneIds");
 Object.defineProperty(exports, "RuneIds", { enumerable: true, get: function () { return RuneIds_1.RuneIds; } });
 var RuneNames_1 = require("./Constants/RuneNames");
 Object.defineProperty(exports, "RuneNames", { enumerable: true, get: function () { return RuneNames_1.RuneNames; } });
+var RuneSets_1 = require("./Constants/RuneSets");
+Object.defineProperty(exports, "RuneSets", { enumerable: true, get: function () { return RuneSets_1.RuneSets; } });
 var StatRuneIds_1 = require("./Constants/StatRuneIds");
 Object.defineProperty(exports, "StatRuneIds", { enumerable: true, get: function () { return StatRuneIds_1.StatRuneIds; } });
 var StatRuneNames_1 = require("./Constants/StatRuneNames");
@@ -56,6 +60,7 @@ var TreeRuneIds_1 = require("./Constants/TreeRuneIds");
 Object.defineProperty(exports, "TreeRuneIds", { enumerable: true, get: function () { return TreeRuneIds_1.TreeRuneIds; } });
 var TreeRuneNames_1 = require("./Constants/TreeRuneNames");
 Object.defineProperty(exports, "TreeRuneNames", { enumerable: true, get: function () { return TreeRuneNames_1.TreeRuneNames; } });
+// # generated
 const championByKey_json_1 = __importDefault(require("./generated/championByKey.json"));
 const championByName_json_1 = __importDefault(require("./generated/championByName.json"));
 const itemByName_json_1 = __importDefault(require("./generated/itemByName.json"));
@@ -70,6 +75,7 @@ exports.runesById = runesById_json_1.default;
 exports.runesByName = runesByName_json_1.default;
 exports.summonerByKey = summonerByKey_json_1.default;
 exports.summonerByName = summonerByName_json_1.default;
+// # Helpers
 var getChampionKeyByName_1 = require("./Helpers/getChampionKeyByName");
 Object.defineProperty(exports, "getChampionKeyByName", { enumerable: true, get: function () { return getChampionKeyByName_1.getChampionKeyByName; } });
 var getChampionNameByKey_1 = require("./Helpers/getChampionNameByKey");
@@ -112,5 +118,7 @@ var isTreeRuneId_1 = require("./Helpers/isTreeRuneId");
 Object.defineProperty(exports, "isTreeRuneId", { enumerable: true, get: function () { return isTreeRuneId_1.isTreeRuneId; } });
 var isTreeRuneName_1 = require("./Helpers/isTreeRuneName");
 Object.defineProperty(exports, "isTreeRuneName", { enumerable: true, get: function () { return isTreeRuneName_1.isTreeRuneName; } });
+// # scripts
+// # types
 __exportStar(require("./types"), exports);
 __exportStar(require("./types/Meta"), exports);

package/dist/types/Meta.d.ts

@@ -6,7 +6,32 @@ export declare type GameType = 'CUSTOM_GAME' | 'TUTORIAL_GAME' | 'MATCHED_GAME';
 export declare type GameMode = 'CLASSIC' | 'ARAM' | 'TUTORIAL' | 'URF' | 'ONEFORALL' | 'KINGPORO' | 'GAMEMODEX' | 'ULTBOOK';
 export declare type PlatformId = 'BR1' | 'EUN1' | 'EUW1' | 'JP1' | 'KR' | 'LA1' | 'LA2' | 'NA1' | 'OC1' | 'TR1' | 'RU';
 export declare type Region = 'EUW' | 'EUNE' | 'NA' | 'KR' | 'JP' | 'OCE' | 'LAN' | 'LAS' | 'TR' | 'RU' | 'BR';
+/**
+ * 0 — Custom games
+ * 400 — 5v5 Draft Pick games
+ * 420 — 5v5 Ranked Solo games
+ * 430 — 5v5 Blind Pick games
+ * 440 — 5v5 Ranked Flex games
+ * 450 — 5v5 ARAM games
+ * 700 — Clash games
+ * 900 — ARURF games
+ * 920 — Legend of the Poro King games
+ * 1020 — One for All games
+ * 1090 — Teamfight Tactics games
+ * 1100 — Ranked Teamfight Tactics games
+ * 1110 — Teamfight Tactics Tutorial games
+ * 1111 — Teamfight Tactics test games
+ * 1300 — Nexus Blitz games
+ * 1400 — Ultimate Spellbook games
+ * 1900 — Pick URF games
+ */
 export declare type QueueId = 0 | 400 | 420 | 430 | 440 | 450 | 700 | 900 | 920 | 1020 | 1090 | 1100 | 1110 | 1111 | 1300 | 1400 | 1900;
+/**
+ * 11 — Summoner's Rift
+ * 12 — Howling Abyss
+ * 21 — Nexus Blitz
+ * 22 — Convergence
+ */
 export declare type MapId = 11 | 12 | 21 | 22;
 export declare type TeamId = 100 | 200;
 export declare type ParticipantId = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;

package/dist/types/index.d.ts

@@ -16,17 +16,143 @@ export declare type ItemName = keyof typeof itemByName.data;
 export declare type SummonerSpellId = keyof typeof summoner.data;
 export declare type SummonerSpellKey = keyof typeof summonerByKey.data;
 export declare type SummonerSpellName = keyof typeof summonerByName.data;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type RuneId = TreeRuneId | StatRuneId;
 export declare type RuneName = TreeRuneName | StatRuneName;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type TreeRuneId = keyof typeof runesById;
 export declare type TreeRuneName = keyof typeof runesByName;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type StatRuneId = keyof typeof StatRunes;
 export declare type StatRuneName = typeof StatRunes[keyof typeof StatRunes];
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type KeystoneRuneId = Extract<typeof RuneSets.Keystones[keyof typeof RuneSets.Keystones], string>;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type PrecisionTreeRuneId = Extract<typeof RuneSets.PrimaryTrees.Precision[keyof typeof RuneSets.PrimaryTrees.Precision], string>;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type DominationTreeRuneId = Extract<typeof RuneSets.PrimaryTrees.Domination[keyof typeof RuneSets.PrimaryTrees.Domination], string>;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type SorceryTreeRuneId = Extract<typeof RuneSets.PrimaryTrees.Sorcery[keyof typeof RuneSets.PrimaryTrees.Sorcery], string>;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type ResolveTreeRuneId = Extract<typeof RuneSets.PrimaryTrees.Resolve[keyof typeof RuneSets.PrimaryTrees.Resolve], string>;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `TreeRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
+ *
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionTreeRuneId`,
+ * -  `DominationTreeRuneId`,
+ * -  `SorceryTreeRuneId`,
+ * -  `ResolveTreeRuneId`,
+ * -  `InspirationTreeRuneId`,
+ */
 export declare type InspirationTreeRuneId = Extract<typeof RuneSets.PrimaryTrees.Inspiration[keyof typeof RuneSets.PrimaryTrees.Inspiration], string>;
 export declare type XP = number;
 export declare type Minute = number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lol-constants",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "League of Legends constants and data resources, such as champion, item, runes reforged, summoner spells.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",