Cocoar.SignalARRR.Contracts 4.0.0

SignalARRR

Typed bidirectional RPC over ASP.NET Core SignalR.

Server and client call each other's methods through shared interfaces — with compile-time proxy generation, streaming, cancellation propagation, and ASP.NET Core authorization. Clients available for .NET, TypeScript/JavaScript, and Swift.

Read the full documentation

Packages

.NET

TypeScript / JavaScript

npm install @cocoar/signalarrr

Swift (iOS / macOS)

.package(url: "https://github.com/cocoar-dev/Cocoar.SignalARRR.git", from: "4.0.0")

Quick Start

Define shared interfaces, set up the server, and call methods with full type safety:

// Shared interface
[SignalARRRContract]
public interface IChatHub {
    Task SendMessage(string user, string message);
    Task<List<string>> GetHistory();
}

// Client usage — one line to get a typed proxy
var chat = connection.GetTypedMethods<IChatHub>();
await chat.SendMessage("Alice", "Hello!");

// TypeScript client
const history = await connection.invoke<string[]>('ChatMethods.GetHistory');

// Swift client — @HubProxy macro generates the proxy
@HubProxy protocol IChatHub { ... }
let chat = connection.getTypedMethods(IChatHubProxy.self)

For full setup guides, streaming, authorization, and server-to-client calls, see the documentation.

Features

• Typed bidirectional RPC — server and client call each other through shared interfaces
• Compile-time proxy generation — Roslyn source generator (zero reflection)
• Organized hub methods — split logic across ServerMethods<T> classes with full DI
• Streaming — IAsyncEnumerable<T>, IObservable<T>, ChannelReader<T> in both directions
• HTTP stream references — file download/upload through SignalR hub methods
• CancellationToken propagation — server can cancel client operations remotely
• Authorization — method-level, class-level, and hub-level [Authorize]
• Server-to-client calls from anywhere — inject ClientManager in controllers, background services, etc.
• Three clients — .NET, TypeScript/JavaScript, Swift with feature parity

Framework Support

Building from Source

# .NET
dotnet build src/Cocoar.SignalARRR.slnx
dotnet test src/Cocoar.SignalARRR.slnx

# TypeScript
cd src/Cocoar.SignalARRR.Typescript && npm install && npm run build

# Swift
swift build && swift test

License

Apache License 2.0 — see LICENSE for details.

Contributing

See CONTRIBUTING.md for guidelines.