react-native-mmkv 2.1.1 → 2.3.0

package/lib/module/hooks.js

@@ -0,0 +1,174 @@
+import { useRef, useState, useMemo, useCallback, useEffect } from 'react';
+import { MMKV } from './MMKV';
+
+function isConfigurationEqual(left, right) {
+  if (left == null || right == null) return left == null && right == null;
+  return left.encryptionKey === right.encryptionKey && left.id === right.id && left.path === right.path;
+}
+
+let defaultInstance = null;
+
+function getDefaultInstance() {
+  if (defaultInstance == null) {
+    defaultInstance = new MMKV();
+  }
+
+  return defaultInstance;
+}
+/**
+ * Use the default, shared MMKV instance.
+ */
+
+
+export function useMMKV(configuration) {
+  const instance = useRef();
+  const lastConfiguration = useRef();
+  if (configuration == null) return getDefaultInstance();
+
+  if (instance.current == null || !isConfigurationEqual(lastConfiguration.current, configuration)) {
+    lastConfiguration.current = configuration;
+    instance.current = new MMKV(configuration);
+  } // @ts-expect-error it's not null, I promise.
+
+
+  return instance;
+}
+
+function createMMKVHook(getter) {
+  return (key, instance) => {
+    const mmkv = instance !== null && instance !== void 0 ? instance : getDefaultInstance();
+    const [value, setValue] = useState(() => getter(mmkv, key));
+    const valueRef = useRef(value);
+    valueRef.current = value; // update value by user set
+
+    const set = useCallback(v => {
+      const newValue = typeof v === 'function' ? v(valueRef.current) : v;
+
+      switch (typeof newValue) {
+        case 'number':
+        case 'string':
+        case 'boolean':
+          mmkv.set(key, newValue);
+          break;
+
+        case 'undefined':
+          mmkv.delete(key);
+          break;
+
+        default:
+          throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);
+      }
+    }, [key, mmkv]); // update value if key changes
+
+    const keyRef = useRef(key);
+    useEffect(() => {
+      if (key !== keyRef.current) {
+        setValue(getter(mmkv, key));
+        keyRef.current = key;
+      }
+    }, [key, mmkv]); // update value if it changes somewhere else (second hook, same key)
+
+    useEffect(() => {
+      const listener = mmkv.addOnValueChangedListener(changedKey => {
+        if (changedKey === key) {
+          setValue(getter(mmkv, key));
+        }
+      });
+      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 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(key, instance) {
+  const [string, setString] = useMMKVString(key, instance);
+  const value = useMemo(() => {
+    if (string == null) return undefined;
+    return JSON.parse(string);
+  }, [string]);
+  const setValue = useCallback(v => {
+    if (v == null) {
+      // Clear the Value
+      setString(undefined);
+    } else {
+      // Store the Object as a serialized Value
+      setString(JSON.stringify(v));
+    }
+  }, [setString]);
+  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, instance) {
+  const ref = useRef(valueChangedListener);
+  ref.current = valueChangedListener;
+  const mmkv = instance !== null && instance !== void 0 ? instance : getDefaultInstance();
+  useEffect(() => {
+    const listener = mmkv.addOnValueChangedListener(changedKey => {
+      ref.current(changedKey);
+    });
+    return () => listener.remove();
+  }, [mmkv]);
+}
+//# sourceMappingURL=hooks.js.map

package/lib/module/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["hooks.ts"],"names":["useRef","useState","useMemo","useCallback","useEffect","MMKV","isConfigurationEqual","left","right","encryptionKey","id","path","defaultInstance","getDefaultInstance","useMMKV","configuration","instance","lastConfiguration","current","createMMKVHook","getter","key","mmkv","value","setValue","valueRef","set","v","newValue","delete","Error","keyRef","listener","addOnValueChangedListener","changedKey","remove","useMMKVString","getString","useMMKVNumber","getNumber","useMMKVBoolean","getBoolean","useMMKVObject","string","setString","undefined","JSON","parse","stringify","useMMKVListener","valueChangedListener","ref"],"mappings":"AAAA,SAASA,MAAT,EAAiBC,QAAjB,EAA2BC,OAA3B,EAAoCC,WAApC,EAAiDC,SAAjD,QAAkE,OAAlE;AACA,SAASC,IAAT,QAAwC,QAAxC;;AAEA,SAASC,oBAAT,CACEC,IADF,EAEEC,KAFF,EAGW;AACT,MAAID,IAAI,IAAI,IAAR,IAAgBC,KAAK,IAAI,IAA7B,EAAmC,OAAOD,IAAI,IAAI,IAAR,IAAgBC,KAAK,IAAI,IAAhC;AAEnC,SACED,IAAI,CAACE,aAAL,KAAuBD,KAAK,CAACC,aAA7B,IACAF,IAAI,CAACG,EAAL,KAAYF,KAAK,CAACE,EADlB,IAEAH,IAAI,CAACI,IAAL,KAAcH,KAAK,CAACG,IAHtB;AAKD;;AAED,IAAIC,eAA4B,GAAG,IAAnC;;AACA,SAASC,kBAAT,GAAoC;AAClC,MAAID,eAAe,IAAI,IAAvB,EAA6B;AAC3BA,IAAAA,eAAe,GAAG,IAAIP,IAAJ,EAAlB;AACD;;AACD,SAAOO,eAAP;AACD;AAED;AACA;AACA;;;AAOA,OAAO,SAASE,OAAT,CAAiBC,aAAjB,EAA0D;AAC/D,QAAMC,QAAQ,GAAGhB,MAAM,EAAvB;AACA,QAAMiB,iBAAiB,GAAGjB,MAAM,EAAhC;AAEA,MAAIe,aAAa,IAAI,IAArB,EAA2B,OAAOF,kBAAkB,EAAzB;;AAE3B,MACEG,QAAQ,CAACE,OAAT,IAAoB,IAApB,IACA,CAACZ,oBAAoB,CAACW,iBAAiB,CAACC,OAAnB,EAA4BH,aAA5B,CAFvB,EAGE;AACAE,IAAAA,iBAAiB,CAACC,OAAlB,GAA4BH,aAA5B;AACAC,IAAAA,QAAQ,CAACE,OAAT,GAAmB,IAAIb,IAAJ,CAASU,aAAT,CAAnB;AACD,GAZ8D,CAc/D;;;AACA,SAAOC,QAAP;AACD;;AAED,SAASG,cAAT,CAIEC,MAJF,EAI8C;AAC5C,SAAO,CACLC,GADK,EAELL,QAFK,KAGiD;AACtD,UAAMM,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeH,kBAAkB,EAA3C;AACA,UAAM,CAACU,KAAD,EAAQC,QAAR,IAAoBvB,QAAQ,CAAC,MAAMmB,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAb,CAAlC;AACA,UAAMI,QAAQ,GAAGzB,MAAM,CAAIuB,KAAJ,CAAvB;AACAE,IAAAA,QAAQ,CAACP,OAAT,GAAmBK,KAAnB,CAJsD,CAMtD;;AACA,UAAMG,GAAG,GAAGvB,WAAW,CACpBwB,CAAD,IAAmB;AACjB,YAAMC,QAAQ,GAAG,OAAOD,CAAP,KAAa,UAAb,GAA0BA,CAAC,CAACF,QAAQ,CAACP,OAAV,CAA3B,GAAgDS,CAAjE;;AACA,cAAQ,OAAOC,QAAf;AACE,aAAK,QAAL;AACA,aAAK,QAAL;AACA,aAAK,SAAL;AACEN,UAAAA,IAAI,CAACI,GAAL,CAASL,GAAT,EAAcO,QAAd;AACA;;AACF,aAAK,WAAL;AACEN,UAAAA,IAAI,CAACO,MAAL,CAAYR,GAAZ;AACA;;AACF;AACE,gBAAM,IAAIS,KAAJ,CAAW,cAAa,OAAOF,QAAS,oBAAxC,CAAN;AAVJ;AAYD,KAfoB,EAgBrB,CAACP,GAAD,EAAMC,IAAN,CAhBqB,CAAvB,CAPsD,CA0BtD;;AACA,UAAMS,MAAM,GAAG/B,MAAM,CAACqB,GAAD,CAArB;AACAjB,IAAAA,SAAS,CAAC,MAAM;AACd,UAAIiB,GAAG,KAAKU,MAAM,CAACb,OAAnB,EAA4B;AAC1BM,QAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACAU,QAAAA,MAAM,CAACb,OAAP,GAAiBG,GAAjB;AACD;AACF,KALQ,EAKN,CAACA,GAAD,EAAMC,IAAN,CALM,CAAT,CA5BsD,CAmCtD;;AACAlB,IAAAA,SAAS,CAAC,MAAM;AACd,YAAM4B,QAAQ,GAAGV,IAAI,CAACW,yBAAL,CAAgCC,UAAD,IAAgB;AAC9D,YAAIA,UAAU,KAAKb,GAAnB,EAAwB;AACtBG,UAAAA,QAAQ,CAACJ,MAAM,CAACE,IAAD,EAAOD,GAAP,CAAP,CAAR;AACD;AACF,OAJgB,CAAjB;AAKA,aAAO,MAAMW,QAAQ,CAACG,MAAT,EAAb;AACD,KAPQ,EAON,CAACd,GAAD,EAAMC,IAAN,CAPM,CAAT;AASA,WAAO,CAACC,KAAD,EAAQG,GAAR,CAAP;AACD,GAjDD;AAkDD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,OAAO,MAAMU,aAAa,GAAGjB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACqB,SAAT,CAAmBhB,GAAnB,CADyC,CAApC;AAIP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMiB,aAAa,GAAGnB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC1CL,QAAQ,CAACuB,SAAT,CAAmBlB,GAAnB,CADyC,CAApC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,MAAMmB,cAAc,GAAGrB,cAAc,CAAC,CAACH,QAAD,EAAWK,GAAX,KAC3CL,QAAQ,CAACyB,UAAT,CAAoBpB,GAApB,CAD0C,CAArC;AAGP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASqB,aAAT,CACLrB,GADK,EAELL,QAFK,EAG6D;AAClE,QAAM,CAAC2B,MAAD,EAASC,SAAT,IAAsBR,aAAa,CAACf,GAAD,EAAML,QAAN,CAAzC;AAEA,QAAMO,KAAK,GAAGrB,OAAO,CAAC,MAAM;AAC1B,QAAIyC,MAAM,IAAI,IAAd,EAAoB,OAAOE,SAAP;AACpB,WAAOC,IAAI,CAACC,KAAL,CAAWJ,MAAX,CAAP;AACD,GAHoB,EAGlB,CAACA,MAAD,CAHkB,CAArB;AAIA,QAAMnB,QAAQ,GAAGrB,WAAW,CACzBwB,CAAD,IAAsB;AACpB,QAAIA,CAAC,IAAI,IAAT,EAAe;AACb;AACAiB,MAAAA,SAAS,CAACC,SAAD,CAAT;AACD,KAHD,MAGO;AACL;AACAD,MAAAA,SAAS,CAACE,IAAI,CAACE,SAAL,CAAerB,CAAf,CAAD,CAAT;AACD;AACF,GATyB,EAU1B,CAACiB,SAAD,CAV0B,CAA5B;AAaA,SAAO,CAACrB,KAAD,EAAQC,QAAR,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASyB,eAAT,CACLC,oBADK,EAELlC,QAFK,EAGC;AACN,QAAMmC,GAAG,GAAGnD,MAAM,CAACkD,oBAAD,CAAlB;AACAC,EAAAA,GAAG,CAACjC,OAAJ,GAAcgC,oBAAd;AAEA,QAAM5B,IAAI,GAAGN,QAAH,aAAGA,QAAH,cAAGA,QAAH,GAAeH,kBAAkB,EAA3C;AAEAT,EAAAA,SAAS,CAAC,MAAM;AACd,UAAM4B,QAAQ,GAAGV,IAAI,CAACW,yBAAL,CAAgCC,UAAD,IAAgB;AAC9DiB,MAAAA,GAAG,CAACjC,OAAJ,CAAYgB,UAAZ;AACD,KAFgB,CAAjB;AAGA,WAAO,MAAMF,QAAQ,CAACG,MAAT,EAAb;AACD,GALQ,EAKN,CAACb,IAAD,CALM,CAAT;AAMD","sourcesContent":["import { useRef, useState, useMemo, useCallback, useEffect } from 'react';\nimport { MMKV, MMKVConfiguration } from './MMKV';\n\nfunction isConfigurationEqual(\n  left?: MMKVConfiguration,\n  right?: MMKVConfiguration\n): boolean {\n  if (left == null || right == null) return left == null && right == null;\n\n  return (\n    left.encryptionKey === right.encryptionKey &&\n    left.id === right.id &&\n    left.path === right.path\n  );\n}\n\nlet defaultInstance: MMKV | null = null;\nfunction getDefaultInstance(): MMKV {\n  if (defaultInstance == null) {\n    defaultInstance = new MMKV();\n  }\n  return defaultInstance;\n}\n\n/**\n * Use the default, shared MMKV instance.\n */\nexport function useMMKV(): MMKV;\n/**\n * Use a custom MMKV instance with the given configuration.\n * @param configuration The configuration to initialize the MMKV instance with. Does not have to be memoized.\n */\nexport function useMMKV(configuration: MMKVConfiguration): MMKV;\nexport function useMMKV(configuration?: MMKVConfiguration): MMKV {\n  const instance = useRef<MMKV>();\n  const lastConfiguration = useRef<MMKVConfiguration>();\n\n  if (configuration == null) return getDefaultInstance();\n\n  if (\n    instance.current == null ||\n    !isConfigurationEqual(lastConfiguration.current, configuration)\n  ) {\n    lastConfiguration.current = configuration;\n    instance.current = new MMKV(configuration);\n  }\n\n  // @ts-expect-error it's not null, I promise.\n  return instance;\n}\n\nfunction createMMKVHook<\n  T extends (boolean | number | string) | undefined,\n  TSet extends T | undefined,\n  TSetAction extends TSet | ((current: T) => TSet)\n>(getter: (instance: MMKV, key: string) => T) {\n  return (\n    key: string,\n    instance?: MMKV\n  ): [value: T, setValue: (value: TSetAction) => void] => {\n    const mmkv = instance ?? getDefaultInstance();\n    const [value, setValue] = useState(() => getter(mmkv, key));\n    const valueRef = useRef<T>(value);\n    valueRef.current = value;\n\n    // update value by user set\n    const set = useCallback(\n      (v: TSetAction) => {\n        const newValue = typeof v === 'function' ? v(valueRef.current) : v;\n        switch (typeof newValue) {\n          case 'number':\n          case 'string':\n          case 'boolean':\n            mmkv.set(key, newValue);\n            break;\n          case 'undefined':\n            mmkv.delete(key);\n            break;\n          default:\n            throw new Error(`MMKV: Type ${typeof newValue} is not supported!`);\n        }\n      },\n      [key, mmkv]\n    );\n\n    // update value if key changes\n    const keyRef = useRef(key);\n    useEffect(() => {\n      if (key !== keyRef.current) {\n        setValue(getter(mmkv, key));\n        keyRef.current = key;\n      }\n    }, [key, mmkv]);\n\n    // update value if it changes somewhere else (second hook, same key)\n    useEffect(() => {\n      const listener = mmkv.addOnValueChangedListener((changedKey) => {\n        if (changedKey === key) {\n          setValue(getter(mmkv, key));\n        }\n      });\n      return () => listener.remove();\n    }, [key, mmkv]);\n\n    return [value, set];\n  };\n}\n\n/**\n * Use the string value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [username, setUsername] = useMMKVString(\"user.name\")\n * ```\n */\nexport const useMMKVString = createMMKVHook((instance, key) =>\n  instance.getString(key)\n);\n\n/**\n * Use the number value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [age, setAge] = useMMKVNumber(\"user.age\")\n * ```\n */\nexport const useMMKVNumber = createMMKVHook((instance, key) =>\n  instance.getNumber(key)\n);\n/**\n * Use the boolean value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * @example\n * ```ts\n * const [isPremiumAccount, setIsPremiumAccount] = useMMKVBoolean(\"user.isPremium\")\n * ```\n */\nexport const useMMKVBoolean = createMMKVHook((instance, key) =>\n  instance.getBoolean(key)\n);\n/**\n * Use an object value of the given `key` from the given MMKV storage instance.\n *\n * If no instance is provided, a shared default instance will be used.\n *\n * The object will be serialized using `JSON`.\n *\n * @example\n * ```ts\n * const [user, setUser] = useMMKVObject<User>(\"user\")\n * ```\n */\nexport function useMMKVObject<T>(\n  key: string,\n  instance?: MMKV\n): [value: T | undefined, setValue: (value: T | undefined) => void] {\n  const [string, setString] = useMMKVString(key, instance);\n\n  const value = useMemo(() => {\n    if (string == null) return undefined;\n    return JSON.parse(string) as T;\n  }, [string]);\n  const setValue = useCallback(\n    (v: T | undefined) => {\n      if (v == null) {\n        // Clear the Value\n        setString(undefined);\n      } else {\n        // Store the Object as a serialized Value\n        setString(JSON.stringify(v));\n      }\n    },\n    [setString]\n  );\n\n  return [value, setValue];\n}\n\n/**\n * Listen for changes in the given MMKV storage instance.\n * If no instance is passed, the default instance will be used.\n * @param valueChangedListener The function to call whenever a value inside the storage instance changes\n * @param instance The instance to listen to changes to (or the default instance)\n *\n * @example\n * ```ts\n * useMMKVListener((key) => {\n *   console.log(`Value for \"${key}\" changed!`)\n * })\n * ```\n */\nexport function useMMKVListener(\n  valueChangedListener: (key: string) => void,\n  instance?: MMKV\n): void {\n  const ref = useRef(valueChangedListener);\n  ref.current = valueChangedListener;\n\n  const mmkv = instance ?? getDefaultInstance();\n\n  useEffect(() => {\n    const listener = mmkv.addOnValueChangedListener((changedKey) => {\n      ref.current(changedKey);\n    });\n    return () => listener.remove();\n  }, [mmkv]);\n}\n"]}

package/lib/module/index.js

@@ -0,0 +1,3 @@
+export * from './MMKV';
+export * from './hooks';
+//# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAd;AACA,cAAc,SAAd","sourcesContent":["export * from './MMKV';\nexport * from './hooks';\n"]}

package/lib/typescript/MMKV.d.ts

@@ -0,0 +1,130 @@
+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/' })
+     * ```
+     */
+    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) => 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;
+    /**
+     * 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 declare type NativeMMKV = Pick<MMKVInterface, 'clearAll' | 'contains' | 'delete' | 'getAllKeys' | 'getBoolean' | 'getNumber' | 'getString' | 'set' | 'recrypt'>;
+/**
+ * A single MMKV instance.
+ */
+export declare class MMKV implements MMKVInterface {
+    private nativeInstance;
+    private functionCache;
+    private id;
+    /**
+     * Creates a new MMKV instance with the given Configuration.
+     * If no custom `id` is supplied, `'mmkv.default'` will be used.
+     */
+    constructor(configuration?: MMKVConfiguration);
+    private get onValueChangedListeners();
+    private getFunctionFromCache;
+    private onValuesAboutToChange;
+    set(key: string, value: boolean | string | number): void;
+    getBoolean(key: string): boolean | undefined;
+    getString(key: string): string | undefined;
+    getNumber(key: string): number | undefined;
+    contains(key: string): boolean;
+    delete(key: string): void;
+    getAllKeys(): string[];
+    clearAll(): void;
+    recrypt(key: string | undefined): void;
+    toString(): string;
+    toJSON(): object;
+    addOnValueChangedListener(onValueChanged: (key: string) => void): Listener;
+}
+export {};

package/lib/typescript/createMMKV.d.ts

@@ -0,0 +1,6 @@
+import type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';
+declare global {
+    function mmkvCreateNewInstance(configuration: MMKVConfiguration): NativeMMKV;
+    function nativeCallSyncHook(): unknown;
+}
+export declare const createMMKV: (config: MMKVConfiguration) => NativeMMKV;

package/lib/typescript/createMMKV.web.d.ts

@@ -0,0 +1,2 @@
+import type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';
+export declare const createMMKV: (config: MMKVConfiguration) => NativeMMKV;

package/lib/typescript/hooks.d.ts

@@ -0,0 +1,70 @@
+import { MMKV, MMKVConfiguration } from './MMKV';
+/**
+ * Use the default, shared MMKV instance.
+ */
+export declare 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 declare function useMMKV(configuration: MMKVConfiguration): MMKV;
+/**
+ * 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 declare const useMMKVString: (key: string, instance?: MMKV | undefined) => [value: string | undefined, setValue: (value: string | ((current: string | undefined) => string | undefined) | undefined) => void];
+/**
+ * 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 declare const useMMKVNumber: (key: string, instance?: MMKV | undefined) => [value: number | undefined, setValue: (value: number | ((current: number | undefined) => number | undefined) | undefined) => void];
+/**
+ * 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 declare const useMMKVBoolean: (key: string, instance?: MMKV | undefined) => [value: boolean | undefined, setValue: (value: boolean | ((current: boolean | undefined) => boolean | undefined) | undefined) => void];
+/**
+ * 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 declare function useMMKVObject<T>(key: string, instance?: MMKV): [value: T | undefined, setValue: (value: T | undefined) => void];
+/**
+ * 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 declare function useMMKVListener(valueChangedListener: (key: string) => void, instance?: MMKV): void;

package/lib/typescript/index.d.ts

@@ -0,0 +1,2 @@
+export * from './MMKV';
+export * from './hooks';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-mmkv",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "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",

package/react-native-mmkv.podspec

@@ -26,6 +26,6 @@ Pod::Spec.new do |s|
     'ios/**/*.h'
   ]
 
-  s.dependency "MMKV"
+  s.dependency "MMKV", ">= 1.2.13"
   s.dependency "React-Core"
 end