react-native-mmkv 1.3.3 → 1.5.2

package/README.md

@@ -127,6 +127,9 @@ const isMmkvFastAsf = storage.getBoolean('is-mmkv-fast-asf') // true
 ### Keys
 
 ```js
+// checking if a specific key exists
+const hasUsername = storage.contains('user.name')
+
 // getting all keys
 const keys = storage.getAllKeys() // ['user.name', 'user.age', 'is-mmkv-fast-asf']
 
@@ -145,65 +148,26 @@ const user = {
   age: 21
 }
 
+// Serialize the object into a JSON string
 storage.set('user', JSON.stringify(user))
 
+// Deserialize the JSON string into an object
 const jsonUser = storage.getString('user') // { 'username': 'Marc', 'age': 21 }
 const userObject = JSON.parse(jsonUser)
 ```
 
-## Migrate from AsyncStorage
+## Documentation
 
-See [#52](https://github.com/mrousavy/react-native-mmkv/issues/52) for instructions on how to safely migrate your existing AsyncStorage database to MMKV.
+* [Hooks](./docs/HOOKS.md)
+* [Value-change Listeners](./docs/LISTENERS.md)
+* [Migrate from AsyncStorage](./docs/MIGRATE_FROM_ASYNC_STORAGE.md)
+* [Using MMKV with redux-persis](./docs/WRAPPER_REDUX.md)
+* [Using MMKV with mobx-persist-storage](./docs/WRAPPER_MOBX.md)
 
 ## Limitations
 
 As the library uses JSI for synchronous native methods access, remote debugging (e.g. with Chrome) is no longer possible. Instead, you should use [Flipper](https://fbflipper.com).
 
-## redux-persist
-
-If you want to use MMKV with [redux-persist](https://github.com/rt2zz/redux-persist), create the following `storage` object:
-
-```ts
-import { Storage } from 'redux-persist'
-
-const storage = new MMKV()
-
-export const reduxStorage: Storage = {
-  setItem: (key, value) => {
-    storage.set(key, value)
-    return Promise.resolve(true)
-  },
-  getItem: (key) => {
-    const value = storage.getString(key)
-    return Promise.resolve(value)
-  },
-  removeItem: (key) => {
-    storage.delete(key)
-    return Promise.resolve()
-  },
-}
-```
-
-## mobx-persist-store
-
-If you want to use MMKV with [mobx-persist-store](https://github.com/quarrant/mobx-persist-store), create the following `storage` object:
-
-```ts
-import { configurePersistable } from 'mobx-persist-store'
-
-const storage = new MMKV()
-
-configurePersistable({
-  storage: {
-    setItem: (key, data) => storage.set(key, data),
-    getItem: (key) => storage.getString(key),
-    removeItem: (key) => storage.delete(key),
-  },
-})
-```
-
-For more information, check out [kanzitelli/rnn-starter](https://github.com/kanzitelli/rnn-starter).
-
 ## Adopting at scale
 
 react-native-mmkv is provided _as is_, I work on it in my free time.

package/android/build.gradle

@@ -59,7 +59,7 @@ android {
   }
 
   packagingOptions {
-    excludes = ["**/libc++_shared.so", "**/libfbjni.so", "**/libjsi.so"]
+    excludes = ["**/libc++_shared.so", "**/libfbjni.so", "**/libreactnativejni.so", "**/libjsi.so", "**/MANIFEST.MF"]
   }
 
   buildTypes {

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

@@ -27,6 +27,7 @@ std::vector<jsi::PropNameID> MmkvHostObject::getPropertyNames(jsi::Runtime& rt)
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getBoolean")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getString")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getNumber")));
+  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("contains")));
   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")));
@@ -118,6 +119,23 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
                                                  });
   }
 
+  if (propName == "contains") {
+    // MMKV.contains(key: string)
+    return jsi::Function::createFromHostFunction(runtime,
+                                                 jsi::PropNameID::forAscii(runtime, funcName),
+                                                 1,  // key
+                                                 [this](jsi::Runtime& runtime,
+                                                        const jsi::Value& thisValue,
+                                                        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 = arguments[0].getString(runtime).utf8(runtime);
+
+                                                   bool containsKey = instance->containsKey(keyName);
+                                                   return jsi::Value(containsKey);
+                                                 });
+  }
+
   if (propName == "delete") {
     // MMKV.delete(key: string)
     return jsi::Function::createFromHostFunction(runtime,

package/ios/MmkvHostObject.mm

@@ -24,6 +24,7 @@ std::vector<jsi::PropNameID> MmkvHostObject::getPropertyNames(jsi::Runtime& rt)
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getBoolean")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getString")));
   result.push_back(jsi::PropNameID::forUtf8(rt, std::string("getNumber")));
+  result.push_back(jsi::PropNameID::forUtf8(rt, std::string("contains")));
   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")));
