lol-constants 2.4.0 → 2.5.0

package/README.md

@@ -0,0 +1,17 @@
+Provides constants and types for League of Legends related stuff within the context of [Riot APIs](https://developer.riotgames.com/docs/lol). Types such as [ChampionId](asd), [ChampionName](asd), [ItemKey](asd), [RuneId](asd), [SpellName](asd), [Position](asd), [Queue](asd), [RankedTier](asd), [Region](asd) and more are provided. Certain URLs and URIs are available as constants as well in [DataDragonUrls](asd), [PlatformApiUris](asd), [RegionalApiUris](asd).
+
+Advantages:
+- Four categories — champions, items, runes, summoner spells — are armed with getter functions that exchange between id–key–name such as [getChampionNameByKey](asd)–[getChampionIdByName](asd)–[getChampionKeyById](asd)
+- Types can be validated through type validating functions such as [isChampionName](asd)
+- Type validation functions such as [isChampionName](asd) and getter functions such as [getChampionNameByKey](asd) are instantaneous $O(1)$ and do not iterate over many elements
+
+<!-- - Runes and items are also provided in a categorized way: [StatRuneId](asd), [NonStatRuneId](asd), [DominationRuneId](asd) etc. and [MythicItemName](asd), [LegendaryItemName](asd), [BootsItemName](asd) etc. -->
+
+# Champions
+| constants | types | getters
+| --- | --- |
+| `ChampionIds`, `ChampionKeys` | `ChampionId`, `ChampionKey`, `ChampionKeyNum`, `ChampionName` | 
+# Items
+# Runes
+# Summoner spells
+# Other

package/assets/scripts/constants/RuneIdComment.d.ts

@@ -1 +1 @@
-export declare const RuneIdComment: "\n/**\n * There are 3 main Rune ID types:\n * -  `RuneId` (all),\n * -  `TreeRuneId` (all but stat runes),\n * -  `StatRuneId` (only stat runes).\n * \n * There are 6 more specific Rune ID types as well:\n * -  `KeystoneRuneId`,\n * -  `PrecisionTreeRuneId`,\n * -  `DominationTreeRuneId`,\n * -  `SorceryTreeRuneId`,\n * -  `ResolveTreeRuneId`,\n * -  `InspirationTreeRuneId`.\n */\n";
+export declare const RuneIdComment: "\n/**\n * There are 3 main Rune ID types:\n * -  `RuneId` (all),\n * -  `NonStatRuneId` (all but stat runes),\n * -  `StatRuneId` (only stat runes).\n * \n * There are 6 more specific Rune ID types as well:\n * -  `KeystoneRuneId`,\n * -  `PrecisionRuneId`,\n * -  `DominationRuneId`,\n * -  `SorceryRuneId`,\n * -  `ResolveRuneId`,\n * -  `InspirationRuneId`.\n * \n * There are 6 numerical Rune ID types:\n * -  `KeystoneRuneIdNum`,\n * -  `PrecisionRuneIdNum`,\n * -  `DominationRuneIdNum`,\n * -  `SorceryRuneIdNum`,\n * -  `ResolveRuneIdNum`,\n * -  `InspirationRuneIdNum`.\n */\n";

package/assets/scripts/constants/RuneIdComment.js

@@ -5,15 +5,23 @@ exports.RuneIdComment = `
 /**
  * There are 3 main Rune ID types:
  * -  \`RuneId\` (all),
- * -  \`TreeRuneId\` (all but stat runes),
+ * -  \`NonStatRuneId\` (all but stat runes),
  * -  \`StatRuneId\` (only stat runes).
  * 
  * There are 6 more specific Rune ID types as well:
  * -  \`KeystoneRuneId\`,
- * -  \`PrecisionTreeRuneId\`,
- * -  \`DominationTreeRuneId\`,
- * -  \`SorceryTreeRuneId\`,
- * -  \`ResolveTreeRuneId\`,
- * -  \`InspirationTreeRuneId\`.
+ * -  \`PrecisionRuneId\`,
+ * -  \`DominationRuneId\`,
+ * -  \`SorceryRuneId\`,
+ * -  \`ResolveRuneId\`,
+ * -  \`InspirationRuneId\`.
+ * 
+ * There are 6 numerical Rune ID types:
+ * -  \`KeystoneRuneIdNum\`,
+ * -  \`PrecisionRuneIdNum\`,
+ * -  \`DominationRuneIdNum\`,
+ * -  \`SorceryRuneIdNum\`,
+ * -  \`ResolveRuneIdNum\`,
+ * -  \`InspirationRuneIdNum\`.
  */
 `;

package/assets/scripts/generate-all.d.ts

@@ -9,6 +9,9 @@ import './generate-champion-names';
 import './generate-item-keys-num';
 import './generate-item-keys';
 import './generate-item-names';
+import './generate-non-stat-rune-ids-num';
+import './generate-non-stat-rune-ids';
+import './generate-non-stat-rune-names';
 import './generate-rune-picking-relationships';
 import './generate-rune-sets-by-rune-names-num';
 import './generate-rune-sets-by-rune-names';
@@ -18,6 +21,3 @@ import './generate-spell-ids';
 import './generate-spell-keys-num';
 import './generate-spell-keys';
 import './generate-spell-names';
-import './generate-tree-rune-ids-num';
-import './generate-tree-rune-ids';
-import './generate-tree-rune-names';

package/assets/scripts/generate-all.js

@@ -11,6 +11,9 @@ require("./generate-champion-names");
 require("./generate-item-keys-num");
 require("./generate-item-keys");
 require("./generate-item-names");
+require("./generate-non-stat-rune-ids-num");
+require("./generate-non-stat-rune-ids");
+require("./generate-non-stat-rune-names");
 // import './generate-rune-ids'
 // import './generate-rune-names'
 require("./generate-rune-picking-relationships");
@@ -24,6 +27,3 @@ require("./generate-spell-keys");
 require("./generate-spell-names");
 // import './generate-stat-rune-ids'
 // import './generate-stat-rune-names'
-require("./generate-tree-rune-ids-num");
-require("./generate-tree-rune-ids");
-require("./generate-tree-rune-names");

package/assets/scripts/generate-non-stat-rune-ids-num.d.ts

@@ -0,0 +1 @@
+export {};

package/assets/scripts/generate-non-stat-rune-ids-num.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RunesReforged_1 = require("../constants/RunesReforged");
+const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
+(async () => {
+    const runeIds = {};
+    // Construct the new data and assign it to product object
+    for (const runeTree of RunesReforged_1.RunesReforged) {
+        for (const { runes } of runeTree.slots) {
+            for (const rune of runes) {
+                runeIds[rune.name] = rune.id;
+            }
+        }
+    }
+    // Write to file
+    const constName = 'NonStatRuneIdsNum';
+    const typeName = 'NonStatRuneIdNum';
+    (0, writeToTmpFile_1.writeToTmpFile)(constName, {
+        constName,
+        typeName,
+        json: runeIds,
+    });
+})();

package/assets/scripts/generate-non-stat-rune-ids.d.ts

@@ -0,0 +1 @@
+export {};

package/assets/scripts/generate-non-stat-rune-ids.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RunesReforged_1 = require("../constants/RunesReforged");
+const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
+const RuneIdComment_1 = require("./constants/RuneIdComment");
+(async () => {
+    const runeIds = {};
+    // Construct the new data and assign it to product object
+    for (const runeTree of RunesReforged_1.RunesReforged) {
+        for (const { runes } of runeTree.slots) {
+            for (const rune of runes) {
+                runeIds[rune.name] = String(rune.id);
+            }
+        }
+    }
+    // Write to file
+    const constName = 'NonStatRuneIds';
+    (0, writeToTmpFile_1.writeToTmpFile)(constName, {
+        constName,
+        includeAutoTypeName: true,
+        typeComment: RuneIdComment_1.RuneIdComment,
+        json: runeIds,
+    });
+})();

package/assets/scripts/generate-non-stat-rune-names.d.ts

@@ -0,0 +1 @@
+export {};

package/assets/scripts/generate-non-stat-rune-names.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RunesReforged_1 = require("../constants/RunesReforged");
+const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
+(async () => {
+    const runeNames = {};
+    // Construct the new data and assign it to product object
+    for (const runeTree of RunesReforged_1.RunesReforged) {
+        for (const { runes } of runeTree.slots) {
+            for (const rune of runes) {
+                runeNames[rune.id] = rune.name;
+            }
+        }
+    }
+    // Write to file
+    const constName = 'NonStatRuneNames';
+    (0, writeToTmpFile_1.writeToTmpFile)(constName, {
+        constName,
+        includeAutoTypeName: true,
+        json: runeNames,
+    });
+})();

package/assets/scripts/generate-rune-sets-by-rune-names-num.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const RunesReforged_1 = require("../constants/RunesReforged");
 const StatRunesByRow_1 = require("../constants/StatRunesByRow");
+const RuneIdComment_1 = require("./constants/RuneIdComment");
 const validateNumber_1 = require("./helpers/validateNumber");
 const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
 (async () => {
@@ -11,7 +12,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         SecondaryRuneTrees: {},
         KeystoneIds: {},
         StatRuneIds: {},
-        RuneTreeHSets: {},
+        RuneHSets: {},
         StatRuneHSets: {},
     };
     const keystoneHSetIdx = 0;
@@ -39,12 +40,12 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
                 if (currentHSetIdx == keystoneHSetIdx) {
                     runeSets.KeystoneIds[runeName] = id;
                 }
-                // Add to RuneTreeHSets
-                if (!(runeTreeName in runeSets.RuneTreeHSets))
-                    runeSets.RuneTreeHSets[runeTreeName] = {};
-                if (!runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx])
-                    runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx] = {};
-                runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx][runeName] = id;
+                // Add to RuneHSets
+                if (!(runeTreeName in runeSets.RuneHSets))
+                    runeSets.RuneHSets[runeTreeName] = {};
+                if (!runeSets.RuneHSets[runeTreeName][currentHSetIdx])
+                    runeSets.RuneHSets[runeTreeName][currentHSetIdx] = {};
+                runeSets.RuneHSets[runeTreeName][currentHSetIdx][runeName] = id;
             }
             ++currentHSetIdx;
         }
