voo_core 0.3.1

Core foundation package for the Voo Flutter ecosystem. Provides plugin architecture and shared utilities.

Voo Core

The foundation package for the Voo Flutter ecosystem. This package provides the core initialization system and plugin architecture that all other Voo packages depend on.

Features

• 🚀 Centralized initialization system
• 🔌 Plugin registration and management
• 🛠️ Shared utilities and base classes
• 📊 Performance metrics interfaces
• 🎯 Analytics event definitions
• ☁️ Optional cloud sync for telemetry data

Installation

dependencies:
  voo_core: ^0.0.2

Usage

Basic Initialization

import 'package:voo_core/voo_core.dart';

void main() async {
  // Initialize Voo Core
  await Voo.initializeApp(
    options: VooOptions(
      enableDebugLogging: true,
      autoRegisterPlugins: true,
    ),
  );
  
  runApp(MyApp());
}

Cloud Sync (Optional)

Enable cloud sync to automatically send telemetry data to your Voo cloud service:

import 'package:voo_core/voo_core.dart';

void main() async {
  await Voo.initializeApp(
    options: VooOptions(
      // Cloud sync configuration
      apiKey: 'your-api-key-here',
      enableCloudSync: true,
      apiEndpoint: 'https://api.vooflutter.com/v1', // Optional, uses default if not provided
      syncInterval: Duration(minutes: 1), // How often to sync
      batchSize: 100, // Max items per sync batch
    ),
  );
  
  runApp(MyApp());
}

When cloud sync is enabled:

• All logs, analytics events, and performance metrics are automatically queued for sync
• Data is sent in efficient batches to reduce network overhead
• Failed syncs are retried with exponential backoff
• Data is persisted locally using Sembast database until successfully synced
• Duplicate data is automatically filtered to prevent re-sending

Using with Other Voo Packages

Voo Core is required by all other Voo packages. When you use packages like voo_logging, voo_analytics, or voo_performance, they will automatically register themselves with Voo Core:

import 'package:voo_core/voo_core.dart';
import 'package:voo_logging/voo_logging.dart';
import 'package:voo_analytics/voo_analytics.dart';
import 'package:voo_performance/voo_performance.dart';

void main() async {
  // Initialize core first
  await Voo.initializeApp();
  
  // Initialize only the packages you need
  await VooLoggingPlugin.instance.initialize();
  await VooAnalyticsPlugin.instance.initialize();
  await VooPerformancePlugin.instance.initialize();
  
  runApp(MyApp());
}

Creating Custom Plugins

You can create your own plugins that integrate with the Voo ecosystem:

class MyCustomPlugin extends VooPlugin {
  @override
  String get name => 'my_custom_plugin';
  
  @override
  String get version => '1.0.0';
  
  @override
  FutureOr<void> onCoreInitialized() {
    // Called when Voo Core is initialized
    print('My plugin is ready!');
  }
  
  @override
  void dispose() {
    // Cleanup resources
  }
}

// Register your plugin
Voo.registerPlugin(MyCustomPlugin());

Platform Utils

The package includes platform detection utilities:

import 'package:voo_core/voo_core.dart';

if (PlatformUtils.isMobile) {
  // Mobile-specific code
}

if (PlatformUtils.isWeb) {
  // Web-specific code
}

print('Running on: ${PlatformUtils.platformName}');

Base Interceptor

Create network interceptors that work across all Voo packages:

class MyInterceptor extends BaseInterceptor {
  @override
  bool get enabled => true;
  
  @override
  FutureOr<void> onRequest({
    required String method,
    required String url,
    Map<String, String>? headers,
    dynamic body,
    Map<String, dynamic>? metadata,
  }) {
    // Handle request
  }
  
  @override
  FutureOr<void> onResponse({
    required int statusCode,
    required String url,
    required Duration duration,
    Map<String, String>? headers,
    dynamic body,
    int? contentLength,
    Map<String, dynamic>? metadata,
  }) {
    // Handle response
  }
  
  @override
  FutureOr<void> onError({
    required String url,
    required Object error,
    StackTrace? stackTrace,
    Map<String, dynamic>? metadata,
  }) {
    // Handle error
  }
}

API Reference

Voo Class

• initializeApp({VooOptions? options}) - Initialize the Voo Core system
• registerPlugin(VooPlugin plugin) - Register a plugin
• unregisterPlugin(String pluginName) - Unregister a plugin
• getPlugin<T>(String name) - Get a registered plugin by name
• hasPlugin(String name) - Check if a plugin is registered
• dispose() - Dispose all plugins and cleanup

VooOptions

• enableDebugLogging - Enable debug logging (default: true in debug mode)
• autoRegisterPlugins - Auto-register plugins when they're imported (default: true)
• customConfig - Custom configuration map
• initializationTimeout - Timeout for initialization (default: 10 seconds)
• apiKey - API key for cloud services (optional)
• apiEndpoint - Custom API endpoint (optional, defaults to https://api.vooflutter.com/v1)
• enableCloudSync - Enable cloud synchronization (default: false)
• syncInterval - How often to sync data (default: 1 minute)
• batchSize - Maximum items per sync batch (default: 100)

License

MIT