react-native-nitro-storage 0.1.3 → 0.3.0

package/src/index.ts

@@ -1,10 +1,61 @@
-import { useSyncExternalStore } from "react";
+import { useRef, useSyncExternalStore } from "react";
 import { NitroModules } from "react-native-nitro-modules";
 import type { Storage } from "./Storage.nitro";
 import { StorageScope } from "./Storage.types";
+import {
+  MIGRATION_VERSION_KEY,
+  type StoredEnvelope,
+  isStoredEnvelope,
+  assertBatchScope,
+  assertValidScope,
+  decodeNativeBatchValue,
+  serializeWithPrimitiveFastPath,
+  deserializeWithPrimitiveFastPath,
+} from "./internal";
 
 export { StorageScope } from "./Storage.types";
 export type { Storage } from "./Storage.nitro";
+export { migrateFromMMKV } from "./migration";
+
+export type Validator<T> = (value: unknown) => value is T;
+export type ExpirationConfig = {
+  ttlMs: number;
+};
+
+export type MigrationContext = {
+  scope: StorageScope;
+  getRaw: (key: string) => string | undefined;
+  setRaw: (key: string, value: string) => void;
+  removeRaw: (key: string) => void;
+};
+
+export type Migration = (context: MigrationContext) => void;
+
+export type TransactionContext = {
+  scope: StorageScope;
+  getRaw: (key: string) => string | undefined;
+  setRaw: (key: string, value: string) => void;
+  removeRaw: (key: string) => void;
+  getItem: <T>(item: Pick<StorageItem<T>, "scope" | "key" | "get">) => T;
+  setItem: <T>(item: Pick<StorageItem<T>, "scope" | "key" | "set">, value: T) => void;
+  removeItem: (item: Pick<StorageItem<unknown>, "scope" | "key" | "delete">) => void;
+};
+
+type KeyListenerRegistry = Map<string, Set<() => void>>;
+type RawBatchPathItem = {
+  _hasValidation?: boolean;
+  _hasExpiration?: boolean;
+};
+type NonMemoryScope = StorageScope.Disk | StorageScope.Secure;
+type PendingSecureWrite = { key: string; value: string | undefined };
+
+const registeredMigrations = new Map<number, Migration>();
+const runMicrotask =
+  typeof queueMicrotask === "function"
+    ? queueMicrotask
+    : (task: () => void) => {
+        Promise.resolve().then(task);
+      };
 
 let _storageModule: Storage | null = null;
 
@@ -12,24 +63,255 @@ function getStorageModule(): Storage {
   if (!_storageModule) {
     _storageModule = NitroModules.createHybridObject<Storage>("Storage");
   }
-  return _storageModule!;
+  return _storageModule;
+}
+
+const memoryStore = new Map<string, unknown>();
+const memoryListeners: KeyListenerRegistry = new Map();
+const scopedListeners = new Map<NonMemoryScope, KeyListenerRegistry>([
+  [StorageScope.Disk, new Map()],
+  [StorageScope.Secure, new Map()],
+]);
+const scopedUnsubscribers = new Map<NonMemoryScope, () => void>();
+const scopedRawCache = new Map<NonMemoryScope, Map<string, string | undefined>>([
+  [StorageScope.Disk, new Map()],
+  [StorageScope.Secure, new Map()],
+]);
+const pendingSecureWrites = new Map<string, PendingSecureWrite>();
+let secureFlushScheduled = false;
+
+function getScopedListeners(scope: NonMemoryScope): KeyListenerRegistry {
+  return scopedListeners.get(scope)!;
+}
+
+function getScopeRawCache(scope: NonMemoryScope): Map<string, string | undefined> {
+  return scopedRawCache.get(scope)!;
+}
+
+function cacheRawValue(scope: NonMemoryScope, key: string, value: string | undefined): void {
+  getScopeRawCache(scope).set(key, value);
+}
+
+function readCachedRawValue(
+  scope: NonMemoryScope,
+  key: string
+): string | undefined {
+  return getScopeRawCache(scope).get(key);
+}
+
+function hasCachedRawValue(scope: NonMemoryScope, key: string): boolean {
+  return getScopeRawCache(scope).has(key);
+}
+
+function clearScopeRawCache(scope: NonMemoryScope): void {
+  getScopeRawCache(scope).clear();
+}
+
+function notifyKeyListeners(registry: KeyListenerRegistry, key: string): void {
+  registry.get(key)?.forEach((listener) => listener());
+}
+
+function notifyAllListeners(registry: KeyListenerRegistry): void {
+  registry.forEach((listeners) => {
+    listeners.forEach((listener) => listener());
+  });
+}
+
+function addKeyListener(
+  registry: KeyListenerRegistry,
+  key: string,
+  listener: () => void
+): () => void {
+  let listeners = registry.get(key);
+  if (!listeners) {
+    listeners = new Set();
+    registry.set(key, listeners);
+  }
+  listeners.add(listener);
+
+  return () => {
+    const scopedListeners = registry.get(key);
+    if (!scopedListeners) {
+      return;
+    }
+    scopedListeners.delete(listener);
+    if (scopedListeners.size === 0) {
+      registry.delete(key);
+    }
+  };
+}
+
+function readPendingSecureWrite(key: string): string | undefined {
+  return pendingSecureWrites.get(key)?.value;
+}
+
+function hasPendingSecureWrite(key: string): boolean {
+  return pendingSecureWrites.has(key);
 }
 
