Zum Hauptinhalt springen

JavaScript SDK

@telepat/otto-sdk ist das offizielle TypeScript/JavaScript SDK zur Integration von Otto in Drittanbieter-Anwendungen. Es wrappt die Relay-WebSocket- und HTTP-APIs in einen sauberen, typsicheren Client, der in Node.js 22+, Cloudflare Workers, Deno und jeder anderen Laufzeitumgebung mit nativem fetch und WebSocket funktioniert.

npm install @telepat/otto-sdk

Was Sie mit dem SDK tun können

FähigkeitSDK-Oberfläche
Mit dem Relay verbundene Nodes auflistenclient.nodes.list()
Verfügbare Befehle auf einem Node auflistenclient.commands.list({ nodeId })
Befehl ausführen und Ergebnis erhaltenclient.commands.run({ nodeId, site, command, input })
Live-Listener-Updates streamenclient.listeners.subscribe({ nodeId, listener })
Ausstehende Kopplungsanfragen auflistenclient.pairing.listPending()
Kopplungscode genehmigenclient.pairing.approve({ code })

Wie es in die Otto-Architektur passt

Das SDK fungiert als Controller — dieselbe Rolle wie die @telepat/otto-CLI. Befehle fließen von Ihrer Anwendung über das SDK zum Relay, dann zum Browser-Node:

Ihre App → @telepat/otto-sdk → Relay → Browser-Node (Erweiterung)

Das SDK übernimmt:

  • Anmeldeinformationsaustausch (clientId + clientSecret → JWT-Access-Token)
  • WebSocket-Lebenszyklus (Verbinden, Auth-Handshake, Heartbeat, Wiederverbindung)
  • Anfrage/Antwort-Korrelation über requestId
  • Typisiertes Streaming über AsyncIterable und EventEmitter

Bevor Sie beginnen

Sie benötigen ein laufendes Relay und einen registrierten Controller-Client. Der schnellste Weg:

# Relay starten
otto start

# Controller-Client registrieren und clientId + clientSecret notieren
otto client register --name "Meine App"

Siehe Erste Schritte für den vollständigen Setup-Walkthrough.

In diesem Abschnitt

SeiteWas Sie finden
Erste SchritteRegistrierung, Installation, Verbinden und Ihr erster Befehl
API-ReferenzVollständige API für OttoClient, Sub-Clients, StreamSession und Fehlertypen
BeispielePraxisnahe Muster: Edge-Laufzeiten, Wiederholung, CI, Streaming