Update to oauth2 package README for Flutter Web info

dart-lang · Jan 13, 2025 · b7a4743 · b7a4743
1 parent 54b8998
commit b7a4743
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 3 deletions.
diff --git a/pkgs/oauth2/CHANGELOG.md b/pkgs/oauth2/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.0.5
+
+* Updated README
+
 ## 2.0.4-wip
 
 * Require Dart 3.4

diff --git a/pkgs/oauth2/README.md b/pkgs/oauth2/README.md
@@ -128,15 +128,16 @@ because different options exist for each platform.
 For Flutter apps, there's two popular approaches:
 
 1.  Launch a browser using [url_launcher][] and listen for a redirect using
-    [uni_links][].
+    [app_links][].
 
     ```dart
       if (await canLaunch(authorizationUrl.toString())) {
         await launch(authorizationUrl.toString()); }
 
       // ------- 8< -------
 
-      final linksStream = getLinksStream().listen((Uri uri) async {
+      final appLinks = AppLinks();
+      final linksStream = appLinks.uriLinkStream.listen((Uri uri) async {
        if (uri.toString().startsWith(redirectUrl)) {
          responseUrl = uri;
        }
@@ -161,6 +162,46 @@ For Flutter apps, there's two popular approaches:
       );
     ```
 
+
+1.  To handle redirect on Flutter Web you would need to add a html file to the web folder with some 
+additional JS code to handle the redirect back to the app (in this example the code will be saved 
+and passed through localStorage).
+
+    ```html
+        <!DOCTYPE html>
+        <html>
+        <head>
+            <meta charset="UTF-8" />
+            <title>OAuth Callback</title>
+        </head>
+        <body>
+        <script>
+            const urlParams = new URLSearchParams(window.location.search);
+            const code = urlParams.get('code');
+        
+            // Store them in localStorage (or sessionStorage).
+            if (code) {
+              localStorage.setItem('oauth_code', code);
+            }
+            
+            // Redirect back to app
+            window.location.replace('/#/');
+        </script>
+        </body>
+        </html>
+    ```
+
+    After redirect to the application the code can be extracted and processed using the dart.html 
+    package
+
+    ```dart
+       import 'dart:html' as html;
+       ...
+       if(html.window.localStorage.containsKey('oauth_code')
+          code = html.window.localStorage.remove('oauth_code')
+       ...
+    ```
+
 For Dart apps, the best approach depends on the available options for accessing
 a browser. In general, you'll need to launch the authorization URL through the
 client's browser and listen for the redirect URL.

diff --git a/pkgs/oauth2/pubspec.yaml b/pkgs/oauth2/pubspec.yaml
@@ -1,5 +1,5 @@
 name: oauth2
-version: 2.0.4-wip
+version: 2.0.5
 description: >-
   A client library for authenticating with a remote service via OAuth2 on
   behalf of a user, and making authorized HTTP requests with the user's