Merge branch 'main' into notifications

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release Note
 
+## v0.4.0
+
+- Split the `PreviewCard` object into a `TrendsLink` object. Now `List<TrendsLink>` is returned from `InstanceV1Service.lookupTrendingLinks`. The fields are the same as in PreviewCard before the modification, so there is no effect if the type is not explicitly specified. If you have explicitly specified the `PreviewCard` as type, rewrite it to `TrendsLink` if necessary. ([#91](https://github.com/mastodon-dart/mastodon-api/issues/91))
+
 ## v0.3.3
 
 - Supported `custom_emojis API methods`. ([#38](https://github.com/mastodon-dart/mastodon-api/issues/38))

lib/mastodon_api.dart

@@ -66,6 +66,7 @@ export 'package:mastodon_api/src/service/entities/tag.dart';
 export 'package:mastodon_api/src/service/entities/thumbnail.dart';
 export 'package:mastodon_api/src/service/entities/thumbnail_version.dart';
 export 'package:mastodon_api/src/service/entities/token.dart';
+export 'package:mastodon_api/src/service/entities/trends_link.dart';
 export 'package:mastodon_api/src/service/entities/usage_statistics.dart';
 export 'package:mastodon_api/src/service/mastodon_v1_service.dart';
 export 'package:mastodon_api/src/service/mastodon_v2_service.dart';

lib/src/service/entities/preview_card.dart

@@ -9,7 +9,6 @@ import 'package:freezed_annotation/freezed_annotation.dart';
 
 // 🌎 Project imports:
 import 'preview_card_type.dart';
-import 'usage_statistics.dart';
 
 part 'preview_card.freezed.dart';
 part 'preview_card.g.dart';
@@ -59,9 +58,6 @@ class PreviewCard with _$PreviewCard {
     /// A hash computed by the BlurHash algorithm, for generating colorful
     /// preview thumbnails when media has not been downloaded yet.
     @JsonKey(name: 'blurhash') String? blurHash,
-
-    /// Usage statistics for given days (typically the past week).
-    @JsonKey(name: 'history') required List<UsageStatistics> usageHistory,
   }) = _PreviewCard;
 
   factory PreviewCard.fromJson(Map<String, Object?> json) =>

lib/src/service/entities/preview_card.freezed.dart

@@ -65,10 +65,6 @@ mixin _$PreviewCard {
   @JsonKey(name: 'blurhash')
   String? get blurHash => throw _privateConstructorUsedError;
 
-  /// Usage statistics for given days (typically the past week).
-  @JsonKey(name: 'history')
-  List<UsageStatistics> get usageHistory => throw _privateConstructorUsedError;
-
   Map<String, dynamic> toJson() => throw _privateConstructorUsedError;
   @JsonKey(ignore: true)
   $PreviewCardCopyWith<PreviewCard> get copyWith =>
@@ -95,8 +91,7 @@ abstract class $PreviewCardCopyWith<$Res> {
       int height,
       @JsonKey(name: 'image') String? imageUrl,
       String embedUrl,
-      @JsonKey(name: 'blurhash') String? blurHash,
-      @JsonKey(name: 'history') List<UsageStatistics> usageHistory});
+      @JsonKey(name: 'blurhash') String? blurHash});
 }
 
 /// @nodoc
@@ -126,7 +121,6 @@ class _$PreviewCardCopyWithImpl<$Res, $Val extends PreviewCard>
     Object? imageUrl = freezed,
     Object? embedUrl = null,
     Object? blurHash = freezed,
-    Object? usageHistory = null,
   }) {
     return _then(_value.copyWith(
       url: null == url
@@ -185,10 +179,6 @@ class _$PreviewCardCopyWithImpl<$Res, $Val extends PreviewCard>
           ? _value.blurHash
           : blurHash // ignore: cast_nullable_to_non_nullable
               as String?,
-      usageHistory: null == usageHistory
-          ? _value.usageHistory
-          : usageHistory // ignore: cast_nullable_to_non_nullable
-              as List<UsageStatistics>,
     ) as $Val);
   }
 }
@@ -215,8 +205,7 @@ abstract class _$$_PreviewCardCopyWith<$Res>
       int height,
       @JsonKey(name: 'image') String? imageUrl,
       String embedUrl,
-      @JsonKey(name: 'blurhash') String? blurHash,
-      @JsonKey(name: 'history') List<UsageStatistics> usageHistory});
+      @JsonKey(name: 'blurhash') String? blurHash});
 }
 
 /// @nodoc
@@ -244,7 +233,6 @@ class __$$_PreviewCardCopyWithImpl<$Res>
     Object? imageUrl = freezed,
     Object? embedUrl = null,
     Object? blurHash = freezed,
-    Object? usageHistory = null,
   }) {
     return _then(_$_PreviewCard(
       url: null == url
@@ -303,10 +291,6 @@ class __$$_PreviewCardCopyWithImpl<$Res>
           ? _value.blurHash
           : blurHash // ignore: cast_nullable_to_non_nullable
               as String?,
-      usageHistory: null == usageHistory
-          ? _value._usageHistory
-          : usageHistory // ignore: cast_nullable_to_non_nullable
-              as List<UsageStatistics>,
     ));
   }
 }
@@ -326,14 +310,9 @@ class _$_PreviewCard implements _PreviewCard {
       required this.html,
       required this.width,
       required this.height,
-      @JsonKey(name: 'image')
-          this.imageUrl,
+      @JsonKey(name: 'image') this.imageUrl,
       required this.embedUrl,
-      @JsonKey(name: 'blurhash')
-          this.blurHash,
-      @JsonKey(name: 'history')
-          required final List<UsageStatistics> usageHistory})
-      : _usageHistory = usageHistory;
+      @JsonKey(name: 'blurhash') this.blurHash});
 
   factory _$_PreviewCard.fromJson(Map<String, dynamic> json) =>
       _$$_PreviewCardFromJson(json);
