uae_pass_kit 0.0.1

Unofficial UAE Pass Flutter plugin: app-to-app sign-in, profile retrieval, document sharing, PDF e-signature, token refresh and logout in pure Dart.

example/lib/main.dart

import 'dart:convert';
import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:uae_pass_kit/uae_pass_kit.dart';

/// UAE Pass's own publicly documented staging POC credentials.
const _sandboxClientId = 'sandbox_stage';
const _sandboxClientSecret = 'sandbox_stage';

void main() {
  runApp(const UaePassKitExampleApp());
}

class UaePassKitExampleApp extends StatelessWidget {
  const UaePassKitExampleApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'UAE PASS Kit',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        useMaterial3: true,
        colorScheme: ColorScheme.fromSeed(
          seedColor: const Color(0xFFAD904C), // Professional Gold
          brightness: Brightness.light,
          primary: const Color(0xFF1A1A1A), // Dark accents
          secondary: const Color(0xFFAD904C),
        ),
        cardTheme: CardThemeData(
          elevation: 0,
          shape: RoundedRectangleBorder(
            borderRadius: BorderRadius.circular(16),
            side: BorderSide(color: Colors.grey.shade200),
          ),
          color: Colors.white,
        ),
        elevatedButtonTheme: ElevatedButtonThemeData(
          style: ElevatedButton.styleFrom(
            backgroundColor: const Color(0xFF1A1A1A),
            foregroundColor: Colors.white,
            minimumSize: const Size.fromHeight(56),
            shape: RoundedRectangleBorder(
              borderRadius: BorderRadius.circular(12),
            ),
            textStyle: const TextStyle(
              fontSize: 16,
              fontWeight: FontWeight.bold,
            ),
          ),
        ),
        outlinedButtonTheme: OutlinedButtonThemeData(
          style: OutlinedButton.styleFrom(
            minimumSize: const Size.fromHeight(48),
            shape: RoundedRectangleBorder(
              borderRadius: BorderRadius.circular(12),
            ),
            side: const BorderSide(color: Color(0xFF1A1A1A)),
            foregroundColor: const Color(0xFF1A1A1A),
          ),
        ),
      ),
      home: const SignInPage(),
    );
  }
}

class SignInPage extends StatefulWidget {
  const SignInPage({super.key});

  @override
  State<SignInPage> createState() => _SignInPageState();
}

class _SignInPageState extends State<SignInPage> {
  late final UaePassConfig _config;
  late final UaePassKit _uaePassKit;

  bool _isBusy = false;
  String? _statusMessage;
  UaePassProfile? _profile;
  UaePassTokenResponse? _token;
  bool _showArabic = false;
  bool? _isAppInstalled;
  String? _signingStatus;
  String? _documentShareStatus;

  @override
  void initState() {
    super.initState();

    _config = UaePassConfig(
      clientId: _sandboxClientId,
      redirectUri: Uri.parse('https://uaepasskit.dev/example/callback'),
      appCallbackScheme: 'uaepasskitexample',
      environment: UaePassEnvironment.staging,
      locale: UaePassLocale.en,
    );

    _uaePassKit = UaePassKit(
      config: _config,
      tokenExchanger: UaePassDirectTokenExchanger(
        clientId: _sandboxClientId,
        clientSecret: _sandboxClientSecret,
        environment: _config.environment,
      ),
      signingTokenExchanger: UaePassDirectSigningTokenExchanger(
        clientId: _sandboxClientId,
        clientSecret: _sandboxClientSecret,
        environment: _config.environment,
      ),
    );

    _checkAppInstalled();
  }

  @override
  void dispose() {
    _uaePassKit.dispose();
    super.dispose();
  }

  Future<void> _checkAppInstalled() async {
    final installed = await _uaePassKit.isUaePassAppInstalled();
    if (!mounted) return;
    setState(() => _isAppInstalled = installed);
  }

  Future<void> _signIn() async {
    setState(() {
      _isBusy = true;
      _statusMessage = null;
      _profile = null;
      _token = null;
      _signingStatus = null;
      _documentShareStatus = null;
    });

    final result = await _uaePassKit.signIn(context);

    switch (result) {
      case UaePassAuthSuccess(:final code):
        await _exchangeAndFetchProfile(code);
      case UaePassAuthCancelled():
        setState(() {
          _isBusy = false;
          _statusMessage = 'Sign-in cancelled.';
        });
      case UaePassAuthFailure(:final exception):
        setState(() {
          _isBusy = false;
          _statusMessage = 'Sign-in failed: ${exception.message}';
        });
    }
  }

