react-native-nitro-storage 0.1.3 → 0.3.0

package/lib/module/index.js

@@ -1,9 +1,15 @@
 "use strict";
 
-import { useSyncExternalStore } from "react";
+import { useRef, useSyncExternalStore } from "react";
 import { NitroModules } from "react-native-nitro-modules";
 import { StorageScope } from "./Storage.types";
+import { MIGRATION_VERSION_KEY, isStoredEnvelope, assertBatchScope, assertValidScope, decodeNativeBatchValue, serializeWithPrimitiveFastPath, deserializeWithPrimitiveFastPath } from "./internal";
 export { StorageScope } from "./Storage.types";
+export { migrateFromMMKV } from "./migration";
+const registeredMigrations = new Map();
+const runMicrotask = typeof queueMicrotask === "function" ? queueMicrotask : task => {
+  Promise.resolve().then(task);
+};
 let _storageModule = null;
 function getStorageModule() {
   if (!_storageModule) {
@@ -12,18 +18,202 @@ function getStorageModule() {
   return _storageModule;
 }
 const memoryStore = new Map();
-const memoryListeners = new Set();
-function notifyMemoryListeners(key, value) {
-  memoryListeners.forEach(listener => listener(key, value));
+const memoryListeners = new Map();
+const scopedListeners = new Map([[StorageScope.Disk, new Map()], [StorageScope.Secure, new Map()]]);
+const scopedUnsubscribers = new Map();
+const scopedRawCache = new Map([[StorageScope.Disk, new Map()], [StorageScope.Secure, new Map()]]);
+const pendingSecureWrites = new Map();
+let secureFlushScheduled = false;
+function getScopedListeners(scope) {
+  return scopedListeners.get(scope);
+}
+function getScopeRawCache(scope) {
+  return scopedRawCache.get(scope);
+}
+function cacheRawValue(scope, key, value) {
+  getScopeRawCache(scope).set(key, value);
+}
+function readCachedRawValue(scope, key) {
+  return getScopeRawCache(scope).get(key);
+}
+function hasCachedRawValue(scope, key) {
+  return getScopeRawCache(scope).has(key);
+}
+function clearScopeRawCache(scope) {
+  getScopeRawCache(scope).clear();
+}
+function notifyKeyListeners(registry, key) {
+  registry.get(key)?.forEach(listener => listener());
+}
+function notifyAllListeners(registry) {
+  registry.forEach(listeners => {
+    listeners.forEach(listener => listener());
+  });
+}
+function addKeyListener(registry, key, listener) {
+  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) {
+  return pendingSecureWrites.get(key)?.value;
+}
+function hasPendingSecureWrite(key) {
+  return pendingSecureWrites.has(key);
+}
+function clearPendingSecureWrite(key) {
+  pendingSecureWrites.delete(key);
+}
+function flushSecureWrites() {
+  secureFlushScheduled = false;
+  if (pendingSecureWrites.size === 0) {
+    return;
+  }
+  const writes = Array.from(pendingSecureWrites.values());
+  pendingSecureWrites.clear();
+  const keysToSet = [];
+  const valuesToSet = [];
+  const keysToRemove = [];
+  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 scheduleSecureWrite(key, value) {
+  pendingSecureWrites.set(key, {
+    key,
+    value
+  });
+  if (secureFlushScheduled) {
+    return;
+  }
+  secureFlushScheduled = true;
+  runMicrotask(flushSecureWrites);
+}
+function ensureNativeScopeSubscription(scope) {
+  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) {
+  const listeners = getScopedListeners(scope);
+  if (listeners.size > 0) {
+    return;
+  }
+  const unsubscribe = scopedUnsubscribers.get(scope);
+  if (!unsubscribe) {
+    return;
+  }
+  unsubscribe();
+  scopedUnsubscribers.delete(scope);
+}
+function getRawValue(key, scope) {
+  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, value, scope) {
+  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, scope) {
+  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) {
+  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, version) {
+  setRawValue(MIGRATION_VERSION_KEY, String(version), scope);
 }
 export const storage = {
   clear: scope => {
     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);
@@ -31,83 +221,201 @@ export const storage = {
     storage.clear(StorageScope.Secure);
   }
 };
+function canUseRawBatchPath(item) {
+  return item._hasExpiration === false && item._hasValidation === false;
+}
 function defaultSerialize(value) {
-  return JSON.stringify(value);
+  return serializeWithPrimitiveFastPath(value);
 }
 function defaultDeserialize(value) {
-  return JSON.parse(value);
+  return deserializeWithPrimitiveFastPath(value);
 }
 export function createStorageItem(config) {
   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() : null;
+  const readCache = !isMemory && config.readCache === true;
+  const coalesceSecureWrites = config.scope === StorageScope.Secure && config.coalesceSecureWrites === true;
+  const nonMemoryScope = 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();
   let unsubscribe = null;
+  let lastRaw = undefined;
+  let lastValue;
+  let hasLastValue = false;
+  const invalidateParsedCache = () => {
+    lastRaw = undefined;
+    lastValue = undefined;
+    hasLastValue = false;
+  };
   const ensureSubscription = () => {
-    if (!unsubscribe) {
-      if (isMemory) {
-        const listener = key => {
-          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 = () => {
+    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);
+    }
+    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;
-  let lastValue;
-  const get = () => {
-    let raw;
+  const writeStoredRaw = rawValue => {
+    cacheRawValue(nonMemoryScope, config.key, rawValue);
+    if (coalesceSecureWrites) {
+      scheduleSecureWrite(config.key, rawValue);
+      return;
+    }
+    if (nonMemoryScope === StorageScope.Secure) {
+      clearPendingSecureWrite(config.key);
+    }
+    getStorageModule().set(config.key, rawValue, config.scope);
+  };
+  const removeStoredRaw = () => {
+    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 => {
     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) {
+    const serialized = serialize(value);
+    if (expiration) {
+      const envelope = {
+        __nitroStorageEnvelope: true,
+        expiresAt: Date.now() + expiration.ttlMs,
+        payload: serialized
+      };
+      writeStoredRaw(JSON.stringify(envelope));
+      return;
+    }
+    writeStoredRaw(serialized);
+  };
+  const resolveInvalidValue = invalidValue => {
+    if (onValidationError) {
+      return onValidationError(invalidValue);
+    }
+    return config.defaultValue;
+  };
+  const ensureValidatedValue = (candidate, hadStoredValue) => {
+    if (!validate || validate(candidate)) {
+      return candidate;
+    }
+    const resolved = resolveInvalidValue(candidate);
+    if (validate && !validate(resolved)) {
+      return config.defaultValue;
+    }
+    if (hadStoredValue) {
+      writeValueWithoutValidation(resolved);
+    }
+    return resolved;
+  };
+  const get = () => {
+    const raw = readStoredRaw();
+    const canUseCachedValue = !expiration && !memoryExpiration;
+    if (canUseCachedValue && raw === lastRaw && hasLastValue) {
       return lastValue;
     }
     lastRaw = raw;
     if (raw === undefined) {
-      lastValue = config.defaultValue;
-    } else {
-      if (isMemory) {
-        lastValue = raw;
-      } 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;
+    if (expiration) {
+      try {
+        const parsed = JSON.parse(raw);
+        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;
   };
   const set = valueOrFn => {
     const currentValue = get();
     const newValue = typeof valueOrFn === "function" ? valueOrFn(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 = () => {
+    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 => {
     ensureSubscription();
@@ -116,11 +424,14 @@ export function createStorageItem(config) {
       listeners.delete(callback);
       if (listeners.size === 0 && unsubscribe) {
         unsubscribe();
+        if (!isMemory) {
+          maybeCleanupNativeScopeSubscription(nonMemoryScope);
+        }
         unsubscribe = null;
       }
     };
   };
-  return {
+  const storageItem = {
     get,
     set,
     delete: deleteItem,
@@ -128,29 +439,83 @@ export function createStorageItem(config) {
     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(item) {
   const value = useSyncExternalStore(item.subscribe, item.get, item.get);
   return [value, item.set];
 }
+export function useStorageSelector(item, selector, isEqual = Object.is) {
+  const selectedRef = useRef({
+    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(item) {
   return item.set;
 }
 export function getBatch(items, scope) {
+  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);
-  return items.map((item, idx) => {
-    const raw = rawValues[idx];
+  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(items.length);
+  const keysToFetch = [];
+  const keyIndexes = [];
+  items.forEach((item, index) => {
+    if (scope === StorageScope.Secure) {
+      if (hasPendingSecureWrite(item.key)) {
+        rawValues[index] = readPendingSecureWrite(item.key);
+        return;
+      }
+    }
+    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();
     }
@@ -158,6 +523,7 @@ export function getBatch(items, scope) {
   });
 }
 export function setBatch(items, scope) {
+  assertBatchScope(items.map(batchEntry => batchEntry.item), scope);
   if (scope === StorageScope.Memory) {
     items.forEach(({
       item,
@@ -165,22 +531,117 @@ export function setBatch(items, scope) {
     }) => item.set(value));
     return;
   }
-  const keys = items.map(i => i.item.key);
-  const values = items.map(i => i.item.serialize(i.value));
-  getStorageModule().setBatch(keys, values, scope);
-  items.forEach(({
+  const useRawBatchPath = items.every(({
     item
-  }) => {
-    item._triggerListeners();
-  });
+  }) => canUseRawBatchPath(item));
+  if (!useRawBatchPath) {
+    items.forEach(({
+      item,
+      value
+    }) => item.set(value));
+    return;
+  }
+  const keys = items.map(entry => entry.item.key);
+  const values = items.map(entry => entry.item.serialize(entry.value));
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+  }
+  getStorageModule().setBatch(keys, values, scope);
+  keys.forEach((key, index) => cacheRawValue(scope, key, values[index]));
 }
 export function removeBatch(items, scope) {
+  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, migration) {
+  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.Disk) {
+  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 = {
+    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(scope, transaction) {
+  assertValidScope(scope);
+  if (scope === StorageScope.Secure) {
+    flushSecureWrites();
+  }
+  const rollback = new Map();
+  const rememberRollback = key => {
+    if (rollback.has(key)) {
+      return;
+    }
+    rollback.set(key, getRawValue(key, scope));
+  };
+  const tx = {
+    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;
+  }
 }
 //# sourceMappingURL=index.js.map