Skip to content

Reference

@olimsaidov/icdp is ESM-only and ships five subpath entry points. Each is imported by its exact specifier; there is no root export. The Node Relay adapter (@olimsaidov/icdp/relay/node) requires Node >= 22; the other entry points run anywhere a DOM exists.

Entry points

SpecifierExportsReference
@olimsaidov/icdp/framestartFrameAgent — runs inside the embedded appFrame Agent
@olimsaidov/icdp/hostIcdpHost — the parent-window hubHost
@olimsaidov/icdp/relayRelayCore — runtime-agnostic Relay coreRelay
@olimsaidov/icdp/relay/nodeserveRelay — Node http + ws adapterRelay
@olimsaidov/icdp/protocolshared types, constants, and message shapesProtocol
ts
import { startFrameAgent } from "@olimsaidov/icdp/frame";
import { IcdpHost } from "@olimsaidov/icdp/host";
import { RelayCore } from "@olimsaidov/icdp/relay";
import { serveRelay } from "@olimsaidov/icdp/relay/node";
import { PROTOCOL_VERSION } from "@olimsaidov/icdp/protocol";

Cross-cutting reference

Two pages describe behavior that spans the entry points:

  • CDP support matrix — the CDP domains and methods the Frame Agent registers, the methods the Relay answers itself, and what is intentionally unsupported.
  • HTTP endpoints — the discovery and status routes the Node Relay serves over HTTP, alongside its WebSocket upgrade paths.

Released under the MIT License.