Version 4.3.0

Author: greenrobot

CHANGELOG.md

@@ -1,6 +1,23 @@
 ObjectBox C and C++ API Changelog
 =================================
 
+4.3.0 (2025-05-12)
+------------------
+* Windows: msvc runtime is now embedded to avoid incompatible msvcp140.dll (e.g. those shipped with some JDKs)
+* External property types (via MongoDB connector): JsonToNative to support sub (embedded/nested) documents/arrays in MongoDB 
+* External property types (via MongoDB connector): support ID mapping to UUIDs (v4 and v7)
+* Admin: add class and dependency diagrams to the schema page (view and download)
+* Admin: improved data view for large vectors by displaying only the first elements and the full vector in a dialog
+* Admin: detects images stored as bytes and shows them as such (PNG, GIF, JPEG, SVG, WEBP)
+
+### Sync
+
+* Add "Log Events" for important server events, which can be viewed on new Admin page
+* Detect and ignore changes for objects that were put but were unchanged
+* The limit for message size was raised to 32 MB
+* Transactions above the message size limit will already fail on the client now (to better enforce the limit)
+* C++: add missing APIs for JWT token credentials
+
 4.2.0 (2025-03-04)
 ------------------
 * Extended the model by external names and types:

CMakeLists.txt

@@ -49,7 +49,7 @@ else ()
 
     function(defineObjectBoxLib VARIANT)
         # Configuration updated for each release
