react-native-mmkv 2.8.0 → 2.9.0

package/lib/module/createMMKV.web.js.map

@@ -1 +1 @@
-{"version":3,"names":["createTextEncoder","canUseDOM","window","document","createElement","KEY_WILDCARD","createMMKV","config","encryptionKey","Error","path","storage","domStorage","global","localStorage","textEncoder","id","includes","keyPrefix","prefixedKey","key","clearAll","keys","Object","startsWith","removeItem","delete","set","value","setItem","toString","getString","getItem","undefined","getNumber","Number","getBoolean","getBuffer","encode","getAllKeys","filter","contains","recrypt"],"sourceRoot":"../../src","sources":["createMMKV.web.ts"],"mappings":";AAAA;;AAEA,SAASA,iBAAiB,QAAQ,qBAAqB;AAEvD,MAAMC,SAAS,GACb,OAAOC,MAAM,KAAK,WAAW,IAAI,qBAAAA,MAAM,CAACC,QAAQ,qDAAf,iBAAiBC,aAAa,KAAI,IAAI;AAEzE,MAAMC,YAAY,GAAG,IAAI;AAEzB,OAAO,MAAMC,UAAU,GAAIC,MAAyB,IAAiB;EACnE,IAAIA,MAAM,CAACC,aAAa,IAAI,IAAI,EAAE;IAChC,MAAM,IAAIC,KAAK,CAAC,gDAAgD,CAAC;EACnE;EACA,IAAIF,MAAM,CAACG,IAAI,IAAI,IAAI,EAAE;IACvB,MAAM,IAAID,KAAK,CAAC,uCAAuC,CAAC;EAC1D;EAEA,MAAME,OAAO,GAAG,MAAM;IAAA;IACpB,IAAI,CAACV,SAAS,EAAE;MACd,MAAM,IAAIQ,KAAK,CACb,kFAAkF,CACnF;IACH;IACA,MAAMG,UAAU,GACd,YAAAC,MAAM,4CAAN,QAAQC,YAAY,iBAAIZ,MAAM,4CAAN,QAAQY,YAAY,KAAIA,YAAY;IAC9D,IAAIF,UAAU,IAAI,IAAI,EAAE;MACtB,MAAM,IAAIH,KAAK,CAAE,yCAAwC,CAAC;IAC5D;IACA,OAAOG,UAAU;EACnB,CAAC;EAED,MAAMG,WAAW,GAAGf,iBAAiB,EAAE;EAEvC,IAAIO,MAAM,CAACS,EAAE,CAACC,QAAQ,CAACZ,YAAY,CAAC,EAAE;IACpC,MAAM,IAAII,KAAK,CACb,2DAA2D,CAC5D;EACH;EAEA,MAAMS,SAAS,GAAI,GAAEX,MAAM,CAACS,EAAG,GAAEX,YAAa,EAAC,CAAC,CAAC;EACjD,MAAMc,WAAW,GAAIC,GAAW,IAAK;IACnC,IAAIA,GAAG,CAACH,QAAQ,CAAC,IAAI,CAAC,EAAE;MACtB,MAAM,IAAIR,KAAK,CACb,4DAA4D,CAC7D;IACH;IACA,OAAQ,GAAES,SAAU,GAAEE,GAAI,EAAC;EAC7B,CAAC;EAED,OAAO;IACLC,QAAQ,EAAE,MAAM;MACd,MAAMC,IAAI,GAAGC,MAAM,CAACD,IAAI,CAACX,OAAO,EAAE,CAAC;MACnC,KAAK,MAAMS,GAAG,IAAIE,IAAI,EAAE;QACtB,IAAIF,GAAG,CAACI,UAAU,CAACN,SAAS,CAAC,EAAE;UAC7BP,OAAO,EAAE,CAACc,UAAU,CAACL,GAAG,CAAC;QAC3B;MACF;IACF,CAAC;IACDM,MAAM,EAAGN,GAAG,IAAKT,OAAO,EAAE,CAACc,UAAU,CAACN,WAAW,CAACC,GAAG,CAAC,CAAC;IACvDO,GAAG,EAAE,CAACP,GAAG,EAAEQ,KAAK,KAAK;MACnBjB,OAAO,EAAE,CAACkB,OAAO,CAACV,WAAW,CAACC,GAAG,CAAC,EAAEQ,KAAK,CAACE,QAAQ,EAAE,CAAC;IACvD,CAAC;IACDC,SAAS,EAAGX,GAAG,IAAKT,OAAO,EAAE,CAACqB,OAAO,CAACb,WAAW,CAACC,GAAG,CAAC,CAAC,IAAIa,SAAS;IACpEC,SAAS,EAAGd,GAAG,IAAK;MAClB,MAAMQ,KAAK,GAAGjB,OAAO,EAAE,CAACqB,OAAO,CAACb,WAAW,CAACC,GAAG,CAAC,CAAC;MACjD,IAAIQ,KAAK,IAAI,IAAI,EAAE,OAAOK,SAAS;MACnC,OAAOE,MAAM,CAACP,KAAK,CAAC;IACtB,CAAC;IACDQ,UAAU,EAAGhB,GAAG,IAAK;MACnB,MAAMQ,KAAK,GAAGjB,OAAO,EAAE,CAACqB,OAAO,CAACb,WAAW,CAACC,GAAG,CAAC,CAAC;MACjD,IAAIQ,KAAK,IAAI,IAAI,EAAE,OAAOK,SAAS;MACnC,OAAOL,KAAK,KAAK,MAAM;IACzB,CAAC;IACDS,SAAS,EAAGjB,GAAG,IAAK;MAClB,MAAMQ,KAAK,GAAGjB,OAAO,EAAE,CAACqB,OAAO,CAACb,WAAW,CAACC,GAAG,CAAC,CAAC;MACjD,IAAIQ,KAAK,IAAI,IAAI,EAAE,OAAOK,SAAS;MACnC,OAAOlB,WAAW,CAACuB,MAAM,CAACV,KAAK,CAAC;IAClC,CAAC;IACDW,UAAU,EAAE,MAAM;MAChB,MAAMjB,IAAI,GAAGC,MAAM,CAACD,IAAI,CAACX,OAAO,EAAE,CAAC;MACnC,OAAOW,IAAI,CAACkB,MAAM,CAAEpB,GAAG,IAAKA,GAAG,CAACI,UAAU,CAACN,SAAS,CAAC,CAAC;IACxD,CAAC;IACDuB,QAAQ,EAAGrB,GAAG,IAAKT,OAAO,EAAE,CAACqB,OAAO,CAACb,WAAW,CAACC,GAAG,CAAC,CAAC,IAAI,IAAI;IAC9DsB,OAAO,EAAE,MAAM;MACb,MAAM,IAAIjC,KAAK,CAAC,wCAAwC,CAAC;IAC3D;EACF,CAAC;AACH,CAAC"}
+{"version":3,"names":["createTextEncoder","canUseDOM","window","document","createElement","hasAccessToLocalStorage","localStorage","KEY_WILDCARD","inMemoryStorage","Map","createMMKV","config","encryptionKey","Error","path","console","warn","storage","getItem","key","get","setItem","value","set","removeItem","delete","clear","length","size","index","Object","keys","at","domStorage","global","textEncoder","id","includes","keyPrefix","prefixedKey","clearAll","startsWith","toString","getString","undefined","getNumber","Number","getBoolean","getBuffer","encode","getAllKeys","filter","contains","recrypt"],"sourceRoot":"../../src","sources":["createMMKV.web.ts"],"mappings":";AAAA;;AAEA,SAASA,iBAAiB,QAAQ,qBAAqB;AAEvD,MAAMC,SAAS,GACb,OAAOC,MAAM,KAAK,WAAW,IAAI,qBAAAA,MAAM,CAACC,QAAQ,qDAAf,iBAAiBC,aAAa,KAAI,IAAI;AAEzE,MAAMC,uBAAuB,GAAG,MAAM;EACpC,IAAI;IACF;IACAH,MAAM,CAACI,YAAY;IAEnB,OAAO,IAAI;EACb,CAAC,CAAC,MAAM;IACN,OAAO,KAAK;EACd;AACF,CAAC;AAED,MAAMC,YAAY,GAAG,IAAI;AACzB,MAAMC,eAAe,GAAG,IAAIC,GAAG,EAAkB;AAEjD,OAAO,MAAMC,UAAU,GAAIC,MAAyB,IAAiB;EACnE,IAAIA,MAAM,CAACC,aAAa,IAAI,IAAI,EAAE;IAChC,MAAM,IAAIC,KAAK,CAAC,gDAAgD,CAAC;EACnE;EACA,IAAIF,MAAM,CAACG,IAAI,IAAI,IAAI,EAAE;IACvB,MAAM,IAAID,KAAK,CAAC,uCAAuC,CAAC;EAC1D;EAEA,IAAI,CAACR,uBAAuB,EAAE,EAAE;IAC9BU,OAAO,CAACC,IAAI,CACV,6FAA6F,CAC9F;EACH;EAEA,MAAMC,OAAO,GAAG,MAAM;IAAA;IACpB,IAAI,CAAChB,SAAS,EAAE;MACd,MAAM,IAAIY,KAAK,CACb,kFAAkF,CACnF;IACH;IAEA,IAAI,CAACR,uBAAuB,EAAE,EAAE;MAC9B,OAAO;QACLa,OAAO,EAAGC,GAAW,IAAKX,eAAe,CAACY,GAAG,CAACD,GAAG,CAAC,IAAI,IAAI;QAC1DE,OAAO,EAAE,CAACF,GAAW,EAAEG,KAAa,KAClCd,eAAe,CAACe,GAAG,CAACJ,GAAG,EAAEG,KAAK,CAAC;QACjCE,UAAU,EAAGL,GAAW,IAAKX,eAAe,CAACiB,MAAM,CAACN,GAAG,CAAC;QACxDO,KAAK,EAAE,MAAMlB,eAAe,CAACkB,KAAK,EAAE;QACpCC,MAAM,EAAEnB,eAAe,CAACoB,IAAI;QAC5BT,GAAG,EAAGU,KAAa,IAAKC,MAAM,CAACC,IAAI,CAACvB,eAAe,CAAC,CAACwB,EAAE,CAACH,KAAK,CAAC,IAAI;MACpE,CAAC;IACH;IAEA,MAAMI,UAAU,GACd,YAAAC,MAAM,4CAAN,QAAQ5B,YAAY,iBAAIJ,MAAM,4CAAN,QAAQI,YAAY,KAAIA,YAAY;IAC9D,IAAI2B,UAAU,IAAI,IAAI,EAAE;MACtB,MAAM,IAAIpB,KAAK,CAAE,yCAAwC,CAAC;IAC5D;IACA,OAAOoB,UAAU;EACnB,CAAC;EAED,MAAME,WAAW,GAAGnC,iBAAiB,EAAE;EAEvC,IAAIW,MAAM,CAACyB,EAAE,CAACC,QAAQ,CAAC9B,YAAY,CAAC,EAAE;IACpC,MAAM,IAAIM,KAAK,CACb,2DAA2D,CAC5D;EACH;EAEA,MAAMyB,SAAS,GAAI,GAAE3B,MAAM,CAACyB,EAAG,GAAE7B,YAAa,EAAC,CAAC,CAAC;EACjD,MAAMgC,WAAW,GAAIpB,GAAW,IAAK;IACnC,IAAIA,GAAG,CAACkB,QAAQ,CAAC,IAAI,CAAC,EAAE;MACtB,MAAM,IAAIxB,KAAK,CACb,4DAA4D,CAC7D;IACH;IACA,OAAQ,GAAEyB,SAAU,GAAEnB,GAAI,EAAC;EAC7B,CAAC;EAED,OAAO;IACLqB,QAAQ,EAAE,MAAM;MACd,MAAMT,IAAI,GAAGD,MAAM,CAACC,IAAI,CAACd,OAAO,EAAE,CAAC;MACnC,KAAK,MAAME,GAAG,IAAIY,IAAI,EAAE;QACtB,IAAIZ,GAAG,CAACsB,UAAU,CAACH,SAAS,CAAC,EAAE;UAC7BrB,OAAO,EAAE,CAACO,UAAU,CAACL,GAAG,CAAC;QAC3B;MACF;IACF,CAAC;IACDM,MAAM,EAAGN,GAAG,IAAKF,OAAO,EAAE,CAACO,UAAU,CAACe,WAAW,CAACpB,GAAG,CAAC,CAAC;IACvDI,GAAG,EAAE,CAACJ,GAAG,EAAEG,KAAK,KAAK;MACnBL,OAAO,EAAE,CAACI,OAAO,CAACkB,WAAW,CAACpB,GAAG,CAAC,EAAEG,KAAK,CAACoB,QAAQ,EAAE,CAAC;IACvD,CAAC;IACDC,SAAS,EAAGxB,GAAG,IAAKF,OAAO,EAAE,CAACC,OAAO,CAACqB,WAAW,CAACpB,GAAG,CAAC,CAAC,IAAIyB,SAAS;IACpEC,SAAS,EAAG1B,GAAG,IAAK;MAClB,MAAMG,KAAK,GAAGL,OAAO,EAAE,CAACC,OAAO,CAACqB,WAAW,CAACpB,GAAG,CAAC,CAAC;MACjD,IAAIG,KAAK,IAAI,IAAI,EAAE,OAAOsB,SAAS;MACnC,OAAOE,MAAM,CAACxB,KAAK,CAAC;IACtB,CAAC;IACDyB,UAAU,EAAG5B,GAAG,IAAK;MACnB,MAAMG,KAAK,GAAGL,OAAO,EAAE,CAACC,OAAO,CAACqB,WAAW,CAACpB,GAAG,CAAC,CAAC;MACjD,IAAIG,KAAK,IAAI,IAAI,EAAE,OAAOsB,SAAS;MACnC,OAAOtB,KAAK,KAAK,MAAM;IACzB,CAAC;IACD0B,SAAS,EAAG7B,GAAG,IAAK;MAClB,MAAMG,KAAK,GAAGL,OAAO,EAAE,CAACC,OAAO,CAACqB,WAAW,CAACpB,GAAG,CAAC,CAAC;MACjD,IAAIG,KAAK,IAAI,IAAI,EAAE,OAAOsB,SAAS;MACnC,OAAOT,WAAW,CAACc,MAAM,CAAC3B,KAAK,CAAC;IAClC,CAAC;IACD4B,UAAU,EAAE,MAAM;MAChB,MAAMnB,IAAI,GAAGD,MAAM,CAACC,IAAI,CAACd,OAAO,EAAE,CAAC;MACnC,OAAOc,IAAI,CAACoB,MAAM,CAAEhC,GAAG,IAAKA,GAAG,CAACsB,UAAU,CAACH,SAAS,CAAC,CAAC;IACxD,CAAC;IACDc,QAAQ,EAAGjC,GAAG,IAAKF,OAAO,EAAE,CAACC,OAAO,CAACqB,WAAW,CAACpB,GAAG,CAAC,CAAC,IAAI,IAAI;IAC9DkC,OAAO,EAAE,MAAM;MACb,MAAM,IAAIxC,KAAK,CAAC,wCAAwC,CAAC;IAC3D;EACF,CAAC;AACH,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"createMMKV.web.d.ts","sourceRoot":"","sources":["../../src/createMMKV.web.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAQvE,eAAO,MAAM,UAAU,WAAY,iBAAiB,KAAG,UA8EtD,CAAC"}
+{"version":3,"file":"createMMKV.web.d.ts","sourceRoot":"","sources":["../../src/createMMKV.web.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAoBvE,eAAO,MAAM,UAAU,WAAY,iBAAiB,KAAG,UAiGtD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-mmkv",
-  "version": "2.8.0",
+  "version": "2.9.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",
@@ -22,6 +22,7 @@
     "ios/**/*.mm",
     "ios/**/*.cpp",
     "ios/Mmkv.xcodeproj/project.pbxproj",
+    "src",
     "react-native-mmkv.podspec",
     "README.md"
   ],
@@ -53,15 +54,15 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@jamesacarr/eslint-formatter-github-actions": "^0.1.0",
+    "@jamesacarr/eslint-formatter-github-actions": "^0.2.0",
     "@react-native-community/eslint-config": "^3.2.0",
     "@react-native-community/eslint-plugin": "^1.3.0",
     "@release-it/conventional-changelog": "^5.1.1",
     "@tsconfig/react-native": "^2.0.3",
-    "@types/react": "^18.0.33",
-    "@typescript-eslint/eslint-plugin": "^5.57.1",
-    "@typescript-eslint/parser": "^5.57.1",
-    "eslint": "^8.37.0",
+    "@types/react": "^18.0.34",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
+    "eslint": "^8.38.0",
     "eslint-plugin-jest": "^27.2.1",
     "prettier": "^2.8.7",
     "react": "^18.2.0",

package/src/MMKV.ts

@@ -0,0 +1,248 @@
+import { createMMKV } from './createMMKV';
+import { createMockMMKV } from './createMMKV.mock';
+import { isJest } from './PlatformChecker';
+
+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 | Uint8Array) => 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) => Uint8Array | 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 type NativeMMKV = Pick<
+  MMKVInterface,
+  | 'clearAll'
+  | 'contains'
+  | 'delete'
+  | 'getAllKeys'
+  | 'getBoolean'
+  | 'getNumber'
+  | 'getString'
+  | 'getBuffer'
+  | 'set'
+  | 'recrypt'
+>;
+
+const onValueChangedListeners = new Map<string, ((key: string) => void)[]>();
+
+/**
+ * A single MMKV instance.
+ */
+export class MMKV implements MMKVInterface {
+  private nativeInstance: NativeMMKV;
+  private functionCache: Partial<NativeMMKV>;
+  private id: string;
+
+  /**
+   * Creates a new MMKV instance with the given Configuration.
+   * If no custom `id` is supplied, `'mmkv.default'` will be used.
+   */
+  constructor(configuration: MMKVConfiguration = { id: 'mmkv.default' }) {
+    this.id = configuration.id;
+    this.nativeInstance = isJest()
+      ? createMockMMKV()
+      : createMMKV(configuration);
+    this.functionCache = {};
+  }
+
+  private get onValueChangedListeners() {
+    if (!onValueChangedListeners.has(this.id)) {
+      onValueChangedListeners.set(this.id, []);
+    }
+    return onValueChangedListeners.get(this.id)!;
+  }
+
+  private getFunctionFromCache<T extends keyof NativeMMKV>(
+    functionName: T
+  ): NativeMMKV[T] {
+    if (this.functionCache[functionName] == null) {
+      this.functionCache[functionName] = this.nativeInstance[functionName];
+    }
+    return this.functionCache[functionName] as NativeMMKV[T];
+  }
+
+  private onValuesChanged(keys: string[]) {
+    if (this.onValueChangedListeners.length === 0) return;
+
+    for (const key of keys) {
+      for (const listener of this.onValueChangedListeners) {
+        listener(key);
+      }
+    }
+  }
+
+  set(key: string, value: boolean | string | number | Uint8Array): void {
+    const func = this.getFunctionFromCache('set');
+    func(key, value);
+
+    this.onValuesChanged([key]);
+  }
+  getBoolean(key: string): boolean | undefined {
+    const func = this.getFunctionFromCache('getBoolean');
+    return func(key);
+  }
+  getString(key: string): string | undefined {
+    const func = this.getFunctionFromCache('getString');
+    return func(key);
+  }
+  getNumber(key: string): number | undefined {
+    const func = this.getFunctionFromCache('getNumber');
+    return func(key);
+  }
+  getBuffer(key: string): Uint8Array | undefined {
+    const func = this.getFunctionFromCache('getBuffer');
+    return func(key);
+  }
+  contains(key: string): boolean {
+    const func = this.getFunctionFromCache('contains');
+    return func(key);
+  }
+  delete(key: string): void {
+    const func = this.getFunctionFromCache('delete');
+    func(key);
+
+    this.onValuesChanged([key]);
+  }
+  getAllKeys(): string[] {
+    const func = this.getFunctionFromCache('getAllKeys');
+    return func();
+  }
+  clearAll(): void {
+    const keys = this.getAllKeys();
+
+    const func = this.getFunctionFromCache('clearAll');
+    func();
+
+    this.onValuesChanged(keys);
+  }
+  recrypt(key: string | undefined): void {
+    const func = this.getFunctionFromCache('recrypt');
+    return func(key);
+  }
+
+  toString(): string {
+    return `MMKV (${this.id}): [${this.getAllKeys().join(', ')}]`;
+  }
+  toJSON(): object {
+    return {
+      [this.id]: this.getAllKeys(),
+    };
+  }
+
+  addOnValueChangedListener(onValueChanged: (key: string) => void): Listener {
+    this.onValueChangedListeners.push(onValueChanged);
+
+    return {
+      remove: () => {
+        const index = this.onValueChangedListeners.indexOf(onValueChanged);
+        if (index !== -1) {
+          this.onValueChangedListeners.splice(index, 1);
+        }
+      },
+    };
+  }
+}

