lol-constants 3.0.0-rc.0 → 3.0.0-rc.2

package/README.md

@@ -4,9 +4,9 @@ Provides constants, helper functions, types (and type validator functions) for L
 In this library, you will find the main advantage to be: the ability to ‘convert’ between **Keys**, **IDs**, and **Names** of various game objects, namely champions, items, runes, and spells. Here's an example:
 
 ```typescript
-import {lol} from 'lol-constants'
+import {lol, ChampionName} from 'lol-constants'
 
-let championName = 'Wukong'
+let championName: ChampionName = 'Wukong'
 
 lol.champion.get(championName).id   // 62
 lol.champion.get(championName).key  // 'MonkeyKing'
@@ -19,23 +19,21 @@ import {getChampion} from 'lol-constants'
 getChampion(championName).id   // 62
 getChampion(championName).key  // 'MonkeyKing'
 getChampion(championName).name // 'Wukong'
-
 ```
 
 That's not all. Such a getter function is also designed to be able to accept not only names, but also keys and ids. Here's how:
 
 ```typescript
-import {getRune} from 'lol-constants'
+import {getRune, RuneName, RuneKey, RuneId} from 'lol-constants'
 
-let runeName = 'Cosmic Insight'
-let runeKey = 'CosmicInsight'
-let runeId = 8347
+let runeName: RuneName = 'Cosmic Insight'
+let runeKey: RuneKey = 'CosmicInsight'
+let runeId: RuneId = 8347
 
 getRune(runeName) // ..
 getRune(runeKey) // ..
 getRune(runeId) // ..
 // All return the same rune object: {id: 8347, key: 'CosmicInsight', name: 'Cosmic Insight', ...}
-
 ```
 
 This paradigm applies to **4** game areas: champions, items, runes (including stat runes and rune trees), and spells. Functions: `getChampion`, `getItem`, `getRune` (plus `getStatRune` and `getRuneTree`), and `getSpell`. Plus a few other areas.
@@ -124,7 +122,9 @@ More types can be found here: [examples/](./examples/)
 # Future plans
 Besides being an easy-to-update library with each League patch and to stay updated whenever a new patch does come out, there are several areas of interest for this library moving forward:
 + Provide tools (functions and such) for front-end work: getting icons and such.
-+ Enable total backwards compatibility with older patches (i.e. no missing items or something for last couple of patches, preferrably two years, which is the limit set by Riot API)
++ Enable total backwards compatibility with older patches (i.e. no missing items or something for last couple of patches, preferably two years, which is the limit set by Riot API)
 + Fulfill any missing types and constants within the context of Riot API. Perhaps provide interfaces for Riot API responses.
-+ More detailed champions, items, runes, and spells information. Would require creating an own database of those instead of relying on DataDragon.
++ More detailed champions, items, runes, and spells information. Would require using an own database of those instead of relying on DataDragon.
 + Optimized library size/splitting (currently library should be around ~100KB).
+
+So, why not give this library a star and see where it goes?

package/dist/helpers/item.d.ts

@@ -34,6 +34,6 @@ export declare function isTrinketItem(item_id_name: typeof ItemsArr[number] | It
 export declare function isBootsItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName): boolean;
 export declare function isConsumableItem(item_id_name: typeof ItemsArr[number] | ItemId | ItemName): boolean;
 /** Check whether item is available on a certain map. */
-export declare function isItemAvailableForMap(itemId: ItemId, mapId: MapId): boolean;
+export declare function isItemAvailableOnMap(itemId: ItemId, mapId: MapId): boolean;
 export declare function isItemId(id: number | null | undefined): id is ItemId;
 export declare function isItemName(name: string | null | undefined): name is ItemName;

package/dist/helpers/item.js

@@ -99,7 +99,7 @@ export function isConsumableItem(item_id_name) {
     return getItem(item_id_name).srType == ItemSrTypes.CONSUMABLE;
 }
 /** Check whether item is available on a certain map. */
