Files
Sterister 3243647aa1
Some checks failed
Test / test (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
release(v4.11.1): ship pre-built dist/ to npm registry
publish-all.ts now does a tsc → dist/ build per package before pack, then
rewrites package.json's main/types/exports to point at the built artefacts
and ensures `files: ["dist"]` so the tarball ships only the built code.
The in-repo package.json is restored in the finally block so dev/typecheck
keep working without a build pass.

Why: strict-mode consumers (Cyndr) were forced to recompile Shade source
under their own tsconfig and tripped on internal `process.env.X` accesses
and implicit-any parameters. Shipping pre-built `.js` + `.d.ts` makes the
strictness contract live entirely inside Shade.
2026-05-21 13:29:52 +02:00
..

@shade/transport-webrtc

V3.11 — direct peer-to-peer chunk transport for Shade transfers via RTCDataChannel. Plugs into @shade/transfer's ITransferTransport contract and wires automatically into @shade/sdk via shade.configureWebRTC().

import { createShade } from '@shade/sdk';
import { nativeRtcFactory } from '@shade/transport-webrtc';

const shade = await createShade({ prekeyServer });
shade.configureWebRTC({ factory: nativeRtcFactory() });
shade.configureTransfers({ resolveBaseUrl });

await shade.upload({ to: 'bob', input: file });    // → P2P when NAT allows,
                                                    //   HTTP otherwise.

See docs/webrtc.md for the full guide: NAT-traversal realities, TURN config, glare resolution, wire format, diagnostics, and end-to-end test recipes.

What's inside

  • WebRtcConnection — one peer connection between two Shade endpoints, driving offer/answer/ICE through Shade's own ratchet.
  • WebRtcConnectionManager — per-peer pool with deterministic glare resolution.
  • WebRtcSignalingChannel — JSON signaling messages multiplexed over Shade.send / Shade.onMessage.
  • WebRtcTransferTransport — implements ITransferTransport over the managed DataChannel; ack-correlated by 16-byte requestId tokens.
  • MemoryRtcFactory — in-process WebRTC simulator for tests.
  • nativeRtcFactory() — adapter over globalThis.RTCPeerConnection (browsers / Deno / Cloudflare Workers).

Adapters

@shade/transport-webrtc ships only the standard-API adapter (nativeRtcFactory). For Bun / Node, wrap your library of choice behind the IRtcFactory interface — only createPeerConnection, createDataChannel, and standard addEventListener are required.

Recommended adapters: