react-native-mmkv 3.0.2 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-mmkv",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "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",
@@ -26,9 +26,7 @@
     "src",
     "react-native-mmkv.podspec",
     "react-native.config.js",
-    "../README.md",
-    "img/banner-light.png",
-    "img/banner-dark.png"
+    "README.md"
   ],
   "scripts": {
     "typescript": "tsc --noEmit",
@@ -74,23 +72,23 @@
   "devDependencies": {
     "@firmnav/eslint-github-actions-formatter": "^1.0.1",
     "@jamesacarr/eslint-formatter-github-actions": "^0.2.0",
-    "@react-native-community/cli-types": "^14.0.1",
-    "@react-native/eslint-config": "^0.75.2",
-    "@release-it/conventional-changelog": "^8.0.1",
-    "@testing-library/react-native": "^12.6.1",
-    "@types/jest": "^29.5.5",
-    "@types/react": "^18.3.4",
-    "del-cli": "^5.1.0",
+    "@react-native-community/cli-types": "^14.1.1",
+    "@react-native/eslint-config": "^0.75.4",
+    "@release-it/conventional-changelog": "^9.0.1",
+    "@testing-library/react-native": "^12.7.2",
+    "@types/jest": "^29.5.13",
+    "@types/react": "^18.3.11",
+    "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",
     "react": "^18.3.1",
-    "react-native": "^0.75.2",
-    "react-native-builder-bob": "^0.30.0",
+    "react-native": "^0.75.4",
+    "react-native-builder-bob": "^0.30.2",
     "react-test-renderer": "18.3.1",
-    "release-it": "^17.6.0",
+    "release-it": "^17.10.0",
     "typescript": "^5.5.4"
   },
   "resolutions": {

package/react-native-mmkv.podspec

@@ -14,7 +14,7 @@ Pod::Spec.new do |s|
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => min_ios_version_supported }
+  s.platforms    = { :ios => min_ios_version_supported, :tvos => "12.0", :osx => "10.14" }
   s.source       = { :git => "https://github.com/mrousavy/react-native-mmkv.git", :tag => "#{s.version}" }
 
   s.pod_target_xcconfig = {

package/src/MMKV.ts

@@ -1,9 +1,9 @@
-import { AppState } from 'react-native';
 import { createMMKV } from './createMMKV';
 import { createMockMMKV } from './createMMKV.mock';
 import { isTest } from './PlatformChecker';
 import type { Configuration } from './NativeMmkv';
 import type { Listener, MMKVInterface, NativeMMKV } from './Types';
+import { addMemoryWarningListener } from './MemoryWarningListener';
 
 const onValueChangedListeners = new Map<string, ((key: string) => void)[]>();
 
@@ -26,10 +26,7 @@ export class MMKV implements MMKVInterface {
       : createMMKV(configuration);
     this.functionCache = {};
 
-    AppState.addEventListener('memoryWarning', () => {
-      // when we have a memory warning, delete unused keys by trimming MMKV
-      this.trim();
-    });
+    addMemoryWarningListener(this);
   }
 
   private get onValueChangedListeners() {
@@ -61,6 +58,9 @@ export class MMKV implements MMKVInterface {
   get size(): number {
     return this.nativeInstance.size;
   }
+  get isReadOnly(): boolean {
+    return this.nativeInstance.isReadOnly;
+  }
   set(key: string, value: boolean | string | number | ArrayBuffer): void {
     const func = this.getFunctionFromCache('set');
     func(key, value);

package/src/MemoryWarningListener.ts

@@ -0,0 +1,29 @@
+import { AppState } from 'react-native';
+import type { NativeEventSubscription } from 'react-native';
+import { MMKVInterface } from './Types';
+
+export function addMemoryWarningListener(mmkv: MMKVInterface): 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 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();
+    });
+    // 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();
+      }
+    );
+    // 2.1. Bind the listener to the actual MMKV instance.
+    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();
+    });
+  }
+}

package/src/NativeMmkv.ts

