ObjectBox Swift database 4.1.0

Author: greenrobot

Source/fetch_dependencies.command

@@ -6,18 +6,25 @@
 # Adjust 'version', 'c_version' and 'build_params' as needed and set the OBX_FEATURES environment
 # variable to get the right version for the current code.
 
+# To skip the tests of the ObjectBox C library, set the environment variable OBX_SKIP_STATIC_C_TESTS to any value.
+# This can be useful when working on that script, and tests are not needed because nothing changed.
+
 set -e
 
 # objectbox-swift release version on GitHub:
 # https://github.com/objectbox/objectbox-swift/releases/download/v${version}
-version=4.0.1
+version=4.1.0
 
 # C library version attached to the GitHub release:
 # ObjectBoxCore-static-${c_version}.zip
-c_version=4.0.2
+c_version=4.1.0
 
 # Params supported by apple-build-static-libs.sh
-build_params=""
+if [ -n "$OBX_SKIP_STATIC_C_TESTS" ]; then
+  build_params="--skip-tests"
+else
+  build_params=""
+fi
 
 # Skips building/fetching, only copy header files and print details
 if [ "${1:-}" == "--verify-only" ]; then
@@ -54,8 +61,8 @@ if [ "$verify_only" = true ]; then
 else
 
 if [ -d "$code_dir" ] && [ "$staging_repo" != "true" ]; then # Do we have an existing code repo? Then build it...
-    pushd "$code_dir" # note: this also "fixed" building into cbuild dir in "our" objectbox-swift dir  
-    
+    pushd "$code_dir" # note: this also "fixed" building into cbuild dir in "our" objectbox-swift dir
+
     echo "-----------------------------------------"
     xcode_version="$(xcodebuild -version | head -n 1 | tr -cd '[a-zA-Z0-9]._-')"
     echo "Xcode version: $xcode_version"
@@ -79,7 +86,9 @@ if [ -d "$code_dir" ] && [ "$staging_repo" != "true" ]; then # Do we have an exi
     mkdir -p "${cache_dir}"
     echo "-----------------------------------------"
     echo "Existing cache files:"
-    find "${cache_dir}" -name "objectbox-static-*.zip" -type f -mtime +30 # -delete # TODO enable delete once this looks good
+    find "${cache_dir}" -name "objectbox-static-*.zip" -type f
+    # Delete old files; set 'mtime +90' to find files last modified 90 days ago or before
+    find "${cache_dir}" -name "objectbox-static-*.zip" -type f -mtime +90 -delete
     echo "-----------------------------------------"
     cache_zip="${cache_dir}/objectbox-static-${cache_key}.zip"
 
