app.realtime() apre uno stream Server-Sent Events e restituisce la Response grezza. L’SDK non analizza i frame SSE al posto tuo — ti consegna lo stream così puoi collegarlo al tuo event loop.
Limiti di connessione
- Ogni connessione dura fino a 10 minuti, poi il server la chiude
- Un singolo account può mantenere al massimo 10 connessioni concorrenti aperte
Struttura degli eventi
Lo stream emette due tipi di frame:
event: system — messaggi di ciclo di vita della connessione come REALTIME_CONNECTING, REALTIME_TIMEOUT, ecc.
event: message — il payload JSON dell’applicazione
Consumare lo stream
import { SquareCloudAPI } from "@squarecloud/api";
const api = new SquareCloudAPI(process.env.SQUARE_API_KEY!);
const app = await api.applications.fetch("abc123def456abc123def456");
const response = await app.realtime();
if (!response.body) {
throw new Error("No stream body");
}
const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
let buffer = "";
while (true) {
const { value, done } = await reader.read();
if (done) break;
buffer += value;
// SSE frames are separated by \n\n
let separator = buffer.indexOf("\n\n");
while (separator !== -1) {
const rawFrame = buffer.slice(0, separator);
buffer = buffer.slice(separator + 2);
separator = buffer.indexOf("\n\n");
const event = parseSSE(rawFrame);
if (!event) continue;
if (event.name === "system") {
console.log(`[system] ${event.data}`);
continue;
}
try {
const payload = JSON.parse(event.data);
console.log("[message]", payload);
} catch {
console.log("[message]", event.data);
}
}
}
function parseSSE(frame: string): { name: string; data: string } | null {
let name = "message";
let data = "";
for (const line of frame.split("\n")) {
if (line.startsWith("event:")) name = line.slice(6).trim();
else if (line.startsWith("data:")) data += line.slice(5).trim();
}
return data ? { name, data } : null;
}
Ogni chiamata a app.realtime() restituisce una nuova Response. Per restare connesso oltre il timeout di 10 minuti del server, riconnettiti quando lo stream termina.