create-client

Client Creation Skill

This skill defines the process for creating a new low-level client in the infrastructure/_clients/ directory.

1. Overview

Clients are high-level wrappers around third-party plugins or system APIs (e.g., shared_preferences, dio, package_info). They encapsulate the configuration and complexity of these tools, providing a clean interface for the rest of the infrastructure layer.

2. Directory Structure

Clients are stored in lib/src/infrastructure/_clients/:

lib/src/infrastructure/_clients/
├── _clients.dart        # Barrel file
├── my_plugin_client.dart # The client implementation
└── ...

3. Implementation Pattern

Follow these rules when creating a client:

• Naming: Use PascalCase + Client (e.g., LocationClient).
• DI: Provide the client via a Riverpod provider with keepAlive: true.
• Encapsulation: Hide plugin-specific types behind your own methods where possible.
• Error Handling: Use try/catch blocks and log errors using dart:developer.

3.1 Example Implementation

import 'dart:developer' as developer;
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:my_plugin/my_plugin.dart';

part 'my_plugin_client.g.dart';

@Riverpod(keepAlive: true)
MyPluginClient myPluginClient(Ref ref) => MyPluginClient();

class MyPluginClient {
  final _plugin = MyPlugin();

  Future<bool> doSomething() async {
    try {
      await _plugin.execute();
      return true;
    } on Object catch (e, st) {
      developer.log(
        'MyPluginClient.doSomething failed',
        name: 'MyPluginClient',
        error: e,
        stackTrace: st,
      );
      return false;
    }
  }
}

4. Barrel File

Always export your new client in lib/src/infrastructure/_clients/_clients.dart:

export 'my_plugin_client.dart';

5. Usage in Repositories

Clients are injected into repositories via their constructors. Repositories then use the client's clean methods to perform data operations.