kasy-cli 1.2.1

package/templates/firebase/test/test_utils.dart

@@ -0,0 +1,272 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:go_router/go_router.dart';
+import 'package:kasy_kit/core/data/api/analytics_api.dart';
+import 'package:kasy_kit/core/data/api/remote_config_api.dart';
+import 'package:kasy_kit/core/data/api/user_api.dart';
+import 'package:kasy_kit/core/data/entities/user_entity.dart';
+import 'package:kasy_kit/core/data/models/subscription.dart';
+import 'package:kasy_kit/core/data/models/user.dart';
+import 'package:kasy_kit/core/initializer/models/run_state.dart';
+import 'package:kasy_kit/core/initializer/onstart_service.dart';
+import 'package:kasy_kit/core/initializer/onstart_widget.dart';
+import 'package:kasy_kit/core/rating/api/rating_api.dart';
+import 'package:kasy_kit/core/security/secured_storage.dart';
+import 'package:kasy_kit/core/shared_preferences/shared_preferences.dart';
+import 'package:kasy_kit/core/states/models/user_state.dart';
+import 'package:kasy_kit/core/states/user_state_notifier.dart';
+import 'package:kasy_kit/core/theme/colors.dart';
+import 'package:kasy_kit/core/theme/providers/theme_provider.dart';
+import 'package:kasy_kit/core/theme/texts.dart';
+import 'package:kasy_kit/core/theme/universal_theme.dart';
+import 'package:kasy_kit/features/authentication/api/authentication_api.dart';
+import 'package:kasy_kit/features/authentication/api/authentication_api_interface.dart';
+import 'package:kasy_kit/features/notifications/api/device_api.dart';
+import 'package:kasy_kit/features/notifications/api/local_notifier.dart';
+import 'package:kasy_kit/features/notifications/api/notifications_api.dart';
+import 'package:kasy_kit/features/notifications/repositories/notifications_repository.dart';
+import 'package:kasy_kit/features/subscription/api/entities/subscription_entity.dart';
+import 'package:kasy_kit/features/subscription/api/inapp_subscription_api.dart';
+import 'package:kasy_kit/features/subscription/api/subscription_api.dart';
+import 'package:kasy_kit/features/subscription/repositories/subscription_repository.dart';
+import 'package:kasy_kit/i18n/translations.g.dart';
+import 'package:kasy_kit/router.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+import 'core/data/api/analytics_api_fake.dart';
+import 'core/data/api/fake_remote_config_api.dart';
+import 'core/data/api/storage_api_fake.dart';
+import 'core/rating/rating_api_fake.dart';
+import 'core/security/secured_storage_fake.dart';
+import 'features/authentication/data/api/auth_api_fake.dart';
+import 'features/authentication/data/api/user_api_fake.dart';
+import 'features/notifications/data/device_api_fake.dart';
+import 'features/notifications/data/local_notifier_fake.dart';
+import 'features/notifications/data/notifications_api_fake.dart';
+import 'features/notifications/data/notifications_settings_fake.dart';
+import 'features/subscription/api/fake_inapp_subscription_api.dart';
+import 'features/subscription/api/fake_subscription_api.dart';
+
+/// Use this page to show a fake page within a test
+class PageFake extends StatelessWidget {
+  final Color color;
+
+  const PageFake(this.color, {super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Container(
+      color: color,
+    );
+  }
+}
+
+extension AppWidgetTester on WidgetTester {
+  /// Pump the given widget into an app with all our default fake APIs
+  /// provided or override them with the given overrides
+  /// this is useful to test a page and not rewrite all the providers
+  /// Only APIs should be faked, not the repositories
+  ///
+  /// We will wait that all the providers are ready before pumping the page
+  /// if that takes more than 10 pump, we will throw an exception
+  ///
+  /// If you want your test to use your app navigation, you can pass the routerConfig
+  /// and the initialRoute from the routerGenerator function (lib/router.dart)
+  /// For ex to test the signup page:
+  /// ```generateRouter(initialLocation: '/signup')```
+  Future<void> pumpPage({
+    UserState? userState,
+    AuthenticationApi? authApiFakeOverride,
+    SubscriptionApiFake? subscriptionApiFakeOverride,
+    InAppSubscriptionApiFake? inAppSubscriptionApiFakeOverride,
+    AuthSecuredStorage? authSecuredStorageFakeOverride,
+    DeviceApi? deviceApiFakeOverride,
+    UserApi? userApiFakeOverride,
+    LocalNotifier? localNotifierFakeOverride,
+    NotificationSettings? notificationsSettingsFakeOverride,
+    NotificationsApi? notificationsApiFakeOverride,
+    RatingApiFake? ratingApiFakeOverride,
+    RemoteConfigApi? remoteConfigApiFakeOverride,
+    AnalyticsApi? analyticsApiFakeOverride,
+    
+    Widget? home,
+    RouterConfig<Object>? routerConfig,
+    String? initialRoute,
+  }) async {
+    // await initFirebaseForTest();
+    SharedPreferences.setMockInitialValues({});
+    final sharedPrefs = await SharedPreferences.getInstance();
+    late WidgetRef refCopie;
+
+    // We setup the list of services that must be initialized at app startup
+    // The order is important as some services may depend on others
+    final List<ProviderListenable<OnStartService>> services = [
+      // shared preferences must be loaded
+      sharedPreferencesProvider,
+      // remote config api
+      remoteConfigApiProvider,
+      // user state
+      userStateNotifierProvider.notifier,
+      // notifications
+      notificationsSettingsProvider,
+      notificationRepositoryProvider,
+      // subscriptions
+      subscriptionRepositoryProvider,
+    ];
+
+    await pumpWidget(
+      TranslationProvider(
+        child: ProviderScope(
+          overrides: [
+            authenticationApiProvider.overrideWithValue(
+              authApiFakeOverride ?? FakeAuthenticationApi(),
+            ),
+            authSecuredStorageProvider.overrideWithValue(
+              authSecuredStorageFakeOverride ?? FakeAuthSecuredStorage.empty(),
+            ),
+            subscriptionApiProvider.overrideWithValue(
+              subscriptionApiFakeOverride ?? SubscriptionApiFake(),
+            ),
+            inAppSubscriptionApiProvider.overrideWithValue(
+              inAppSubscriptionApiFakeOverride ?? InAppSubscriptionApiFake(),
+            ),
+            deviceApiProvider.overrideWithValue(
+              deviceApiFakeOverride ?? FakeDeviceApi(),
+            ),
+            userApiProvider.overrideWithValue(
+              userApiFakeOverride ?? FakeUserApi(storageApi: FakeStorageApi()),
+            ),
+            localNotifierProvider.overrideWithValue(
+              localNotifierFakeOverride ?? FakeLocalNotifier(),
+            ),
+            notificationsApiProvider.overrideWithValue(
+              notificationsApiFakeOverride ?? FakeNotificationsApi(),
+            ),
+            notificationsSettingsProvider.overrideWithValue(
+              notificationsSettingsFakeOverride ?? NotificationsSettingsFake(),
+            ),
+            ratingApiProvider.overrideWithValue(
+              ratingApiFakeOverride ?? RatingApiFake(),
+            ),
+            remoteConfigApiProvider.overrideWithValue(
+              remoteConfigApiFakeOverride ?? FakeRemoteConfigApi(),
+            ),
+            analyticsApiProvider.overrideWithValue(
+              analyticsApiFakeOverride ?? AnalyticsApiFake(),
+            ),
+            
+          ],
+          child: Consumer(builder: (context, ref, child) {
+            refCopie = ref;
+
+            // We setup the test with the default USER STATE
+            final subscriptionApi = ref.read(
+              subscriptionApiProvider,
+            ) as SubscriptionApiFake;
+
+            final authStorageApi = ref.read(
+              authSecuredStorageProvider,
+            ) as FakeAuthSecuredStorage;
+
+            final authApi = ref.read(
+              authenticationApiProvider,
+            ) as FakeAuthenticationApi;
+
+            final userApi = ref.read(userApiProvider) as FakeUserApi;
+
+            subscriptionApi.currentFake = null;
+            authStorageApi.credentials = null;
+            authApi.current = null;
+            userApi.getUserResult = null;
+
+            // if the test include a user state (anonymous or authenticated) we setup with it
+            if (userState != null) {
+              debugPrint("✅- Test user provided");
+
+              authStorageApi.credentials = Credentials(
+                id: userState.user.idOrThrow,
+                token: 'fake-user-token-1234567890',
+              );
+              authApi.current = authStorageApi.credentials;
+
+              userApi.getUserResult = switch (userState.user) {
+                AuthenticatedUserData() => userState.user.toEntity(),
+                AnonymousUserData() => userState.user.toEntity(),
+                LoadingUserData() => null,
+              };
+            }
+            
+            // if the test include an active subscription state
+            if (userState != null &&
+                userState.subscription != null &&
+                userState.subscription is SubscriptionStateData) {
+              subscriptionApi.currentFake = switch (userState.subscription) {
+                SubscriptionStateData(:final activeOffer) => SubscriptionEntity(
+                  skuId: activeOffer!.skuId,
+                  status: SubscriptionStatus.ACTIVE,
+                  creationDate: DateTime.now().add(const Duration(days: -30)),
+                  periodEndDate: DateTime.now().add(const Duration(days: 30)),
+                  offerId: activeOffer.id,
+                ),
+                _ => null,
+              };
+            }
+            // We now run the app like we do on the main function
+            return ThemeProvider(
+              notifier: AppTheme.uniform(
+                sharedPreferences: sharedPrefs,
+                themeFactory: const UniversalThemeFactory(),
+                lightColors: KasyColors.light(),
+                darkColors: KasyColors.dark(),
+                textTheme: KasyTextTheme.build(),
+                defaultMode: ThemeMode.light,
+              ),
+              child: Builder(builder: (context) {
+                return MaterialApp.router(
+                  theme: ThemeProvider.of(context).light,
+                  darkTheme: ThemeProvider.of(context).dark,
+                  themeMode: ThemeProvider.of(context).mode,
+                  builder: (context, child) => Initializer(
+                    services: services,
+                    onReady: child!,
+                    onLoading: const Scaffold(
+                      body: Center(
+                        child: CircularProgressIndicator(),
+                      ),
+                    ),
+                  ),
+                  routerConfig: routerConfig ??
+                      GoRouter(
+                        navigatorKey: navigatorKey,
+                        initialLocation: initialRoute ?? '/',
+                        routes: [
+                          GoRoute(
+                            path: '/',
+                            builder: (context, state) =>
+                                home ?? const PageFake(Colors.red),
+                          ),
+                        ],
+                      ),
+                );
+              }),
+            );
+          }),
+        ),
+      ),
+    );
+    // We wait that the app is ready before continuing
+    final startHandlerNotifier = refCopie.read(onStartProvider.notifier);
+    const maxWait = 100;
+    var wait = 0;
+    while (startHandlerNotifier.state is AppLoadingState) {
+      await pump(const Duration(milliseconds: 100));
+      wait++;
+      if (wait > maxWait) {
+        throw Exception('Timeout waiting for app to be ready');
+      }
+    }
+    await pumpAndSettle();
+  }
+}

package/templates/firebase/web/firebase-messaging-sw.js

@@ -0,0 +1,27 @@
+importScripts('https://www.gstatic.com/firebasejs/10.7.0/firebase-app-compat.js');
+importScripts('https://www.gstatic.com/firebasejs/10.7.0/firebase-messaging-compat.js');
+
+firebase.initializeApp({
+  apiKey: 'YOUR_FIREBASE_WEB_API_KEY',
+  appId: 'YOUR_FIREBASE_WEB_APP_ID',
+  messagingSenderId: 'YOUR_FIREBASE_PROJECT_NUMBER',
+  projectId: 'YOUR_FIREBASE_PROJECT_ID',
+  authDomain: 'YOUR_FIREBASE_PROJECT_ID.firebaseapp.com',
+  storageBucket: 'YOUR_FIREBASE_PROJECT_ID.firebasestorage.app',
+});
+
+const messaging = firebase.messaging();
+
+// Handle background messages
+messaging.onBackgroundMessage((payload) => {
+  console.log('[firebase-messaging-sw.js] Received background message:', payload);
+
+  const notificationTitle = payload.notification?.title || 'New Message';
+  const notificationOptions = {
+    body: payload.notification?.body || '',
+    icon: '/icons/Icon-192.png',
+    badge: '/icons/Icon-192.png',
+  };
+
+  self.registration.showNotification(notificationTitle, notificationOptions);
+});

package/templates/firebase/web/index.html

@@ -0,0 +1,110 @@
+<!DOCTYPE html><html><head>
+   <!--
+    If you are serving your web app in a path other than the root, change the
+    href value below to reflect the base path you are serving from.
+
+    The path provided below has to start and end with a slash "/" in order for
+    it to work correctly.
+
+    For more details:
+    * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
+
+    This is a placeholder for base href that will be replaced by the value of
+    the `--base-href` argument provided to `flutter build`.
+  -->
+  <base href="$FLUTTER_BASE_HREF">
+
+  <meta charset="UTF-8">
+  <meta content="IE=Edge" http-equiv="X-UA-Compatible">
+  <meta name="description" content="A new Flutter project.">
+
+  <!-- iOS meta tags & icons -->
+  <meta name="mobile-web-app-capable" content="yes">
+  <meta name="apple-mobile-web-app-status-bar-style" content="black">
+  <meta name="apple-mobile-web-app-title" content="kasy">
+  <link rel="apple-touch-icon" href="icons/Icon-192.png">
+
+  <!-- Favicon -->
+  <link rel="icon" type="image/png" href="favicon.png">
+
+  <title>kasy</title>
+  <link rel="manifest" href="manifest.json">
+  <style id="splash-screen-style">
+    html {
+      height: 100%;
+    }
+
+    body {
+      margin: 0;
+      min-height: 100%;
+      background-color: #FFFFFF;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      body { background-color: #000000; }
+    }
+
+    #splash {
+      position: fixed;
+      inset: 0;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      background-color: #FFFFFF;
+      transition: opacity 0.35s ease;
+      z-index: 9999;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      #splash { background-color: #000000; }
+    }
+
+    #splash img {
+      width: 160px;
+      height: 160px;
+      object-fit: contain;
+    }
+
+    .center {
+      margin: 0;
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      -ms-transform: translate(-50%, -50%);
+      transform: translate(-50%, -50%);
+    }
+
+    .contain { display:block; width:100%; height:100%; object-fit: contain; }
+    .stretch { display:block; width:100%; height:100%; }
+    .cover   { display:block; width:100%; height:100%; object-fit: cover; }
+
+    .bottom      { position: absolute; bottom: 0; left: 50%; transform: translate(-50%, 0); }
+    .bottomLeft  { position: absolute; bottom: 0; left: 0; }
+    .bottomRight { position: absolute; bottom: 0; right: 0; }
+  </style>
+  <script id="splash-screen-script">
+    function removeSplashFromWeb() {
+      var splash = document.getElementById("splash");
+      if (splash) {
+        splash.style.opacity = "0";
+        setTimeout(function() {
+          splash.remove();
+          document.getElementById("splash-branding")?.remove();
+          document.body.style.background = "transparent";
+        }, 380);
+      }
+    }
+  </script>
+  <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport">
+</head>
+<body>
+  <picture id="splash">
+      <source srcset="splash/img/light-1x.png 1x, splash/img/light-2x.png 2x, splash/img/light-3x.png 3x, splash/img/light-4x.png 4x" media="(prefers-color-scheme: light)">
+      <source srcset="splash/img/dark-1x.png 1x, splash/img/dark-2x.png 2x, splash/img/dark-3x.png 3x, splash/img/dark-4x.png 4x" media="(prefers-color-scheme: dark)">
+      <img class="center" aria-hidden="true" src="splash/img/light-1x.png" alt="">
+  </picture>
+  <script src="flutter_bootstrap.js" async=""></script>
+  <script src="./local_notifications.js"></script>
+
+
+</body></html>

