Refactor AccountStorage to use private fields for state management

5085f6cdc9f68dc702ab3a78e5dc7f0efe30c770

Cohee <18619528+Cohee1207@users.noreply.github.com>

public/script.js+1 -1 Viewed

         url: '/api/settings/save',
         data: JSON.stringify({
             firstRun: firstRun,
-            accountStorage: accountStorage.state,
+            accountStorage: accountStorage.getState(),
             currentVersion: currentVersion,
             username: name1,
             active_character: active_character,

public/scripts/util/AccountStorage.js+29 -16 Viewed

  * Provides access to account storage of arbitrary key-value pairs.
  */
 class AccountStorage {
-    constructor() {
+    /**
-        this.state = {};
+     * @type {Record<string, string>} Storage state
-        this.ready = false;
+     */
-    }
+    #state = {};
+    /**
+     * @type {boolean} If the storage was initialized
+     */
+    #ready = false;
     #migrateLocalStorage() {
         for (let i = 0; i < globalThis.localStorage.length; i++) {

@@ -45,7 +50,7 @@ class AccountStorage {
45	const value = globalThis.localStorage.getItem(key);	50	const value = globalThis.localStorage.getItem(key);
46		51
47	if (MIGRATABLE_KEYS.some(k => k.test(key))) {	52	if (MIGRATABLE_KEYS.some(k => k.test(key))) {
48	this.state[key] = value;	53	this.#state[key] = value;
49	globalThis.localStorage.removeItem(key);	54	globalThis.localStorage.removeItem(key);
50	}	55	}
51	}	56	}

@@ -57,16 +62,16 @@ class AccountStorage {
57	*/	62	*/
58	init(state) {	63	init(state) {
59	if (state && typeof state === 'object') {	64	if (state && typeof state === 'object') {
60	this.state = Object.assign(this.state, state);	65	this.#state = Object.assign(this.#state, state);
61	}	66	}
62		67
63	if (!Object.hasOwn(this.state, MIGRATED_MARKER)) {	68	if (!Object.hasOwn(this.#state, MIGRATED_MARKER)) {
64	this.#migrateLocalStorage();	69	this.#migrateLocalStorage();
65	this.state[MIGRATED_MARKER] = 1;	70	this.#state[MIGRATED_MARKER] = '1';
66	saveSettingsDebounced();	71	saveSettingsDebounced();
67	}	72	}
68		73
69	this.ready = true;	74	this.#ready = true;
70	}	75	}
71		76
72	/**	77	/**

@@ -75,11 +80,11 @@ class AccountStorage {
75	* @returns {string\|null} Value of the key	80	* @returns {string\|null} Value of the key
76	*/	81	*/
77	getItem(key) {	82	getItem(key) {
78	if (!this.ready) {	83	if (!this.#ready) {
79	console.warn(`AccountStorage not ready (trying to read from ${key})`);	84	console.warn(`AccountStorage not ready (trying to read from ${key})`);
80	}	85	}
81		86
82	return Object.hasOwn(this.state, key) ? String(this.state[key]) : null;	87	return Object.hasOwn(this.#state, key) ? String(this.#state[key]) : null;
83	}	88	}
84		89
85	/**	90	/**

@@ -88,11 +93,11 @@ class AccountStorage {
88	* @param {string} value Value to set	93	* @param {string} value Value to set
89	*/	94	*/
90	setItem(key, value) {	95	setItem(key, value) {
91	if (!this.ready) {	96	if (!this.#ready) {
92	console.warn(`AccountStorage not ready (trying to write to ${key})`);	97	console.warn(`AccountStorage not ready (trying to write to ${key})`);
93	}	98	}
94		99
95	this.state[key] = String(value);	100	this.#state[key] = String(value);
96	saveSettingsDebounced();	101	saveSettingsDebounced();
97	}	102	}
98		103

      * @param {string} key Key to remove
      */
     removeItem(key) {
-        if (!this.ready) {
+        if (!this.#ready) {
             console.warn(`AccountStorage not ready (trying to remove ${key})`);
+        }
-        if (!Object.hasOwn(this.state, key)) {
+        if (!Object.hasOwn(this.#state, key)) {
             return;
+        }
-        delete this.state[key];
+        delete this.#state[key];
         saveSettingsDebounced();
+    }
+    /**
+     * Gets a snapshot of the storage state.
+     * @returns {Record<string, string>} A deep clone of the storage state
+     */
+    getState() {
+        return structuredClone(this.#state);
+    }
+}
 /**