package/src/PlatformChecker.ts

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

package/src/createMMKV.mock.ts

@@ -0,0 +1,33 @@
+import type { NativeMMKV } from 'react-native-mmkv';
+
+/* Mock MMKV instance for use in tests */
+export const createMockMMKV = (): NativeMMKV => {
+  const storage = new Map<string, string | boolean | number | Uint8Array>();
+
+  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 Uint8Array ? result : undefined;
+    },
+    getAllKeys: () => Array.from(storage.keys()),
+    contains: (key) => storage.has(key),
+    recrypt: () => {
+      console.warn('Encryption is not supported in mocked MMKV instances!');
+    },
+  };
+};

package/src/createMMKV.ts

@@ -0,0 +1,70 @@
+import { NativeModules, Platform } from 'react-native';
+import type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';
+
+// global func declaration for JSI functions
+declare global {
+  function mmkvCreateNewInstance(configuration: MMKVConfiguration): NativeMMKV;
+  function nativeCallSyncHook(): unknown;
+}
+
+// Root directory of all MMKV stores
+const ROOT_DIRECTORY: string | null = null;
+
+export const createMMKV = (config: MMKVConfiguration): NativeMMKV => {
+  // Check if the constructor exists. If not, try installing the JSI bindings.
+  if (global.mmkvCreateNewInstance == null) {
+    // Get the native MMKV ReactModule
+    const MMKVModule = NativeModules.MMKV;
+    if (MMKVModule == null) {
+      let message =
+        'Failed to create a new MMKV instance: The native MMKV Module could not be found.';
+      message +=
+        '\n* Make sure react-native-mmkv is correctly autolinked (run `npx react-native config` to verify)';
+      if (Platform.OS === 'ios' || Platform.OS === 'macos') {
+        message += '\n* Make sure you ran `pod install` in the ios/ directory.';
+      }
+      if (Platform.OS === 'android') {
+        message += '\n* Make sure gradle is synced.';
+      }
+      // check if Expo
+      const ExpoConstants =
+        NativeModules.NativeUnimoduleProxy?.modulesConstants?.ExponentConstants;
+      if (ExpoConstants != null) {
+        if (ExpoConstants.appOwnership === 'expo') {
+          // We're running Expo Go
+          throw new Error(
+            'react-native-mmkv is not supported in Expo Go! Use EAS (`expo prebuild`) or eject to a bare workflow instead.'
+          );
+        } else {
+          // We're running Expo bare / standalone
+          message += '\n* Make sure you ran `expo prebuild`.';
+        }
+      }
+
+      message += '\n* Make sure you rebuilt the app.';
+      throw new Error(message);
+    }
+
+    // Check if we are running on-device (JSI)
+    if (global.nativeCallSyncHook == null || MMKVModule.install == null) {
+      throw new Error(
+        'Failed to create a new MMKV instance: React Native is not running on-device. MMKV can only be used when synchronous method invocations (JSI) are possible. If you are using a remote debugger (e.g. Chrome), switch to an on-device debugger (e.g. Flipper) instead.'
+      );
+    }
+
+    // Call the synchronous blocking install() function
+    const result = MMKVModule.install(ROOT_DIRECTORY);
+    if (result !== true)
+      throw new Error(
+        `Failed to create a new MMKV instance: The native MMKV Module could not be installed! Looks like something went wrong when installing JSI bindings: ${result}`
+      );
+
+    // Check again if the constructor now exists. If not, throw an error.
+    if (global.mmkvCreateNewInstance == null)
+      throw new Error(
+        'Failed to create a new MMKV instance, the native initializer function does not exist. Are you trying to use MMKV from different JS Runtimes?'
+      );
+  }
+
+  return global.mmkvCreateNewInstance(config);
+};

