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

package/src/ModuleNotFoundError.ts

@@ -1,95 +0,0 @@
-import { NativeModules, Platform } from 'react-native';
-
-declare global {
-  // A react-native internal from TurboModuleRegistry.js
-  var __turboModuleProxy: unknown | undefined;
-}
-
-const BULLET_POINT = '\n* ';
-
-function messageWithSuggestions(
-  message: string,
-  suggestions: string[]
-): string {
-  return message + BULLET_POINT + suggestions.join(BULLET_POINT);
-}
-
-function getFrameworkType(): 'react-native' | 'expo' | 'expo-go' {
-  // check if Expo
-  const ExpoConstants =
-    NativeModules.NativeUnimoduleProxy?.modulesConstants?.ExponentConstants;
-  if (ExpoConstants != null) {
-    if (ExpoConstants.appOwnership === 'expo') {
-      // We're running Expo Go
-      return 'expo-go';
-    } else {
-      // We're running Expo bare / standalone
-      return 'expo';
-    }
-  }
-  return 'react-native';
-}
-
-export class ModuleNotFoundError extends Error {
-  constructor(cause?: unknown) {
-    // TurboModule not found, something went wrong!
-    if (global.__turboModuleProxy == null) {
-      // TurboModules are not available/new arch is not enabled.
-      // react-native-mmkv 3.x.x requires new arch (react-native >0.74)
-      // react-native-mmkv 2.x.x works on old arch (react-native <0.74)
-      const message =
-        'Failed to create a new MMKV instance: react-native-mmkv 3.x.x requires TurboModules, but the new architecture is not enabled!';
-      const suggestions: string[] = [];
-      suggestions.push(
-        'Downgrade to react-native-mmkv 2.x.x if you want to stay on the old architecture.'
-      );
-      suggestions.push(
-        'Enable the new architecture in your app to use react-native-mmkv 3.x.x. (See https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md)'
-      );
-      const error = messageWithSuggestions(message, suggestions);
-      super(error, { cause: cause });
-      return;
-    }
-
-    const framework = getFrameworkType();
-    if (framework === 'expo-go') {
-      super(
-        'react-native-mmkv is not supported in Expo Go! Use EAS (`expo prebuild`) or eject to a bare workflow instead.'
-      );
-      return;
-    }
-
-    const message =
-      'Failed to create a new MMKV instance: The native MMKV Module could not be found.';
-    const suggestions: string[] = [];
-    suggestions.push(
-      'Make sure react-native-mmkv is correctly autolinked (run `npx react-native config` to verify)'
-    );
-    suggestions.push(
-      'Make sure you enabled the new architecture (TurboModules) and CodeGen properly generated the react-native-mmkv specs. See https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md'
-    );
-    suggestions.push(
-      'Make sure you are using react-native 0.74.0 or higher, because react-native-mmkv is a C++ TurboModule.'
-    );
-    suggestions.push('Make sure you rebuilt the app.');
-    if (framework === 'expo') {
-      suggestions.push('Make sure you ran `expo prebuild`.');
-    }
-    switch (Platform.OS) {
-      case 'ios':
-      case 'macos':
-        suggestions.push(
-          'Make sure you ran `pod install` in the ios/ directory.'
-        );
-        break;
-      case 'android':
-        suggestions.push('Make sure gradle is synced.');
-        break;
-      default:
-        throw new Error(`MMKV is not supported on ${Platform.OS}!`);
-    }
-
-    const error = messageWithSuggestions(message, suggestions);
-    super(error, { cause: cause });
-  }
-}

package/src/NativeMmkv.ts