@@ -113,7 +114,24 @@ 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,
+                                                 jsi::PropNameID::forAscii(runtime, funcName),
+                                                 1,  // key
+                                                 [this](jsi::Runtime& runtime,
+                                                        const jsi::Value& thisValue,
+                                                        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,
@@ -124,7 +142,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();

package/lib/commonjs/MMKV.js

@@ -5,20 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.MMKV = void 0;
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+var _reactNative = require("react-native");
 
-/**
- * Used for configuration of a single MMKV instance.
- */
-
-/**
- * Represents a single MMKV instance.
- */
-// global func declaration for JSI functions
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+const onValueChangedListeners = new Map();
 /**
  * A single MMKV instance.
  */
+
 class MMKV {
   /**
    * Creates a new MMKV instance with the given Configuration.
@@ -31,14 +26,25 @@ class MMKV {
 
     _defineProperty(this, "functionCache", void 0);
 
+    _defineProperty(this, "id", void 0);
+
     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!');
     }
 
+    this.id = configuration.id;
     this.nativeInstance = global.mmkvCreateNewInstance(configuration);
     this.functionCache = {};
   }
 
+  get onValueChangedListeners() {
+    if (!onValueChangedListeners.has(this.id)) {
+      onValueChangedListeners.set(this.id, []);
+    }
+
+    return onValueChangedListeners.get(this.id);
+  }
+
   getFunctionFromCache(functionName) {
     if (this.functionCache[functionName] == null) {
       this.functionCache[functionName] = this.nativeInstance[functionName];
@@ -47,7 +53,21 @@ class MMKV {
     return this.functionCache[functionName];
   }
 
+  onValuesAboutToChange(keys) {
+    if (this.onValueChangedListeners.length === 0) return;
+    setImmediate(() => {
+      (0, _reactNative.unstable_batchedUpdates)(() => {
+        for (const key of keys) {
+          for (const listener of this.onValueChangedListeners) {
+            listener(key);
+          }
+        }
+      });
+    });
+  }
+
   set(key, value) {
+    this.onValuesAboutToChange([key]);
     const func = this.getFunctionFromCache('set');
     return func(key, value);
   }
@@ -67,7 +87,13 @@ class MMKV {
     return func(key);
   }
 
+  contains(key) {
+    const func = this.getFunctionFromCache('contains');
+    return func(key);
+  }
+
   delete(key) {
+    this.onValuesAboutToChange([key]);
     const func = this.getFunctionFromCache('delete');
     return func(key);
   }
@@ -78,10 +104,25 @@ class MMKV {
   }
 
   clearAll() {
+    const keys = this.getAllKeys();
+    this.onValuesAboutToChange(keys);
     const func = this.getFunctionFromCache('clearAll');
     return func();
   }
 
+  addOnValueChangedListener(onValueChanged) {
+    this.onValueChangedListeners.push(onValueChanged);
+    return {
+      remove: () => {
+        const index = this.onValueChangedListeners.indexOf(onValueChanged);
+
+        if (index !== -1) {
+          this.onValueChangedListeners.splice(index, 1);
+        }
+      }
+    };
+  }
+
 }
 
 exports.MMKV = MMKV;

package/lib/commonjs/MMKV.js.map

@@ -1 +1 @@
-{"version":3,"sources":["MMKV.ts"],"names":["MMKV","constructor","configuration","id","global","mmkvCreateNewInstance","Error","nativeInstance","functionCache","getFunctionFromCache","functionName","set","key","value","func","getBoolean","getString","getNumber","delete","getAllKeys","clearAll"],"mappings":";;;;;;;;;AAAA;AACA;AACA;;AAkCA;AACA;AACA;AAwCA;;AAOA;AACA;AACA;AACO,MAAMA,IAAN,CAAoC;AAIzC;AACF;AACA;AACA;AACEC,EAAAA,WAAW,CAACC,aAAgC,GAAG;AAAEC,IAAAA,EAAE,EAAE;AAAN,GAApC,EAA4D;AAAA;;AAAA;;AACrE,QAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC,YAAM,IAAIC,KAAJ,CACJ,0MADI,CAAN;AAGD;;AACD,SAAKC,cAAL,GAAsBH,MAAM,CAACC,qBAAP,CAA6BH,aAA7B,CAAtB;AACA,SAAKM,aAAL,GAAqB,EAArB;AACD;;AAEOC,EAAAA,oBAAoB,CAC1BC,YAD0B,EAER;AAClB,QAAI,KAAKF,aAAL,CAAmBE,YAAnB,KAAoC,IAAxC,EAA8C;AAC5C,WAAKF,aAAL,CAAmBE,YAAnB,IAAmC,KAAKH,cAAL,CAAoBG,YAApB,CAAnC;AACD;;AACD,WAAO,KAAKF,aAAL,CAAmBE,YAAnB,CAAP;AACD;;AAEDC,EAAAA,GAAG,CAACC,GAAD,EAAcC,KAAd,EAAsD;AACvD,UAAMC,IAAI,GAAG,KAAKL,oBAAL,CAA0B,KAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,EAAMC,KAAN,CAAX;AACD;;AACDE,EAAAA,UAAU,CAACH,GAAD,EAAuB;AAC/B,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDI,EAAAA,SAAS,CAACJ,GAAD,EAAkC;AACzC,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDK,EAAAA,SAAS,CAACL,GAAD,EAAsB;AAC7B,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDM,EAAAA,MAAM,CAACN,GAAD,EAAoB;AACxB,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,QAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDO,EAAAA,UAAU,GAAa;AACrB,UAAML,IAAI,GAAG,KAAKL,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOK,IAAI,EAAX;AACD;;AACDM,EAAAA,QAAQ,GAAS;AACf,UAAMN,IAAI,GAAG,KAAKL,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOK,IAAI,EAAX;AACD;;AAtDwC","sourcesContent":["/**\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 */\nexport interface 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   * 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\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(\n    configuration: MMKVConfiguration\n  ): MMKVInterface;\n}\n\n/**\n * A single MMKV instance.\n */\nexport class MMKV implements MMKVInterface {\n  private nativeInstance: MMKVInterface;\n  private functionCache: Partial<MMKVInterface>;\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    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    this.nativeInstance = global.mmkvCreateNewInstance(configuration);\n    this.functionCache = {};\n  }\n\n  private getFunctionFromCache<T extends keyof MMKVInterface>(\n    functionName: T\n  ): MMKVInterface[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as MMKVInterface[T];\n  }\n\n  set(key: string, value: boolean | string | number): void {\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  delete(key: string): void {\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 func = this.getFunctionFromCache('clearAll');\n    return func();\n  }\n}\n"]}
+{"version":3,"sources":["MMKV.ts"],"names":["onValueChangedListeners","Map","MMKV","constructor","configuration","id","global","mmkvCreateNewInstance","Error","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;;;;AAqGA,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,QAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC,YAAM,IAAIC,KAAJ,CACJ,0MADI,CAAN;AAGD;;AACD,SAAKH,EAAL,GAAUD,aAAa,CAACC,EAAxB;AACA,SAAKI,cAAL,GAAsBH,MAAM,CAACC,qBAAP,CAA6BH,aAA7B,CAAtB;AACA,SAAKM,aAAL,GAAqB,EAArB;AACD;;AAEkC,MAAvBV,uBAAuB,GAAG;AACpC,QAAI,CAACA,uBAAuB,CAACW,GAAxB,CAA4B,KAAKN,EAAjC,CAAL,EAA2C;AACzCL,MAAAA,uBAAuB,CAACY,GAAxB,CAA4B,KAAKP,EAAjC,EAAqC,EAArC;AACD;;AACD,WAAOL,uBAAuB,CAACa,GAAxB,CAA4B,KAAKR,EAAjC,CAAP;AACD;;AAEOS,EAAAA,oBAAoB,CAC1BC,YAD0B,EAER;AAClB,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,KAAKjB,uBAAL,CAA6BkB,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,KAAKrB,uBAA5B,EAAqD;AACnDqB,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,SAAKhC,uBAAL,CAA6BiC,IAA7B,CAAkCD,cAAlC;AAEA,WAAO;AACLE,MAAAA,MAAM,EAAE,MAAM;AACZ,cAAMC,KAAK,GAAG,KAAKnC,uBAAL,CAA6BoC,OAA7B,CAAqCJ,cAArC,CAAd;;AACA,YAAIG,KAAK,KAAK,CAAC,CAAf,EAAkB;AAChB,eAAKnC,uBAAL,CAA6BqC,MAA7B,CAAoCF,KAApC,EAA2C,CAA3C;AACD;AACF;AANI,KAAP;AAQD;;AArGwC","sourcesContent":["import { unstable_batchedUpdates } from 'react-native';\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 */\nexport interface 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\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(\n    configuration: MMKVConfiguration\n  ): MMKVInterface;\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: MMKVInterface;\n  private functionCache: Partial<MMKVInterface>;\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    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    this.id = configuration.id;\n    this.nativeInstance = global.mmkvCreateNewInstance(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 MMKVInterface>(\n    functionName: T\n  ): MMKVInterface[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as MMKVInterface[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"]}

package/lib/commonjs/hooks.js

@@ -0,0 +1,139 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useMMKV = useMMKV;
+exports.useMMKVNumber = exports.useMMKVBoolean = void 0;
+exports.useMMKVObject = useMMKVObject;
+exports.useMMKVString = void 0;
+
+var _react = require("react");
+
+var _MMKV = require("./MMKV");
+
+function isConfigurationEqual(left, right) {
+  return left.encryptionKey === right.encryptionKey && left.id === right.id && left.path === right.path;
+}
+
+let defaultInstance = null;
+
+function getDefaultInstance() {
+  if (defaultInstance == null) {
+    defaultInstance = new _MMKV.MMKV();
+  }
+
+  return defaultInstance;
+}
+
+function useMMKV(configuration) {
+  const instance = (0, _react.useRef)();
+  const lastConfiguration = (0, _react.useRef)(configuration);
+
+  if (!isConfigurationEqual(lastConfiguration.current, configuration)) {
+    instance.current = new _MMKV.MMKV(configuration);
+  } // @ts-expect-error it's not null, I promise.
+
+
+  return instance;
+}
+
+function createMMKVHook(getter) {
+  return (key, instance) => {
+    const mmkv = instance !== null && instance !== void 0 ? instance : getDefaultInstance();
+    const [value, setValue] = (0, _react.useState)(() => getter(mmkv, key));
+    const set = (0, _react.useCallback)(v => {
+      const newValue = typeof v === 'function' ? v(value) : v;
+
+      switch (typeof newValue) {
+        case 'number':
+        case 'string':
+        case 'boolean':
+          mmkv.set(key, newValue);
+          break;
+
+        case 'undefined':
+          mmkv.delete(key);
+          break;
+
+        default:
+          throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);
+      }
+    }, [key, mmkv, value]);
+    (0, _react.useEffect)(() => {
+      const listener = mmkv.addOnValueChangedListener(changedKey => {
+        if (changedKey === key) {
+          setValue(getter(mmkv, key));
+        }
+      });
+      return () => listener.remove();
+    }, [key, mmkv]);
+    return (0, _react.useMemo)(() => [value, set], [value, set]);
+  };
+}
+/**
+ * Use the string value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [username, setUsername] = useMMKVString("user.name")
+ * ```
+ */
+
+
+const useMMKVString = createMMKVHook((instance, key) => instance.getString(key));
+/**
+ * Use the number value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [age, setAge] = useMMKVNumber("user.age")
+ * ```
+ */
+
+exports.useMMKVString = useMMKVString;
+const useMMKVNumber = createMMKVHook((instance, key) => instance.getNumber(key));
+/**
+ * Use the boolean value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean("user.isPremium")
+ * ```
+ */
+
+exports.useMMKVNumber = useMMKVNumber;
+const useMMKVBoolean = createMMKVHook((instance, key) => instance.getBoolean(key));
+/**
+ * Use an object value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * The object will be serialized using `JSON`.
+ *
+ * @example
+ * ```ts
+ * const [user, setUser] = useMMKVObject<User>("user")
+ * ```
+ */
+
+exports.useMMKVBoolean = useMMKVBoolean;
+
+function useMMKVObject(key, instance) {
+  const [string, setString] = useMMKVString(key, instance);
+  const value = (0, _react.useMemo)(() => {
+    if (string == null) return undefined;
+    return JSON.parse(string);
+  }, [string]);
+  const setValue = (0, _react.useCallback)(v => {
+    setString(JSON.stringify(v));
+  }, [setString]);
+  return [value, setValue];
+}
+//# sourceMappingURL=hooks.js.map

package/lib/commonjs/hooks.js.map

@@ -0,0 +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","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,eAAqC,GAAG,IAA5C;;AACA,SAASC,kBAAT,GAA6C;AAC3C,MAAID,eAAe,IAAI,IAAvB,EAA6B;AAC3BA,IAAAA,eAAe,GAAG,IAAIE,UAAJ,EAAlB;AACD;;AACD,SAAOF,eAAP;AACD;;AAEM,SAASG,OAAT,CACLC,aADK,EAE2B;AAChC,QAAMC,QAAQ,GAAG,oBAAjB;AAEA,QAAMC,iBAAiB,GAAG,mBAA0BF,aAA1B,CAA1B;;AACA,MAAI,CAACV,oBAAoB,CAACY,iBAAiB,CAACC,OAAnB,EAA4BH,aAA5B,CAAzB,EAAqE;AACnEC,IAAAA,QAAQ,CAACE,OAAT,GAAmB,IAAIL,UAAJ,CAASE,aAAT,CAAnB;AACD,GAN+B,CAQhC;;;AACA,SAAOC,QAAP;AACD;;AAED,SAASG,cAAT,CAIEC,MAJF,EAIuD;AACrD,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;AAEA,UAAMI,GAAG,GAAG,wBACTC,CAAD,IAAmB;AACjB,YAAMC,QAAQ,GAAG,OAAOD,CAAP,KAAa,UAAb,GAA0BA,CAAC,CAACH,KAAD,CAA3B,GAAqCG,CAAtD;;AACA,cAAQ,OAAOC,QAAf;AACE,aAAK,QAAL;AACA,aAAK,QAAL;AACA,aAAK,SAAL;AACEL,UAAAA,IAAI,CAACG,GAAL,CAASJ,GAAT,EAAcM,QAAd;AACA;;AACF,aAAK,WAAL;AACEL,UAAAA,IAAI,CAACM,MAAL,CAAYP,GAAZ;AACA;;AACF;AACE,gBAAM,IAAIQ,KAAJ,CAAW,cAAa,OAAOF,QAAS,oBAAxC,CAAN;AAVJ;AAYD,KAfS,EAgBV,CAACN,GAAD,EAAMC,IAAN,EAAYC,KAAZ,CAhBU,CAAZ;AAmBA,0BAAU,MAAM;AACd,YAAMO,QAAQ,GAAGR,IAAI,CAACS,yBAAL,CAAgCC,UAAD,IAAgB;AAC9D,YAAIA,UAAU,KAAKX,GAAnB,EAAwB;AACtBG,UAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACD;AACF,OAJgB,CAAjB;AAKA,aAAO,MAAMS,QAAQ,CAACG,MAAT,EAAb;AACD,KAPD,EAOG,CAACZ,GAAD,EAAMC,IAAN,CAPH;AASA,WAAO,oBAAQ,MAAM,CAACC,KAAD,EAAQE,GAAR,CAAd,EAA4B,CAACF,KAAD,EAAQE,GAAR,CAA5B,CAAP;AACD,GApCD;AAqCD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMS,aAAa,GAAGf,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACmB,SAAT,CAAmBd,GAAnB,CADyC,CAApC;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMe,aAAa,GAAGjB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACqB,SAAT,CAAmBhB,GAAnB,CADyC,CAApC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMiB,cAAc,GAAGnB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC3CL,QAAQ,CAACuB,UAAT,CAAoBlB,GAApB,CAD0C,CAArC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;AACO,SAASmB,aAAT,CACLnB,GADK,EAELL,QAFK,EAGiD;AACtD,QAAM,CAACyB,MAAD,EAASC,SAAT,IAAsBR,aAAa,CAACb,GAAD,EAAML,QAAN,CAAzC;AAEA,QAAMO,KAAK,GAAG,oBAAQ,MAAM;AAC1B,QAAIkB,MAAM,IAAI,IAAd,EAAoB,OAAOE,SAAP;AACpB,WAAOC,IAAI,CAACC,KAAL,CAAWJ,MAAX,CAAP;AACD,GAHa,EAGX,CAACA,MAAD,CAHW,CAAd;AAIA,QAAMjB,QAAQ,GAAG,wBACdE,CAAD,IAAU;AACRgB,IAAAA,SAAS,CAACE,IAAI,CAACE,SAAL,CAAepB,CAAf,CAAD,CAAT;AACD,GAHc,EAIf,CAACgB,SAAD,CAJe,CAAjB;AAOA,SAAO,CAACnB,KAAD,EAAQC,QAAR,CAAP;AACD","sourcesContent":["import React, {\n  useRef,\n  useState,\n  useMemo,\n  useCallback,\n  useEffect,\n} from 'react';\nimport { MMKV, MMKVConfiguration, MMKVInterface } 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: MMKVInterface | null = null;\nfunction getDefaultInstance(): MMKVInterface {\n  if (defaultInstance == null) {\n    defaultInstance = new MMKV();\n  }\n  return defaultInstance;\n}\n\nexport function useMMKV(\n  configuration: MMKVConfiguration\n): React.RefObject<MMKVInterface> {\n  const instance = useRef<MMKVInterface>();\n\n  const lastConfiguration = useRef<MMKVConfiguration>(configuration);\n  if (!isConfigurationEqual(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: MMKVInterface, key: string) => T) {\n  return (\n    key: string,\n    instance?: MMKVInterface\n  ): [value: T, setValue: (value: TSetAction) => void] => {\n    const mmkv = instance ?? getDefaultInstance();\n    const [value, setValue] = useState(() => getter(mmkv, key));\n\n    const set = useCallback(\n      (v: TSetAction) => {\n        const newValue = typeof v === 'function' ? v(value) : 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, value]\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?: MMKVInterface\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"]}

package/lib/commonjs/index.js

@@ -16,4 +16,17 @@ Object.keys(_MMKV).forEach(function (key) {
     }
   });
 });
+
+var _hooks = require("./hooks");
+
+Object.keys(_hooks).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _hooks[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _hooks[key];
+    }
+  });
+});
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["index.ts"],"names":[],"mappings":";;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["export * from './MMKV';\n"]}
+{"version":3,"sources":["index.ts"],"names":[],"mappings":";;;;;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AACA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["export * from './MMKV';\nexport * from './hooks';\n"]}

package/lib/module/MMKV.js

@@ -1,17 +1,11 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-/**
- * Used for configuration of a single MMKV instance.
- */
-
-/**
- * Represents a single MMKV instance.
- */
-// global func declaration for JSI functions
-
+import { unstable_batchedUpdates } from 'react-native';
+const onValueChangedListeners = new Map();
 /**
  * A single MMKV instance.
  */
+
 export class MMKV {
   /**
    * Creates a new MMKV instance with the given Configuration.
@@ -24,14 +18,25 @@ export class MMKV {
 
     _defineProperty(this, "functionCache", void 0);
 
+    _defineProperty(this, "id", void 0);
+
     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!');
     }
 
+    this.id = configuration.id;
     this.nativeInstance = global.mmkvCreateNewInstance(configuration);
     this.functionCache = {};
   }
 
+  get onValueChangedListeners() {
+    if (!onValueChangedListeners.has(this.id)) {
+      onValueChangedListeners.set(this.id, []);
+    }
+
+    return onValueChangedListeners.get(this.id);
+  }
+
   getFunctionFromCache(functionName) {
     if (this.functionCache[functionName] == null) {
       this.functionCache[functionName] = this.nativeInstance[functionName];
@@ -40,7 +45,21 @@ export class MMKV {
     return this.functionCache[functionName];
   }
 
+  onValuesAboutToChange(keys) {
+    if (this.onValueChangedListeners.length === 0) return;
+    setImmediate(() => {
+      unstable_batchedUpdates(() => {
+        for (const key of keys) {
+          for (const listener of this.onValueChangedListeners) {
+            listener(key);
+          }
+        }
+      });
+    });
+  }
+
   set(key, value) {
+    this.onValuesAboutToChange([key]);
     const func = this.getFunctionFromCache('set');
     return func(key, value);
   }
@@ -60,7 +79,13 @@ export class MMKV {
     return func(key);
   }
 
+  contains(key) {
+    const func = this.getFunctionFromCache('contains');
+    return func(key);
+  }
+
   delete(key) {
+    this.onValuesAboutToChange([key]);
     const func = this.getFunctionFromCache('delete');
     return func(key);
   }
@@ -71,9 +96,24 @@ export class MMKV {
   }
 
   clearAll() {
+    const keys = this.getAllKeys();
+    this.onValuesAboutToChange(keys);
     const func = this.getFunctionFromCache('clearAll');
     return func();
   }
 
+  addOnValueChangedListener(onValueChanged) {
+    this.onValueChangedListeners.push(onValueChanged);
+    return {
+      remove: () => {
+        const index = this.onValueChangedListeners.indexOf(onValueChanged);
+
+        if (index !== -1) {
+          this.onValueChangedListeners.splice(index, 1);
+        }
+      }
+    };
+  }
+
 }
 //# sourceMappingURL=MMKV.js.map

package/lib/module/MMKV.js.map

@@ -1 +1 @@
-{"version":3,"sources":["MMKV.ts"],"names":["MMKV","constructor","configuration","id","global","mmkvCreateNewInstance","Error","nativeInstance","functionCache","getFunctionFromCache","functionName","set","key","value","func","getBoolean","getString","getNumber","delete","getAllKeys","clearAll"],"mappings":";;AAAA;AACA;AACA;;AAkCA;AACA;AACA;AAwCA;;AAOA;AACA;AACA;AACA,OAAO,MAAMA,IAAN,CAAoC;AAIzC;AACF;AACA;AACA;AACEC,EAAAA,WAAW,CAACC,aAAgC,GAAG;AAAEC,IAAAA,EAAE,EAAE;AAAN,GAApC,EAA4D;AAAA;;AAAA;;AACrE,QAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC,YAAM,IAAIC,KAAJ,CACJ,0MADI,CAAN;AAGD;;AACD,SAAKC,cAAL,GAAsBH,MAAM,CAACC,qBAAP,CAA6BH,aAA7B,CAAtB;AACA,SAAKM,aAAL,GAAqB,EAArB;AACD;;AAEOC,EAAAA,oBAAoB,CAC1BC,YAD0B,EAER;AAClB,QAAI,KAAKF,aAAL,CAAmBE,YAAnB,KAAoC,IAAxC,EAA8C;AAC5C,WAAKF,aAAL,CAAmBE,YAAnB,IAAmC,KAAKH,cAAL,CAAoBG,YAApB,CAAnC;AACD;;AACD,WAAO,KAAKF,aAAL,CAAmBE,YAAnB,CAAP;AACD;;AAEDC,EAAAA,GAAG,CAACC,GAAD,EAAcC,KAAd,EAAsD;AACvD,UAAMC,IAAI,GAAG,KAAKL,oBAAL,CAA0B,KAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,EAAMC,KAAN,CAAX;AACD;;AACDE,EAAAA,UAAU,CAACH,GAAD,EAAuB;AAC/B,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDI,EAAAA,SAAS,CAACJ,GAAD,EAAkC;AACzC,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDK,EAAAA,SAAS,CAACL,GAAD,EAAsB;AAC7B,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,WAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDM,EAAAA,MAAM,CAACN,GAAD,EAAoB;AACxB,UAAME,IAAI,GAAG,KAAKL,oBAAL,CAA0B,QAA1B,CAAb;AACA,WAAOK,IAAI,CAACF,GAAD,CAAX;AACD;;AACDO,EAAAA,UAAU,GAAa;AACrB,UAAML,IAAI,GAAG,KAAKL,oBAAL,CAA0B,YAA1B,CAAb;AACA,WAAOK,IAAI,EAAX;AACD;;AACDM,EAAAA,QAAQ,GAAS;AACf,UAAMN,IAAI,GAAG,KAAKL,oBAAL,CAA0B,UAA1B,CAAb;AACA,WAAOK,IAAI,EAAX;AACD;;AAtDwC","sourcesContent":["/**\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 */\nexport interface 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   * 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\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(\n    configuration: MMKVConfiguration\n  ): MMKVInterface;\n}\n\n/**\n * A single MMKV instance.\n */\nexport class MMKV implements MMKVInterface {\n  private nativeInstance: MMKVInterface;\n  private functionCache: Partial<MMKVInterface>;\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    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    this.nativeInstance = global.mmkvCreateNewInstance(configuration);\n    this.functionCache = {};\n  }\n\n  private getFunctionFromCache<T extends keyof MMKVInterface>(\n    functionName: T\n  ): MMKVInterface[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as MMKVInterface[T];\n  }\n\n  set(key: string, value: boolean | string | number): void {\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  delete(key: string): void {\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 func = this.getFunctionFromCache('clearAll');\n    return func();\n  }\n}\n"]}
+{"version":3,"sources":["MMKV.ts"],"names":["unstable_batchedUpdates","onValueChangedListeners","Map","MMKV","constructor","configuration","id","global","mmkvCreateNewInstance","Error","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,SAASA,uBAAT,QAAwC,cAAxC;AAqGA,MAAMC,uBAAuB,GAAG,IAAIC,GAAJ,EAAhC;AAEA;AACA;AACA;;AACA,OAAO,MAAMC,IAAN,CAAoC;AAKzC;AACF;AACA;AACA;AACEC,EAAAA,WAAW,CAACC,aAAgC,GAAG;AAAEC,IAAAA,EAAE,EAAE;AAAN,GAApC,EAA4D;AAAA;;AAAA;;AAAA;;AACrE,QAAIC,MAAM,CAACC,qBAAP,IAAgC,IAApC,EAA0C;AACxC,YAAM,IAAIC,KAAJ,CACJ,0MADI,CAAN;AAGD;;AACD,SAAKH,EAAL,GAAUD,aAAa,CAACC,EAAxB;AACA,SAAKI,cAAL,GAAsBH,MAAM,CAACC,qBAAP,CAA6BH,aAA7B,CAAtB;AACA,SAAKM,aAAL,GAAqB,EAArB;AACD;;AAEkC,MAAvBV,uBAAuB,GAAG;AACpC,QAAI,CAACA,uBAAuB,CAACW,GAAxB,CAA4B,KAAKN,EAAjC,CAAL,EAA2C;AACzCL,MAAAA,uBAAuB,CAACY,GAAxB,CAA4B,KAAKP,EAAjC,EAAqC,EAArC;AACD;;AACD,WAAOL,uBAAuB,CAACa,GAAxB,CAA4B,KAAKR,EAAjC,CAAP;AACD;;AAEOS,EAAAA,oBAAoB,CAC1BC,YAD0B,EAER;AAClB,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,KAAKjB,uBAAL,CAA6BkB,MAA7B,KAAwC,CAA5C,EAA+C;AAE/CC,IAAAA,YAAY,CAAC,MAAM;AACjBpB,MAAAA,uBAAuB,CAAC,MAAM;AAC5B,aAAK,MAAMqB,GAAX,IAAkBH,IAAlB,EAAwB;AACtB,eAAK,MAAMI,QAAX,IAAuB,KAAKrB,uBAA5B,EAAqD;AACnDqB,YAAAA,QAAQ,CAACD,GAAD,CAAR;AACD;AACF;AACF,OANsB,CAAvB;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,SAAKhC,uBAAL,CAA6BiC,IAA7B,CAAkCD,cAAlC;AAEA,WAAO;AACLE,MAAAA,MAAM,EAAE,MAAM;AACZ,cAAMC,KAAK,GAAG,KAAKnC,uBAAL,CAA6BoC,OAA7B,CAAqCJ,cAArC,CAAd;;AACA,YAAIG,KAAK,KAAK,CAAC,CAAf,EAAkB;AAChB,eAAKnC,uBAAL,CAA6BqC,MAA7B,CAAoCF,KAApC,EAA2C,CAA3C;AACD;AACF;AANI,KAAP;AAQD;;AArGwC","sourcesContent":["import { unstable_batchedUpdates } from 'react-native';\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 */\nexport interface 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\n// global func declaration for JSI functions\ndeclare global {\n  function mmkvCreateNewInstance(\n    configuration: MMKVConfiguration\n  ): MMKVInterface;\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: MMKVInterface;\n  private functionCache: Partial<MMKVInterface>;\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    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    this.id = configuration.id;\n    this.nativeInstance = global.mmkvCreateNewInstance(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 MMKVInterface>(\n    functionName: T\n  ): MMKVInterface[T] {\n    if (this.functionCache[functionName] == null) {\n      this.functionCache[functionName] = this.nativeInstance[functionName];\n    }\n    return this.functionCache[functionName] as MMKVInterface[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"]}

package/lib/module/hooks.js

@@ -0,0 +1,124 @@
+import { useRef, useState, useMemo, useCallback, useEffect } from 'react';
+import { MMKV } from './MMKV';
+
+function isConfigurationEqual(left, right) {
+  return left.encryptionKey === right.encryptionKey && left.id === right.id && left.path === right.path;
+}
+
+let defaultInstance = null;
+
+function getDefaultInstance() {
+  if (defaultInstance == null) {
+    defaultInstance = new MMKV();
+  }
+
+  return defaultInstance;
+}
+
+export function useMMKV(configuration) {
+  const instance = useRef();
+  const lastConfiguration = useRef(configuration);
+
+  if (!isConfigurationEqual(lastConfiguration.current, configuration)) {
+    instance.current = new MMKV(configuration);
+  } // @ts-expect-error it's not null, I promise.
+
+
+  return instance;
+}
+
+function createMMKVHook(getter) {
+  return (key, instance) => {
+    const mmkv = instance !== null && instance !== void 0 ? instance : getDefaultInstance();
+    const [value, setValue] = useState(() => getter(mmkv, key));
+    const set = useCallback(v => {
+      const newValue = typeof v === 'function' ? v(value) : v;
+
+      switch (typeof newValue) {
+        case 'number':
+        case 'string':
+        case 'boolean':
+          mmkv.set(key, newValue);
+          break;
+
+        case 'undefined':
+          mmkv.delete(key);
+          break;
+
+        default:
+          throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);
+      }
+    }, [key, mmkv, value]);
+    useEffect(() => {
+      const listener = mmkv.addOnValueChangedListener(changedKey => {
+        if (changedKey === key) {
+          setValue(getter(mmkv, key));
+        }
+      });
+      return () => listener.remove();
+    }, [key, mmkv]);
+    return useMemo(() => [value, set], [value, set]);
+  };
+}
+/**
+ * Use the string value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [username, setUsername] = useMMKVString("user.name")
+ * ```
+ */
+
+
+export const useMMKVString = createMMKVHook((instance, key) => instance.getString(key));
+/**
+ * Use the number value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [age, setAge] = useMMKVNumber("user.age")
+ * ```
+ */
+
+export const useMMKVNumber = createMMKVHook((instance, key) => instance.getNumber(key));
+/**
+ * Use the boolean value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean("user.isPremium")
+ * ```
+ */
+
+export const useMMKVBoolean = createMMKVHook((instance, key) => instance.getBoolean(key));
+/**
+ * Use an object value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * The object will be serialized using `JSON`.
+ *
+ * @example
+ * ```ts
+ * const [user, setUser] = useMMKVObject<User>("user")
+ * ```
+ */
+
+export function useMMKVObject(key, instance) {
+  const [string, setString] = useMMKVString(key, instance);
+  const value = useMemo(() => {
+    if (string == null) return undefined;
+    return JSON.parse(string);
+  }, [string]);
+  const setValue = useCallback(v => {
+    setString(JSON.stringify(v));
+  }, [setString]);
+  return [value, setValue];
+}
+//# sourceMappingURL=hooks.js.map

package/lib/module/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["hooks.ts"],"names":["useRef","useState","useMemo","useCallback","useEffect","MMKV","isConfigurationEqual","left","right","encryptionKey","id","path","defaultInstance","getDefaultInstance","useMMKV","configuration","instance","lastConfiguration","current","createMMKVHook","getter","key","mmkv","value","setValue","set","v","newValue","delete","Error","listener","addOnValueChangedListener","changedKey","remove","useMMKVString","getString","useMMKVNumber","getNumber","useMMKVBoolean","getBoolean","useMMKVObject","string","setString","undefined","JSON","parse","stringify"],"mappings":"AAAA,SACEA,MADF,EAEEC,QAFF,EAGEC,OAHF,EAIEC,WAJF,EAKEC,SALF,QAMO,OANP;AAOA,SAASC,IAAT,QAAuD,QAAvD;;AAEA,SAASC,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,eAAqC,GAAG,IAA5C;;AACA,SAASC,kBAAT,GAA6C;AAC3C,MAAID,eAAe,IAAI,IAAvB,EAA6B;AAC3BA,IAAAA,eAAe,GAAG,IAAIP,IAAJ,EAAlB;AACD;;AACD,SAAOO,eAAP;AACD;;AAED,OAAO,SAASE,OAAT,CACLC,aADK,EAE2B;AAChC,QAAMC,QAAQ,GAAGhB,MAAM,EAAvB;AAEA,QAAMiB,iBAAiB,GAAGjB,MAAM,CAAoBe,aAApB,CAAhC;;AACA,MAAI,CAACT,oBAAoB,CAACW,iBAAiB,CAACC,OAAnB,EAA4BH,aAA5B,CAAzB,EAAqE;AACnEC,IAAAA,QAAQ,CAACE,OAAT,GAAmB,IAAIb,IAAJ,CAASU,aAAT,CAAnB;AACD,GAN+B,CAQhC;;;AACA,SAAOC,QAAP;AACD;;AAED,SAASG,cAAT,CAIEC,MAJF,EAIuD;AACrD,SAAO,CACLC,GADK,EAELL,QAFK,KAGiD;AACtD,UAAMM,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeH,kBAAkB,EAA3C;AACA,UAAM,CAACU,KAAD,EAAQC,QAAR,IAAoBvB,QAAQ,CAAC,MAAMmB,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAb,CAAlC;AAEA,UAAMI,GAAG,GAAGtB,WAAW,CACpBuB,CAAD,IAAmB;AACjB,YAAMC,QAAQ,GAAG,OAAOD,CAAP,KAAa,UAAb,GAA0BA,CAAC,CAACH,KAAD,CAA3B,GAAqCG,CAAtD;;AACA,cAAQ,OAAOC,QAAf;AACE,aAAK,QAAL;AACA,aAAK,QAAL;AACA,aAAK,SAAL;AACEL,UAAAA,IAAI,CAACG,GAAL,CAASJ,GAAT,EAAcM,QAAd;AACA;;AACF,aAAK,WAAL;AACEL,UAAAA,IAAI,CAACM,MAAL,CAAYP,GAAZ;AACA;;AACF;AACE,gBAAM,IAAIQ,KAAJ,CAAW,cAAa,OAAOF,QAAS,oBAAxC,CAAN;AAVJ;AAYD,KAfoB,EAgBrB,CAACN,GAAD,EAAMC,IAAN,EAAYC,KAAZ,CAhBqB,CAAvB;AAmBAnB,IAAAA,SAAS,CAAC,MAAM;AACd,YAAM0B,QAAQ,GAAGR,IAAI,CAACS,yBAAL,CAAgCC,UAAD,IAAgB;AAC9D,YAAIA,UAAU,KAAKX,GAAnB,EAAwB;AACtBG,UAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACD;AACF,OAJgB,CAAjB;AAKA,aAAO,MAAMS,QAAQ,CAACG,MAAT,EAAb;AACD,KAPQ,EAON,CAACZ,GAAD,EAAMC,IAAN,CAPM,CAAT;AASA,WAAOpB,OAAO,CAAC,MAAM,CAACqB,KAAD,EAAQE,GAAR,CAAP,EAAqB,CAACF,KAAD,EAAQE,GAAR,CAArB,CAAd;AACD,GApCD;AAqCD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,OAAO,MAAMS,aAAa,GAAGf,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACmB,SAAT,CAAmBd,GAAnB,CADyC,CAApC;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMe,aAAa,GAAGjB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACqB,SAAT,CAAmBhB,GAAnB,CADyC,CAApC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMiB,cAAc,GAAGnB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC3CL,QAAQ,CAACuB,UAAT,CAAoBlB,GAApB,CAD0C,CAArC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASmB,aAAT,CACLnB,GADK,EAELL,QAFK,EAGiD;AACtD,QAAM,CAACyB,MAAD,EAASC,SAAT,IAAsBR,aAAa,CAACb,GAAD,EAAML,QAAN,CAAzC;AAEA,QAAMO,KAAK,GAAGrB,OAAO,CAAC,MAAM;AAC1B,QAAIuC,MAAM,IAAI,IAAd,EAAoB,OAAOE,SAAP;AACpB,WAAOC,IAAI,CAACC,KAAL,CAAWJ,MAAX,CAAP;AACD,GAHoB,EAGlB,CAACA,MAAD,CAHkB,CAArB;AAIA,QAAMjB,QAAQ,GAAGrB,WAAW,CACzBuB,CAAD,IAAU;AACRgB,IAAAA,SAAS,CAACE,IAAI,CAACE,SAAL,CAAepB,CAAf,CAAD,CAAT;AACD,GAHyB,EAI1B,CAACgB,SAAD,CAJ0B,CAA5B;AAOA,SAAO,CAACnB,KAAD,EAAQC,QAAR,CAAP;AACD","sourcesContent":["import React, {\n  useRef,\n  useState,\n  useMemo,\n  useCallback,\n  useEffect,\n} from 'react';\nimport { MMKV, MMKVConfiguration, MMKVInterface } 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: MMKVInterface | null = null;\nfunction getDefaultInstance(): MMKVInterface {\n  if (defaultInstance == null) {\n    defaultInstance = new MMKV();\n  }\n  return defaultInstance;\n}\n\nexport function useMMKV(\n  configuration: MMKVConfiguration\n): React.RefObject<MMKVInterface> {\n  const instance = useRef<MMKVInterface>();\n\n  const lastConfiguration = useRef<MMKVConfiguration>(configuration);\n  if (!isConfigurationEqual(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: MMKVInterface, key: string) => T) {\n  return (\n    key: string,\n    instance?: MMKVInterface\n  ): [value: T, setValue: (value: TSetAction) => void] => {\n    const mmkv = instance ?? getDefaultInstance();\n    const [value, setValue] = useState(() => getter(mmkv, key));\n\n    const set = useCallback(\n      (v: TSetAction) => {\n        const newValue = typeof v === 'function' ? v(value) : 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, value]\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?: MMKVInterface\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"]}

