@gloocan/cat-inspector
A TypeScript runtime SDK, AST scanner, and WebSocket inspector that exposes a host application’s registered functions as QA-callable RPC units.
It is the host-side runtime of the no-code QA platform: developers annotate or register functions, and the QA web app discovers them via a versioned wire protocol and invokes them with JSON arguments.
Pillars
- Registry — allowlist of every callable
fnKey(ClassName.methodName). - Catalog metadata — params, declared return, label states, route info, JSON Schemas.
- AST scanner — extracts real TypeScript types into registry entries.
- Transports — Socket.IO
attachCatRPC(@gloocan/cat-inspector/socket-io) is the path this repo and Gloocan QA web target. Optional embedded WebSocket:startInspectorWebSocketfor standalone tooling. - RPC pipeline —
executeRPCvalidates args, resolves class instances when needed, invokes, serializes results, and returnsRpcResponse. - Inspector events — versioned JSON fan-out for QA UIs (Inspector events).
Conceptual flow
Where to go next
- Getting started → Overview — what the SDK is, what it isn’t.
- Getting started → Installation — install, peer deps, tsconfig requirements.
- Getting started → Quick start — minimal copy-paste
attachCatRPCserver. - Getting started → attachCatRPC — primary host integration over Socket.IO (catalog, RPC, uploads).
- API index — every public export with links into this site.
- Registration →
@Catdecorator — annotate class methods. - RPC pipeline — how
executeRPCvalidates and invokes. - Types glossary —
RegistryEntry,RpcResponse, inspector events.
Package facts
- Name:
@gloocan/cat-inspector - Current version:
0.1.0 - Protocol version:
10 - Source: sdk/ts/
- Optional peer deps:
express,socket.io,minio