Bee.UI.Core 4.1.0

Bee.UI.Core

繁體中文

Client-side bridging layer for Bee.NET UI applications. Bee.UI.Core wraps Bee.Api.Client connectors with a single static entry point (ClientInfo) that manages connection settings, login state, and definition-data access — letting WinForms / WPF / Avalonia hosts focus on views instead of plumbing.

Targets net10.0.

✨ Features

• One-line bootstrap: ClientInfo.Initialize(...) resolves the saved endpoint, validates it, falls back to a connection setup view when missing, and primes the API connector.
• Local & remote connection abstraction: Switch between local (file-based define path) and remote (JSON-RPC URL) by changing the endpoint string; the rest of the API surface is unchanged.
• Connector caching: SystemApiConnector and IDefineAccess are cached per token; resetting the access token automatically invalidates them.
• Pluggable persistence: Replace the default EndpointStorage (XML-backed <exe>.Settings.xml) with your own IEndpointStorage implementation.
• Host-supplied UI: Connection-settings dialogs are abstracted behind IUIViewService, leaving the choice of UI framework to the consumer.

📦 Installation

dotnet add package Bee.UI.Core

Or in .csproj:

<PackageReference Include="Bee.UI.Core" Version="4.1.0" />

This package depends on:

(Transitively pulls in Bee.Base, Bee.Definition, Bee.Api.Core, Bee.Api.Contracts.)

🚀 Quick Start

1. Implement the host UI service

IUIViewService is invoked when the saved endpoint is missing or unreachable, prompting the user to configure a new one.

using Bee.UI.Core;

public class MainFormUIViewService : IUIViewService
{
    public bool ShowApiConnect()
    {
        using var dialog = new ApiConnectDialog();
        return dialog.ShowDialog() == DialogResult.OK;
    }
}

2. Initialize on startup

using Bee.UI.Core;
using Bee.Api.Client;

// At application startup:
if (!ClientInfo.Initialize(new MainFormUIViewService(), SupportedConnectTypes.Both))
{
    // User cancelled the connection setup — exit.
    return;
}

Or directly with a known endpoint (no UI fallback):

ClientInfo.Initialize("http://localhost:5000/jsonrpc/api");

3. Apply the login result

After a successful login through SystemApiConnector, hand the response to ClientInfo to populate the access token and user info:

var response = await ClientInfo.SystemApiConnector.LoginAsync(userId, password);
ClientInfo.ApplyLoginResult(response);

4. Use the connectors

// System-level connector (cached per token):
var system = ClientInfo.SystemApiConnector;

// Form-level connector for a specific program:
var employee = ClientInfo.CreateFormApiConnector("Employee");

// Definition data access:
var formSchema = ClientInfo.DefineAccess.GetFormSchema("Employee");

🔧 Customization

Replace the endpoint storage

The default EndpointStorage persists to <ExeName>.Settings.xml next to the executable. To use a different backend (registry, environment variable, in-memory, etc.) supply your own implementation before Initialize:

public class EnvVarEndpointStorage : IEndpointStorage
{
    public string LoadEndpoint() => Environment.GetEnvironmentVariable("API_ENDPOINT") ?? "";
    public void SetEndpoint(string endpoint) { /* ... */ }
    public void SaveEndpoint(string endpoint) => Environment.SetEnvironmentVariable("API_ENDPOINT", endpoint);
}

ClientInfo.EndpointStorage = new EnvVarEndpointStorage();
ClientInfo.Initialize(uiViewService, SupportedConnectTypes.Both);

Override the endpoint via command line

Initialize(IUIViewService, SupportedConnectTypes) parses Key=Value pairs from the command line. Pass Endpoint=... to override the saved endpoint at launch:

MyApp.exe Endpoint=http://staging.example.com/jsonrpc/api

The parsed dictionary is exposed through ClientInfo.Arguments.

🧩 Public API at a glance

🌐 Bee.NET Ecosystem

📬 Contact

Facebook ｜ HackMD ｜ GitHub ｜ NuGet

📄 License

MIT © Bee.NET