react-native-mmkv 3.0.0-beta.6 → 3.0.0-beta.7

package/src/NativeMmkv.ts

@@ -42,9 +42,9 @@ export interface Configuration {
    * 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).
+   * @note On iOS, if an `AppGroup` is set in `Info.plist` and `path` is `undefined`, MMKV will use the `AppGroup` directory.
+   * App Groups allow you to share MMKV storage between apps, widgets and extensions within the same AppGroup bundle.
+   * For more information, see [the `Configuration` section](https://github.com/Tencent/MMKV/wiki/iOS_tutorial#configuration).
    *
    * @default undefined
    */

package/src/NativeMmkvPlatformContext.ts

@@ -7,6 +7,17 @@ export interface Spec extends TurboModule {
    * Gets the base directory of the documents storage
    */
   getBaseDirectory(): string;
+  /**
+   * Get the App Group directory if it exists, or `undefined` otherwise.
+   *
+   * The App Group directory will be used instead of a custom path to use the same
+   * MMKV instance between the iOS app, Widgets, and other companion apps.
+   *
+   * To set an App Group, add a `AppGroup` field to `Info.plist`
+   *
+   * @platform ios
+   */
+  getAppGroupDirectory(): string | undefined;
 }
 
 let module: Spec | null;

package/src/Types.ts

@@ -4,6 +4,8 @@
 export interface NativeMMKV {
   /**
    * Set a value for the given `key`.
+   *
+   * @throws an Error if the value cannot be set.
    */
   set: (key: string, value: boolean | string | number | ArrayBuffer) => void;
   /**
@@ -54,6 +56,8 @@ export interface NativeMMKV {
    * To remove encryption, pass `undefined` as a key.
    *
    * Encryption keys can have a maximum length of 16 bytes.
+   *
+   * @throws an Error if the instance cannot be recrypted.
    */
   recrypt: (key: string | undefined) => void;
   /**

package/src/createMMKV.ts

@@ -1,10 +1,28 @@
-import type { Configuration } from './MMKV';
-import { getMMKVTurboModule } from './NativeMmkv';
+import { Platform } from 'react-native';
+import { getMMKVTurboModule, type Configuration } from './NativeMmkv';
 import type { NativeMMKV } from './Types';
+import { getMMKVPlatformContextTurboModule } from './NativeMmkvPlatformContext';
 
 export const createMMKV = (config: Configuration): NativeMMKV => {
   const module = getMMKVTurboModule();
 
+  if (Platform.OS === 'ios') {
+    if (config.path == null) {
+      try {
+        // If no `path` was supplied, we check if an `AppGroup` was set in Info.plist
+        const appGroupDirectory =
+          getMMKVPlatformContextTurboModule().getAppGroupDirectory();
+        if (appGroupDirectory != null) {
+          // If we have an `AppGroup` in Info.plist, use that as a path.
+          config.path = appGroupDirectory;
+        }
+      } catch (e) {
+        // We cannot throw errors here because it is a sync C++ TurboModule func. idk why.
+        console.error(e);
+      }
+    }
+  }
+
   const instance = module.createMMKV(config);
   if (__DEV__) {
     if (typeof instance !== 'object' || instance == null) {

package/src/createMMKV.web.ts

@@ -1,5 +1,5 @@
 /* global localStorage */
-import type { Configuration } from './MMKV';
+import type { Configuration } from './NativeMmkv';
 import type { NativeMMKV } from './Types';
 import { createTextEncoder } from './createTextEncoder';
 

package/src/hooks.ts

@@ -1,6 +1,6 @@
 import { useRef, useState, useMemo, useCallback, useEffect } from 'react';
-import type { Configuration } from './MMKV';
 import { MMKV } from './MMKV';
+import type { Configuration } from './NativeMmkv';
 
 function isConfigurationEqual(
   left?: Configuration,

package/android/src/main/cpp/cpp-adapter.cpp

@@ -1,7 +0,0 @@
-#include <jni.h>
-
-extern "C" JNIEXPORT jdouble JNICALL Java_com_mmkv_MmkvModule_nativeMultiply(JNIEnv* env,
-                                                                             jclass type, jdouble a,
-                                                                             jdouble b) {
-  return 5.0;
-}