BloomRpcContract<TInput, TOutput> class

Strongly-typed specification of an RPC network endpoint.

BloomRpcContract defines the network boundary contract shared between client applications and backend servers:

• HTTP Method & Path: Specifies the HTTP verb (method) and URL path template (pathTemplate), supporting path parameter tokens (e.g. '/users/:id/posts/:postId').
• Input & Output Types: Parameterized on TInput (request payload / query parameters) and TOutput (decoded response payload).
• Codecs: Encodes inputs to JSON-compatible structures via encodeInput and decodes server responses into strongly typed Dart objects via decodeOutput.
• Zero Transport Overhead: A contract is a pure description, carrying no transport or network logic itself. It can be declared as a compile-time const or top-level final.

End-to-End Type Safety Example

// 1. Shared contract declaration (shared across client and server)
class CreateTaskInput {
  final String title;
  final bool completed;
  CreateTaskInput({required this.title, this.completed = false});
  Map<String, dynamic> toJson() => {'title': title, 'completed': completed};
}

class Task {
  final String id;
  final String title;
  final bool completed;
  Task({required this.id, required this.title, required this.completed});
  factory Task.fromJson(Map<String, dynamic> json) => Task(
    id: json['id'] as String,
    title: json['title'] as String,
    completed: json['completed'] as bool? ?? false,
  );
}

const createTaskContract = BloomRpcContract<CreateTaskInput, Task>.post(
  '/tasks',
  encodeInput: (input) => input.toJson(),
  decodeOutput: Task.fromJson,
);

// 2. Client-side execution with full type inference
final client = BloomRpcClient(baseUrl: 'https://api.example.com');
final Task createdTask = await client.call(
  createTaskContract,
  CreateTaskInput(title: 'Write unit tests'),
);

See also:

• BloomRpcClient, the client that executes contracts over HTTP.
• rpcQuery, for binding contracts to reactive BloomQuery caches.
• rpcMutation, for binding contracts to BloomMutation state machines.
• BloomRpcRouter, for registering server-side handlers for contracts.