react-native-mmkv 4.0.0-beta.1 → 4.0.0-beta.11

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

@@ -0,0 +1,67 @@
+///
+/// Listener.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <functional>
+
+namespace margelo::nitro::mmkv {
+
+  /**
+   * A struct which can be represented as a JavaScript object (Listener).
+   */
+  struct Listener {
+  public:
+    std::function<void()> remove     SWIFT_PRIVATE;
+
+  public:
+    Listener() = default;
+    explicit Listener(std::function<void()> remove): remove(remove) {}
+  };
+
+} // namespace margelo::nitro::mmkv
+
+namespace margelo::nitro {
+
+  // C++ Listener <> JS Listener (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mmkv::Listener> final {
+    static inline margelo::nitro::mmkv::Listener fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mmkv::Listener(
+        JSIConverter<std::function<void()>>::fromJSI(runtime, obj.getProperty(runtime, "remove"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mmkv::Listener& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "remove", JSIConverter<std::function<void()>>::toJSI(runtime, arg.remove));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!JSIConverter<std::function<void()>>::canConvert(runtime, obj.getProperty(runtime, "remove"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,76 @@
+///
+/// Mode.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/NitroHash.hpp>)
+#include <NitroModules/NitroHash.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+namespace margelo::nitro::mmkv {
+
+  /**
+   * An enum which can be represented as a JavaScript union (Mode).
+   */
+  enum class Mode {
+    SINGLE_PROCESS      SWIFT_NAME(singleProcess) = 0,
+    MULTI_PROCESS      SWIFT_NAME(multiProcess) = 1,
+  } CLOSED_ENUM;
+
+} // namespace margelo::nitro::mmkv
+
+namespace margelo::nitro {
+
+  // C++ Mode <> JS Mode (union)
+  template <>
+  struct JSIConverter<margelo::nitro::mmkv::Mode> final {
+    static inline margelo::nitro::mmkv::Mode fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, arg);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("single-process"): return margelo::nitro::mmkv::Mode::SINGLE_PROCESS;
+        case hashString("multi-process"): return margelo::nitro::mmkv::Mode::MULTI_PROCESS;
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum Mode - invalid value!");
+      }
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, margelo::nitro::mmkv::Mode arg) {
+      switch (arg) {
+        case margelo::nitro::mmkv::Mode::SINGLE_PROCESS: return JSIConverter<std::string>::toJSI(runtime, "single-process");
+        case margelo::nitro::mmkv::Mode::MULTI_PROCESS: return JSIConverter<std::string>::toJSI(runtime, "multi-process");
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert Mode to JS - invalid value: "
+                                    + std::to_string(static_cast<int>(arg)) + "!");
+      }
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isString()) {
+        return false;
+      }
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, value);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("single-process"):
+        case hashString("multi-process"):
+          return true;
+        default:
+          return false;
+      }
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -1,65 +1,57 @@
 {
   "name": "react-native-mmkv",
-  "version": "4.0.0-beta.1",
-  "description": "The fastest key/value storage for React Native. ~30x faster than AsyncStorage! Works on Android, iOS and Web.",
-  "main": "lib/commonjs/index",
-  "module": "lib/module/index",
-  "types": "lib/typescript/src/index.d.ts",
+  "version": "4.0.0-beta.11",
+  "description": "⚡️ The fastest key/value storage for React Native.",
+  "main": "lib/index",
+  "module": "lib/index",
+  "types": "lib/index.d.ts",
   "react-native": "src/index",
   "source": "src/index",
   "files": [
-    "cpp/**/*.h",
-    "cpp/**/*.cpp",
-    "android/src",
+    "src",
+    "react-native.config.js",
+    "lib",
+    "nitrogen",
     "android/build.gradle",
-    "android/CMakeLists.txt",
-    "android/cpp-adapter.cpp",
     "android/gradle.properties",
-    "lib/commonjs",
-    "lib/module",
-    "lib/typescript",
+    "android/fix-prefab.gradle",
+    "android/CMakeLists.txt",
+    "android/src",
     "ios/**/*.h",
     "ios/**/*.m",
     "ios/**/*.mm",
     "ios/**/*.cpp",
-    "src",
-    "react-native-mmkv.podspec",
-    "react-native.config.js",
+    "ios/**/*.swift",
+    "cpp/**/*.h",
+    "cpp/**/*.hpp",
+    "cpp/**/*.cpp",
+    "app.plugin.js",
+    "nitro.json",
+    "*.podspec",
     "README.md"
   ],
   "scripts": {
-    "typescript": "tsc --noEmit",
-    "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "lint-ci": "yarn lint -f ./node_modules/@firmnav/eslint-github-actions-formatter/dist/formatter.js",
-    "lint-cpp": "scripts/clang-format.sh",
-    "check-all": "yarn lint --fix && yarn lint-cpp",
-    "test": "jest",
+    "postinstall": "tsc || exit 0;",
     "typecheck": "tsc --noEmit",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
-    "prepare": "bob build",
-    "prepack": "bob build",
-    "pods": "cd example && yarn pods",
+    "clean": "rm -rf android/build node_modules/**/android/build lib",
+    "lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "lint-ci": "eslint \"**/*.{js,ts,tsx}\" -f @jamesacarr/github-actions",
+    "typescript": "tsc",
+    "specs": "tsc && nitrogen --logLevel=\"debug\"",
+    "build": "tsc --noEmit false",
     "release": "release-it",
-    "codegen": "npx react-native codegen"
+    "test": "jest"
   },
   "keywords": [
     "react-native",
-    "ios",
-    "android",
-    "mmkv",
-    "storage",
-    "key",
-    "value",
-    "fast",
-    "turbo",
-    "async"
+    "nitro"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mrousavy/react-native-mmkv.git"
   },
   "author": "Marc Rousavy <me@mrousavy.com> (https://github.com/mrousavy)",
-  "license": "(MIT AND BSD-3-Clause)",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/mrousavy/react-native-mmkv/issues"
   },