@@ -75,9 +76,13 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         json: runeSets.KeystoneIds,
     }, {
         constName: 'StatRuneIdsNum',
+        typeName: 'StatRuneIdNum',
+        typeComment: RuneIdComment_1.RuneIdComment,
         json: runeSets.StatRuneIds,
     }, {
         constName: 'RuneIdsNum',
+        typeName: 'RuneIdNum',
+        typeComment: RuneIdComment_1.RuneIdComment,
         json: {
             1: '...PrimaryRuneTreesByRuneNamesNum.Precision',
             2: '...PrimaryRuneTreesByRuneNamesNum.Domination',
@@ -88,8 +93,8 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         },
         keysToEscape: [1, 2, 3, 4, 5, 6],
     }, {
-        constName: 'RuneTreeHSetsByRuneNamesNum',
-        json: runeSets.RuneTreeHSets,
+        constName: 'RuneHSetsByRuneNamesNum',
+        json: runeSets.RuneHSets,
     }, {
         constName: 'StatRuneHSetsByRuneNamesNum',
         json: runeSets.StatRuneHSets,
@@ -102,7 +107,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneIdsNum': 'KeystoneIdsNum',
             'StatRuneIdsNum': 'StatRuneIdsNum',
             'RuneIdsNum': 'RuneIdsNum',
-            'RuneTreeHSetsByRuneNamesNum': 'RuneTreeHSetsByRuneNamesNum',
+            'RuneHSetsByRuneNamesNum': 'RuneHSetsByRuneNamesNum',
             'StatRuneHSetsByRuneNamesNum': 'StatRuneHSetsByRuneNamesNum',
         },
         keysToEscape: [
@@ -111,7 +116,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneIdsNum',
             'StatRuneIdsNum',
             'RuneIdsNum',
-            'RuneTreeHSetsByRuneNamesNum',
+            'RuneHSetsByRuneNamesNum',
             'StatRuneHSetsByRuneNamesNum',
         ],
     });

