orchestrator_generator #

Code generator for orchestrator_core's offline support. Automatically generates NetworkJobRegistry registration code.

Features #

• NetworkRegistryGenerator: Generates registerNetworkJobs from @NetworkRegistry
• OrchestratorGenerator: Generates declarative event routing mixin from @Orchestrator & @OnEvent
• AsyncStateGenerator: Generates copyWith, when, maybeWhen from @GenerateAsyncState
• JobGenerator: Generates toJson/fromJson and boilerplate from @GenerateJob
• EventGenerator: Generates boilerplate for events from @GenerateEvent
• ExecutorRegistryGenerator: Generates registerExecutors from @ExecutorRegistry

Installation #

dependencies:
  orchestrator_core: ^0.2.0
  
dev_dependencies:
  orchestrator_generator: ^0.2.0
  build_runner: ^2.4.0

Usage #

1. Annotate your configuration #

import 'package:orchestrator_core/orchestrator_core.dart';

// List all NetworkAction jobs that need offline support
@NetworkRegistry([
  SendMessageJob,
  UploadFileJob,
  SyncDataJob,
])
class AppConfig {}

2. Run the generator #

dart run build_runner build

3. Use the generated function #

// In your app initialization
import 'app_config.g.dart';

void main() {
  registerNetworkJobs(); // Generated function
  runApp(MyApp());
}

Generated output #

// app_config.g.dart
/// Auto-generated function to register all network jobs.
/// Call this during app initialization before processing offline queue.
///
/// Registered jobs:
/// - `SendMessageJob`
/// - `UploadFileJob`
/// - `SyncDataJob`
void registerNetworkJobs() {
  NetworkJobRegistry.register('SendMessageJob', SendMessageJob.fromJson);
  NetworkJobRegistry.register('UploadFileJob', UploadFileJob.fromJson);
  NetworkJobRegistry.register('SyncDataJob', SyncDataJob.fromJson);
}

Job Requirements #

Each job in the registry must have a fromJson factory constructor:

class SendMessageJob extends BaseJob implements NetworkAction {
  final String message;
  
  SendMessageJob(this.message) : super(id: generateJobId('msg'));
  
  // Required for offline restoration
  factory SendMessageJob.fromJson(Map<String, dynamic> json) {
    return SendMessageJob(json['message'] as String);
  }
  
  @override
  Map<String, dynamic> toJson() => {'message': message};
}

3. Declarative Orchestrator #

@Orchestrator()
class MyOrchestrator extends BaseOrchestrator<MyState> with _$MyOrchestratorEventRouting {
  @OnEvent(UserLoggedIn)
  void _handleLogin(UserLoggedIn event) {
    emit(state.copyWith(user: event.user));
  }
}

4. Async State Generation #

@GenerateAsyncState()
class MyState {
  final AsyncStatus status;
  final String? data;
  final Object? error;
  
  const MyState({this.status = AsyncStatus.initial, this.data, this.error});
}

Documentation #

See the full documentation.

License #

MIT License