diff --git a/README.md b/README.md index cce1999..a3b5bd9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ -# fai_dart_sdk +# fai_client_sdk (Dart) gRPC client SDK for the F∆I Platform hub. Used by F∆I Studio (Tier-2 generic GUI) and any Tier-3 Dart/Flutter domain app -(DigiScout, J∆I, Scout, …) that wants to talk to a running -`fai serve`. +that wants to talk to a running `fai serve`. + +One of the three SDK families documented in +`fai/platform/docs/architecture/sdks.md`: + + * `fai-module-sdk` (Rust) — flow modules + * `fai-plugin-sdk` (Rust) — Studio plugins + * `fai_client_sdk` (Dart) — clients ← this package + +Dir / repo carries the `_dart` / `-dart` language suffix +(`fai_client_sdk_dart` / `client-sdk-dart`); the Dart package +name itself does not (Dart-land doesn't need the suffix). > **Status (2026-05-05):** scaffold. Public surface (`HubClient`, > `HubEndpoint`) is committed; generated proto bindings land in @@ -25,11 +35,13 @@ boilerplate. This package centralises that work: ## Layout ``` -fai_dart_sdk/ +fai_client_sdk_dart/ ├── lib/ -│ ├── fai_dart_sdk.dart # Public API +│ ├── fai_client_sdk.dart # Public API │ └── src/ │ ├── hub_client.dart # Typed client wrapper +│ ├── channel_factory_io.dart # Native ClientChannel (HTTP/2) +│ ├── channel_factory_web.dart # GrpcWebClientChannel.xhr (HTTP/1.1) │ └── generated/ # protoc output (committed; pinned to platform tag) ├── tools/ │ └── generate.sh # Wraps `protoc --dart_out=...` against ../fai_platform/proto @@ -39,9 +51,8 @@ fai_dart_sdk/ ## Repo placement -Will be published as `fai/dart-sdk` on Forgejo -(`git.flemming.ws`). The local directory `fai_dart_sdk/` -follows the established `fai_platform/` layout convention. +Published as `fai/client-sdk-dart` on Forgejo +(`git.flemming.ai`). ## Versioning diff --git a/example/fai_dart_sdk_example.dart b/example/fai_client_sdk_example.dart similarity index 64% rename from example/fai_dart_sdk_example.dart rename to example/fai_client_sdk_example.dart index 262377b..d5af03e 100644 --- a/example/fai_dart_sdk_example.dart +++ b/example/fai_client_sdk_example.dart @@ -1,10 +1,8 @@ // Example: connect to a locally-running F∆I hub. // -// Run with `dart run example/fai_dart_sdk_example.dart`. -// Currently the SDK is a stub; once codegen lands, this example -// will exercise the actual Hub RPCs. +// Run with `dart run example/fai_client_sdk_example.dart`. -import 'package:fai_dart_sdk/fai_dart_sdk.dart'; +import 'package:fai_client_sdk/fai_client_sdk.dart'; Future main() async { final client = HubClient( diff --git a/lib/fai_dart_sdk.dart b/lib/fai_client_sdk.dart similarity index 100% rename from lib/fai_dart_sdk.dart rename to lib/fai_client_sdk.dart diff --git a/pubspec.yaml b/pubspec.yaml index 137aaba..86346fa 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ -name: fai_dart_sdk +name: fai_client_sdk description: gRPC client SDK for the F∆I Platform hub. Used by F∆I Studio and Tier-3 domain apps. version: 0.16.0 publish_to: 'none' -repository: https://git.flemming.ws/fai/dart-sdk +repository: https://git.flemming.ai/fai/client-sdk-dart environment: sdk: ^3.11.0-200.1.beta diff --git a/test/fai_dart_sdk_test.dart b/test/fai_client_sdk_test.dart similarity index 93% rename from test/fai_dart_sdk_test.dart rename to test/fai_client_sdk_test.dart index f94f0da..31e82bf 100644 --- a/test/fai_dart_sdk_test.dart +++ b/test/fai_client_sdk_test.dart @@ -1,4 +1,4 @@ -import 'package:fai_dart_sdk/fai_dart_sdk.dart'; +import 'package:fai_client_sdk/fai_client_sdk.dart'; import 'package:test/test.dart'; void main() {