  Future<void> _exchangeAndFetchProfile(String code) async {
    try {
      final token = await _uaePassKit.exchangeAuthorizationCode(code);
      final profile = await _uaePassKit.getProfile(token);
      setState(() {
        _isBusy = false;
        _token = token;
        _profile = profile;
        _statusMessage = null;
      });
    } on UaePassException catch (e) {
      setState(() {
        _isBusy = false;
        _statusMessage = 'Could not complete sign-in: ${e.message}';
      });
    }
  }

  Future<void> _signOut() async {
    setState(() => _isBusy = true);
    await _uaePassKit.logout();
    setState(() {
      _isBusy = false;
      _profile = null;
      _token = null;
      _signingStatus = null;
      _documentShareStatus = null;
      _statusMessage = 'Signed out.';
    });
  }

  Future<void> _refreshToken() async {
    final refreshToken = _token?.refreshToken;
    if (refreshToken == null) {
      setState(() => _statusMessage = 'No refresh token available.');
      return;
    }

    setState(() {
      _isBusy = true;
      _statusMessage = null;
    });
    try {
      final refreshed = await _uaePassKit.refreshAccessToken(refreshToken);
      setState(() {
        _isBusy = false;
        _token = refreshed;
        _statusMessage = 'Token refreshed.';
      });
    } on UaePassException catch (e) {
      setState(() {
        _isBusy = false;
        _statusMessage = 'Refresh failed: ${e.message}';
      });
    }
  }

  Future<void> _signSampleDocument() async {
    setState(() {
      _isBusy = true;
      _signingStatus = null;
    });
    try {
      final outcome = await _uaePassKit.signDocument(
        context,
        UaePassSigningRequest(
          documentBytes: _buildSamplePdfBytes(),
          documentFileName: 'sample.pdf',
          finishCallbackUrl: Uri.parse('uaepasskitexample://sign/finish'),
          signer: const UaePassSigner(
            fields: [
              UaePassSignatureField(
                name: 'signature1',
                pageNumber: 1,
                rectangle: UaePassSignatureRectangle(
                  x: 50,
                  y: 50,
                  width: 100,
                  height: 50,
                ),
              ),
            ],
          ),
        ),
      );
      if (!mounted) return;
      setState(() {
        _isBusy = false;
        _signingStatus = 'Successfully signed: ${outcome.name}';
      });
    } on UaePassException catch (e) {
      if (!mounted) return;
      setState(() {
        _isBusy = false;
        _signingStatus = 'Signing failed: ${e.message}';
      });
    }
  }

  Future<void> _requestDocumentShare() async {
    final profile = _profile;
    final token = _token;
    if (profile == null || token == null) return;

    setState(() {
      _isBusy = true;
      _documentShareStatus = null;
    });
    try {
      await for (final status in _uaePassKit.requestDocumentShare(
        UaePassDocumentShareRequest(
          accessToken: token.accessToken,
          emiratesId: profile.emiratesId ?? '',
          uuid: profile.uuid ?? '',
          documents: const [
            UaePassDocumentRequestItem(
              documentType: 'EmiratesId',
              required: true,
            ),
          ],
          successUrl: Uri.parse('uaepasskitexample://doc-share/success'),
          failureUrl: Uri.parse('uaepasskitexample://doc-share/failure'),
          origin: UaePassDocumentShareOrigin.mobile,
        ),
      )) {
        if (!mounted) return;
        setState(() => _documentShareStatus = status.runtimeType.toString());
      }
    } on UaePassConfigurationException catch (e) {
      if (!mounted) return;
      setState(() => _documentShareStatus = e.message);
    } finally {
      if (mounted) setState(() => _isBusy = false);
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: const Color(0xFFF8F9FA),
      body: SafeArea(
        child: AnimatedSwitcher(
          duration: const Duration(milliseconds: 400),
          child: _profile == null ? _buildLoginView() : _buildProfileView(),
        ),
      ),
    );
  }

