refactor: migrate project storage from IndexedDB to OPFS with folder-based structure

- Replace monolithic KGStorage with KGProjectStorage (OPFS) and KGConfigStorage (IndexedDB)
- Each project stored as folder: project.json + meta.json + media/
- Add KGConfigUpgrader with V1 upgrader to auto-migrate existing IndexedDB projects to OPFS
- Request persistent storage via navigator.storage.persist() to prevent browser eviction
- Show loading spinner during one-time migration
- Enforce safe project name characters (letters, numbers, space, hyphen, underscore, period, parens)
- Export projects as .kgstudio zip bundles instead of raw JSON
- Import supports .kgstudio bundles (with meta.json validation) and legacy JSON files
- Auto-deduplicate project names on import with (1), (2), etc. suffix
- Add OPFS shell debugger (pwd, ls, cd, cat, dl) accessible via KGDebugger.opfs()
- Add ESLint semi rule for consistent semicolons
- Delete KGStorage.ts — all logic absorbed by new storage classes
- Add jszip dependency for zip export/import
This commit is contained in:
Xiaohan-Tian
2026-04-09 19:25:08 -07:00
parent 17610f12f3
commit 2d3ea33ce6
21 changed files with 1781 additions and 235 deletions
+10 -17
View File
@@ -1,5 +1,4 @@
import { KGStorage, DuplicateEntryError } from '../core/io/KGStorage';
import { DB_CONSTANTS } from '../constants/coreConstants';
import { KGProjectStorage, DuplicateEntryError } from '../core/io/KGProjectStorage';
import { KGCore } from '../core/KGCore';
/**
@@ -13,43 +12,37 @@ export const saveProject = async (
projectName: string,
setStatus: (status: string) => void
): Promise<boolean> => {
const storage = KGStorage.getInstance();
const storage = KGProjectStorage.getInstance();
try {
await storage.save(
DB_CONSTANTS.DB_NAME,
DB_CONSTANTS.PROJECTS_STORE_NAME,
projectName,
KGCore.instance().getCurrentProject(),
false,
DB_CONSTANTS.DB_VERSION
);
setStatus(`Project "${projectName}" has been saved`);
console.log("project saved successfully");
return true;
} catch (error) {
console.error("Error saving project:", error);
if (error instanceof DuplicateEntryError) {
const confirmed = window.confirm(`Project "${projectName}" already exists. Do you want to overwrite it?`);
if (confirmed) {
try {
await storage.save(
DB_CONSTANTS.DB_NAME,
DB_CONSTANTS.PROJECTS_STORE_NAME,
projectName,
KGCore.instance().getCurrentProject(),
true,
DB_CONSTANTS.DB_VERSION
);
setStatus(`Project "${projectName}" has been saved`);
console.log("project saved successfully after overwrite");
return true;
} catch (overwriteError) {
console.error("Error overwriting project:", overwriteError);
window.alert(`An error occurred while overwriting the project: ${overwriteError}`);
@@ -65,4 +58,4 @@ export const saveProject = async (
return false;
}
}
};
};