-export function isItemAvailableForMap(itemId, mapId) {
+export function isItemAvailableOnMap(itemId, mapId) {
     const mapsObjOrItemId = itemNames[Items[itemId].name];
     if (typeof mapsObjOrItemId == 'number')
         return false; // Means item is disabled on all maps

package/dist/helpers/riotId.js

@@ -4,9 +4,10 @@ const maxRiotTaglineCharCount = 5;
 export function splitRiotId(riotId, 
 /** @default '#' */
 splitChar = '#') {
+    var _a, _b;
     const split = riotId.split(splitChar);
-    let name = split[0] ?? '';
-    let tag = split[1] ?? '';
+    let name = (_a = split[0]) !== null && _a !== void 0 ? _a : '';
+    let tag = (_b = split[1]) !== null && _b !== void 0 ? _b : '';
     if (tag.includes(splitChar))
         tag = '';
     return {

package/dist/index.d.ts

@@ -9,7 +9,7 @@ export * from './constants/participants';
 export { ItemSrTypes } from './enums/ItemSrTypes';
 export { StatRuneSlots } from './enums/StatRuneSlots';
 export { getChampion, isChampionId, isChampionKey, isChampionName, } from './helpers/champion';
-export { getItem, isStarterItem, isBasicItem, isEpicItem, isLegendaryItem, isTrinketItem, isBootsItem, isConsumableItem, isItemAvailableForMap, isItemId, isItemName, } from './helpers/item';
+export { getItem, isStarterItem, isBasicItem, isEpicItem, isLegendaryItem, isTrinketItem, isBootsItem, isConsumableItem, isItemAvailableOnMap, isItemId, isItemName, } from './helpers/item';
 export type { RiotId } from './helpers/riotId';
 export { makeRiotId, splitRiotId, validateRiotId, } from './helpers/riotId';
 export { getRune, getStatRune, getRuneTree, isRuneId, isRuneKey, isRuneName, isStatRuneId, isStatRuneName, isRuneTreeId, isRuneTreeKey, isRuneTreeName, } from './helpers/rune';

package/dist/index.js

@@ -13,7 +13,7 @@ export { ItemSrTypes } from './enums/ItemSrTypes';
 export { StatRuneSlots } from './enums/StatRuneSlots';
 // # helpers
 export { getChampion, isChampionId, isChampionKey, isChampionName, } from './helpers/champion';
-export { getItem, isStarterItem, isBasicItem, isEpicItem, isLegendaryItem, isTrinketItem, isBootsItem, isConsumableItem, isItemAvailableForMap, isItemId, isItemName, } from './helpers/item';
+export { getItem, isStarterItem, isBasicItem, isEpicItem, isLegendaryItem, isTrinketItem, isBootsItem, isConsumableItem, isItemAvailableOnMap, isItemId, isItemName, } from './helpers/item';
 export { makeRiotId, splitRiotId, validateRiotId, } from './helpers/riotId';
 export { getRune, getStatRune, getRuneTree, isRuneId, isRuneKey, isRuneName, isStatRuneId, isStatRuneName, isRuneTreeId, isRuneTreeKey, isRuneTreeName, } from './helpers/rune';
 export { getSpell, isSpellId, isSpellKey, isSpellName, } from './helpers/spell';

package/dist/lol.d.ts

@@ -5,13 +5,18 @@ import { isRankedRank, isRankedTier } from './constants/leagues';
 import { isLocale } from './constants/locales';
 import { isLane, isLaneType, isPosition, isRole, isTeamId } from './constants/participants';
 import { getChampion, isChampionId, isChampionKey, isChampionName } from './helpers/champion';
-import { getItem, isBasicItem, isBootsItem, isConsumableItem, isEpicItem, isItemAvailableForMap, isItemId, isItemName, isLegendaryItem, isStarterItem, isTrinketItem } from './helpers/item';
+import { getItem, isBasicItem, isBootsItem, isConsumableItem, isEpicItem, isItemAvailableOnMap, 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 } from './objects/Maps';
 import { getQueue, isQueueId, isQueueTitle } from './objects/Queues';
 import { getRegion, isPlatform, isRegion } from './objects/Regions';
+/**
+ * # `lol-constants`
+ * + [README](https://github.com/kd0010/lol-constants#readme)
+ * + [`lol` object and shorthand function examples](https://github.com/kd0010/lol-constants/blob/main/examples/examples-with-lol.ts)
+ */
 export declare const lol: {
     /**
      * ## Current patch version
@@ -3149,7 +3154,7 @@ export declare const lol: {
         isTrinket: typeof isTrinketItem;
         isBoots: typeof isBootsItem;
         isConsumable: typeof isConsumableItem;
-        isAvailable: typeof isItemAvailableForMap;
+        isAvailable: typeof isItemAvailableOnMap;
     };
     /** ## Runes, Stat Runes, and Rune Trees */
     rune: {

package/dist/lol.js

@@ -8,7 +8,7 @@ import { isLane, isLaneType, isPosition, isRole, isTeamId, Lanes, LaneTypes, Pos
 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 { getItem, isBasicItem, isBootsItem, isConsumableItem, isEpicItem, isItemAvailableOnMap, 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';
@@ -19,6 +19,11 @@ 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';
+/**
+ * # `lol-constants`
+ * + [README](https://github.com/kd0010/lol-constants#readme)
+ * + [`lol` object and shorthand function examples](https://github.com/kd0010/lol-constants/blob/main/examples/examples-with-lol.ts)
+ */
 export const lol = {
     /**
      * ## Current patch version
@@ -85,7 +90,7 @@ export const lol = {
         isTrinket: isTrinketItem,
         isBoots: isBootsItem,
         isConsumable: isConsumableItem,
-        isAvailable: isItemAvailableForMap,
+        isAvailable: isItemAvailableOnMap,
     },
     /** ## Runes, Stat Runes, and Rune Trees */
     rune: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lol-constants",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.2",
   "description": "League of Legends constants, functions, and types. Provides a plathera of functions to easily convert between ID, Name, and Key for champions, items, summoner spells, and runes.",
   "license": "MIT",
   "type": "module",
@@ -22,6 +22,17 @@
     "type": "git",
     "url": "git+https://github.com/kd0010/lol-constants.git"
   },
+  "keywords": [
+    "lol",
+    "league",
+    "leagueoflegends",
+    "riot",
+    "constants",
+    "types",
+    "api",
+    "typescript",
+    "ts"
+  ],
   "scripts": {
     "patch:update": "pnpm run scripts:pull && pnpm run scripts:generate && pnpm run build",
     "temp": "node --no-warnings --loader ts-node/esm dev/scripts/temp",