v2.1.0

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.1.0] - 2025-02-05
+
+* Add the ability to scaffold Notifications in your Nylo app
+* Run `dart run laravel_notify_fcm:main install` to scaffold the necessary files for FCM notifications
+* pubspec.yaml update
+* Update Readme
+
 ## [2.0.0] - 2025-01-12
 
 * Small Refactor

README.md

@@ -16,7 +16,7 @@ Add the following to your `pubspec.yaml` file:
 
 ``` yaml
 dependencies:
-  laravel_notify_fcm: ^2.0.0
+  laravel_notify_fcm: ^2.1.0
 ```
 
 or with Dart:
@@ -33,6 +33,21 @@ dart pub add laravel_notify_fcm
 
 ### Usage
 
+Using Nylo? Run the following command to scaffold the necessary files for FCM notifications.
+
+``` bash
+dart run laravel_notify_fcm:main install
+```
+
+This will create the following files:
+- Provider - `FirebaseMessagingProvider` (lib/providers/firebase_messaging_provider.dart)
+  - This will initialize the package to send notifications to the device.
+- Page - `EnableNotificationsPage` (lib/pages/enable_notifications_page.dart)
+  - This page will request permission to send notifications to the device.
+  - You can navigate to it by calling `routeTo(EnableNotificationsPage.path);`.
+- Event - `RegisterForNotificationsEvent` (lib/events/register_for_notifications_event.dart)
+  - This event will be dispatched to request permission to send notifications to the device.
+
 ``` dart
 import 'package:laravel_notify_fcm/laravel_notify_fcm.dart';
 
@@ -51,7 +66,7 @@ Parameters:
 FirebaseMessaging firebaseMessaging = FirebaseMessaging.instance;
 
 await LaravelNotifyFcm.instance.init(
-  url: 'https://example.com/api/fcm/devices',
+  url: 'https://example.com/api/fcm',
   firebaseMessaging: firebaseMessaging,
 );
 ```

bin/main.dart

@@ -0,0 +1,78 @@
+import 'dart:io';
+
+import 'package:laravel_notify_fcm/cli_dialog/cli_dialog.dart';
+import 'package:laravel_notify_fcm/models/ny_laravel_slate_config.dart';
+import 'package:laravel_notify_fcm/slate_laravel_notify_fcm.dart';
+import 'package:nylo_support/metro/metro_console.dart';
+import 'package:nylo_support/metro/metro_service.dart';
+import 'package:nylo_support/metro/models/ny_template.dart';
+
+void main(List<String> arguments) async {
+  if (arguments.length != 1) {
+    MetroConsole.writeInRed("Invalid arguments");
+    MetroConsole.writeInRed("Usage: dart run laravel_notify_fcm:main install");
+    exit(1);
+  }
+
+  String command = arguments[0];
+  if (command != 'install') {
+    MetroConsole.writeInRed("Invalid command");
+    MetroConsole.writeInRed("Usage: dart run laravel_notify_fcm:main install");
+    exit(1);
+  }
+
+  final dialogLaravelUrl = CliDialog(questions: [
+    ['What is your Laravel Url?', 'laravel_url']
+  ]);
+
+  String laravelUrl = dialogLaravelUrl.ask()['laravel_url'];
+  // remove trailing slash if exists
+  if (laravelUrl.endsWith('/')) {
+    laravelUrl = laravelUrl.substring(0, laravelUrl.length - 1);
+  }
+
+  await MetroService.addPackage("firebase_core");
+  await MetroService.addPackage("firebase_messaging");
+  await MetroService.addPackage("laravel_notify_fcm");
+
+  NyLaravelSlateConfig nyLaravelSlateConfig = NyLaravelSlateConfig(
+    url: laravelUrl,
+  );
+
+  List<NyTemplate> templates = laravelNotifyFcmSlateRun(nyLaravelSlateConfig);
+  await MetroService.createSlate(templates, hasForceFlag: true);
+
+  MetroConsole.writeInGreen(
+      'Go to your Laravel project\n\nRun: composer require nylo/laravel-fcm-channel\n\nThen run: php artisan laravelfcm:install');
+  MetroConsole.writeInGreen(
+      'Make sure you have Laravel Sanctum installed\n Run: php artisan install:api\n\nYour User model must use the HasApiTokens trait');
+
+  // usage instructions
+  String usageInstructions = '''
+Use the following code to register for notifications:
+event<RegisterForNotificationsEvent>();
+
+Make sure to call this code after the user has logged in.
+
+You can also use the enable notifications page:
+routeTo(EnableNotificationsPage.path);
+
+This will prompt the user to enable notifications.
+''';
+
+  String firebaseInfo = "\nSetup Firebase";
+  firebaseInfo +=
+      "\n- Create a Firebase project: https://console.firebase.google.com";
+  firebaseInfo +=
+      "\n- Download flutterfire: https://firebase.google.com/docs/flutter/setup";
+  firebaseInfo += "\n- Run `flutterfire configure`";
+  firebaseInfo += "\n- For IOS, you'll need to do the following steps";
+  firebaseInfo +=
+      "\n  - Project settings > Cloud Messaging > iOS app configuration";
+  firebaseInfo +=
+      "\n  - Add your APNs Authentication Key from your Apple Developer account";
+
+  MetroConsole.writeInGreen("\n\n$usageInstructions$firebaseInfo");
+
+  exit(0);
+}