  Widget _buildLoginView() {
    return SingleChildScrollView(
      key: const ValueKey('login_view'),
      padding: const EdgeInsets.symmetric(horizontal: 24, vertical: 40),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.center,
        children: [
          const SizedBox(height: 40),
          Container(
            padding: const EdgeInsets.all(16),
            decoration: BoxDecoration(
              color: Colors.white,
              shape: BoxShape.circle,
              boxShadow: [
                BoxShadow(
                  color: Colors.black.withOpacity(0.05),
                  blurRadius: 20,
                  offset: const Offset(0, 10),
                ),
              ],
            ),
            child: const Icon(
              Icons.fingerprint,
              size: 80,
              color: Color(0xFFAD904C),
            ),
          ),
          const SizedBox(height: 32),
          Text(
            'UAE PASS',
            style: Theme.of(context).textTheme.headlineMedium
                ?.copyWith(fontWeight: FontWeight.bold, letterSpacing: 2),
          ),
          const SizedBox(height: 8),
          Text(
            'Your secure digital identity',
            style: Theme.of(context).textTheme.bodyLarge
                ?.copyWith(color: Colors.grey.shade600),
          ),
          const SizedBox(height: 64),
          ElevatedButton.icon(
            onPressed: _isBusy ? null : _signIn,
            icon: _isBusy
                ? const SizedBox(
                    height: 20,
                    width: 20,
                    child: CircularProgressIndicator(
                      strokeWidth: 2,
                      color: Colors.white,
                    ),
                  )
                : const Icon(Icons.login),
            label: Text(_isBusy ? 'Connecting...' : 'Sign in with UAE PASS'),
          ),
          if (_statusMessage != null) ...[
            const SizedBox(height: 24),
            Container(
              padding: const EdgeInsets.all(12),
              decoration: BoxDecoration(
                color: Colors.red.shade50,
                borderRadius: BorderRadius.circular(8),
              ),
              child: Text(
                _statusMessage!,
                textAlign: TextAlign.center,
                style: TextStyle(color: Colors.red.shade800, fontSize: 14),
              ),
            ),
          ],
          const SizedBox(height: 40),
          _AppStatusCard(isInstalled: _isAppInstalled),
        ],
      ),
    );
  }

  Widget _buildProfileView() {
    final profile = _profile!;
    return SingleChildScrollView(
      key: const ValueKey('profile_view'),
      padding: const EdgeInsets.all(24),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.stretch,
        children: [
          Row(
            children: [
              IconButton(
                onPressed: _signOut,
                icon: const Icon(Icons.logout),
                style: IconButton.styleFrom(backgroundColor: Colors.white),
              ),
              const Spacer(),
              const Text('EN', style: TextStyle(fontWeight: FontWeight.bold)),
              Switch(
                value: _showArabic,
                activeColor: const Color(0xFFAD904C),
                onChanged: (v) => setState(() => _showArabic = v),
              ),
              const Text('AR', style: TextStyle(fontWeight: FontWeight.bold)),
            ],
          ),
          const SizedBox(height: 24),
          Text('Welcome,', style: Theme.of(context).textTheme.titleLarge),
          Text(
            (_showArabic ? profile.fullNameAr : profile.fullNameEn) ?? 'User',
            style: Theme.of(context).textTheme.headlineSmall
                ?.copyWith(fontWeight: FontWeight.bold),
          ),
          const SizedBox(height: 32),
          Card(
            child: Column(
              children: [
                _ProfileListTile(
                  icon: Icons.badge_outlined,
                  label: 'Emirates ID',
                  value: profile.emiratesId,
                ),
                const Divider(height: 1, indent: 56),
                _ProfileListTile(
                  icon: Icons.public_outlined,
                  label: 'Nationality',
                  value: _showArabic
                      ? profile.nationalityAr
                      : profile.nationalityEn,
                ),
                const Divider(height: 1, indent: 56),
                _ProfileListTile(
                  icon: Icons.email_outlined,
                  label: 'Email',
                  value: profile.email,
                ),
                const Divider(height: 1, indent: 56),
                _ProfileListTile(
                  icon: Icons.phone_android_outlined,
                  label: 'Mobile',
                  value: profile.mobile,
                ),
              ],
            ),
          ),
          const SizedBox(height: 32),
          Text(
            'Actions',
            style: Theme.of(context).textTheme.titleMedium
                ?.copyWith(fontWeight: FontWeight.bold),
          ),
          const SizedBox(height: 12),
          OutlinedButton.icon(
            onPressed: _isBusy ? null : _refreshToken,
            icon: const Icon(Icons.refresh, size: 20),
            label: const Text('Refresh Session'),
          ),
          const SizedBox(height: 12),
          OutlinedButton.icon(
            onPressed: _isBusy ? null : _signSampleDocument,
            icon: const Icon(Icons.assignment_turned_in_outlined, size: 20),
            label: const Text('Digital Signature (Sandbox)'),
          ),
          if (_signingStatus != null) ...[
            Padding(
              padding: const EdgeInsets.only(top: 8, left: 4),
              child: Text(
                _signingStatus!,
                style: TextStyle(color: Colors.grey.shade600, fontSize: 13),
              ),
            ),
          ],
          const SizedBox(height: 12),
          OutlinedButton.icon(
            onPressed: _isBusy ? null : _requestDocumentShare,
            icon: const Icon(Icons.share_outlined, size: 20),
            label: const Text('Request Document Sharing'),
          ),
          if (_documentShareStatus != null) ...[
            Padding(
              padding: const EdgeInsets.only(top: 8, left: 4),
              child: Text(
                _documentShareStatus!,
                style: TextStyle(color: Colors.grey.shade600, fontSize: 13),
              ),
            ),
          ],
          const SizedBox(height: 40),
          Text(
            'Note: Some features require a backend integration as described in the README.',
            textAlign: TextAlign.center,
            style: TextStyle(fontSize: 12, color: Colors.grey.shade500),
          ),
        ],
      ),
    );
  }
}

