Add reference property in Field class.

Author: happy-san

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.5.1
+
+* Added `reference` property in `Field` class.
+
 # 0.5.0
 
 * Added support for nested object fields.

README.md

@@ -12,7 +12,7 @@ Add `typesense` as a [dependency in your pubspec.yaml file](https://flutter.dev/
 
 ```@yaml
 dependencies:
-  typesense: ^0.5.0
+  typesense: ^0.5.1
 ```
 
 ## Usage

example/console-simple/pubspec.lock

@@ -127,7 +127,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.5.0"
+    version: "0.5.1"
   web:
     dependency: transitive
     description:

lib/src/models/field.dart

@@ -43,6 +43,11 @@ class Field {
   /// be enabled on a per-field basis.
   final bool enableInfixSearch;
 
+  /// Connects a document to a field in another collection.
+  ///
+  /// Example value: `ReferencedCollectionName.fieldName`.
+  final String? reference;
+
   Field(
     this.name, {
     this.type,
@@ -54,6 +59,7 @@ class Field {
     this.locale,
     this.sort = false,
     this.enableInfixSearch = false,
+    this.reference,
   }) {
     if (name.isEmpty) {
       throw ArgumentError('Ensure Field.name is not empty');
@@ -77,6 +83,7 @@ class Field {
       locale: map['locale'],
       sort: map['sort'] ?? false,
       enableInfixSearch: map['infix'] ?? false,
+      reference: map['reference'],
     );
   }
 
@@ -107,6 +114,9 @@ class Field {
     if (enableInfixSearch) {
       map['infix'] = true;
     }
+    if (reference != null) {
+      map['reference'] = reference;
+    }
     return map;
   }
 
@@ -126,7 +136,8 @@ class Field {
       shouldIndex.hashCode ^
       locale.hashCode ^
       sort.hashCode ^
-      enableInfixSearch.hashCode;
+      enableInfixSearch.hashCode ^
+      reference.hashCode;
 
   @override
   bool operator ==(Object other) {
@@ -141,7 +152,8 @@ class Field {
         other.shouldIndex == shouldIndex &&
         other.locale == locale &&
         other.sort == sort &&
-        other.enableInfixSearch == enableInfixSearch;
+        other.enableInfixSearch == enableInfixSearch &&
+        other.reference == reference;
   }
 }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: typesense
 description: Dart client library for accessing the HTTP API of Typesense search engine.
-version: 0.5.0
+version: 0.5.1
 repository: https://github.com/typesense/typesense-dart
 
 environment:
@@ -15,3 +15,4 @@ dev_dependencies:
   mockito: ^5.4.4
   lints: ^3.0.0
   build_runner: ^2.4.8
+  analyzer: ^6.4.1

test/models/field_test.dart

@@ -16,6 +16,7 @@ void main() {
         locale: 'en',
         sort: true,
         enableInfixSearch: true,
+        reference: 'RefColl.field',
       );
       f2 = Field.fromMap({
         "name": "country",
@@ -26,6 +27,7 @@ void main() {
         "locale": "en",
         "sort": true,
         "infix": true,
+        "reference": "RefColl.field",
       });
     });
 
@@ -65,6 +67,10 @@ void main() {
       expect(f1.enableInfixSearch, isTrue);
       expect(f2.enableInfixSearch, isTrue);
     });
+    test('has a reference field', () {
+      expect(f1.reference, 'RefColl.field');
+      expect(f2.reference, 'RefColl.field');
+    });
     test('has a toMap method', () {
       final map = {
         'name': 'country',
@@ -73,6 +79,7 @@ void main() {
         'locale': 'en',
         'sort': true,
         'infix': true,
+        'reference': 'RefColl.field',
       };
       expect(f1.toMap(), equals(map));
       expect(f2.toMap(), equals(map));
@@ -265,6 +272,7 @@ void main() {
       expect(field.locale, isNull);
       expect(field.sort, isFalse);
       expect(field.enableInfixSearch, isFalse);
+      expect(field.reference, isNull);
     });
   });
   group('Field toMap()', () {