package/templates/firebase/web/local_notifications.js

@@ -0,0 +1,31 @@
+// local_notification.js
+function showNotification(title, body) {
+    if (!("Notification" in window)) {
+        console.error("This browser does not support desktop notifications");
+        return;
+    }
+
+    if (Notification.permission === "granted") {
+        var notification = new Notification(title, {
+            body: body,
+            icon: "icon.png"
+        });
+
+        notification.onclick = function () {
+            console.log("Notification clicked");
+        };
+    } else if (Notification.permission !== "denied") {
+        Notification.requestPermission().then(function (permission) {
+            if (permission === "granted") {
+                var notification = new Notification(title, {
+                    body: body,
+                    icon: "favicon.png"
+                });
+
+                notification.onclick = function () {
+                    console.log("Notification clicked");
+                };
+            }
+        });
+    }
+}

package/templates/firebase/web/manifest.json

@@ -0,0 +1,35 @@
+{
+    "name": "kasy",
+    "short_name": "kasy",
+    "start_url": ".",
+    "display": "standalone",
+    "background_color": "#0175C2",
+    "theme_color": "#0175C2",
+    "description": "A new Flutter project.",
+    "orientation": "portrait-primary",
+    "prefer_related_applications": false,
+    "icons": [
+        {
+            "src": "icons/Icon-192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "icons/Icon-512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        },
+        {
+            "src": "icons/Icon-maskable-192.png",
+            "sizes": "192x192",
+            "type": "image/png",
+            "purpose": "maskable"
+        },
+        {
+            "src": "icons/Icon-maskable-512.png",
+            "sizes": "512x512",
+            "type": "image/png",
+            "purpose": "maskable"
+        }
+    ]
+}