Files

admin 9bf56a806b Move docs/ package mirror into document-navigator plugin

Relocate the ~6k-file docs tree from the repo root into
plugins/document-navigator/docs/ so the plugin is self-contained and
portable. docs/superpowers/ (specs and plans) stays at the repo root.

Moved via cp+rm rather than git mv because directory rename() fails with
EPERM on this WSL /mnt DrvFs mount; git rename-detection pairs the
identical-content files at commit time.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-05-30 01:10:00 +01:00

src

Move docs/ package mirror into document-navigator plugin

2026-05-30 01:10:00 +01:00

README.md

Move docs/ package mirror into document-navigator plugin

2026-05-30 01:10:00 +01:00

README.md

@suaveplan/drive-transport-https - HTTPS relay transport for the drive mesh. Implements TransportLike over a relay endpoint with bearer auth, long-poll receive, exponential backoff, and AbortSignal cancellation.

Summary

HTTPS-relay-backed TransportLike<MessageEnvelope> for the Suaveplan drive mesh. Implements long-poll receive, stateless POST send, exponential backoff with equal-jitter, and Zod-validated wire format. Browser-friendly: the relay is the only HTTP server in the loop, so peers never need to host an inbound endpoint.

import { HttpsTransport } from "@suaveplan/drive-transport-https";

const transport = new HttpsTransport({
    relayUrl: "https://relay.example.com",
    ourPeerId: "ab12...",
    authToken: process.env.RELAY_TOKEN,
});
transport.start();
const off = transport.onMessage((envelope) => console.log(envelope.id));
await transport.connect("peer-b", "ignored");
await transport.send("peer-b", envelope);
off();
await transport.stop();

See src/transport/https-transport.md for full semantics, error-handling guidance, and the relay contract.

Documentation tree

schemas — (no submodules)
- transport.schema — (no submodules)
defaults — Centralises default values for HttpsTransport so every part of the package agrees on the same numbers. Living in its…
https-transport — Implements HttpsTransport, the HTTPS-relay-backed TransportLike<MessageEnvelope> for @suaveplan/drive-mesh and an…
error-codes — Defines the structured error registry for @suaveplan/drive-transport-https. Every failure mode the HTTPS relay transp…

- [transport.schema](./src/schemas/transport.schema.md) — _(no submodules)_- [defaults](./src/transport/defaults.md) — Centralises default values for `HttpsTransport` so every part of the package agrees on the same numbers. Living in its…

https-transport — Implements HttpsTransport, the HTTPS-relay-backed TransportLike<MessageEnvelope> for @suaveplan/drive-mesh and an…
error-codes — Defines the structured error registry for @suaveplan/drive-transport-https. Every failure mode the HTTPS relay transp…
transport.schema — (no submodules)- defaults — Centralises default values for HttpsTransport so every part of the package agrees on the same numbers. Living in its…
https-transport — Implements HttpsTransport, the HTTPS-relay-backed TransportLike<MessageEnvelope> for @suaveplan/drive-mesh and an…
error-codes — Defines the structured error registry for @suaveplan/drive-transport-https. Every failure mode the HTTPS relay transp…
transport.schema — (no submodules)- defaults — Centralises default values for HttpsTransport so every part of the package agrees on the same numbers. Living in its…
https-transport — Implements HttpsTransport, the HTTPS-relay-backed TransportLike<MessageEnvelope> for @suaveplan/drive-mesh and an…
error-codes — Defines the structured error registry for @suaveplan/drive-transport-https. Every failure mode the HTTPS relay transp…
transport.schema — (no submodules)- defaults — Centralises default values for HttpsTransport so every part of the package agrees on the same numbers. Living in its…
https-transport — Implements HttpsTransport, the HTTPS-relay-backed TransportLike<MessageEnvelope> for @suaveplan/drive-mesh and an…
error-codes — Defines the structured error registry for @suaveplan/drive-transport-https. Every failure mode the HTTPS relay transp…