react-native-mmkv 4.0.0 → 4.1.0

package/nitrogen/generated/ios/swift/HybridMMKVPlatformContextSpec_cxx.swift

@@ -76,7 +76,7 @@ open class HybridMMKVPlatformContextSpec_cxx {
    */
   public func getCxxPart() -> bridge.std__shared_ptr_HybridMMKVPlatformContextSpec_ {
     let cachedCxxPart = self.__cxxPart.lock()
-    if cachedCxxPart.__convertToBool() {
+    if Bool(fromCxx: cachedCxxPart) {
       return cachedCxxPart
     } else {
       let newCxxPart = bridge.create_std__shared_ptr_HybridMMKVPlatformContextSpec_(self.toUnsafe())
@@ -105,6 +105,14 @@ open class HybridMMKVPlatformContextSpec_cxx {
     self.__implementation.dispose()
   }
 
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public func toString() -> String {
+    return self.__implementation.toString()
+  }
+
   // Properties
   
 

package/nitrogen/generated/shared/c++/HybridMMKVFactorySpec.cpp

@@ -15,8 +15,10 @@ namespace margelo::nitro::mmkv {
     // load custom methods/properties
     registerHybrids(this, [](Prototype& prototype) {
       prototype.registerHybridGetter("defaultMMKVInstanceId", &HybridMMKVFactorySpec::getDefaultMMKVInstanceId);
-      prototype.registerHybridMethod("createMMKV", &HybridMMKVFactorySpec::createMMKV);
       prototype.registerHybridMethod("initializeMMKV", &HybridMMKVFactorySpec::initializeMMKV);
+      prototype.registerHybridMethod("createMMKV", &HybridMMKVFactorySpec::createMMKV);
+      prototype.registerHybridMethod("deleteMMKV", &HybridMMKVFactorySpec::deleteMMKV);
+      prototype.registerHybridMethod("existsMMKV", &HybridMMKVFactorySpec::existsMMKV);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridMMKVFactorySpec.hpp

@@ -54,8 +54,10 @@ namespace margelo::nitro::mmkv {
 
     public:
       // Methods
-      virtual std::shared_ptr<HybridMMKVSpec> createMMKV(const Configuration& configuration) = 0;
       virtual void initializeMMKV(const std::string& rootPath) = 0;
+      virtual std::shared_ptr<HybridMMKVSpec> createMMKV(const Configuration& configuration) = 0;
+      virtual bool deleteMMKV(const std::string& id) = 0;
+      virtual bool existsMMKV(const std::string& id) = 0;
 
     protected:
       // Hybrid Setup

package/nitrogen/generated/shared/c++/HybridMMKVSpec.cpp

@@ -14,6 +14,7 @@ namespace margelo::nitro::mmkv {
     HybridObject::loadHybridMethods();
     // load custom methods/properties
     registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("id", &HybridMMKVSpec::getId);
       prototype.registerHybridGetter("size", &HybridMMKVSpec::getSize);
       prototype.registerHybridGetter("isReadOnly", &HybridMMKVSpec::getIsReadOnly);
       prototype.registerHybridMethod("set", &HybridMMKVSpec::set);
@@ -28,6 +29,7 @@ namespace margelo::nitro::mmkv {
       prototype.registerHybridMethod("recrypt", &HybridMMKVSpec::recrypt);
       prototype.registerHybridMethod("trim", &HybridMMKVSpec::trim);
       prototype.registerHybridMethod("addOnValueChangedListener", &HybridMMKVSpec::addOnValueChangedListener);
+      prototype.registerHybridMethod("importAllFrom", &HybridMMKVSpec::importAllFrom);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridMMKVSpec.hpp

@@ -15,6 +15,8 @@
 
 // Forward declaration of `Listener` to properly resolve imports.
 namespace margelo::nitro::mmkv { struct Listener; }
+// Forward declaration of `HybridMMKVSpec` to properly resolve imports.
+namespace margelo::nitro::mmkv { class HybridMMKVSpec; }
 
 #include <string>
 #include <NitroModules/ArrayBuffer.hpp>
@@ -23,6 +25,8 @@ namespace margelo::nitro::mmkv { struct Listener; }
 #include <vector>
 #include "Listener.hpp"
 #include <functional>
+#include <memory>
+#include "HybridMMKVSpec.hpp"
 
 namespace margelo::nitro::mmkv {
 
@@ -51,6 +55,7 @@ namespace margelo::nitro::mmkv {
 
     public:
       // Properties
+      virtual std::string getId() = 0;
       virtual double getSize() = 0;
       virtual bool getIsReadOnly() = 0;
 
@@ -68,6 +73,7 @@ namespace margelo::nitro::mmkv {
       virtual void recrypt(const std::optional<std::string>& key) = 0;
       virtual void trim() = 0;
       virtual Listener addOnValueChangedListener(const std::function<void(const std::string& /* key */)>& onValueChanged) = 0;
+      virtual double importAllFrom(const std::shared_ptr<HybridMMKVSpec>& other) = 0;
 
     protected:
       // Hybrid Setup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-mmkv",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "⚡️ The fastest key/value storage for React Native.",
   "main": "lib/index",
   "module": "lib/index",
@@ -31,7 +31,6 @@
     "README.md"
   ],
   "scripts": {
-    "postinstall": "tsc || exit 0;",
     "typecheck": "tsc --noEmit",
     "clean": "rm -rf android/build node_modules/**/android/build lib",
     "lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
@@ -68,11 +67,11 @@
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "nitrogen": "0.31.0",
+    "nitrogen": "0.31.7",
     "prettier": "^3.3.3",
     "react": "19.1.1",
     "react-native": "0.82.0",
-    "react-native-nitro-modules": "0.31.0",
+    "react-native-nitro-modules": "0.31.7",
     "typescript": "^5.8.3"
   },
   "peerDependencies": {

package/src/createMMKV/createMMKV.ts

@@ -1,33 +1,18 @@
-import { NitroModules } from 'react-native-nitro-modules'
 import type { MMKV } from '../specs/MMKV.nitro'
-import type { Configuration, MMKVFactory } from '../specs/MMKVFactory.nitro'
-import type { MMKVPlatformContext } from '../specs/MMKVPlatformContext.nitro'
+import type { Configuration } from '../specs/MMKVFactory.nitro'
 import { Platform } from 'react-native'
 import { addMemoryWarningListener } from '../addMemoryWarningListener/addMemoryWarningListener'
 import { isTest } from '../isTest'
 import { createMockMMKV } from './createMockMMKV'
-
-let factory: MMKVFactory | undefined
-let platformContext: MMKVPlatformContext | undefined
+import { getMMKVFactory, getPlatformContext } from '../getMMKVFactory'
 
 export function createMMKV(configuration?: Configuration): MMKV {
   if (isTest()) {
     // In a test environment, we mock the MMKV instance.
-    return createMockMMKV()
+    return createMockMMKV(configuration)
   }
 
-  if (platformContext == null) {
-    // Lazy-init the platform-context HybridObject
-    platformContext = NitroModules.createHybridObject<MMKVPlatformContext>(
-      'MMKVPlatformContext'
-    )
-  }
-  if (factory == null) {
-    // Lazy-init the factory HybridObject
-    factory = NitroModules.createHybridObject<MMKVFactory>('MMKVFactory')
-    const baseDirectory = platformContext.getBaseDirectory()
-    factory.initializeMMKV(baseDirectory)
-  }
+  const factory = getMMKVFactory()
 
   // Pre-parse the config
   let config = configuration ?? { id: factory.defaultMMKVInstanceId }
@@ -36,6 +21,7 @@ export function createMMKV(configuration?: Configuration): MMKV {
     if (config.path == null) {
       // If the user set an App Group directory in Info.plist, let's use
       // the App Group as a MMKV path:
+      const platformContext = getPlatformContext()
       const appGroupDirectory = platformContext.getAppGroupDirectory()
       if (appGroupDirectory != null) {
         config.path = appGroupDirectory

package/src/createMMKV/createMMKV.web.ts

@@ -1,23 +1,10 @@
 import type { MMKV } from '../specs/MMKV.nitro'
 import type { Configuration } from '../specs/MMKVFactory.nitro'
 import { createTextEncoder } from '../web/createTextEncoder'
-
-const canUseDOM =
-  typeof window !== 'undefined' && window.document?.createElement != null
-
-const hasAccessToLocalStorage = () => {
-  try {
-    // throws ACCESS_DENIED error
-    window.localStorage
-
-    return true
-  } catch {
-    return false
-  }
-}
-
-const KEY_WILDCARD = '\\'
-const inMemoryStorage = new Map<string, string>()
+import {
+  getLocalStorage,
+  LOCAL_STORAGE_KEY_WILDCARD,
+} from '../web/getLocalStorage'
 
 export function createMMKV(
   config: Configuration = { id: 'mmkv.default' }
@@ -29,48 +16,14 @@ export function createMMKV(
     throw new Error("MMKV: 'path' is not supported on Web!")
   }
 
-  // canUseDOM check prevents spam in Node server environments, such as Next.js server side props.
-  if (!hasAccessToLocalStorage() && canUseDOM) {
-    console.warn(
-      'MMKV: LocalStorage has been disabled. Your experience will be limited to in-memory storage!'
-    )
-  }
-
-  const storage = () => {
-    if (!canUseDOM) {
-      throw new Error(
-        'Tried to access storage on the server. Did you forget to call this in useEffect?'
-      )
-    }
-
-    if (!hasAccessToLocalStorage()) {
-      return {
-        getItem: (key: string) => inMemoryStorage.get(key) ?? null,
-        setItem: (key: string, value: string) =>
-          inMemoryStorage.set(key, value),
-        removeItem: (key: string) => inMemoryStorage.delete(key),
-        clear: () => inMemoryStorage.clear(),
-        length: inMemoryStorage.size,
-        key: (index: number) => Object.keys(inMemoryStorage).at(index) ?? null,
-      } as Storage
-    }
-
-    const domStorage =
-      global?.localStorage ?? window?.localStorage ?? localStorage
-    if (domStorage == null) {
-      throw new Error(`Could not find 'localStorage' instance!`)
-    }
-    return domStorage
-  }
-
   const textEncoder = createTextEncoder()
   const listeners = new Set<(key: string) => void>()
 
-  if (config.id.includes(KEY_WILDCARD)) {
+  if (config.id.includes(LOCAL_STORAGE_KEY_WILDCARD)) {
     throw new Error('MMKV: `id` cannot contain the backslash character (`\\`)!')
   }
 
-  const keyPrefix = `${config.id}${KEY_WILDCARD}` // mmkv.default\\
+  const keyPrefix = `${config.id}${LOCAL_STORAGE_KEY_WILDCARD}` // mmkv.default\\
   const prefixedKey = (key: string) => {
     if (key.includes('\\')) {
       throw new Error(
@@ -85,53 +38,68 @@ export function createMMKV(
   }
 
   return {
+    id: config.id,
+    size: 0,
+    isReadOnly: false,
     clearAll: () => {
-      const keys = Object.keys(storage())
+      const storage = getLocalStorage()
+      const keys = Object.keys(storage)
       for (const key of keys) {
         if (key.startsWith(keyPrefix)) {
-          storage().removeItem(key)
+          storage.removeItem(key)
           callListeners(key)
         }
       }
     },
     remove: (key) => {
-      const wasRemoved = storage().removeItem(prefixedKey(key)) ?? false
+      const storage = getLocalStorage()
+      storage.removeItem(prefixedKey(key))
+      const wasRemoved = storage.getItem(prefixedKey(key)) === null
       if (wasRemoved) callListeners(key)
       return wasRemoved
     },
     set: (key, value) => {
+      const storage = getLocalStorage()
       if (key === '') throw new Error('Cannot set a value for an empty key!')
-      storage().setItem(prefixedKey(key), value.toString())
+      storage.setItem(prefixedKey(key), value.toString())
       callListeners(key)
     },
-    getString: (key) => storage().getItem(prefixedKey(key)) ?? undefined,
+    getString: (key) => {
+      const storage = getLocalStorage()
+      return storage.getItem(prefixedKey(key)) ?? undefined
+    },
     getNumber: (key) => {
-      const value = storage().getItem(prefixedKey(key))
+      const storage = getLocalStorage()
+      const value = storage.getItem(prefixedKey(key))
       if (value == null) return undefined
       return Number(value)
     },
     getBoolean: (key) => {
-      const value = storage().getItem(prefixedKey(key))
+      const storage = getLocalStorage()
+      const value = storage.getItem(prefixedKey(key))
       if (value == null) return undefined
       return value === 'true'
     },
     getBuffer: (key) => {
-      const value = storage().getItem(prefixedKey(key))
+      const storage = getLocalStorage()
+      const value = storage.getItem(prefixedKey(key))
       if (value == null) return undefined
       return textEncoder.encode(value).buffer
     },
     getAllKeys: () => {
-      const keys = Object.keys(storage())
+      const storage = getLocalStorage()
+      const keys = Object.keys(storage)
       return keys
         .filter((key) => key.startsWith(keyPrefix))
         .map((key) => key.slice(keyPrefix.length))
     },
-    contains: (key) => storage().getItem(prefixedKey(key)) != null,
+    contains: (key) => {
+      const storage = getLocalStorage()
+      return storage.getItem(prefixedKey(key)) != null
+    },
     recrypt: () => {
       throw new Error('`recrypt(..)` is not supported on Web!')
     },
-    size: 0,
-    isReadOnly: false,
     trim: () => {
       // no-op
     },
@@ -146,5 +114,18 @@ export function createMMKV(
         },
       }
     },
+    importAllFrom: (other) => {
+      const storage = getLocalStorage()
+      const keys = other.getAllKeys()
+      let imported = 0
+      for (const key of keys) {
+        const string = other.getString(key)
+        if (string != null) {
+          storage.set(key, string)
+          imported++
+        }
+      }
+      return imported
+    },
   }
 }

package/src/createMMKV/createMockMMKV.ts

@@ -1,9 +1,12 @@
 import type { MMKV } from '../specs/MMKV.nitro'
+import type { Configuration } from '../specs/MMKVFactory.nitro'
 
 /**
  * Mock MMKV instance when used in a Jest/Test environment.
  */
-export function createMockMMKV(): MMKV {
+export function createMockMMKV(
+  config: Configuration = { id: 'mmkv.default' }
+): MMKV {
   const storage = new Map<string, string | boolean | number | ArrayBuffer>()
   const listeners = new Set<(key: string) => void>()
 
@@ -14,6 +17,11 @@ export function createMockMMKV(): MMKV {
   }
 
   return {
+    id: config.id,
+    get size(): number {
+      return storage.size
+    },
+    isReadOnly: false,
     clearAll: () => {
       const keysBefore = storage.keys()
       storage.clear()
@@ -55,10 +63,6 @@ export function createMockMMKV(): MMKV {
     recrypt: () => {
       console.warn('Encryption is not supported in mocked MMKV instances!')
     },
-    get size(): number {
-      return storage.size
-    },
-    isReadOnly: false,
     trim: () => {
       // no-op
     },
@@ -75,5 +79,17 @@ export function createMockMMKV(): MMKV {
         },
       }
     },
+    importAllFrom: (other) => {
+      const keys = other.getAllKeys()
+      let imported = 0
+      for (const key of keys) {
+        const data = other.getBuffer(key)
+        if (data != null) {
+          storage.set(key, data)
+          imported++
+        }
+      }
+      return imported
+    },
   }
 }

package/src/deleteMMKV/deleteMMKV.ts

@@ -0,0 +1,11 @@
+import { getMMKVFactory } from '../getMMKVFactory'
+import { isTest } from '../isTest'
+
+export function deleteMMKV(id: string): boolean {
+  if (isTest()) {
+    return true
+  }
+
+  const factory = getMMKVFactory()
+  return factory.deleteMMKV(id)
+}

package/src/deleteMMKV/deleteMMKV.web.ts

@@ -0,0 +1,20 @@
+import {
+  getLocalStorage,
+  LOCAL_STORAGE_KEY_WILDCARD,
+} from '../web/getLocalStorage'
+
+export function deleteMMKV(id: string): boolean {
+  const storage = getLocalStorage()
+  const prefix = id + LOCAL_STORAGE_KEY_WILDCARD
+  let wasRemoved = false
+
+  const keys = Object.keys(storage)
+  for (const key of keys) {
+    if (key.startsWith(prefix)) {
+      storage.removeItem(key)
+      wasRemoved = true
+    }
+  }
+
+  return wasRemoved
+}

package/src/existsMMKV/existsMMKV.ts

@@ -0,0 +1,11 @@
+import { getMMKVFactory } from '../getMMKVFactory'
+import { isTest } from '../isTest'
+
+export function existsMMKV(id: string): boolean {
+  if (isTest()) {
+    return true
+  }
+
+  const factory = getMMKVFactory()
+  return factory.existsMMKV(id)
+}

package/src/existsMMKV/existsMMKV.web.ts

@@ -0,0 +1,11 @@
+import {
+  getLocalStorage,
+  LOCAL_STORAGE_KEY_WILDCARD,
+} from '../web/getLocalStorage'
+
+export function existsMMKV(id: string): boolean {
+  const storage = getLocalStorage()
+  const prefix = id + LOCAL_STORAGE_KEY_WILDCARD
+  const keys = Object.keys(storage)
+  return keys.some((k) => k.startsWith(prefix))
+}

package/src/getMMKVFactory.ts

@@ -0,0 +1,28 @@
+import { NitroModules } from 'react-native-nitro-modules'
+import type { MMKVFactory } from './specs/MMKVFactory.nitro'
+import type { MMKVPlatformContext } from './specs/MMKVPlatformContext.nitro'
+
+let factory: MMKVFactory | undefined
+let platformContext: MMKVPlatformContext | undefined
+
+export function getPlatformContext(): MMKVPlatformContext {
+  if (platformContext == null) {
+    // Lazy-init the platform-context HybridObject
+    platformContext = NitroModules.createHybridObject<MMKVPlatformContext>(
+      'MMKVPlatformContext'
+    )
+  }
+  return platformContext
+}
+
+export function getMMKVFactory(): MMKVFactory {
+  if (factory == null) {
+    // Lazy-init the factory HybridObject
+    factory = NitroModules.createHybridObject<MMKVFactory>('MMKVFactory')
+    const context = getPlatformContext()
+    const baseDirectory = context.getBaseDirectory()
+    factory.initializeMMKV(baseDirectory)
+  }
+
+  return factory
+}

package/src/index.ts

@@ -5,6 +5,10 @@ export type { Configuration, Mode } from './specs/MMKVFactory.nitro'
 // The create function
 export { createMMKV } from './createMMKV/createMMKV'
 
+// Exists + Delete
+export { existsMMKV } from './existsMMKV/existsMMKV'
+export { deleteMMKV } from './deleteMMKV/deleteMMKV'
+
 // All the hooks
 export { useMMKV } from './hooks/useMMKV'
 export { useMMKVBoolean } from './hooks/useMMKVBoolean'

package/src/specs/MMKV.nitro.ts

@@ -5,6 +5,19 @@ export interface Listener {
 }
 
 export interface MMKV extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  /**
+   * Get the ID of this {@linkcode MMKV} instance.
+   */
+  readonly id: string
+  /**
+   * Get the current total size of the storage, in bytes.
+   */
+  readonly size: number
+  /**
+   * Returns whether this instance is in read-only mode or not.
+   * If this is `true`, you can only use "get"-functions.
+   */
+  readonly isReadOnly: boolean
   /**
    * Set a {@linkcode value} for the given {@linkcode key}.
    *
@@ -75,15 +88,6 @@ export interface MMKV extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
    * In most applications, this is not needed at all.
    */
   trim(): void
-  /**
-   * Get the current total size of the storage, in bytes.
-   */
-  readonly size: number
-  /**
-   * Returns whether this instance is in read-only mode or not.
-   * If this is `true`, you can only use "get"-functions.
-   */
-  readonly isReadOnly: boolean
   /**
    * Adds a value changed listener. The Listener will be called whenever any value
    * in this storage instance changes (set or delete).
@@ -91,4 +95,11 @@ export interface MMKV extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
    * To unsubscribe from value changes, call `remove()` on the Listener.
    */
   addOnValueChangedListener(onValueChanged: (key: string) => void): Listener
+
+  /**
+   * Imports all keys and values from the
+   * given other {@linkcode MMKV} instance.
+   * @returns the number of imported keys/values.
+   */
+  importAllFrom(other: MMKV): number
 }

package/src/specs/MMKVFactory.nitro.ts

@@ -68,16 +68,28 @@ export interface Configuration {
 
 export interface MMKVFactory
   extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  /**
+   * Initialize the MMKV library with the given root path.
+   * This has to be called once, before using {@linkcode createMMKV}.
+   */
+  initializeMMKV(rootPath: string): void
+
   /**
    * Create a new {@linkcode MMKV} instance with the given {@linkcode Configuration}
    */
   createMMKV(configuration: Configuration): MMKV
 
   /**
-   * Initialize the MMKV library with the given root path.
-   * This has to be called once, before using {@linkcode createMMKV}.
+   * Deletes the MMKV instance with the
+   * given {@linkcode id}.
    */
-  initializeMMKV(rootPath: string): void
+  deleteMMKV(id: string): boolean
+
+  /**
+   * Returns `true` if an MMKV instance with the
+   * given {@linkcode id} exists, `false` otherwise.
+   */
+  existsMMKV(id: string): boolean
 
   /**
    * Get the default MMKV instance's ID.

package/src/web/getLocalStorage.ts

@@ -0,0 +1,42 @@
+export const LOCAL_STORAGE_KEY_WILDCARD = '\\'
+
+const canUseDOM =
+  typeof window !== 'undefined' && window.document?.createElement != null
+
+const hasAccessToLocalStorage = () => {
+  try {
+    // throws ACCESS_DENIED error
+    window.localStorage
+
+    return true
+  } catch {
+    return false
+  }
+}
+const inMemoryStorage = new Map<string, string>()
+
+export function getLocalStorage(): Storage {
+  if (!canUseDOM) {
+    throw new Error(
+      'Tried to access storage on the server. Did you forget to call this in useEffect?'
+    )
+  }
+
+  if (!hasAccessToLocalStorage()) {
+    return {
+      getItem: (key: string) => inMemoryStorage.get(key) ?? null,
+      setItem: (key: string, value: string) => inMemoryStorage.set(key, value),
+      removeItem: (key: string) => inMemoryStorage.delete(key),
+      clear: () => inMemoryStorage.clear(),
+      length: inMemoryStorage.size,
+      key: (index: number) => Object.keys(inMemoryStorage).at(index) ?? null,
+    } as Storage
+  }
+
+  const domStorage =
+    global?.localStorage ?? window?.localStorage ?? localStorage
+  if (domStorage == null) {
+    throw new Error(`Could not find 'localStorage' instance!`)
+  }
+  return domStorage
+}