feat(specs): add fields for metadata in composition injectedItems (generated)

algolia/api-clients-automation#5241

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Gavin Wade <[email protected]>

Author: algolia-bot

packages/client_composition/lib/algolia_client_composition.dart

@@ -25,6 +25,7 @@ export 'src/model/facet_stats.dart';
 export 'src/model/facets.dart';
 export 'src/model/highlight_result_option.dart';
 export 'src/model/hit.dart';
+export 'src/model/hit_metadata.dart';
 export 'src/model/hit_ranking_info.dart';
 export 'src/model/match_level.dart';
 export 'src/model/matched_geo_location.dart';

packages/client_composition/lib/src/deserialize.dart

@@ -18,6 +18,7 @@ import 'package:algolia_client_composition/src/model/facet_stats.dart';
 import 'package:algolia_client_composition/src/model/facets.dart';
 import 'package:algolia_client_composition/src/model/highlight_result_option.dart';
 import 'package:algolia_client_composition/src/model/hit.dart';
+import 'package:algolia_client_composition/src/model/hit_metadata.dart';
 import 'package:algolia_client_composition/src/model/hit_ranking_info.dart';
 import 'package:algolia_client_composition/src/model/match_level.dart';
 import 'package:algolia_client_composition/src/model/matched_geo_location.dart';
@@ -119,6 +120,8 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
           as ReturnType;
     case 'Hit':
       return Hit.fromJson(value as Map<String, dynamic>) as ReturnType;
+    case 'HitMetadata':
+      return HitMetadata.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'HitRankingInfo':
       return HitRankingInfo.fromJson(value as Map<String, dynamic>)
           as ReturnType;

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

@@ -1,5 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 // ignore_for_file: unused_element
+import 'package:algolia_client_composition/src/model/hit_metadata.dart';
 import 'package:algolia_client_composition/src/model/hit_ranking_info.dart';
 
 import 'package:collection/collection.dart';
@@ -16,6 +17,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
     this.snippetResult,
     this.rankingInfo,
     this.distinctSeqID,
+    this.extra,
     Map<String, dynamic> additionalProperties = const {},
   }) : super(additionalProperties);
 
@@ -37,6 +39,9 @@ final class Hit extends DelegatingMap<String, dynamic> {
   @JsonKey(name: r'_distinctSeqID')
   final int? distinctSeqID;
 
+  @JsonKey(name: r'_extra')
+  final HitMetadata? extra;
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
@@ -46,6 +51,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
           other.snippetResult == snippetResult &&
           other.rankingInfo == rankingInfo &&
           other.distinctSeqID == distinctSeqID &&
+          other.extra == extra &&
           const MapEquality<String, dynamic>().equals(this, this);
 
   @override
@@ -55,6 +61,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
       snippetResult.hashCode +
       rankingInfo.hashCode +
       distinctSeqID.hashCode +
+      extra.hashCode +
       const MapEquality<String, dynamic>().hash(this);
 
   factory Hit.fromJson(Map<String, dynamic> json) {
@@ -67,6 +74,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
       snippetResult: instance.snippetResult,
       rankingInfo: instance.rankingInfo,
       distinctSeqID: instance.distinctSeqID,
+      extra: instance.extra,
       additionalProperties: additionalProperties,
     );
   }

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

@@ -0,0 +1,49 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// ignore_for_file: unused_element
+
+import 'package:collection/collection.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'hit_metadata.g.dart';
+
+@JsonSerializable(createFieldMap: true)
+final class HitMetadata extends DelegatingMap<String, dynamic> {
+  /// Returns a new [HitMetadata] instance.
+  const HitMetadata({
+    this.injectedItemKey,
+    Map<String, dynamic> additionalProperties = const {},
+  }) : super(additionalProperties);
+
+  /// The key of the injectedItem that inserted this metadata.
+  @JsonKey(name: r'_injectedItemKey')
+  final String? injectedItemKey;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is HitMetadata &&
+          other.injectedItemKey == injectedItemKey &&
+          const MapEquality<String, dynamic>().equals(this, this);
+
+  @override
+  int get hashCode =>
+      injectedItemKey.hashCode +
+      const MapEquality<String, dynamic>().hash(this);
+
+  factory HitMetadata.fromJson(Map<String, dynamic> json) {
+    final instance = _$HitMetadataFromJson(json);
+    final additionalProperties = Map<String, dynamic>.from(json)
+      ..removeWhere((key, value) => _$HitMetadataFieldMap.containsKey(key));
+    return HitMetadata(
+      injectedItemKey: instance.injectedItemKey,
+      additionalProperties: additionalProperties,
+    );
+  }
+
+  Map<String, dynamic> toJson() => _$HitMetadataToJson(this)..addAll(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}