@@ -68,111 +60,71 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@firmnav/eslint-github-actions-formatter": "1.0.1",
-    "@jamesacarr/eslint-formatter-github-actions": "0.2.0",
-    "@react-native-community/cli": "19.1.1",
-    "@react-native-community/cli-types": "18.0.0",
-    "@react-native/babel-preset": "^0.81.0",
+    "@expo/config-plugins": "^10.1.2",
     "@react-native/eslint-config": "0.81.0",
-    "@release-it/conventional-changelog": "9.0.1",
-    "@testing-library/react-native": "13.0.1",
-    "@types/jest": "29.5.13",
-    "@types/react": "19.1.01",
-    "del-cli": "6.0.0",
-    "eslint": "8.51.0",
-    "eslint-config-prettier": "9.0.0",
-    "eslint-plugin-prettier": "5.2.1",
-    "jest": "29.7.0",
-    "prettier": "3.3.3",
+    "@testing-library/react-native": "^13.3.1",
+    "@types/jest": "^29.5.12",
+    "@types/react": "^19.0.6",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "nitrogen": "^0.29.4",
+    "prettier": "^3.3.3",
     "react": "19.1.0",
     "react-native": "0.81.0",
-    "react-native-builder-bob": "0.37.0",
-    "react-test-renderer": "19.1.0",
-    "release-it": "17.10.0",
+    "react-native-nitro-modules": "^0.29.4",
     "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": "*",
+    "react-native-nitro-modules": "*"
   },
-  "jest": {
-    "preset": "react-native",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
-      "<rootDir>/lib/"
-    ]
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "warn",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
   },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
   "release-it": {
-    "git": {
-      "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
-    },
     "npm": {
       "publish": true
     },
+    "git": false,
     "github": {
-      "release": true
+      "release": false
     },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": {
-          "name": "conventionalcommits",
-          "types": [
-            {
-              "type": "feat",
-              "section": "✨ Features"
-            },
-            {
-              "type": "fix",
-              "section": "🐛 Bug Fixes"
-            },
-            {
-              "type": "perf",
-              "section": "💨 Performance Improvements"
-            },
-            {
-              "type": "chore(deps)",
-              "section": "🛠️ Dependency Upgrades"
-            },
-            {
-              "type": "docs",
-              "section": "📚 Documentation"
-            }
-          ]
-        }
-      }
+    "hooks": {
+      "before:init": "bun typecheck",
+      "after:bump": "bun run build"
     }
   },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/",
-    "MMKV"
-  ],
   "prettier": {
     "quoteProps": "consistent",
     "singleQuote": true,
     "tabWidth": 2,
     "trailingComma": "es5",
-    "useTabs": false
-  },
-  "react-native-builder-bob": {
-    "source": "src",
-    "output": "lib",
-    "targets": [
-      "commonjs",
-      "module",
-      [
-        "typescript",
-        {
-          "project": "tsconfig.json"
-        }
-      ]
-    ]
-  },
-  "codegenConfig": {
-    "name": "RNMmkvSpec",
-    "type": "modules",
-    "jsSrcsDir": "src"
-  },
-  "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
+    "useTabs": false,
+    "semi": false
+  }
 }

package/react-native.config.js

