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

package/src/hooks/useMMKVListener.ts

@@ -0,0 +1,33 @@
+import { useEffect, useRef } from 'react'
+import type { MMKV } from '../specs/MMKV.nitro'
+import { getDefaultMMKVInstance } from '../createMMKV/getDefaultMMKVInstance'
+
+/**
+ * Listen for changes in the given MMKV storage instance.
+ * If no instance is passed, the default instance will be used.
+ * @param valueChangedListener The function to call whenever a value inside the storage instance changes
+ * @param instance The instance to listen to changes to (or the default instance)
+ *
+ * @example
+ * ```ts
+ * useMMKVListener((key) => {
+ *   console.log(`Value for "${key}" changed!`)
+ * })
+ * ```
+ */
+export function useMMKVListener(
+  valueChangedListener: (key: string) => void,
+  instance?: MMKV
+): void {
+  const ref = useRef(valueChangedListener)
+  ref.current = valueChangedListener
+
+  const mmkv = instance ?? getDefaultMMKVInstance()
+
+  useEffect(() => {
+    const listener = mmkv.addOnValueChangedListener((changedKey) => {
+      ref.current(changedKey)
+    })
+    return () => listener.remove()
+  }, [mmkv])
+}

package/src/hooks/useMMKVNumber.ts

@@ -0,0 +1,15 @@
+import { createMMKVHook } from './createMMKVHook'
+
+/**
+ * Use the number value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [age, setAge] = useMMKVNumber("user.age")
+ * ```
+ */
+export const useMMKVNumber = createMMKVHook((instance, key) =>
+  instance.getNumber(key)
+)

package/src/hooks/useMMKVObject.ts

@@ -0,0 +1,53 @@
+import { useCallback, useMemo } from 'react'
+import type { MMKV } from '../specs/MMKV.nitro'
+import { useMMKVString } from './useMMKVString'
+
+/**
+ * Use an object value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * The object will be serialized using `JSON`.
+ *
+ * @example
+ * ```ts
+ * const [user, setUser] = useMMKVObject<User>("user")
+ * ```
+ */
+export function useMMKVObject<T>(
+  key: string,
+  instance?: MMKV
+): [
+  value: T | undefined,
+  setValue: (
+    value: T | undefined | ((prevValue: T | undefined) => T | undefined)
+  ) => void,
+] {
+  const [json, setJson] = useMMKVString(key, instance)
+
+  const value = useMemo(() => {
+    if (json == null) return undefined
+    return JSON.parse(json) as T
+  }, [json])
+
+  const setValue = useCallback(
+    (v: (T | undefined) | ((prev: T | undefined) => T | undefined)) => {
+      if (v instanceof Function) {
+        setJson((currentJson) => {
+          const currentValue =
+            currentJson != null ? (JSON.parse(currentJson) as T) : undefined
+          const newValue = v(currentValue)
+          // Store the Object as a serialized Value or clear the value
+          return newValue != null ? JSON.stringify(newValue) : undefined
+        })
+      } else {
+        // Store the Object as a serialized Value or clear the value
+        const newValue = v != null ? JSON.stringify(v) : undefined
+        setJson(newValue)
+      }
+    },
+    [setJson]
+  )
+
+  return [value, setValue]
+}

package/src/hooks/useMMKVString.ts

@@ -0,0 +1,15 @@
+import { createMMKVHook } from './createMMKVHook'
+
+/**
+ * Use the string value of the given `key` from the given MMKV storage instance.
+ *
+ * If no instance is provided, a shared default instance will be used.
+ *
+ * @example
+ * ```ts
+ * const [username, setUsername] = useMMKVString("user.name")
+ * ```
+ */
+export const useMMKVString = createMMKVHook((instance, key) =>
+  instance.getString(key)
+)

package/src/index.ts

@@ -1,4 +1,16 @@
-export * from './MMKV';
-export * from './hooks';
+// All types
+export type { MMKV } from './specs/MMKV.nitro'
+export type { Configuration, Mode } from './specs/MMKVFactory.nitro'
 