@@ -187,4 +196,4 @@ for filename in ./*.a; do
   echo "  >> Architectures: $obx_archs"
   sha=($(shasum -a 256 "$filename"))
   echo "  >> SHA256: $sha"
-done
+done

Source/ios-framework/CodeGenTests/README.md

@@ -1,4 +1,4 @@
-#  Tool Test Project
+# ObjectBox Swift Code generator tests (CodeGenTests)
 
 ## What is it?
 

Source/ios-framework/CommonSource/Entities/HnswParams.swift

@@ -37,6 +37,12 @@ public enum HnswDistanceType: UInt16 {
   ///  Because of this, the dot product is often preferred as it performs better.
   ///  Value range (normalized vectors): 0.0 - 2.0 (0.0: same direction, 1.0: orthogonal, 2.0: opposite direction)
   case dotProduct = 3
+
+  /// 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.
+  /// Internally, this uses haversine distance.
+  case geo = 6
+
   ///  A custom dot product similarity measure that does not require the vectors to be normalized.
   ///  Note: this is no replacement for cosine similarity (like DotProduct for normalized vectors is).
   ///  The non-linear conversion provides a high precision over the entire float range (for the raw dot product).

Source/ios-framework/CommonSource/Errors.swift

@@ -32,6 +32,8 @@ public enum ObjectBoxError: Swift.Error {
     case illegalArgument(message: String)
     /// Thrown when a resource could not be allocated.
     case allocation(message: String)
+    /// This build of the ObjectBox library does not contain the requested feature
+    case featureNotAvailable(message: String)
     /// An unexpected error.
     case noErrorInfo(message: String)
     /// An unexpected error.
@@ -202,6 +204,8 @@ internal func throwObxErr(_ err: obx_err, message: String = "") throws -> Never
         throw ObjectBoxError.illegalArgument(message: message)
     case OBX_ERROR_ALLOCATION:
         throw ObjectBoxError.allocation(message: message)
+    case OBX_ERROR_FEATURE_NOT_AVAILABLE:
+        throw ObjectBoxError.featureNotAvailable(message: message)
     case OBX_ERROR_NO_ERROR_INFO:
         throw ObjectBoxError.noErrorInfo(message: message)
     case OBX_ERROR_GENERAL:

Source/ios-framework/CommonSource/Internal/objectbox-c-sync.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2024 ObjectBox Ltd. All rights reserved.
+ * Copyright 2018-2025 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@
 #include "objectbox-c.h"
 
 #if defined(static_assert) || defined(__cplusplus)
-static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 0 && OBX_VERSION_PATCH == 2,  // NOLINT
+static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 1 && OBX_VERSION_PATCH == 0,  // NOLINT
               "Versions of objectbox.h and objectbox-sync.h files do not match, please update");
 #endif
 
@@ -56,11 +56,19 @@ typedef struct OBX_sync OBX_sync;
 /// specifies a generic client-side credential type.
 typedef enum {
     OBXSyncCredentialsType_NONE = 1,
-    OBXSyncCredentialsType_SHARED_SECRET = 2,
+    OBXSyncCredentialsType_SHARED_SECRET = 2,  ///< Deprecated, replaced by SHARED_SECRET_SIPPED
     OBXSyncCredentialsType_GOOGLE_AUTH = 3,
-    OBXSyncCredentialsType_SHARED_SECRET_SIPPED = 4,
-    OBXSyncCredentialsType_OBX_ADMIN_USER = 5,
-    OBXSyncCredentialsType_USER_PASSWORD = 6,
+    OBXSyncCredentialsType_SHARED_SECRET_SIPPED = 4,  ///< Uses shared secret to create a hashed credential.
+    OBXSyncCredentialsType_OBX_ADMIN_USER = 5,        ///< ObjectBox admin users (username/password)
+    OBXSyncCredentialsType_USER_PASSWORD = 6,         ///< Generic credential type suitable for ObjectBox admin
+                                                      ///< (and possibly others in the future)
+    OBXSyncCredentialsType_JWT_ID = 7,      ///< JSON Web Token (JWT): an ID token that typically provides identity
+                                            ///< information about the authenticated user.
+    OBXSyncCredentialsType_JWT_ACCESS = 8,  ///< JSON Web Token (JWT): an access token that is used to access resources.
+    OBXSyncCredentialsType_JWT_REFRESH = 9,  ///< JSON Web Token (JWT): a refresh token that is used to obtain a new
+                                             ///< access token.
+    OBXSyncCredentialsType_JWT_CUSTOM = 10,  ///< JSON Web Token (JWT): a token that is neither an ID, access,
+                                             ///< nor refresh token.
 } OBXSyncCredentialsType;
 
 // TODO sync prefix
@@ -194,8 +202,11 @@ OBX_C_API OBX_sync* obx_sync_urls(OBX_store* store, const char* server_urls[], s
 OBX_C_API obx_err obx_sync_close(OBX_sync* sync);
 
 /// Sets credentials to authenticate the client with the server.
-/// See OBXSyncCredentialsType for available options.
-/// The accepted OBXSyncCredentials type depends on your sync-server configuration.
+/// Any credentials that were set before are replaced;
+/// if you want to pass multiple credentials, use obx_sync_credentials_add() instead.
+/// If the client was waiting for credentials, this can trigger a reconnection/login attempt.
+/// @param type See OBXSyncCredentialsType for available options.
+///        The accepted OBXSyncCredentials type depends on your sync-server configuration.
 /// @param data may be NULL in combination with OBXSyncCredentialsType_NONE
 OBX_C_API obx_err obx_sync_credentials(OBX_sync* sync, OBXSyncCredentialsType type, const void* data, size_t size);
 
@@ -207,6 +218,29 @@ OBX_C_API obx_err obx_sync_credentials(OBX_sync* sync, OBXSyncCredentialsType ty
 OBX_C_API obx_err obx_sync_credentials_user_password(OBX_sync* sync, OBXSyncCredentialsType type, const char* username,
                                                      const char* password);
 
+/// For authentication with multiple credentials, collect credentials by calling this function multiple times.
+/// When adding the last credentials element, the "complete" flag must be set to true.
+/// When completed, it will "activate" the collected credentials and replace any previously set credentials and
+/// potentially trigger a reconnection/login attempt.
+/// @param type See OBXSyncCredentialsType for available options.
+///        The accepted OBXSyncCredentials type depends on your sync-server configuration.
+/// @param data non-NULL (OBXSyncCredentialsType_NONE is not allowed)
+/// @param complete set to true when adding the last credentials element to activate the set of credentials
+OBX_C_API obx_err obx_sync_credentials_add(OBX_sync* sync, OBXSyncCredentialsType type, const void* data, size_t size,
+                                           bool complete);
+
+/// For authentication with multiple credentials, collect credentials by calling this function multiple times.
+/// When adding the last credentials element, the "complete" flag must be set to true.
+/// When completed, it will "activate" the collected credentials and replace any previously set credentials and
+/// potentially trigger a reconnection/login attempt.
+/// @param type See OBXSyncCredentialsType for available options.
+///        The accepted OBXSyncCredentials type depends on your sync-server configuration.
+/// @param username non-NULL
+/// @param password non-NULL
+/// @param complete set to true when adding the last credentials element to activate the set of credentials
+OBX_C_API obx_err obx_sync_credentials_add_user_password(OBX_sync* sync, OBXSyncCredentialsType type,
+                                                         const char* username, const char* password, bool complete);
+
 /// Configures the maximum number of outgoing TX messages that can be sent without an ACK from the server.
 /// @returns OBX_ERROR_ILLEGAL_ARGUMENT if value is not in the range 1-20
 OBX_C_API obx_err obx_sync_max_messages_in_flight(OBX_sync* sync, int value);
@@ -374,9 +408,9 @@ OBX_C_API void obx_sync_listener_msg_objects(OBX_sync* sync, OBX_sync_listener_m
                                              void* listener_arg);
 
 /// Set or overwrite a previously set 'error' listener - provides information about occurred sync-level errors.
-/// @param listener set NULL to reset
+/// @param listener The callback to receive sync errors. Set to NULL to reset.
 /// @param listener_arg is a pass-through argument passed to the listener
-OBX_C_API void obx_sync_listener_error(OBX_sync* sync, OBX_sync_listener_error* error, void* listener_arg);
+OBX_C_API void obx_sync_listener_error(OBX_sync* sync, OBX_sync_listener_error* listener, void* listener_arg);
 
 //----------------------------------------------
 // Sync Stats
@@ -702,7 +736,7 @@ typedef enum {
 
 /// Get u64 value for sync server statistics.
 /// @param counter_type the counter value to be read (make sure to choose a uint64_t (u64) metric value type).
-/// @param out_count receives the counter value.
+/// @param out_value receives the counter value.
 /// @return OBX_SUCCESS if the counter has been successfully retrieved.
 /// @return OBX_ERROR_ILLEGAL_ARGUMENT if counter_type is undefined (this also happens if the wrong type is requested)
 /// @return OBX_ERROR_ILLEGAL_STATE if the server is not started.
@@ -711,7 +745,7 @@ OBX_C_API obx_err obx_sync_server_stats_u64(OBX_sync_server* server, OBXSyncServ
 
 /// Get double value for sync server statistics.
 /// @param counter_type the counter value to be read (make sure to use a double (f64) metric value type).
-/// @param out_count receives the counter value.
+/// @param out_value receives the counter value.
 /// @return OBX_SUCCESS if the counter has been successfully retrieved.
 /// @return OBX_ERROR_ILLEGAL_ARGUMENT if counter_type is undefined (this also happens if the wrong type is requested)
 /// @return OBX_ERROR_ILLEGAL_STATE if the server is not started.
@@ -785,7 +819,7 @@ typedef void OBX_custom_msg_server_func_client_connection_close(void* server_use
 /// Callback to shutdown and free all resources associated with the sync client connection to the custom server.
 /// Note that the custom server may already have been shutdown at this point (e.g. no server user data is supplied).
 /// Must be provided to implement a custom server. See notes on OBX_custom_msg_server_functions for more details.
-/// @param server_user_data User supplied data returned by the function that created the server
+/// @param connection_user_data User supplied data returned by the function that created the server
 typedef void OBX_custom_msg_server_func_client_connection_shutdown(void* connection_user_data);
 
 /// Struct of the custom server function callbacks. In order to implement the custom server, you must provide