Merge branch '76-export-query-property-classes' into 'main'

Show QueryProperty classes, docs fixes

See merge request objectbox/objectbox-dart!52

Author: greenrobot-team

objectbox/CHANGELOG.md

@@ -5,6 +5,7 @@
   ObjectBox library on these devices. [#369](https://github.com/objectbox/objectbox-dart/issues/369)
 * Improve code generator performance if there are many entities with many constructor parameters.
 * Throw `StateError` instead of crashing on closed `Box`, `Query` and `PropertyQuery`.
+* Export query property classes to make them usable in user code.
 
 ## 2.1.0 (2023-06-13)
 

objectbox/lib/internal.dart

@@ -2,23 +2,9 @@
 /// Don't import into your own code, use 'objectbox.dart' instead.
 library objectbox_internal;
 
-// ignore_for_file: invalid_export_of_internal_element
-
-export 'src/model.dart';
 export 'src/modelinfo/index.dart';
 export 'src/native/bindings/flatbuffers_readers.dart';
 export 'src/native/store.dart' show InternalStoreAccess;
-export 'src/query.dart'
-// don't export the same things as objectbox.dart to avoid docs conflicts
-    hide
-        Query,
-        QueryBuilder,
-        Order,
-        Condition,
-        PropertyQuery,
-        IntegerPropertyQuery,
-        DoublePropertyQuery,
-        StringPropertyQuery;
 export 'src/relations/info.dart';
 export 'src/relations/to_many.dart'
     show InternalToManyAccess, InternalToManyTestAccess;

objectbox/lib/objectbox.dart

@@ -23,7 +23,18 @@ export 'src/query.dart'
         QueryParamBytes,
         QueryParamInt,
         QueryParamBool,
-        QueryParamDouble;
+        QueryParamDouble,
+        QueryProperty,
+        QueryStringProperty,
+        QueryByteVectorProperty,
+        QueryIntegerProperty,
+        QueryIntegerVectorProperty,
+        QueryDoubleProperty,
+        QueryDoubleVectorProperty,
+        QueryBooleanProperty,
+        QueryStringVectorProperty,
+        QueryRelationToOne,
+        QueryRelationToMany;
 export 'src/relations/to_many.dart' show ToMany;
 export 'src/relations/to_one.dart' show ToOne;
 export 'src/store.dart' show Store, ObservableStore;

objectbox/lib/src/native/box.dart

@@ -360,10 +360,12 @@ class Box<T> {
   /// to be spawned.
   Future<T?> getAsync(int id) => _store.runAsync(_getAsyncCallback<T>, id);
 
-  /// Returns a list of [ids.length] Objects of type T, each corresponding to
-  /// the location of its ID in [ids]. Non-existent IDs become null.
+  /// Returns a list of Objects of type T, each located at the corresponding
+  /// position of its ID in [ids].
   ///
-  /// Pass growableResult: true for the resulting list to be growable.
+  /// If an object does not exist, null is added to the list instead.
+  ///
+  /// Set [growableResult] to `true` for the returned list to be growable.
   List<T?> getMany(List<int> ids, {bool growableResult = false}) {
     final result = List<T?>.filled(ids.length, null, growable: growableResult);
     if (ids.isEmpty) return result;

objectbox/lib/src/native/query/property.dart

@@ -105,7 +105,7 @@ extension IntegerPropertyQuery on PropertyQuery<int> {
 
   /// Set to only return distinct values.
   ///
-  /// E.g. [1,2,3] instead of [1,1,2,3,3,3].
+  /// E.g. `[1,2,3]` instead of `[1,1,2,3,3,3]`.
   /// Strings default to case-insensitive comparison.
   set distinct(bool d) {
     _distinct = d;
@@ -201,7 +201,7 @@ extension DoublePropertyQuery on PropertyQuery<double> {
 
   /// Set to only return distinct values.
   ///
-  /// E.g. [1,2,3] instead of [1,1,2,3,3,3].
+  /// E.g. `[1,2,3]` instead of `[1,1,2,3,3,3]`.
   /// Strings default to case-insensitive comparison.
   set distinct(bool d) {
     _distinct = d;
@@ -267,7 +267,7 @@ extension StringPropertyQuery on PropertyQuery<String> {
 
   /// Set to only return distinct values.
   ///
-  /// E.g. [foo, bar] instead of [foo, bar, bar, bar, foo].
+  /// E.g. `[foo, bar]` instead of `[foo, bar, bar, bar, foo]`.
   /// Strings default to case-insensitive comparison.
   set distinct(bool d) {
     _distinct = d;

objectbox/lib/src/native/query/query.dart

@@ -37,7 +37,7 @@ class Order {
   static final caseSensitive = 2;
 
   /// For integers only: changes the comparison to unsigned. The default is
-  /// signed, unless the property is annotated with [@Property(signed: false)].
+  /// signed, unless the property is annotated with `@Property(signed: false)`.
   static final unsigned = 4;
 
   /// null values will be put last.

objectbox/lib/src/native/store.dart

@@ -73,7 +73,7 @@ class Store implements Finalizable {
 
   late final ByteData _reference;
 
-  /// A list of observers of the Store.close() event.
+  /// A list of observers of the [Store.close] event.
   final _onClose = <dynamic, void Function()>{};
 
   /// If true and calling [close] will also close the native Store and
@@ -846,12 +846,12 @@ class InternalStoreAccess {
     return store._entityTypeById!;
   }
 
-  /// Adds a listener to the [store.close()] event.
+  /// Adds a listener to the [Store.close] event.
   static void addCloseListener(
           Store store, dynamic key, void Function() listener) =>
       store._onClose[key] = listener;
 
-  /// Removes a [store.close()] event listener.
+  /// Removes a [Store.close] event listener.
   static void removeCloseListener(Store store, dynamic key) =>
       store._onClose.remove(key);
 

objectbox/lib/src/relations/to_many.dart

@@ -303,7 +303,6 @@ class InternalToManyAccess {
 }
 
 /// Internal only.
-@internal
 @visibleForTesting
 class InternalToManyTestAccess<EntityT> {
   final ToMany<EntityT> _rel;

objectbox_test/test/query_property_test.dart

@@ -1,6 +1,5 @@
 import 'dart:math';
 
-import 'package:objectbox/internal.dart';
 import 'package:test/test.dart';
 
 import 'entity.dart';