chore: rename package + dir + repo to fai_client_sdk
Some checks failed
Security / Security check (push) Failing after 1s
Some checks failed
Security / Security check (push) Failing after 1s
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:
parent
f481eee687
commit
f882b7f955
5 changed files with 24 additions and 15 deletions
27
README.md
27
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
|
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
|
(Tier-2 generic GUI) and any Tier-3 Dart/Flutter domain app
|
||||||
(DigiScout, J∆I, Scout, …) that wants to talk to a running
|
that wants to talk to a running `fai serve`.
|
||||||
`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`,
|
> **Status (2026-05-05):** scaffold. Public surface (`HubClient`,
|
||||||
> `HubEndpoint`) is committed; generated proto bindings land in
|
> `HubEndpoint`) is committed; generated proto bindings land in
|
||||||
|
|
@ -25,11 +35,13 @@ boilerplate. This package centralises that work:
|
||||||
## Layout
|
## Layout
|
||||||
|
|
||||||
```
|
```
|
||||||
fai_dart_sdk/
|
fai_client_sdk_dart/
|
||||||
├── lib/
|
├── lib/
|
||||||
│ ├── fai_dart_sdk.dart # Public API
|
│ ├── fai_client_sdk.dart # Public API
|
||||||
│ └── src/
|
│ └── src/
|
||||||
│ ├── hub_client.dart # Typed client wrapper
|
│ ├── 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)
|
│ └── generated/ # protoc output (committed; pinned to platform tag)
|
||||||
├── tools/
|
├── tools/
|
||||||
│ └── generate.sh # Wraps `protoc --dart_out=...` against ../fai_platform/proto
|
│ └── generate.sh # Wraps `protoc --dart_out=...` against ../fai_platform/proto
|
||||||
|
|
@ -39,9 +51,8 @@ fai_dart_sdk/
|
||||||
|
|
||||||
## Repo placement
|
## Repo placement
|
||||||
|
|
||||||
Will be published as `fai/dart-sdk` on Forgejo
|
Published as `fai/client-sdk-dart` on Forgejo
|
||||||
(`git.flemming.ws`). The local directory `fai_dart_sdk/`
|
(`git.flemming.ai`).
|
||||||
follows the established `fai_platform/` layout convention.
|
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
// Example: connect to a locally-running F∆I hub.
|
// Example: connect to a locally-running F∆I hub.
|
||||||
//
|
//
|
||||||
// Run with `dart run example/fai_dart_sdk_example.dart`.
|
// Run with `dart run example/fai_client_sdk_example.dart`.
|
||||||
// Currently the SDK is a stub; once codegen lands, this example
|
|
||||||
// will exercise the actual Hub RPCs.
|
|
||||||
|
|
||||||
import 'package:fai_dart_sdk/fai_dart_sdk.dart';
|
import 'package:fai_client_sdk/fai_client_sdk.dart';
|
||||||
|
|
||||||
Future<void> main() async {
|
Future<void> main() async {
|
||||||
final client = HubClient(
|
final client = HubClient(
|
||||||
|
|
@ -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.
|
description: gRPC client SDK for the F∆I Platform hub. Used by F∆I Studio and Tier-3 domain apps.
|
||||||
version: 0.16.0
|
version: 0.16.0
|
||||||
publish_to: 'none'
|
publish_to: 'none'
|
||||||
repository: https://git.flemming.ws/fai/dart-sdk
|
repository: https://git.flemming.ai/fai/client-sdk-dart
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: ^3.11.0-200.1.beta
|
sdk: ^3.11.0-200.1.beta
|
||||||
|
|
|
||||||
|
|
@ -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';
|
import 'package:test/test.dart';
|
||||||
|
|
||||||
void main() {
|
void main() {
|
||||||
Loading…
Add table
Add a link
Reference in a new issue