fai/chain-client-sdk-dart
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: rename package + dir + repo to fai_client_sdk
Some checks failed
Security / Security check (push) Failing after 1s
Details

Browse source 
Adopts the three SDK families convention from
fai/platform/docs/architecture/sdks.md — base name carries
the family, language suffix on dir + repo only:

  fai_dart_sdk          (pkg) → fai_client_sdk
  fai_dart_sdk          (dir) → fai_client_sdk_dart
  fai/dart-sdk          (repo) → fai/client-sdk-dart

Internal lib/test/example file renames track the package
name. Old git.flemming.ws URL also retired here.

Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
This commit is contained in:
flemming-it 2026-05-26 13:46:16 +02:00
parent f481eee687
commit f882b7f955
5 changed files with 24 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -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