From bfddf855a48b25424c22537da424abe95338132c Mon Sep 17 00:00:00 2001
From: Oliver-Akins <Oliver.akins1999@gmail.com>
Date: Sat, 5 Apr 2025 15:31:28 -0600
Subject: [PATCH] Move the magic string into an enum

---
 module/Apps/ActorSheets/HeroSkillsCardV1.mjs | 3 ++-
 module/Apps/popovers/AmmoTracker.mjs         | 7 ++++---
 module/api.mjs                               | 6 +++++-
 module/flags/item.mjs                        | 4 ++++
 4 files changed, 15 insertions(+), 5 deletions(-)
 create mode 100644 module/flags/item.mjs

diff --git a/module/Apps/ActorSheets/HeroSkillsCardV1.mjs b/module/Apps/ActorSheets/HeroSkillsCardV1.mjs
index cccc359..76f0e9d 100644
--- a/module/Apps/ActorSheets/HeroSkillsCardV1.mjs
+++ b/module/Apps/ActorSheets/HeroSkillsCardV1.mjs
@@ -3,6 +3,7 @@ import { documentSorter, filePath } from "../../consts.mjs";
 import { AmmoTracker } from "../popovers/AmmoTracker.mjs";
 import { gameTerms } from "../../gameTerms.mjs";
 import { GenericAppMixin } from "../GenericApp.mjs";
+import { ItemFlags } from "../../flags/item.mjs";
 import { localizer } from "../../utils/Localizer.mjs";
 import { Logger } from "../../utils/Logger.mjs";
 import { PopoverEventManager } from "../../utils/PopoverEventManager.mjs";
@@ -142,7 +143,7 @@ export class HeroSkillsCardV1 extends GenericAppMixin(HandlebarsApplicationMixin
 		for (const ammo of ctx.actor.itemTypes.ammo) {
 			total += ammo.system.quantity;
 
-			if (favouriteCount < 3 && ammo.getFlag(game.system.id, `favourited`)) {
+			if (favouriteCount < 3 && ammo.getFlag(game.system.id, ItemFlags.FAVOURITE)) {
 				ctx.favouriteAmmo[favouriteCount] = {
 					uuid: ammo.uuid,
 					name: ammo.name,
diff --git a/module/Apps/popovers/AmmoTracker.mjs b/module/Apps/popovers/AmmoTracker.mjs
index 6e0e399..c91e3a4 100644
--- a/module/Apps/popovers/AmmoTracker.mjs
+++ b/module/Apps/popovers/AmmoTracker.mjs
@@ -1,5 +1,6 @@
 import { filePath } from "../../consts.mjs";
 import { GenericPopoverMixin } from "./GenericPopoverMixin.mjs";
+import { ItemFlags } from "../../flags/item.mjs";
 import { localizer } from "../../utils/Localizer.mjs";
 import { Logger } from "../../utils/Logger.mjs";
 
@@ -40,7 +41,7 @@ export class AmmoTracker extends GenericPopoverMixin(HandlebarsApplicationMixin(
 
 		let favouriteCount = 0;
 		ctx.ammos = data.ammos.map(ammo => {
-			const favourite = ammo.getFlag(game.system.id, `favourited`) ?? false;
+			const favourite = ammo.getFlag(game.system.id, ItemFlags.FAVOURITE) ?? false;
 			if (favourite) { favouriteCount++ };
 
 			return {
@@ -73,7 +74,7 @@ export class AmmoTracker extends GenericPopoverMixin(HandlebarsApplicationMixin(
 		const item = await fromUuid(data.itemId);
 		if (!item) { return };
 
-		item.setFlag(game.system.id, `favourited`, true);
+		item.setFlag(game.system.id, ItemFlags.FAVOURITE, true);
 	};
 
 	static async #unfavourite(_, el) {
@@ -87,7 +88,7 @@ export class AmmoTracker extends GenericPopoverMixin(HandlebarsApplicationMixin(
 		const item = await fromUuid(data.itemId);
 		if (!item) { return };
 
-		item.unsetFlag(game.system.id, `favourited`);
+		item.unsetFlag(game.system.id, ItemFlags.FAVOURITE);
 	};
 	// #endregion
 };
diff --git a/module/api.mjs b/module/api.mjs
index ee40143..389ca3e 100644
--- a/module/api.mjs
+++ b/module/api.mjs
@@ -1,4 +1,5 @@
 // App imports
+import { AmmoTracker } from "./Apps/popovers/AmmoTracker.mjs";
 import { CombinedHeroSheet } from "./Apps/ActorSheets/CombinedHeroSheet.mjs";
 import { DicePool } from "./Apps/DicePool.mjs";
 import { HeroSkillsCardV1 } from "./Apps/ActorSheets/HeroSkillsCardV1.mjs";
@@ -9,7 +10,9 @@ import { RichEditor } from "./Apps/RichEditor.mjs";
 import { distanceBetweenFates, nextFate, previousFate } from "./utils/fates.mjs";
 import { documentSorter } from "./consts.mjs";
 import { rankToInteger } from "./utils/rank.mjs";
-import { AmmoTracker } from "./Apps/popovers/AmmoTracker.mjs";
+
+// Misc Imports
+import { ItemFlags } from "./flags/item.mjs";
 
 const { deepFreeze } = foundry.utils;
 
@@ -33,6 +36,7 @@ Object.defineProperty(
 				previousFate,
 				rankToInteger,
 			},
+			ItemFlags,
 		}),
 		writable: false,
 	},
diff --git a/module/flags/item.mjs b/module/flags/item.mjs
new file mode 100644
index 0000000..de53d3b
--- /dev/null
+++ b/module/flags/item.mjs
@@ -0,0 +1,4 @@
+export const ItemFlags = Object.freeze({
+	/** The boolean value to indicate if an item is considered favourited/starred or not */
+	FAVOURITE: `favourited`,
+});