lol-constants 2.10.0 → 2.11.0

package/README.md

@@ -1,6 +1,7 @@
-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), [`QueueType`](src/core/constants/QueueTypes.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).
+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), [`QueueType`](src/core/constants/QueueTypes.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: [`DataDragonUrls`](src/core/constants/DataDragonUrls.ts), [`PlatformApiUris`](src/core/constants/PlatformApiUris.ts), [`RegionalApiUris`](src/core/constants/RegionalApiUris.ts).
 
 Advantages:
+- Types
 - 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
@@ -8,8 +9,20 @@ Advantages:
 # Champions
 | constants | types | getters | type-validators
 | --- | --- | --- | --- |
-| `ChampionIds`, `ChampionIdsByName`, `ChampionKeys`, `ChampionKeysNum`, `ChampionNames` | `ChampionId`, `ChampionKey`, `ChampionKeyNum`, `ChampionName` | `getChampionIdByKey`, `getChampionIdByName`, `getChampionKeyById`, `getChampionKeyByName`, `getChampionNameById`, `getChampionNameByKey` | `isChampionId`, `isChampionKey`, `isChampionKeyNum`, `isChampionName`
+`ChampionIds`, `ChampionIdsByName`, `ChampionKeys`, `ChampionKeysNum`, `ChampionNames` | `ChampionId`, `ChampionKey`, `ChampionKeyNum`, `ChampionName` | `getChampionIdByKey`, `getChampionIdByName`, `getChampionKeyById`, `getChampionKeyByName`, `getChampionNameById`, `getChampionNameByKey` | `isChampionId`, `isChampionKey`, `isChampionKeyNum`, `isChampionName`
 # Items
+| constants | types | getters | type-validators
+| --- | --- | --- | --- |
+`BootsItemKeys`, `BootsItemKeysNum`, `BootsItemNames`, `ItemKeys`, `ItemKeysNum`, `ItemNames`, `ItemTypes`, `LegendaryItemKeys`, `LegendaryItemKeysNum`, `LegendaryItemNames`, `MythicItemKeys`, `MythicItemKeysNum`, `MythicItemNames`, `OrnnItemKeys`, `OrnnItemKeysNum`, `OrnnItemNames` | `BootsItemKey`, `BootsItemKeyNum`, `BootsItemName`, `ItemKey`, `ItemKeyNum`, `ItemName`, `ItemType`, `LegendaryItemKey`, `LegendaryItemKeyNum`, `LegendaryItemName`, `MythicItemKey`, `MythicItemKeyNum`, `MythicItemName`, `OrnnItemKey`, `OrnnItemKeyNum`, `OrnnItemName` | `getItemKeyByName`, `getItemNameByKey` | `isBootsItemKey`, `isBootsItemKeyNum`, `isBootsItemName`, `isItemKey`, `isItemKeyNum`, `isItemName`, `isItemType`, `isLegendaryItemKey`, `isLegendaryItemKeyNum`, `isLegendaryItemName`, `isMythicItemKey`, `isMythicItemKeyNum`, `isMythicItemName`, `isOrnnItemKey`, `isOrnnItemKeyNum`, `isOrnnItemName`
 # Runes
+| constants | types | getters | type-validators
+| --- | --- | --- | --- |
+`KeystoneIds`, `KeystoneIdsNum`, `KeystoneNames`, `NonStatRuneIds`, `NonStatRuneIdsNum`, `NonStatRuneNames`, `PrimaryRuneTrees`, `PrimaryRuneTreesByRuneNames`, `PrimaryRuneTreesByRuneNamesNum`, `RuneHSets`, `RuneHSetsByRuneNames`, `RuneHSetsByRuneNamesNum`, `RuneIconFileNames`, `RuneIds`, `RuneIdsNum`, `RuneNames`, `RunePickingRelationships`, `RuneSets`, `RuneSetsByRuneNames`, `RuneSetsByRuneNamesNum`, `RuneTreeIds`, `RuneTreeIdsNum`, `RuneTreeNames`, `RuneTreeTypes`, `SecondaryRuneTrees`, `SecondaryRuneTreesByRuneNames`, `SecondaryRuneTreesByRuneNamesNum`, `StatRuneHSets`, `StatRuneHSetsByRuneNames`, `StatRuneHSetsByRuneNamesNum`, `StatRuneIds`, `StatRuneIdsNum`, `StatRuneNames` | `NonStatRuneId`, `NonStatRuneIdNum`, `NonStatRuneName`, `RuneIconFile`, `RuneId`, `RuneIdNum`, `RuneName`, `RuneTreeId`, `RuneTreeIdNum`, `RuneTreeName`, `RuneTreeType`, `StatRuneId`, `StatRuneIdNum`, `StatRuneName` | `getNonStatRuneIdByName`, `getNonStatRuneNameById`, `getRuneCategoryName`, `getRuneCdnUrl`, `getRuneIdByName`, `getRuneNameById`, `getRuneTreeIdByName`, `getRuneTreeIdNumByName`, `getRuneTreeNameById`, `getStatRuneIdByName`, `getStatRuneNameById` | `isDominationRuneId`, `isDominationRuneIdNum`, `isDominationRuneName`, `isInspirationRuneId`, `isInspirationRuneIdNum`, `isInspirationRuneName`, `isKeystoneRuneId`, `isKeystoneRuneIdNum`, `isKeystoneRuneName`, `isNonStatRuneId`, `isNonStatRuneIdNum`, `isNonStatRuneName`, `isPrecisionRuneId`, `isPrecisionRuneIdNum`, `isPrecisionRuneName`, `isResolveRuneId`, `isResolveRuneIdNum`, `isResolveRuneName`, `isRuneId`, `isRuneIdNum`, `isRuneName`, `isRuneTreeId`, `isRuneTreeIdNum`, `isRuneTreeName`, `isRuneTreeType`, `isSorceryRuneId`, `isSorceryRuneIdNum`, `isSorceryRuneName`, `isStatRuneId`, `isStatRuneIdNum`, `isStatRuneName`
 # Summoner spells
+| constants | types | getters | type-validators
+| --- | --- | --- | --- |
+`SpellIds`, `SpellIdsByName`, `SpellKeys`, `SpellKeysNum`, `SpellNames` | `SpellId`, `SpellKey`, `SpellKeyNum`, `SpellName` | `getSpellIdByKey`, `getSpellIdByName`, `getSpellKeyById`, `getSpellKeyByName`, `getSpellNameById`, `getSpellNameByKey` | `isSpellId`, `isSpellKey`, `isSpellKeyNum`, `isSpellName`
 # Other
+| constants | types | type-validators
+| --- | --- | --- |
+`BuildingTypes`, `Continents`, `DataDragonUrls`, `DragonTypes`, `GameModes`, `GameTypes`, `KillTypes`, `Lanes`, `LaneTypes`, `Levels`, `Locales`, `MapIds`, `MonsterTypes`, `ParticipantIds`, `PlatformApiUris`, `PlatformIds`, `Positions`, `QueueDescriptions:`, `QueueIds`, `QueueTypes`, `RankedRanks`, `RankedTiers`, `RegionalApiUris`, `Regions`, `RelativeTeams`, `Roles`, `Skills`, `SkillSlots`, `TeamIds`, `TowerTypes`, `WardTypes` | `BuildingType`, `Continent`, `DragonType`, `GameMode`, `GameType`, `KillType`, `Lane`, `LaneType`, `Level`, `Locale`, `MapId`, `MonsterType`, `ParticipantId`, `PlatformApiUri`, `PlatformId`, `Position`, `QueueId`, `QueueType`, `RankedRank`, `RankedTier`, `RegionalApiUri`, `Region`, `RelativeTeam`, `Role`, `Skill`, `SkillSlot`, `TeamId`, `TowerType`, `WardType` | `isBuildingType`, `isContinent`, `isDragonType`, `isGameMode`, `isGameType`, `isKillType`, `isLane`, `isLaneType`, `isLevel`, `isLocale`, `isMapId`, `isMonsterType`, `isParticipantId`, `isPlatformApiUri`, `isPlatformId`, `getPlatformIdByRegion`, `isPosition`, `isQueueId`, `isQueueType`, `isRankedRank`, `isRankedTier`, `isRegionalApiUri`, `isRegion`, `getRegionByPlatformId`, `isRelativeTeam`, `isRole`, `isSkill`, `isSkillSlot`, `isTeamId`, `isTowerType`, `isWardType`

package/assets/scripts/print-file-names.d.ts

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

package/assets/scripts/print-file-names.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("fs/promises");
+const folders1 = [
+    'constants',
+    'helpers',
+];
+const folders2 = [
+    'Champions',
+    'Items',
+    'Runes',
+    'Spells',
+];
+// TEMP
+// async function getConstantNames() {
+//   const product: {
+//     [folder1: string]: {
+//       [folder2: string]: string
+//     }
+//   } = {}
+//   async function getFileNames(dir: string): Promise<string> {
+//     const fileNames = await readdir(dir)
+//     // Remove `.ts` extension
+//     const modifiedFileNames = fileNames
+//       .map(name => name.slice(0, name.indexOf('.ts')))
+//       .join('`, `')
+//     return '`' + modifiedFileNames + '`'
+//   }
+//   for (const folder1 of folders1) {
+//     if (product[folder1] == null) product[folder1] = {}
+//     for (const folder2 of folders2) {
+//       const fileNamesSt = await getFileNames(`src/core/${folder1}/${folder2}`)
+//       product[folder1]![folder2] = fileNamesSt
+//     }
+//   }
+//   return product
+// }
+function getVariableNamesFromFileContents(contents, exportStatement, endingCharacter) {
+    const typeNames = [];
+    let exportIndex = 0;
+    while ((exportIndex = contents.indexOf(exportStatement, exportIndex)) != -1) {
+        const typeNameIndex = exportIndex + (exportStatement + ' ').length;
+        const typeNameEndIndex = contents.indexOf(endingCharacter, typeNameIndex);
+        const typeName = contents.slice(typeNameIndex, typeNameEndIndex);
+        typeNames.push(typeName);
+        exportIndex = typeNameEndIndex;
+    }
+    return typeNames;
+}
+async function getVariableNames(exportStatement, endingCharacter) {
+    exportStatement = exportStatement.trim();
+    const workspace = {};
+    const product = {};
+    for (const folder1 of folders1) {
+        for (const folder2 of folders2) {
+            if (workspace[folder2] == null)
+                workspace[folder2] = [];
+            const base = `src/core/${folder1}/${folder2}`;
+            const fileNames = await (0, promises_1.readdir)(base);
+            for (const fileName of fileNames) {
+                const contents = await (0, promises_1.readFile)(`${base}/${fileName}`, { encoding: 'utf-8' });
+                workspace[folder2].push(...getVariableNamesFromFileContents(contents, exportStatement, endingCharacter));
+            }
+        }
+    }
+    // Finalize product
+    for (const folder2 in workspace) {
+        const variableNames = workspace[folder2];
+        variableNames.sort((a, b) => a.localeCompare(b));
+        product[folder2] = '`' + workspace[folder2].join('`, `') + '`';
+    }
+    return product;
+}
+function combineVariableGroupsForReadMeTable(obj) {
+    const product = {};
+    for (const folder2 of folders2) {
+        const groups = [];
+        for (let groupName in obj) {
+            groups.push(obj[groupName][folder2]);
+        }
+        product[folder2] = groups.join(' | ');
+    }
+    return product;
+}
+async function getOtherVariableInfo() {
+    const constants = [];
+    const types = [];
+    const functions = [];
+    const constantFileNames = (await (0, promises_1.readdir)('src/core/constants'))
+        .filter(fileName => fileName.includes('.ts'));
+    console.log('constantFileNames', constantFileNames); // TEMP
+    for (const fileName of constantFileNames) {
+        const contents = await (0, promises_1.readFile)(`src/core/constants/${fileName}`, { encoding: 'utf-8' });
+        constants.push(...getVariableNamesFromFileContents(contents, 'export const', ' '));
+        types.push(...getVariableNamesFromFileContents(contents, 'export type', ' '));
+        functions.push(...getVariableNamesFromFileContents(contents, 'export function', '('));
+    }
+    const constantsSt = '`' + constants.join('`, `') + '`';
+    const typesSt = '`' + types.join('`, `') + '`';
+    const functionsSt = '`' + functions.join('`, `') + '`';
+    return `${constantsSt} | ${typesSt} | ${functionsSt}`;
+}
+(async () => {
+    const constantNames = await getVariableNames('export const', ' ');
+    const typeNames = await getVariableNames('export type', ' ');
+    const functionNames = await getVariableNames('export function', '(');
+    const grouped = {
+        constants: constantNames,
+        types: typeNames,
+        functions: functionNames,
+    };
+    const product = combineVariableGroupsForReadMeTable(grouped);
+    console.log(product);
+    const otherVariableInfo = await getOtherVariableInfo();
+    console.log(otherVariableInfo);
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lol-constants",
-  "version": "2.10.0",
+  "version": "2.11.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",
@@ -12,6 +12,7 @@
   "scripts": {
     "build:clean": "rmdir /s /q core && rmdir /s /q assets && tsc",
     "generate": "node assets/scripts/generate-all",
+    "print-file-names": "node assets/scripts/print-file-names",
     "dev": "vite"
   },
   "devDependencies": {