lol-constants 1.0.2 → 1.2.0

package/assets/scripts/Helpers/enableSpreadValues.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Basically a modified `JSON.stringify()` function.
+ *
+ * Assumes that what you're trying to do is simply "escape" the value
+ * of a key in `keysToSpread`, clearing it away from:
+ * -  its own key and its 2 quotation marks `"` and its colon `:`,
+ * -  the 2 quotation marks `"` around the value.
+ *
+ * This way enabling the spreading of a Constant into the end object.
+ * Example:
+ * `{"key":"...ConstantValue"} => {...ConstantValue}`
+ */
+export declare function enableSpreadValues(obj: {
+    [k: string]: any;
+}, keysToSpread: (string | number)[]): string;

package/assets/scripts/Helpers/enableSpreadValues.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableSpreadValues = void 0;
+/**
+ * Basically a modified `JSON.stringify()` function.
+ *
+ * Assumes that what you're trying to do is simply "escape" the value
+ * of a key in `keysToSpread`, clearing it away from:
+ * -  its own key and its 2 quotation marks `"` and its colon `:`,
+ * -  the 2 quotation marks `"` around the value.
+ *
+ * This way enabling the spreading of a Constant into the end object.
+ * Example:
+ * `{"key":"...ConstantValue"} => {...ConstantValue}`
+ */
+function enableSpreadValues(obj, keysToSpread) {
+    let json = JSON.stringify(obj);
+    for (let key of keysToSpread) {
+        const stringifiedKey = `"${key}":`;
+        let stKeyIdx = json.indexOf(stringifiedKey);
+        // Skip if for whatever reason not found
+        if (stKeyIdx == -1)
+            continue;
+        // Remove the key with its 2 quotation marks and colon
+        json =
+            json.slice(0, stKeyIdx)
+                + json.slice(stKeyIdx + stringifiedKey.length);
+        // Remove the next 2 quotation marks for supposed spread value
+        for (let i = 0; i < 2; ++i) {
+            const idxToRemove = json.indexOf('"', stKeyIdx);
+            json =
+                json.slice(0, idxToRemove)
+                    + json.slice(idxToRemove + 1);
+        }
+    }
+    return json;
+}
+exports.enableSpreadValues = enableSpreadValues;

package/assets/scripts/Helpers/getExportStatement.d.ts

@@ -3,4 +3,4 @@
  */
 export declare function getExportStatement(constName: string, json: {
     [k: string]: any;
-}): string;
+}, keysToSpread?: (string | number)[], comment?: string): string;

package/assets/scripts/Helpers/getExportStatement.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getExportStatement = void 0;
+const enableSpreadValues_1 = require("./enableSpreadValues");
+const getFmtdComment_1 = require("./getFmtdComment");
 /**
  * Wraps the provided JSON in a TS export-as-const statement.
  */