-const memoryStore = new Map<string, any>();
-const memoryListeners = new Set<(key: string, value: any) => void>();
+function clearPendingSecureWrite(key: string): void {
+  pendingSecureWrites.delete(key);
+}
+
+function flushSecureWrites(): void {
+  secureFlushScheduled = false;
+
+  if (pendingSecureWrites.size === 0) {
+    return;
+  }
+
+  const writes = Array.from(pendingSecureWrites.values());
+  pendingSecureWrites.clear();
+
+  const keysToSet: string[] = [];
+  const valuesToSet: string[] = [];
+  const keysToRemove: string[] = [];
+
+  writes.forEach(({ key, value }) => {
+    if (value === undefined) {
+      keysToRemove.push(key);
+    } else {
+      keysToSet.push(key);
+      valuesToSet.push(value);
+    }
+  });
+
+  const storageModule = getStorageModule();
+  if (keysToSet.length > 0) {
+    storageModule.setBatch(keysToSet, valuesToSet, StorageScope.Secure);
+  }
+  if (keysToRemove.length > 0) {
+    storageModule.removeBatch(keysToRemove, StorageScope.Secure);
+  }
+}
 
-function notifyMemoryListeners(key: string, value: any) {
-  memoryListeners.forEach((listener) => listener(key, value));
+function scheduleSecureWrite(key: string, value: string | undefined): void {
+  pendingSecureWrites.set(key, { key, value });
+  if (secureFlushScheduled) {
+    return;
+  }
+  secureFlushScheduled = true;
+  runMicrotask(flushSecureWrites);
+}
+
+function ensureNativeScopeSubscription(scope: NonMemoryScope): void {
+  if (scopedUnsubscribers.has(scope)) {
+    return;
+  }
+
+  const unsubscribe = getStorageModule().addOnChange(scope, (key, value) => {
+    if (scope === StorageScope.Secure) {
+      if (key === "") {
+        pendingSecureWrites.clear();
+      } else {
+        clearPendingSecureWrite(key);
+      }
+    }
+
+    if (key === "") {
+      clearScopeRawCache(scope);
+      notifyAllListeners(getScopedListeners(scope));
+      return;
+    }
+
+    cacheRawValue(scope, key, value);
+    notifyKeyListeners(getScopedListeners(scope), key);
+  });
+  scopedUnsubscribers.set(scope, unsubscribe);
+}
+
+function maybeCleanupNativeScopeSubscription(scope: NonMemoryScope): void {
+  const listeners = getScopedListeners(scope);
+  if (listeners.size > 0) {
+    return;
+  }
+
+  const unsubscribe = scopedUnsubscribers.get(scope);
+  if (!unsubscribe) {
+    return;
+  }
+
+  unsubscribe();
+  scopedUnsubscribers.delete(scope);
+}
+
+function getRawValue(key: string, scope: StorageScope): string | undefined {
+  assertValidScope(scope);
+  if (scope === StorageScope.Memory) {
+    const value = memoryStore.get(key);
+    return typeof value === "string" ? value : undefined;
+  }
+
+  if (scope === StorageScope.Secure && hasPendingSecureWrite(key)) {
+    return readPendingSecureWrite(key);
+  }
+
+  return getStorageModule().get(key, scope);
+}
+
+function setRawValue(key: string, value: string, scope: StorageScope): void {
+  assertValidScope(scope);
+  if (scope === StorageScope.Memory) {
+    memoryStore.set(key, value);
+    notifyKeyListeners(memoryListeners, key);
+    return;
+  }
+
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+    clearPendingSecureWrite(key);
+  }
+
+  getStorageModule().set(key, value, scope);
+  cacheRawValue(scope, key, value);
+}
+
+function removeRawValue(key: string, scope: StorageScope): void {
+  assertValidScope(scope);
+  if (scope === StorageScope.Memory) {
+    memoryStore.delete(key);
+    notifyKeyListeners(memoryListeners, key);
+    return;
+  }
+
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+    clearPendingSecureWrite(key);
+  }
+
+  getStorageModule().remove(key, scope);
+  cacheRawValue(scope, key, undefined);
+}
+
+function readMigrationVersion(scope: StorageScope): number {
+  const raw = getRawValue(MIGRATION_VERSION_KEY, scope);
+  if (raw === undefined) {
+    return 0;
+  }
+
+  const parsed = Number.parseInt(raw, 10);
+  return Number.isFinite(parsed) && parsed > 0 ? parsed : 0;
+}
+
+function writeMigrationVersion(scope: StorageScope, version: number): void {
+  setRawValue(MIGRATION_VERSION_KEY, String(version), scope);
 }
 
 export const storage = {
   clear: (scope: StorageScope) => {
     if (scope === StorageScope.Memory) {
       memoryStore.clear();
-      notifyMemoryListeners("", undefined);
-    } else {
-      getStorageModule().clear(scope);
+      notifyAllListeners(memoryListeners);
+      return;
+    }
+
+    if (scope === StorageScope.Secure) {
+      flushSecureWrites();
+      pendingSecureWrites.clear();
     }
+
+    clearScopeRawCache(scope);
+    getStorageModule().clear(scope);
   },
   clearAll: () => {
     storage.clear(StorageScope.Memory);
@@ -44,6 +326,11 @@ export interface StorageItemConfig<T> {
   defaultValue?: T;
   serialize?: (value: T) => string;
   deserialize?: (value: string) => T;
+  validate?: Validator<T>;
+  onValidationError?: (invalidValue: unknown) => T;
+  expiration?: ExpirationConfig;
+  readCache?: boolean;
+  coalesceSecureWrites?: boolean;
 }
 
 export interface StorageItem<T> {
@@ -54,16 +341,23 @@ export interface StorageItem<T> {
   serialize: (value: T) => string;
   deserialize: (value: string) => T;
   _triggerListeners: () => void;
+  _hasValidation?: boolean;
+  _hasExpiration?: boolean;
+  _readCacheEnabled?: boolean;
   scope: StorageScope;
   key: string;
 }
 
+function canUseRawBatchPath(item: RawBatchPathItem): boolean {
+  return item._hasExpiration === false && item._hasValidation === false;
+}
+
 function defaultSerialize<T>(value: T): string {
-  return JSON.stringify(value);
+  return serializeWithPrimitiveFastPath(value);
 }
 
 function defaultDeserialize<T>(value: string): T {
-  return JSON.parse(value) as T;
+  return deserializeWithPrimitiveFastPath(value);
 }
 
 export function createStorageItem<T = undefined>(
@@ -72,62 +366,210 @@ export function createStorageItem<T = undefined>(
   const serialize = config.serialize ?? defaultSerialize;
   const deserialize = config.deserialize ?? defaultDeserialize;
   const isMemory = config.scope === StorageScope.Memory;
+  const validate = config.validate;
+  const onValidationError = config.onValidationError;
+  const expiration = config.expiration;
+  const expirationTtlMs = expiration?.ttlMs;
+  const memoryExpiration = expiration && isMemory ? new Map<string, number>() : null;
+  const readCache = !isMemory && config.readCache === true;
+  const coalesceSecureWrites =
+    config.scope === StorageScope.Secure && config.coalesceSecureWrites === true;
+  const nonMemoryScope: NonMemoryScope | null =
+    config.scope === StorageScope.Disk
+      ? StorageScope.Disk
+      : config.scope === StorageScope.Secure
+        ? StorageScope.Secure
+        : null;
+
+  if (expiration && expiration.ttlMs <= 0) {
+    throw new Error("expiration.ttlMs must be greater than 0.");
+  }
 
   const listeners = new Set<() => void>();
   let unsubscribe: (() => void) | null = null;
+  let lastRaw: unknown = undefined;
+  let lastValue: T | undefined;
+  let hasLastValue = false;
+
+  const invalidateParsedCache = () => {
+    lastRaw = undefined;
+    lastValue = undefined;
+    hasLastValue = false;
+  };
 
   const ensureSubscription = () => {
-    if (!unsubscribe) {
-      if (isMemory) {
-        const listener = (key: string) => {
-          if (key === "" || key === config.key) {
-            lastRaw = undefined;
-            lastValue = undefined;
-            listeners.forEach((l) => l());
-          }
-        };
-        memoryListeners.add(listener);
-        unsubscribe = () => memoryListeners.delete(listener);
-      } else {
-        unsubscribe = getStorageModule().addOnChange(config.scope, (key) => {
-          if (key === "" || key === config.key) {
-            lastRaw = undefined;
-            lastValue = undefined;
-            listeners.forEach((listener) => listener());
-          }
-        });
+    if (unsubscribe) {
+      return;
+    }
+
+    const listener = () => {
+      invalidateParsedCache();
+      listeners.forEach((callback) => callback());
+    };
+
+    if (isMemory) {
+      unsubscribe = addKeyListener(memoryListeners, config.key, listener);
+      return;
+    }
+
+    ensureNativeScopeSubscription(nonMemoryScope!);
+    unsubscribe = addKeyListener(getScopedListeners(nonMemoryScope!), config.key, listener);
+  };
+
+  const readStoredRaw = (): unknown => {
+    if (isMemory) {
+      if (memoryExpiration) {
+        const expiresAt = memoryExpiration.get(config.key);
+        if (expiresAt !== undefined && expiresAt <= Date.now()) {
+          memoryExpiration.delete(config.key);
+          memoryStore.delete(config.key);
+          notifyKeyListeners(memoryListeners, config.key);
+          return undefined;
+        }
+      }
+      return memoryStore.get(config.key) as T | undefined;
+    }
+
+    if (nonMemoryScope === StorageScope.Secure && hasPendingSecureWrite(config.key)) {
+      return readPendingSecureWrite(config.key);
+    }
+
+    if (readCache) {
+      if (hasCachedRawValue(nonMemoryScope!, config.key)) {
+        return readCachedRawValue(nonMemoryScope!, config.key);
       }
     }
+
+    const raw = getStorageModule().get(config.key, config.scope);
+    cacheRawValue(nonMemoryScope!, config.key, raw);
+    return raw;
   };
 
-  let lastRaw: string | undefined;
-  let lastValue: T | undefined;
+  const writeStoredRaw = (rawValue: string): void => {
+    cacheRawValue(nonMemoryScope!, config.key, rawValue);
 
-  const get = (): T => {
-    let raw: string | undefined;
+    if (coalesceSecureWrites) {
+      scheduleSecureWrite(config.key, rawValue);
+      return;
+    }
+
+    if (nonMemoryScope === StorageScope.Secure) {
+      clearPendingSecureWrite(config.key);
+    }
+
+    getStorageModule().set(config.key, rawValue, config.scope);
+  };
+
+  const removeStoredRaw = (): void => {
+    cacheRawValue(nonMemoryScope!, config.key, undefined);
 
+    if (coalesceSecureWrites) {
+      scheduleSecureWrite(config.key, undefined);
+      return;
+    }
+
+    if (nonMemoryScope === StorageScope.Secure) {
+      clearPendingSecureWrite(config.key);
+    }
+
+    getStorageModule().remove(config.key, config.scope);
+  };
+
+  const writeValueWithoutValidation = (value: T): void => {
     if (isMemory) {
-      raw = memoryStore.get(config.key);
-    } else {
-      raw = getStorageModule().get(config.key, config.scope);
+      if (memoryExpiration) {
+        memoryExpiration.set(config.key, Date.now() + (expirationTtlMs ?? 0));
+      }
+      memoryStore.set(config.key, value);
+      notifyKeyListeners(memoryListeners, config.key);
+      return;
     }
 
-    if (raw === lastRaw && lastValue !== undefined) {
-      return lastValue;
+    const serialized = serialize(value);
+    if (expiration) {
+      const envelope: StoredEnvelope = {
+        __nitroStorageEnvelope: true,
+        expiresAt: Date.now() + expiration.ttlMs,
+        payload: serialized,
+      };
+      writeStoredRaw(JSON.stringify(envelope));
+      return;
+    }
+
+    writeStoredRaw(serialized);
+  };
+
+  const resolveInvalidValue = (invalidValue: unknown): T => {
+    if (onValidationError) {
+      return onValidationError(invalidValue);
+    }
+
+    return config.defaultValue as T;
+  };
+
+  const ensureValidatedValue = (
+    candidate: unknown,
+    hadStoredValue: boolean
+  ): T => {
+    if (!validate || validate(candidate)) {
+      return candidate as T;
+    }
+
+    const resolved = resolveInvalidValue(candidate);
+    if (validate && !validate(resolved)) {
+      return config.defaultValue as T;
+    }
+    if (hadStoredValue) {
+      writeValueWithoutValidation(resolved);
+    }
+    return resolved;
+  };
+
+  const get = (): T => {
+    const raw = readStoredRaw();
+
+    const canUseCachedValue = !expiration && !memoryExpiration;
+    if (canUseCachedValue && raw === lastRaw && hasLastValue) {
+      return lastValue as T;
     }
 
     lastRaw = raw;
 
     if (raw === undefined) {
-      lastValue = config.defaultValue as T;
-    } else {
-      if (isMemory) {
-        lastValue = raw as T;
-      } else {
-        lastValue = deserialize(raw);
+      lastValue = ensureValidatedValue(config.defaultValue, false);
+      hasLastValue = true;
+      return lastValue;
+    }
+
+    if (isMemory) {
+      lastValue = ensureValidatedValue(raw, true);
+      hasLastValue = true;
+      return lastValue;
+    }
+
+    let deserializableRaw = raw as string;
+
+    if (expiration) {
+      try {
+        const parsed = JSON.parse(raw as string) as unknown;
+        if (isStoredEnvelope(parsed)) {
+          if (parsed.expiresAt <= Date.now()) {
+            removeStoredRaw();
+            invalidateParsedCache();
+            lastValue = ensureValidatedValue(config.defaultValue, false);
+            hasLastValue = true;
+            return lastValue;
+          }
+
+          deserializableRaw = parsed.payload;
+        }
+      } catch {
+        // Keep backward compatibility with legacy raw values.
       }
     }
 
+    lastValue = ensureValidatedValue(deserialize(deserializableRaw), true);
+    hasLastValue = true;
     return lastValue;
   };
 
@@ -138,22 +580,30 @@ export function createStorageItem<T = undefined>(
         ? (valueOrFn as (prev: T) => T)(currentValue)
         : valueOrFn;
 
-    if (isMemory) {
-      memoryStore.set(config.key, newValue);
-      notifyMemoryListeners(config.key, newValue);
-    } else {
-      const serialized = serialize(newValue);
-      getStorageModule().set(config.key, serialized, config.scope);
+    invalidateParsedCache();
+
+    if (validate && !validate(newValue)) {
+      throw new Error(
+        `Validation failed for key "${config.key}" in scope "${StorageScope[config.scope]}".`
+      );
     }
+
+    writeValueWithoutValidation(newValue);
   };
 
   const deleteItem = (): void => {
+    invalidateParsedCache();
+
     if (isMemory) {
+      if (memoryExpiration) {
+        memoryExpiration.delete(config.key);
+      }
       memoryStore.delete(config.key);
-      notifyMemoryListeners(config.key, undefined);
-    } else {
-      getStorageModule().remove(config.key, config.scope);
+      notifyKeyListeners(memoryListeners, config.key);
+      return;
     }
+
+    removeStoredRaw();
   };
 
   const subscribe = (callback: () => void): (() => void) => {
@@ -163,12 +613,15 @@ export function createStorageItem<T = undefined>(
       listeners.delete(callback);
       if (listeners.size === 0 && unsubscribe) {
         unsubscribe();
+        if (!isMemory) {
+          maybeCleanupNativeScopeSubscription(nonMemoryScope!);
+        }
         unsubscribe = null;
       }
     };
   };
 
-  return {
+  const storageItem: StorageItem<T> = {
     get,
     set,
     delete: deleteItem,
@@ -176,13 +629,17 @@ export function createStorageItem<T = undefined>(
     serialize,
     deserialize,
     _triggerListeners: () => {
-      lastRaw = undefined;
-      lastValue = undefined;
-      listeners.forEach((l) => l());
+      invalidateParsedCache();
+      listeners.forEach((listener) => listener());
     },
+    _hasValidation: validate !== undefined,
+    _hasExpiration: expiration !== undefined,
+    _readCacheEnabled: readCache,
     scope: config.scope,
     key: config.key,
   };
+
+  return storageItem;
 }
 
 export function useStorage<T>(
@@ -192,23 +649,109 @@ export function useStorage<T>(
   return [value, item.set];
 }
 
+export function useStorageSelector<T, TSelected>(
+  item: StorageItem<T>,
+  selector: (value: T) => TSelected,
+  isEqual: (prev: TSelected, next: TSelected) => boolean = Object.is
+): [TSelected, (value: T | ((prev: T) => T)) => void] {
+  const selectedRef = useRef<{ hasValue: false } | { hasValue: true; value: TSelected }>({
+    hasValue: false,
+  });
+
+  const getSelectedSnapshot = () => {
+    const nextSelected = selector(item.get());
+    const current = selectedRef.current;
+    if (current.hasValue && isEqual(current.value, nextSelected)) {
+      return current.value;
+    }
+
+    selectedRef.current = { hasValue: true, value: nextSelected };
+    return nextSelected;
+  };
+
+  const selectedValue = useSyncExternalStore(
+    item.subscribe,
+    getSelectedSnapshot,
+    getSelectedSnapshot
+  );
+  return [selectedValue, item.set];
+}
+
 export function useSetStorage<T>(item: StorageItem<T>) {
   return item.set;
 }
 
+type BatchReadItem<T> = Pick<
+  StorageItem<T>,
+  | "key"
+  | "scope"
+  | "get"
+  | "deserialize"
+  | "_hasValidation"
+  | "_hasExpiration"
+  | "_readCacheEnabled"
+>;
+type BatchRemoveItem = Pick<StorageItem<unknown>, "key" | "scope" | "delete">;
+
+export type StorageBatchSetItem<T> = {
+  item: StorageItem<T>;
+  value: T;
+};
+
 export function getBatch(
-  items: StorageItem<any>[],
+  items: readonly BatchReadItem<unknown>[],
   scope: StorageScope
-): any[] {
+): unknown[] {
+  assertBatchScope(items, scope);
+
   if (scope === StorageScope.Memory) {
     return items.map((item) => item.get());
   }
 
-  const keys = items.map((item) => item.key);
-  const rawValues = getStorageModule().getBatch(keys, scope);
+  const useRawBatchPath = items.every((item) => canUseRawBatchPath(item));
+  if (!useRawBatchPath) {
+    return items.map((item) => item.get());
+  }
+  const useBatchCache = items.every((item) => item._readCacheEnabled === true);
+
+  const rawValues = new Array<string | undefined>(items.length);
+  const keysToFetch: string[] = [];
+  const keyIndexes: number[] = [];
+
+  items.forEach((item, index) => {
+    if (scope === StorageScope.Secure) {
+      if (hasPendingSecureWrite(item.key)) {
+        rawValues[index] = readPendingSecureWrite(item.key);
+        return;
+      }
+    }
 
-  return items.map((item, idx) => {
-    const raw = rawValues[idx];
+    if (useBatchCache) {
+      if (hasCachedRawValue(scope, item.key)) {
+        rawValues[index] = readCachedRawValue(scope, item.key);
+        return;
+      }
+    }
+
+    keysToFetch.push(item.key);
+    keyIndexes.push(index);
+  });
+
+  if (keysToFetch.length > 0) {
+    const fetchedValues = getStorageModule()
+      .getBatch(keysToFetch, scope)
+      .map((value) => decodeNativeBatchValue(value));
+
+    fetchedValues.forEach((value, index) => {
+      const key = keysToFetch[index];
+      const targetIndex = keyIndexes[index];
+      rawValues[targetIndex] = value;
+      cacheRawValue(scope, key, value);
+    });
+  }
+
+  return items.map((item, index) => {
+    const raw = rawValues[index];
     if (raw === undefined) {
       return item.get();
     }
@@ -216,35 +759,152 @@ export function getBatch(
   });
 }
 
-export function setBatch(
-  items: { item: StorageItem<any>; value: any }[],
+export function setBatch<T>(
+  items: readonly StorageBatchSetItem<T>[],
   scope: StorageScope
 ): void {
+  assertBatchScope(
+    items.map((batchEntry) => batchEntry.item),
+    scope
+  );
+
   if (scope === StorageScope.Memory) {
     items.forEach(({ item, value }) => item.set(value));
     return;
   }
 
-  const keys = items.map((i) => i.item.key);
-  const values = items.map((i) => i.item.serialize(i.value));
+  const useRawBatchPath = items.every(({ item }) => canUseRawBatchPath(item));
+  if (!useRawBatchPath) {
+    items.forEach(({ item, value }) => item.set(value));
+    return;
+  }
 
-  getStorageModule().setBatch(keys, values, scope);
+  const keys = items.map((entry) => entry.item.key);
+  const values = items.map((entry) => entry.item.serialize(entry.value));
 
-  items.forEach(({ item }) => {
-    item._triggerListeners();
-  });
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+  }
+  getStorageModule().setBatch(keys, values, scope);
+  keys.forEach((key, index) => cacheRawValue(scope, key, values[index]));
 }
 
 export function removeBatch(
-  items: StorageItem<any>[],
+  items: readonly BatchRemoveItem[],
   scope: StorageScope
 ): void {
+  assertBatchScope(items, scope);
+
   if (scope === StorageScope.Memory) {
     items.forEach((item) => item.delete());
     return;
   }
 
   const keys = items.map((item) => item.key);
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+  }
   getStorageModule().removeBatch(keys, scope);
-  items.forEach((item) => item.delete());
+  keys.forEach((key) => cacheRawValue(scope, key, undefined));
+}
+
+export function registerMigration(version: number, migration: Migration): void {
+  if (!Number.isInteger(version) || version <= 0) {
+    throw new Error("Migration version must be a positive integer.");
+  }
+
+  if (registeredMigrations.has(version)) {
+    throw new Error(`Migration version ${version} is already registered.`);
+  }
+
+  registeredMigrations.set(version, migration);
+}
+
+export function migrateToLatest(scope: StorageScope = StorageScope.Disk): number {
+  assertValidScope(scope);
+  const currentVersion = readMigrationVersion(scope);
+  const versions = Array.from(registeredMigrations.keys())
+    .filter((version) => version > currentVersion)
+    .sort((a, b) => a - b);
+
+  let appliedVersion = currentVersion;
+  const context: MigrationContext = {
+    scope,
+    getRaw: (key) => getRawValue(key, scope),
+    setRaw: (key, value) => setRawValue(key, value, scope),
+    removeRaw: (key) => removeRawValue(key, scope),
+  };
+
+  versions.forEach((version) => {
+    const migration = registeredMigrations.get(version);
+    if (!migration) {
+      return;
+    }
+    migration(context);
+    writeMigrationVersion(scope, version);
+    appliedVersion = version;
+  });
+
+  return appliedVersion;
+}
+
+export function runTransaction<T>(
+  scope: StorageScope,
+  transaction: (context: TransactionContext) => T
+): T {
+  assertValidScope(scope);
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+  }
+
+  const rollback = new Map<string, string | undefined>();
+
+  const rememberRollback = (key: string) => {
+    if (rollback.has(key)) {
+      return;
+    }
+    rollback.set(key, getRawValue(key, scope));
+  };
+
+  const tx: TransactionContext = {
+    scope,
+    getRaw: (key) => getRawValue(key, scope),
+    setRaw: (key, value) => {
+      rememberRollback(key);
+      setRawValue(key, value, scope);
+    },
+    removeRaw: (key) => {
+      rememberRollback(key);
+      removeRawValue(key, scope);
+    },
+    getItem: (item) => {
+      assertBatchScope([item], scope);
+      return item.get();
+    },
+    setItem: (item, value) => {
+      assertBatchScope([item], scope);
+      rememberRollback(item.key);
+      item.set(value);
+    },
+    removeItem: (item) => {
+      assertBatchScope([item], scope);
+      rememberRollback(item.key);
+      item.delete();
+    },
+  };
+
+  try {
+    return transaction(tx);
+  } catch (error) {
+    Array.from(rollback.entries())
+      .reverse()
+      .forEach(([key, previousValue]) => {
+        if (previousValue === undefined) {
+          removeRawValue(key, scope);
+        } else {
+          setRawValue(key, previousValue, scope);
+        }
+      });
+    throw error;
+  }
 }