added QPixel.Storage helper module & migration for fixing user preferences

Author: Oaphi

app/assets/javascripts/qpixel_storage.js

@@ -0,0 +1,36 @@
+window.QPixel = window.QPixel || {};
+
+QPixel.Storage = {
+  get latestMigration() {
+    return localStorage.getItem("qpixel.latest_storage_migration");
+  },
+  migrations: [],
+  addMigration(migration) {
+    this.migrations.push(migration);
+    return this;
+  },
+  async runMigrations() {
+    const { latestMigration, migrations } = this;
+
+    const latestIndex = migrations.findIndex((m) => m.name === latestMigration);
+    const pending = migrations.slice(latestIndex + 1);
+
+    for (const migration of pending) {
+      try {
+        await migration.up();
+      } catch (e) {
+        console.warn(`[qpixel/storage] migration ${migration.name} error`, e);
+        break;
+      }
+    }
+  },
+};
+
+document.addEventListener("DOMContentLoaded", async () => {
+  await QPixel.Storage.addMigration({
+    name: "fix-user-preferences",
+    async up() {
+      localStorage.removeItem("qpixel.user_undefined_preferences");
+    },
+  }).runMigrations();
+});

global.d.ts

@@ -52,6 +52,19 @@ interface QPixelMD {
   stripMarkdown(content: string, options?: StripMarkdownOptions): string;
 }
 
+interface QPixelStorageMigration {
+  name: string
+  up: () => Promise<void>
+  down?: () => Promise<void>
+}
+
+interface QPixelStorage {
+  readonly latestMigration: string | null
+  migrations: QPixelStorageMigration[]
+  addMigration: (migration: QPixelStorageMigration) => QPixelStorage
+  runMigrations:() => Promise<void>
+}
+
 type QPixelKeyboardState =
   | "home"
   | "goto"
@@ -386,6 +399,8 @@ interface QPixel {
   MD?: QPixelMD;
   // qpixel popups
   Popup?: typeof QPixelPopup;
+  // qpixel storage management
+  Storage?: QPixelStorage;
   // Stripe integration, TODO: types
   stripe?: any;
 }