Skip to content

Commit 044754b

Browse files
refactor(specs): re-organise response for Composition API (generated)
algolia/api-clients-automation#5744 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent 1b08816 commit 044754b

16 files changed

+125
-232
lines changed

packages/client_composition/lib/algolia_client_composition.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,11 @@ export 'src/model/rules_multiple_batch_response.dart';
8585
export 'src/model/search.dart';
8686
export 'src/model/search_composition_rules_params.dart';
8787
export 'src/model/search_composition_rules_response.dart';
88+
export 'src/model/search_fields.dart';
8889
export 'src/model/search_for_facet_values_params.dart';
8990
export 'src/model/search_for_facet_values_request.dart';
9091
export 'src/model/search_for_facet_values_response.dart';
9192
export 'src/model/search_for_facet_values_results.dart';
92-
export 'src/model/search_hits.dart';
93-
export 'src/model/search_pagination.dart';
9493
export 'src/model/search_response.dart';
9594
export 'src/model/search_results.dart';
9695
export 'src/model/search_results_item.dart';

packages/client_composition/lib/src/deserialize.dart

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,11 @@ import 'package:algolia_client_composition/src/model/rules_multiple_batch_respon
7878
import 'package:algolia_client_composition/src/model/search.dart';
7979
import 'package:algolia_client_composition/src/model/search_composition_rules_params.dart';
8080
import 'package:algolia_client_composition/src/model/search_composition_rules_response.dart';
81+
import 'package:algolia_client_composition/src/model/search_fields.dart';
8182
import 'package:algolia_client_composition/src/model/search_for_facet_values_params.dart';
8283
import 'package:algolia_client_composition/src/model/search_for_facet_values_request.dart';
8384
import 'package:algolia_client_composition/src/model/search_for_facet_values_response.dart';
8485
import 'package:algolia_client_composition/src/model/search_for_facet_values_results.dart';
85-
import 'package:algolia_client_composition/src/model/search_hits.dart';
86-
import 'package:algolia_client_composition/src/model/search_pagination.dart';
8786
import 'package:algolia_client_composition/src/model/search_response.dart';
8887
import 'package:algolia_client_composition/src/model/search_results.dart';
8988
import 'package:algolia_client_composition/src/model/search_results_item.dart';
@@ -322,6 +321,8 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
322321
case 'SearchCompositionRulesResponse':
323322
return SearchCompositionRulesResponse.fromJson(
324323
value as Map<String, dynamic>) as ReturnType;
324+
case 'SearchFields':
325+
return SearchFields.fromJson(value as Map<String, dynamic>) as ReturnType;
325326
case 'SearchForFacetValuesParams':
326327
return SearchForFacetValuesParams.fromJson(value as Map<String, dynamic>)
327328
as ReturnType;
@@ -334,11 +335,6 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
334335
case 'SearchForFacetValuesResults':
335336
return SearchForFacetValuesResults.fromJson(value as Map<String, dynamic>)
336337
as ReturnType;
337-
case 'SearchHits':
338-
return SearchHits.fromJson(value as Map<String, dynamic>) as ReturnType;
339-
case 'SearchPagination':
340-
return SearchPagination.fromJson(value as Map<String, dynamic>)
341-
as ReturnType;
342338
case 'SearchResponse':
343339
return SearchResponse.fromJson(value as Map<String, dynamic>)
344340
as ReturnType;

packages/client_composition/lib/src/model/composition_base_search_response.dart

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,16 @@
22
// ignore_for_file: unused_element
33
import 'package:algolia_client_composition/src/model/compositions_search_response.dart';
44

5-
import 'package:collection/collection.dart';
65
import 'package:json_annotation/json_annotation.dart';
76

87
part 'composition_base_search_response.g.dart';
98

10-
@JsonSerializable(createFieldMap: true)
11-
final class CompositionBaseSearchResponse
12-
extends DelegatingMap<String, dynamic> {
9+
@JsonSerializable()
10+
final class CompositionBaseSearchResponse {
1311
/// Returns a new [CompositionBaseSearchResponse] instance.
1412
const CompositionBaseSearchResponse({
1513
this.compositions,
16-
Map<String, dynamic> additionalProperties = const {},
17-
}) : super(additionalProperties);
14+
});
1815

1916
@JsonKey(name: r'compositions')
2017
final CompositionsSearchResponse? compositions;
@@ -23,26 +20,15 @@ final class CompositionBaseSearchResponse
2320
bool operator ==(Object other) =>
2421
identical(this, other) ||
2522
other is CompositionBaseSearchResponse &&
26-
other.compositions == compositions &&
27-
const MapEquality<String, dynamic>().equals(this, this);
23+
other.compositions == compositions;
2824

