@floegence/flowersec-core
v0.17.1
Published
Flowersec core TypeScript library (browser-friendly E2EE + multiplexing over WebSocket).
Downloads
3,139
Readme
@floegence/flowersec-core
Flowersec core TypeScript library for building an end-to-end encrypted, multiplexed connection over WebSocket (browser-friendly).
Status: experimental; not audited.
Install
npm install @floegence/flowersec-coreUsage
Browser (recommended):
import { connectBrowser } from "@floegence/flowersec-core/browser";
const grant = await fetch("/api/flowersec/channel/init", { method: "POST" }).then((r) => r.json());
const client = await connectBrowser(grant);
await client.ping();
client.close();Node.js (recommended):
import { connectNode } from "@floegence/flowersec-core/node";
const grant = await fetch("https://your-app.example/api/flowersec/channel/init", { method: "POST" }).then((r) => r.json());
const client = await connectNode(grant, { origin: "https://your-app.example" });
await client.ping();
client.close();Docs
- Frontend quickstart:
docs/FRONTEND_QUICKSTART.md - Integration guide:
docs/INTEGRATION_GUIDE.md - API surface contract:
docs/API_SURFACE.md - Error model:
docs/ERROR_MODEL.md