package/src/createMMKV.web.ts

@@ -0,0 +1,119 @@
+/* global localStorage */
+import type { MMKVConfiguration, NativeMMKV } from 'react-native-mmkv';
+import { createTextEncoder } from './createTextEncoder';
+
+const canUseDOM =
+  typeof window !== 'undefined' && window.document?.createElement != null;
+
+const hasAccessToLocalStorage = () => {
+  try {
+    // throws ACCESS_DENIED error
+    window.localStorage;
+
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const KEY_WILDCARD = '\\';
+const inMemoryStorage = new Map<string, string>();
+
+export const createMMKV = (config: MMKVConfiguration): NativeMMKV => {
+  if (config.encryptionKey != null) {
+    throw new Error("MMKV: 'encryptionKey' is not supported on Web!");
+  }
+  if (config.path != null) {
+    throw new Error("MMKV: 'path' is not supported on Web!");
+  }
+
+  if (!hasAccessToLocalStorage()) {
+    console.warn(
+      'MMKV: LocalStorage has been disabled. Your experience will be limited to in-memory storage!'
+    );
+  }
+
+  const storage = () => {
+    if (!canUseDOM) {
+      throw new Error(
+        'Tried to access storage on the server. Did you forget to call this in useEffect?'
+      );
+    }
+
+    if (!hasAccessToLocalStorage()) {
+      return {
+        getItem: (key: string) => inMemoryStorage.get(key) ?? null,
+        setItem: (key: string, value: string) =>
+          inMemoryStorage.set(key, value),
+        removeItem: (key: string) => inMemoryStorage.delete(key),
+        clear: () => inMemoryStorage.clear(),
+        length: inMemoryStorage.size,
+        key: (index: number) => Object.keys(inMemoryStorage).at(index) ?? null,
+      } as Storage;
+    }
+
+    const domStorage =
+      global?.localStorage ?? window?.localStorage ?? localStorage;
+    if (domStorage == null) {
+      throw new Error(`Could not find 'localStorage' instance!`);
+    }
+    return domStorage;
+  };
+
+  const textEncoder = createTextEncoder();
+
+  if (config.id.includes(KEY_WILDCARD)) {
+    throw new Error(
+      'MMKV: `id` cannot contain the backslash character (`\\`)!'
+    );
+  }
+
+  const keyPrefix = `${config.id}${KEY_WILDCARD}`; // mmkv.default\\
+  const prefixedKey = (key: string) => {
+    if (key.includes('\\')) {
+      throw new Error(
+        'MMKV: `key` cannot contain the backslash character (`\\`)!'
+      );
+    }
+    return `${keyPrefix}${key}`;
+  };
+
+  return {
+    clearAll: () => {
+      const keys = Object.keys(storage());
+      for (const key of keys) {
+        if (key.startsWith(keyPrefix)) {
+          storage().removeItem(key);
+        }
+      }
+    },
+    delete: (key) => storage().removeItem(prefixedKey(key)),
+    set: (key, value) => {
+      storage().setItem(prefixedKey(key), value.toString());
+    },
+    getString: (key) => storage().getItem(prefixedKey(key)) ?? undefined,
+    getNumber: (key) => {
+      const value = storage().getItem(prefixedKey(key));
+      if (value == null) return undefined;
+      return Number(value);
+    },
+    getBoolean: (key) => {
+      const value = storage().getItem(prefixedKey(key));
+      if (value == null) return undefined;
+      return value === 'true';
+    },
+    getBuffer: (key) => {
+      const value = storage().getItem(prefixedKey(key));
+      if (value == null) return undefined;
+      return textEncoder.encode(value);
+    },
+    getAllKeys: () => {
+      const keys = Object.keys(storage());
+      return keys.filter((key) => key.startsWith(keyPrefix));
+    },
+    contains: (key) => storage().getItem(prefixedKey(key)) != null,
+    recrypt: () => {
+      throw new Error('`recrypt(..)` is not supported on Web!');
+    },
+  };
+};

package/src/createTextEncoder.ts

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