@@ -1,118 +0,0 @@
-import type { TurboModule } from 'react-native';
-import { TurboModuleRegistry } from 'react-native';
-import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
-import { ModuleNotFoundError } from './ModuleNotFoundError';
-import { getMMKVPlatformContextTurboModule } from './NativeMmkvPlatformContext';
-
-/**
- * IMPORTANT: These types are also in the Types.ts file.
- * Due to how react-native-codegen works these are required here as the spec types can not be separated from spec.
- * We also need the types separate to allow bypassing importing turbo module registry in web
- */
-/**
- * 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/' })
-   * ```
-   *
-   * @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.
-   * - `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;
-  /**
-   * If `true`, the MMKV instance can only read from the storage, but not write to it.
-   */
-  readOnly?: boolean;
-}
-
-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 mmkvModule: Spec | null;
-
-export function getMMKVTurboModule(): Spec {
-  try {
-    if (mmkvModule == null) {
-      // 1. Load MMKV TurboModule
-      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();
-      mmkvModule.initialize(basePath);
-    }
-
-    return mmkvModule;
-  } catch (cause) {
-    // TurboModule could not be found!
-    throw new ModuleNotFoundError(cause);
-  }
-}

package/src/NativeMmkvPlatformContext.ts

@@ -1,38 +0,0 @@
-import type { TurboModule } from 'react-native';
-import { TurboModuleRegistry } from 'react-native';
-import { ModuleNotFoundError } from './ModuleNotFoundError';
-
-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 mmkvPlatformModule: Spec | null;
-
-export function getMMKVPlatformContextTurboModule(): Spec {
-  try {
-    if (mmkvPlatformModule == null) {
-      // 1. Get the TurboModule
-      mmkvPlatformModule = TurboModuleRegistry.getEnforcing<Spec>(
-        'MmkvPlatformContext'
-      );
-    }
-    return mmkvPlatformModule;
-  } catch (e) {
-    // TurboModule could not be found!
-    throw new ModuleNotFoundError(e);
-  }
-}

package/src/Types.ts

@@ -1,178 +0,0 @@
-/**
- * IMPORTANT: Some of these types are also in the NativeMmkv.ts file.
- * Due to how react-native-codegen works these are required here as the spec types can not be separated from spec.
- * We also need the types separate to allow bypassing importing turbo module registry in web
- */
-
-/**
- * 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/' })
-   * ```
-   *
-   * @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.
-   * - `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;
-  /**
-   * 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;
-}
-
-/**
- * Represents a single MMKV instance.
- */
-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;
-  /**
-   * 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) => ArrayBufferLike | 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.
-   *
-   * @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;
-}
-
-export interface Listener {
-  remove: () => void;
-}
-
-export interface MMKVInterface extends NativeMMKV {
-  /**
-   * 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/createMMKV.mock.ts

@@ -1,38 +0,0 @@
-import type { NativeMMKV } from './Types';
-
-/* Mock MMKV instance for use in tests */
-export const createMockMMKV = (): NativeMMKV => {
-  const storage = new Map<string, string | boolean | number | ArrayBuffer>();
-
-  return {
-    clearAll: () => storage.clear(),
-    delete: (key) => storage.delete(key),
-    set: (key, value) => storage.set(key, value),
-    getString: (key) => {
-      const result = storage.get(key);
-      return typeof result === 'string' ? result : undefined;
-    },
-    getNumber: (key) => {
-      const result = storage.get(key);
-      return typeof result === 'number' ? result : undefined;
-    },
-    getBoolean: (key) => {
-      const result = storage.get(key);
-      return typeof result === 'boolean' ? result : undefined;
-    },
-    getBuffer: (key) => {
-      const result = storage.get(key);
-      return result instanceof ArrayBuffer ? result : undefined;
-    },
-    getAllKeys: () => Array.from(storage.keys()),
-    contains: (key) => storage.has(key),
-    recrypt: () => {
-      console.warn('Encryption is not supported in mocked MMKV instances!');
-    },
-    size: 0,
-    isReadOnly: false,
-    trim: () => {
-      // no-op
-    },
-  };
-};

package/src/createMMKV.ts

@@ -1,42 +0,0 @@
-import { Platform } from 'react-native';
-import { getMMKVTurboModule } from './NativeMmkv';
-import { type Configuration, Mode, 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);
-      }
-    }
-  }
-
-  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) {
-      throw new Error(
-        'Failed to create MMKV instance - an unknown object was returned by createMMKV(..)!'
-      );
-    }
-  }
-  return instance as NativeMMKV;
-};