lol-constants 2.5.0 → 2.6.0

package/README.md

@@ -1,16 +1,14 @@
-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).
+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`](src/core/constants/Champions/ChampionIds.ts), [`ChampionName`](src/core/constants/Champions/ChampionNames.ts), [`ItemKey`](src/core/constants/Items/ItemKeys.ts), [`RuneId`](src/core/constants/Runes/RuneSetsByRuneNames.ts#L55), [`SpellName`](src/core/constants/Spells/SpellNames.ts), [`Position`](src/core/constants/Positions.ts), [`Queue`](src/core/constants/Queues.ts), [`RankedTier`](src/core/constants/RankedTiers.ts), [`Region`](src/core/constants/Regions.ts) and more are provided. Certain URLs and URIs are available as constants as well in [`DataDragonUrls`](src/core/constants/DataDragonUrls.ts), [`PlatformApiUris`](src/core/constants/PlatformApiUris.ts), [`RegionalApiUris`](src/core/constants/RegionalApiUris.ts).
 
 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. -->
+- Four categories — champions, items, runes, summoner spells — are armed with getter functions that exchange between id–key–name such as [`getChampionNameByKey`](src/core/helpers/Champions/getChampionNameByKey.ts)–[`getChampionIdByName`](src/core/helpers/Champions/getChampionIdByName.ts)–[`getChampionKeyById`](src/core/helpers/Champions/getChampionKeyById.ts)
+- Types can be validated through type-validating functions such as [`isChampionName`](src/core/helpers/Champions/isChampionName.ts)
+- Type validation functions such as [`isChampionName`](src/core/helpers/Champions/isChampionName.ts) and getter functions such as [`getChampionNameByKey`](src/core/helpers/Champions/getChampionNameByKey.ts) are instantaneous $O(1)$ and do not iterate over many elements
 
 # Champions
-| constants | types | getters
-| --- | --- |
-| `ChampionIds`, `ChampionKeys` | `ChampionId`, `ChampionKey`, `ChampionKeyNum`, `ChampionName` | 
+| constants | types | getters | type-validators
+| --- | --- | --- | --- |
+| `ChampionIds`, `ChampionIdsByName`, `ChampionKeys`, `ChampionKeysNum`, `ChampionNames` | `ChampionId`, `ChampionKey`, `ChampionKeyNum`, `ChampionName` | `getChampionIdByKey`, `getChampionIdByName`, `getChampionKeyById`, `getChampionKeyByName`, `getChampionNameById`, `getChampionNameByKey` | `isChampionId`, `isChampionKey`, `isChampionKeyNum`, `isChampionName`
 # Items
 # Runes
 # Summoner spells

package/core/constants/DataDragonUrls.d.ts

@@ -2,6 +2,8 @@
  * Data Dragon CDN Paths.
  */
 export declare const DataDragonUrls: {
+    readonly DATA_DRAGON_BASE: string;
+    readonly COMMUNITY_DRAGON_BASE: string;
     /**
      * Append with `/MonkeyKing.png` (`/{championId}.png`).
      */

package/core/constants/DataDragonUrls.js

@@ -10,6 +10,8 @@ const locale = 'en_US';
  * Data Dragon CDN Paths.
  */
 exports.DataDragonUrls = {
+    DATA_DRAGON_BASE: base,
+    COMMUNITY_DRAGON_BASE: cdragonBase,
     /**
      * Append with `/MonkeyKing.png` (`/{championId}.png`).
      */

package/core/constants/QueueDescriptions.d.ts

@@ -0,0 +1,21 @@
+export declare const QueueDescriptions: {
+    readonly 0: "Custom";
+    readonly 400: "5v5 Draft Pick";
+    readonly 420: "5v5 Ranked Solo";
+    readonly 430: "5v5 Blind Pick";
+    readonly 440: "5v5 Ranked Flex";
+    readonly 450: "5v5 ARAM";
+    readonly 700: "Clash";
+    readonly 900: "ARURF";
+    readonly 920: "Legend of the Poro King";
+    readonly 1020: "One for All";
+    readonly 1090: "Teamfight Tactics";
+    readonly 1100: "Ranked Teamfight Tactics";
+    readonly 1110: "Teamfight Tactics Tutorial";
+    readonly 1111: "Teamfight Tactics test";
+    readonly 1300: "Nexus Blitz";
+    readonly 1400: "Ultimate Spellbook";
+    readonly 1900: "URF";
+};
+export type QueueDescription = typeof QueueDescriptions[keyof typeof QueueDescriptions];
+export declare function isQueueDescription(value: any): value is QueueDescription;

package/core/constants/QueueDescriptions.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isQueueDescription = exports.QueueDescriptions = void 0;
+exports.QueueDescriptions = {
+    0: 'Custom',
+    400: '5v5 Draft Pick',
+    420: '5v5 Ranked Solo',
+    430: '5v5 Blind Pick',
+    440: '5v5 Ranked Flex',
+    450: '5v5 ARAM',
+    700: 'Clash',
+    900: 'ARURF',
+    920: 'Legend of the Poro King',
+    1020: 'One for All',
+    1090: 'Teamfight Tactics',
+    1100: 'Ranked Teamfight Tactics',
+    1110: 'Teamfight Tactics Tutorial',
+    1111: 'Teamfight Tactics test',
+    1300: 'Nexus Blitz',
+    1400: 'Ultimate Spellbook',
+    1900: 'URF',
+};
+function isQueueDescription(value) {
+    return typeof value == 'string' && value in exports.QueueDescriptions;
+}
+exports.isQueueDescription = isQueueDescription;

package/core/index.d.ts

@@ -13,6 +13,8 @@ export * from './constants/MonsterTypes';
 export * from './constants/PlatformApiUris';
 export * from './constants/PlatformIds';
 export * from './constants/Positions';
+export * from './constants/QueueDescriptions';
+export * from './constants/QueueIds';
 export * from './constants/Queues';
 export * from './constants/RankedRanks';
 export * from './constants/RankedTiers';

package/core/index.js

@@ -30,6 +30,8 @@ __exportStar(require("./constants/MonsterTypes"), exports);
 __exportStar(require("./constants/PlatformApiUris"), exports);
 __exportStar(require("./constants/PlatformIds"), exports);
 __exportStar(require("./constants/Positions"), exports);
+__exportStar(require("./constants/QueueDescriptions"), exports);
+__exportStar(require("./constants/QueueIds"), exports);
 __exportStar(require("./constants/Queues"), exports);
 __exportStar(require("./constants/RankedRanks"), exports);
 __exportStar(require("./constants/RankedTiers"), exports);

package/package.json

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