react-native-mmkv 2.12.2 → 3.0.0-beta.2

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "react-native-mmkv",
-  "version": "2.12.2",
+  "version": "3.0.0-beta.2",
   "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/index.d.ts",
-  "react-native": "lib/module/index",
+  "types": "lib/typescript/src/index.d.ts",
+  "react-native": "src/index",
   "source": "src/index",
   "files": [
+    "cpp/**/*.h",
+    "cpp/**/*.cpp",
+    "MMKV/Core",
     "android/src",
     "android/build.gradle",
-    "android/gradle.properties",
     "android/CMakeLists.txt",
-    "cpp",
-    "MMKV/Core",
+    "android/cpp-adapter.cpp",
+    "android/gradle.properties",
     "lib/commonjs",
     "lib/module",
     "lib/typescript",
@@ -21,9 +23,9 @@
     "ios/**/*.m",
     "ios/**/*.mm",
     "ios/**/*.cpp",
-    "ios/Mmkv.xcodeproj/project.pbxproj",
     "src",
     "react-native-mmkv.podspec",
+    "react-native.config.js",
     "README.md",
     "img/banner-light.png",
     "img/banner-dark.png"
@@ -34,21 +36,32 @@
     "lint-ci": "yarn lint -f ./node_modules/@firmnav/eslint-github-actions-formatter/dist/formatter.js",
     "lint-cpp": "scripts/clang-format.sh",
     "test": "jest",
+    "typecheck": "tsc --noEmit",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
     "prepare": "git submodule update --init --recursive && bob build",
     "prepack": "bob build",
     "update-submodule": "git submodule update --remote --merge",
-    "release": "release-it",
-    "example": "yarn --cwd example",
     "pods": "cd example && yarn pods",
-    "bootstrap": "git submodule update --init --recursive && yarn && cd example && yarn bootstrap"
+    "release": "release-it",
+    "codegen": "npx react-native codegen"
   },
   "keywords": [
     "react-native",
     "ios",
-    "android"
+    "android",
+    "mmkv",
+    "storage",
+    "key",
+    "value",
+    "fast",
+    "turbo",
+    "async"
   ],
-  "repository": "https://github.com/mrousavy/react-native-mmkv",
-  "author": "Marc Rousavy <marcrousavy@hotmail.com> (https://github.com/mrousavy)",
+  "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)",
   "bugs": {
     "url": "https://github.com/mrousavy/react-native-mmkv/issues"
@@ -58,33 +71,34 @@
     "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/eslint-config": "^3.2.0",
-    "@react-native-community/eslint-plugin": "^1.3.0",
+    "@react-native-community/cli-types": "^13.6.6",
+    "@react-native/eslint-config": "^0.74.81",
     "@release-it/conventional-changelog": "^8.0.1",
     "@testing-library/react-native": "^12.4.3",
-    "@tsconfig/react-native": "^3.0.3",
-    "@types/jest": "^29.5.12",
-    "@types/react": "^18.2.55",
-    "@types/react-test-renderer": "^18.0.7",
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
-    "eslint": "^8.56.0",
-    "eslint-plugin-ft-flow": "^3.0.4",
-    "eslint-plugin-jest": "^27.8.0",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^18.3.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
-    "metro-react-native-babel-preset": "^0.77.0",
-    "prettier": "^3.2.5",
-    "react": "^18.2.0",
-    "react-native": "^0.71.6",
-    "react-native-builder-bob": "^0.20.4",
-    "react-test-renderer": "^18.2.0",
-    "release-it": "^15.10.1",
-    "typescript": "^5.3.3"
+    "prettier": "^3.0.3",
+    "react": "18.3.1",
+    "react-native": "0.74.0",
+    "react-native-builder-bob": "^0.23.2",
+    "react-test-renderer": "18.3.1",
+    "release-it": "^17.2.1",
+    "typescript": "^5.4.5"
+  },
+  "resolutions": {
+    "@types/react": "^18.2.44",
+    "@react-native-community/cli": "^14.0.0-alpha.2"
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": ">=0.71.0"
+    "react-native": "*"
   },
   "jest": {
     "preset": "react-native",
@@ -137,12 +151,9 @@
   "eslintConfig": {
     "root": true,
     "extends": [
-      "@react-native-community",
+      "@react-native",
       "prettier"
     ],
-    "plugins": [
-      "jest"
-    ],
     "rules": {
       "prettier/prettier": [
         "error",
@@ -182,8 +193,9 @@
     ]
   },
   "codegenConfig": {
-    "name": "reactnativemmkv",
+    "name": "RNMmkvSpec",
     "type": "modules",
-    "jsSrcsDir": "./lib/module"
-  }
+    "jsSrcsDir": "src"
+  },
+  "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
 }

