react-native-mmkv 1.6.2 → 2.1.0

package/android/src/main/cpp/MmkvHostObject.cpp

@@ -16,7 +16,18 @@ MmkvHostObject::MmkvHostObject(const std::string& instanceId, std::string path,
   std::string* pathPtr = path.size() > 0 ? &path : nullptr;
   std::string* cryptKeyPtr = cryptKey.size() > 0 ? &cryptKey : nullptr;
   instance = MMKV::mmkvWithID(instanceId, mmkv::DEFAULT_MMAP_SIZE, MMKV_SINGLE_PROCESS, cryptKeyPtr, pathPtr);
+
   if (instance == nullptr) {
+    // Check if instanceId is invalid
+    if (instanceId.empty()) {
+      throw std::runtime_error("Failed to create MMKV instance! `id` cannot be empty!");
+    }
+
+    // Check if encryptionKey is invalid
+    if (cryptKey.size() > 16) {
+      throw std::runtime_error("Failed to create MMKV instance! `encryptionKey` cannot be longer than 16 bytes!");
+    }
+
     throw std::runtime_error("Failed to create MMKV instance!");
   }
 }
@@ -31,6 +42,7 @@ std::vector<jsi::PropNameID> MmkvHostObject::getPropertyNames(jsi::Runtime& rt)
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("delete")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getAllKeys")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("deleteAll")));
+  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("recrypt")));
   return result;
 }
 
@@ -181,9 +193,33 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
                                                         const jsi::Value* arguments,
                                                         size_t count) -> jsi::Value {
                                                    instance->clearAll();
+
                                                    return jsi::Value::undefined();
                                                  });
   }
 
+  if (propName == "recrypt") {
+    // MMKV.recrypt(key)
+    return jsi::Function::createFromHostFunction(runtime,
+                                                 jsi::PropNameID::forAscii(runtime, funcName),
+                                                 0,
+                                                 [this](jsi::Runtime& runtime,
+                                                        const jsi::Value& thisValue,
+                                                        const jsi::Value* arguments,
+                                                        size_t count) -> jsi::Value {
+      if (arguments[0].isUndefined()) {
+        // reset encryption key to "no encryption"
+        instance->reKey(nullptr);
+      } else if (arguments[0].isString()) {
+        // reKey(..) with new encryption-key
+        auto encryptionKey = arguments[0].getString(runtime).utf8(runtime);
+        instance->reKey(encryptionKey);
+      } else {
+        throw jsi::JSError(runtime, "First argument ('encryptionKey') has to be of type string (or undefined)!");
+      }
+      return jsi::Value::undefined();
+    });
+  }
+
   return jsi::Value::undefined();
 }

package/android/src/main/java/com/reactnativemmkv/MmkvModule.java

@@ -1,24 +1,49 @@
 package com.reactnativemmkv;
 
+import android.util.Log;
+
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.facebook.react.bridge.JavaScriptContextHolder;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.module.annotations.ReactModule;
 
+@ReactModule(name = MmkvModule.NAME)
 public class MmkvModule extends ReactContextBaseJavaModule {
-  static {
-    System.loadLibrary("reactnativemmkv");
-  }
+  public static final String NAME = "MMKV";
 
-  private static native void nativeInstall(long jsiPtr, String path);
-
-  public static void install(JavaScriptContextHolder jsContext, String storageDirectory) {
-    nativeInstall(jsContext.get(), storageDirectory);
+  public MmkvModule(ReactApplicationContext reactContext) {
+    super(reactContext);
   }
 
   @NonNull
   @Override
   public String getName() {
-    return "MMKV";
+    return NAME;
   }
+
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  public boolean install(@Nullable String rootDirectory) {
+    try {
+      Log.i(NAME, "Loading C++ library...");
+      System.loadLibrary("reactnativemmkv");
+
+      JavaScriptContextHolder jsContext = getReactApplicationContext().getJavaScriptContextHolder();
+      if (rootDirectory == null) {
+        rootDirectory = getReactApplicationContext().getFilesDir().getAbsolutePath() + "/mmkv";
+      }
+      Log.i(NAME, "Installing MMKV JSI Bindings for MMKV root directory: " + rootDirectory);
+      nativeInstall(jsContext.get(), rootDirectory);
+      Log.i(NAME, "Successfully installed MMKV JSI Bindings!");
+      return true;
+    } catch (Exception exception) {
+      Log.e(NAME, "Failed to install MMKV JSI Bindings!", exception);
+      return false;
+    }
+  }
+
+  private static native void nativeInstall(long jsiPtr, String path);
 }

package/android/src/main/java/com/reactnativemmkv/MmkvPackage.java

@@ -15,8 +15,7 @@ public class MmkvPackage implements ReactPackage {
   @NonNull
   @Override
   public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
-    // TODO: Remove this dummy init, once TurboModules are stable I will migrate to those.
-    return Collections.singletonList(new MmkvModule());
+    return Collections.singletonList(new MmkvModule(reactContext));
   }
 
   @NonNull

package/ios/MmkvHostObject.mm

@@ -13,7 +13,25 @@
 MmkvHostObject::MmkvHostObject(NSString* instanceId, NSString* path, NSString* cryptKey) {
   NSData* cryptData = cryptKey == nil ? nil : [cryptKey dataUsingEncoding:NSUTF8StringEncoding];
   instance = [MMKV mmkvWithID:instanceId cryptKey:cryptData rootPath:path];
+
   if (instance == nil) {
+    // Check if instanceId is invalid
+    if ([instanceId length] == 0) {
+      throw std::runtime_error("Failed to create MMKV instance! `id` cannot be empty!");
+    }
+
+    // Check if encryptionKey is invalid
+    if (cryptData != nil && [cryptData length] > 16) {
+      throw std::runtime_error("Failed to create MMKV instance! `encryptionKey` cannot be longer than 16 bytes!");
+    }
+
+    // Check if path is invalid
+    NSFileManager* fileManager = [[NSFileManager alloc] init];
+    bool pathExists = [fileManager fileExistsAtPath:path isDirectory:nil];
+    if (!pathExists) {
+      throw std::runtime_error("Failed to create MMKV instance! The given Storage Path does not exist!");
+    }
+
     throw std::runtime_error("Failed to create MMKV instance!");
   }
 }
@@ -28,6 +46,7 @@ std::vector<jsi::PropNameID> MmkvHostObject::getPropertyNames(jsi::Runtime& rt)
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("delete")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getAllKeys")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("deleteAll")));
+  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("recrypt")));
   return result;
 }
 
@@ -73,7 +92,7 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
       if (!arguments[0].isString()) throw jsi::JSError(runtime, "First argument ('key') has to be of type string!");
 
       auto keyName = convertJSIStringToNSString(runtime, arguments[0].getString(runtime));
-      auto value = [instance getBoolForKey:keyName];
+      bool value = [instance getBoolForKey:keyName];
       return jsi::Value(value);
     });
   }
@@ -114,7 +133,7 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
       return jsi::Value(value);
     });
   }
-  
+
   if (propName == "contains") {
     // MMKV.contains(key: string)
     return jsi::Function::createFromHostFunction(runtime,
@@ -125,13 +144,13 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
                                                         const jsi::Value* arguments,
                                                         size_t count) -> jsi::Value {
       if (!arguments[0].isString()) throw jsi::JSError(runtime, "First argument ('key') has to be of type string!");
-      
+
       auto keyName = convertJSIStringToNSString(runtime, arguments[0].getString(runtime));
       bool containsKey = [instance containsKey:keyName];
       return jsi::Value(containsKey);
     });
   }
-  
+
   if (propName == "delete") {
     // MMKV.delete(key: string)
     return jsi::Function::createFromHostFunction(runtime,
@@ -142,7 +161,7 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
                                                         const jsi::Value* arguments,
                                                         size_t count) -> jsi::Value {
       if (!arguments[0].isString()) throw jsi::JSError(runtime, "First argument ('key') has to be of type string!");
-      
+
       auto keyName = convertJSIStringToNSString(runtime, arguments[0].getString(runtime));
       [instance removeValueForKey:keyName];
       return jsi::Value::undefined();
@@ -177,5 +196,29 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
     });
   }
 
+  if (propName == "recrypt") {
+    // MMKV.recrypt(key)
+    return jsi::Function::createFromHostFunction(runtime,
+                                                 jsi::PropNameID::forAscii(runtime, funcName),
+                                                 0,
+                                                 [this](jsi::Runtime& runtime,
+                                                        const jsi::Value& thisValue,
+                                                        const jsi::Value* arguments,
+                                                        size_t count) -> jsi::Value {
+      if (arguments[0].isUndefined()) {
+        // reset encryption key to "no encryption"
+        [instance reKey:nil];
+      } else if (arguments[0].isString()) {
+        // reKey(..) with new encryption-key
+        NSString* encryptionKey = convertJSIStringToNSString(runtime, arguments[0].getString(runtime));
+        NSData* encryptionKeyBytes = [encryptionKey dataUsingEncoding:NSUTF8StringEncoding];
+        [instance reKey:encryptionKeyBytes];
+      } else {
+        throw jsi::JSError(runtime, "First argument ('encryptionKey') has to be of type string (or undefined)!");
+      }
+      return jsi::Value::undefined();
+    });
+  }
+
   return jsi::Value::undefined();
 }

package/ios/MmkvModule.h

@@ -0,0 +1,5 @@
+#import <React/RCTBridgeModule.h>
+
+@interface MmkvModule : NSObject <RCTBridgeModule>
+
+@end

package/ios/MmkvModule.mm

