Utilize type alias StringifiedIdentifier where applicable, rename Game properties, and rename certain handler methods

Author: FifthTundraG

src/ts/handler.ts

@@ -1,6 +1,6 @@
 export class Handler<T> implements Iterable<T> {
     /** This stores the stringified Identifier as the key and then the values is obviously T. We store the identifier stringified because objects are never equal so we can't `get()` from the Map without using the same obj reference. */
-    protected registered: Map<string, T>;
+    protected registered: Map<StringifiedIdentifier, T>;
     /** the number of registered items in the handler */
     public get length(): number {
         return this.registered.size;
@@ -11,7 +11,7 @@ export class Handler<T> implements Iterable<T> {
     }
 
     register(identifier: Identifier, object: T) {
-        const stringifiedIdentifier = identifier.toString();
+        const stringifiedIdentifier: StringifiedIdentifier = identifier.toString();
         if (this.registered.has(stringifiedIdentifier) !== false) {
             console.error(`Tried to register object with Identifier "${identifier.toString()}" to a Handler, but it already exists!`);
             // todo ASAP: should this return?
@@ -28,7 +28,7 @@ export class Handler<T> implements Iterable<T> {
             console.warn(`Tried to get object from a Handler but identifier was undefined. Will return %cundefined%c.`, "font-style: italic;", "font-style: default;");
             return undefined;
         }
-        const stringifiedIdentifier = identifier.toString();
+        const stringifiedIdentifier: StringifiedIdentifier = identifier.toString();
         if (this.registered.has(stringifiedIdentifier) === false) {
             console.warn(`Tried to get object from a Handler with Identifier "${identifier}" that does not exist. Will return %cundefined%c.`, "font-style: italic;", "font-style: default;");
         }
@@ -46,11 +46,11 @@ export class Handler<T> implements Iterable<T> {
     }
 
     /**
-     * Gets a stringified key from a given registered value
+     * Gets a stringified identifier from a given registered value
      * @param value The value to get the key of
      * @returns The value's key
      */
-    getKeyFromValue(value: T): string | undefined {
+    getIdentifierFromValue(value: T): StringifiedIdentifier | undefined {
         for (const [key, val] of this.registered.entries()) {
             if (val === value) {
                 return key;
@@ -90,7 +90,7 @@ export class UniqueKeyHandler<T> implements Iterable<T> {
      * If a {@link T} is registered with the given ID than return it, if it's not then return undefined
      * @param key The key to get from
      */
-    getFromIdentifier(key: string): T | undefined {
+    getFromKey(key: string): T | undefined {
         if (key === undefined) {
             console.warn(`Tried to get object from a UniqueKeyHandler but key was undefined. Will return %cundefined%c.`, "font-style: italic;", "font-style: default;");
             return undefined;
@@ -107,7 +107,7 @@ export class UniqueKeyHandler<T> implements Iterable<T> {
      * @param value The value to get the key of
      * @returns The value's key
      */
-    getKeyFromValue(value: T): string | undefined {
+    getKeyFromValue(value: T): StringifiedIdentifier | undefined {
         for (const [key, val] of this.registered.entries()) {
             if (val === value) {
                 return key;
@@ -127,7 +127,7 @@ export class Identifier {
      * @param stringified The stringified Identifier
      * @returns A new {@link Identifier}
      */
-    static fromString(stringified: string): Identifier | undefined {
+    static fromString(stringified: StringifiedIdentifier): Identifier | undefined {
         const regex = /\w+:\w+/;
         if (!regex.test(stringified)) {
             console.warn(`Cannot construct a new Identifier from invalid string "${stringified}". Returning %cundefined%c.`, "font-style: italic;", "font-style: default;");
@@ -149,7 +149,7 @@ export class Identifier {
     /**
      * @returns Format: `namespace:uid`
      */
-    toString(): string {
+    toString(): StringifiedIdentifier {
         return `${this.namespace}:${this.uid}`;
     }
 
@@ -163,4 +163,7 @@ export class Identifier {
         else
             return false;
     }
-}
+}
+
+/** An alias for a `string` that exists to make typing more clear to the user whenever a stringified identifier is involved, as there are obviously requirements expected in that case that need to be clearly shown to the user to avoid errors. */
+export type StringifiedIdentifier = string;

src/ts/handlers.ts

@@ -1,7 +1,7 @@
 //* Ideally I would put things like BackgroundHandler in personalization.ts but because of lexical declarations we can't do that without getting circular imports as far as I can tell. This is fine.
 
 import { Building, BuildingSave } from "./buildings.js";
-import { Handler, Identifier, UniqueKeyHandler } from "./handler.js";
+import { Handler, Identifier, StringifiedIdentifier, UniqueKeyHandler } from "./handler.js";
 import { url } from "./helper.js";
 import { Game } from "./main.js";
 import { Mod } from "./mods.js";
@@ -39,7 +39,7 @@ export class BackgroundHandler extends Handler<Background> {
      * This method kinda sucks but we need it to work this way because of how {@link HTMLSelectElement}s work
      * @param value The UID of whatever {@link Background} we want from {@link backgroundHandler}. Usually `backgroundSelect`'s `value`
      */
-    setBackground(stringifiedIdentifier: string) {
+    setBackground(stringifiedIdentifier: StringifiedIdentifier) {
         const foundObject = Handlers.BACKGROUND.getFromIdentifier(Identifier.fromString(stringifiedIdentifier));
         if (foundObject) {
             this.currentBackground = foundObject;
@@ -89,7 +89,7 @@ export class CurrentlyClickedHandler extends Handler<CurrentlyClickedObject> {
      * This method kinda sucks but we need it to work this way because of how {@link HTMLSelectElement}s work
      * @param stringifiedIdentifier The stringified identifier of whatever {@link Background} we want from {@link currentlyClickedHandler}. Usually `currentlyClickedSelect`'s `value`
      */
-    setCurrentlyClicked(stringifiedIdentifier: string): void {
+    setCurrentlyClicked(stringifiedIdentifier: StringifiedIdentifier): void {
         const foundObject = Handlers.CURRENTLY_CLICKED.getFromIdentifier(Identifier.fromString(stringifiedIdentifier));
         if (foundObject) {
             this.currentlyClicked = foundObject;
@@ -146,9 +146,9 @@ export class BuildingHandler extends Handler<Building> {
      * @returns savedata as obj in following format: `stringifiedIdentifier: BuildingSave`
      */
     dumpSave(namespace: string=undefined) {
-        const saveObj: Record<string, BuildingSave> = {};
+        const saveObj: Record<StringifiedIdentifier, BuildingSave> = {};
         for (const value of (namespace === undefined) ? this : this.getValuesFromNamespace(namespace)) {
-            saveObj[this.getKeyFromValue(value)] = value.getSaveData();
+            saveObj[this.getIdentifierFromValue(value)] = value.getSaveData();
         }
         return saveObj;
     }
@@ -158,7 +158,7 @@ export class BuildingHandler extends Handler<Building> {
      * @param saveObj The save object to load the data of
      * @param namespace Optional: if present will only load data for buildings of a given namespace.
      */
-    loadSave(saveObj: Record<string, BuildingSave>, namespace: string=undefined) {
+    loadSave(saveObj: Record<StringifiedIdentifier, BuildingSave>, namespace: string=undefined) {
         for (const stringifiedIdentifier in saveObj) {
             const id = Identifier.fromString(stringifiedIdentifier);
 
@@ -233,9 +233,9 @@ export class UpgradeHandler extends Handler<Upgrade> {
      * @returns savedata as obj in following format: `stringifiedIdentifier: UpgradeSave`
      */
     dumpSave(namespace: string=undefined) {
-        const saveObj: Record<string, UpgradeSave> = {};
+        const saveObj: Record<StringifiedIdentifier, UpgradeSave> = {};
         for (const value of (namespace === undefined) ? this : this.getValuesFromNamespace(namespace)) {
-            saveObj[this.getKeyFromValue(value)] = value.getSaveData();
+            saveObj[this.getIdentifierFromValue(value)] = value.getSaveData();
         }
         return saveObj;
     }
@@ -245,7 +245,7 @@ export class UpgradeHandler extends Handler<Upgrade> {
      * @param saveObj The save object to load the data of
      * @param namespace Optional: if present will only load data for upgrades of a given namespace.
      */
-    loadSave(saveObj: Record<string, UpgradeSave>, namespace: string=undefined) {
+    loadSave(saveObj: Record<StringifiedIdentifier, UpgradeSave>, namespace: string=undefined) {
         for (const stringifiedIdentifier in saveObj) {
             const id = Identifier.fromString(stringifiedIdentifier);
 
@@ -277,7 +277,7 @@ export class ModHandler extends UniqueKeyHandler<Mod<any>> {
         (document.getElementById("addModURLForm") as HTMLFormElement).reset();
         document.getElementById("importedMessage").style.display = "block";
 
-        Game.getInstance().isModded = true;
+        Game.getInstance().modded = true;
 
         console.log("Loaded mod from URL: "+url);
     }
@@ -301,7 +301,7 @@ export class ModHandler extends UniqueKeyHandler<Mod<any>> {
             (document.getElementById("addModURLForm") as HTMLFormElement).reset();
             document.getElementById("importedMessage")!.style.display = "block";
 
-            Game.getInstance().isModded = true;
+            Game.getInstance().modded = true;
 
             console.log("Successfully added mod from file: "+file.name);
         };
@@ -378,7 +378,7 @@ export class ModHandler extends UniqueKeyHandler<Mod<any>> {
      */
     override register(key: string, mod: Mod<any>) {
         //! below will always warn, should that be changed?
-        if (this.getFromIdentifier(key) !== undefined) { //* do this before registering so we can get a more user-friendly popup than the console.error that we usually get for this type of error
+        if (this.getFromKey(key) !== undefined) { //* do this before registering so we can get a more user-friendly popup than the console.error that we usually get for this type of error
             new SimplePopup({x: 400, y: 200, title: "Error", text: `The mod namespace "${key}" is already present!`});
             return;
         }

src/ts/main.ts

@@ -17,6 +17,7 @@ import { Handlers, ModHandler } from "./handlers.js";
 import { BuildingSave } from "./buildings.js";
 
 import { NewMod } from "./exmod.js"; //* note: this import is intentionally left unused so tsc can find this file and compile it
+import { StringifiedIdentifier } from "./handler.js";
 
 // ------------------------------------
 // Version Constants
@@ -65,8 +66,8 @@ export enum VersionBranch {
 type MiddleState = "none" | "stats" | "info" | "options";
 
 export interface GameSaveData {
-    hasCheated: boolean;
-    isModded: boolean;
+    cheated: boolean;
+    modded: boolean;
     autoSavingAllowed: boolean;
 
     // personalization
@@ -88,8 +89,8 @@ export class Game implements SaveProvider<GameSaveData> {
         "potatman4": "Playtesting",
         "Wolfsarecool44": "Playtesting, Emotional Support"
     }
-    public static readonly DEFAULT_BACKGROUND: string = "clickercookie:blue";
-    public static readonly DEFAULT_CURRENTLY_CLICKED_OBJECT: string = "clickercookie:cookie";
+    public static readonly DEFAULT_BACKGROUND: StringifiedIdentifier = "clickercookie:blue";
+    public static readonly DEFAULT_CURRENTLY_CLICKED_OBJECT: StringifiedIdentifier = "clickercookie:cookie";
 
     public static getMousePosition(): MousePosition {
         return mousePos;
@@ -122,17 +123,17 @@ export class Game implements SaveProvider<GameSaveData> {
     public clickercookie: ClickerCookie;
 
     // self-explainatory-ish things
-    private _hasCheated: boolean;
-    public get hasCheated() { return this._hasCheated }
-    public set hasCheated(bool: boolean) {
-        this._hasCheated = bool;
-        document.getElementById("ifCheatedStat").style.display = (this._hasCheated) ? "block" : "none";
+    private _cheated: boolean;
+    public get cheated() { return this._cheated }
+    public set cheated(bool: boolean) {
+        this._cheated = bool;
+        document.getElementById("ifCheatedStat").style.display = (this._cheated) ? "block" : "none";
     }
-    private _isModded: boolean;
-    public get isModded() { return this._isModded }
-    public set isModded(bool: boolean) {
-        this._isModded = bool;
-        document.getElementById("ifModdedStat").style.display = (this._isModded) ? "block" : "none";
+    private _modded: boolean;
+    public get modded() { return this._modded }
+    public set modded(bool: boolean) {
+        this._modded = bool;
+        document.getElementById("ifModdedStat").style.display = (this._modded) ? "block" : "none";
     }
     private _autoSavingAllowed: boolean;
     public get autoSavingAllowed(): boolean { return this._autoSavingAllowed }
@@ -171,8 +172,8 @@ export class Game implements SaveProvider<GameSaveData> {
             y: 0
         };
 
-        this.hasCheated = false;
-        this.isModded = false;
+        this.cheated = false;
+        this.modded = false;
         this.autoSavingAllowed = true;
 
         this.clickercookie = new ClickerCookie();
@@ -369,13 +370,13 @@ export class Game implements SaveProvider<GameSaveData> {
         const originalBuildingSave = (this.savinator5000.getLocalStorageSave()) ? (this.savinator5000.getLocalStorageSave().getData("game") as GameSaveData).buildingsSave : {};
 
         return {
-            hasCheated: this.hasCheated,
-            isModded: this.isModded,
+            cheated: this.cheated,
+            modded: this.modded,
             autoSavingAllowed: this.autoSavingAllowed,
 
             // personalization
-            currentlyClickedObjectKey: Handlers.CURRENTLY_CLICKED.getKeyFromValue(Handlers.CURRENTLY_CLICKED.getCurrentlyClicked()),
-            currentBackgroundKey: Handlers.BACKGROUND.getKeyFromValue(Handlers.BACKGROUND.getCurrentBackground()), // todo: make better
+            currentlyClickedObjectKey: Handlers.CURRENTLY_CLICKED.getIdentifierFromValue(Handlers.CURRENTLY_CLICKED.getCurrentlyClicked()),
+            currentBackgroundKey: Handlers.BACKGROUND.getIdentifierFromValue(Handlers.BACKGROUND.getCurrentBackground()), // todo: make better
 
             upgradesSave: { // merge to preserve unregistered upgrades
                 ...originalUpgradeSave,
@@ -389,8 +390,8 @@ export class Game implements SaveProvider<GameSaveData> {
     }
 
     loadSaveData(saveData: GameSaveData): void {
-        this.hasCheated = saveData.hasCheated;
-        this.isModded = saveData.isModded;
+        this.cheated = saveData.cheated;
+        this.modded = saveData.modded;
         this.autoSavingAllowed = saveData.autoSavingAllowed;
 
         Handlers.CURRENTLY_CLICKED.setCurrentlyClicked(saveData.currentlyClickedObjectKey);

src/ts/saving.ts

@@ -100,8 +100,8 @@ export class Savinator {
                 console.log(`Loaded save data for "${namespace}" namespace.`);
             }
         }
-        if (this.saveHandler.getFromIdentifier("game") !== undefined) { // game should always be there, but just in case it isn't we check
-            this.saveHandler.getFromIdentifier("game").loadSaveData(localStorageSave.getData("game"));
+        if (this.saveHandler.getFromKey("game") !== undefined) { // game should always be there, but just in case it isn't we check
+            this.saveHandler.getFromKey("game").loadSaveData(localStorageSave.getData("game"));
             console.log(`Loaded save data for game namespace.`);
         }
 
@@ -378,8 +378,8 @@ export function convert06Save(save: string) {
 
     game.clickercookie.cookiesPerClick = parsedSave["core.cookiesPerClick"];
     game.clickercookie.cookieBeenClickedTimes = parsedSave["core.cookieBeenClickedTimes"];
-    game.hasCheated = !!parsedSave["hasCheated"];
-    game.isModded = !!parsedSave["isModded"];
+    game.cheated = !!parsedSave["hasCheated"];
+    game.modded = !!parsedSave["isModded"];
     // no won
 
     game.savinator5000.preserveUnusedNamespacesInSaves = false;