react-native-mmkv 3.2.0 → 4.0.0-beta.0

package/react-native-mmkv.podspec

@@ -1,7 +1,6 @@
 require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
 
 Pod::UI.puts "[react-native-mmkv] Thank you for using react-native-mmkv ❤️"
 Pod::UI.puts "[react-native-mmkv] If you enjoy using react-native-mmkv, please consider sponsoring this project: https://github.com/sponsors/mrousavy"
@@ -18,21 +17,16 @@ Pod::Spec.new do |s|
   s.source       = { :git => "https://github.com/mrousavy/react-native-mmkv.git", :tag => "#{s.version}" }
 
   s.pod_target_xcconfig = {
-    "CLANG_CXX_LANGUAGE_STANDARD" => "c++17",
-    "CLANG_CXX_LIBRARY" => "libc++",
-    "CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF" => "NO",
-    # FORCE_POSIX ensures we are using C++ types instead of Objective-C types for MMKV.
-    "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited) FORCE_POSIX",
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
   }
   s.compiler_flags = '-x objective-c++'
-
+  s.libraries    = "z", "c++"
   s.source_files = [
     # react-native-mmkv
     "ios/**/*.{h,m,mm}",
-    "cpp/**/*.{hpp,cpp,c,h}",
-    # MMKV/Core
-    "MMKV/Core/**/*.{h,cpp,hpp,S}",
+    "cpp/**/*.{hpp,cpp,c,h}"
   ]
 
+  s.dependency 'MMKVCore', '>= 2.2.3'
   install_modules_dependencies(s)
 end

package/react-native.config.js

@@ -17,4 +17,13 @@ module.exports = {
       },
     },
   },
+  // Codegen configuration for TurboModules
+  codegenConfig: {
+    name: 'RNMmkvSpec',
+    type: 'modules',
+    jsSrcsDir: 'src',
+    android: {
+      javaPackageName: 'com.mrousavy.mmkv',
+    },
+  },
 };

package/src/MMKV.ts

@@ -83,7 +83,7 @@ export class MMKV implements MMKVInterface {
     const func = this.getFunctionFromCache('getNumber');
     return func(key);
   }