@@ -0,0 +1,68 @@
+#import "MmkvModule.h"
+#import "JSIUtils.h"
+
+#import <React/RCTBridge+Private.h>
+#import <React/RCTUtils.h>
+#import <jsi/jsi.h>
+
+#import <MMKV/MMKV.h>
+#import "MmkvHostObject.h"
+
+using namespace facebook;
+
+@implementation MmkvModule
+
+RCT_EXPORT_MODULE(MMKV)
+
++ (NSString*)getPropertyAsStringOrNilFromObject:(jsi::Object&)object propertyName:(std::string)propertyName runtime:(jsi::Runtime&)runtime {
+    jsi::Value value = object.getProperty(runtime, propertyName.c_str());
+    std::string string = value.isString() ? value.asString(runtime).utf8(runtime) : "";
+    return string.length() > 0 ? [NSString stringWithUTF8String:string.c_str()] : nil;
+}
+
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(install:(nullable NSString*)storageDirectory)
+{
+    NSLog(@"Installing global.mmkvCreateNewInstance...");
+    RCTBridge* bridge = [RCTBridge currentBridge];
+    RCTCxxBridge* cxxBridge = (RCTCxxBridge*)bridge;
+    if (cxxBridge == nil) {
+        return @false;
+    }
+
+    using namespace facebook;
+
+    auto jsiRuntime = (jsi::Runtime*) cxxBridge.runtime;
+    if (jsiRuntime == nil) {
+        return @false;
+    }
+    auto& runtime = *jsiRuntime;
+
+    [MMKV initializeMMKV:storageDirectory];
+
+    // MMKV.createNewInstance()
+    auto mmkvCreateNewInstance = jsi::Function::createFromHostFunction(runtime,
+                                                                        jsi::PropNameID::forAscii(runtime, "mmkvCreateNewInstance"),
+                                                                        1,
+                                                                        [](jsi::Runtime& runtime,
+                                                                           const jsi::Value& thisValue,
+                                                                           const jsi::Value* arguments,
+                                                                           size_t count) -> jsi::Value {
+        if (count != 1) {
+            throw jsi::JSError(runtime, "MMKV.createNewInstance(..) expects one argument (object)!");
+        }
+        jsi::Object config = arguments[0].asObject(runtime);
+
+        NSString* instanceId = [MmkvModule getPropertyAsStringOrNilFromObject:config propertyName:"id" runtime:runtime];
+        NSString* path = [MmkvModule getPropertyAsStringOrNilFromObject:config propertyName:"path" runtime:runtime];
+        NSString* encryptionKey = [MmkvModule getPropertyAsStringOrNilFromObject:config propertyName:"encryptionKey" runtime:runtime];
+
+        auto instance = std::make_shared<MmkvHostObject>(instanceId, path, encryptionKey);
+        return jsi::Object::createFromHostObject(runtime, instance);
+    });
+    runtime.global().setProperty(runtime, "mmkvCreateNewInstance", std::move(mmkvCreateNewInstance));
+
+    NSLog(@"Installed global.mmkvCreateNewInstance!");
+    return @true;
+}
+
+@end

package/lib/commonjs/MMKV.js

