refactor: rename package fai_client_sdk -> chain_client_sdk
Some checks failed
Security / Security check (push) Failing after 2s
Some checks failed
Security / Security check (push) Failing after 2s
The SDK belongs to the Ch∆In product, not the F∆I vendor namespace (a future Brain client SDK would otherwise collide). Rename the Dart package, entry library, test + example files. Also drop a private project name from a doc comment. dart analyze: clean. Dependents must update their dependency name + package: imports. Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
This commit is contained in:
parent
d680cf3462
commit
14c8f38f36
5 changed files with 11 additions and 11 deletions
10
README.md
10
README.md
|
|
@ -1,4 +1,4 @@
|
||||||
# fai_client_sdk (Dart)
|
# chain_client_sdk (Dart)
|
||||||
|
|
||||||
gRPC client SDK for the Ch∆In hub. Used by F∆I Studio
|
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
|
(Tier-2 generic GUI) and any Tier-3 Dart/Flutter domain app
|
||||||
|
|
@ -9,10 +9,10 @@ One of the three SDK families documented in
|
||||||
|
|
||||||
* `fai-module-sdk` (Rust) — flow modules
|
* `fai-module-sdk` (Rust) — flow modules
|
||||||
* `fai-plugin-sdk` (Rust) — Studio plugins
|
* `fai-plugin-sdk` (Rust) — Studio plugins
|
||||||
* `fai_client_sdk` (Dart) — clients ← this package
|
* `chain_client_sdk` (Dart) — clients ← this package
|
||||||
|
|
||||||
Dir / repo carries the `_dart` / `-dart` language suffix
|
Dir / repo carries the `_dart` / `-dart` language suffix
|
||||||
(`fai_client_sdk_dart` / `client-sdk-dart`); the Dart package
|
(`chain_client_sdk_dart` / `client-sdk-dart`); the Dart package
|
||||||
name itself does not (Dart-land doesn't need the suffix).
|
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`,
|
||||||
|
|
@ -35,9 +35,9 @@ boilerplate. This package centralises that work:
|
||||||
## Layout
|
## Layout
|
||||||
|
|
||||||
```
|
```
|
||||||
fai_client_sdk_dart/
|
chain_client_sdk_dart/
|
||||||
├── lib/
|
├── lib/
|
||||||
│ ├── fai_client_sdk.dart # Public API
|
│ ├── chain_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_io.dart # Native ClientChannel (HTTP/2)
|
||||||
|
|
|
||||||
|
|
@ -1,8 +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_client_sdk_example.dart`.
|
// Run with `dart run example/chain_client_sdk_example.dart`.
|
||||||
|
|
||||||
import 'package:fai_client_sdk/fai_client_sdk.dart';
|
import 'package:chain_client_sdk/chain_client_sdk.dart';
|
||||||
|
|
||||||
Future<void> main() async {
|
Future<void> main() async {
|
||||||
final client = HubClient(
|
final client = HubClient(
|
||||||
|
|
@ -2,8 +2,8 @@
|
||||||
///
|
///
|
||||||
/// Provides a typed Dart wrapper around the hub's gRPC services
|
/// Provides a typed Dart wrapper around the hub's gRPC services
|
||||||
/// (Hub, HubAdmin) defined in `fai/chain`'s `proto/chain/v1/`
|
/// (Hub, HubAdmin) defined in `fai/chain`'s `proto/chain/v1/`
|
||||||
/// directory. Used by F∆I Studio and any Tier-3 Dart/Flutter
|
/// directory. Used by Ch∆In Studio and any Tier-3 Dart/Flutter
|
||||||
/// app (DigiScout, J∆I, Scout, …) that wants to talk to a hub.
|
/// app that wants to talk to a hub.
|
||||||
///
|
///
|
||||||
/// The generated protobuf bindings live under
|
/// The generated protobuf bindings live under
|
||||||
/// `lib/src/generated/`. Re-run `tools/generate.sh` whenever the
|
/// `lib/src/generated/`. Re-run `tools/generate.sh` whenever the
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
name: fai_client_sdk
|
name: chain_client_sdk
|
||||||
description: gRPC client SDK for the Ch∆In hub. Used by F∆I Studio and Tier-3 domain apps.
|
description: gRPC client SDK for the Ch∆In hub. Used by F∆I Studio and Tier-3 domain apps.
|
||||||
version: 0.18.0
|
version: 0.18.0
|
||||||
publish_to: 'none'
|
publish_to: 'none'
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
import 'package:fai_client_sdk/fai_client_sdk.dart';
|
import 'package:chain_client_sdk/chain_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