lol-constants 2.4.0 → 2.6.0

package/core/types/types.d.ts

@@ -1,151 +1,268 @@
 import { RuneSets } from '../constants/Runes/RuneSets';
 import { RuneSetsByRuneNames } from '../constants/Runes/RuneSetsByRuneNames';
+import { RuneSetsByRuneNamesNum } from '../constants/Runes/RuneSetsByRuneNamesNum';
 import { RuneTreeName } from '../constants/Runes/RuneTreeNames';
 import { RuneTreeType } from '../constants/Runes/RuneTreeTypes';
 /**
- * 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
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `NonStatRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
  *
- * 1020 — One for All games
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionRuneId`,
+ * -  `DominationRuneId`,
+ * -  `SorceryRuneId`,
+ * -  `ResolveRuneId`,
+ * -  `InspirationRuneId`.
  *
- * 1090 — Teamfight Tactics games
+ * There are 6 numerical Rune ID types:
+ * -  `KeystoneRuneIdNum`,
+ * -  `PrecisionRuneIdNum`,
+ * -  `DominationRuneIdNum`,
+ * -  `SorceryRuneIdNum`,
+ * -  `ResolveRuneIdNum`,
+ * -  `InspirationRuneIdNum`.
+ */
+export type KeystoneRuneId = keyof typeof RuneSets.KeystoneNames;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `NonStatRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
  *
- * 1100 — Ranked Teamfight Tactics games
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionRuneId`,
+ * -  `DominationRuneId`,
+ * -  `SorceryRuneId`,
+ * -  `ResolveRuneId`,
+ * -  `InspirationRuneId`.
  *
- * 1110 — Teamfight Tactics Tutorial games
+ * There are 6 numerical Rune ID types:
+ * -  `KeystoneRuneIdNum`,
+ * -  `PrecisionRuneIdNum`,
+ * -  `DominationRuneIdNum`,
+ * -  `SorceryRuneIdNum`,
+ * -  `ResolveRuneIdNum`,
+ * -  `InspirationRuneIdNum`.
+ */
+export type KeystoneRuneIdNum = typeof RuneSetsByRuneNamesNum.KeystoneIdsNum[keyof typeof RuneSetsByRuneNamesNum.KeystoneIdsNum];
+export type KeystoneRuneName = keyof typeof RuneSetsByRuneNames.KeystoneIds;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `NonStatRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
  *
- * 1111 — Teamfight Tactics test games
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionRuneId`,
+ * -  `DominationRuneId`,
+ * -  `SorceryRuneId`,
+ * -  `ResolveRuneId`,
+ * -  `InspirationRuneId`.
  *
- * 1300 — Nexus Blitz games
+ * There are 6 numerical Rune ID types:
+ * -  `KeystoneRuneIdNum`,
+ * -  `PrecisionRuneIdNum`,
+ * -  `DominationRuneIdNum`,
+ * -  `SorceryRuneIdNum`,
+ * -  `ResolveRuneIdNum`,
+ * -  `InspirationRuneIdNum`.
+ */
+export type PrecisionRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Precision;
+/**
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `NonStatRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
  *
- * 1400 — Ultimate Spellbook games
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionRuneId`,
+ * -  `DominationRuneId`,
+ * -  `SorceryRuneId`,
+ * -  `ResolveRuneId`,
+ * -  `InspirationRuneId`.
  *
- * 1900 — Pick URF games
+ * There are 6 numerical Rune ID types:
+ * -  `KeystoneRuneIdNum`,
+ * -  `PrecisionRuneIdNum`,
+ * -  `DominationRuneIdNum`,
+ * -  `SorceryRuneIdNum`,
+ * -  `ResolveRuneIdNum`,
+ * -  `InspirationRuneIdNum`.
  */
-export type QueueId = 0 | 400 | 420 | 430 | 440 | 450 | 700 | 900 | 920 | 1020 | 1090 | 1100 | 1110 | 1111 | 1300 | 1400 | 1900;
+export type PrecisionRuneIdNum = typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Precision[keyof typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Precision];
+export type PrecisionRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Precision;
 /**
- * 11 — Summoner's Rift
- *
- * 12 — Howling Abyss
+ * There are 3 main Rune ID types:
+ * -  `RuneId` (all),
+ * -  `NonStatRuneId` (all but stat runes),
+ * -  `StatRuneId` (only stat runes).
  *
- * 21 — Nexus Blitz
+ * There are 6 more specific Rune ID types as well:
+ * -  `KeystoneRuneId`,
+ * -  `PrecisionRuneId`,
+ * -  `DominationRuneId`,
+ * -  `SorceryRuneId`,
+ * -  `ResolveRuneId`,
+ * -  `InspirationRuneId`.
  *
- * 22 — Convergence
+ * There are 6 numerical Rune ID types:
+ * -  `KeystoneRuneIdNum`,
+ * -  `PrecisionRuneIdNum`,
+ * -  `DominationRuneIdNum`,
+ * -  `SorceryRuneIdNum`,
+ * -  `ResolveRuneIdNum`,
+ * -  `InspirationRuneIdNum`.
  */
-export type MapId = 11 | 12 | 21 | 22;
-export type TeamId = 100 | 200;
-export type ParticipantId = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+export type DominationRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Domination;
 /**
  * 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`.
  */
-export type KeystoneRuneId = keyof typeof RuneSets.KeystoneNames;
-export type KeystoneRuneName = keyof typeof RuneSetsByRuneNames.KeystoneIds;
+export type DominationRuneIdNum = typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Domination[keyof typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Domination];
+export type DominationRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Domination;
 /**
  * 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`.
  */
-export type PrecisionTreeRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Precision;
-export type PrecisionTreeRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Precision;
+export type SorceryRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Sorcery;
+export type SorceryRuneIdNum = typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Sorcery[keyof typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Sorcery];
+export type SorceryRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Sorcery;
 /**
  * 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`.
  */
-export type DominationTreeRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Domination;
-export type DominationTreeRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Domination;
+export type ResolveRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Resolve;
 /**
  * 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`.
  */
-export type SorceryTreeRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Sorcery;
-export type SorceryTreeRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Sorcery;
+export type ResolveRuneIdNum = typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Resolve[keyof typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Resolve];
+export type ResolveRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Resolve;
 /**
  * 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`.
  */
-export type ResolveTreeRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Resolve;
-export type ResolveTreeRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Resolve;
+export type InspirationRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Inspiration;
 /**
  * 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`.
  */
-export type InspirationTreeRuneId = keyof typeof RuneSets.PrimaryRuneTrees.Inspiration;
-export type InspirationTreeRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Inspiration;
+export type InspirationRuneIdNum = typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Inspiration[keyof typeof RuneSetsByRuneNamesNum.PrimaryRuneTreesByRuneNamesNum.Inspiration];
+export type InspirationRuneName = keyof typeof RuneSetsByRuneNames.PrimaryRuneTreesByRuneNames.Inspiration;
 export type StatRunesCategory = 'StatRunes';
 export type RuneSection = RuneTreeType | StatRunesCategory;
 export type RuneCategory = RuneTreeName | StatRunesCategory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lol-constants",
-  "version": "2.4.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",