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

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;
-};

package/src/hooks.ts

@@ -1,247 +0,0 @@
-import { useRef, useState, useMemo, useCallback, useEffect } from 'react';
-import { MMKV } from './MMKV';
-import type { Configuration } from './Types';
-
-function isConfigurationEqual(
-  left?: Configuration,
-  right?: Configuration
-): boolean {
-  if (left == null || right == null) return left == null && right == null;
-
-  return (
-    left.encryptionKey === right.encryptionKey &&
-    left.id === right.id &&
-    left.path === right.path &&
-    left.mode === right.mode
-  );
-}
-
-let defaultInstance: MMKV | null = null;
-function getDefaultInstance(): MMKV {
-  if (defaultInstance == null) {
-    defaultInstance = new MMKV();
-  }
-  return defaultInstance;
-}
-
-/**
- * Use the default, shared MMKV instance.
- */
-export function useMMKV(): MMKV;
-/**
- * Use a custom MMKV instance with the given configuration.
- * @param configuration The configuration to initialize the MMKV instance with. Does not have to be memoized.
- */
-export function useMMKV(configuration: Configuration): MMKV;
-export function useMMKV(configuration?: Configuration): MMKV {
-  const instance = useRef<MMKV>(undefined);
-  const lastConfiguration = useRef<Configuration>(undefined);
-
-  if (configuration == null) return getDefaultInstance();
-
-  if (
-    instance.current == null ||
-    !isConfigurationEqual(lastConfiguration.current, configuration)
-  ) {
-    lastConfiguration.current = configuration;
-    instance.current = new MMKV(configuration);
-  }
-
-  return instance.current;
-}
-
-function createMMKVHook<
-  T extends (boolean | number | string | ArrayBufferLike) | undefined,
-  TSet extends T | undefined,
-  TSetAction extends TSet | ((current: T) => TSet),
->(getter: (instance: MMKV, key: string) => T) {
-  return (
-    key: string,
-    instance?: MMKV
-  ): [value: T, setValue: (value: TSetAction) => void] => {
-    const mmkv = instance ?? getDefaultInstance();
-
-    const [bump, setBump] = useState(0);
-    const value = useMemo(() => {
-      // bump is here as an additional outside dependency, so this useMemo
-      // re-computes the value each time bump changes, effectively acting as a hint
-      // that the outside value (storage) has changed. setting bump refreshes this value.
-      bump;
-      return getter(mmkv, key);
-    }, [mmkv, key, bump]);
-
-    // update value by user set
-    const set = useCallback(
-      (v: TSetAction) => {
-        const newValue = typeof v === 'function' ? v(getter(mmkv, key)) : v;
-        switch (typeof newValue) {
-          case 'number':
-          case 'string':
-          case 'boolean':
-            mmkv.set(key, newValue);
-            break;
-          case 'undefined':
-            mmkv.delete(key);
-            break;
-          case 'object':
-            if (newValue instanceof ArrayBuffer) {
-              mmkv.set(key, newValue);
-              break;
-            } else {
-              throw new Error(
-                `MMKV: Type object (${newValue}) is not supported!`
-              );
-            }
-          default:
-            throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);
-        }
-      },
-      [key, mmkv]
-    );
-
-    // update value if it changes somewhere else (second hook, same key)
-    useEffect(() => {
-      const listener = mmkv.addOnValueChangedListener((changedKey) => {
-        if (changedKey === key) {
-          setBump((b) => b + 1);
-        }
-      });
-      return () => listener.remove();
-    }, [key, mmkv]);
-
-    return [value, set];
-  };
-}
-
-/**
- * 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)
-);
-
-/**
- * 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)
-);
-/**
- * Use the boolean 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 [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean("user.isPremium")
- * ```
- */
-export const useMMKVBoolean = createMMKVHook((instance, key) =>
-  instance.getBoolean(key)
-);
-/**
- * Use the buffer value (unsigned 8-bit (0-255)) 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 [privateKey, setPrivateKey] = useMMKVBuffer("user.privateKey")
- * ```
- */
-export const useMMKVBuffer = createMMKVHook((instance, key) =>
-  instance.getBuffer(key)
-);
-/**
- * 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];
-}
-
-/**
- * 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 ?? getDefaultInstance();
-
-  useEffect(() => {
-    const listener = mmkv.addOnValueChangedListener((changedKey) => {
-      ref.current(changedKey);
-    });
-    return () => listener.remove();
-  }, [mmkv]);
-}