Expand the driver support for IndexedDB

[petarblazevski]

Hi there,

I recently started using this plugin, and it's exactly what I needed—great work! However, I noticed a missing feature that's essential for my use case: schema and data migration.

The current driver for IndexedDB, localForage, doesn't seem to support this functionality.

Previously, I implemented a custom solution using the IDB wrapper to interact with IndexedDB. IDB's built-in upgrade functionality made handling migrations straightforward.

It would be fantastic if this plugin could support similar migration capabilities, perhaps by integrating with IDB or Dexie.js. Adding such a feature would make this tool even more versatile and powerful.

Thanks for considering this suggestion, and keep up the great work!

[stephenjason89]

Hi @petarblazevski,

Sorry for the late reply since last week has been a busy week.

Thank you for your thoughtful feedback and for sharing your use case! 😊

The plugin’s primary focus is on simplifying state persistence for Pinia stores by treating storage mechanisms (like localStorage or localForage) as key-value stores. This abstraction is intentional to keep the plugin lightweight and versatile.

Regarding schema and data migration, here’s why it’s not directly addressed in the plugin:

• No Fixed Schema: The plugin doesn’t enforce a schema because its primary purpose is to mirror Pinia state into storage, rather than act as a database management tool. Data is serialized into storage using JSON.stringify by default and retrieved with JSON.parse. Additionally, the plugin supports custom serializers, giving developers full control over how data is stored and retrieved. This flexibility, combined with the fact that it’s designed to sync state rather than manage data structures, makes schema migrations unnecessary in most use cases.

• Custom Storage Options: For advanced use cases like yours, the plugin allows developers to define their own storage mechanism. This means you can integrate a library like Dexie.js or IDB directly into your setup for handling schema migrations while still benefiting from the plugin's core functionality.

Here’s how you might use a custom storage implementation with the plugin:

import { createPinia } from 'pinia';
import { createStatePersistence } from 'pinia-plugin-state-persistence';
import Dexie from 'dexie';

const db = new Dexie('MyDatabase');
db.version(1).stores({ data: 'key' }); // Define your schema

const customStorage = {
  async getItem(key) {
    return (await db.table('data').get(key))?.value || null;
  },
  async setItem(key, value) {
    await db.table('data').put({ key, value });
  },
  async removeItem(key) {
    await db.table('data').delete(key);
  },
};

const pinia = createPinia();
pinia.use(createStatePersistence({ storage: customStorage }));

This setup lets you leverage Dexie.js for schema migration and advanced IndexedDB features while maintaining compatibility with the plugin.

We’re always open to improving the plugin, so if you have additional ideas or specific features in mind, feel free to share. Thanks again for your suggestion and support! 🚀

[petarblazevski]

Many thanks for the feedback @stephenjason89. I will take a look at creating my own storage implementation like you proposed. I believe it should solve my problem with the schema and migrations

[stephenjason89]

You're very welcome! 🎉 Let me know if you run into any roadblocks or need any insights along the way. Happy coding!