package/assets/scripts/generate-rune-sets-by-rune-names.js

@@ -11,7 +11,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         SecondaryRuneTrees: {},
         KeystoneIds: {},
         StatRuneIds: {},
-        RuneTreeHSets: {},
+        RuneHSets: {},
         StatRuneHSets: {},
     };
     const keystoneHSetIdx = 0;
@@ -39,12 +39,12 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
                 if (currentHSetIdx == keystoneHSetIdx) {
                     runeSets.KeystoneIds[runeName] = String(id);
                 }
-                // Add to RuneTreeHSets
-                if (!(runeTreeName in runeSets.RuneTreeHSets))
-                    runeSets.RuneTreeHSets[runeTreeName] = {};
-                if (!runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx])
-                    runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx] = {};
-                runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx][runeName] = String(id);
+                // Add to RuneHSets
+                if (!(runeTreeName in runeSets.RuneHSets))
+                    runeSets.RuneHSets[runeTreeName] = {};
+                if (!runeSets.RuneHSets[runeTreeName][currentHSetIdx])
+                    runeSets.RuneHSets[runeTreeName][currentHSetIdx] = {};
+                runeSets.RuneHSets[runeTreeName][currentHSetIdx][runeName] = String(id);
             }
             ++currentHSetIdx;
         }
