@ai-monitor/types

Canonical TypeScript session protocol definitions shared by @ai-monitor/bridge and ai-monitor-relay.

Contents

• SessionEnvelope / SessionMessage — Public runtime session protocol
• SessionEnvelopeUploadBatch — Envelope-first relay upload contract
• Runtime Validators — Shared validation helpers for relay upload payloads and gateway RPC contracts
• Gateway Fixtures — Shared JSON fixtures for cross-language wire contract regression tests
• RPC Frame Types — ReqFrame, ResFrame, EventFrame for WebSocket gateway protocol
• Connect Handshake — ConnectParams, HelloOkPayload for gateway authentication
• RuntimeSummary — In-memory runtime metadata exposed via sessions.list RPC
• GatewayConfigBase — Shared gateway configuration interface

Protocol Version

Current protocol version: 3 (exported as PROTOCOL_VERSION).

iOS Alignment

The Swift wire models live in MyAIPartner/Core/Networking/OpenClawProtocol.swift, GatewayFrame.swift, and AnyCodable.swift. They are regression-checked against the shared gateway contract fixtures in MyAIPartnerTests.

Usage

import type {
  EventFrame,
  ReqFrame,
  ResFrame,
  SessionEnvelope,
  SessionEnvelopeUploadBatch,
  SessionMessage,
} from "@ai-monitor/types";
import {
  PROTOCOL_VERSION,
  validateSessionEnvelopeUploadRequest,
  validateSessionsListParams,
} from "@ai-monitor/types";

Build

npm run build   # tsc → dist/
npm test        # build + validate shared gateway fixtures