gRPC client SDK for the F∆I Platform hub (Dart/Flutter)

Find a file

flemming-it c46dc58ac3 Some checks failed Security / Security check (push) Failing after 2s Details feat: submitStreaming + detached-invocation client (T2/T3) Regenerates the gRPC stubs from the updated proto and adds: - HubClient.submitStreaming(...) -> Stream<SubmitStreamEvent>: follow a flow execution live (step markers, module emit-events, terminal result/error). Works over native gRPC and, on web, gRPC-Web (the same conditional channel factory the rest of the SDK uses). - submit(..., detach: true) and getInvocationStatus / getInvocationResult / cancelInvocation wrappers (T3). - SubmitStreamEvent + InvocationStatus re-exported as typedefs. Shared _buildSubmitRequest between submit + submitStreaming. analyze clean, tests pass. Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>		2026-07-06 01:56:43 +02:00
.forgejo/workflows	ci(security): add self-test harness (mirror of fai/platform)	2026-05-10 21:41:24 +02:00
.githooks	docs: old product name F∆I Platform -> Ch∆In + contact chain@flemming.ai	2026-06-16 10:14:33 +02:00
example	refactor: rename package fai_client_sdk -> chain_client_sdk	2026-06-16 17:39:12 +02:00
lib	feat: submitStreaming + detached-invocation client (T2/T3)	2026-07-06 01:56:43 +02:00
test	refactor: rename package fai_client_sdk -> chain_client_sdk	2026-06-16 17:39:12 +02:00
tools	refactor: regenerate gRPC stubs for chain.v1 wire package	2026-06-16 16:59:35 +02:00
.gitignore	feat: fai_dart_sdk scaffold	2026-05-05 14:19:39 +02:00
analysis_options.yaml	feat: live HubClient with generated proto bindings	2026-05-05 16:24:16 +02:00
CHANGELOG.md	feat: fai_dart_sdk scaffold	2026-05-05 14:19:39 +02:00
pubspec.yaml	refactor: rename package fai_client_sdk -> chain_client_sdk	2026-06-16 17:39:12 +02:00
README.md	refactor: rename package fai_client_sdk -> chain_client_sdk	2026-06-16 17:39:12 +02:00

README.md

chain_client_sdk (Dart)

gRPC client SDK for the Ch∆In hub. Used by F∆I Studio (Tier-2 generic GUI) and any Tier-3 Dart/Flutter domain app 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
chain_client_sdk (Dart) — clients ← this package

Dir / repo carries the _dart / -dart language suffix (chain_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 a follow-up commit once the codegen step is wired in. Until then, downstream apps can compile against the stub and Studio uses mock data.

Why a separate SDK package

The platform hub speaks gRPC. Each Dart consumer (Studio plus each Tier-3 domain app) would otherwise re-generate proto bindings independently and write near-identical client boilerplate. This package centralises that work:

One source of generated proto bindings.
One typed HubClient wrapper with helpers.
One place to bump when the wire protocol evolves.

Layout

chain_client_sdk_dart/
├── lib/
│   ├── chain_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
├── example/
└── pubspec.yaml

Repo placement

Published as fai/client-sdk-dart on Forgejo (git.flemming.ai).

Versioning

Tracks the platform's wire-protocol version, not the platform binary version. As long as fai:platform@1.x is current, this SDK stays at 0.x (will move to 1.0 once API stabilises); when fai:platform@2.0 lands, a 2.x SDK ships in parallel during the transition.