@@ -91,8 +91,8 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         },
         keysToEscape: [1, 2, 3, 4, 5, 6],
     }, {
-        constName: 'RuneTreeHSetsByRuneNames',
-        json: runeSets.RuneTreeHSets,
+        constName: 'RuneHSetsByRuneNames',
+        json: runeSets.RuneHSets,
     }, {
         constName: 'StatRuneHSetsByRuneNames',
         json: runeSets.StatRuneHSets,
@@ -105,7 +105,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneIds': 'KeystoneIds',
             'StatRuneIds': 'StatRuneIds',
             'RuneIds': 'RuneIds',
-            'RuneTreeHSetsByRuneNames': 'RuneTreeHSetsByRuneNames',
+            'RuneHSetsByRuneNames': 'RuneHSetsByRuneNames',
             'StatRuneHSetsByRuneNames': 'StatRuneHSetsByRuneNames',
         },
         keysToEscape: [
@@ -114,7 +114,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneIds',
             'StatRuneIds',
             'RuneIds',
-            'RuneTreeHSetsByRuneNames',
+            'RuneHSetsByRuneNames',
             'StatRuneHSetsByRuneNames',
         ],
     });

package/assets/scripts/generate-rune-sets.js

@@ -10,7 +10,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         SecondaryRuneTrees: {},
         KeystoneNames: {},
         StatRuneNames: {},
-        RuneTreeHSets: {},
+        RuneHSets: {},
         StatRuneHSets: {},
     };
     const keystoneHSetIdx = 0;
@@ -38,12 +38,12 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
                 if (currentHSetIdx == keystoneHSetIdx) {
                     runeSets.KeystoneNames[id] = runeName;
                 }
-                // Add to RuneTreeHSets
-                if (!(runeTreeName in runeSets.RuneTreeHSets))
-                    runeSets.RuneTreeHSets[runeTreeName] = {};
-                if (!runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx])
-                    runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx] = {};
-                runeSets.RuneTreeHSets[runeTreeName][currentHSetIdx][id] = runeName;
+                // Add to RuneHSets
+                if (!(runeTreeName in runeSets.RuneHSets))
+                    runeSets.RuneHSets[runeTreeName] = {};
+                if (!runeSets.RuneHSets[runeTreeName][currentHSetIdx])
+                    runeSets.RuneHSets[runeTreeName][currentHSetIdx] = {};
+                runeSets.RuneHSets[runeTreeName][currentHSetIdx][id] = runeName;
             }
             ++currentHSetIdx;
         }