@@ -397,21 +376,9 @@ class _$_PreviewCard implements _PreviewCard {
   @JsonKey(name: 'blurhash')
   final String? blurHash;
 
-  /// Usage statistics for given days (typically the past week).
-  final List<UsageStatistics> _usageHistory;
-
-  /// Usage statistics for given days (typically the past week).
-  @override
-  @JsonKey(name: 'history')
-  List<UsageStatistics> get usageHistory {
-    if (_usageHistory is EqualUnmodifiableListView) return _usageHistory;
-    // ignore: implicit_dynamic_type
-    return EqualUnmodifiableListView(_usageHistory);
-  }
-
   @override
   String toString() {
-    return 'PreviewCard(url: $url, title: $title, description: $description, type: $type, authorName: $authorName, authorUrl: $authorUrl, providerName: $providerName, providerUrl: $providerUrl, html: $html, width: $width, height: $height, imageUrl: $imageUrl, embedUrl: $embedUrl, blurHash: $blurHash, usageHistory: $usageHistory)';
+    return 'PreviewCard(url: $url, title: $title, description: $description, type: $type, authorName: $authorName, authorUrl: $authorUrl, providerName: $providerName, providerUrl: $providerUrl, html: $html, width: $width, height: $height, imageUrl: $imageUrl, embedUrl: $embedUrl, blurHash: $blurHash)';
   }
 
   @override
@@ -440,9 +407,7 @@ class _$_PreviewCard implements _PreviewCard {
             (identical(other.embedUrl, embedUrl) ||
                 other.embedUrl == embedUrl) &&
             (identical(other.blurHash, blurHash) ||
-                other.blurHash == blurHash) &&
-            const DeepCollectionEquality()
-                .equals(other._usageHistory, _usageHistory));
+                other.blurHash == blurHash));
   }
 
   @JsonKey(ignore: true)
@@ -462,8 +427,7 @@ class _$_PreviewCard implements _PreviewCard {
       height,
       imageUrl,
       embedUrl,
-      blurHash,
-      const DeepCollectionEquality().hash(_usageHistory));
+      blurHash);
 
   @JsonKey(ignore: true)
   @override
@@ -492,13 +456,9 @@ abstract class _PreviewCard implements PreviewCard {
       required final String html,
       required final int width,
       required final int height,
-      @JsonKey(name: 'image')
-          final String? imageUrl,
+      @JsonKey(name: 'image') final String? imageUrl,
       required final String embedUrl,
-      @JsonKey(name: 'blurhash')
-          final String? blurHash,
-      @JsonKey(name: 'history')
-          required final List<UsageStatistics> usageHistory}) = _$_PreviewCard;
+      @JsonKey(name: 'blurhash') final String? blurHash}) = _$_PreviewCard;
 
   factory _PreviewCard.fromJson(Map<String, dynamic> json) =
       _$_PreviewCard.fromJson;
@@ -563,11 +523,6 @@ abstract class _PreviewCard implements PreviewCard {
   @JsonKey(name: 'blurhash')
   String? get blurHash;
   @override
-
-  /// Usage statistics for given days (typically the past week).
-  @JsonKey(name: 'history')
-  List<UsageStatistics> get usageHistory;
-  @override
   @JsonKey(ignore: true)
   _$$_PreviewCardCopyWith<_$_PreviewCard> get copyWith =>
       throw _privateConstructorUsedError;

lib/src/service/entities/trends_link.dart

@@ -0,0 +1,69 @@
+// Copyright 2023 Kato Shinya. All rights reserved.
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided the conditions.
+
+// ignore_for_file: invalid_annotation_target
+
+// 📦 Package imports:
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+// 🌎 Project imports:
+import 'preview_card_type.dart';
+import 'usage_statistics.dart';
+
+part 'trends_link.freezed.dart';
+part 'trends_link.g.dart';
+
+@freezed
+class TrendsLink with _$TrendsLink {
+  const factory TrendsLink({
+    /// Location of linked resource.
+    required String url,
+
+    /// Title of linked resource.
+    required String title,
+
+    /// Description of preview.
+    required String description,
+
+    /// The type of the preview card.
+    required PreviewCardType type,
+
+    /// The author of the original resource.
+    required String authorName,
+
+    /// A link to the author of the original resource.
+    required String authorUrl,
+
+    /// The provider of the original resource.
+    required String providerName,
+
+    /// A link to the provider of the original resource.
+    required String providerUrl,
+
+    /// HTML to be used for generating the preview card.
+    required String html,
+
+    /// Width of preview, in pixels.
+    required int width,
+
+    /// Height of preview, in pixels.
+    required int height,
+
+    /// Preview thumbnail.
+    @JsonKey(name: 'image') String? imageUrl,
+
+    /// Used for photo embeds, instead of custom html.
+    required String embedUrl,
+
+    /// A hash computed by the BlurHash algorithm, for generating colorful
+    /// preview thumbnails when media has not been downloaded yet.
+    @JsonKey(name: 'blurhash') String? blurHash,
+
+    /// Usage statistics for given days (typically the past week).
+    @JsonKey(name: 'history') required List<UsageStatistics> usageHistory,
+  }) = _TrendsLink;
+
+  factory TrendsLink.fromJson(Map<String, Object?> json) =>
+      _$TrendsLinkFromJson(json);
+}