auto_interop #

Use any native package in Flutter — npm, CocoaPods, SPM, or Gradle — with auto-generated type-safe Dart bindings.

// Generated from Alamofire (iOS) — no manual bridging code
final session = await Session.create();
final request = await session.request('https://api.example.com', HTTPMethod.get, null);
final response = await request.response();
print('Status: ${response.statusCode}');

Quick Start #

1. Install #

# pubspec.yaml
dependencies:
  auto_interop: ^0.2.0

dev_dependencies:
  auto_interop_generator: ^0.2.0
  build_runner: ^2.4.0

2. Declare native packages #

Create auto_interop.yaml in your project root:

native_packages:
  - source: npm
    package: "date-fns"
    version: "^3.6.0"
    imports:
      - "format"
      - "addDays"

  - source: cocoapods
    package: "Alamofire"
    version: "~> 5.9"
    imports:
      - "Session"
      - "DataRequest"

  - source: gradle
    package: "com.squareup.okhttp3:okhttp"
    version: "4.12.0"
    imports:
      - "OkHttpClient"
      - "Request"

3. Generate bindings #

dart run auto_interop_generator:generate

This produces Dart bindings, plus native glue code (Swift plugin for iOS, Kotlin plugin for Android, JS interop for web).

4. Use #

import 'package:auto_interop/auto_interop.dart';
import 'generated/alamofire.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await AutoInteropLifecycle.instance.initialize();

  final session = await Session.create();
  final request = await session.request(
    'https://httpbin.org/get',
    HTTPMethod.get,
    null,
  );
  final response = await request.response();
  print('Status: ${response.statusCode}');

  await request.dispose();
  await session.dispose();
}

Supported Platforms #

What Gets Generated #

For each native package, the generator produces:

• Dart bindings — classes, methods, enums, and data types with full type safety
• Interfaces — for dependency injection and testing (e.g. SessionInterface)
• Native glue — platform channel handlers that call the real native library
• Data classes — with toMap()/fromMap() for serialization

// Generated interface — use for DI and mocking
abstract interface class SessionInterface {
  Future<DataRequest> request(String url, HTTPMethod method, Map<String, String>? headers);
  Future<String> download(String url, String? destination);
}

// Generated implementation
class Session implements SessionInterface {
  static Future<Session> create() async { ... }

  @override
  Future<DataRequest> request(...) async { ... }
}

Runtime API #

The auto_interop package provides the runtime that generated code depends on. You rarely need to use these directly — generated bindings handle everything.

Initialize at app start #

await AutoInteropLifecycle.instance.initialize();

Handle errors #

try {
  final response = await request.response();
} on AutoInteropException catch (e) {
  print('${e.code}: ${e.message}');
}

Dispose native objects #

Handle-based objects (Session, OkHttpClient, etc.) hold native memory. Always dispose them when done:

final session = await Session.create();
// ... use session ...
await session.dispose();

Testing #

Generated classes expose interfaces for easy mocking. Runtime classes have .withChannel() constructors for test doubles:

// Mock via the generated interface
class MockSession implements SessionInterface {
  @override
  Future<DataRequest> request(...) async => mockRequest;
}

// Or replace the runtime singleton for integration tests
AutoInteropLifecycle.instance = AutoInteropLifecycle.withChannel(mockChannel);

Type Mapping #

Related #

• Documentation — full documentation with examples, architecture, and API reference
• auto_interop_generator — the code generation engine (config, parsers, generators, CLI)
• Example app — full working demo with Alamofire, streams, callbacks, and error handling

License #

BSD 3-Clause. See LICENSE.