package/lib/module/index.js

@@ -1,2 +1,3 @@
 export * from './MMKV';
+export * from './hooks';
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAd","sourcesContent":["export * from './MMKV';\n"]}
+{"version":3,"sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAd;AACA,cAAc,SAAd","sourcesContent":["export * from './MMKV';\nexport * from './hooks';\n"]}

package/lib/typescript/MMKV.d.ts

@@ -1,3 +1,6 @@
+interface Listener {
+    remove: () => void;
+}
 /**
  * Used for configuration of a single MMKV instance.
  */
@@ -59,6 +62,10 @@ export interface MMKVInterface {
      * @default 0
      */
     getNumber: (key: string) => number;
+    /**
+     * Checks whether the given `key` is being stored in this MMKV instance.
+     */
+    contains: (key: string) => boolean;
     /**
      * Delete the given `key`.
      */
@@ -73,6 +80,10 @@ export interface MMKVInterface {
      * Delete all keys.
      */
     clearAll: () => void;
+    /**
+     * Adds a value changed listener.
+     */
+    addOnValueChangedListener: (onValueChanged: (key: string) => void) => Listener;
 }
 declare global {
     function mmkvCreateNewInstance(configuration: MMKVConfiguration): MMKVInterface;
@@ -83,17 +94,23 @@ declare global {
 export declare class MMKV implements MMKVInterface {
     private nativeInstance;
     private functionCache;
+    private id;
     /**
      * Creates a new MMKV instance with the given Configuration.
      * If no custom `id` is supplied, `'default'` will be used.
      */
     constructor(configuration?: MMKVConfiguration);
+    private get onValueChangedListeners();
     private getFunctionFromCache;
+    private onValuesAboutToChange;
     set(key: string, value: boolean | string | number): void;
     getBoolean(key: string): boolean;
     getString(key: string): string | undefined;
     getNumber(key: string): number;
+    contains(key: string): boolean;
     delete(key: string): void;
     getAllKeys(): string[];
     clearAll(): void;
+    addOnValueChangedListener(onValueChanged: (key: string) => void): Listener;
 }
+export {};

package/lib/typescript/hooks.d.ts

@@ -0,0 +1,49 @@
+import React from 'react';
+import { MMKVConfiguration, MMKVInterface } from './MMKV';
+export declare function useMMKV(configuration: MMKVConfiguration): React.RefObject<MMKVInterface>;
+/**
+ * Use the string value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [username, setUsername] = useMMKVString("user.name")
+ * ```
+ */
+export declare const useMMKVString: (key: string, instance?: MMKVInterface | undefined) => [value: string | undefined, setValue: (value: string | ((current: string | undefined) => string | undefined) | undefined) => void];
+/**
+ * Use the number value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [age, setAge] = useMMKVNumber("user.age")
+ * ```
+ */
+export declare const useMMKVNumber: (key: string, instance?: MMKVInterface | undefined) => [value: number, setValue: (value: number | ((current: number) => number | undefined) | undefined) => void];
+/**
+ * Use the boolean value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean("user.isPremium")
+ * ```
+ */
+export declare const useMMKVBoolean: (key: string, instance?: MMKVInterface | undefined) => [value: boolean, setValue: (value: boolean | ((current: boolean) => boolean | undefined) | undefined) => void];
+/**
+ * Use an object value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * The object will be serialized using `JSON`.
+ *
+ * @example
+ * ```ts
+ * const [user, setUser] = useMMKVObject<User>("user")
+ * ```
+ */
+export declare function useMMKVObject<T>(key: string, instance?: MMKVInterface): [value: T | undefined, setValue: (value: T) => void];

package/lib/typescript/index.d.ts

@@ -1 +1,2 @@
 export * from './MMKV';
+export * from './hooks';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-mmkv",
-  "version": "1.3.3",
+  "version": "1.5.2",
   "description": "An efficient, small mobile key-value storage framework developed by WeChat. Works on Android and iOS.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",