2925
@override
30-
int get hashCode =>
31-
compositions.hashCode + const MapEquality<String, dynamic>().hash(this);
32-
33-
factory CompositionBaseSearchResponse.fromJson(Map<String, dynamic> json) {
34-
final instance = _$CompositionBaseSearchResponseFromJson(json);
35-
final additionalProperties = Map<String, dynamic>.from(json)
36-
..removeWhere((key, value) =>
37-
_$CompositionBaseSearchResponseFieldMap.containsKey(key));
38-
return CompositionBaseSearchResponse(
39-
compositions: instance.compositions,
40-
additionalProperties: additionalProperties,
41-
);
42-
}
26+
int get hashCode => compositions.hashCode;
27+
28+
factory CompositionBaseSearchResponse.fromJson(Map<String, dynamic> json) =>
29+
_$CompositionBaseSearchResponseFromJson(json);
4330

44-
Map<String, dynamic> toJson() =>
45-
_$CompositionBaseSearchResponseToJson(this)..addAll(this);
31+
Map<String, dynamic> toJson() => _$CompositionBaseSearchResponseToJson(this);
4632

4733
@override
4834
String toString() {

packages/client_composition/lib/src/model/composition_base_search_response.g.dart

Lines changed: 0 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/client_composition/lib/src/model/composition_run_applied_rules.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ final class CompositionRunAppliedRules {
1212
required this.objectID,
1313
});
1414

15-
/// Unique record identifier.
15+
/// The objectID of the applied composition rule on this query.
1616
@JsonKey(name: r'objectID')
1717
final String objectID;
1818

packages/client_composition/lib/src/model/composition_run_search_response.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ final class CompositionRunSearchResponse
1717
Map<String, dynamic> additionalProperties = const {},
1818
}) : super(additionalProperties);
1919

20-
/// Unique record identifier.
20+
/// The objectID of the composition which generated this result set.
2121
@JsonKey(name: r'objectID')
2222
final String objectID;
2323

packages/client_composition/lib/src/model/results_compositions_response.dart

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22
// ignore_for_file: unused_element
33
import 'package:algolia_client_composition/src/model/results_composition_info_response.dart';
44

5-
import 'package:collection/collection.dart';
65
import 'package:json_annotation/json_annotation.dart';
76

87
part 'results_compositions_response.g.dart';
98

10-
@JsonSerializable(createFieldMap: true)
11-
final class ResultsCompositionsResponse extends DelegatingMap<String, dynamic> {
9+
@JsonSerializable()
10+
final class ResultsCompositionsResponse {
1211
/// Returns a new [ResultsCompositionsResponse] instance.
1312
const ResultsCompositionsResponse({
1413
required this.compositions,
15-
Map<String, dynamic> additionalProperties = const {},
16-
}) : super(additionalProperties);
14+
});
1715

1816
@JsonKey(name: r'compositions')
1917
final Map<String, ResultsCompositionInfoResponse> compositions;
@@ -22,26 +20,15 @@ final class ResultsCompositionsResponse extends DelegatingMap<String, dynamic> {
2220
bool operator ==(Object other) =>
2321
identical(this, other) ||
2422
other is ResultsCompositionsResponse &&
25-
other.compositions == compositions &&
26-
const MapEquality<String, dynamic>().equals(this, this);
23+
other.compositions == compositions;
2724

2825
@override
29-
int get hashCode =>
30-
compositions.hashCode + const MapEquality<String, dynamic>().hash(this);
31-
32-
factory ResultsCompositionsResponse.fromJson(Map<String, dynamic> json) {
33-
final instance = _$ResultsCompositionsResponseFromJson(json);
34-
final additionalProperties = Map<String, dynamic>.from(json)
35-
..removeWhere((key, value) =>
36-
_$ResultsCompositionsResponseFieldMap.containsKey(key));
37-
return ResultsCompositionsResponse(
38-
compositions: instance.compositions,
39-
additionalProperties: additionalProperties,
40-
);
41-
}
26+
int get hashCode => compositions.hashCode;
27+
28+
factory ResultsCompositionsResponse.fromJson(Map<String, dynamic> json) =>
29+
_$ResultsCompositionsResponseFromJson(json);
4230

43-
Map<String, dynamic> toJson() =>
44-
_$ResultsCompositionsResponseToJson(this)..addAll(this);
31+
Map<String, dynamic> toJson() => _$ResultsCompositionsResponseToJson(this);
4532

4633
@override
4734
String toString() {

packages/client_composition/lib/src/model/results_compositions_response.g.dart

Lines changed: 0 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/client_composition/lib/src/model/results_injected_item_applied_rules_info_response.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ final class ResultsInjectedItemAppliedRulesInfoResponse {
1212
required this.objectID,
1313
});
1414

15-
/// Unique record identifier.
15+
/// The objectID of the applied index level rule on this injected group.
1616
@JsonKey(name: r'objectID')
1717
final String objectID;
1818

packages/client_composition/lib/src/model/results_injected_item_info_response.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ final class ResultsInjectedItemInfoResponse
1717
Map<String, dynamic> additionalProperties = const {},
1818
}) : super(additionalProperties);
1919

20+
/// The key of the injected group.
2021
@JsonKey(name: r'key')
2122
final String key;
2223

0 commit comments

Comments
 (0)