@@ -19,7 +19,7 @@ const onValueChangedListeners = new Map();
 class MMKV {
   /**
    * Creates a new MMKV instance with the given Configuration.
-   * If no custom `id` is supplied, `'default'` will be used.
+   * If no custom `id` is supplied, `'mmkv.default'` will be used.
    */
   constructor(configuration = {
     id: 'mmkv.default'
@@ -108,6 +108,21 @@ class MMKV {
     return func();
   }
 
+  recrypt(key) {
+    const func = this.getFunctionFromCache('recrypt');
+    return func(key);
+  }
+
+  toString() {
+    return `MMKV (${this.id}): [${this.getAllKeys().join(', ')}]`;
+  }
+
+  toJSON() {
+    return {
+      [this.id]: this.getAllKeys()
+    };
+  }
+
   addOnValueChangedListener(onValueChanged) {
     this.onValueChangedListeners.push(onValueChanged);
     return {

package/lib/commonjs/MMKV.js.map

@@ -1 +1 @@
-{"version":3,"sources":["MMKV.ts"],"names":["onValueChangedListeners","Map","MMKV","constructor","configuration","id","nativeInstance","functionCache","has","set","get","getFunctionFromCache","functionName","onValuesAboutToChange","keys","length","setImmediate","key","listener","value","func","getBoolean","getString","getNumber","contains","delete","getAllKeys","clearAll","addOnValueChangedListener","onValueChanged","push","remove","index","indexOf","splice"],"mappings":";;;;;;;AAAA;;AACA;;;;AA0GA,MAAMA,uBAAuB,GAAG,IAAIC,GAAJ,EAAhC;AAEA;AACA;AACA;;AACO,MAAMC,IAAN,CAAoC;AAKzC;AACF;AACA;AACA;AACEC,EAAAA,WAAW,CAACC,aAAgC,GAAG;AAAEC,IAAAA,EAAE,EAAE;AAAN,GAApC,EAA4D;AAAA;;AAAA;;AAAA;;AACrE,SAAKA,EAAL,GAAUD,aAAa,CAACC,EAAxB;AACA,SAAKC,cAAL,GAAsB,4BAAWF,aAAX,CAAtB;AACA,SAAKG,aAAL,GAAqB,EAArB;AACD;;AAEkC,MAAvBP,uBAAuB,GAAG;AACpC,QAAI,CAACA,uBAAuB,CAACQ,GAAxB,CAA4B,KAAKH,EAAjC,CAAL,EAA2C;AACzCL,MAAAA,uBAAuB,CAACS,GAAxB,CAA4B,KAAKJ,EAAjC,EAAqC,EAArC;AACD;;AACD,WAAOL,uBAAuB,CAACU,GAAxB,CAA4B,KAAKL,EAAjC,CAAP;AACD;;AAEOM,EAAAA,oBAAoB,CAC1BC,YAD0B,EAEX;AACf,QAAI,KAAKL,aAAL,CAAmBK,YAAnB,KAAoC,IAAxC,EAA8C;AAC5C,WAAKL,aAAL,CAAmBK,YAAnB,IAAmC,KAAKN,cAAL,CAAoBM,YAApB,CAAnC;AACD;;AACD,WAAO,KAAKL,aAAL,CAAmBK,YAAnB,CAAP;AACD;;AAEOC,EAAAA,qBAAqB,CAACC,IAAD,EAAiB;AAC5C,QAAI,KAAKd,uBAAL,CAA6Be,MAA7B,KAAwC,CAA5C,EAA+C;AAE/CC,IAAAA,YAAY,CAAC,MAAM;AACjB,gDAAwB,MAAM;AAC5B,aAAK,MAAMC,GAAX,IAAkBH,IAAlB,EAAwB;AACtB,eAAK,MAAMI,QAAX,IAAuB,KAAKlB,uBAA5B,EAAqD;AACnDkB,YAAAA,QAAQ,CAACD,GAAD,CAAR;AACD;AACF;AACF,OAND;AAOD,KARW,CAAZ;AASD;;AAEDR,EAAAA,GAAG,CAACQ,GAAD,EAAcE,KAAd,EAAsD;AACvD,SAAKN,qBAAL,CAA2B,CAACI,GAAD,CAA3B;AAEA,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,KAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,EAAME,KAAN,CAAX;AACD;;AACDE,EAAAA,UAAU,CAACJ,GAAD,EAAuB;AAC/B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDK,EAAAA,SAAS,CAACL,GAAD,EAAkC;AACzC,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDM,EAAAA,SAAS,CAACN,GAAD,EAAsB;AAC7B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDO,EAAAA,QAAQ,CAACP,GAAD,EAAuB;AAC7B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDQ,EAAAA,MAAM,CAACR,GAAD,EAAoB;AACxB,SAAKJ,qBAAL,CAA2B,CAACI,GAAD,CAA3B;AAEA,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,QAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDS,EAAAA,UAAU,GAAa;AACrB,UAAMN,IAAI,GAAG,KAAKT,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOS,IAAI,EAAX;AACD;;AACDO,EAAAA,QAAQ,GAAS;AACf,UAAMb,IAAI,GAAG,KAAKY,UAAL,EAAb;AACA,SAAKb,qBAAL,CAA2BC,IAA3B;AAEA,UAAMM,IAAI,GAAG,KAAKT,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOS,IAAI,EAAX;AACD;;AAEDQ,EAAAA,yBAAyB,CAACC,cAAD,EAAkD;AACzE,SAAK7B,uBAAL,CAA6B8B,IAA7B,CAAkCD,cAAlC;AAEA,WAAO;AACLE,MAAAA,MAAM,EAAE,MAAM;AACZ,cAAMC,KAAK,GAAG,KAAKhC,uBAAL,CAA6BiC,OAA7B,CAAqCJ,cAArC,CAAd;;AACA,YAAIG,KAAK,KAAK,CAAC,CAAf,EAAkB;AAChB,eAAKhC,uBAAL,CAA6BkC,MAA7B,CAAoCF,KAApC,EAA2C,CAA3C;AACD;AACF;AANI,KAAP;AAQD;;AAhGwC","sourcesContent":["import { unstable_batchedUpdates } from 'react-native';\nimport { createMMKV } from './createMMKV';\n\ninterface Listener {\n  remove: () => void;\n}\n\n/**\n * Used for configuration of a single MMKV instance.\n */\nexport interface MMKVConfiguration {\n  /**\n   * The MMKV instance's ID. If you want to use multiple instances, make sure to use different IDs!\n   *\n   * @example\n   * ```ts\n   * const userStorage = new MMKV({ id: `user-${userId}-storage` })\n   * const globalStorage = new MMKV({ id: 'global-app-storage' })\n   * ```\n   *\n   * @default 'mmkv.default'\n   */\n  id: string;\n  /**\n   * The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization:\n   *\n   * @example\n   * ```ts\n   * const temporaryStorage = new MMKV({ path: '/tmp/' })\n   * ```\n   */\n  path?: string;\n  /**\n   * The MMKV instance's encryption/decryption key. By default, MMKV stores all key-values in plain text on file, relying on iOS's sandbox to make sure the file is encrypted. Should you worry about information leaking, you can choose to encrypt MMKV.\n   *\n   * @example\n   * ```ts\n   * const secureStorage = new MMKV({ encryptionKey: 'my-encryption-key!' })\n   * ```\n   */\n  encryptionKey?: string;\n}\n\n/**\n * Represents a single MMKV instance.\n */\ninterface MMKVInterface {\n  /**\n   * Set a value for the given `key`.\n   */\n  set: (key: string, value: boolean | string | number) => void;\n  /**\n   * Get a boolean value for the given `key`.\n   *\n   * @default false\n   */\n  getBoolean: (key: string) => boolean;\n  /**\n   * Get a string value for the given `key`.\n   *\n   * @default undefined\n   */\n  getString: (key: string) => string | undefined;\n  /**\n   * Get a number value for the given `key`.\n   *\n   * @default 0\n   */\n  getNumber: (key: string) => number;\n  /**\n   * Checks whether the given `key` is being stored in this MMKV instance.\n   */\n  contains: (key: string) => boolean;\n  /**\n   * Delete the given `key`.\n   */\n  delete: (key: string) => void;\n  /**\n   * Get all keys.\n   *\n   * @default []\n   */\n  getAllKeys: () => string[];\n  /**\n   * Delete all keys.\n   */\n  clearAll: () => void;\n  /**\n   * Adds a value changed listener.\n   */\n  addOnValueChangedListener: (\n    onValueChanged: (key: string) => void\n  ) => Listener;\n}\n\nexport type NativeMMKV = Pick<\n  MMKVInterface,\n  | 'clearAll'\n  | 'contains'\n  | 'delete'\n  | 'getAllKeys'\n  | 'getBoolean'\n  | 'getNumber'\n  | 'getString'\n  | 'set'\n>;\n\nconst onValueChangedListeners = new Map<string, ((key: string) => void)[]>();\n\n/**\n * A single MMKV instance.\n */\nexport class MMKV implements MMKVInterface {\n  private nativeInstance: NativeMMKV;\n  private functionCache: Partial<NativeMMKV>;\n  private id: string;\n\n  /**\n   * Creates a new MMKV instance with the given Configuration.\n   * If no custom `id` is supplied, `'default'` will be used.\n   */\n  constructor(configuration: MMKVConfiguration = { id: 'mmkv.default' }) {\n    this.id = configuration.id;\n    this.nativeInstance = createMMKV(configuration);\n    this.functionCache = {};\n  }\n\n  private get onValueChangedListeners() {\n    if (!onValueChangedListeners.has(this.id)) {\n      onValueChangedListeners.set(this.id, []);\n    }\n    return onValueChangedListeners.get(this.id)!;\n  }\n\n  private getFunctionFromCache<T extends keyof NativeMMKV>(\n    functionName: T\n  ): NativeMMKV[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as NativeMMKV[T];\n  }\n\n  private onValuesAboutToChange(keys: string[]) {\n    if (this.onValueChangedListeners.length === 0) return;\n\n    setImmediate(() => {\n      unstable_batchedUpdates(() => {\n        for (const key of keys) {\n          for (const listener of this.onValueChangedListeners) {\n            listener(key);\n          }\n        }\n      });\n    });\n  }\n\n  set(key: string, value: boolean | string | number): void {\n    this.onValuesAboutToChange([key]);\n\n    const func = this.getFunctionFromCache('set');\n    return func(key, value);\n  }\n  getBoolean(key: string): boolean {\n    const func = this.getFunctionFromCache('getBoolean');\n    return func(key);\n  }\n  getString(key: string): string | undefined {\n    const func = this.getFunctionFromCache('getString');\n    return func(key);\n  }\n  getNumber(key: string): number {\n    const func = this.getFunctionFromCache('getNumber');\n    return func(key);\n  }\n  contains(key: string): boolean {\n    const func = this.getFunctionFromCache('contains');\n    return func(key);\n  }\n  delete(key: string): void {\n    this.onValuesAboutToChange([key]);\n\n    const func = this.getFunctionFromCache('delete');\n    return func(key);\n  }\n  getAllKeys(): string[] {\n    const func = this.getFunctionFromCache('getAllKeys');\n    return func();\n  }\n  clearAll(): void {\n    const keys = this.getAllKeys();\n    this.onValuesAboutToChange(keys);\n\n    const func = this.getFunctionFromCache('clearAll');\n    return func();\n  }\n\n  addOnValueChangedListener(onValueChanged: (key: string) => void): Listener {\n    this.onValueChangedListeners.push(onValueChanged);\n\n    return {\n      remove: () => {\n        const index = this.onValueChangedListeners.indexOf(onValueChanged);\n        if (index !== -1) {\n          this.onValueChangedListeners.splice(index, 1);\n        }\n      },\n    };\n  }\n}\n"]}
+{"version":3,"sources":["MMKV.ts"],"names":["onValueChangedListeners","Map","MMKV","constructor","configuration","id","nativeInstance","functionCache","has","set","get","getFunctionFromCache","functionName","onValuesAboutToChange","keys","length","setImmediate","key","listener","value","func","getBoolean","getString","getNumber","contains","delete","getAllKeys","clearAll","recrypt","toString","join","toJSON","addOnValueChangedListener","onValueChanged","push","remove","index","indexOf","splice"],"mappings":";;;;;;;AAAA;;AACA;;;;AAwHA,MAAMA,uBAAuB,GAAG,IAAIC,GAAJ,EAAhC;AAEA;AACA;AACA;;AACO,MAAMC,IAAN,CAAoC;AAKzC;AACF;AACA;AACA;AACEC,EAAAA,WAAW,CAACC,aAAgC,GAAG;AAAEC,IAAAA,EAAE,EAAE;AAAN,GAApC,EAA4D;AAAA;;AAAA;;AAAA;;AACrE,SAAKA,EAAL,GAAUD,aAAa,CAACC,EAAxB;AACA,SAAKC,cAAL,GAAsB,4BAAWF,aAAX,CAAtB;AACA,SAAKG,aAAL,GAAqB,EAArB;AACD;;AAEkC,MAAvBP,uBAAuB,GAAG;AACpC,QAAI,CAACA,uBAAuB,CAACQ,GAAxB,CAA4B,KAAKH,EAAjC,CAAL,EAA2C;AACzCL,MAAAA,uBAAuB,CAACS,GAAxB,CAA4B,KAAKJ,EAAjC,EAAqC,EAArC;AACD;;AACD,WAAOL,uBAAuB,CAACU,GAAxB,CAA4B,KAAKL,EAAjC,CAAP;AACD;;AAEOM,EAAAA,oBAAoB,CAC1BC,YAD0B,EAEX;AACf,QAAI,KAAKL,aAAL,CAAmBK,YAAnB,KAAoC,IAAxC,EAA8C;AAC5C,WAAKL,aAAL,CAAmBK,YAAnB,IAAmC,KAAKN,cAAL,CAAoBM,YAApB,CAAnC;AACD;;AACD,WAAO,KAAKL,aAAL,CAAmBK,YAAnB,CAAP;AACD;;AAEOC,EAAAA,qBAAqB,CAACC,IAAD,EAAiB;AAC5C,QAAI,KAAKd,uBAAL,CAA6Be,MAA7B,KAAwC,CAA5C,EAA+C;AAE/CC,IAAAA,YAAY,CAAC,MAAM;AACjB,gDAAwB,MAAM;AAC5B,aAAK,MAAMC,GAAX,IAAkBH,IAAlB,EAAwB;AACtB,eAAK,MAAMI,QAAX,IAAuB,KAAKlB,uBAA5B,EAAqD;AACnDkB,YAAAA,QAAQ,CAACD,GAAD,CAAR;AACD;AACF;AACF,OAND;AAOD,KARW,CAAZ;AASD;;AAEDR,EAAAA,GAAG,CAACQ,GAAD,EAAcE,KAAd,EAAsD;AACvD,SAAKN,qBAAL,CAA2B,CAACI,GAAD,CAA3B;AAEA,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,KAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,EAAME,KAAN,CAAX;AACD;;AACDE,EAAAA,UAAU,CAACJ,GAAD,EAAuB;AAC/B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDK,EAAAA,SAAS,CAACL,GAAD,EAAkC;AACzC,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDM,EAAAA,SAAS,CAACN,GAAD,EAAsB;AAC7B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDO,EAAAA,QAAQ,CAACP,GAAD,EAAuB;AAC7B,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDQ,EAAAA,MAAM,CAACR,GAAD,EAAoB;AACxB,SAAKJ,qBAAL,CAA2B,CAACI,GAAD,CAA3B;AAEA,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,QAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AACDS,EAAAA,UAAU,GAAa;AACrB,UAAMN,IAAI,GAAG,KAAKT,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOS,IAAI,EAAX;AACD;;AACDO,EAAAA,QAAQ,GAAS;AACf,UAAMb,IAAI,GAAG,KAAKY,UAAL,EAAb;AACA,SAAKb,qBAAL,CAA2BC,IAA3B;AAEA,UAAMM,IAAI,GAAG,KAAKT,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOS,IAAI,EAAX;AACD;;AACDQ,EAAAA,OAAO,CAACX,GAAD,EAAgC;AACrC,UAAMG,IAAI,GAAG,KAAKT,oBAAL,CAA0B,SAA1B,CAAb;AACA,WAAOS,IAAI,CAACH,GAAD,CAAX;AACD;;AAEDY,EAAAA,QAAQ,GAAW;AACjB,WAAQ,SAAQ,KAAKxB,EAAG,OAAM,KAAKqB,UAAL,GAAkBI,IAAlB,CAAuB,IAAvB,CAA6B,GAA3D;AACD;;AACDC,EAAAA,MAAM,GAAW;AACf,WAAO;AACL,OAAC,KAAK1B,EAAN,GAAW,KAAKqB,UAAL;AADN,KAAP;AAGD;;AAEDM,EAAAA,yBAAyB,CAACC,cAAD,EAAkD;AACzE,SAAKjC,uBAAL,CAA6BkC,IAA7B,CAAkCD,cAAlC;AAEA,WAAO;AACLE,MAAAA,MAAM,EAAE,MAAM;AACZ,cAAMC,KAAK,GAAG,KAAKpC,uBAAL,CAA6BqC,OAA7B,CAAqCJ,cAArC,CAAd;;AACA,YAAIG,KAAK,KAAK,CAAC,CAAf,EAAkB;AAChB,eAAKpC,uBAAL,CAA6BsC,MAA7B,CAAoCF,KAApC,EAA2C,CAA3C;AACD;AACF;AANI,KAAP;AAQD;;AA7GwC","sourcesContent":["import { unstable_batchedUpdates } from 'react-native';\nimport { createMMKV } from './createMMKV';\n\ninterface Listener {\n  remove: () => void;\n}\n\n/**\n * Used for configuration of a single MMKV instance.\n */\nexport interface MMKVConfiguration {\n  /**\n   * The MMKV instance's ID. If you want to use multiple instances, make sure to use different IDs!\n   *\n   * @example\n   * ```ts\n   * const userStorage = new MMKV({ id: `user-${userId}-storage` })\n   * const globalStorage = new MMKV({ id: 'global-app-storage' })\n   * ```\n   *\n   * @default 'mmkv.default'\n   */\n  id: string;\n  /**\n   * The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization:\n   *\n   * @example\n   * ```ts\n   * const temporaryStorage = new MMKV({ path: '/tmp/' })\n   * ```\n   */\n  path?: string;\n  /**\n   * The MMKV instance's encryption/decryption key. By default, MMKV stores all key-values in plain text on file, relying on iOS's sandbox to make sure the file is encrypted. Should you worry about information leaking, you can choose to encrypt MMKV.\n   *\n   * Encryption keys can have a maximum length of 16 bytes.\n   *\n   * @example\n   * ```ts\n   * const secureStorage = new MMKV({ encryptionKey: 'my-encryption-key!' })\n   * ```\n   */\n  encryptionKey?: string;\n}\n\n/**\n * Represents a single MMKV instance.\n */\ninterface MMKVInterface {\n  /**\n   * Set a value for the given `key`.\n   */\n  set: (key: string, value: boolean | string | number) => void;\n  /**\n   * Get a boolean value for the given `key`.\n   *\n   * @default false\n   */\n  getBoolean: (key: string) => boolean;\n  /**\n   * Get a string value for the given `key`.\n   *\n   * @default undefined\n   */\n  getString: (key: string) => string | undefined;\n  /**\n   * Get a number value for the given `key`.\n   *\n   * @default 0\n   */\n  getNumber: (key: string) => number;\n  /**\n   * Checks whether the given `key` is being stored in this MMKV instance.\n   */\n  contains: (key: string) => boolean;\n  /**\n   * Delete the given `key`.\n   */\n  delete: (key: string) => void;\n  /**\n   * Get all keys.\n   *\n   * @default []\n   */\n  getAllKeys: () => string[];\n  /**\n   * Delete all keys.\n   */\n  clearAll: () => void;\n  /**\n   * Sets (or updates) the encryption-key to encrypt all data in this MMKV instance with.\n   *\n   * To remove encryption, pass `undefined` as a key.\n   *\n   * Encryption keys can have a maximum length of 16 bytes.\n   */\n  recrypt: (key: string | undefined) => void;\n  /**\n   * Adds a value changed listener. The Listener will be called whenever any value\n   * in this storage instance changes (set or delete).\n   *\n   * To unsubscribe from value changes, call `remove()` on the Listener.\n   */\n  addOnValueChangedListener: (\n    onValueChanged: (key: string) => void\n  ) => Listener;\n}\n\nexport type NativeMMKV = Pick<\n  MMKVInterface,\n  | 'clearAll'\n  | 'contains'\n  | 'delete'\n  | 'getAllKeys'\n  | 'getBoolean'\n  | 'getNumber'\n  | 'getString'\n  | 'set'\n  | 'recrypt'\n>;\n\nconst onValueChangedListeners = new Map<string, ((key: string) => void)[]>();\n\n/**\n * A single MMKV instance.\n */\nexport class MMKV implements MMKVInterface {\n  private nativeInstance: NativeMMKV;\n  private functionCache: Partial<NativeMMKV>;\n  private id: string;\n\n  /**\n   * Creates a new MMKV instance with the given Configuration.\n   * If no custom `id` is supplied, `'mmkv.default'` will be used.\n   */\n  constructor(configuration: MMKVConfiguration = { id: 'mmkv.default' }) {\n    this.id = configuration.id;\n    this.nativeInstance = createMMKV(configuration);\n    this.functionCache = {};\n  }\n\n  private get onValueChangedListeners() {\n    if (!onValueChangedListeners.has(this.id)) {\n      onValueChangedListeners.set(this.id, []);\n    }\n    return onValueChangedListeners.get(this.id)!;\n  }\n\n  private getFunctionFromCache<T extends keyof NativeMMKV>(\n    functionName: T\n  ): NativeMMKV[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as NativeMMKV[T];\n  }\n\n  private onValuesAboutToChange(keys: string[]) {\n    if (this.onValueChangedListeners.length === 0) return;\n\n    setImmediate(() => {\n      unstable_batchedUpdates(() => {\n        for (const key of keys) {\n          for (const listener of this.onValueChangedListeners) {\n            listener(key);\n          }\n        }\n      });\n    });\n  }\n\n  set(key: string, value: boolean | string | number): void {\n    this.onValuesAboutToChange([key]);\n\n    const func = this.getFunctionFromCache('set');\n    return func(key, value);\n  }\n  getBoolean(key: string): boolean {\n    const func = this.getFunctionFromCache('getBoolean');\n    return func(key);\n  }\n  getString(key: string): string | undefined {\n    const func = this.getFunctionFromCache('getString');\n    return func(key);\n  }\n  getNumber(key: string): number {\n    const func = this.getFunctionFromCache('getNumber');\n    return func(key);\n  }\n  contains(key: string): boolean {\n    const func = this.getFunctionFromCache('contains');\n    return func(key);\n  }\n  delete(key: string): void {\n    this.onValuesAboutToChange([key]);\n\n    const func = this.getFunctionFromCache('delete');\n    return func(key);\n  }\n  getAllKeys(): string[] {\n    const func = this.getFunctionFromCache('getAllKeys');\n    return func();\n  }\n  clearAll(): void {\n    const keys = this.getAllKeys();\n    this.onValuesAboutToChange(keys);\n\n    const func = this.getFunctionFromCache('clearAll');\n    return func();\n  }\n  recrypt(key: string | undefined): void {\n    const func = this.getFunctionFromCache('recrypt');\n    return func(key);\n  }\n\n  toString(): string {\n    return `MMKV (${this.id}): [${this.getAllKeys().join(', ')}]`;\n  }\n  toJSON(): object {\n    return {\n      [this.id]: this.getAllKeys(),\n    };\n  }\n\n  addOnValueChangedListener(onValueChanged: (key: string) => void): Listener {\n    this.onValueChangedListeners.push(onValueChanged);\n\n    return {\n      remove: () => {\n        const index = this.onValueChangedListeners.indexOf(onValueChanged);\n        if (index !== -1) {\n          this.onValueChangedListeners.splice(index, 1);\n        }\n      },\n    };\n  }\n}\n"]}

package/lib/commonjs/createMMKV.js

@@ -5,10 +5,58 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createMMKV = void 0;
 
-// global func declaration for JSI functions
+var _reactNative = require("react-native");
+
+// Root directory of all MMKV stores
+const ROOT_DIRECTORY = null;
+
 const createMMKV = config => {
+  // Check if the constructor exists. If not, try installing the JSI bindings.
   if (global.mmkvCreateNewInstance == null) {
-    throw new Error('Failed to create a new MMKV instance, the native initializer function does not exist. Is the native MMKV library correctly installed? Make sure to disable any remote debugger (e.g. Chrome) to use JSI!');
+    // Get the native MMKV ReactModule
+    const MMKVModule = _reactNative.NativeModules.MMKV;
+
+    if (MMKVModule == null) {
+      var _NativeModules$Native, _NativeModules$Native2;
+
+      let message = 'Failed to create a new MMKV instance: The native MMKV Module could not be found.';
+      message += '\n* Make sure react-native-mmkv is correctly autolinked (run `npx react-native config` to verify)';
+
+      if (_reactNative.Platform.OS === 'ios' || _reactNative.Platform.OS === 'macos') {
+        message += '\n* Make sure you ran `pod install` in the ios/ directory.';
+      }
+
+      if (_reactNative.Platform.OS === 'android') {
+        message += '\n* Make sure gradle is synced.';
+      } // check if Expo
+
+
+      const ExpoConstants = (_NativeModules$Native = _reactNative.NativeModules.NativeUnimoduleProxy) === null || _NativeModules$Native === void 0 ? void 0 : (_NativeModules$Native2 = _NativeModules$Native.modulesConstants) === null || _NativeModules$Native2 === void 0 ? void 0 : _NativeModules$Native2.ExponentConstants;
+
+      if (ExpoConstants != null) {
+        if (ExpoConstants.appOwnership === 'expo') {
+          // We're running Expo Go
+          throw new Error('react-native-mmkv is not supported in Expo Go! Use EAS (`expo prebuild`) or eject to a bare workflow instead.');
+        } else {
+          // We're running Expo bare / standalone
+          message += '\n* Make sure you ran `expo prebuild`.';
+        }
+      }
+
+      message += '\n* Make sure you rebuilt the app.';
+      throw new Error(message);
+    } // Check if we are running on-device (JSI)
+
+
+    if (global.nativeCallSyncHook == null || MMKVModule.install == null) {
+      throw new Error('Failed to create a new MMKV instance: React Native is not running on-device. MMKV can only be used when synchronous method invocations (JSI) are possible. If you are using a remote debugger (e.g. Chrome), switch to an on-device debugger (e.g. Flipper) instead.');
+    } // Call the synchronous blocking install() function
+
+
+    const result = MMKVModule.install(ROOT_DIRECTORY);
+    if (result !== true) throw new Error(`Failed to create a new MMKV instance: The native MMKV Module could not be installed! Looks like something went wrong when installing JSI bindings: ${result}`); // Check again if the constructor now exists. If not, throw an error.
+
+    if (global.mmkvCreateNewInstance == null) throw new Error('Failed to create a new MMKV instance, the native initializer function does not exist. Are you trying to use MMKV from different JS Runtimes?');
   }
 
   return global.mmkvCreateNewInstance(config);

package/lib/commonjs/createMMKV.js.map

@@ -1 +1 @@
-{"version":3,"sources":["createMMKV.ts"],"names":["createMMKV","config","global","mmkvCreateNewInstance","Error"],"mappings":";;;;;;;AAEA;AAKO,MAAMA,UAAU,GAAIC,MAAD,IAA2C;AACnE,MAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC,UAAM,IAAIC,KAAJ,CACJ,0MADI,CAAN;AAGD;;AAED,SAAOF,MAAM,CAACC,qBAAP,CAA6BF,MAA7B,CAAP;AACD,CARM","sourcesContent":["import type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';\n\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(configuration: MMKVConfiguration): NativeMMKV;\n}\n\nexport const createMMKV = (config: MMKVConfiguration): NativeMMKV => {\n  if (global.mmkvCreateNewInstance == null) {\n    throw new Error(\n      'Failed to create a new MMKV instance, the native initializer function does not exist. Is the native MMKV library correctly installed? Make sure to disable any remote debugger (e.g. Chrome) to use JSI!'\n    );\n  }\n\n  return global.mmkvCreateNewInstance(config);\n};\n"]}
+{"version":3,"sources":["createMMKV.ts"],"names":["ROOT_DIRECTORY","createMMKV","config","global","mmkvCreateNewInstance","MMKVModule","NativeModules","MMKV","message","Platform","OS","ExpoConstants","NativeUnimoduleProxy","modulesConstants","ExponentConstants","appOwnership","Error","nativeCallSyncHook","install","result"],"mappings":";;;;;;;AAAA;;AASA;AACA,MAAMA,cAA6B,GAAG,IAAtC;;AAEO,MAAMC,UAAU,GAAIC,MAAD,IAA2C;AACnE;AACA,MAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC;AACA,UAAMC,UAAU,GAAGC,2BAAcC,IAAjC;;AACA,QAAIF,UAAU,IAAI,IAAlB,EAAwB;AAAA;;AACtB,UAAIG,OAAO,GACT,kFADF;AAEAA,MAAAA,OAAO,IACL,mGADF;;AAEA,UAAIC,sBAASC,EAAT,KAAgB,KAAhB,IAAyBD,sBAASC,EAAT,KAAgB,OAA7C,EAAsD;AACpDF,QAAAA,OAAO,IAAI,4DAAX;AACD;;AACD,UAAIC,sBAASC,EAAT,KAAgB,SAApB,EAA+B;AAC7BF,QAAAA,OAAO,IAAI,iCAAX;AACD,OAVqB,CAWtB;;;AACA,YAAMG,aAAa,4BACjBL,2BAAcM,oBADG,oFACjB,sBAAoCC,gBADnB,2DACjB,uBAAsDC,iBADxD;;AAEA,UAAIH,aAAa,IAAI,IAArB,EAA2B;AACzB,YAAIA,aAAa,CAACI,YAAd,KAA+B,MAAnC,EAA2C;AACzC;AACA,gBAAM,IAAIC,KAAJ,CACJ,+GADI,CAAN;AAGD,SALD,MAKO;AACL;AACAR,UAAAA,OAAO,IAAI,wCAAX;AACD;AACF;;AAEDA,MAAAA,OAAO,IAAI,oCAAX;AACA,YAAM,IAAIQ,KAAJ,CAAUR,OAAV,CAAN;AACD,KA/BuC,CAiCxC;;;AACA,QAAIL,MAAM,CAACc,kBAAP,IAA6B,IAA7B,IAAqCZ,UAAU,CAACa,OAAX,IAAsB,IAA/D,EAAqE;AACnE,YAAM,IAAIF,KAAJ,CACJ,sQADI,CAAN;AAGD,KAtCuC,CAwCxC;;;AACA,UAAMG,MAAM,GAAGd,UAAU,CAACa,OAAX,CAAmBlB,cAAnB,CAAf;AACA,QAAImB,MAAM,KAAK,IAAf,EACE,MAAM,IAAIH,KAAJ,CACH,sJAAqJG,MAAO,EADzJ,CAAN,CA3CsC,CA+CxC;;AACA,QAAIhB,MAAM,CAACC,qBAAP,IAAgC,IAApC,EACE,MAAM,IAAIY,KAAJ,CACJ,8IADI,CAAN;AAGH;;AAED,SAAOb,MAAM,CAACC,qBAAP,CAA6BF,MAA7B,CAAP;AACD,CAzDM","sourcesContent":["import { NativeModules, Platform } from 'react-native';\nimport type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';\n\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(configuration: MMKVConfiguration): NativeMMKV;\n  function nativeCallSyncHook(): unknown;\n}\n\n// Root directory of all MMKV stores\nconst ROOT_DIRECTORY: string | null = null;\n\nexport const createMMKV = (config: MMKVConfiguration): NativeMMKV => {\n  // Check if the constructor exists. If not, try installing the JSI bindings.\n  if (global.mmkvCreateNewInstance == null) {\n    // Get the native MMKV ReactModule\n    const MMKVModule = NativeModules.MMKV;\n    if (MMKVModule == null) {\n      let message =\n        'Failed to create a new MMKV instance: The native MMKV Module could not be found.';\n      message +=\n        '\\n* Make sure react-native-mmkv is correctly autolinked (run `npx react-native config` to verify)';\n      if (Platform.OS === 'ios' || Platform.OS === 'macos') {\n        message += '\\n* Make sure you ran `pod install` in the ios/ directory.';\n      }\n      if (Platform.OS === 'android') {\n        message += '\\n* Make sure gradle is synced.';\n      }\n      // check if Expo\n      const ExpoConstants =\n        NativeModules.NativeUnimoduleProxy?.modulesConstants?.ExponentConstants;\n      if (ExpoConstants != null) {\n        if (ExpoConstants.appOwnership === 'expo') {\n          // We're running Expo Go\n          throw new Error(\n            'react-native-mmkv is not supported in Expo Go! Use EAS (`expo prebuild`) or eject to a bare workflow instead.'\n          );\n        } else {\n          // We're running Expo bare / standalone\n          message += '\\n* Make sure you ran `expo prebuild`.';\n        }\n      }\n\n      message += '\\n* Make sure you rebuilt the app.';\n      throw new Error(message);\n    }\n\n    // Check if we are running on-device (JSI)\n    if (global.nativeCallSyncHook == null || MMKVModule.install == null) {\n      throw new Error(\n        'Failed to create a new MMKV instance: React Native is not running on-device. MMKV can only be used when synchronous method invocations (JSI) are possible. If you are using a remote debugger (e.g. Chrome), switch to an on-device debugger (e.g. Flipper) instead.'\n      );\n    }\n\n    // Call the synchronous blocking install() function\n    const result = MMKVModule.install(ROOT_DIRECTORY);\n    if (result !== true)\n      throw new Error(\n        `Failed to create a new MMKV instance: The native MMKV Module could not be installed! Looks like something went wrong when installing JSI bindings: ${result}`\n      );\n\n    // Check again if the constructor now exists. If not, throw an error.\n    if (global.mmkvCreateNewInstance == null)\n      throw new Error(\n        'Failed to create a new MMKV instance, the native initializer function does not exist. Are you trying to use MMKV from different JS Runtimes?'\n      );\n  }\n\n  return global.mmkvCreateNewInstance(config);\n};\n"]}

package/lib/commonjs/createMMKV.web.js

@@ -59,7 +59,10 @@ const createMMKV = config => {
       return Boolean((_storage$getItem3 = storage().getItem(key)) !== null && _storage$getItem3 !== void 0 ? _storage$getItem3 : false);
     },
     getAllKeys: () => Object.keys(storage()),
-    contains: key => storage().getItem(key) != null
+    contains: key => storage().getItem(key) != null,
+    recrypt: () => {
+      throw new Error('`recrypt(..)` is not supported on Web!');
+    }
   };
 };
 

package/lib/commonjs/createMMKV.web.js.map

@@ -1 +1 @@
-{"version":3,"sources":["createMMKV.web.ts"],"names":["canUseDOM","window","document","createElement","createMMKV","config","id","Error","encryptionKey","path","storage","domStorage","global","localStorage","clearAll","clear","delete","key","removeItem","set","value","setItem","toString","getString","getItem","undefined","getNumber","Number","getBoolean","Boolean","getAllKeys","Object","keys","contains"],"mappings":";;;;;;;;;AAAA;AAGA,MAAMA,SAAS,GACb,OAAOC,MAAP,KAAkB,WAAlB,IAAiC,qBAAAA,MAAM,CAACC,QAAP,sEAAiBC,aAAjB,KAAkC,IADrE;;AAGO,MAAMC,UAAU,GAAIC,MAAD,IAA2C;AACnE,MAAIA,MAAM,CAACC,EAAP,KAAc,cAAlB,EAAkC;AAChC,UAAM,IAAIC,KAAJ,CAAU,qCAAV,CAAN;AACD;;AACD,MAAIF,MAAM,CAACG,aAAP,IAAwB,IAA5B,EAAkC;AAChC,UAAM,IAAID,KAAJ,CAAU,gDAAV,CAAN;AACD;;AACD,MAAIF,MAAM,CAACI,IAAP,IAAe,IAAnB,EAAyB;AACvB,UAAM,IAAIF,KAAJ,CAAU,uCAAV,CAAN;AACD;;AAED,QAAMG,OAAO,GAAG,MAAM;AAAA;;AACpB,QAAI,CAACV,SAAL,EAAgB;AACd,YAAM,IAAIO,KAAJ,CACJ,kFADI,CAAN;AAGD;;AACD,UAAMI,UAAU,8CACdC,MADc,4CACd,QAAQC,YADM,kFACUZ,MADV,4CACU,QAAQY,YADlB,uCACkCA,YADlD;;AAEA,QAAIF,UAAU,IAAI,IAAlB,EAAwB;AACtB,YAAM,IAAIJ,KAAJ,CAAW,yCAAX,CAAN;AACD;;AACD,WAAOI,UAAP;AACD,GAZD;;AAcA,SAAO;AACLG,IAAAA,QAAQ,EAAE,MAAMJ,OAAO,GAAGK,KAAV,EADX;AAELC,IAAAA,MAAM,EAAGC,GAAD,IAASP,OAAO,GAAGQ,UAAV,CAAqBD,GAArB,CAFZ;AAGLE,IAAAA,GAAG,EAAE,CAACF,GAAD,EAAMG,KAAN,KAAgBV,OAAO,GAAGW,OAAV,CAAkBJ,GAAlB,EAAuBG,KAAK,CAACE,QAAN,EAAvB,CAHhB;AAILC,IAAAA,SAAS,EAAGN,GAAD;AAAA;;AAAA,iCAASP,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAT,+DAAmCQ,SAAnC;AAAA,KAJN;AAKLC,IAAAA,SAAS,EAAGT,GAAD;AAAA;;AAAA,aAASU,MAAM,sBAACjB,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAD,iEAA2B,CAA3B,CAAf;AAAA,KALN;AAMLW,IAAAA,UAAU,EAAGX,GAAD;AAAA;;AAAA,aAASY,OAAO,sBAACnB,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAD,iEAA2B,KAA3B,CAAhB;AAAA,KANP;AAOLa,IAAAA,UAAU,EAAE,MAAMC,MAAM,CAACC,IAAP,CAAYtB,OAAO,EAAnB,CAPb;AAQLuB,IAAAA,QAAQ,EAAGhB,GAAD,IAASP,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,KAA0B;AARxC,GAAP;AAUD,CAnCM","sourcesContent":["/* global localStorage */\nimport type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';\n\nconst canUseDOM =\n  typeof window !== 'undefined' && window.document?.createElement != null;\n\nexport const createMMKV = (config: MMKVConfiguration): NativeMMKV => {\n  if (config.id !== 'mmkv.default') {\n    throw new Error(\"MMKV: 'id' is not supported on Web!\");\n  }\n  if (config.encryptionKey != null) {\n    throw new Error(\"MMKV: 'encryptionKey' is not supported on Web!\");\n  }\n  if (config.path != null) {\n    throw new Error(\"MMKV: 'path' is not supported on Web!\");\n  }\n\n  const storage = () => {\n    if (!canUseDOM) {\n      throw new Error(\n        'Tried to access storage on the server. Did you forget to call this in useEffect?'\n      );\n    }\n    const domStorage =\n      global?.localStorage ?? window?.localStorage ?? localStorage;\n    if (domStorage == null) {\n      throw new Error(`Could not find 'localStorage' instance!`);\n    }\n    return domStorage;\n  };\n\n  return {\n    clearAll: () => storage().clear(),\n    delete: (key) => storage().removeItem(key),\n    set: (key, value) => storage().setItem(key, value.toString()),\n    getString: (key) => storage().getItem(key) ?? undefined,\n    getNumber: (key) => Number(storage().getItem(key) ?? 0),\n    getBoolean: (key) => Boolean(storage().getItem(key) ?? false),\n    getAllKeys: () => Object.keys(storage()),\n    contains: (key) => storage().getItem(key) != null,\n  };\n};\n"]}
+{"version":3,"sources":["createMMKV.web.ts"],"names":["canUseDOM","window","document","createElement","createMMKV","config","id","Error","encryptionKey","path","storage","domStorage","global","localStorage","clearAll","clear","delete","key","removeItem","set","value","setItem","toString","getString","getItem","undefined","getNumber","Number","getBoolean","Boolean","getAllKeys","Object","keys","contains","recrypt"],"mappings":";;;;;;;;;AAAA;AAGA,MAAMA,SAAS,GACb,OAAOC,MAAP,KAAkB,WAAlB,IAAiC,qBAAAA,MAAM,CAACC,QAAP,sEAAiBC,aAAjB,KAAkC,IADrE;;AAGO,MAAMC,UAAU,GAAIC,MAAD,IAA2C;AACnE,MAAIA,MAAM,CAACC,EAAP,KAAc,cAAlB,EAAkC;AAChC,UAAM,IAAIC,KAAJ,CAAU,qCAAV,CAAN;AACD;;AACD,MAAIF,MAAM,CAACG,aAAP,IAAwB,IAA5B,EAAkC;AAChC,UAAM,IAAID,KAAJ,CAAU,gDAAV,CAAN;AACD;;AACD,MAAIF,MAAM,CAACI,IAAP,IAAe,IAAnB,EAAyB;AACvB,UAAM,IAAIF,KAAJ,CAAU,uCAAV,CAAN;AACD;;AAED,QAAMG,OAAO,GAAG,MAAM;AAAA;;AACpB,QAAI,CAACV,SAAL,EAAgB;AACd,YAAM,IAAIO,KAAJ,CACJ,kFADI,CAAN;AAGD;;AACD,UAAMI,UAAU,8CACdC,MADc,4CACd,QAAQC,YADM,kFACUZ,MADV,4CACU,QAAQY,YADlB,uCACkCA,YADlD;;AAEA,QAAIF,UAAU,IAAI,IAAlB,EAAwB;AACtB,YAAM,IAAIJ,KAAJ,CAAW,yCAAX,CAAN;AACD;;AACD,WAAOI,UAAP;AACD,GAZD;;AAcA,SAAO;AACLG,IAAAA,QAAQ,EAAE,MAAMJ,OAAO,GAAGK,KAAV,EADX;AAELC,IAAAA,MAAM,EAAGC,GAAD,IAASP,OAAO,GAAGQ,UAAV,CAAqBD,GAArB,CAFZ;AAGLE,IAAAA,GAAG,EAAE,CAACF,GAAD,EAAMG,KAAN,KAAgBV,OAAO,GAAGW,OAAV,CAAkBJ,GAAlB,EAAuBG,KAAK,CAACE,QAAN,EAAvB,CAHhB;AAILC,IAAAA,SAAS,EAAGN,GAAD;AAAA;;AAAA,iCAASP,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAT,+DAAmCQ,SAAnC;AAAA,KAJN;AAKLC,IAAAA,SAAS,EAAGT,GAAD;AAAA;;AAAA,aAASU,MAAM,sBAACjB,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAD,iEAA2B,CAA3B,CAAf;AAAA,KALN;AAMLW,IAAAA,UAAU,EAAGX,GAAD;AAAA;;AAAA,aAASY,OAAO,sBAACnB,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,CAAD,iEAA2B,KAA3B,CAAhB;AAAA,KANP;AAOLa,IAAAA,UAAU,EAAE,MAAMC,MAAM,CAACC,IAAP,CAAYtB,OAAO,EAAnB,CAPb;AAQLuB,IAAAA,QAAQ,EAAGhB,GAAD,IAASP,OAAO,GAAGc,OAAV,CAAkBP,GAAlB,KAA0B,IARxC;AASLiB,IAAAA,OAAO,EAAE,MAAM;AACb,YAAM,IAAI3B,KAAJ,CAAU,wCAAV,CAAN;AACD;AAXI,GAAP;AAaD,CAtCM","sourcesContent":["/* global localStorage */\nimport type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';\n\nconst canUseDOM =\n  typeof window !== 'undefined' && window.document?.createElement != null;\n\nexport const createMMKV = (config: MMKVConfiguration): NativeMMKV => {\n  if (config.id !== 'mmkv.default') {\n    throw new Error(\"MMKV: 'id' is not supported on Web!\");\n  }\n  if (config.encryptionKey != null) {\n    throw new Error(\"MMKV: 'encryptionKey' is not supported on Web!\");\n  }\n  if (config.path != null) {\n    throw new Error(\"MMKV: 'path' is not supported on Web!\");\n  }\n\n  const storage = () => {\n    if (!canUseDOM) {\n      throw new Error(\n        'Tried to access storage on the server. Did you forget to call this in useEffect?'\n      );\n    }\n    const domStorage =\n      global?.localStorage ?? window?.localStorage ?? localStorage;\n    if (domStorage == null) {\n      throw new Error(`Could not find 'localStorage' instance!`);\n    }\n    return domStorage;\n  };\n\n  return {\n    clearAll: () => storage().clear(),\n    delete: (key) => storage().removeItem(key),\n    set: (key, value) => storage().setItem(key, value.toString()),\n    getString: (key) => storage().getItem(key) ?? undefined,\n    getNumber: (key) => Number(storage().getItem(key) ?? 0),\n    getBoolean: (key) => Boolean(storage().getItem(key) ?? false),\n    getAllKeys: () => Object.keys(storage()),\n    contains: (key) => storage().getItem(key) != null,\n    recrypt: () => {\n      throw new Error('`recrypt(..)` is not supported on Web!');\n    },\n  };\n};\n"]}

package/lib/commonjs/hooks.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useMMKV = useMMKV;
-exports.useMMKVNumber = exports.useMMKVBoolean = void 0;
+exports.useMMKVBoolean = void 0;
+exports.useMMKVListener = useMMKVListener;
+exports.useMMKVNumber = void 0;
 exports.useMMKVObject = useMMKVObject;
 exports.useMMKVString = void 0;
 
@@ -71,7 +73,7 @@ function createMMKVHook(getter) {
       });
       return () => listener.remove();
     }, [key, mmkv]);
-    return (0, _react.useMemo)(() => [value, set], [value, set]);
+    return [value, set];
   };
 }
 /**
@@ -135,8 +137,40 @@ function useMMKVObject(key, instance) {
     return JSON.parse(string);
   }, [string]);
   const setValue = (0, _react.useCallback)(v => {
-    setString(JSON.stringify(v));
+    if (v == null) {
+      // Clear the Value
+      setString(undefined);
+    } else {
+      // Store the Object as a serialized Value
+      setString(JSON.stringify(v));
+    }
   }, [setString]);
   return [value, setValue];
 }
+/**
+ * Listen for changes in the given MMKV storage instance.
+ * If no instance is passed, the default instance will be used.
+ * @param valueChangedListener The function to call whenever a value inside the storage instance changes
+ * @param instance The instance to listen to changes to (or the default instance)
+ *
+ * @example
+ * ```ts
+ * useMMKVListener((key) => {
+ *   console.log(`Value for "${key}" changed!`)
+ * })
+ * ```
+ */
+
+
+function useMMKVListener(valueChangedListener, instance) {
+  const ref = (0, _react.useRef)(valueChangedListener);
+  ref.current = valueChangedListener;
+  const mmkv = instance !== null && instance !== void 0 ? instance : getDefaultInstance();
+  (0, _react.useEffect)(() => {
+    const listener = mmkv.addOnValueChangedListener(changedKey => {
+      ref.current(changedKey);
+    });
+    return () => listener.remove();
+  }, [mmkv]);
+}
 //# sourceMappingURL=hooks.js.map