@@ -10,20 +10,7 @@ module.exports = {
       /**
        * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
        */
-      android: {
-        cxxModuleCMakeListsModuleName: 'react-native-mmkv',
-        cxxModuleCMakeListsPath: 'CMakeLists.txt',
-        cxxModuleHeaderName: 'NativeMmkvModule',
-      },
+      android: {},
     },
   },
-  // Codegen configuration for TurboModules
-  codegenConfig: {
-    name: 'RNMmkvSpec',
-    type: 'modules',
-    jsSrcsDir: 'src',
-    android: {
-      javaPackageName: 'com.mrousavy.mmkv',
-    },
-  },
-};
+}

package/src/__tests__/hooks.test.tsx

@@ -1,44 +1,49 @@
-import React from 'react';
-import { Button, Text } from 'react-native';
+import React from 'react'
+import { Button, Text } from 'react-native'
 import {
   act,
   fireEvent,
   render,
   renderHook,
   screen,
-} from '@testing-library/react-native';
-import { MMKV, useMMKVNumber, useMMKVString } from '..';
+  cleanup,
+} from '@testing-library/react-native'
+import { createMMKV, useMMKVNumber, useMMKVString } from '..'
 
-const mmkv = new MMKV();
+const mmkv = createMMKV()
 
 beforeEach(() => {
-  mmkv.clearAll();
-  mmkv.trim();
-});
+  mmkv.clearAll()
+  mmkv.trim()
+})
+
+afterEach(() => {
+  cleanup()
+})
 
 test('hooks update when the value is changed directly through the instance', () => {
-  const { result } = renderHook(() => useMMKVString('string-key', mmkv));
+  const { result } = renderHook(() => useMMKVString('string-key', mmkv))
 
-  expect(result.current[0]).toBeUndefined();
+  expect(result.current[0]).toBeUndefined()
 
   // First, make a "normal" change
   act(() => {
-    result.current[1]('value 1');
-  });
+    result.current[1]('value 1')
+  })
 
-  expect(result.current[0]).toStrictEqual('value 1');
+  expect(result.current[0]).toStrictEqual('value 1')
 
   // Now, make the change directly through the instance.
   act(() => {
-    mmkv.set('string-key', 'value 2');
-  });
-  expect(result.current[0]).toStrictEqual('value 2');
-});
+    mmkv.set('string-key', 'value 2')
+  })
+  expect(result.current[0]).toStrictEqual('value 2')
+})
 
 test('functional updates to hooks', () => {
   const Component: React.FC = () => {
-    const [state, setState] = React.useState(0);
-    const [value, setValue] = useMMKVNumber('number-key', mmkv);
+    const [state, setState] = React.useState(0)
+    const [value, setValue] = useMMKVNumber('number-key', mmkv)
 
     return (
       <>
@@ -47,43 +52,43 @@ test('functional updates to hooks', () => {
           title="Double Increment Me"
           onPress={() => {
             // Increment the state value twice, using the function form of useState.
-            setState((current) => current + 1);
-            setState((current) => current + 1);
+            setState((current) => current + 1)
+            setState((current) => current + 1)
 
             // Increment the MMKV value twice, using the same function form.
-            setValue((current) => (current ?? 0) + 1);
-            setValue((current) => (current ?? 0) + 1);
+            setValue((current) => (current ?? 0) + 1)
+            setValue((current) => (current ?? 0) + 1)
           }}
         />
         <Text testID="state-value">State: {state.toString()}</Text>
         <Text testID="mmkv-value">MMKV: {(value ?? 0).toString()}</Text>
       </>
-    );
-  };
+    )
+  }
 
-  render(<Component />);
+  render(<Component />)
 
-  const button = screen.getByTestId('button');
+  const button = screen.getByTestId('button')
 
   // Why these assertions:
   // https://github.com/mrousavy/react-native-mmkv/issues/599
-  fireEvent.press(button);
+  fireEvent.press(button)
   expect(screen.getByTestId('state-value').children).toStrictEqual([
     'State: ',
     '2',
-  ]);
+  ])
   expect(screen.getByTestId('mmkv-value').children).toStrictEqual([
     'MMKV: ',
     '2',
-  ]);
+  ])
 
-  fireEvent.press(button);
+  fireEvent.press(button)
   expect(screen.getByTestId('state-value').children).toStrictEqual([
     'State: ',
     '4',
-  ]);
+  ])
   expect(screen.getByTestId('mmkv-value').children).toStrictEqual([
     'MMKV: ',
     '4',
-  ]);
-});
+  ])
+})

package/src/addMemoryWarningListener/addMemoryWarningListener.mock.ts

