Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add an empty changelog section #8483

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Add an empty changelog section #8483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 40 additions & 19 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
x.y.z Release notes (yyyy-MM-dd)
=============================================================
### Enhancements
* None.

### Fixed
* <How to hit and notice issue? what was the impact?> ([#????](https://github.com/realm/realm-swift/issues/????), since v?.?.?)
* None.

<!-- ### Breaking Changes - ONLY INCLUDE FOR NEW MAJOR version -->

### Compatibility
* Realm Studio: 14.0.1 or later.
* APIs are backwards compatible with all previous releases in the 10.x.y series.
* Carthage release for Swift is built with Xcode 15.2.0.
* CocoaPods: 1.10 or later.
* Xcode: 14.2-15.2.0.

### Internal
* Upgraded realm-core from ? to ?

10.47.0 Release notes (2024-02-12)
=============================================================

Expand Down Expand Up @@ -956,7 +977,7 @@ supported version.

### Deprecations

* `App.SyncManager.logLevel` and `App.SyncManager.logFunction` are deprecated in favour of
* `App.SyncManager.logLevel` and `App.SyncManager.logFunction` are deprecated in favour of
setting a default logger.

### Compatibility
Expand Down Expand Up @@ -1688,7 +1709,7 @@ The prebuilt binary for Carthage is now build with Xcode 14.0.1.
object ids.
### Breaking Changes
* Private API `_realmColumnNames` has been renamed to a new public API
called `propertiesMapping()`. This change only affects the Swift API
called `propertiesMapping()`. This change only affects the Swift API
and doesn't have any effects in the obj-c API.

### Compatibility
Expand Down Expand Up @@ -1793,7 +1814,7 @@ The prebuilt binary for Carthage is now build with Xcode 14.0.1.
sectionedResults = realm.objects(DemoObject.self)
.sectioned(by: \.firstLetter, ascending: true)
```
* Add `@ObservedSectionedResults` for SwiftUI support. This property wrapper type retrieves sectioned results
* Add `@ObservedSectionedResults` for SwiftUI support. This property wrapper type retrieves sectioned results
from a Realm using a keyPath or callback to determine the section key.
```swift
struct DemoView: View {
Expand Down Expand Up @@ -2325,7 +2346,7 @@ Non-synchronized Realm files remain backwards-compatible.
then the client reset process reverts to manual mode.
- The realm's underlying object accessors remain bound so the UI may be updated in a non-disruptive way.
* Added support for client reset notification blocks for `.discardLocal` and `RLMClientResetDiscardLocal`
- **RealmSwift implementation**: `discardLocal(((Realm) -> Void)? = nil, ((Realm, Realm) -> Void)? = nil)`
- **RealmSwift implementation**: `discardLocal(((Realm) -> Void)? = nil, ((Realm, Realm) -> Void)? = nil)`
- RealmSwift client reset blocks are set when initializing the user configuration
```swift
var configuration = user.configuration(partitionValue: "myPartition", clientResetMode: .discardLocal(beforeClientResetBlock, afterClientResetBlock))
Expand Down Expand Up @@ -2380,7 +2401,7 @@ Non-synchronized Realm files remain backwards-compatible.
`.environment(\.realmConfiguration, ...)` if they did not match
([Cocoa #7463](https://github.com/realm/realm-swift/issues/7463), since v10.6.0).
* Fix searchable component filter overriding the initial filter on `@ObservedResults`, (since v10.23.0).
* Comparing `Results`, `LinkingObjects` or `AnyRealmCollection` when using Realm via XCFramework
* Comparing `Results`, `LinkingObjects` or `AnyRealmCollection` when using Realm via XCFramework
would result in compile time errors ([Cocoa #7615](https://github.com/realm/realm-swift/issues/7615), since v10.21.0)
* Opening an encrypted Realm while the keychain is locked on macOS would crash
([#7438](https://github.com/realm/realm-swift/issues/7438)).
Expand Down Expand Up @@ -2443,7 +2464,7 @@ no functional changes from 10.24.0.

### Enhancements

* Add ability to use Swift Query syntax in `@ObservedResults`, which allows you
* Add ability to use Swift Query syntax in `@ObservedResults`, which allows you
to filter results using the `where` parameter.

### Fixed
Expand Down Expand Up @@ -2507,7 +2528,7 @@ no functional changes from 10.24.0.
be copied to the `fileURL` of the new Realm. If a Realm file already exists at the
desitnation path, the seed file will not be copied and the already existing Realm
will be opened instead. Note that to use this parameter with a synced Realm configuration
the seed Realm must be appropriately copied to a destination with
the seed Realm must be appropriately copied to a destination with
`Realm.writeCopy(configuration:)`/`[RLMRealm writeCopyForConfiguration:]` first.
* Add ability to permanently delete a User from a MongoDB Realm app. This can
be invoked with `User.delete()`/`[RLMUser deleteWithCompletion:]`.
Expand Down Expand Up @@ -2610,7 +2631,7 @@ no functional changes from 10.24.0.
### Enhancements

* Add `metadata` property to `RLMUserProfile`/`UserProfile`.
* Add class `Projection` to allow creation of light weight view models out of Realm Objects.
* Add class `Projection` to allow creation of light weight view models out of Realm Objects.
```swift
public class Person: Object {
@Persisted var firstName = ""
Expand Down Expand Up @@ -3046,15 +3067,15 @@ r `User.linkUser` methods.

### Enhancements

* Sync logs now contain information about what object/changeset was being applied when the exception was thrown.
* Sync logs now contain information about what object/changeset was being applied when the exception was thrown.
([Core #4836](https://github.com/realm/realm-core/issues/4836))
* Added ServiceErrorCode for wrong username/password when using '`App.login`.
* Added ServiceErrorCode for wrong username/password when using '`App.login`.
([Core #7380](https://github.com/realm/realm-swift/issues/7380)

### Fixed

* Fix crash in `MongoCollection.findOneDocument(filter:)` that occurred when no results were
found for a given filter.
found for a given filter.
([Cocoa #7380](https://github.com/realm/realm-swift/issues/7380), since v10.0.0)
* Some of the SwiftUI property wrappers incorrectly required objects to conform
to ObjectKeyIdentifiable rather than Identifiable.
Expand Down Expand Up @@ -3758,20 +3779,20 @@ Xcode 12.2 is now the minimum supported version.

### Enhancements

* Add `@StateRealmObject` for SwiftUI support. This property wrapper type instantiates an observable object on a View.
* Add `@StateRealmObject` for SwiftUI support. This property wrapper type instantiates an observable object on a View.
Use in place of `SwiftUI.StateObject` for Realm `Object`, `List`, and `EmbeddedObject` types.
* Add `@ObservedRealmObject` for SwiftUI support. This property wrapper type subscribes to an observable object
and invalidates a view whenever the observable object changes. Use in place of `SwiftUI.ObservedObject` for
Realm `Object`, `List`, or `EmbeddedObject` types.
* Add `@ObservedResults` for SwiftUI support. This property wrapper type retrieves results from a Realm.
The results use the realm configuration provided by the environment value `EnvironmentValues.realmConfiguration`.
* Add `EnvironmentValues.realm` and `EnvironmentValues.realmConfiguration` for `Realm`
and `Realm.Configuration` types respectively. Values can be injected into views using the `View.environment` method, e.g., `MyView().environment(\.realmConfiguration, Realm.Configuration(fileURL: URL(fileURLWithPath: "myRealmPath.realm")))`.
and `Realm.Configuration` types respectively. Values can be injected into views using the `View.environment` method, e.g., `MyView().environment(\.realmConfiguration, Realm.Configuration(fileURL: URL(fileURLWithPath: "myRealmPath.realm")))`.
The value can then be declared on the example `MyView` as `@Environment(\.realm) var realm`.
* Add `SwiftUI.Binding` extensions where `Value` is of type `Object`, `List`, or `EmbeddedObject`.
These extensions expose methods for wrapped write transactions, to avoid boilerplate within
* Add `SwiftUI.Binding` extensions where `Value` is of type `Object`, `List`, or `EmbeddedObject`.
These extensions expose methods for wrapped write transactions, to avoid boilerplate within
views, e.g., `TextField("name", $personObject.name)` or `$personList.append(Person())`.
* Add `Object.bind` and `EmbeddedObject.bind` for SwiftUI support. This allows you to create
* Add `Object.bind` and `EmbeddedObject.bind` for SwiftUI support. This allows you to create
bindings of realm properties when a propertyWrapper is not available for you to do so, e.g., `TextField("name", personObject.bind(\.name))`.
* The Sync client now logs error messages received from server rather than just
the size of the error message.
Expand Down Expand Up @@ -4603,7 +4624,7 @@ later will be able to open the new file format.
owned by a single parent object, and are deleted when that parent object is
deleted. They are defined by subclassing `EmbeddedObject` /
`RLMEmbeddedObject` rather than `Object` / `RLMObject`.
* Add `-[RLMSyncUser customData]`/`SyncUser.customData`. Custom data is
* Add `-[RLMSyncUser customData]`/`SyncUser.customData`. Custom data is
configured in your MongoDB Realm App.
* Add `-[RLMApp callFunctionNamed:arguments]`/`RealmApp.functions`. This is the
entry point for calling Remote MongoDB Realm functions. Functions allow you
Expand Down Expand Up @@ -5257,7 +5278,7 @@ later will be able to open the new file format.
owned by a single parent object, and are deleted when that parent object is
deleted. They are defined by subclassing `EmbeddedObject` /
`RLMEmbeddedObject` rather than `Object` / `RLMObject`.
* Add `-[RLMSyncUser customData]`/`SyncUser.customData`. Custom data is
* Add `-[RLMSyncUser customData]`/`SyncUser.customData`. Custom data is
configured in your MongoDB Realm App.
* Add `-[RLMApp callFunctionNamed:arguments]`/`RealmApp.functions`. This is the
entry point for calling Remote MongoDB Realm functions. Functions allow you
Expand Down Expand Up @@ -5456,7 +5477,7 @@ later will be able to open the new file format.

NOTE: This version bumps the Realm file format to version 10. It is not
possible to downgrade version 9 or earlier. Files created with older versions
of Realm will be automatically upgraded. Only
of Realm will be automatically upgraded. Only
[Studio 3.11](https://github.com/realm/realm-studio/releases/tag/v3.11.0) or later will be able
to open the new file format.

Expand Down
Loading