Add support Telegram Sticker .tgs in Lottie Integration

Author: dungngminh

README.md

@@ -408,9 +408,9 @@ Widget build(BuildContext context) {
 |---------------------------------------------------------|----------------------|-----------------------|-------------------------------------------|
 | [flutter_svg](https://pub.dev/packages/flutter_svg)     | .svg                 | `flutter_svg: true`   | Assets.images.icons.paint.**svg()**       |
 | [rive](https://pub.dev/packages/rive)                   | .riv                 | `rive: true`          | Assets.rive.vehicles.**rive()**           |
-| [lottie](https://pub.dev/packages/lottie)               | .json, .zip, .lottie | `lottie: true`        | Assets.lottie.hamburgerArrow.**lottie()** |
+| [lottie](https://pub.dev/packages/lottie)               | .json, .zip, .lottie, .tgs | `lottie: true`        | Assets.lottie.hamburgerArrow.**lottie()** |
 
-**Note:** For [lottie](https://pub.dev/packages/lottie) integration with `.lottie` files, you must add a custom decoder via `decoder` parameter to select the correct .json file from a dotlottie (.lottie) archive, see [lottie's document](https://pub.dev/packages/lottie#telegram-stickers-tgs-and-dotlottie-lottie) for more information.
+**Note:** For [lottie](https://pub.dev/packages/lottie) integration with `.lottie` and `.tgs` files, you must add a custom decoder via `decoder` parameter, see [lottie's document](https://pub.dev/packages/lottie#telegram-stickers-tgs-and-dotlottie-lottie) for more information.
 
 In other cases, the asset is generated as String class.
 

examples/example/assets/lottie/cat.tgs

@@ -54,8 +54,13 @@ class $AssetsImagesGen {
       const AssetGenImage('assets/images/profile.png');
 
   /// List of all assets
-  List<AssetGenImage> get values =>
-      [chip1, chip2, logo, profileJpg, profilePng];
+  List<AssetGenImage> get values => [
+        chip1,
+        chip2,
+        logo,
+        profileJpg,
+        profilePng,
+      ];
 }
 
 class $AssetsJsonGen {
@@ -82,6 +87,9 @@ class $AssetsLottieGen {
   LottieGenImage get alarmClockLottieV440 =>
       const LottieGenImage('assets/lottie/alarm-clock-lottie-v440.json');
 
+  /// File path: assets/lottie/cat.tgs
+  LottieGenImage get cat => const LottieGenImage('assets/lottie/cat.tgs');
+
   /// File path: assets/lottie/geometrical-animation.json
   LottieGenImage get geometricalAnimation =>
       const LottieGenImage('assets/lottie/geometrical-animation.json');
@@ -101,6 +109,7 @@ class $AssetsLottieGen {
   List<LottieGenImage> get values => [
         xuiIZ9X1Rf,
         alarmClockLottieV440,
+        cat,
         geometricalAnimation,
         hamburgerArrow,
         spinningCarrousel,
@@ -171,10 +180,8 @@ class $AssetsImagesChip4Gen {
   const $AssetsImagesChip4Gen();
 
   /// File path: assets/images/chip4/chip4.jpg
-  AssetGenImage get chip4 => const AssetGenImage(
-        'assets/images/chip4/chip4.jpg',
-        flavors: {'extern'},
-      );
+  AssetGenImage get chip4 =>
+      const AssetGenImage('assets/images/chip4/chip4.jpg', flavors: {'extern'});
 
   /// List of all assets
   List<AssetGenImage> get values => [chip4];
@@ -232,11 +239,7 @@ class MyAssets {
 }
 
 class AssetGenImage {
-  const AssetGenImage(
-    this._assetName, {
-    this.size,
-    this.flavors = const {},
-  });
+  const AssetGenImage(this._assetName, {this.size, this.flavors = const {}});
 
   final String _assetName;
 
@@ -296,15 +299,8 @@ class AssetGenImage {
     );
   }
 
-  ImageProvider provider({
-    AssetBundle? bundle,
-    String? package,
-  }) {
-    return AssetImage(
-      _assetName,
-      bundle: bundle,
-      package: package,
-    );
+  ImageProvider provider({AssetBundle? bundle, String? package}) {
+    return AssetImage(_assetName, bundle: bundle, package: package);
   }
 
   String get path => _assetName;

examples/example/lib/gen/assets.gen.dart

@@ -3,6 +3,7 @@ import 'package:example/gen/colors.gen.dart';
 import 'package:example/gen/fonts.gen.dart';
 import 'package:example_resources/gen/assets.gen.dart';
 import 'package:flutter/material.dart';
+import 'package:lottie/lottie.dart';
 
 void main() {
   print(MyAssets.images.chip4.chip4.flavors);
@@ -59,6 +60,13 @@ class MyApp extends StatelessWidget {
                     fit: BoxFit.contain,
                   ),
                 ),
+                SizedBox(
+                  width: 200,
+                  height: 200,
+                  child: MyAssets.lottie.cat.lottie(
+                    decoder: LottieComposition.decodeGZip,
+                  ),
+                ),
                 MyAssets.images.chip1.image(),
                 Container(
                   height: 400,

examples/example/lib/main.dart

@@ -17,11 +17,15 @@ import 'package:vector_graphics/vector_graphics.dart' as _vg;
 class $AssetsImagesGen {
   const $AssetsImagesGen();
 
+  /// File path: assets/images/cat.tgs
+  LottieGenImage get cat => const LottieGenImage('assets/images/cat.tgs');
+
   /// File path: assets/images/dart.svg
   SvgGenImage get dart => const SvgGenImage('assets/images/dart.svg');
 
   /// File path: assets/images/favorite.flr
-  String get favorite => 'assets/images/favorite.flr';
+  String get favorite =>
+      'packages/example_resources/assets/images/favorite.flr';
 
   /// File path: assets/images/flutter3.jpg
   AssetGenImage get flutter3 =>
@@ -35,8 +39,14 @@ class $AssetsImagesGen {
   RiveGenImage get skills => const RiveGenImage('assets/images/skills.riv');
 
   /// List of all assets
-  List<dynamic> get values =>
-      [dart, favorite, flutter3, runningCarOnRoad, skills];
+  List<dynamic> get values => [
+        cat,
+        dart,
+        favorite,
+        flutter3,
+        runningCarOnRoad,
+        skills,
+      ];
 }
 
 class $AssetsUnknownGen {
@@ -51,7 +61,7 @@ class $AssetsUnknownGen {
 }
 
 class ResAssets {
-  ResAssets._();
+  const ResAssets._();
 
   static const String package = 'example_resources';
 
@@ -132,11 +142,7 @@ class AssetGenImage {
     @Deprecated('Do not specify package for a generated library asset')
     String? package = package,
   }) {
-    return AssetImage(
-      _assetName,
-      bundle: bundle,
-      package: package,
-    );
+    return AssetImage(_assetName, bundle: bundle, package: package);
   }
 
   String get path => _assetName;

examples/example_resources/assets/images/cat.tgs

@@ -122,7 +122,7 @@ ${isPackage ? "\n  static const String package = '$packageName';" : ''}
   bool get isConstConstructor => true;
 
   bool isLottieFile(AssetType asset) {
-    if (asset.extension == '.lottie') {
+    if (asset.extension == '.lottie' || asset.extension == '.tgs') {
       return true;
     }
     if (!_supportedMimeTypes.contains(asset.mime)) {

examples/example_resources/lib/gen/assets.gen.dart

@@ -12,3 +12,4 @@ flutter:
     - assets/lottie/hamburger_arrow.json
     - assets/lottie/spinning_carrousel.zip
     - assets/lottie/XuiIZ9X1Rf.lottie
+    - assets/lottie/cat_cat.tgs