-export { Mode, type Configuration } from './Types';
+// The create function
+export { createMMKV } from './createMMKV/createMMKV'
+
+// All the hooks
+export { useMMKV } from './hooks/useMMKV'
+export { useMMKVBoolean } from './hooks/useMMKVBoolean'
+export { useMMKVBuffer } from './hooks/useMMKVBuffer'
+export { useMMKVNumber } from './hooks/useMMKVNumber'
+export { useMMKVObject } from './hooks/useMMKVObject'
+export { useMMKVString } from './hooks/useMMKVString'
+export { useMMKVListener } from './hooks/useMMKVListener'
+export { useMMKVKeys } from './hooks/useMMKVKeys'

package/src/{PlatformChecker.ts → isTest.ts}

@@ -1,9 +1,9 @@
 export function isTest(): boolean {
   if (global.process == null) {
     // In a WebBrowser/Electron the `process` variable does not exist
-    return false;
+    return false
   }
   return (
     process.env.JEST_WORKER_ID != null || process.env.VITEST_WORKER_ID != null
-  );
+  )
 }

package/src/specs/MMKV.nitro.ts

@@ -0,0 +1,92 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+
+export interface Listener {
+  remove: () => void
+}
+
+export interface MMKV extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  /**
+   * 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
+  /**
+   * 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): ArrayBuffer | undefined
+  /**
+   * Checks whether the given `key` is being stored in this MMKV instance.
+   */
+  contains(key: string): boolean
+  /**
+   * Removes the given `key`.
+   */
+  remove(key: string): void
+  /**
+   * Get all keys.
+   *
+   * @default []
+   */
+  getAllKeys(): string[]
+  /**
+   * Clears all keys/values.
+   */
+  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.
+   *
+   * @throws an Error if the instance cannot be recrypted.
+   */
+  recrypt(key: string | undefined): void
+  /**
+   * Trims the storage space and clears memory cache.
+   *
+   * Since MMKV does not resize itself after deleting keys, you can call `trim()`
+   * after deleting a bunch of keys to manually trim the memory- and
+   * disk-file to reduce storage and memory usage.
+   *
+   * In most applications, this is not needed at all.
+   */
+  trim(): void
+  /**
+   * 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
+  /**
+   * 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
+}

package/src/specs/MMKVFactory.nitro.ts

@@ -0,0 +1,87 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { MMKV } from './MMKV.nitro'
+
+/**
+ * Configures the mode of the MMKV instance.
+ * - `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.
+ */
+export type Mode = 'single-process' | '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/' })
+   * ```
+   *
+   * @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
+   */
+  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.
+   *
+   * @default 'single-process'
+   */
+  mode?: Mode
+  /**
+   * If `true`, the MMKV instance can only read from the storage, but not write to it.
+   * This is more efficient if you do not need to write to it.
+   * @default false
+   */
+  readOnly?: boolean
+}
+
+export interface MMKVFactory
+  extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  /**
+   * Create a new {@linkcode MMKV} instance with the given {@linkcode Configuration}
+   */
+  createMMKV(configuration: Configuration): MMKV
+
+  /**
+   * Initialize the MMKV library with the given root path.
+   * This has to be called once, before using {@linkcode createMMKV}.
+   */
+  initializeMMKV(rootPath: string): void
+
+  /**
+   * Get the default MMKV instance's ID.
+   * @default 'mmkv.default'
+   */
+  readonly defaultMMKVInstanceId: string
+}

package/src/specs/MMKVPlatformContext.nitro.ts

@@ -0,0 +1,14 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+
+export interface MMKVPlatformContext
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  /**
+   * Get the MMKV base directory
+   */
+  getBaseDirectory(): string
+  /**
+   * Get the MMKV AppGroup's directory.
+   * @platform iOS
+   */
+  getAppGroupDirectory(): string
+}

package/src/{createTextEncoder.ts → web/createTextEncoder.ts}

@@ -1,16 +1,16 @@
-/* global TextEncoder */
-export function createTextEncoder(): TextEncoder {
-  if (global.TextEncoder != null) {
-    return new global.TextEncoder();
+export function createTextEncoder() {
+  const g = global ?? globalThis ?? window
+  if (g.TextEncoder != null) {
+    return new g.TextEncoder()
   } else {
     return {
       encode: () => {
-        throw new Error('TextEncoder is not supported in this environment!');
+        throw new Error('TextEncoder is not supported in this environment!')
       },
       encodeInto: () => {
-        throw new Error('TextEncoder is not supported in this environment!');
+        throw new Error('TextEncoder is not supported in this environment!')
       },
       encoding: 'utf-8',
-    };
+    }
   }
 }

package/android/src/main/cpp/AndroidLogger.cpp

@@ -1,16 +0,0 @@
-//
-//  AndroidMmkvLogger.cpp
-//  react-native-mmkv
-//
-//  Created by Marc Rousavy on 05.03.24.
-//
-
-#include "MmkvLogger.h"
-#include <android/log.h>
-
-void MmkvLogger::log(const std::string& tag, const std::string& message) {
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wformat-security"
-  __android_log_print(ANDROID_LOG_INFO, tag.c_str(), message.c_str());
-#pragma clang diagnostic pop
-}

package/android/src/main/java/com/mrousavy/mmkv/MmkvPackage.java

@@ -1,44 +0,0 @@
-package com.mrousavy.mmkv;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-import com.facebook.react.bridge.NativeModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.module.model.ReactModuleInfo;
-import com.facebook.react.module.model.ReactModuleInfoProvider;
-import com.facebook.react.TurboReactPackage;
-
-import java.util.HashMap;
-import java.util.Map;
-
-public class MmkvPackage extends TurboReactPackage {
-  @Nullable
-  @Override
-  public NativeModule getModule(String name, @NonNull ReactApplicationContext reactContext) {
-    if (name.equals(MmkvPlatformContextModule.NAME)) {
-      return new MmkvPlatformContextModule(reactContext);
-    } else {
-      return null;
-    }
-  }
-
-  @Override
-  public ReactModuleInfoProvider getReactModuleInfoProvider() {
-    return () -> {
-      final Map<String, ReactModuleInfo> moduleInfos = new HashMap<>();
-      moduleInfos.put(
-              MmkvPlatformContextModule.NAME,
-              new ReactModuleInfo(
-                      MmkvPlatformContextModule.NAME,
-                      MmkvPlatformContextModule.NAME,
-                      false, // canOverrideExistingModule
-                      false, // needsEagerInit
-                      true, // hasConstants
-                      false, // isCxxModule
-                      true // isTurboModule
-              ));
-      return moduleInfos;
-    };
-  }
-}

package/android/src/main/java/com/mrousavy/mmkv/MmkvPlatformContextModule.java

@@ -1,26 +0,0 @@
-package com.mrousavy.mmkv;
-
-import androidx.annotation.Nullable;
-
-import com.facebook.react.bridge.ReactApplicationContext;
-
-public class MmkvPlatformContextModule extends NativeMmkvPlatformContextSpec {
-    private final ReactApplicationContext context;
-
-    public MmkvPlatformContextModule(ReactApplicationContext reactContext) {
-        super(reactContext);
-        context = reactContext;
-    }
-
-    @Override
-    public String getBaseDirectory() {
-        return context.getFilesDir().getAbsolutePath() + "/mmkv";
-    }
-
-    @Nullable
-    @Override
-    public String getAppGroupDirectory() {
-        // AppGroups do not exist on Android. It's iOS only.
-        return null;
-    }
-}

package/cpp/ManagedMMBuffer.h

@@ -1,32 +0,0 @@
-//
-//  ManagedMMBuffer.h
-//  react-native-mmkv
-//
-//  Created by Marc Rousavy on 25.03.24.
-//
-
-#pragma once
-
-#include "MmkvTypes.h" // IWYU pragma: keep
-#include <jsi/jsi.h>
-
-using namespace facebook;
-
-/**
- A jsi::MutableBuffer that manages MMBuffer memory (by ownership).
- */
-class ManagedMMBuffer : public jsi::MutableBuffer {
-public:
-  explicit ManagedMMBuffer(MMBuffer&& buffer) : _buffer(std::move(buffer)) {}
-
-  uint8_t* data() override {
-    return static_cast<uint8_t*>(_buffer.getPtr());
-  }
-
-  size_t size() const override {
-    return _buffer.length();
-  }
-
-private:
-  MMBuffer _buffer;
-};