package/react-native-mmkv.podspec

@@ -1,6 +1,7 @@
 require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
 
 Pod::Spec.new do |s|
   s.name         = "react-native-mmkv"
@@ -10,27 +11,25 @@ Pod::Spec.new do |s|
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => "11.0", :tvos => "12.0", :osx => "10.14" }
+  s.platforms    = { :ios => min_ios_version_supported }
   s.source       = { :git => "https://github.com/mrousavy/react-native-mmkv.git", :tag => "#{s.version}" }
 
-  # All source files that should be publicly visible
-  # Note how this does not include headers, since those can nameclash.
+  s.pod_target_xcconfig = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++17",
+    "CLANG_CXX_LIBRARY" => "libc++",
+    "CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF" => "NO",
+    # FORCE_POSIX ensures we are using C++ types instead of Objective-C types for MMKV.
+    "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited) FORCE_POSIX",
+  }
+  s.compiler_flags = '-x objective-c++'
+
   s.source_files = [
-    "ios/**/*.{m,mm}",
-    "ios/MmkvModule.h",
-    "cpp/**/*.{h,cpp}"
-  ]
-  # Any private headers that are not globally unique should be mentioned here.
-  # Otherwise there will be a nameclash, since CocoaPods flattens out any header directories
-  # See https://github.com/firebase/firebase-ios-sdk/issues/4035 for more details.
-  s.preserve_paths = [
-    'ios/**/*.h'
+    # react-native-mmkv
+    "ios/**/*.{h,m,mm}",
+    "cpp/**/*.{hpp,cpp,c,h}",
+    # MMKV/Core
+    "MMKV/Core/**/*.{h,cpp,hpp,S}",
   ]
 
-  s.dependency "MMKV", ">= 1.3.3"
-  if respond_to?(:install_modules_dependencies, true)
-    install_modules_dependencies(s)
-  else
-    s.dependency "React-Core"
-  end
+  install_modules_dependencies(s)
 end

package/react-native.config.js

@@ -0,0 +1,20 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {
+        cxxModuleCMakeListsModuleName: 'react-native-mmkv',
+        cxxModuleCMakeListsPath: `${__dirname}/android/CMakeLists.txt`,
+        cxxModuleHeaderName: 'NativeMmkvModule',
+      },
+    },
+  },
+};

package/src/LazyTurboModule.ts

@@ -0,0 +1,62 @@
+import { NativeModules, Platform, TurboModule } from 'react-native';
+
+interface ModuleHolder<T> {
+  module: T | null;
+}
+
+/**
+ * Lazily get a TurboModule by wrapping it in a Proxy.
+ */
+export function getLazyTurboModule<T extends TurboModule>(
+  initializeTurboModule: () => T | null
+): T {
+  const proxy = new Proxy<ModuleHolder<T>>(
+    {
+      module: null,
+    },
+    {
+      get: (target, property) => {
+        if (target.module == null) {
+          // Target is null, let's initialize it!
+          target.module = initializeTurboModule();
+
+          if (target.module == null) {
+            // TurboModule not found, something went wrong!
+            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.NativeUnimoduleProxy?.modulesConstants
+                ?.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);
+          }
+        }
+
+        return target.module[property as keyof T];
+      },
+    }
+  );
+  return proxy as unknown as T;
+}

package/src/MMKV.ts

@@ -1,135 +1,10 @@
+import { AppState } from 'react-native';
 import { createMMKV } from './createMMKV';
 import { createMockMMKV } from './createMMKV.mock';
 import { isJest } from './PlatformChecker';
