@hsuite/connect-types

Canonical TypeScript definitions and Zod schemas for the HSuite Native Connect ecosystem.

Quick Start

# Install workspace dependencies
pnpm install

# Build package
pnpm --filter @hsuite/connect-types build

Development

• Source: src/ - TypeScript types and Zod schemas
• Build: TypeScript declaration files to dist/
• No runtime code - Types only package

Key Exports

• Channel types (ChannelInvite, ChannelMessage, ChannelState, TransportState)
• Session types (UnifiedSession, SessionRequest, SessionApproval)
• Ledger types (LedgerId, NetworkId, Account, LedgerPluginManifest)
• RPC types (RpcRequest, RpcResponse, RpcError)
• Vault types (VaultSeed, VaultKey, VaultProtection, VaultRecoveryBundle)
• Transaction types (TransactionPayload, SignResult, SubmitResult)
• Telemetry types (TelemetryEvent, TelemetryConfig)
• Widget types (WidgetManifest, WidgetPermission)
• Theme types (HsuiteTheme, ThemeColors, ThemeMetadata)

Directory Structure

• src/ - All type definitions and Zod schemas
• dist/ - Built TypeScript declarations

Scripts

• pnpm build - Build type definitions
• pnpm docs - Generate Compodoc documentation

Usage Example

import { 
  SessionRequest, 
  SessionRequestSchema,
  LedgerId,
  NetworkId 
} from '@hsuite/connect-types';

// Type-safe usage
const request: SessionRequest = {
  appId: 'my-dapp',
  appName: 'My dApp',
  ledgerId: 'hedera',
  networkId: 'hedera:testnet',
};

// Runtime validation with Zod
const validated = SessionRequestSchema.parse(request);

Documentation

📚 Full Documentation: docs/packages/types.md

For comprehensive guides including:

• Complete type catalog
• Zod schema usage
• Runtime validation
• Type inference patterns
• Session management types

Related

• Main README - Project overview
• Documentation Index - All documentation
• RPC Versioning - Protocol versioning

Status: ✅ Production Ready | Type: Foundation package used by all others