package/lib/commonjs/hooks.js.map

@@ -1 +1 @@
-{"version":3,"sources":["hooks.ts"],"names":["isConfigurationEqual","left","right","encryptionKey","id","path","defaultInstance","getDefaultInstance","MMKV","useMMKV","configuration","instance","lastConfiguration","current","createMMKVHook","getter","key","mmkv","value","setValue","valueRef","set","v","newValue","delete","Error","listener","addOnValueChangedListener","changedKey","remove","useMMKVString","getString","useMMKVNumber","getNumber","useMMKVBoolean","getBoolean","useMMKVObject","string","setString","undefined","JSON","parse","stringify"],"mappings":";;;;;;;;;;AAAA;;AAOA;;AAEA,SAASA,oBAAT,CACEC,IADF,EAEEC,KAFF,EAGW;AACT,SACED,IAAI,CAACE,aAAL,KAAuBD,KAAK,CAACC,aAA7B,IACAF,IAAI,CAACG,EAAL,KAAYF,KAAK,CAACE,EADlB,IAEAH,IAAI,CAACI,IAAL,KAAcH,KAAK,CAACG,IAHtB;AAKD;;AAED,IAAIC,eAA4B,GAAG,IAAnC;;AACA,SAASC,kBAAT,GAAoC;AAClC,MAAID,eAAe,IAAI,IAAvB,EAA6B;AAC3BA,IAAAA,eAAe,GAAG,IAAIE,UAAJ,EAAlB;AACD;;AACD,SAAOF,eAAP;AACD;;AAEM,SAASG,OAAT,CACLC,aADK,EAEkB;AACvB,QAAMC,QAAQ,GAAG,oBAAjB;AAEA,QAAMC,iBAAiB,GAAG,oBAA1B;;AACA,MACEA,iBAAiB,CAACC,OAAlB,IAA6B,IAA7B,IACA,CAACb,oBAAoB,CAACY,iBAAiB,CAACC,OAAnB,EAA4BH,aAA5B,CAFvB,EAGE;AACAE,IAAAA,iBAAiB,CAACC,OAAlB,GAA4BH,aAA5B;AACAC,IAAAA,QAAQ,CAACE,OAAT,GAAmB,IAAIL,UAAJ,CAASE,aAAT,CAAnB;AACD,GAVsB,CAYvB;;;AACA,SAAOC,QAAP;AACD;;AAED,SAASG,cAAT,CAIEC,MAJF,EAI8C;AAC5C,SAAO,CACLC,GADK,EAELL,QAFK,KAGiD;AACtD,UAAMM,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeJ,kBAAkB,EAA3C;AACA,UAAM,CAACW,KAAD,EAAQC,QAAR,IAAoB,qBAAS,MAAMJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAArB,CAA1B;AACA,UAAMI,QAAQ,GAAG,mBAAUF,KAAV,CAAjB;AACAE,IAAAA,QAAQ,CAACP,OAAT,GAAmBK,KAAnB;AAEA,UAAMG,GAAG,GAAG,wBACTC,CAAD,IAAmB;AACjB,YAAMC,QAAQ,GAAG,OAAOD,CAAP,KAAa,UAAb,GAA0BA,CAAC,CAACF,QAAQ,CAACP,OAAV,CAA3B,GAAgDS,CAAjE;;AACA,cAAQ,OAAOC,QAAf;AACE,aAAK,QAAL;AACA,aAAK,QAAL;AACA,aAAK,SAAL;AACEN,UAAAA,IAAI,CAACI,GAAL,CAASL,GAAT,EAAcO,QAAd;AACA;;AACF,aAAK,WAAL;AACEN,UAAAA,IAAI,CAACO,MAAL,CAAYR,GAAZ;AACA;;AACF;AACE,gBAAM,IAAIS,KAAJ,CAAW,cAAa,OAAOF,QAAS,oBAAxC,CAAN;AAVJ;AAYD,KAfS,EAgBV,CAACP,GAAD,EAAMC,IAAN,CAhBU,CAAZ;AAmBA,0BAAU,MAAM;AACd,YAAMS,QAAQ,GAAGT,IAAI,CAACU,yBAAL,CAAgCC,UAAD,IAAgB;AAC9D,YAAIA,UAAU,KAAKZ,GAAnB,EAAwB;AACtBG,UAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACD;AACF,OAJgB,CAAjB;AAKA,aAAO,MAAMU,QAAQ,CAACG,MAAT,EAAb;AACD,KAPD,EAOG,CAACb,GAAD,EAAMC,IAAN,CAPH;AASA,WAAO,oBAAQ,MAAM,CAACC,KAAD,EAAQG,GAAR,CAAd,EAA4B,CAACH,KAAD,EAAQG,GAAR,CAA5B,CAAP;AACD,GAtCD;AAuCD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMS,aAAa,GAAGhB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACoB,SAAT,CAAmBf,GAAnB,CADyC,CAApC;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMgB,aAAa,GAAGlB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACsB,SAAT,CAAmBjB,GAAnB,CADyC,CAApC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMkB,cAAc,GAAGpB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC3CL,QAAQ,CAACwB,UAAT,CAAoBnB,GAApB,CAD0C,CAArC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;AACO,SAASoB,aAAT,CACLpB,GADK,EAELL,QAFK,EAGiD;AACtD,QAAM,CAAC0B,MAAD,EAASC,SAAT,IAAsBR,aAAa,CAACd,GAAD,EAAML,QAAN,CAAzC;AAEA,QAAMO,KAAK,GAAG,oBAAQ,MAAM;AAC1B,QAAImB,MAAM,IAAI,IAAd,EAAoB,OAAOE,SAAP;AACpB,WAAOC,IAAI,CAACC,KAAL,CAAWJ,MAAX,CAAP;AACD,GAHa,EAGX,CAACA,MAAD,CAHW,CAAd;AAIA,QAAMlB,QAAQ,GAAG,wBACdG,CAAD,IAAU;AACRgB,IAAAA,SAAS,CAACE,IAAI,CAACE,SAAL,CAAepB,CAAf,CAAD,CAAT;AACD,GAHc,EAIf,CAACgB,SAAD,CAJe,CAAjB;AAOA,SAAO,CAACpB,KAAD,EAAQC,QAAR,CAAP;AACD","sourcesContent":["import React, {\n  useRef,\n  useState,\n  useMemo,\n  useCallback,\n  useEffect,\n} from 'react';\nimport { MMKV, MMKVConfiguration } from './MMKV';\n\nfunction isConfigurationEqual(\n  left: MMKVConfiguration,\n  right: MMKVConfiguration\n): boolean {\n  return (\n    left.encryptionKey === right.encryptionKey &&\n    left.id === right.id &&\n    left.path === right.path\n  );\n}\n\nlet defaultInstance: MMKV | null = null;\nfunction getDefaultInstance(): MMKV {\n  if (defaultInstance == null) {\n    defaultInstance = new MMKV();\n  }\n  return defaultInstance;\n}\n\nexport function useMMKV(\n  configuration: MMKVConfiguration\n): React.RefObject<MMKV> {\n  const instance = useRef<MMKV>();\n\n  const lastConfiguration = useRef<MMKVConfiguration>();\n  if (\n    lastConfiguration.current == null ||\n    !isConfigurationEqual(lastConfiguration.current, configuration)\n  ) {\n    lastConfiguration.current = configuration;\n    instance.current = new MMKV(configuration);\n  }\n\n  // @ts-expect-error it's not null, I promise.\n  return instance;\n}\n\nfunction createMMKVHook<\n  T extends boolean | number | (string | undefined),\n  TSet extends T | undefined,\n  TSetAction extends TSet | ((current: T) => TSet)\n>(getter: (instance: MMKV, key: string) => T) {\n  return (\n    key: string,\n    instance?: MMKV\n  ): [value: T, setValue: (value: TSetAction) => void] => {\n    const mmkv = instance ?? getDefaultInstance();\n    const [value, setValue] = useState(() => getter(mmkv, key));\n    const valueRef = useRef<T>(value);\n    valueRef.current = value;\n\n    const set = useCallback(\n      (v: TSetAction) => {\n        const newValue = typeof v === 'function' ? v(valueRef.current) : v;\n        switch (typeof newValue) {\n          case 'number':\n          case 'string':\n          case 'boolean':\n            mmkv.set(key, newValue);\n            break;\n          case 'undefined':\n            mmkv.delete(key);\n            break;\n          default:\n            throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);\n        }\n      },\n      [key, mmkv]\n    );\n\n    useEffect(() => {\n      const listener = mmkv.addOnValueChangedListener((changedKey) => {\n        if (changedKey === key) {\n          setValue(getter(mmkv, key));\n        }\n      });\n      return () => listener.remove();\n    }, [key, mmkv]);\n\n    return useMemo(() => [value, set], [value, set]);\n  };\n}\n\n/**\n * Use the string value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [username, setUsername] = useMMKVString(\"user.name\")\n * ```\n */\nexport const useMMKVString = createMMKVHook((instance, key) =>\n  instance.getString(key)\n);\n\n/**\n * Use the number value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [age, setAge] = useMMKVNumber(\"user.age\")\n * ```\n */\nexport const useMMKVNumber = createMMKVHook((instance, key) =>\n  instance.getNumber(key)\n);\n/**\n * Use the boolean value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean(\"user.isPremium\")\n * ```\n */\nexport const useMMKVBoolean = createMMKVHook((instance, key) =>\n  instance.getBoolean(key)\n);\n/**\n * Use an object value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * The object will be serialized using `JSON`.\n *\n * @example\n * ```ts\n * const [user, setUser] = useMMKVObject<User>(\"user\")\n * ```\n */\nexport function useMMKVObject<T>(\n  key: string,\n  instance?: MMKV\n): [value: T | undefined, setValue: (value: T) => void] {\n  const [string, setString] = useMMKVString(key, instance);\n\n  const value = useMemo(() => {\n    if (string == null) return undefined;\n    return JSON.parse(string) as T;\n  }, [string]);\n  const setValue = useCallback(\n    (v: T) => {\n      setString(JSON.stringify(v));\n    },\n    [setString]\n  );\n\n  return [value, setValue];\n}\n"]}
+{"version":3,"sources":["hooks.ts"],"names":["isConfigurationEqual","left","right","encryptionKey","id","path","defaultInstance","getDefaultInstance","MMKV","useMMKV","configuration","instance","lastConfiguration","current","createMMKVHook","getter","key","mmkv","value","setValue","valueRef","set","v","newValue","delete","Error","listener","addOnValueChangedListener","changedKey","remove","useMMKVString","getString","useMMKVNumber","getNumber","useMMKVBoolean","getBoolean","useMMKVObject","string","setString","undefined","JSON","parse","stringify","useMMKVListener","valueChangedListener","ref"],"mappings":";;;;;;;;;;;;AAAA;;AAOA;;AAEA,SAASA,oBAAT,CACEC,IADF,EAEEC,KAFF,EAGW;AACT,SACED,IAAI,CAACE,aAAL,KAAuBD,KAAK,CAACC,aAA7B,IACAF,IAAI,CAACG,EAAL,KAAYF,KAAK,CAACE,EADlB,IAEAH,IAAI,CAACI,IAAL,KAAcH,KAAK,CAACG,IAHtB;AAKD;;AAED,IAAIC,eAA4B,GAAG,IAAnC;;AACA,SAASC,kBAAT,GAAoC;AAClC,MAAID,eAAe,IAAI,IAAvB,EAA6B;AAC3BA,IAAAA,eAAe,GAAG,IAAIE,UAAJ,EAAlB;AACD;;AACD,SAAOF,eAAP;AACD;;AAEM,SAASG,OAAT,CACLC,aADK,EAEkB;AACvB,QAAMC,QAAQ,GAAG,oBAAjB;AAEA,QAAMC,iBAAiB,GAAG,oBAA1B;;AACA,MACEA,iBAAiB,CAACC,OAAlB,IAA6B,IAA7B,IACA,CAACb,oBAAoB,CAACY,iBAAiB,CAACC,OAAnB,EAA4BH,aAA5B,CAFvB,EAGE;AACAE,IAAAA,iBAAiB,CAACC,OAAlB,GAA4BH,aAA5B;AACAC,IAAAA,QAAQ,CAACE,OAAT,GAAmB,IAAIL,UAAJ,CAASE,aAAT,CAAnB;AACD,GAVsB,CAYvB;;;AACA,SAAOC,QAAP;AACD;;AAED,SAASG,cAAT,CAIEC,MAJF,EAI8C;AAC5C,SAAO,CACLC,GADK,EAELL,QAFK,KAGiD;AACtD,UAAMM,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeJ,kBAAkB,EAA3C;AACA,UAAM,CAACW,KAAD,EAAQC,QAAR,IAAoB,qBAAS,MAAMJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAArB,CAA1B;AACA,UAAMI,QAAQ,GAAG,mBAAUF,KAAV,CAAjB;AACAE,IAAAA,QAAQ,CAACP,OAAT,GAAmBK,KAAnB;AAEA,UAAMG,GAAG,GAAG,wBACTC,CAAD,IAAmB;AACjB,YAAMC,QAAQ,GAAG,OAAOD,CAAP,KAAa,UAAb,GAA0BA,CAAC,CAACF,QAAQ,CAACP,OAAV,CAA3B,GAAgDS,CAAjE;;AACA,cAAQ,OAAOC,QAAf;AACE,aAAK,QAAL;AACA,aAAK,QAAL;AACA,aAAK,SAAL;AACEN,UAAAA,IAAI,CAACI,GAAL,CAASL,GAAT,EAAcO,QAAd;AACA;;AACF,aAAK,WAAL;AACEN,UAAAA,IAAI,CAACO,MAAL,CAAYR,GAAZ;AACA;;AACF;AACE,gBAAM,IAAIS,KAAJ,CAAW,cAAa,OAAOF,QAAS,oBAAxC,CAAN;AAVJ;AAYD,KAfS,EAgBV,CAACP,GAAD,EAAMC,IAAN,CAhBU,CAAZ;AAmBA,0BAAU,MAAM;AACd,YAAMS,QAAQ,GAAGT,IAAI,CAACU,yBAAL,CAAgCC,UAAD,IAAgB;AAC9D,YAAIA,UAAU,KAAKZ,GAAnB,EAAwB;AACtBG,UAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACD;AACF,OAJgB,CAAjB;AAKA,aAAO,MAAMU,QAAQ,CAACG,MAAT,EAAb;AACD,KAPD,EAOG,CAACb,GAAD,EAAMC,IAAN,CAPH;AASA,WAAO,CAACC,KAAD,EAAQG,GAAR,CAAP;AACD,GAtCD;AAuCD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMS,aAAa,GAAGhB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACoB,SAAT,CAAmBf,GAAnB,CADyC,CAApC;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMgB,aAAa,GAAGlB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACsB,SAAT,CAAmBjB,GAAnB,CADyC,CAApC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMkB,cAAc,GAAGpB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC3CL,QAAQ,CAACwB,UAAT,CAAoBnB,GAApB,CAD0C,CAArC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;AACO,SAASoB,aAAT,CACLpB,GADK,EAELL,QAFK,EAG6D;AAClE,QAAM,CAAC0B,MAAD,EAASC,SAAT,IAAsBR,aAAa,CAACd,GAAD,EAAML,QAAN,CAAzC;AAEA,QAAMO,KAAK,GAAG,oBAAQ,MAAM;AAC1B,QAAImB,MAAM,IAAI,IAAd,EAAoB,OAAOE,SAAP;AACpB,WAAOC,IAAI,CAACC,KAAL,CAAWJ,MAAX,CAAP;AACD,GAHa,EAGX,CAACA,MAAD,CAHW,CAAd;AAIA,QAAMlB,QAAQ,GAAG,wBACdG,CAAD,IAAsB;AACpB,QAAIA,CAAC,IAAI,IAAT,EAAe;AACb;AACAgB,MAAAA,SAAS,CAACC,SAAD,CAAT;AACD,KAHD,MAGO;AACL;AACAD,MAAAA,SAAS,CAACE,IAAI,CAACE,SAAL,CAAepB,CAAf,CAAD,CAAT;AACD;AACF,GATc,EAUf,CAACgB,SAAD,CAVe,CAAjB;AAaA,SAAO,CAACpB,KAAD,EAAQC,QAAR,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASwB,eAAT,CACLC,oBADK,EAELjC,QAFK,EAGC;AACN,QAAMkC,GAAG,GAAG,mBAAOD,oBAAP,CAAZ;AACAC,EAAAA,GAAG,CAAChC,OAAJ,GAAc+B,oBAAd;AAEA,QAAM3B,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeJ,kBAAkB,EAA3C;AAEA,wBAAU,MAAM;AACd,UAAMmB,QAAQ,GAAGT,IAAI,CAACU,yBAAL,CAAgCC,UAAD,IAAgB;AAC9DiB,MAAAA,GAAG,CAAChC,OAAJ,CAAYe,UAAZ;AACD,KAFgB,CAAjB;AAGA,WAAO,MAAMF,QAAQ,CAACG,MAAT,EAAb;AACD,GALD,EAKG,CAACZ,IAAD,CALH;AAMD","sourcesContent":["import React, {\n  useRef,\n  useState,\n  useMemo,\n  useCallback,\n  useEffect,\n} from 'react';\nimport { MMKV, MMKVConfiguration } from './MMKV';\n\nfunction isConfigurationEqual(\n  left: MMKVConfiguration,\n  right: MMKVConfiguration\n): boolean {\n  return (\n    left.encryptionKey === right.encryptionKey &&\n    left.id === right.id &&\n    left.path === right.path\n  );\n}\n\nlet defaultInstance: MMKV | null = null;\nfunction getDefaultInstance(): MMKV {\n  if (defaultInstance == null) {\n    defaultInstance = new MMKV();\n  }\n  return defaultInstance;\n}\n\nexport function useMMKV(\n  configuration: MMKVConfiguration\n): React.RefObject<MMKV> {\n  const instance = useRef<MMKV>();\n\n  const lastConfiguration = useRef<MMKVConfiguration>();\n  if (\n    lastConfiguration.current == null ||\n    !isConfigurationEqual(lastConfiguration.current, configuration)\n  ) {\n    lastConfiguration.current = configuration;\n    instance.current = new MMKV(configuration);\n  }\n\n  // @ts-expect-error it's not null, I promise.\n  return instance;\n}\n\nfunction createMMKVHook<\n  T extends boolean | number | (string | undefined),\n  TSet extends T | undefined,\n  TSetAction extends TSet | ((current: T) => TSet)\n>(getter: (instance: MMKV, key: string) => T) {\n  return (\n    key: string,\n    instance?: MMKV\n  ): [value: T, setValue: (value: TSetAction) => void] => {\n    const mmkv = instance ?? getDefaultInstance();\n    const [value, setValue] = useState(() => getter(mmkv, key));\n    const valueRef = useRef<T>(value);\n    valueRef.current = value;\n\n    const set = useCallback(\n      (v: TSetAction) => {\n        const newValue = typeof v === 'function' ? v(valueRef.current) : v;\n        switch (typeof newValue) {\n          case 'number':\n          case 'string':\n          case 'boolean':\n            mmkv.set(key, newValue);\n            break;\n          case 'undefined':\n            mmkv.delete(key);\n            break;\n          default:\n            throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);\n        }\n      },\n      [key, mmkv]\n    );\n\n    useEffect(() => {\n      const listener = mmkv.addOnValueChangedListener((changedKey) => {\n        if (changedKey === key) {\n          setValue(getter(mmkv, key));\n        }\n      });\n      return () => listener.remove();\n    }, [key, mmkv]);\n\n    return [value, set];\n  };\n}\n\n/**\n * Use the string value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [username, setUsername] = useMMKVString(\"user.name\")\n * ```\n */\nexport const useMMKVString = createMMKVHook((instance, key) =>\n  instance.getString(key)\n);\n\n/**\n * Use the number value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [age, setAge] = useMMKVNumber(\"user.age\")\n * ```\n */\nexport const useMMKVNumber = createMMKVHook((instance, key) =>\n  instance.getNumber(key)\n);\n/**\n * Use the boolean value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean(\"user.isPremium\")\n * ```\n */\nexport const useMMKVBoolean = createMMKVHook((instance, key) =>\n  instance.getBoolean(key)\n);\n/**\n * Use an object value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * The object will be serialized using `JSON`.\n *\n * @example\n * ```ts\n * const [user, setUser] = useMMKVObject<User>(\"user\")\n * ```\n */\nexport function useMMKVObject<T>(\n  key: string,\n  instance?: MMKV\n): [value: T | undefined, setValue: (value: T | undefined) => void] {\n  const [string, setString] = useMMKVString(key, instance);\n\n  const value = useMemo(() => {\n    if (string == null) return undefined;\n    return JSON.parse(string) as T;\n  }, [string]);\n  const setValue = useCallback(\n    (v: T | undefined) => {\n      if (v == null) {\n        // Clear the Value\n        setString(undefined);\n      } else {\n        // Store the Object as a serialized Value\n        setString(JSON.stringify(v));\n      }\n    },\n    [setString]\n  );\n\n  return [value, setValue];\n}\n\n/**\n * Listen for changes in the given MMKV storage instance.\n * If no instance is passed, the default instance will be used.\n * @param valueChangedListener The function to call whenever a value inside the storage instance changes\n * @param instance The instance to listen to changes to (or the default instance)\n *\n * @example\n * ```ts\n * useMMKVListener((key) => {\n *   console.log(`Value for \"${key}\" changed!`)\n * })\n * ```\n */\nexport function useMMKVListener(\n  valueChangedListener: (key: string) => void,\n  instance?: MMKV\n): void {\n  const ref = useRef(valueChangedListener);\n  ref.current = valueChangedListener;\n\n  const mmkv = instance ?? getDefaultInstance();\n\n  useEffect(() => {\n    const listener = mmkv.addOnValueChangedListener((changedKey) => {\n      ref.current(changedKey);\n    });\n    return () => listener.remove();\n  }, [mmkv]);\n}\n"]}

package/lib/module/MMKV.js

@@ -10,7 +10,7 @@ const onValueChangedListeners = new Map();
 export class MMKV {
   /**
    * Creates a new MMKV instance with the given Configuration.
-   * If no custom `id` is supplied, `'default'` will be used.
+   * If no custom `id` is supplied, `'mmkv.default'` will be used.
    */
   constructor(configuration = {
     id: 'mmkv.default'
@@ -99,6 +99,21 @@ export class MMKV {
     return func();
   }
 
+  recrypt(key) {
+    const func = this.getFunctionFromCache('recrypt');
+    return func(key);
+  }
+
+  toString() {
+    return `MMKV (${this.id}): [${this.getAllKeys().join(', ')}]`;
+  }
+
+  toJSON() {
+    return {
+      [this.id]: this.getAllKeys()
+    };
+  }
+
   addOnValueChangedListener(onValueChanged) {
     this.onValueChangedListeners.push(onValueChanged);
     return {