Skip to Content

Overview

@gloocan/cat-inspector helps you expose selected TypeScript functions and Express handlers to QA tools over a versioned wire protocol. Integrators register units (fnKey + handler), optionally enrich types from source via an AST pass, then serve a catalog and execute RPC—for Gloocan QA web, that path is attachCatRPC on Socket.IO next to your HTTP server.

Pillars

  1. Registry — Each registered unit has a stable string key (ClassName.methodName), parameter metadata, declared return, return/error labels, and optional JSON Schemas for validation.
  2. RPC — executeRPC invokes a registered handler with positional arguments and returns a structured RpcResponse.
  3. Host transport — attachCatRPC (import @gloocan/cat-inspector/socket-io) is the primary integration: catalog, invoke, uploads, and sessions over Socket.IO. Optional embedded WebSocket: startInspectorWebSocket for standalone tooling.
  4. Catalog build — attachCatRPC takes scanRoots and a nested bootstrap object (AST scan, file-wire hints, Minio, timeouts, and so on); the SDK builds the registry and emits catalog:bootstrap to clients.

Where to go next

  • Installation — package, peers, TypeScript flags for @Cat.
  • Quick start — copy-paste minimal attachCatRPC server example.
  • attachCatRPC — Socket.IO host options, secretApiKey, nested catalog fields, validation helpers.
  • API index — every public export with links.
OverviewInstallation