FeaturePlugin class - moose_core library

Base class for all feature plugins in the application.

Feature plugins are self-contained modules that provide specific functionality to the application. Each plugin has access to various registries for hooks, addons, widgets, adapters, actions, and the event bus for inter-plugin communication.

Plugin Lifecycle:

Creation: Plugin instance is created via factory function
Configuration Check: PluginRegistry checks if plugin is active in environment.json
Registration: If active, onRegister() is called for setup
Initialization: onInit() is called for async setup (API connections, etc.)
Start: onStart() is called once all plugins finished initialization
Runtime: onAppLifecycle() is called for app foreground/background changes
Stop: onStop() is called during app teardown

Configuration:

Plugins can be configured in environment.json under the plugins key:

{
  "plugins": {
    "products": {
      "active": true,
      "settings": {
        "cache": {
          "productsTTL": 300,
          "categoriesTTL": 600
        }
      },
      "sections": {
        "main": [...]
      }
    }
  }
}

Example Implementation:

class ProductsPlugin extends FeaturePlugin {
  @override
  String get name => 'products';

  @override
  String get version => '1.0.0';

  @override
  void onRegister() {
    // Register widgets
    widgetRegistry.register('product.list', (context, {data, onEvent}) {
      return ProductListWidget(data: data);
    });

    // Register adapters
    adapterRegistry.registerProductsAdapter(WooProductsAdapter());
  }

  @override
  Future<void> onInit() async {
    // Async initialization (API setup, cache warming, etc.)
    await loadInitialData();
  }

  @override
  Map<String, WidgetBuilder>? getRoutes() {
    return {
      '/products': (context) => ProductsScreen(),
      '/product': (context) => ProductDetailScreen(),
    };
  }
}

Properties