authyra_flutter 0.1.0

The Flutter integration for Authyra. Provides secure storage, reactive UI components, and official OAuth/Credentials provider

authyra_flutter

Flutter layer for authyra. Adds OAuth2 providers (Google, GitHub, Apple), SecureAuthStorage, and a AuthGuard widget on top of the core framework. Re-exports the entire authyra package — one import, everything included.

---

Installation

dependencies:
  authyra_flutter: ^0.1.0

---

Quick start

import 'package:authyra_flutter/authyra_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Authyra.initialize(
    client: AuthyraClient(
      providers: [
        CredentialsProvider.withTokens(
          id: 'email',
          authorize: (creds) async {
            final res = await myApi.post('/auth/login', body: creds);
            if (res.statusCode != 200) return null;
            return AuthSignInResult(
              user: AuthUser(id: res.data['id'], email: res.data['email']),
              accessToken: res.data['accessToken'],
              refreshToken: res.data['refreshToken'],
              expiresAt: DateTime.parse(res.data['expiresAt']),
            );
          },
        ),
        GoogleProvider(clientId: 'YOUR_GOOGLE_CLIENT_ID'),
        GitHubOAuth2Provider(
          clientId: 'YOUR_GITHUB_CLIENT_ID',
          redirectUri: 'myapp://auth/callback',
        ),
      ],
      storage: SecureAuthStorage(),
    ),
  );

  runApp(const MyApp());
}

---

Providers

Google

final googleProvider = GoogleProvider(
  clientId: 'YOUR_CLIENT_ID',
  // redirectUri defaults to com.googleusercontent.apps.<clientId>:/oauth2redirect
  // scopes default to ['openid', 'email', 'profile']
);

// Wire deep-link callback once at startup:
OAuth2CallbackHandler.registerProvider(
  'com.googleusercontent.apps.YOUR_CLIENT_ID',
  googleProvider,
);
AppLinks().uriLinkStream.listen(OAuth2CallbackHandler.handleCallback);

// Sign in:
await Authyra.instance.signIn('google');

GitHub

final githubProvider = GitHubOAuth2Provider(
  clientId: 'YOUR_CLIENT_ID',
  redirectUri: 'myapp://auth/callback',
  // scopes default to ['read:user', 'user:email']
);

OAuth2CallbackHandler.registerProvider('myapp', githubProvider);

await Authyra.instance.signIn('github');

Apple

final appleProvider = AppleProvider(
  clientId: 'com.example.myapp',
  redirectUri: 'https://example.com/auth/apple/callback',
);

await Authyra.instance.signIn('apple');

Any OAuth2 provider

OAuth2Provider handles any standards-compliant IdP with PKCE:

final discordProvider = OAuth2Provider(
  config: OAuth2Config(
    providerName:          'discord',
    clientId:              'YOUR_CLIENT_ID',
    authorizationEndpoint: 'https://discord.com/oauth2/authorize',
    tokenEndpoint:         'https://discord.com/api/oauth2/token',
    userInfoEndpoint:      'https://discord.com/api/users/@me',
    redirectUri:           'myapp://auth/callback',
    scopes:                ['identify', 'email'],
    usePkce:               true,
    userExtractor: (json) => AuthUser(
      id:    json['id']       as String,
      email: json['email']    as String?,
      name:  json['username'] as String?,
    ),
  ),
);

Proxy OAuth (backend-delegated)

Keeps the client secret and code exchange on your server. The app only opens the browser and receives a custom token via deep link:

final googleProxy = ProxyOAuthProvider(
  config: ProxyOAuthConfig(
    providerName:       'google',
    initiationEndpoint: 'https://api.example.com/auth/google/initiate',
    callbackEndpoint:   'https://api.example.com/auth/google/callback',
    appCallbackScheme:  'myapp://auth/callback',
    backendRedirectUri: 'https://api.example.com/auth/google/oauth-callback',
    userExtractor: (json) => AuthUser(
      id:    json['id']    as String,
      email: json['email'] as String?,
    ),
  ),
);

// Wire deep-link in your link handler:
AppLinks().uriLinkStream.listen((uri) {
  if (uri.toString().startsWith('myapp://auth/callback')) {
    googleProxy.handleDeepLink(uri);
  }
});

---

Storage

SecureAuthStorage wraps flutter_secure_storage (Keychain on iOS, Keystore on Android). Use it as-is — no configuration required.

storage: SecureAuthStorage()

---

Reactive UI

StreamBuilder

StreamBuilder<AuthState>(
  stream: Authyra.instance.authStateChanges,
  builder: (context, snapshot) {
    final state = snapshot.data ?? AuthState.unauthenticated();
    return switch (state.type) {
      AuthStateType.authenticated   => Dashboard(user: state.user!),
      AuthStateType.unauthenticated => LoginPage(),
      AuthStateType.error           => ErrorPage(message: state.error!),
    };
  },
);

Synchronous state (no await)

if (Authyra.instance.isAuthenticated) {
  final name = Authyra.instance.currentUser?.name;
}

---

Multi-account

// List signed-in accounts
final users = await Authyra.instance.accounts.getAll();

// Switch active account
await Authyra.instance.accounts.switchTo(userId);

// Sign out a specific account
await Authyra.instance.accounts.signOut(userId);

// Sign out all accounts
await Authyra.instance.accounts.signOutAll();

---

Deep-link setup

OAuth2 providers rely on deep links to receive the authorization callback. Wire once at startup with OAuth2CallbackHandler:

// Register each provider under the URI scheme it expects
OAuth2CallbackHandler.registerProvider('com.googleusercontent.apps.YOUR_ID', googleProvider);
OAuth2CallbackHandler.registerProvider('myapp', githubProvider);

// Forward all incoming links to the handler
AppLinks().uriLinkStream.listen(OAuth2CallbackHandler.handleCallback);

---

Documentation

meragix.github.io/authyra

License

MIT