Merge branch 'release-4.0.1' into 'main'

ObjectBox Swift database 4.0.1

See merge request objectbox/objectbox-swift-public!18

Author: greenrobot-team

.gitignore

@@ -39,7 +39,10 @@ Carthage/Checkouts
 # ObjectBox model backups
 *.json.bak
 
-#DBs
+# ObjectBox static library download
+Source/external/objectbox-static/
+
+# ObjectBox database files
 *.mdb
 
 # E.g. built frameworks

CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+
+Notable changes to the ObjectBox Swift library.
+
+For more insights into what changed in the ObjectBox C++ core, [check the ObjectBox C changelog](https://github.com/objectbox/objectbox-c/blob/main/CHANGELOG.md).
+
+## 4.0.1 - 2024-10-16
+
+- Built with Xcode 15.0.1 and Swift 5.9.
+- Make closing the Store more robust. In addition to transactions, it also waits for ongoing queries. This is just an
+  additional safety net. Your apps should still make sure to finish all Store operations, like queries, before closing it.
+- Generator: no longer print a `Mapping not found` warning when an entity class uses `ToMany`.
+- Some minor vector search performance improvements.
+- Update to [ObjectBox C 4.0.2](https://github.com/objectbox/objectbox-c/releases/tag/v4.0.2).
+
+### Sync
+
+- **Fix a serious regression, please update as soon as possible.**
+
+## 4.0.0 - 2024-07-22
+
+**ObjectBox now supports [Vector Search](https://docs.objectbox.io/ann-vector-search)** to enable efficient similarity searches.
+
+This is particularly useful for AI/ML/RAG applications, e.g. image, audio, or text similarity. Other use cases include semantic search or recommendation engines.
+
+Create a Vector (HNSW) index for a floating point vector property. For example, a `City` with a location vector:
+
+```swift
+// objectbox: entity
+class City {
+
+    // objectbox:hnswIndex: dimensions=2
+    var location: [Float]?
+    
+}
+```
+
+Perform a nearest neighbor search using the new `nearestNeighbors(queryVector, maxCount)` query condition and the new "find with scores" query methods (the score is the distance to the query vector). For example, find the 2 closest cities:
+
+```swift
+let madrid = [40.416775, -3.703790]
+let query = try box
+        .query { City.coordinates.nearestNeighbors(queryVector: madrid, maxCount: 2) }
+        .build()
+let closest = query.findWithScores()[0].object
+```
+
+For an introduction to Vector Search, more details and other supported languages see the [Vector Search documentation](https://docs.objectbox.io/ann-vector-search).
+
+- Built with Xcode 15.0.1 and Swift 5.9.
+- The generator now displays an error when using an index on a property type that can not be indexed.
+- Update to [ObjectBox C 4.0.1](https://github.com/objectbox/objectbox-c/releases/tag/v4.0.1).
+
+## 2.0.0 - 2024-05-15
+
+- Built with Xcode 15.0.1 and Swift 5.9.
+- Support creating file-less in-memory databases, e.g. for caching and testing. To create one instead of a directory path pass `memory:` together with an identifier string when creating a `Store`:
+
+  ```swift
+  inMemoryStore = try Store(directoryPath: "memory:test-db");
+  ```
+
+  See the `Store` documentation for details.
+- Change `Store.closeAndDeleteAllFiles()` to support deleting an in-memory database.
+- Removed some deprecated APIs:
+  - Removed `findIntegers()` for property query, replaced by `find()`.
+  - Removed `find()` of `Box`, replaced by `all()`.
+- Update to [ObjectBox C 4.0.0](https://github.com/objectbox/objectbox-c/releases/tag/v4.0.0).
+
+## Previous versions
+
+See the [changelog in the documentation](https://swift.objectbox.io/).

Package.swift

@@ -16,8 +16,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "ObjectBox",
-            url: "https://github.com/objectbox/objectbox-swift/releases/download/v4.0.0/ObjectBox-xcframework-4.0.0.zip",
-            checksum: "2bed7b8b87dd46dda64fa1f5e7a0b1df87908a783690fda09c6dc943a01a32e5"
+            url: "https://github.com/objectbox/objectbox-swift/releases/download/v4.0.1/ObjectBox-xcframework-4.0.1.zip",
+            checksum: "02a0f686ced7488a9afe312e3b1a7cac634848709bd04cd904a3a5fa26ec8d31"
         )
     ]
 )

README.md

@@ -1,5 +1,5 @@
 <p align="center">
- <img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
+ <img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png" alt="ObjectBox">
 </p>
 
 <p align="center">
@@ -21,8 +21,7 @@
   </a>
 </p>
 
-Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
-===============
+# Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
 
 Powerful & superfast database for Swift that's also easy to use. Persist Swift objects quickly and reliably on-device on iOS and macOS.
 
@@ -72,6 +71,7 @@ Want details? **[Read the guides](https://swift.objectbox.io/)** or
 Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an intuitive Swift API that's easy to pick up, fun to work with, and incredibly fast, making it sustainable in many ways. Its frugal recource use (CPU, memory, battery / power) makes ObjectBox an ideal and sustainable choice for iOS apps. So why not give it a try right away? Check out the [installation section below](#adding-objectbox-to-your-project). You can also star this repository for later 🌟
 
 ### Features
+
 🧠 **Artificial Intelligence** - superfast [on-device vector search](https://docs.objectbox.io/on-device-ann-vector-search).\
 🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
 💚 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
@@ -87,9 +87,10 @@ Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an int
 👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
 🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
 
+<a name="cocoapods"></a>
+
+## Adding ObjectBox to your project
 
-<a name="cocoapods"></a>Adding ObjectBox to your project
---------------------------------------------------------
 ObjectBox is available as a [CocoaPods](https://cocoapods.org) pod. [See the docs](https://swift.objectbox.io/install) for details and alternative setup options.
 
 If you are new to CocoaPods, [check out their website](https://cocoapods.org) for an introduction and installation instructions.
@@ -116,7 +117,9 @@ e.g. check the [getting started guide](https://swift.objectbox.io/getting-starte
 
 If `pod install` fails, try updating CocoaPods first:
 
-    gem update xcodeproj && gem update cocoapods && pod repo update
+```bash
+gem update xcodeproj && gem update cocoapods && pod repo update
+```
 
 ## Updating to newer ObjectBox versions
 
@@ -128,8 +131,10 @@ pod update ObjectBox
 Pods/ObjectBox/setup.rb
 ```
 
-<a name="example"></a>Example
------------------------------
+<a name="example"></a>
+
+## Example
+
 In the [Example](Example/) directory, you'll find a "Notes" example app demonstrating ObjectBox's Swift API.
 The example comes with two apps: one for iOS and one for macOS. The iOS example is a full GUI application, whereas the macOS example runs a few operations and then exits.
 
@@ -139,76 +144,79 @@ Here's a list of ObjectBox releases, and the Swift versions they were compiled w
 
 | ObjectBox version(s) | Swift version |
 |:--------------------:|:-------------:|
+|        4.0.1         |      5.9      |
 |        4.0.0         |      5.9      |
 |        2.0.0         |      5.9      |
 |        1.9.2         |      5.9      |
 |        1.9.1         |      5.9      |
 |        1.9.0         |     5.8.1     |
-|        1.8.1         |     5.7.2     |        
-|        1.8.0         |     5.7.1     |        
-|        1.7.0         |      5.5      |        
-|        1.6.0         |      5.4      |        
-|        1.5.0         |    5.3(.2)    |        
-|        1.4.1         |      5.3      |        
-|      1.3, 1.4.0      |      5.2      |        
+|        1.8.1         |     5.7.2     |
+|        1.8.0         |     5.7.1     |
+|        1.7.0         |      5.5      |
+|        1.6.0         |      5.4      |
+|        1.5.0         |    5.3(.2)    |
+|        1.4.1         |      5.3      |
+|      1.3, 1.4.0      |      5.2      |
 |         1.2          |      5.1      |
 
 This might be relevant, e.g. when using Carthage. For various reasons, we recommend using the latest version.
 
-Development
------------
+## Changelog
+
+For notable and important changes in new releases, read the [changelog](CHANGELOG.md).
+
+## Development
+
 The source code for ObjectBox's Swift binding can be found [in the Source folder](Source/README.md) of this repository.
 
-Background: code generation
----------------------------
+## Background: code generation
+
 ObjectBox Swift Database generates code at build time for optimal performance at runtime by avoiding reflection etc.
 This is automatically done for you and should be transparent.
 Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
 
-Already using ObjectBox?
----------------------------
+## Already using ObjectBox?
 
 We're on a mission to bring joy, delight and sustainability to app developers. **To do this, we need your help:** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6). Let us know what you love and what is amiss, so we can improve.
 
 **We're looking forward to receiving your comments and requests:**
 
-- Add [GitHub issues](https://github.com/ObjectBox/objectbox-swift/issues) 
+- Add [GitHub issues](https://github.com/ObjectBox/objectbox-swift/issues)
 - Upvote issues you find important by hitting the 👍/+1 reaction button
 - Drop us a line via [@ObjectBox_io](https://twitter.com/ObjectBox_io/)
-- ⭐ us, if you like what you see 
+- ⭐ us, if you like what you see
 
 Thank you! 🙏
 
 Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox.io/blog)!
 
+## Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
 
-Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
-------------------------
-ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/): 
+ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/):
 
-* [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart): persist Dart objects & build cross-platform apps using Flutter.
-* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
-* [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
-* [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications. 
+- [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart): persist Dart objects & build cross-platform apps using Flutter.
+- [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
+- [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
+- [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
   also enables porting ObjectBox to other languages.
 
+## License
 
-License
--------
+```text
+Copyright 2018-2024 ObjectBox Ltd. All rights reserved.
 
-    Copyright 2018-2024 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.
-    You may obtain a copy of the License at
-    
-        http://www.apache.org/licenses/LICENSE-2.0
-    
-    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.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+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.
+```
 
 Note that this license applies to the code in this repository only.
 See our website on details about all [licenses for ObjectBox components](https://objectbox.io/faq/#license-pricing).

Source/external/objectbox-swift-generator

@@ -10,11 +10,11 @@ set -e
 
 # objectbox-swift release version on GitHub:
 # https://github.com/objectbox/objectbox-swift/releases/download/v${version}
-version=4.0.0
+version=4.0.1
 
 # C library version attached to the GitHub release:
 # ObjectBoxCore-static-${c_version}.zip
-c_version=4.0.1
+c_version=4.0.2
 
 # Params supported by apple-build-static-libs.sh
 build_params=""

Source/fetch_dependencies.command

@@ -6,6 +6,10 @@ This project is used to test code generation in ObjectBox's Sourcery-descended c
 It will run the codegen over a given target in the project, then build and run the product. You can do
 whatever testing you need to do in the actual Swift code.
 
+**Important note**: by passing the `--debug-parsetree` option to the generator in `RunToolTests.sh`
+it generates **non-random, stable UIDs**. See `runCLI()` of `objectbox-swift-generator/Sourcery/main.swift`.
+These are unlike (notably shorter) UIDs than are generated for a user project.
+
 ## Running these tests
 
 These tests require a copy of ObjectBox Swift Code Generator in a known location. To get that all set up, do the following:

Source/ios-framework/CodeGenTests/README.md

@@ -193,6 +193,8 @@ fail_codegen_target_num () {
 
     echo "// Ensure there's no leftover code from previous tests." > "$ENTITY_INFO_FILE_ACTUAL"
 
+    # Setting --debug-parsetree for the generator also makes it generate non-random UIDs,
+    # see objectbox-swift-generator/Sourcery/main.swift runCLI().
     echo "$SOURCERY --xcode-project \"$TESTPROJECT\" --xcode-target \"ToolTestProject${2}\" --model-json \"$MODEL_FILE_ACTUAL\" --debug-parsetree \"$DUMP_FILE_ACTUAL\" --output \"${ENTITY_INFO_FILE_ACTUAL}\" --disableCache"
     $SOURCERY --xcode-project "$TESTPROJECT" --xcode-target "ToolTestProject${2}" --model-json "$MODEL_FILE_ACTUAL" --debug-parsetree "$DUMP_FILE_ACTUAL" --output "${ENTITY_INFO_FILE_ACTUAL}" --disableCache > "$TESTMESSAGESFILE" 2>&1