example/pubspec.lock

@@ -5,18 +5,18 @@ packages:
     dependency: transitive
     description:
       name: _flutterfire_internals
-      sha256: "27899c95f9e7ec06c8310e6e0eac967707714b9f1450c4a58fa00ca011a4a8ae"
+      sha256: e4f2a7ef31b0ab2c89d2bde35ef3e6e6aff1dce5e66069c6540b0e9cfe33ee6b
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.49"
+    version: "1.3.50"
   animate_do:
     dependency: transitive
     description:
       name: animate_do
-      sha256: "7a3162729f0ea042f9dd84da217c5bde5472ad9cef644079929d4304a5dc4ca0"
+      sha256: f517dec9c98c1ea2c6e82e172ac138f6b102394a8e843b74bd18f665858e8c1c
       url: "https://pub.dev"
     source: hosted
-    version: "3.3.4"
+    version: "3.3.7"
   app_badge_plus:
     dependency: transitive
     description:
@@ -105,14 +105,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.0.3"
+  dart_console:
+    dependency: transitive
+    description:
+      name: dart_console
+      sha256: "30776f697c440fdf5615a5b4fa318fd03c0788a2aeb30625a5972e83592b40c5"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.1.1"
   date_field:
     dependency: transitive
     description:
       name: date_field
-      sha256: "921246e5e8fb8e22c82e234de48dde27f9c739071a38dac666258909fd2f7b14"
+      sha256: "5714b1ac0ba1c860877b3040601a6fd20cb846042c9ae6d8216ffede422d43d1"
       url: "https://pub.dev"
     source: hosted
-    version: "6.0.0"
+    version: "6.0.3+1"
   dbus:
     dependency: transitive
     description:
@@ -141,18 +149,18 @@ packages:
     dependency: transitive
     description:
       name: device_meta
-      sha256: "74c40791731b499432d2c35986645949e34a0ccdfd3f4daa376486d356898816"
+      sha256: "9af36e12370e0bb647f30946d1fd256fae47663638ce5113c5b6345d0d356da5"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
   dio:
     dependency: transitive
     description:
       name: dio
-      sha256: "5598aa796bbf4699afd5c67c0f5f6e2ed542afc956884b9cd58c306966efc260"
+      sha256: "253a18bbd4851fecba42f7343a1df3a9a4c1d31a2c1b37e221086b4fa8c8dbc9"
       url: "https://pub.dev"
     source: hosted
-    version: "5.7.0"
+    version: "5.8.0+1"
   dio_web_adapter:
     dependency: transitive
     description:
@@ -173,10 +181,10 @@ packages:
     dependency: transitive
     description:
       name: error_stack
