Table of Contents

v1.0.0 "Hajimari" - Initial Release

Release Date: July 17, 2025
Code Name: "Hajimari" (Beginning)
Type: Major Release

🎯 Overview

The initial release of Jiro.Shared introduces the foundational shared types and models library for the Jiro ecosystem. This package provides the core communication contracts and data structures used across JiroCloud and Jiro instances.

✨ Features Added

WebSocket Communication

  • Endpoint Constants: Predefined endpoint definitions for consistent WebSocket communication
    • Endpoints.Incoming.* - Server to client events
    • Endpoints.Outgoing.* - Client to server events
    • Endpoints.Lifecycle.* - Connection lifecycle events

Request/Response Models

  • Chat Session Models: ChatSession, SessionResponse, SessionsResponse
  • Command Models: CommandMessage, CommandMetadata, CommandsMetadataResponse
  • Configuration Models: ConfigResponse, ConfigUpdateResponse
  • Logging Models: LogEntry, LogsResponse
  • Theme Models: Theme, ThemesResponse
  • Core Models: ErrorResponse, KeepaliveResponse, SyncResponse
  • WebSocket Parameters: Connection and communication parameter models

gRPC Integration

  • Protocol Buffers: gRPC service definitions in Grpc/jiroHub.proto
  • Generated Services: Strongly-typed gRPC client and server code
  • Type Safety: Compile-time validation for service contracts

Package Configuration

  • NuGet Package: Properly configured as Jiro.Shared with full metadata
  • Documentation: XML documentation for IntelliSense support
  • Dependencies: gRPC, Protocol Buffers, and ASP.NET Core integration
  • Icon and README: Professional package presentation

🛠️ Technical Details

Framework Support

  • Target Framework: .NET 9.0
  • Language Features: C# 13 with nullable reference types enabled
  • Documentation: XML documentation file generation enabled

Dependencies

  • Grpc.AspNetCore v2.66.0
  • Google.Protobuf v3.28.2
  • Grpc.Tools v2.66.0 (build-time only)

Project Structure

source/Jiro.Shared/
├── Grpc/
│   └── jiroHub.proto          # gRPC service definitions
├── Websocket/
│   ├── Endpoints.cs           # WebSocket endpoint constants
│   ├── Requests/              # Request models
│   └── Responses/             # Response models  
├── Jiro.Shared.csproj         # Project configuration
└── Jiro.Shared.nuspec         # NuGet package specification

📊 Release Metrics

  • Total Files: 15+ source files
  • Models Added: 15+ request/response models
  • Endpoint Constants: 25+ predefined endpoints
  • Package Size: ~50KB
  • Dependencies: 3 runtime + 1 build-time

🎉 What This Enables

For Developers

  • Type Safety: Strongly-typed contracts for all communication
  • IntelliSense: Full IDE support with XML documentation
  • Consistency: Standardized models across the Jiro ecosystem
  • Integration: Seamless gRPC and WebSocket communication

For Applications

  • Reliability: Compile-time validation of communication contracts
  • Performance: Efficient binary serialization with Protocol Buffers
  • Scalability: Foundation for distributed Jiro ecosystem
  • Maintainability: Centralized type definitions

🔮 Looking Forward

This initial release establishes the foundation for:

  • Enhanced real-time communication features
  • Additional gRPC service definitions
  • Extended model collections
  • Performance optimizations
  • Cross-platform compatibility improvements

📦 Installation

dotnet add package Jiro.Shared --version 1.0.0

🙏 Acknowledgments

Special thanks to the Jiro ecosystem development team for establishing these foundational shared types that will enable seamless communication across all Jiro applications.

Next Release: v1.0.1 will focus on expanding the model collection and adding performance optimizations based on initial usage feedback.

Edit this page