@@ -70,6 +70,10 @@ export interface Configuration {
    * @default SINGLE_PROCESS
    */
   mode?: Mode;
+  /**
+   * If `true`, the MMKV instance can only read from the storage, but not write to it.
+   */
+  readOnly?: boolean;
 }
 
 export interface Spec extends TurboModule {
@@ -85,23 +89,23 @@ export interface Spec extends TurboModule {
   createMMKV(configuration: Configuration): UnsafeObject;
 }
 
-let module: Spec | null;
+let mmkvModule: Spec | null;
 
 export function getMMKVTurboModule(): Spec {
   try {
-    if (module == null) {
+    if (mmkvModule == null) {
       // 1. Load MMKV TurboModule
-      module = TurboModuleRegistry.getEnforcing<Spec>('MmkvCxx');
+      mmkvModule = TurboModuleRegistry.getEnforcing<Spec>('MmkvCxx');
 
       // 2. Get the PlatformContext TurboModule as well
       const platformContext = getMMKVPlatformContextTurboModule();
 
       // 3. Initialize it with the documents directory from platform-specific context
       const basePath = platformContext.getBaseDirectory();
-      module.initialize(basePath);
+      mmkvModule.initialize(basePath);
     }
 
-    return module;
+    return mmkvModule;
   } catch (cause) {
     // TurboModule could not be found!
     throw new ModuleNotFoundError(cause);

package/src/NativeMmkvPlatformContext.ts

@@ -20,15 +20,17 @@ export interface Spec extends TurboModule {
   getAppGroupDirectory(): string | undefined;
 }
 
-let module: Spec | null;
+let mmkvPlatformModule: Spec | null;
 
 export function getMMKVPlatformContextTurboModule(): Spec {
   try {
-    if (module == null) {
+    if (mmkvPlatformModule == null) {
       // 1. Get the TurboModule
-      module = TurboModuleRegistry.getEnforcing<Spec>('MmkvPlatformContext');
+      mmkvPlatformModule = TurboModuleRegistry.getEnforcing<Spec>(
+        'MmkvPlatformContext'
+      );
     }
-    return module;
+    return mmkvPlatformModule;
   } catch (e) {
     // TurboModule could not be found!
     throw new ModuleNotFoundError(e);

package/src/Types.ts

@@ -74,6 +74,11 @@ export interface NativeMMKV {
    * Get the current total size of the storage, in bytes.
    */
   readonly size: number;
+  /**
+   * Returns whether this instance is in read-only mode or not.
+   * If this is `true`, you can only use "get"-functions.
+   */
+  readonly isReadOnly: boolean;
 }
 
 export interface Listener {

package/src/createMMKV.mock.ts

@@ -30,6 +30,7 @@ export const createMockMMKV = (): NativeMMKV => {
       console.warn('Encryption is not supported in mocked MMKV instances!');
     },
     size: 0,
+    isReadOnly: false,
     trim: () => {
       // no-op
     },

package/src/createMMKV.ts

@@ -1,5 +1,5 @@
 import { Platform } from 'react-native';
-import { getMMKVTurboModule, type Configuration } from './NativeMmkv';
+import { getMMKVTurboModule, Mode, type Configuration } from './NativeMmkv';
 import type { NativeMMKV } from './Types';
 import { getMMKVPlatformContextTurboModule } from './NativeMmkvPlatformContext';
 
@@ -23,6 +23,13 @@ export const createMMKV = (config: Configuration): NativeMMKV => {
     }
   }
 
+  if (typeof config.mode === 'number') {
+    // Code-gen expects enums to be strings. In TS, they might be numbers tho.
+    // This sucks, so we need a workaround.
+    // @ts-expect-error the native side actually expects a string.
+    config.mode = Mode[config.mode];
+  }
+
   const instance = module.createMMKV(config);
   if (__DEV__) {
     if (typeof instance !== 'object' || instance == null) {

package/src/createMMKV.web.ts

@@ -120,6 +120,7 @@ export const createMMKV = (config: Configuration): NativeMMKV => {
       throw new Error('`recrypt(..)` is not supported on Web!');
     },
     size: 0,
+    isReadOnly: false,
     trim: () => {
       // no-op
     },