API Reference

import { createCrosslinkServer } from "@crosslink/sdk-node";

const server = createCrosslinkServer(options);

interface CapabilityDef {
  id: string;           // e.g., "app.control"
  title: string;        // e.g., "Control the app"
  risk: "low" | "medium" | "high";
  description?: string;
  defaultGranted?: boolean; // granted by default at pairing when requested
  confirmEachUse?: boolean; // require a fresh prompt on every use
}

{
  ttlMs?: number;
  autoApprove?: boolean; // dev convenience; never for production
  approve?(request: PairingApprovalRequest): PairingApproval | Promise<PairingApproval>;
  bootstrapUrl?: string; // hosted install page for the iOS "Add to Home Screen" flow
}

interface PairingApprovalRequest {
  sas: string;
  deviceName: string;
  deviceId: string;
  requestedCaps: string[];
  requiresExplicitApproval: string[];
  deniedCaps: Array<{ id: string; reason: string }>;
}

await server.start();

await server.stop();

const code = await server.getPairingCode();
// code = {
//   psid: "...",
//   code: "123456789",
//   uri: "crosslink://pair?v=2&e=lan~ws%3A%2F%2F...&c=123456789&a=...&n=...&f=...",
//   expiresAt: 1699999999999,
//   qrSvg: "<svg>...</svg>",
//   endpoints: [{ kind: "lan", url: "ws://192.168.1.5:51820" }]
// }

server.expose("app.status", () => ({ ok: true }), {
  capability: "app.control"  // Optional capability requirement
});

interface RpcContext {
  deviceId: string;      // which paired device is calling
  requestId: string;
  signal: AbortSignal;   // aborts on client cancel or session loss
  log: Logger;           // pre-bound with device, method, request id
  emitProgress(d: Json): void;  // progress events without ending the request
}

server.declareEvent("app.tick");

server.emit("app.tick", { t: Date.now() });

const devices = server.listDevices();
// [{ deviceId, name, caps, addedAt, lastSeen, revokedAt }]

server.revokeDevice(deviceId);

server.revokeAllDevices();

server.setDeviceCaps(deviceId, ["app.control"]);

const status = server.getConnectivity();
// { reach: "local-only" | "relayed" | "offline", lan, relay, signaling, webrtc, message, transports }

server.connectionEndpoints();
// [{ kind: "lan", url: "ws://192.168.1.83:57525" },
//  { kind: "wan", url: "ws://203.0.113.9:57525" }]

const { secrets, transports, networkMode } = server.status();

import { createSecureCrosslinkClient } from "@crosslink/sdk-browser";

const client = await createSecureCrosslinkClient({ deviceName: "Phone" });

import { CrosslinkClient } from "@crosslink/sdk-browser";

const client = await CrosslinkClient.create(options);

const client = new CrosslinkClient(options);

const record = await client.pairFromQr(uri, ["app.control"]);

const rpc = await client.connect();

client.close();

client.forget("com.example.myapp");

const apps = client.listApps();

const unsubscribe = client.onStateChange((state, detail) => {
  console.log("state:", state, detail);
});

const result = await rpc.call("app.status", { detail: true });

const unsubscribe = rpc.subscribe("app.tick", (payload) => {
  console.log(payload);
});

createPairingCard({ target: "#crosslink" });