class _AppStatusCard extends StatelessWidget {
  const _AppStatusCard({required this.isInstalled});
  final bool? isInstalled;

  @override
  Widget build(BuildContext context) {
    return Card(
      child: Padding(
        padding: const EdgeInsets.symmetric(horizontal: 16, vertical: 12),
        child: Row(
          children: [
            Icon(
              isInstalled == true
                  ? Icons.check_circle_outline
                  : isInstalled == false
                  ? Icons.error_outline
                  : Icons.hourglass_empty,
              color: isInstalled == true
                  ? Colors.green
                  : isInstalled == false
                  ? Colors.orange
                  : Colors.grey,
            ),
            const SizedBox(width: 12),
            Expanded(
              child: Text(
                isInstalled == null
                    ? 'Checking UAE PASS app...'
                    : isInstalled!
                    ? 'UAE PASS app is installed'
                    : 'UAE PASS app is not detected',
                style: const TextStyle(fontSize: 13),
              ),
            ),
          ],
        ),
      ),
    );
  }
}

class _ProfileListTile extends StatelessWidget {
  const _ProfileListTile({required this.icon, required this.label, this.value});

  final IconData icon;
  final String label;
  final String? value;

  @override
  Widget build(BuildContext context) {
    return ListTile(
      leading: Icon(icon, color: const Color(0xFFAD904C)),
      title: Text(
        label,
        style: TextStyle(
          fontSize: 12,
          color: Colors.grey.shade600,
          fontWeight: FontWeight.w500,
        ),
      ),
      subtitle: Text(
        value ?? '—',
        style: const TextStyle(
          fontSize: 16,
          color: Colors.black87,
          fontWeight: FontWeight.w600,
        ),
      ),
      dense: true,
    );
  }
}

Uint8List _buildSamplePdfBytes() {
  const header = '%PDF-1.4\n';
  const obj1 = '1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n';
  const obj2 = '2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n';
  const obj3 =
      '3 0 obj\n<< /Type /Page /Parent 2 0 R /Resources << >> '
      '/MediaBox [0 0 200 200] >>\nendobj\n';

  final offset1 = header.length;
  final offset2 = offset1 + obj1.length;
  final offset3 = offset2 + obj2.length;
  final xrefOffset = offset3 + obj3.length;

  String padOffset(int offset) => offset.toString().padLeft(10, '0');

  final xref =
      'xref\n0 4\n'
      '0000000000 65535 f \n'
      '${padOffset(offset1)} 00000 n \n'
      '${padOffset(offset2)} 00000 n \n'
      '${padOffset(offset3)} 00000 n \n';
  final trailer =
      'trailer\n<< /Size 4 /Root 1 0 R >>\nstartxref\n$xrefOffset\n%%EOF';

  final pdf = '$header$obj1$obj2$obj3$xref$trailer';
  return Uint8List.fromList(utf8.encode(pdf));
}