react-native-mmkv 2.0.0 → 2.0.1

package/MMKV/Core/MemoryFile_Win32.cpp

@@ -28,6 +28,7 @@
 #    include "ScopedLock.hpp"
 #    include "ThreadLock.h"
 #    include <cassert>
+#    include <strsafe.h>
 
 using namespace std;
 
@@ -36,13 +37,73 @@ namespace mmkv {
 static bool getFileSize(MMKVFileHandle_t fd, size_t &size);
 static bool ftruncate(MMKVFileHandle_t file, size_t size);
 
-MemoryFile::MemoryFile(const MMKVPath_t &path)
-    : m_name(path), m_fd(INVALID_HANDLE_VALUE), m_fileMapping(nullptr), m_ptr(nullptr), m_size(0) {
+File::File(MMKVPath_t path, OpenFlag flag) : m_path(std::move(path)), m_fd(INVALID_HANDLE_VALUE), m_flag(flag) {
+    open();
+}
+
+static pair<int, int> OpenFlag2NativeFlag(OpenFlag flag) {
+    int access = 0, create = OPEN_EXISTING;
+    if (flag & OpenFlag::ReadWrite) {
+        access = (GENERIC_READ | GENERIC_WRITE);
+    } else if (flag & OpenFlag::ReadOnly) {
+        access |= GENERIC_READ;
+    } else if (flag & OpenFlag::WriteOnly) {
+        access |= GENERIC_WRITE;
+    }
+    if (flag & OpenFlag::Create) {
+        create = OPEN_ALWAYS;
+    }
+    if (flag & OpenFlag::Excel) {
+        access = CREATE_NEW;
+    }
+    if (flag & OpenFlag::Truncate) {
+        access = CREATE_ALWAYS;
+    }
+    return {access, create};
+}
+
+bool File::open() {
+    if (isFileValid()) {
+        return true;
+    }
+    auto pair = OpenFlag2NativeFlag(m_flag);
+    m_fd = CreateFile(m_path.c_str(), pair.first, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, nullptr,
+                      pair.second, FILE_ATTRIBUTE_NORMAL, nullptr);
+    if (!isFileValid()) {
+        MMKVError("fail to open:[%ws], %d", m_path.c_str(), GetLastError());
+        return false;
+    }
+    MMKVInfo("open fd[%p], %ws", m_fd, m_path.c_str());
+    return true;
+}
+
+void File::close() {
+    if (isFileValid()) {
+        MMKVInfo("closing fd[%p], %ws", m_fd, m_path.c_str());
+        if (CloseHandle(m_fd)) {
+            m_fd = INVALID_HANDLE_VALUE;
+        } else {
+            MMKVError("fail to close [%ws], %d", m_path.c_str(), GetLastError());
+        }
+    }
+}
+
+size_t File::getActualFileSize() const {
+    size_t size = 0;
+    mmkv::getFileSize(m_fd, size);
+    return size;
+}
+
+MemoryFile::MemoryFile(MMKVPath_t path)
+    : m_diskFile(std::move(path), OpenFlag::ReadWrite | OpenFlag::Create)
+    , m_fileMapping(nullptr)
+    , m_ptr(nullptr)
+    , m_size(0) {
     reloadFromFile();
 }
 
 bool MemoryFile::truncate(size_t size) {
-    if (m_fd < 0) {
+    if (!m_diskFile.isFileValid()) {
         return false;
     }
     if (size == m_size) {
@@ -56,14 +117,14 @@ bool MemoryFile::truncate(size_t size) {
         m_size = ((m_size / DEFAULT_MMAP_SIZE) + 1) * DEFAULT_MMAP_SIZE;
     }
 
-    if (!ftruncate(m_fd, m_size)) {
-        MMKVError("fail to truncate [%ws] to size %zu", m_name.c_str(), m_size);
+    if (!ftruncate(m_diskFile.getFd(), m_size)) {
+        MMKVError("fail to truncate [%ws] to size %zu", m_diskFile.m_path.c_str(), m_size);
         m_size = oldSize;
         return false;
     }
     if (m_size > oldSize) {
-        if (!zeroFillFile(m_fd, oldSize, m_size - oldSize)) {
-            MMKVError("fail to zeroFile [%ws] to size %zu", m_name.c_str(), m_size);
+        if (!zeroFillFile(m_diskFile.getFd(), oldSize, m_size - oldSize)) {
+            MMKVError("fail to zeroFile [%ws] to size %zu", m_diskFile.m_path.c_str(), m_size);
             m_size = oldSize;
             return false;
         }
@@ -71,7 +132,7 @@ bool MemoryFile::truncate(size_t size) {
 
     if (m_ptr) {
         if (!UnmapViewOfFile(m_ptr)) {
-            MMKVError("fail to munmap [%ws], %d", m_name.c_str(), GetLastError());
+            MMKVError("fail to munmap [%ws], %d", m_diskFile.m_path.c_str(), GetLastError());
         }
         m_ptr = nullptr;
     }
@@ -90,28 +151,28 @@ bool MemoryFile::msync(SyncFlag syncFlag) {
     if (m_ptr) {
         if (FlushViewOfFile(m_ptr, m_size)) {
             if (syncFlag == MMKV_SYNC) {
-                if (!FlushFileBuffers(m_fd)) {
-                    MMKVError("fail to FlushFileBuffers [%ws]:%d", m_name.c_str(), GetLastError());
+                if (!FlushFileBuffers(m_diskFile.getFd())) {
+                    MMKVError("fail to FlushFileBuffers [%ws]:%d", m_diskFile.m_path.c_str(), GetLastError());
                     return false;
                 }
             }
             return true;
         }
-        MMKVError("fail to FlushViewOfFile [%ws]:%d", m_name.c_str(), GetLastError());
+        MMKVError("fail to FlushViewOfFile [%ws]:%d", m_diskFile.m_path.c_str(), GetLastError());
         return false;
     }
     return false;
 }
 
 bool MemoryFile::mmap() {
-    m_fileMapping = CreateFileMapping(m_fd, nullptr, PAGE_READWRITE, 0, 0, nullptr);
+    m_fileMapping = CreateFileMapping(m_diskFile.getFd(), nullptr, PAGE_READWRITE, 0, 0, nullptr);
     if (!m_fileMapping) {
-        MMKVError("fail to CreateFileMapping [%ws], %d", m_name.c_str(), GetLastError());
+        MMKVError("fail to CreateFileMapping [%ws], %d", m_diskFile.m_path.c_str(), GetLastError());
         return false;
     } else {
         m_ptr = (char *) MapViewOfFile(m_fileMapping, FILE_MAP_ALL_ACCESS, 0, 0, 0);
         if (!m_ptr) {
-            MMKVError("fail to mmap [%ws], %d", m_name.c_str(), GetLastError());
+            MMKVError("fail to mmap [%ws], %d", m_diskFile.m_path.c_str(), GetLastError());
             return false;
         }
     }
@@ -121,22 +182,17 @@ bool MemoryFile::mmap() {
 
 void MemoryFile::reloadFromFile() {
     if (isFileValid()) {
-        MMKVWarning("calling reloadFromFile while the cache [%ws] is still valid", m_name.c_str());
+        MMKVWarning("calling reloadFromFile while the cache [%ws] is still valid", m_diskFile.m_path.c_str());
         assert(0);
         clearMemoryCache();
     }
-
-    m_fd =
-        CreateFile(m_name.c_str(), GENERIC_READ | GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
-                   nullptr, OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
-    if (m_fd == INVALID_HANDLE_VALUE) {
-        MMKVError("fail to open:%ws, %d", m_name.c_str(), GetLastError());
-    } else {
-        FileLock fileLock(m_fd);
+    m_diskFile.open();
+    if (m_diskFile.isFileValid()) {
+        FileLock fileLock(m_diskFile.getFd());
         InterProcessLock lock(&fileLock, ExclusiveLockType);
         SCOPED_LOCK(&lock);
 
-        mmkv::getFileSize(m_fd, m_size);
+        mmkv::getFileSize(m_diskFile.getFd(), m_size);
         // round up to (n * pagesize)
         if (m_size < DEFAULT_MMAP_SIZE || (m_size % DEFAULT_MMAP_SIZE != 0)) {
             size_t roundSize = ((m_size / DEFAULT_MMAP_SIZE) + 1) * DEFAULT_MMAP_SIZE;
@@ -159,16 +215,7 @@ void MemoryFile::doCleanMemoryCache(bool forceClean) {
         CloseHandle(m_fileMapping);
         m_fileMapping = nullptr;
     }
-    if (m_fd != INVALID_HANDLE_VALUE) {
-        CloseHandle(m_fd);
-        m_fd = INVALID_HANDLE_VALUE;
-    }
-}
-
-size_t MemoryFile::getActualFileSize() {
-    size_t size = 0;
-    mmkv::getFileSize(m_fd, size);
-    return size;
+    m_diskFile.close();
 }
 
 size_t getPageSize() {
@@ -302,6 +349,170 @@ static bool getFileSize(MMKVFileHandle_t fd, size_t &size) {
     return false;
 }
 
+static pair<MMKVPath_t, MMKVFileHandle_t> createUniqueTempFile(const wchar_t *prefix) {
+    wchar_t lpTempPathBuffer[MAX_PATH];
+    //  Gets the temp path env string (no guarantee it's a valid path).
+    auto dwRetVal = GetTempPath(MAX_PATH, lpTempPathBuffer);
+    if (dwRetVal > MAX_PATH || (dwRetVal == 0)) {
+        MMKVError("GetTempPath failed %d", GetLastError());
+        return {L"", INVALID_HANDLE_VALUE};
+    }
+    //  Generates a temporary file name.
+    wchar_t szTempFileName[MAX_PATH];
+    if (!GetTempFileName(lpTempPathBuffer, prefix, 0, szTempFileName)) {
+        MMKVError("GetTempFileName failed %d", GetLastError());
+        return {L"", INVALID_HANDLE_VALUE};
+    }
+    auto hTempFile = CreateFile(szTempFileName, GENERIC_WRITE, 0, nullptr, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
+    if (hTempFile == INVALID_HANDLE_VALUE) {
+        MMKVError("fail to create unique temp file [%ws], %d", szTempFileName, GetLastError());
+        return {L"", INVALID_HANDLE_VALUE};
+    }
+    MMKVDebug("create unique temp file [%ws] with fd[%p]", szTempFileName, hTempFile);
+    return {MMKVPath_t(szTempFileName), hTempFile};
+}
+
+bool tryAtomicRename(const MMKVPath_t &srcPath, const MMKVPath_t &dstPath) {
+    if (MoveFileEx(srcPath.c_str(), dstPath.c_str(), MOVEFILE_REPLACE_EXISTING | MOVEFILE_COPY_ALLOWED) == 0) {
+        MMKVError("MoveFileEx [%ws] to [%ws] failed %d", srcPath.c_str(), dstPath.c_str(), GetLastError());
+        return false;
+    }
+    return true;
+}
+
+bool copyFileContent(const MMKVPath_t &srcPath, MMKVFileHandle_t dstFD, bool needTruncate) {
+    if (dstFD == INVALID_HANDLE_VALUE) {
+        return false;
+    }
+    bool ret = false;
+    File srcFile(srcPath, OpenFlag::ReadOnly);
+    if (!srcFile.isFileValid()) {
+        return false;
+    }
+    auto bufferSize = getPageSize();
+    auto buffer = (char *) malloc(bufferSize);
+    if (!buffer) {
+        MMKVError("fail to malloc size %zu, %d(%s)", bufferSize, errno, strerror(errno));
+        goto errorOut;
+    }
+    SetFilePointer(dstFD, 0, 0, FILE_BEGIN);
+
+    // the Win32 platform don't have sendfile()/fcopyfile() equivalent, do it the hard way
+    while (true) {
+        DWORD sizeRead = 0;
+        if (!ReadFile(srcFile.getFd(), buffer, bufferSize, &sizeRead, nullptr)) {
+            MMKVError("fail to read %ws: %d", srcPath.c_str(), GetLastError());
+            goto errorOut;
+        }
+
+        DWORD sizeWrite = 0;
+        if (!WriteFile(dstFD, buffer, sizeRead, &sizeWrite, nullptr)) {
+            MMKVError("fail to write fd [%d], %d", dstFD, GetLastError());
+            goto errorOut;
+        }
+
+        if (sizeRead < bufferSize) {
+            break;
+        }
+    }
+    if (needTruncate) {
+        size_t dstFileSize = 0;
+        getFileSize(dstFD, dstFileSize);
+        auto srcFileSize = srcFile.getActualFileSize();
+        if ((dstFileSize != srcFileSize) && !ftruncate(dstFD, static_cast<off_t>(srcFileSize))) {
+            MMKVError("fail to truncate [%d] to size [%zu]", dstFD, srcFileSize);
+            goto errorOut;
+        }
+    }
+
+    ret = true;
+    MMKVInfo("copy content from %ws to fd[%d] finish", srcPath.c_str(), dstFD);
+
+errorOut:
+    free(buffer);
+    return ret;
+}
+
+// copy to a temp file then rename it
+// this is the best we can do on Win32
+bool copyFile(const MMKVPath_t &srcPath, const MMKVPath_t &dstPath) {
+    auto pair = createUniqueTempFile(L"MMKV");
+    auto tmpFD = pair.second;
+    auto &tmpPath = pair.first;
+    if (tmpFD == INVALID_HANDLE_VALUE) {
+        return false;
+    }
+
+    bool renamed = false;
+    if (copyFileContent(srcPath, tmpFD, false)) {
+        MMKVInfo("copyed file [%ws] to [%ws]", srcPath.c_str(), tmpPath.c_str());
+        CloseHandle(tmpFD);
+        renamed = tryAtomicRename(tmpPath.c_str(), dstPath.c_str());
+        if (renamed) {
+            MMKVInfo("copyfile [%ws] to [%ws] finish.", srcPath.c_str(), dstPath.c_str());
+        }
+    } else {
+        CloseHandle(tmpFD);
+    }
+
+    if (!renamed) {
+        DeleteFile(tmpPath.c_str());
+    }
+    return renamed;
+}
+
+bool copyFileContent(const MMKVPath_t &srcPath, const MMKVPath_t &dstPath) {
+    File dstFile(dstPath, OpenFlag::WriteOnly | OpenFlag::Create | OpenFlag::Truncate);
+    if (!dstFile.isFileValid()) {
+        return false;
+    }
+    auto ret = copyFileContent(srcPath, dstFile.getFd(), false);
+    if (!ret) {
+        MMKVError("fail to copyfile(): target file %ws", dstPath.c_str());
+    } else {
+        MMKVInfo("copy content from %ws to [%ws] finish", srcPath.c_str(), dstPath.c_str());
+    }
+    return ret;
+}
+
+bool copyFileContent(const MMKVPath_t &srcPath, MMKVFileHandle_t dstFD) {
+    return copyFileContent(srcPath, dstFD, true);
+}
+
+void walkInDir(const MMKVPath_t &dirPath,
+               WalkType type,
+               const std::function<void(const MMKVPath_t &, WalkType)> &walker) {
+    wchar_t szDir[MAX_PATH];
+    StringCchCopy(szDir, MAX_PATH, dirPath.c_str());
+    StringCchCat(szDir, MAX_PATH, L"\\*");
+
+    WIN32_FIND_DATA ffd;
+    auto hFind = FindFirstFile(szDir, &ffd);
+    if (hFind == INVALID_HANDLE_VALUE) {
+        return;
+    }
+
+    do {
+        if (ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
+            if (type & WalkFolder) {
+                if (wcscmp(ffd.cFileName, L".") == 0 || wcscmp(ffd.cFileName, L"..") == 0) {
+                    continue;
+                }
+                walker(dirPath + L"\\" + ffd.cFileName, WalkFolder);
+            }
+        } else if (type & WalkFile) {
+            walker(dirPath + L"\\" + ffd.cFileName, WalkFile);
+        }
+    } while (FindNextFile(hFind, &ffd) != 0);
+
+    auto dwError = GetLastError();
+    if (dwError != ERROR_NO_MORE_FILES) {
+        MMKVError("WalkInDir fail %d", dwError);
+    }
+
+    FindClose(hFind);
+}
+
 } // namespace mmkv
 
 std::wstring string2MMKVPath_t(const std::string &str) {
@@ -313,4 +524,13 @@ std::wstring string2MMKVPath_t(const std::string &str) {
     return result;
 }
 
+std::string MMKVPath_t2String(const MMKVPath_t &str) {
+    auto length = WideCharToMultiByte(CP_UTF8, 0, str.c_str(), -1, nullptr, 0, 0, 0);
+    auto buffer = new char[length];
+    WideCharToMultiByte(CP_UTF8, 0, str.c_str(), -1, buffer, length, 0, 0);
+    string result(buffer);
+    delete[] buffer;
+    return result;
+}
+
 #endif // MMKV_WIN32

package/MMKV/Core/aes/openssl/openssl_aes.h

@@ -89,13 +89,13 @@ int AES_C_set_decrypt_key(const uint8_t *userKey, const int bits, void *key);
 void AES_C_encrypt(const uint8_t *in, uint8_t *out, const void *key);
 void AES_C_decrypt(const uint8_t *in, uint8_t *out, const void *key);
 
-} // namespace openssl
-
 extern aes_set_encrypt_t AES_set_encrypt_key;
 extern aes_set_decrypt_t AES_set_decrypt_key;
 extern aes_encrypt_t AES_encrypt;
 extern aes_decrypt_t AES_decrypt;
 
+} // namespace openssl
+
 #endif // __ARM_MAX_ARCH__ <= 7
 
 #endif // __linux__

package/MMKV/Core/aes/openssl/openssl_aes_core.cpp

@@ -43,6 +43,8 @@
 
 #ifndef MMKV_DISABLE_CRYPT
 
+namespace openssl {
+
 #if (__ARM_MAX_ARCH__ > 7) && defined(__linux__)
 
 aes_set_encrypt_t AES_set_encrypt_key = openssl::AES_C_set_encrypt_key;
@@ -54,8 +56,6 @@ aes_encrypt_t AES_decrypt = openssl::AES_C_decrypt;
 
 #if (__ARM_MAX_ARCH__ <= 0) || (__ARM_MAX_ARCH__ > 7 && defined(__linux__))
 
-namespace openssl {
-
 /*-
 Te0[x] = S [x].[02, 01, 01, 03];
 Te1[x] = S [x].[03, 02, 01, 01];
@@ -1037,8 +1037,8 @@ void AES_C_decrypt(const uint8_t *in, uint8_t *out, const void *k) {
     PUTU32(out + 12, s3);
 }
 
-} // namespace openssl
-
 #endif // (__ARM_MAX_ARCH__ < 0) || (__ARM_MAX_ARCH__ > 7 && defined(__linux__))
 
+} // namespace openssl
+
 #endif // MMKV_DISABLE_CRYPT

package/MMKV/README.md

@@ -1,6 +1,6 @@
 [![license](https://img.shields.io/badge/license-BSD_3-brightgreen.svg?style=flat)](https://github.com/Tencent/MMKV/blob/master/LICENSE.TXT)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/MMKV/pulls)
-[![Release Version](https://img.shields.io/badge/release-1.2.10-brightgreen.svg)](https://github.com/Tencent/MMKV/releases)
+[![Release Version](https://img.shields.io/badge/release-1.2.12-brightgreen.svg)](https://github.com/Tencent/MMKV/releases)
 [![Platform](https://img.shields.io/badge/Platform-%20Android%20%7C%20iOS%2FmacOS%20%7C%20Win32%20%7C%20POSIX-brightgreen.svg)](https://github.com/Tencent/MMKV/wiki/home)
 
 中文版本请参看[这里](./README_CN.md)
@@ -28,12 +28,12 @@ Add the following lines to `build.gradle` on your app module:
 
 ```gradle
 dependencies {
-    implementation 'com.tencent:mmkv-static:1.2.10'
-    // replace "1.2.10" with any available version
+    implementation 'com.tencent:mmkv:1.2.12'
+    // replace "1.2.12" with any available version
 }
 ```
 
-Starting from v1.2.8, MMKV has been **migrated to Maven Central**. Older versions (<= v1.2.7) are still available on JCenter.  
+Starting from v1.2.8, MMKV has been **migrated to Maven Central**.  
 For other installation options, see [Android Setup](https://github.com/Tencent/MMKV/wiki/android_setup).
 
 ### Quick Tutorial

package/README.md

@@ -160,9 +160,10 @@ const userObject = JSON.parse(jsonUser)
 * [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 redux-persist](./docs/WRAPPER_REDUX.md)
 * [Using MMKV with mobx-persist-storage](./docs/WRAPPER_MOBX.md)
 * [Using MMKV with mobx-persist](./docs/WRAPPER_MOBXPERSIST.md)
+* [How is this library different from **react-native-mmkv-storage**?](https://github.com/mrousavy/react-native-mmkv/issues/100#issuecomment-886477361)
 
 ## Limitations
 

package/lib/commonjs/createMMKV.js

@@ -13,14 +13,50 @@ const ROOT_DIRECTORY = null;
 const createMMKV = config => {
   // Check if the constructor exists. If not, try installing the JSI bindings.
   if (global.mmkvCreateNewInstance == null) {
-    // get the MMKV ReactModule
+    // Get the native MMKV ReactModule
     const MMKVModule = _reactNative.NativeModules.MMKV;
-    if (MMKVModule == null || typeof MMKVModule.install !== 'function') throw new Error('The native MMKV Module could not be found! Is it correctly installed and autolinked?'); // Call the synchronous blocking install() function
+
+    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(`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 (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. Is the native MMKV library correctly installed? Make sure to disable any remote debugger (e.g. Chrome) to use JSI!');
+    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":["ROOT_DIRECTORY","createMMKV","config","global","mmkvCreateNewInstance","MMKVModule","NativeModules","MMKV","install","Error","result"],"mappings":";;;;;;;AAAA;;AAQA;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,IAAd,IAAsB,OAAOA,UAAU,CAACG,OAAlB,KAA8B,UAAxD,EACE,MAAM,IAAIC,KAAJ,CACJ,sFADI,CAAN,CAJsC,CAOxC;;AACA,UAAMC,MAAM,GAAGL,UAAU,CAACG,OAAX,CAAmBR,cAAnB,CAAf;AACA,QAAIU,MAAM,KAAK,IAAf,EACE,MAAM,IAAID,KAAJ,CACH,gHAA+GC,MAAO,EADnH,CAAN,CAVsC,CAaxC;;AACA,QAAIP,MAAM,CAACC,qBAAP,IAAgC,IAApC,EACE,MAAM,IAAIK,KAAJ,CACJ,0MADI,CAAN;AAGH;;AAED,SAAON,MAAM,CAACC,qBAAP,CAA6BF,MAA7B,CAAP;AACD,CAvBM","sourcesContent":["import { NativeModules } 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}\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 MMKV ReactModule\n    const MMKVModule = NativeModules.MMKV;\n    if (MMKVModule == null || typeof MMKVModule.install !== 'function')\n      throw new Error(\n        'The native MMKV Module could not be found! Is it correctly installed and autolinked?'\n      );\n    // Call the synchronous blocking install() function\n    const result = MMKVModule.install(ROOT_DIRECTORY);\n    if (result !== true)\n      throw new Error(\n        `The native MMKV Module could not be installed! Looks like something went wrong when installing JSI bindings: ${result}`\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. 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/hooks.js

@@ -71,7 +71,7 @@ function createMMKVHook(getter) {
       });
       return () => listener.remove();
     }, [key, mmkv]);
-    return (0, _react.useMemo)(() => [value, set], [value, set]);
+    return [value, set];
   };
 }
 /**
@@ -135,7 +135,13 @@ 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];
 }

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"],"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","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"]}

package/lib/module/createMMKV.js

@@ -1,17 +1,53 @@
-import { NativeModules } from 'react-native';
+import { NativeModules, Platform } from 'react-native';
 // Root directory of all MMKV stores
 const ROOT_DIRECTORY = null;
 export const createMMKV = config => {
   // Check if the constructor exists. If not, try installing the JSI bindings.
   if (global.mmkvCreateNewInstance == null) {
-    // get the MMKV ReactModule
+    // Get the native MMKV ReactModule
     const MMKVModule = NativeModules.MMKV;
-    if (MMKVModule == null || typeof MMKVModule.install !== 'function') throw new Error('The native MMKV Module could not be found! Is it correctly installed and autolinked?'); // Call the synchronous blocking install() function
+
+    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 (Platform.OS === 'ios' || Platform.OS === 'macos') {
+        message += '\n* Make sure you ran `pod install` in the ios/ directory.';
+      }
+
+      if (Platform.OS === 'android') {
+        message += '\n* Make sure gradle is synced.';
+      } // check if Expo
+
+
+      const ExpoConstants = (_NativeModules$Native = 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(`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 (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. Is the native MMKV library correctly installed? Make sure to disable any remote debugger (e.g. Chrome) to use JSI!');
+    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);