@@ -88,8 +88,8 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
         },
         keysToEscape: [1, 2, 3, 4, 5, 6],
     }, {
-        constName: 'RuneTreeHSets',
-        json: runeSets.RuneTreeHSets,
+        constName: 'RuneHSets',
+        json: runeSets.RuneHSets,
     }, {
         constName: 'StatRuneHSets',
         json: runeSets.StatRuneHSets,
@@ -102,7 +102,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneNames': 'KeystoneNames',
             'StatRuneNames': 'StatRuneNames',
             'RuneNames': 'RuneNames',
-            'RuneTreeHSets': 'RuneTreeHSets',
+            'RuneHSets': 'RuneHSets',
             'StatRuneHSets': 'StatRuneHSets',
         },
         keysToEscape: [
@@ -111,7 +111,7 @@ const writeToTmpFile_1 = require("./helpers/writeToTmpFile");
             'KeystoneNames',
             'StatRuneNames',
             'RuneNames',
-            'RuneTreeHSets',
+            'RuneHSets',
             'StatRuneHSets',
         ],
     });

package/core/constants/Continents.d.ts

@@ -0,0 +1,8 @@
+export declare const Continents: {
+    readonly AMERICAS: "AMERICAS";
+    readonly ASIA: "ASIA";
+    readonly EUROPE: "EUROPE";
+    readonly SEA: "SEA";
+};
+export type Continent = typeof Continents[keyof typeof Continents];
+export declare function isContinent(value: any): value is Continent;

package/core/constants/Continents.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isContinent = exports.Continents = void 0;
+exports.Continents = {
+    'AMERICAS': 'AMERICAS',
+    'ASIA': 'ASIA',
+    'EUROPE': 'EUROPE',
+    'SEA': 'SEA',
+};
+function isContinent(value) {
+    return typeof value == 'string' && value in exports.Continents;
+}
+exports.isContinent = isContinent;

package/core/constants/DataDragonUrls.d.ts