-function getExportStatement(constName, json) {
-    return `export const ${constName} = ${JSON.stringify(json)} as const`;
+function getExportStatement(constName, json, keysToSpread, comment) {
+    const stringifiedJson = keysToSpread
+        ? (0, enableSpreadValues_1.enableSpreadValues)(json, keysToSpread)
+        : JSON.stringify(json);
+    const fmtdComment = comment ? (0, getFmtdComment_1.getFmtdComment)(comment) : '';
+    return fmtdComment + `export const ${constName} = ${stringifiedJson} as const`;
 }
 exports.getExportStatement = getExportStatement;

package/assets/scripts/Helpers/getFmtdComment.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns a JavaScript-formatted comment,
+ * the kind you put on top of functions, for example.
+ */
+export declare function getFmtdComment(comment: string): string;

package/assets/scripts/Helpers/getFmtdComment.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFmtdComment = void 0;
+/**
+ * Returns a JavaScript-formatted comment,
+ * the kind you put on top of functions, for example.
+ */
+function getFmtdComment(comment) {
+    let st = '';
+    st += '/**\n';
+    st += ' * ' + comment + '\n';
+    st += ' */\n';
+    return st;
+}
+exports.getFmtdComment = getFmtdComment;

package/assets/scripts/Helpers/writeToTmpFile.d.ts

@@ -0,0 +1,8 @@
+export declare function writeToTmpFile(mainConstName: string, ...constants: {
+    constName: string;
+    comment?: string;
+    json: {
+        [k: string]: any;
+    };
+    keysToSpread?: (string | number)[];
+}[]): Promise<void>;

package/assets/scripts/Helpers/writeToTmpFile.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeToTmpFile = void 0;
+const fs_1 = require("fs");
+const getExportStatement_1 = require("./getExportStatement");
+function writeToTmpFile(mainConstName, ...constants) {
+    return new Promise((res, rej) => {
+        const exportStatements = constants.reduce((finalSt, { constName, comment, json, keysToSpread, }, i) => {
+            let exportStatement = (0, getExportStatement_1.getExportStatement)(constName, json, keysToSpread, comment);
+            return (finalSt
+                + exportStatement
+                // On last statement, provide only a single empty ending line
+                + (i + 1 == constants.length ? '\n' : '\n\n'));
+        }, '');
+        (0, fs_1.writeFile)(`tmp/${mainConstName}.ts`, exportStatements, err => {
+            if (err)
+                rej(err);
+            res();
+        });
+    });
+}
+exports.writeToTmpFile = writeToTmpFile;

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

@@ -6,6 +6,7 @@ import './generate-item-keys';
 import './generate-item-names';
 import './generate-rune-ids';
 import './generate-rune-names';
+import './generate-rune-sets';
 import './generate-spell-ids-by-name';
 import './generate-spell-ids';
 import './generate-spell-keys';

package/assets/scripts/generate-all.js

@@ -8,6 +8,7 @@ require("./generate-item-keys");
 require("./generate-item-names");
 require("./generate-rune-ids");
 require("./generate-rune-names");
+require("./generate-rune-sets");
 require("./generate-spell-ids-by-name");
 require("./generate-spell-ids");
 require("./generate-spell-keys");

package/assets/scripts/generate-rune-sets.d.ts

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

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

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const runesReforged_json_1 = __importDefault(require("../runesReforged.json"));
+const StatRunes_1 = require("../StatRunes");
+const writeToTmpFile_1 = require("./Helpers/writeToTmpFile");
+(async () => {
+    const constant = 'RuneSets';
+    const runeSets = {
+        PrimaryTrees: {},
+        SecondaryTrees: {},
+        Keystones: {},
+        StatRunes: {},
+    };
+    const keystoneHSetIdx = 0;
+    let totalRuneAmt = 0;
+    for (const runeTree of runesReforged_json_1.default) {
+        const runeTreeName = runeTree.name;
+        const horizontalSets = runeTree.slots;
+        let currentHSetIdx = 0;
+        for (const { runes, } of horizontalSets) {
+            for (let { id, name: runeName, } of runes) {
+                totalRuneAmt += 1;
+                // Add to PrimaryTrees
+                if (!(runeTreeName in runeSets.PrimaryTrees))
+                    runeSets.PrimaryTrees[runeTreeName] = {};
+                runeSets.PrimaryTrees[runeTreeName][id] = runeName;
+                // Add to SecondaryTrees
+                if (!(runeTreeName in runeSets.SecondaryTrees))
+                    runeSets.SecondaryTrees[runeTreeName] = {};
+                // But only if it isn't a keystone rune
+                if (currentHSetIdx != keystoneHSetIdx) {
+                    runeSets.SecondaryTrees[runeTreeName][id] = runeName;
+                }
+                // Add to Keystones
+                // But only if it is a keystone rune
+                if (currentHSetIdx == keystoneHSetIdx) {
+                    runeSets.Keystones[id] = runeName;
+                }
+            }
+            ++currentHSetIdx;
+        }
+    }
+    let statRuneId;
+    for (statRuneId in StatRunes_1.StatRunes) {
+        totalRuneAmt += 1;
+        // Add to StatRunes
+        runeSets.StatRunes[statRuneId] = StatRunes_1.StatRunes[statRuneId];
+    }
+    // Write to file
+    await (0, writeToTmpFile_1.writeToTmpFile)(constant, {
+        constName: 'PrimaryTrees',
+        json: runeSets.PrimaryTrees,
+    }, {
+        constName: 'SecondaryTrees',
+        json: runeSets.SecondaryTrees,
+    }, {
+        constName: 'Keystones',
+        json: runeSets.Keystones,
+    }, {
+        constName: 'StatRunes',
+        json: runeSets.StatRunes,
+    }, {
+        constName: 'All',
+        json: {
+            1: '...PrimaryTrees.Precision',
+            2: '...PrimaryTrees.Domination',
+            3: '...PrimaryTrees.Sorcery',
+            4: '...PrimaryTrees.Resolve',
+            5: '...PrimaryTrees.Inspiration',
+            6: '...StatRunes',
+        },
+        keysToSpread: [1, 2, 3, 4, 5, 6],
+    }, {
+        constName: 'RuneSets',
+        comment: `Contains all Rune IDs that are known to man in the game of League of Legends. Sorted by various useful categories. There are a total of ${totalRuneAmt} runes in the game.`,
+        json: {
+            'PrimaryTrees': 'PrimaryTrees',
+            'SecondaryTrees': 'SecondaryTrees',
+            'Keystones': 'Keystones',
+            'StatRunes': 'StatRunes',
+            'All': 'All',
+        },
+        keysToSpread: [
+            'PrimaryTrees',
+            'SecondaryTrees',
+            'Keystones',
+            'StatRunes',
+            'All',
+        ],
+    });
+})();

package/dist/Constants/Lanes.d.ts

@@ -0,0 +1,6 @@
+export declare const Lanes: {
+    readonly TOP: "TOP";
+    readonly JUNGLE: "JUNGLE";
+    readonly MIDDLE: "MIDDLE";
+    readonly BOTTOM: "BOTTOM";
+};

package/dist/Constants/Lanes.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Lanes = void 0;
+exports.Lanes = {
+    'TOP': 'TOP',
+    'JUNGLE': 'JUNGLE',
+    'MIDDLE': 'MIDDLE',
+    'BOTTOM': 'BOTTOM',
+};

package/dist/Constants/Levels.d.ts

@@ -0,0 +1,20 @@
+export declare const Levels: {
+    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;
+    readonly 11: 11;
+    readonly 12: 12;
+    readonly 13: 13;
+    readonly 14: 14;
+    readonly 15: 15;
+    readonly 16: 16;
+    readonly 17: 17;
+    readonly 18: 18;
+};

package/dist/Constants/Levels.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Levels = void 0;
+exports.Levels = {
+    1: 1,
+    2: 2,
+    3: 3,
+    4: 4,
+    5: 5,
+    6: 6,
+    7: 7,
+    8: 8,
+    9: 9,
+    10: 10,
+    11: 11,
+    12: 12,
+    13: 13,
+    14: 14,
+    15: 15,
+    16: 16,
+    17: 17,
+    18: 18,
+};

package/dist/Constants/Positions.d.ts

@@ -0,0 +1,7 @@
+export declare const Positions: {
+    readonly TOP: "TOP";
+    readonly JUNGLE: "JUNGLE";
+    readonly MIDDLE: "MIDDLE";
+    readonly BOTTOM: "BOTTOM";
+    readonly UTILITY: "UTILITY";
+};

package/dist/Constants/Positions.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Positions = void 0;
+exports.Positions = {
+    'TOP': 'TOP',
+    'JUNGLE': 'JUNGLE',
+    'MIDDLE': 'MIDDLE',
+    'BOTTOM': 'BOTTOM',
+    'UTILITY': 'UTILITY',
+};

package/dist/Constants/{RuneIds.d.ts → Runes/RuneIds.d.ts}

@@ -1,4 +1,13 @@
 export declare const RuneIds: {
+    readonly "Defense (HP)": "5001";
+    readonly "Defense (AR)": "5002";
+    readonly "Defense (MR)": "5003";
+    readonly "Offense (AS)": "5005";
+    readonly "Offense (AH)": "5007";
+    readonly "Offense (AF)": "5008";
+    readonly "Flex (AR)": "5002f";
+    readonly "Flex (MR)": "5003f";
+    readonly "Flex (AF)": "5008f";
     readonly Electrocute: "8112";
     readonly Predator: "8124";
     readonly "Dark Harvest": "8128";
@@ -62,13 +71,4 @@ export declare const RuneIds: {
     readonly Scorch: "8237";
     readonly Waterwalking: "8232";
     readonly "Gathering Storm": "8236";
-    readonly "Defense (HP)": "5001";
-    readonly "Defense (AR)": "5002";
-    readonly "Defense (MR)": "5003";
-    readonly "Offense (AS)": "5005";
-    readonly "Offense (AH)": "5007";
-    readonly "Offense (AF)": "5008";
-    readonly "Flex (AR)": "5002f";
-    readonly "Flex (MR)": "5003f";
-    readonly "Flex (AF)": "5008f";
 };

package/dist/Constants/Runes/RuneIds.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuneIds = void 0;
+const StatRuneIds_1 = require("./StatRuneIds");
+const TreeRuneIds_1 = require("./TreeRuneIds");
+exports.RuneIds = {
+    ...TreeRuneIds_1.TreeRuneIds,
+    ...StatRuneIds_1.StatRuneIds,
+};

package/dist/Constants/{RuneNames.d.ts → Runes/RuneNames.d.ts}

@@ -5,6 +5,9 @@ export declare const RuneNames: {
     readonly "5005": "Offense (AS)";
     readonly "5007": "Offense (AH)";
     readonly "5008": "Offense (AF)";
+    readonly "5002f": "Flex (AR)";
+    readonly "5003f": "Flex (MR)";
+    readonly "5008f": "Flex (AF)";
     readonly "8005": "Press the Attack";
     readonly "8008": "Lethal Tempo";
     readonly "8009": "Presence of Mind";
@@ -68,7 +71,4 @@ export declare const RuneNames: {
     readonly "9105": "Legend: Tenacity";
     readonly "9111": "Triumph";
     readonly "9923": "Hail of Blades";
-    readonly "5002f": "Flex (AR)";
-    readonly "5003f": "Flex (MR)";
-    readonly "5008f": "Flex (AF)";
 };

package/dist/Constants/Runes/RuneNames.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuneNames = void 0;
+const StatRuneNames_1 = require("./StatRuneNames");
+const TreeRuneNames_1 = require("./TreeRuneNames");
+exports.RuneNames = {
+    ...TreeRuneNames_1.TreeRuneNames,
+    ...StatRuneNames_1.StatRuneNames,
+};