Types Registry Module

GTS entity registration, storage, validation, and REST API endpoints for HyperSpot.

Overview

The types-registry module provides:

• Two-phase registration: Configuration phase (no validation) → Production phase (full validation)
• GTS entity storage: In-memory storage using gts-rust for Phase 1.1
• REST API: Endpoints for registering, listing, and retrieving GTS entities
• ClientHub integration: Other modules access via hub.get::<dyn TypesRegistryClient>()?

Usage

Via ClientHub (Rust)

use types_registry_sdk::TypesRegistryClient;

// Get the client from ClientHub
let client = hub.get::<dyn TypesRegistryClient>()?;

// Register entities
let results = client.register(&ctx, entities).await?;

// List entities with filtering
let query = ListQuery::default().with_vendor("acme");
let entities = client.list(&ctx, query).await?;

// Get a single entity
let entity = client.get(&ctx, "gts.acme.core.events.user_created.v1~").await?;

Via REST API

# Register entities
POST /types-registry/v1/entities
Content-Type: application/json

{
  "entities": [
    {
      "$id": "gts://gts.acme.core.events.user_created.v1~",
      "type": "object",
      "properties": { "userId": { "type": "string" } }
    }
  ]
}

# List entities
GET /types-registry/v1/entities?vendor=acme&kind=type

# Get entity by ID
GET /types-registry/v1/entities/gts.acme.core.events.user_created.v1~

Configuration

types_registry:
  entity_id_fields:
    - "$id"
    - "gtsId"
    - "id"
  schema_id_fields:
    - "$schema"
    - "gtsTid"
    - "type"

Core GTS Types

The types-registry module automatically registers core GTS types during initialization. These are framework-level types that other modules depend on:

This ensures that when modules register their derived schemas (e.g., plugin-specific types), the base types are already available for validation.

Two-Phase Registration

1. Configuration Phase: Entities are stored in temporary storage without full validation
2. Production Phase: Call switch_to_production() to validate all entities and move to persistent storage

// During module initialization (configuration phase)
registry.register(&ctx, entities).await?;

// When ready for production
module.switch_to_production()?;

Testing

cargo test -p types-registry