@@ -26,6 +26,14 @@ export declare const DataDragonUrls: {
      * Append with `/1001.png` (`/{itemId}.png`).
      */
     readonly ITEM_ICON_BASE: `${string}/img/item`;
+    /**
+     * Append with `/MonkeyKing.json` (`/{championId}.json`).
+     */
+    readonly CHAMPION_BASE: `${string}/data/en_US/champion`;
+    readonly CHAMPION: `${string}/data/en_US/champion.json`;
+    readonly ITEM: `${string}/data/en_US/item.json`;
+    readonly RUNES_REFORGED: `${string}/data/en_US/runesReforged.json`;
+    readonly SUMMONER: `${string}/data/en_US/summoner.json`;
     /**
      * @see https://raw.communitydragon.org/latest/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/statmods
      */
@@ -34,5 +42,8 @@ export declare const DataDragonUrls: {
      * @see https://raw.communitydragon.org/latest/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/styles
      */
     readonly TREE_RUNE_ICON_BASE: `${string}/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/styles`;
+    /**
+     * @see https://raw.communitydragon.org/latest/plugins/rcp-fe-lol-static-assets/global/default/svg
+     */
     readonly POSITION_ICON_BASE: `${string}/plugins/rcp-fe-lol-static-assets/global/default/svg`;
 };

package/core/constants/DataDragonUrls.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataDragonUrls = void 0;
 const version = '13.10.1';
-const base = `https://ddragon.leagueoflegends.com/cdn/${version}`;
 const cdragonVersion = '13.10';
+const base = `https://ddragon.leagueoflegends.com/cdn/${version}`;
 const cdragonBase = `https://raw.communitydragon.org/${cdragonVersion}`;
+const locale = 'en_US';
 /**
  * Data Dragon CDN Paths.
  */
@@ -33,6 +34,14 @@ exports.DataDragonUrls = {
      * Append with `/1001.png` (`/{itemId}.png`).
      */
     ITEM_ICON_BASE: `${base}/img/item`,
+    /**
+     * Append with `/MonkeyKing.json` (`/{championId}.json`).
+     */
+    CHAMPION_BASE: `${base}/data/${locale}/champion`,
+    CHAMPION: `${base}/data/${locale}/champion.json`,
+    ITEM: `${base}/data/${locale}/item.json`,
+    RUNES_REFORGED: `${base}/data/${locale}/runesReforged.json`,
+    SUMMONER: `${base}/data/${locale}/summoner.json`,
     /**
      * @see https://raw.communitydragon.org/latest/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/statmods
      */
@@ -41,5 +50,8 @@ exports.DataDragonUrls = {
      * @see https://raw.communitydragon.org/latest/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/styles
      */
     TREE_RUNE_ICON_BASE: `${cdragonBase}/plugins/rcp-be-lol-game-data/global/default/v1/perk-images/styles`,
+    /**
+     * @see https://raw.communitydragon.org/latest/plugins/rcp-fe-lol-static-assets/global/default/svg
+     */
     POSITION_ICON_BASE: `${cdragonBase}/plugins/rcp-fe-lol-static-assets/global/default/svg`,
 };

package/core/constants/Locales.d.ts

@@ -1,31 +1,59 @@
 export declare const Locales: {
+    /** Czech (Czech Republic) */
     readonly cs_CZ: "cs_CZ";
+    /** Greek (Greece) */
     readonly el_GR: "el_GR";
+    /** Polish (Poland) */
     readonly pl_PL: "pl_PL";
+    /** Romanian (Romania) */
     readonly ro_RO: "ro_RO";
+    /** Hungarian (Hungary) */
     readonly hu_HU: "hu_HU";
+    /** English (United Kingdom) */
     readonly en_GB: "en_GB";
+    /** German (Germany) */
     readonly de_DE: "de_DE";
+    /** Spanish (Spain) */
     readonly es_ES: "es_ES";
+    /** Italian (Italy) */
     readonly it_IT: "it_IT";
+    /** French (France) */
     readonly fr_FR: "fr_FR";
+    /** Japanese (Japan) */
     readonly ja_JP: "ja_JP";
+    /** Korean (Korea) */
     readonly ko_KR: "ko_KR";
+    /** Spanish (Mexico) */
     readonly es_MX: "es_MX";
+    /** Spanish (Argentina) */
     readonly es_AR: "es_AR";
+    /** Portuguese (Brazil) */
     readonly pt_BR: "pt_BR";
+    /** English (United States) */
     readonly en_US: "en_US";
+    /** English (Australia) */
     readonly en_AU: "en_AU";
+    /** Russian (Russia) */
     readonly ru_RU: "ru_RU";
+    /** Turkish (Turkey) */
     readonly tr_TR: "tr_TR";
+    /** Malay (Malaysia) */
     readonly ms_MY: "ms_MY";
+    /** English (Republic of the Philippines) */
     readonly en_PH: "en_PH";
+    /** English (Singapore) */
     readonly en_SG: "en_SG";
+    /** Thai (Thailand) */
     readonly th_TH: "th_TH";
-    readonly vn_VN: "vn_VN";
+    /** Vietnamese (Viet Nam) */
+    readonly vi_VN: "vi_VN";
+    /** Indonesian (Indonesia) */
     readonly id_ID: "id_ID";
+    /** Chinese (Malaysia) */
     readonly zh_MY: "zh_MY";
+    /** Chinese (China) */
     readonly zh_CN: "zh_CN";
+    /** Chinese (Taiwan) */
     readonly zh_TW: "zh_TW";
 };
 export type Locale = typeof Locales[keyof typeof Locales];

package/core/constants/Locales.js

@@ -2,33 +2,61 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLocale = exports.Locales = void 0;
 exports.Locales = {
+    /** Czech (Czech Republic) */
     'cs_CZ': 'cs_CZ',
+    /** Greek (Greece) */
     'el_GR': 'el_GR',
+    /** Polish (Poland) */
     'pl_PL': 'pl_PL',
+    /** Romanian (Romania) */
     'ro_RO': 'ro_RO',
+    /** Hungarian (Hungary) */
     'hu_HU': 'hu_HU',
+    /** English (United Kingdom) */
     'en_GB': 'en_GB',
+    /** German (Germany) */
     'de_DE': 'de_DE',
+    /** Spanish (Spain) */
     'es_ES': 'es_ES',
+    /** Italian (Italy) */
     'it_IT': 'it_IT',
+    /** French (France) */
     'fr_FR': 'fr_FR',
+    /** Japanese (Japan) */
     'ja_JP': 'ja_JP',
+    /** Korean (Korea) */
     'ko_KR': 'ko_KR',
+    /** Spanish (Mexico) */
     'es_MX': 'es_MX',
+    /** Spanish (Argentina) */
     'es_AR': 'es_AR',
+    /** Portuguese (Brazil) */
     'pt_BR': 'pt_BR',
+    /** English (United States) */
     'en_US': 'en_US',
+    /** English (Australia) */
     'en_AU': 'en_AU',
+    /** Russian (Russia) */
     'ru_RU': 'ru_RU',
+    /** Turkish (Turkey) */
     'tr_TR': 'tr_TR',
+    /** Malay (Malaysia) */
     'ms_MY': 'ms_MY',
+    /** English (Republic of the Philippines) */
     'en_PH': 'en_PH',
+    /** English (Singapore) */
     'en_SG': 'en_SG',
+    /** Thai (Thailand) */
     'th_TH': 'th_TH',
-    'vn_VN': 'vn_VN',
+    /** Vietnamese (Viet Nam) */
+    'vi_VN': 'vi_VN',
+    /** Indonesian (Indonesia) */
     'id_ID': 'id_ID',
+    /** Chinese (Malaysia) */
     'zh_MY': 'zh_MY',
+    /** Chinese (China) */
     'zh_CN': 'zh_CN',
+    /** Chinese (Taiwan) */
     'zh_TW': 'zh_TW',
 };
 function isLocale(value) {

package/core/constants/MapIds.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 11 — Summoner's Rift
+ *
+ * 12 — Howling Abyss
+ *
+ * 21 — Nexus Blitz
+ *
+ * 22 — Convergence
+ */
+export declare const MapIds: {
+    readonly 11: 11;
+    readonly 12: 12;
+    readonly 21: 21;
+    readonly 22: 22;
+};
+export type MapId = typeof MapIds[keyof typeof MapIds];
+export declare function isMapId(value: number): value is MapId;

package/core/constants/MapIds.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMapId = exports.MapIds = void 0;
+/**
+ * 11 — Summoner's Rift
+ *
+ * 12 — Howling Abyss
+ *
+ * 21 — Nexus Blitz
+ *
+ * 22 — Convergence
+ */
+exports.MapIds = {
+    11: 11,
+    12: 12,
+    21: 21,
+    22: 22,
+};
+function isMapId(value) {
+    return value in exports.MapIds;
+}
+exports.isMapId = isMapId;

package/core/constants/ParticipantIds.d.ts

@@ -0,0 +1,14 @@
+export declare const ParticipantIds: {
+    readonly 1: 1;
+    readonly 2: 2;
+    readonly 3: 3;
+    readonly 4: 4;
+    readonly 5: 5;
+    readonly 6: 6;
+    readonly 7: 7;
+    readonly 8: 8;
+    readonly 9: 9;
+    readonly 10: 10;
+};
+export type ParticipantId = typeof ParticipantIds[keyof typeof ParticipantIds];
+export declare function isParticipantId(value: number): value is ParticipantId;

package/core/constants/ParticipantIds.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isParticipantId = exports.ParticipantIds = void 0;
+exports.ParticipantIds = {
+    1: 1,
+    2: 2,
+    3: 3,
+    4: 4,
+    5: 5,
+    6: 6,
+    7: 7,
+    8: 8,
+    9: 9,
+    10: 10,
+};
+function isParticipantId(value) {
+    return value in exports.ParticipantIds;
+}
+exports.isParticipantId = isParticipantId;