-  getBuffer(key: string): ArrayBuffer | undefined {
+  getBuffer(key: string): ArrayBufferLike | undefined {
     const func = this.getFunctionFromCache('getBuffer');
     return func(key);
   }

package/src/Types.ts

@@ -70,6 +70,12 @@ export interface Configuration {
    * @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;
 }
 
 /**
@@ -105,7 +111,7 @@ export interface NativeMMKV {
    *
    * @default undefined
    */
-  getBuffer: (key: string) => ArrayBuffer | undefined;
+  getBuffer: (key: string) => ArrayBufferLike | undefined;
   /**
    * Checks whether the given `key` is being stored in this MMKV instance.
    */

package/src/createMMKV.web.ts

@@ -106,7 +106,7 @@ export const createMMKV = (config: Configuration): NativeMMKV => {
     getBuffer: (key) => {
       const value = storage().getItem(prefixedKey(key));
       if (value == null) return undefined;
-      return textEncoder.encode(value);
+      return textEncoder.encode(value).buffer;
     },
     getAllKeys: () => {
       const keys = Object.keys(storage());

package/src/hooks.ts

@@ -51,7 +51,7 @@ export function useMMKV(configuration?: Configuration): MMKV {
 }
 
 function createMMKVHook<
-  T extends (boolean | number | string | ArrayBuffer) | undefined,
+  T extends (boolean | number | string | ArrayBufferLike) | undefined,
   TSet extends T | undefined,
   TSetAction extends TSet | ((current: T) => TSet),
 >(getter: (instance: MMKV, key: string) => T) {

package/MMKV/Core/CMakeLists.txt

@@ -1,172 +0,0 @@
-#
-# Tencent is pleased to support the open source community by making
-# MMKV available.
-#
-# Copyright (C) 2019 THL A29 Limited, a Tencent company.
-# All rights reserved.
-#
-# Licensed under the BSD 3-Clause License (the "License"); you may not use
-# this file except in compliance with the License. You may obtain a copy of
-# the License at
-#
-#       https://opensource.org/licenses/BSD-3-Clause
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# Sets the minimum version of CMake required to build the native library.
-
-cmake_minimum_required(VERSION 3.10.0)
-
-IF(APPLE)
-    # tell ranlib to ignore empty compilation units
-    SET(CMAKE_C_ARCHIVE_FINISH   "<CMAKE_RANLIB> -no_warning_for_no_symbols -c <TARGET>")
-    SET(CMAKE_CXX_ARCHIVE_FINISH "<CMAKE_RANLIB> -no_warning_for_no_symbols -c <TARGET>")
-    # prevents ar from invoking ranlib, let CMake do it
-    SET(CMAKE_C_ARCHIVE_CREATE   "<CMAKE_AR> qc -S <TARGET> <LINK_FLAGS> <OBJECTS>")
-    SET(CMAKE_CXX_ARCHIVE_CREATE "<CMAKE_AR> qc -S <TARGET> <LINK_FLAGS> <OBJECTS>")
-
-    add_compile_definitions(FORCE_POSIX)
-ENDIF()
-
-set(can_use_assembler TRUE)
-enable_language(ASM)
-IF("${ANDROID_ABI}" STREQUAL "arm64-v8a")
-    SET(ASM_OPTIONS "-x assembler-with-cpp")
-    SET(CMAKE_ASM_FLAGS "${CFLAGS} ${ASM_OPTIONS} -march=armv8+crypto -D__ANDROID__")
-ELSEIF("${ANDROID_ABI}" STREQUAL "armeabi-v7a")
-    SET(ASM_OPTIONS "-x assembler-with-cpp")
-    SET(CMAKE_ASM_FLAGS "${CFLAGS} ${ASM_OPTIONS} -march=armv7a -D__ANDROID__")
-ELSEIF("${ANDROID_ABI}" STREQUAL "armeabi")
-    SET(ASM_OPTIONS "-x assembler-with-cpp")
-    SET(CMAKE_ASM_FLAGS "${CFLAGS} ${ASM_OPTIONS} -march=armv5 -D__ANDROID__")
-ENDIF()
-
-#include(CMakePrintHelpers)
-#cmake_print_variables(CMAKE_SYSTEM_PROCESSOR OHOS OHOS_ARCH CFLAGS ASM_OPTIONS CMAKE_ASM_FLAGS)
-
-IF(OHOS)
-    IF("${OHOS_ARCH}" STREQUAL "arm64-v8a")
-        SET(ASM_OPTIONS "-x assembler-with-cpp")
-        SET(CMAKE_ASM_FLAGS "${CFLAGS} ${ASM_OPTIONS} -march=armv8+crypto -D__MUSL__")
-    ENDIF()
-ELSEIF(UNIX AND (NOT APPLE))
-    IF("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "aarch64")
-        SET(ASM_OPTIONS "-x assembler-with-cpp")
-        SET(CMAKE_ASM_FLAGS "${CFLAGS} ${ASM_OPTIONS} -march=armv8-a+crypto")
-    ENDIF()
-ENDIF()
-
-
-project(core)
-
-# Creates and names a library, sets it as either STATIC
-# or SHARED, and provides the relative paths to its source code.
-# You can define multiple libraries, and CMake builds them for you.
-# Gradle automatically packages shared libraries with your APK.
-
-add_library(core
-
-        # Sets the library as a shared library.
-        STATIC
-
-        # Provides a relative path to your source file(s).
-        MMKV.h
-        MMKV.cpp
-        MMKV_Android.cpp
-        MMKV_IO.h
-        MMKV_IO.cpp
-        MMKV_OSX.cpp
-        MMKVLog.h
-        MMKVLog.cpp
-        MMKVLog_Android.cpp
-        CodedInputData.h
-        CodedInputData.cpp
-        CodedInputData_OSX.cpp
-        CodedInputDataCrypt.h
-        CodedInputDataCrypt.cpp
-        CodedInputDataCrypt_OSX.cpp
-        CodedOutputData.h
-        CodedOutputData.cpp
-        KeyValueHolder.h
-        KeyValueHolder.cpp
-        PBUtility.h
-        PBUtility.cpp
-        MiniPBCoder.h
-        MiniPBCoder.cpp
-        MiniPBCoder_OSX.cpp
-        MMBuffer.h
-        MMBuffer.cpp
-        InterProcessLock.h
-        InterProcessLock.cpp
-        InterProcessLock_Win32.cpp
-        InterProcessLock_Android.cpp
-        MemoryFile.h
-        MemoryFile.cpp
-        MemoryFile_Android.cpp
-        MemoryFile_Linux.cpp
-        MemoryFile_Win32.cpp
-        MemoryFile_OSX.cpp
-        ThreadLock.h
-        ThreadLock.cpp
-        ThreadLock_Win32.cpp
-        MMKVMetaInfo.hpp
-        aes/AESCrypt.h
-        aes/AESCrypt.cpp
-        aes/openssl/openssl_aes.h
-        aes/openssl/openssl_aes_core.cpp
-        aes/openssl/openssl_aes_locl.h
-        aes/openssl/openssl_cfb128.cpp
-        aes/openssl/openssl_opensslconf.h
-        aes/openssl/openssl_md5_dgst.cpp
-        aes/openssl/openssl_md5_locl.h
-        aes/openssl/openssl_md5_one.cpp
-        aes/openssl/openssl_md5.h
-        aes/openssl/openssl_md32_common.h
-        aes/openssl/openssl_arm_arch.h
-        crc32/Checksum.h
-        crc32/crc32_armv8.cpp
-        crc32/zlib/zconf.h
-        crc32/zlib/zutil.h
-        crc32/zlib/crc32.h
-        crc32/zlib/crc32.cpp
-        MMKVPredef.h
-        )
-
-IF (MSVC OR (CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64"))
-    # .S files is not supported by MSVC.
-    # x86_64 asm not supported in OHOS
-ELSE()
-    target_sources(core PRIVATE
-        aes/openssl/openssl_aesv8-armx.S
-        aes/openssl/openssl_aes-armv4.S)
-ENDIF()
-
-target_include_directories(core PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
-
-IF (WIN32)
-    # MMKV can be used only with Unicode on Windows.
-    target_compile_definitions(core PUBLIC UNICODE)
-    target_compile_definitions(core PUBLIC _UNICODE)
-ENDIF()
-
-set_target_properties(core PROPERTIES
-        CXX_STANDARD 20
-        CXX_EXTENSIONS OFF
-        POSITION_INDEPENDENT_CODE ON
-        )
-
-find_library(zlib
-        z
-        )
-
-IF (NOT zlib)
-    target_compile_definitions(core PUBLIC MMKV_EMBED_ZLIB=1)
-ELSE()
-    target_link_libraries(core ${zlib})
-ENDIF()
-

package/MMKV/Core/CodedInputData.cpp

@@ -1,252 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * MMKV available.
- *
- * Copyright (C) 2018 THL A29 Limited, a Tencent company.
- * All rights reserved.
- *
- * Licensed under the BSD 3-Clause License (the "License"); you may not use
- * this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- *       https://opensource.org/licenses/BSD-3-Clause
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include "CodedInputData.h"
-#include "PBUtility.h"
-#include <stdexcept>
-#include <cstring>
-
-#ifdef MMKV_APPLE
-#    if __has_feature(objc_arc)
-#        error This file must be compiled with MRC. Use -fno-objc-arc flag.
-#    endif
-#endif // MMKV_APPLE
-
-using namespace std;
-
-namespace mmkv {
-
-CodedInputData::CodedInputData(const void *oData, size_t length)
-    : m_ptr((uint8_t *) oData), m_size(length), m_position(0) {
-    MMKV_ASSERT(m_ptr);
-}
-
-void CodedInputData::seek(size_t addedSize) {
-    if (m_position + addedSize > m_size) {
-        throw out_of_range("OutOfSpace");
-    }
-    m_position += addedSize;
-}
-
-double CodedInputData::readDouble() {
-    return Int64ToFloat64(this->readRawLittleEndian64());
-}
-
-float CodedInputData::readFloat() {
-    return Int32ToFloat32(this->readRawLittleEndian32());
-}
-
-int64_t CodedInputData::readInt64() {
-    int32_t shift = 0;
-    int64_t result = 0;
-    while (shift < 64) {
-        int8_t b = this->readRawByte();
-        result |= (int64_t)(b & 0x7f) << shift;
-        if ((b & 0x80) == 0) {
-            return result;
-        }
-        shift += 7;
-    }
-    throw invalid_argument("InvalidProtocolBuffer malformedInt64");
-}
-
-uint64_t CodedInputData::readUInt64() {
-    return static_cast<uint64_t>(readInt64());
-}
-
-int32_t CodedInputData::readInt32() {
-    return this->readRawVarint32();
-}
-
-uint32_t CodedInputData::readUInt32() {
-    return static_cast<uint32_t>(readRawVarint32());
-}
-
-bool CodedInputData::readBool() {
-    return this->readRawVarint32() != 0;
-}
-
-#ifndef MMKV_APPLE
-
-string CodedInputData::readString() {
-    int32_t size = readRawVarint32();
-    if (size < 0) {
-        throw length_error("InvalidProtocolBuffer negativeSize");
-    }
-
-    auto s_size = static_cast<size_t>(size);
-    if (s_size <= m_size - m_position) {
-        string result((char *) (m_ptr + m_position), s_size);
-        m_position += s_size;
-        return result;
-    } else {
-        throw out_of_range("InvalidProtocolBuffer truncatedMessage");
-    }
-}
-
-void CodedInputData::readString(string &s) {
-    int32_t size = readRawVarint32();
-    if (size < 0) {
-        throw length_error("InvalidProtocolBuffer negativeSize");
-    }
-
-    auto s_size = static_cast<size_t>(size);
-    if (s_size <= m_size - m_position) {
-        s.resize(s_size);
-        memcpy((void *) s.data(), (char *) (m_ptr + m_position), s_size);
-        m_position += s_size;
-    } else {
-        throw out_of_range("InvalidProtocolBuffer truncatedMessage");
-    }
-}
-
-string CodedInputData::readString(KeyValueHolder &kvHolder) {
-    kvHolder.offset = static_cast<uint32_t>(m_position);
-
-    int32_t size = this->readRawVarint32();
-    if (size < 0) {
-        throw length_error("InvalidProtocolBuffer negativeSize");
-    }
-
-    auto s_size = static_cast<size_t>(size);
-    if (s_size <= m_size - m_position) {
-        kvHolder.keySize = static_cast<uint16_t>(s_size);
-
-        auto ptr = m_ptr + m_position;
-        string result((char *) (m_ptr + m_position), s_size);
-        m_position += s_size;
-        return result;
-    } else {
-        throw out_of_range("InvalidProtocolBuffer truncatedMessage");
-    }
-}
-
-#endif
-
-MMBuffer CodedInputData::readRealData(mmkv::MMBuffer & data) {
-    CodedInputData input(data.getPtr(), data.length());
-    return input.readData(false, true);
-}
-
-MMBuffer CodedInputData::readData(bool copy, bool exactly) {
-    int32_t size = this->readRawVarint32();
-    if (size < 0) {
-        throw length_error("InvalidProtocolBuffer negativeSize");
-    }
-
-    auto s_size = static_cast<size_t>(size);
-    bool isSizeValid = exactly ? (s_size == m_size - m_position) : (s_size <= m_size - m_position);
-    if (isSizeValid) {
-        size_t pos = m_position;
-        m_position += s_size;
-        auto copyFlag = copy ? MMBufferCopy : MMBufferNoCopy;
-        return MMBuffer(((int8_t *) m_ptr) + pos, s_size, copyFlag);
-    } else {
-        throw out_of_range("InvalidProtocolBuffer truncatedMessage");
-    }
-}
-
-void CodedInputData::readData(KeyValueHolder &kvHolder) {
-    int32_t size = this->readRawVarint32();
-    if (size < 0) {
-        throw length_error("InvalidProtocolBuffer negativeSize");
-    }
-
-    auto s_size = static_cast<size_t>(size);
-    if (s_size <= m_size - m_position) {
-        kvHolder.computedKVSize = static_cast<uint16_t>(m_position - kvHolder.offset);
-        kvHolder.valueSize = static_cast<uint32_t>(s_size);
-
-        m_position += s_size;
-    } else {
-        throw out_of_range("InvalidProtocolBuffer truncatedMessage");
-    }
-}
-
-int32_t CodedInputData::readRawVarint32() {
-    int8_t tmp = this->readRawByte();
-    if (tmp >= 0) {
-        return tmp;
-    }
-    int32_t result = tmp & 0x7f;
-    if ((tmp = this->readRawByte()) >= 0) {
-        result |= tmp << 7;
-    } else {
-        result |= (tmp & 0x7f) << 7;
-        if ((tmp = this->readRawByte()) >= 0) {
-            result |= tmp << 14;
-        } else {
-            result |= (tmp & 0x7f) << 14;
-            if ((tmp = this->readRawByte()) >= 0) {
-                result |= tmp << 21;
-            } else {
-                result |= (tmp & 0x7f) << 21;
-                result |= (tmp = this->readRawByte()) << 28;
-                if (tmp < 0) {
-                    // discard upper 32 bits
-                    for (int i = 0; i < 5; i++) {
-                        if (this->readRawByte() >= 0) {
-                            return result;
-                        }
-                    }
-                    throw invalid_argument("InvalidProtocolBuffer malformed varint32");
-                }
-            }
-        }
-    }
-    return result;
-}
-
-int32_t CodedInputData::readRawLittleEndian32() {
-    int8_t b1 = this->readRawByte();
-    int8_t b2 = this->readRawByte();
-    int8_t b3 = this->readRawByte();
-    int8_t b4 = this->readRawByte();
-    return (((int32_t) b1 & 0xff)) | (((int32_t) b2 & 0xff) << 8) | (((int32_t) b3 & 0xff) << 16) |
-           (((int32_t) b4 & 0xff) << 24);
-}
-
-int64_t CodedInputData::readRawLittleEndian64() {
-    int8_t b1 = this->readRawByte();
-    int8_t b2 = this->readRawByte();
-    int8_t b3 = this->readRawByte();
-    int8_t b4 = this->readRawByte();
-    int8_t b5 = this->readRawByte();
-    int8_t b6 = this->readRawByte();
-    int8_t b7 = this->readRawByte();
-    int8_t b8 = this->readRawByte();
-    return (((int64_t) b1 & 0xff)) | (((int64_t) b2 & 0xff) << 8) | (((int64_t) b3 & 0xff) << 16) |
-           (((int64_t) b4 & 0xff) << 24) | (((int64_t) b5 & 0xff) << 32) | (((int64_t) b6 & 0xff) << 40) |
-           (((int64_t) b7 & 0xff) << 48) | (((int64_t) b8 & 0xff) << 56);
-}
-
-int8_t CodedInputData::readRawByte() {
-    if (m_position == m_size) {
-        auto msg = "reach end, m_position: " + to_string(m_position) + ", m_size: " + to_string(m_size);
-        throw out_of_range(msg);
-    }
-    auto *bytes = (int8_t *) m_ptr;
-    return bytes[m_position++];
-}
-
-#ifdef MMKV_APPLE
-#endif // MMKV_APPLE
-
-} // namespace mmkv

package/MMKV/Core/CodedInputData.h

@@ -1,87 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * MMKV available.
- *
- * Copyright (C) 2018 THL A29 Limited, a Tencent company.
- * All rights reserved.
- *
- * Licensed under the BSD 3-Clause License (the "License"); you may not use
- * this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- *       https://opensource.org/licenses/BSD-3-Clause
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef MMKV_CODEDINPUTDATA_H
-#define MMKV_CODEDINPUTDATA_H
-#ifdef __cplusplus
-
-#include "MMKVPredef.h"
-
-#include "KeyValueHolder.h"
-#include "MMBuffer.h"
-#include <cstdint>
-
-namespace mmkv {
-
-class CodedInputData {
-    uint8_t *const m_ptr;
-    size_t m_size;
-    size_t m_position;
-
-    int8_t readRawByte();
-
-    int32_t readRawVarint32();
-
-    int32_t readRawLittleEndian32();
-
-    int64_t readRawLittleEndian64();
-
-public:
-    CodedInputData(const void *oData, size_t length);
-
-    bool isAtEnd() const { return m_position == m_size; };
-
-    void seek(size_t addedSize);
-
-    bool readBool();
-
-    double readDouble();
-
-    float readFloat();
-
-    int64_t readInt64();
-
-    uint64_t readUInt64();
-
-    int32_t readInt32();
-
-    uint32_t readUInt32();
-
-    // exactly is like getValueSize(actualSize = true)
-    MMBuffer readData(bool copy = true, bool exactly = false);
-    void readData(KeyValueHolder &kvHolder);
-
-    static MMBuffer readRealData(mmkv::MMBuffer & data);
-
-#ifndef MMKV_APPLE
-    std::string readString();
-    void readString(std::string &s);
-    std::string readString(KeyValueHolder &kvHolder);
-#else
-    NSString *readString();
-    NSString *readString(KeyValueHolder &kvHolder);
-    NSData *readNSData();
-#endif
-};
-
-} // namespace mmkv
-
-#endif
-#endif //MMKV_CODEDINPUTDATA_H