-
-interface Listener {
-  remove: () => void;
-}
-
-/**
- * Used for configuration of a single MMKV instance.
- */
-export interface MMKVConfiguration {
-  /**
-   * The MMKV instance's ID. If you want to use multiple instances, make sure to use different IDs!
-   *
-   * @example
-   * ```ts
-   * const userStorage = new MMKV({ id: `user-${userId}-storage` })
-   * const globalStorage = new MMKV({ id: 'global-app-storage' })
-   * ```
-   *
-   * @default 'mmkv.default'
-   */
-  id: string;
-  /**
-   * The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization:
-
-   * @example
-   * ```ts
-   * const temporaryStorage = new MMKV({ path: '/tmp/' })
-   * ```
-   * 
-   * _Notice_: On iOS you can set the AppGroup bundle property to share the same storage between your app and its extensions. 
-   * In this case `path` property will be ignored.
-   * See more on MMKV configuration [here](https://github.com/Tencent/MMKV/wiki/iOS_tutorial#configuration).
-   */
-  path?: string;
-  /**
-   * 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.
-   *
-   * Encryption keys can have a maximum length of 16 bytes.
-   *
-   * @example
-   * ```ts
-   * const secureStorage = new MMKV({ encryptionKey: 'my-encryption-key!' })
-   * ```
-   */
-  encryptionKey?: string;
-}
-
-/**
- * Represents a single MMKV instance.
- */
-interface MMKVInterface {
-  /**
-   * Set a value for the given `key`.
-   */
-  set: (key: string, value: boolean | string | number | Uint8Array) => void;
-  /**
-   * Get the boolean value for the given `key`, or `undefined` if it does not exist.
-   *
-   * @default undefined
-   */
-  getBoolean: (key: string) => boolean | undefined;
-  /**
-   * Get the string value for the given `key`, or `undefined` if it does not exist.
-   *
-   * @default undefined
-   */
-  getString: (key: string) => string | undefined;
-  /**
-   * Get the number value for the given `key`, or `undefined` if it does not exist.
-   *
-   * @default undefined
-   */
-  getNumber: (key: string) => number | undefined;
-  /**
-   * Get a raw buffer of unsigned 8-bit (0-255) data.
-   *
-   * @default undefined
-   */
-  getBuffer: (key: string) => Uint8Array | undefined;
-  /**
-   * Checks whether the given `key` is being stored in this MMKV instance.
-   */
-  contains: (key: string) => boolean;
-  /**
-   * Delete the given `key`.
-   */
-  delete: (key: string) => void;
-  /**
-   * Get all keys.
-   *
-   * @default []
-   */
-  getAllKeys: () => string[];
-  /**
-   * Delete all keys.
-   */
-  clearAll: () => void;
-  /**
-   * Sets (or updates) the encryption-key to encrypt all data in this MMKV instance with.
-   *
-   * To remove encryption, pass `undefined` as a key.
-   *
-   * Encryption keys can have a maximum length of 16 bytes.
-   */
-  recrypt: (key: string | undefined) => void;
-  /**
-   * Adds a value changed listener. The Listener will be called whenever any value
-   * in this storage instance changes (set or delete).
-   *
-   * To unsubscribe from value changes, call `remove()` on the Listener.
-   */
-  addOnValueChangedListener: (
-    onValueChanged: (key: string) => void
-  ) => Listener;
-}
-
-export type NativeMMKV = Pick<
-  MMKVInterface,
-  | 'clearAll'
-  | 'contains'
-  | 'delete'
-  | 'getAllKeys'
-  | 'getBoolean'
-  | 'getNumber'
-  | 'getString'
-  | 'getBuffer'
-  | 'set'
-  | 'recrypt'
->;
+import { Configuration } from './NativeMmkv';
+import { Listener, MMKVInterface, NativeMMKV } from './Types';
+export { Configuration, Mode } from './NativeMmkv';
 
 const onValueChangedListeners = new Map<string, ((key: string) => void)[]>();
 
