@rozenite/storage-plugin 1.8.1 → 1.10.0

package/src/react-native/storage-view.ts

@@ -34,6 +34,10 @@ const toSnapshotMap = (entries: StorageEntry[]) => {
 };
 
 const shouldFilterKey = (storage: StorageNode, key: string) => {
+  if (storage.shouldFilterKey?.(key)) {
+    return true;
+  }
+
   if (!storage.blacklist) {
     return false;
   }
@@ -45,14 +49,14 @@ const shouldFilterKey = (storage: StorageNode, key: string) => {
 const checkTypeSupport = (
   capabilities: StorageCapabilities,
   type: StorageEntryType,
-  target: StorageTarget
+  target: StorageTarget,
 ) => {
   if (supportsType(capabilities, type)) {
     return;
   }
 
   throw new Error(
-    `Type "${type}" is not supported by storage "${target.storageId}" in adapter "${target.adapterId}".`
+    `Type "${type}" is not supported by storage "${target.storageId}" in adapter "${target.adapterId}".`,
   );
 };
 
@@ -96,6 +100,7 @@ export type StorageView = {
   adapterName: string;
   storageName: string;
   capabilities: StorageCapabilities;
+  blacklist?: RegExp;
   get: (key: string) => Promise<StorageEntry | undefined>;
   set: (entry: StorageEntry) => Promise<void>;
   delete: (key: string) => Promise<void>;
@@ -108,7 +113,7 @@ export type StorageView = {
 };
 
 const buildSnapshotMap = async (
-  getAllEntries: () => Promise<StorageEntry[]>
+  getAllEntries: () => Promise<StorageEntry[]>,
 ): Promise<StorageSnapshotMap> => {
   const entries = await getAllEntries();
   return toSnapshotMap(entries);
@@ -120,7 +125,7 @@ const diffSnapshots = (
   handlers: {
     onSet: (entry: StorageEntry) => void;
     onDelete: (key: string) => void;
-  }
+  },
 ) => {
   next.forEach((nextEntry, key) => {
     const previousEntry = previous.get(key);
@@ -147,7 +152,7 @@ const createPollingSubscription = async (
   handlers: {
     onSet: (entry: StorageEntry) => void;
     onDelete: (key: string) => void;
-  }
+  },
 ): Promise<StorageSubscription> => {
   let previousSnapshot = await buildSnapshotMap(getAllEntries);
 
@@ -170,7 +175,7 @@ const createPollingSubscription = async (
 
 export const createStorageView = (
   adapter: StorageAdapter,
-  storageNode: StorageNode
+  storageNode: StorageNode,
 ): StorageView => {
   const storage = storageNode.storage;
   const target: StorageTarget = {
@@ -191,7 +196,7 @@ export const createStorageView = (
     const visibleEntries = await Promise.all(
       keys
         .filter((key) => !shouldFilterKey(storageNode, key))
-        .map((key) => getEntry(storage, key))
+        .map((key) => getEntry(storage, key)),
     );
 
     return visibleEntries.filter((entry): entry is StorageEntry => !!entry);
@@ -203,6 +208,7 @@ export const createStorageView = (
     adapterName: adapter.name,
     storageName: storageNode.name,
     capabilities: storageNode.capabilities,
+    blacklist: storageNode.blacklist,
     get,
     set: async (entry) => {
       checkTypeSupport(storageNode.capabilities, entry.type, target);
@@ -241,5 +247,7 @@ export const createStorageView = (
 
 export const createStorageViews = (storages: StorageAdapter[]) =>
   storages.flatMap((adapter) =>
-    adapter.storages.map((storageNode) => createStorageView(adapter, storageNode))
+    adapter.storages.map((storageNode) =>
+      createStorageView(adapter, storageNode),
+    ),
   );

package/src/react-native/useRozeniteStoragePlugin.ts

@@ -4,9 +4,11 @@ import type {
   StorageDeleteEntryEvent,
   StorageEventMap,
   StorageGetSnapshotEvent,
+  StorageImportEntriesEvent,
   StorageSetEntryEvent,
 } from '../shared/messaging';
 import type { StorageAdapter } from '../shared/types';
+import { handleImportEntries } from './import';
 import { createStorageViews } from './storage-view';
 import { useStorageAgentTools } from './useStorageAgentTools';
 
@@ -31,7 +33,9 @@ export const useRozeniteStoragePlugin = ({
     }
 
     const pushSnapshot = async (viewId?: string) => {
-      const selectedViews = viewId ? views.filter((view) => view.id === viewId) : views;
+      const selectedViews = viewId
+        ? views.filter((view) => view.id === viewId)
+        : views;
 
       for (const view of selectedViews) {
         try {
@@ -42,12 +46,15 @@ export const useRozeniteStoragePlugin = ({
             adapterName: view.adapterName,
             storageName: view.storageName,
             capabilities: view.capabilities,
+            blacklist: view.blacklist
+              ? { source: view.blacklist.source, flags: view.blacklist.flags }
+              : undefined,
             entries,
           });
         } catch (error) {
           console.warn(
             `[Rozenite] Storage Plugin: Failed to snapshot ${view.target.adapterId}/${view.target.storageId}.`,
-            error
+            error,
           );
         }
       }
@@ -88,48 +95,51 @@ export const useRozeniteStoragePlugin = ({
         } catch (error) {
           console.warn(
             `[Rozenite] Storage Plugin: Failed to attach watcher for ${view.target.adapterId}/${view.target.storageId}.`,
-            error
+            error,
           );
         }
-      })
+      }),
     );
 
     const messageSubscriptions = [
-      client.onMessage('set-entry', async ({ target, entry }: StorageSetEntryEvent) => {
-        const view = views.find(
-          (candidate) =>
-            candidate.target.adapterId === target.adapterId &&
-            candidate.target.storageId === target.storageId
-        );
-
-        if (!view) {
-          console.warn(
-            `[Rozenite] Storage Plugin: Storage target not found for ${target.adapterId}/${target.storageId}`
+      client.onMessage(
+        'set-entry',
+        async ({ target, entry }: StorageSetEntryEvent) => {
+          const view = views.find(
+            (candidate) =>
+              candidate.target.adapterId === target.adapterId &&
+              candidate.target.storageId === target.storageId,
           );
-          return;
-        }
 
-        try {
-          await view.set(entry);
-        } catch (error) {
-          console.warn(
-            `[Rozenite] Storage Plugin: Failed to set entry in ${target.adapterId}/${target.storageId}.`,
-            error
-          );
-        }
-      }),
+          if (!view) {
+            console.warn(
+              `[Rozenite] Storage Plugin: Storage target not found for ${target.adapterId}/${target.storageId}`,
+            );
+            return;
+          }
+
+          try {
+            await view.set(entry);
+          } catch (error) {
+            console.warn(
+              `[Rozenite] Storage Plugin: Failed to set entry in ${target.adapterId}/${target.storageId}.`,
+              error,
+            );
+          }
+        },
+      ),
       client.onMessage(
         'delete-entry',
         async ({ target, key }: StorageDeleteEntryEvent) => {
           const view = views.find(
             (candidate) =>
               candidate.target.adapterId === target.adapterId &&
-              candidate.target.storageId === target.storageId
+              candidate.target.storageId === target.storageId,
           );
 
           if (!view) {
             console.warn(
-              `[Rozenite] Storage Plugin: Storage target not found for ${target.adapterId}/${target.storageId}`
+              `[Rozenite] Storage Plugin: Storage target not found for ${target.adapterId}/${target.storageId}`,
             );
             return;
           }
@@ -139,19 +149,34 @@ export const useRozeniteStoragePlugin = ({
           } catch (error) {
             console.warn(
               `[Rozenite] Storage Plugin: Failed to delete entry in ${target.adapterId}/${target.storageId}.`,
-              error
+              error,
             );
           }
-        }
+        },
       ),
-      client.onMessage('get-snapshot', async ({ target }: StorageGetSnapshotEvent) => {
-        if (target === 'all') {
-          await pushSnapshot();
-          return;
-        }
+      client.onMessage(
+        'get-snapshot',
+        async ({ target }: StorageGetSnapshotEvent) => {
+          if (target === 'all') {
+            await pushSnapshot();
+            return;
+          }
 
-        await pushSnapshot(`${target.adapterId}:${target.storageId}`);
-      }),
+          await pushSnapshot(`${target.adapterId}:${target.storageId}`);
+        },
+      ),
+      client.onMessage(
+        'import-entries',
+        async (event: StorageImportEntriesEvent) => {
+          await handleImportEntries(views, event, (out) => {
+            if (out.type === 'set-entry') {
+              client.send('set-entry', out);
+            } else {
+              client.send('import-result', out);
+            }
+          });
+        },
+      ),
     ];
 
     return () => {

package/src/shared/__tests__/snapshot.test.ts

@@ -0,0 +1,361 @@
+import { describe, expect, it } from 'vitest';
+import {
+  buildSnapshot,
+  computePreview,
+  parseSnapshot,
+  type StorageSnapshotV1,
+} from '../snapshot';
+import type {
+  StorageCapabilities,
+  StorageEntry,
+  StorageTarget,
+} from '../types';
+
+const validSnapshot = (
+  overrides: Partial<StorageSnapshotV1> = {},
+): StorageSnapshotV1 => ({
+  version: 1,
+  plugin: '@rozenite/storage-plugin',
+  createdAt: '2026-05-11T12:00:00.000Z',
+  storage: {
+    adapterId: 'mmkv',
+    storageId: 'user',
+    adapterName: 'MMKV',
+    storageName: 'user',
+    capabilities: { supportedTypes: ['string', 'number', 'boolean', 'buffer'] },
+  },
+  entries: [
+    { key: 'token', type: 'string', value: 'abc' },
+    { key: 'launchCount', type: 'number', value: 3 },
+    { key: 'seenOnboarding', type: 'boolean', value: true },
+    { key: 'blob', type: 'buffer', value: [1, 2, 255] },
+  ],
+  ...overrides,
+});
+
+describe('parseSnapshot', () => {
+  it('accepts a valid snapshot covering all entry types', () => {
+    const result = parseSnapshot(validSnapshot());
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.snapshot).toEqual(validSnapshot());
+    }
+  });
+
+  it('accepts a snapshot with an empty entries array', () => {
+    const result = parseSnapshot(validSnapshot({ entries: [] }));
+    expect(result.ok).toBe(true);
+  });
+
+  it('ignores unknown top-level fields (forward-tolerant)', () => {
+    const input = { ...validSnapshot(), extraField: 'ignored' };
+    const result = parseSnapshot(input);
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.snapshot).not.toHaveProperty('extraField');
+    }
+  });
+
+  describe('top-level rejections', () => {
+    it.each([
+      ['null', null],
+      ['array', []],
+      ['string', 'hi'],
+      ['number', 1],
+    ])('rejects non-object root (%s)', (_label, raw) => {
+      const result = parseSnapshot(raw);
+      expect(result.ok).toBe(false);
+      if (!result.ok) {
+        expect(result.error.path).toBe('$');
+      }
+    });
+
+    it('rejects when version is missing', () => {
+      const snapshot = validSnapshot() as Record<string, unknown>;
+      delete snapshot.version;
+      const result = parseSnapshot(snapshot);
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('version');
+    });
+
+    it.each([0, 2, '1', null])('rejects unsupported version: %s', (version) => {
+      const result = parseSnapshot({ ...validSnapshot(), version });
+      expect(result.ok).toBe(false);
+      if (!result.ok) {
+        expect(result.error.path).toBe('version');
+        expect(result.error.message).toMatch(/version/i);
+      }
+    });
+
+    it('rejects when plugin is not a string', () => {
+      const result = parseSnapshot({ ...validSnapshot(), plugin: 42 });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('plugin');
+    });
+
+    it('rejects when createdAt is not a string', () => {
+      const result = parseSnapshot({ ...validSnapshot(), createdAt: 0 });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('createdAt');
+    });
+
+    it('rejects when storage is missing', () => {
+      const snapshot = validSnapshot() as Record<string, unknown>;
+      delete snapshot.storage;
+      const result = parseSnapshot(snapshot);
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('storage');
+    });
+
+    it('rejects when entries is not an array', () => {
+      const result = parseSnapshot({ ...validSnapshot(), entries: 'nope' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries');
+    });
+
+    it('rejects when capabilities.supportedTypes has an invalid type', () => {
+      const snapshot = validSnapshot();
+      const input = {
+        ...snapshot,
+        storage: {
+          ...snapshot.storage,
+          capabilities: { supportedTypes: ['string', 'date'] },
+        },
+      };
+      const result = parseSnapshot(input);
+      expect(result.ok).toBe(false);
+      if (!result.ok) {
+        expect(result.error.path).toBe(
+          'storage.capabilities.supportedTypes[1]',
+        );
+      }
+    });
+  });
+
+  describe('per-entry rejections', () => {
+    const withEntry = (entry: unknown) =>
+      parseSnapshot({ ...validSnapshot(), entries: [entry] });
+
+    it('rejects entry missing key', () => {
+      const result = withEntry({ type: 'string', value: 'x' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].key');
+    });
+
+    it('rejects entry with unknown type', () => {
+      const result = withEntry({ key: 'k', type: 'date', value: 'x' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].type');
+    });
+
+    it('rejects string type with non-string value', () => {
+      const result = withEntry({ key: 'k', type: 'string', value: 42 });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].value');
+    });
+
+    it('rejects number type with non-number value', () => {
+      const result = withEntry({ key: 'k', type: 'number', value: '42' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].value');
+    });
+
+    it.each([NaN, Infinity, -Infinity])(
+      'rejects number type with non-finite value (%s)',
+      (value) => {
+        const result = withEntry({ key: 'k', type: 'number', value });
+        expect(result.ok).toBe(false);
+        if (!result.ok) expect(result.error.path).toBe('entries[0].value');
+      },
+    );
+
+    it('rejects boolean type with non-boolean value', () => {
+      const result = withEntry({ key: 'k', type: 'boolean', value: 'true' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].value');
+    });
+
+    it('rejects buffer type with non-array value', () => {
+      const result = withEntry({ key: 'k', type: 'buffer', value: 'data' });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[0].value');
+    });
+
+    it.each([
+      ['byte > 255', [1, 2, 256]],
+      ['byte < 0', [1, -1]],
+      ['non-integer byte', [1, 1.5]],
+      ['NaN byte', [1, NaN]],
+      ['non-number byte', [1, 'x']],
+    ])('rejects buffer with invalid byte (%s)', (_label, value) => {
+      const result = withEntry({ key: 'k', type: 'buffer', value });
+      expect(result.ok).toBe(false);
+      if (!result.ok) {
+        expect(result.error.path).toMatch(/^entries\[0\]\.value\[\d+\]$/);
+      }
+    });
+
+    it('produces a path-precise error for a nested failure', () => {
+      const result = parseSnapshot({
+        ...validSnapshot(),
+        entries: [
+          { key: 'a', type: 'string', value: 'ok' },
+          { key: 'b', type: 'string', value: 'ok' },
+          { key: 'c', type: 'string', value: 'ok' },
+          { key: 'd', type: 'number', value: 'wrong' },
+        ],
+      });
+      expect(result.ok).toBe(false);
+      if (!result.ok) expect(result.error.path).toBe('entries[3].value');
+    });
+  });
+});
+
+describe('buildSnapshot', () => {
+  it('produces a v1-shaped snapshot with the plugin id and an ISO createdAt', () => {
+    const target: StorageTarget = { adapterId: 'mmkv', storageId: 'user' };
+    const capabilities: StorageCapabilities = {
+      supportedTypes: ['string', 'number'],
+    };
+    const entries: StorageEntry[] = [
+      { key: 'token', type: 'string', value: 'abc' },
+    ];
+
+    const result = buildSnapshot({
+      target,
+      adapterName: 'MMKV',
+      storageName: 'user',
+      capabilities,
+      entries,
+    });
+
+    expect(result.version).toBe(1);
+    expect(result.plugin).toBe('@rozenite/storage-plugin');
+    expect(() => new Date(result.createdAt).toISOString()).not.toThrow();
+    expect(result.storage).toEqual({
+      adapterId: 'mmkv',
+      storageId: 'user',
+      adapterName: 'MMKV',
+      storageName: 'user',
+      capabilities,
+    });
+    expect(result.entries).toBe(entries);
+  });
+});
+
+describe('computePreview', () => {
+  const target: StorageTarget = { adapterId: 'mmkv', storageId: 'user' };
+  const allTypes: StorageCapabilities = {
+    supportedTypes: ['string', 'number', 'boolean', 'buffer'],
+  };
+  const noBlacklist = () => false;
+
+  it('splits entries into new vs overwrite', () => {
+    const snapshot = validSnapshot({
+      entries: [
+        { key: 'existing', type: 'string', value: 'a' },
+        { key: 'fresh', type: 'string', value: 'b' },
+      ],
+    });
+    const preview = computePreview(snapshot, {
+      target,
+      capabilities: allTypes,
+      entryKeys: new Set(['existing']),
+      isBlacklisted: noBlacklist,
+    });
+    expect(preview.newKeys).toEqual(['fresh']);
+    expect(preview.overwriteKeys).toEqual(['existing']);
+  });
+
+  it('surfaces blacklisted keys in skippedKeys', () => {
+    const snapshot = validSnapshot({
+      entries: [
+        { key: 'visible', type: 'string', value: 'a' },
+        { key: '__internal', type: 'string', value: 'b' },
+      ],
+    });
+    const preview = computePreview(snapshot, {
+      target,
+      capabilities: allTypes,
+      entryKeys: new Set(),
+      isBlacklisted: (key) => key.startsWith('__'),
+    });
+    expect(preview.skippedKeys).toEqual([
+      { key: '__internal', reason: 'blacklist' },
+    ]);
+    expect(preview.newKeys).toEqual(['visible']);
+  });
+
+  it('surfaces unsupported types', () => {
+    const stringOnly: StorageCapabilities = { supportedTypes: ['string'] };
+    const snapshot = validSnapshot({
+      entries: [
+        { key: 'ok', type: 'string', value: 'a' },
+        { key: 'bad', type: 'buffer', value: [1, 2] },
+      ],
+    });
+    const preview = computePreview(snapshot, {
+      target,
+      capabilities: stringOnly,
+      entryKeys: new Set(),
+      isBlacklisted: noBlacklist,
+    });
+    expect(preview.unsupportedTypes).toEqual([{ key: 'bad', type: 'buffer' }]);
+    expect(preview.newKeys).toEqual(['ok']);
+  });
+
+  it('prioritises unsupportedTypes over blacklist over overwrite/new', () => {
+    const stringOnly: StorageCapabilities = { supportedTypes: ['string'] };
+    const snapshot = validSnapshot({
+      entries: [
+        { key: '__blocked', type: 'buffer', value: [1] }, // unsupported wins
+        { key: '__skipped', type: 'string', value: 'a' }, // blacklist
+        { key: 'existing', type: 'string', value: 'b' },
+        { key: 'fresh', type: 'string', value: 'c' },
+      ],
+    });
+    const preview = computePreview(snapshot, {
+      target,
+      capabilities: stringOnly,
+      entryKeys: new Set(['existing']),
+      isBlacklisted: (key) => key.startsWith('__'),
+    });
+    expect(preview.unsupportedTypes).toEqual([
+      { key: '__blocked', type: 'buffer' },
+    ]);
+    expect(preview.skippedKeys).toEqual([
+      { key: '__skipped', reason: 'blacklist' },
+    ]);
+    expect(preview.overwriteKeys).toEqual(['existing']);
+    expect(preview.newKeys).toEqual(['fresh']);
+  });
+
+  it('flags metadataMismatch when adapter or storage IDs differ', () => {
+    const snapshot = validSnapshot({
+      storage: {
+        adapterId: 'async-storage',
+        storageId: 'default',
+        adapterName: 'AsyncStorage',
+        storageName: 'default',
+        capabilities: allTypes,
+      },
+    });
+    const preview = computePreview(snapshot, {
+      target,
+      capabilities: allTypes,
+      entryKeys: new Set(),
+      isBlacklisted: noBlacklist,
+    });
+    expect(preview.metadataMismatch).toBe(true);
+  });
+
+  it('reports metadataMismatch=false for matching target', () => {
+    const preview = computePreview(validSnapshot(), {
+      target,
+      capabilities: allTypes,
+      entryKeys: new Set(),
+      isBlacklisted: noBlacklist,
+    });
+    expect(preview.metadataMismatch).toBe(false);
+  });
+});

package/src/shared/messaging.ts

@@ -1,11 +1,17 @@
 import type { StorageCapabilities, StorageEntry, StorageTarget } from './types';
 
+export type SerializedBlacklist = {
+  source: string;
+  flags: string;
+};
+
 export type StorageSnapshotEvent = {
   type: 'snapshot';
   target: StorageTarget;
   adapterName: string;
   storageName: string;
   capabilities: StorageCapabilities;
+  blacklist?: SerializedBlacklist;
   entries: StorageEntry[];
 };
 
@@ -26,11 +32,29 @@ export type StorageGetSnapshotEvent = {
   target: StorageTarget | 'all';
 };
 
+export type StorageImportEntriesEvent = {
+  type: 'import-entries';
+  target: StorageTarget;
+  entries: StorageEntry[];
+};
+
+export type StorageImportResultEvent = {
+  type: 'import-result';
+  target: StorageTarget;
+  ok: boolean;
+  written: number;
+  total: number;
+  failedKey?: string;
+  error?: string;
+};
+
 export type StorageEvent =
   | StorageSnapshotEvent
   | StorageSetEntryEvent
   | StorageDeleteEntryEvent
-  | StorageGetSnapshotEvent;
+  | StorageGetSnapshotEvent
+  | StorageImportEntriesEvent
+  | StorageImportResultEvent;
 
 export type StorageEventMap = {
   [K in StorageEvent['type']]: Extract<StorageEvent, { type: K }>;