interceptly 1.0.1

Flutter network inspector for Dio, HTTP, and Chopper with overlay UI, replay tools, and HAR/cURL export.

Interceptly

Interceptly is a high-performance network inspector for Flutter. It provides real-time traffic visualization for Dio, Http, and Chopper with minimal impact on UI performance.

---

Preview

Inspector Overview	Request Details	Replay Tool
[assets/images/overview_demo.gif]	[assets/images/request_detail_demo.gif]	[assets/images/relay_tool_demo.gif]

---

Features

• High Performance: Background isolates handle all serialization logic to prevent UI jank.
• Hybrid Storage: Smart memory management that offloads large payloads to temporary files.
• Postman-like Replay: Built-in request editor to modify headers/body and re-send requests.
• Network Simulation: Global profiles for Offline, 3G, 4G, or custom latency/bandwidth.
• Advanced Formatters: Specialized views for GraphQL, Multipart, cURL, and Binary data.
• Flexible Triggers: Support for Shake, Long Press, Floating Button, or Custom Streams.

---

Install

Add the following to your pubspec.yaml:

dependencies:
  interceptly: ^1.0.1

---

Quick Start (Dio)

import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'package:interceptly/interceptly.dart';

void main() {
  final dio = Dio()..interceptors.add(Interceptly.dioInterceptor);

  runApp(
    MaterialApp(
      home: InterceptlyOverlay(
        child: MyApp(dio: dio),
      ),
    ),
  );
}

---

Integrations

HTTP (package:http)

import 'package:http/http.dart' as http;

final client = Interceptly.wrapHttpClient(http.Client());
final res = await client.get(Uri.parse('[https://api.example.com/data](https://api.example.com/data)'));

Chopper

final chopper = ChopperClient(
  interceptors: [InterceptlyChopperInterceptor()],
);

---

Network Simulation

Simulate various network conditions globally for all intercepted requests:

// Apply built-in profiles
Interceptly.instance.setNetworkSimulation(NetworkSimulationProfile.slow3G);

// Custom profile definition
Interceptly.instance.setNetworkSimulation(
  const NetworkSimulationProfile(
    name: 'Custom Profile',
    latencyMs: 500,
    downloadKbps: 1000,
    uploadKbps: 500,
  ),
);

---

Configuration

InterceptlySettings

Parameter	Default	Description
bodyOffloadThreshold	50 KB	Threshold to move body to temp file
maxEntries	5000	Maximum requests kept in history
maxBodyBytes	2 MB	Hard cap for body size before truncation

UI Triggers

InterceptlyOverlay(
  config: InterceptlyConfig(
    triggers: {
      InspectorTrigger.floatingButton,
      InspectorTrigger.shake,
      InspectorTrigger.longPress,
    },
  ),
  child: MyApp(),
)

---

Navigator Setup (MaterialApp.router)

If using MaterialApp.router, pass the navigator key to the overlay:

final navigatorKey = GlobalKey();

MaterialApp.router(
  routerConfig: router,
  builder: (context, child) {
    return InterceptlyOverlay(
      navigatorKey: navigatorKey,
      child: child ?? const SizedBox(),
    );
  },
)

---

Storage Model

• Small Payloads: Kept in memory for instant access.
• Large Payloads: Written to temporary files via background isolates.
• Lazy Loading: Data is only read from disk when a record is selected.

---

License

MIT License - see LICENSE for details.

---

Published by stormx.dev