@@ -145,12 +20,17 @@ export class MMKV implements MMKVInterface {
    * Creates a new MMKV instance with the given Configuration.
    * If no custom `id` is supplied, `'mmkv.default'` will be used.
    */
-  constructor(configuration: MMKVConfiguration = { id: 'mmkv.default' }) {
+  constructor(configuration: Configuration = { id: 'mmkv.default' }) {
     this.id = configuration.id;
     this.nativeInstance = isJest()
       ? createMockMMKV()
       : createMMKV(configuration);
     this.functionCache = {};
+
+    AppState.addEventListener('memoryWarning', () => {
+      // when we have a memory warning, delete unused keys by trimming MMKV
+      this.trim();
+    });
   }
 
   private get onValueChangedListeners() {
@@ -179,7 +59,10 @@ export class MMKV implements MMKVInterface {
     }
   }
 
-  set(key: string, value: boolean | string | number | Uint8Array): void {
+  get size(): number {
+    return this.nativeInstance.size;
+  }
+  set(key: string, value: boolean | string | number | ArrayBuffer): void {
     const func = this.getFunctionFromCache('set');
     func(key, value);
 
@@ -197,7 +80,7 @@ export class MMKV implements MMKVInterface {
     const func = this.getFunctionFromCache('getNumber');
     return func(key);
   }
-  getBuffer(key: string): Uint8Array | undefined {
+  getBuffer(key: string): ArrayBuffer | undefined {
     const func = this.getFunctionFromCache('getBuffer');
     return func(key);
   }
@@ -227,6 +110,10 @@ export class MMKV implements MMKVInterface {
     const func = this.getFunctionFromCache('recrypt');
     return func(key);
   }
+  trim(): void {
+    const func = this.getFunctionFromCache('trim');
+    func();
+  }
 
   toString(): string {
     return `MMKV (${this.id}): [${this.getAllKeys().join(', ')}]`;

package/src/NativeMmkv.ts

@@ -0,0 +1,105 @@
+import { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+import { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
+import { getLazyTurboModule } from './LazyTurboModule';
+import { PlatformContext } from './NativeMmkvPlatformContext';
+
+/**
+ * Configures the mode of the MMKV instance.
+ */
+export enum Mode {
+  /**
+   * The MMKV instance is only used from a single process (this app).
+   */
+  SINGLE_PROCESS,
+  /**
+   * The MMKV instance may be used from multiple processes, such as app clips, share extensions or background services.
+   */
+  MULTI_PROCESS,
+}
+
+/**
+ * Used for configuration of a single MMKV instance.
+ */
+export interface Configuration {
+  /**
+   * The MMKV instance's ID. If you want to use multiple instances, make sure to use different IDs!
+   *
+   * @example
+   * ```ts
+   * const userStorage = new MMKV({ id: `user-${userId}-storage` })
+   * const globalStorage = new MMKV({ id: 'global-app-storage' })
+   * ```
+   *
+   * @default 'mmkv.default'
+   */
+  id: string;
+  /**
+   * The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization:
+
+   * @example
+   * ```ts
+   * const temporaryStorage = new MMKV({ path: '/tmp/' })
+   * ```
+   *
+   * _Notice_: On iOS you can set the AppGroup bundle property to share the same storage between your app and its extensions.
+   * In this case `path` property will be ignored.
+   * See more on MMKV configuration [here](https://github.com/Tencent/MMKV/wiki/iOS_tutorial#configuration).
+   *
+   * @default undefined
+   */
+  path?: string;
+  /**
+   * 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.
+   *
+   * Encryption keys can have a maximum length of 16 bytes.
+   *
+   * @example
+   * ```ts
+   * const secureStorage = new MMKV({ encryptionKey: 'my-encryption-key!' })
+   * ```
+   *
+   * @default undefined
+   */
+  encryptionKey?: string;
+  /**
+   * Configure the processing mode for MMKV.
+   * - `SINGLE_PROCESS`: The MMKV instance is only used from a single process (this app).
+   * - `MULTI_PROCESS`: The MMKV instance may be used from multiple processes, such as app clips, share extensions or background services.
+   *
+   * @default SINGLE_PROCESS
+   */
+  mode?: Mode;
+}
+
+export interface Spec extends TurboModule {
+  /**
+   * Initialize MMKV with the given base storage directory.
+   * This should be the documents directory by default.
+   */
+  initialize(basePath: string): boolean;
+  /**
+   * Create a new instance of MMKV.
+   * The returned {@linkcode UnsafeObject} is a `jsi::HostObject`.
+   */
+  createMMKV(configuration: Configuration): UnsafeObject;
+}
+
+let basePath: string | null = null;
+
+function getNativeModule(): Spec | null {
+  if (basePath == null) {
+    // use default base path from the Platform (iOS/Android)
+    basePath = PlatformContext.getBaseDirectory();
+  }
+
+  const module = TurboModuleRegistry.get<Spec>('MmkvCxx');
+
+  if (module != null) {
+    // initialize MMKV
+    module.initialize(basePath);
+  }
+
+  return module;
+}
+export const MMKVTurboModule = getLazyTurboModule(getNativeModule);

package/src/NativeMmkvPlatformContext.ts

@@ -0,0 +1,14 @@
+import { TurboModule, TurboModuleRegistry } from 'react-native';
+import { getLazyTurboModule } from './LazyTurboModule';
+
+export interface Spec extends TurboModule {
+  /**
+   * Gets the base directory of the documents storage
+   */
+  getBaseDirectory(): string;
+}
+
+function getModule(): Spec | null {
+  return TurboModuleRegistry.get<Spec>('MmkvPlatformContext');
+}
+export const PlatformContext = getLazyTurboModule(getModule);