-      sha256: "9b4b685fbee04cc4a72f0791663caac5838585d32f83e15ab64f9c8957ec506b"
+      sha256: ffa61cf73940d61d501c97d14421a2ad7d3a2809fa38bb5c81ef3acee6f131a0
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.1"
+    version: "1.10.2"
   fake_async:
     dependency: transitive
     description:
@@ -205,10 +213,10 @@ packages:
     dependency: transitive
     description:
       name: firebase_core
-      sha256: "0307c1fde82e2b8b97e0be2dab93612aff9a72f31ebe9bfac66ed8b37ef7c568"
+      sha256: d851c1ca98fd5a4c07c747f8c65dacc2edd84a4d9ac055d32a5f0342529069f5
       url: "https://pub.dev"
     source: hosted
-    version: "3.10.0"
+    version: "3.10.1"
   firebase_core_platform_interface:
     dependency: transitive
     description:
@@ -229,26 +237,26 @@ packages:
     dependency: transitive
     description:
       name: firebase_messaging
-      sha256: "48a8a59197c1c5174060ba9aa1e0036e9b5a0d28a0cc22d19c1fcabc67fafe3c"
+      sha256: e20ea2a0ecf9b0971575ab3ab42a6e285a94e50092c555b090c1a588a81b4d54
       url: "https://pub.dev"
     source: hosted
-    version: "15.2.0"
+    version: "15.2.1"
   firebase_messaging_platform_interface:
     dependency: transitive
     description:
       name: firebase_messaging_platform_interface
-      sha256: "9770a8e91f54296829dcaa61ce9b7c2f9ae9abbf99976dd3103a60470d5264dd"
+      sha256: c57a92b5ae1857ef4fe4ae2e73452b44d32e984e15ab8b53415ea1bb514bdabd
       url: "https://pub.dev"
     source: hosted
-    version: "4.6.0"
+    version: "4.6.1"
   firebase_messaging_web:
     dependency: transitive
     description:
       name: firebase_messaging_web
-      sha256: "329ca4ef45ec616abe6f1d5e58feed0934a50840a65aa327052354ad3c64ed77"
+      sha256: "83694a990d8525d6b01039240b97757298369622ca0253ad0ebcfed221bf8ee0"
       url: "https://pub.dev"
     source: hosted
-    version: "3.10.0"
+    version: "3.10.1"
   fixnum:
     dependency: transitive
     description:
@@ -380,10 +388,10 @@ packages:
     dependency: transitive
     description:
       name: flutter_timezone
-      sha256: "6e6a0a9d0dfc049b209e01e1dee3efd5ff2ddf2375e9de86589761b244eb5a5f"
+      sha256: bc286cecb0366d88e6c4644e3962ebd1ce1d233abc658eb1e0cd803389f84b64
       url: "https://pub.dev"
     source: hosted
-    version: "4.0.0"
+    version: "4.1.0"
   flutter_web_plugins:
     dependency: transitive
     description: flutter
@@ -393,10 +401,10 @@ packages:
     dependency: transitive
     description:
       name: get_time_ago
-      sha256: "0f50a87080a720f5491266a3f7c79109f95943decd10b66c84b5aef802f1d959"
+      sha256: "1bf7bebe32e070e2a5aa9a84ee401c88895de337e9e168e70416ec3373771243"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "2.2.0"
   http:
     dependency: transitive
     description:
@@ -435,7 +443,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.0.0"
+    version: "2.1.0"
   leak_tracker:
     dependency: transitive
     description:
@@ -496,10 +504,10 @@ packages:
     dependency: transitive
     description:
       name: nylo_support
-      sha256: "28707d9a8b3a71f820ce367e708139e3d3ac32e83e7af5c7f2d519533f78003f"
+      sha256: fcec6528167d8ca4d0c8b3f989b1202f4ea5fdc8487826ba1517adb95574a94c
       url: "https://pub.dev"
     source: hosted
-    version: "6.15.0"
+    version: "6.19.1"
   path:
     dependency: transitive
     description:

lib/cli_dialog/cli_dialog.dart

@@ -0,0 +1,3 @@
+export 'src/dialog.dart';
+export 'src/services.dart';
+export 'src/xterm.dart' show XTerm;