-        set(DL_VERSION 4.2.0)
+        set(DL_VERSION 4.3.0)
 
         # Platform detection and other setup
         set(DL_URL https://github.com/objectbox/objectbox-c/releases/download)

README.md

@@ -18,7 +18,7 @@ box.put({.text = "Buy milk"});
 
 See [ObjectBox C and C++ docs](https://cpp.objectbox.io/) for API details.
 
-**Latest version: 4.2.0** (2025-03-04).
+**Latest version: 4.3.0** (2025-05-12).
 See [changelog](CHANGELOG.md) for more details.
 
 ## Table of Contents:

download.sh

@@ -44,7 +44,7 @@ tty -s || quiet=true
 
 # Note: optional arguments like "--quiet" shifts argument positions in the case block above
 
-version=${1:-4.2.0}
+version=${1:-4.3.0}
 os=${2:-$(uname)}
 arch=${3:-$(uname -m)}
 echo "Base config: OS ${os} and architecture ${arch}"

doxygen/Changelog.md

@@ -3,6 +3,23 @@
 ObjectBox C and C++ API Changelog
 =================================
 
+4.3.0 (2025-05-12)
+------------------
+* Windows: msvc runtime is now embedded to avoid incompatible msvcp140.dll (e.g. those shipped with some JDKs)
+* External property types (via MongoDB connector): JsonToNative to support sub (embedded/nested) documents/arrays in MongoDB 
+* External property types (via MongoDB connector): support ID mapping to UUIDs (v4 and v7)
+* Admin: add class and dependency diagrams to the schema page (view and download)
+* Admin: improved data view for large vectors by displaying only the first elements and the full vector in a dialog
+* Admin: detects images stored as bytes and shows them as such (PNG, GIF, JPEG, SVG, WEBP)
+
+### Sync
+
+* Add "Log Events" for important server events, which can be viewed on new Admin page
+* Detect and ignore changes for objects that were put but were unchanged
+* The limit for message size was raised to 32 MB
+* Transactions above the message size limit will already fail on the client now (to better enforce the limit)
+* C++: add missing APIs for JWT token credentials
+
 4.2.0 (2025-03-04)
 ------------------
 * Extended the model by external names and types:

doxygen/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ObjectBox C and C++ API"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "4.2.0"
+PROJECT_NUMBER         = "4.3.0"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

include/objectbox-sync.h

@@ -34,7 +34,7 @@
 #include "objectbox.h"
 
 #if defined(static_assert) || defined(__cplusplus)
-static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 2 && OBX_VERSION_PATCH == 0,  // NOLINT
+static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 3 && OBX_VERSION_PATCH == 0,  // NOLINT
               "Versions of objectbox.h and objectbox-sync.h files do not match, please update");
 #endif
 

include/objectbox-sync.hpp

@@ -16,14 +16,18 @@
 
 #pragma once
 
+#include <chrono>
+
 #include "objectbox-sync.h"
 #include "objectbox.hpp"
 
-static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 2 && OBX_VERSION_PATCH == 0,  // NOLINT
+static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 3 && OBX_VERSION_PATCH == 0,  // NOLINT
               "Versions of objectbox.h and objectbox-sync.hpp files do not match, please update");
 
 namespace obx {
 
+/// Credentials for logging into a Sync Server that are passed to SyncClient.
+/// Typically created using a factory method, e.g. `SyncCredentials::none()` or `SyncCredentials::jwtIdToken(...)`.
 class SyncCredentials {
     friend SyncClient;
     friend SyncServer;
@@ -72,6 +76,23 @@ class SyncCredentials {
     static SyncCredentials userPassword(const std::string& username, const std::string& password) {
         return SyncCredentials(OBXSyncCredentialsType::OBXSyncCredentialsType_USER_PASSWORD, username, password);
     }
+
+    static SyncCredentials jwtIdToken(const std::string& token) {
+        return SyncCredentials(OBXSyncCredentialsType::OBXSyncCredentialsType_JWT_ID, token);
+    }
+
+    static SyncCredentials jwtAccessToken(const std::string& token) {
+        return SyncCredentials(OBXSyncCredentialsType::OBXSyncCredentialsType_JWT_ACCESS, token);
+    }
+
+    static SyncCredentials jwtRefreshToken(const std::string& token) {
+        return SyncCredentials(OBXSyncCredentialsType::OBXSyncCredentialsType_JWT_REFRESH, token);
+    }
+
+    static SyncCredentials jwtCustomToken(const std::string& token) {
+        return SyncCredentials(OBXSyncCredentialsType::OBXSyncCredentialsType_JWT_CUSTOM, token);
+    }
+
 };
 
 /// Listens to login events on a sync client.
@@ -801,7 +822,7 @@ class SyncServer : public Closable {
     /// - accepted credentials via setCredentials() (always required)
     /// - SSL certificate info via setCertificatePath() (required if you use wss)
     /// \note The model given via store_options is also used to verify the compatibility of the models presented by
-    /// clients.
+    ///       clients.
     ///       E.g. a client with an incompatible model will be rejected during login.
     /// @param storeOptions Options for the server's store. Will be "consumed"; do not use the Options object again.
     /// @param url The URL (following the pattern protocol:://IP:port) the server should listen on.

include/objectbox.h

@@ -52,7 +52,7 @@ extern "C" {
 /// When using ObjectBox as a dynamic library, you should verify that a compatible version was linked using
 /// obx_version() or obx_version_is_at_least().
 #define OBX_VERSION_MAJOR 4
-#define OBX_VERSION_MINOR 2
+#define OBX_VERSION_MINOR 3
 #define OBX_VERSION_PATCH 0  // values >= 100 are reserved for dev releases leading to the next minor/major increase
 
 //----------------------------------------------
@@ -479,8 +479,8 @@ typedef enum {
     /// Value range (normalized vectors): 0.0 - 2.0 (0.0: same direction, 1.0: orthogonal, 2.0: opposite direction)
     OBXVectorDistanceType_DotProduct = 3,
 
-    OBXVectorDistanceType_Manhattan = 4,
-    OBXVectorDistanceType_Hamming = 5,
+    // OBXVectorDistanceType_Manhattan = 4,
+    // OBXVectorDistanceType_Hamming = 5,
 
     /// For geospatial coordinates aka latitude/longitude pairs.
     /// Note, that the vector dimension must be 2, with the latitude being the first element and longitude the second.
@@ -625,16 +625,31 @@ typedef enum {
     /// Encoding: 1:1 binary representation, little endian (16 bytes)
     OBXExternalPropertyType_Int128 = 100,
     // OBXExternalPropertyType_Reserved1 = 101,
+    /// A UUID (Universally Unique Identifier) as defined by RFC 9562.
+    /// ObjectBox uses the UUIDv7 scheme (timestamp + random) to create new UUIDs.
+    /// UUIDv7 is a good choice for database keys as it's mostly sequential and encodes a timestamp.
+    /// However, if keys are used externally, consider UuidV4 for better privacy by not exposing any time information.
     /// Representing type: ByteVector
     /// Encoding: 1:1 binary representation (16 bytes)
     OBXExternalPropertyType_Uuid = 102,
     /// IEEE 754 decimal128 type, e.g. supported by MongoDB
     /// Representing type: ByteVector
     /// Encoding: 1:1 binary representation (16 bytes)
     OBXExternalPropertyType_Decimal128 = 103,
-    // OBXExternalPropertyType_Reserved2 = 104,
-    // OBXExternalPropertyType_Reserved3 = 105,
-    // OBXExternalPropertyType_Reserved4 = 106,
+    /// UUID represented as a string of 36 characters, e.g. "019571b4-80e3-7516-a5c1-5f1053d23fff".
+    /// For efficient storage, consider the Uuid type instead, which occupies only 16 bytes (20 bytes less).
+    /// This type may still be a convenient alternative as the string type is widely supported and more human-readable.
+    /// In accordance to standards, new UUIDs generated by ObjectBox use lowercase hexadecimal digits.
+    /// Representing type: String
+    OBXExternalPropertyType_UuidString = 104,
+    /// A UUID (Universally Unique Identifier) as defined by RFC 9562.
+    /// ObjectBox uses the UUIDv4 scheme (completely random) to create new UUIDs.
+    /// Representing type: ByteVector
+    /// Encoding: 1:1 binary representation (16 bytes)
+    OBXExternalPropertyType_UuidV4 = 105,
+    /// Like UuidString, but using the UUIDv4 scheme (completely random) to create new UUID.
+    /// Representing type: String
+    OBXExternalPropertyType_UuidV4String = 106,
     /// A key/value map; e.g. corresponds to a JSON object or a MongoDB document (although not keeping the key order).
     /// Unlike the Flex type, this must contain a map value (e.g. not a vector or a scalar).
     /// Representing type: Flex
@@ -654,14 +669,19 @@ typedef enum {
     /// JavaScript source code
     /// Representing type: String
     OBXExternalPropertyType_JavaScript = 111,
-    // OBXExternalPropertyType_Reserved5 = 112,
+    /// A JSON string that is converted to a native representation in the external system.
+    /// For example, a JSON object on the ObjectBox side (string) would be converted to an embedded document in MongoDB.
+    /// It depends on the external system what kind of JSON structures is supported.
+    /// For MongoDB, this is very flexible and allows (nested) objects, arrays, primitives, etc.
+    /// Representing type: String
+    OBXExternalPropertyType_JsonToNative = 112,
     // OBXExternalPropertyType_Reserved6 = 113,
     // OBXExternalPropertyType_Reserved7 = 114,
     // OBXExternalPropertyType_Reserved8 = 115,
     /// A vector (array) of Int128 values
     OBXExternalPropertyType_Int128Vector = 116,
     // OBXExternalPropertyType_Reserved9 = 117,
-    /// A vector (array) of Int128 values
+    /// A vector (array) of Uuid values
     OBXExternalPropertyType_UuidVector = 118,
     // OBXExternalPropertyType_Reserved10 = 119,
     // OBXExternalPropertyType_Reserved11 = 120,
@@ -2956,4 +2976,4 @@ OBX_C_API obx_err obx_admin_close(OBX_admin* admin);
 
 #endif  // OBJECTBOX_H
 
-/**@}*/  // end of doxygen group
+/**@}*/  // end of doxygen group

include/objectbox.hpp

@@ -36,7 +36,7 @@
 #include <optional>
 #endif
 
-static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 2 && OBX_VERSION_PATCH == 0,  // NOLINT
+static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 3 && OBX_VERSION_PATCH == 0,  // NOLINT
               "Versions of objectbox.h and objectbox.hpp files do not match, please update");
 
 #ifdef __clang__