@@ -0,0 +1,5 @@
+import type { MMKV } from '../specs/MMKV.nitro'
+
+export function addMemoryWarningListener(_mmkv: MMKV): void {
+  // This is no-op in a mocked environment.
+}

package/src/{MemoryWarningListener.ts → addMemoryWarningListener/addMemoryWarningListener.ts}

@@ -1,29 +1,29 @@
-import { AppState } from 'react-native';
-import type { NativeEventSubscription } from 'react-native';
-import { MMKVInterface } from './Types';
+import { AppState } from 'react-native'
+import type { NativeEventSubscription } from 'react-native'
+import type { MMKV } from '../specs/MMKV.nitro'
 
-export function addMemoryWarningListener(mmkv: MMKVInterface): void {
+export function addMemoryWarningListener(mmkv: MMKV): void {
   if (global.WeakRef != null && global.FinalizationRegistry != null) {
     // 1. Weakify MMKV so we can safely use it inside the memoryWarning event listener
-    const weakMmkv = new WeakRef(mmkv);
+    const weakMmkv = new WeakRef(mmkv)
     const listener = AppState.addEventListener('memoryWarning', () => {
       // 0. Everytime we receive a memoryWarning, we try to trim the MMKV instance (if it is still valid)
-      weakMmkv.deref()?.trim();
-    });
+      weakMmkv.deref()?.trim()
+    })
     // 2. Add a listener to when the MMKV instance is deleted
     const finalization = new FinalizationRegistry(
       (l: NativeEventSubscription) => {
         // 3. When MMKV is deleted, this listener will be called with the memoryWarning listener.
-        l.remove();
+        l.remove()
       }
-    );
+    )
     // 2.1. Bind the listener to the actual MMKV instance.
-    finalization.register(mmkv, listener);
+    finalization.register(mmkv, listener)
   } else {
     // WeakRef/FinalizationRegistry is not implemented in this engine.
     // Just add the listener, even if it retains MMKV strong forever.
     AppState.addEventListener('memoryWarning', () => {
-      mmkv.trim();
-    });
+      mmkv.trim()
+    })
   }
 }

package/src/addMemoryWarningListener/addMemoryWarningListener.web.ts

@@ -0,0 +1,5 @@
+import type { MMKV } from '../specs/MMKV.nitro'
+
+export const addMemoryWarningListener = (_mmkv: MMKV): void => {
+  //no-op function, there is not a web equivalent to memory warning
+}

package/src/createMMKV/createMMKV.ts

@@ -0,0 +1,51 @@
+import { NitroModules } from 'react-native-nitro-modules'
+import type { MMKV } from '../specs/MMKV.nitro'
+import type { Configuration, MMKVFactory } from '../specs/MMKVFactory.nitro'
+import type { MMKVPlatformContext } from '../specs/MMKVPlatformContext.nitro'
+import { Platform } from 'react-native'
+import { addMemoryWarningListener } from '../addMemoryWarningListener/addMemoryWarningListener'
+import { isTest } from '../isTest'
+import { createMockMMKV } from './createMockMMKV'
+
+let factory: MMKVFactory | undefined
+let platformContext: MMKVPlatformContext | undefined
+
+export function createMMKV(configuration?: Configuration): MMKV {
+  if (isTest()) {
+    // In a test environment, we mock the MMKV instance.
+    return createMockMMKV()
+  }
+
+  if (platformContext == null) {
+    // Lazy-init the platform-context HybridObject
+    platformContext = NitroModules.createHybridObject<MMKVPlatformContext>(
+      'MMKVPlatformContext'
+    )
+  }
+  if (factory == null) {
+    // Lazy-init the factory HybridObject
+    factory = NitroModules.createHybridObject<MMKVFactory>('MMKVFactory')
+    const baseDirectory = platformContext.getBaseDirectory()
+    factory.initializeMMKV(baseDirectory)
+  }
+
+  // Pre-parse the config
+  let config = configuration ?? { id: factory.defaultMMKVInstanceId }
+
+  if (Platform.OS === 'ios') {
+    if (config.path == null) {
+      // If the user set an App Group directory in Info.plist, let's use
+      // the App Group as a MMKV path:
+      const appGroupDirectory = platformContext.getAppGroupDirectory()
+      if (appGroupDirectory != null) {
+        config.path = appGroupDirectory
+      }
+    }
+  }
+
+  // Creates the C++ MMKV HybridObject
+  const mmkv = factory.createMMKV(config)
+  // Add a hook that trims the storage when we get a memory warning
+  addMemoryWarningListener(mmkv)
+  return mmkv
+}