y-openrtc 0.1.0

package/LICENSE

@@ -0,0 +1,92 @@
+Required Notice: Copyright (c) 2026 Bryant Hargreaves and OpenRTC contributors.
+Licensor Line of Business: OpenRTC realtime collaboration runtime, SDKs, developer services, and related tools (https://openrtc.app)
+
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,92 @@
+# y-openrtc
+
+`y-openrtc` is a Yjs provider that feels close to `y-webrtc`, but uses OpenRTC for room membership and peer transport.
+
+## Install
+
+```bash
+pnpm add y-openrtc yjs
+```
+
+## Minimal usage
+
+```ts
+import * as Y from 'yjs';
+import { OpenrtcProvider } from 'y-openrtc';
+
+const doc = new Y.Doc();
+const provider = new OpenrtcProvider('my-room', doc, {
+  apiKey: '<your public OpenRTC API key>',
+});
+```
+
+## Advanced usage
+
+```ts
+import * as Y from 'yjs';
+import { OpenRTC } from 'openrtc';
+import { OpenrtcProvider } from 'y-openrtc';
+
+const client = OpenRTC({
+  apiKey: '<your public OpenRTC API key>',
+});
+
+const doc = new Y.Doc();
+const provider = new OpenrtcProvider('my-room', doc, {
+  runtime: client,
+});
+```
+
+## Transport and strict-mode options
+
+`OpenrtcProvider` forwards OpenRTC transport options when it creates its own runtime:
+
+```ts
+const provider = new OpenrtcProvider('private-room', doc, {
+  apiKey: '<your public OpenRTC API key>',
+  strictMode: true,
+  transports: {
+    iroh: true,
+    webrtc: {
+      privacyMode: true,
+      useTurn: true,
+    },
+    moq: true,
+  },
+  turnCredentialsProvider: async () => ({
+    iceServers: [{
+      urls: ['turn:turn.example.com:3478?transport=udp'],
+      username: 'short-lived-user',
+      credential: 'short-lived-credential',
+    }],
+  }),
+});
+```
+
+Keep TURN credentials server-generated and short lived. Do not commit `.env` files or long-lived secrets.
+
+## Differences from `y-webrtc`
+
+- `signaling` and `peerOpts` are accepted for compatibility, but ignored.
+- OpenRTC remains the source of truth for room membership and peer transport.
+- Same-tab sync still prefers `BroadcastChannel` when available.
+- `password` encrypts provider payloads end-to-end on top of OpenRTC.
+
+## Live test env
+
+The live test at `tests/OpenrtcProvider.live.test.ts` reads package-local env values.
+
+Create `openrtc/packages/y-openrtc/.env.local` with:
+
+```bash
+OPENRTC_LIVE_TESTS=1
+OPENRTC_Y_OPENRTC_API_KEY=<your public OpenRTC API key>
+```
+
+Then run:
+
+```bash
+pnpm --dir openrtc/packages/y-openrtc test:live
+```
+
+The live test only uses the public OpenRTC API key. Server secrets are not needed for this package-local live test and should stay server-side.

package/dist/broadcast.d.ts

@@ -0,0 +1,25 @@
+export interface BroadcastMeshTransportOptions {
+    channelName: string;
+    providerId: string;
+    nodeId: string | null;
+    onPeerMessage: (message: {
+        action: 'add' | 'remove';
+        providerId: string;
+        nodeId: string | null;
+    }) => void;
+    onPayload: (message: {
+        providerId: string;
+        nodeId: string | null;
+        data: Uint8Array;
+    }) => void;
+}
+export declare class BroadcastMeshTransport {
+    private readonly options;
+    private channel;
+    constructor(options: BroadcastMeshTransportOptions);
+    get available(): boolean;
+    connect(): boolean;
+    announcePresence(): void;
+    sendPayload(data: Uint8Array): void;
+    disconnect(): void;
+}

package/dist/broadcast.js

@@ -0,0 +1,65 @@
+export class BroadcastMeshTransport {
+    constructor(options) {
+        this.channel = null;
+        this.options = options;
+    }
+    get available() {
+        return typeof globalThis.BroadcastChannel === 'function';
+    }
+    connect() {
+        if (!this.available || this.channel) {
+            return !!this.channel;
+        }
+        this.channel = new BroadcastChannel(this.options.channelName);
+        this.channel.onmessage = (event) => {
+            const message = event.data;
+            if (!message || message.providerId === this.options.providerId) {
+                return;
+            }
+            if (message.kind === 'peer') {
+                this.options.onPeerMessage({
+                    action: message.action,
+                    providerId: message.providerId,
+                    nodeId: message.nodeId,
+                });
+                return;
+            }
+            this.options.onPayload({
+                providerId: message.providerId,
+                nodeId: message.nodeId,
+                data: message.data,
+            });
+        };
+        this.announcePresence();
+        return true;
+    }
+    announcePresence() {
+        this.channel?.postMessage({
+            kind: 'peer',
+            action: 'add',
+            providerId: this.options.providerId,
+            nodeId: this.options.nodeId,
+        });
+    }
+    sendPayload(data) {
+        this.channel?.postMessage({
+            kind: 'payload',
+            providerId: this.options.providerId,
+            nodeId: this.options.nodeId,
+            data,
+        });
+    }
+    disconnect() {
+        if (!this.channel) {
+            return;
+        }
+        this.channel.postMessage({
+            kind: 'peer',
+            action: 'remove',
+            providerId: this.options.providerId,
+            nodeId: this.options.nodeId,
+        });
+        this.channel.close();
+        this.channel = null;
+    }
+}

package/dist/codec.d.ts

@@ -0,0 +1,18 @@
+import * as awarenessProtocol from 'y-protocols/awareness';
+import type * as Y from 'yjs';
+export declare const MESSAGE_SYNC = 0;
+export declare const MESSAGE_AWARENESS = 1;
+export declare const MESSAGE_QUERY_AWARENESS = 3;
+export interface ApplyProviderMessageOptions {
+    doc: Y.Doc;
+    awareness: awarenessProtocol.Awareness;
+    payload: Uint8Array;
+    origin: unknown;
+    onSynced?: () => void;
+}
+export declare function encodeSyncStep1(doc: Y.Doc): Uint8Array;
+export declare function encodeSyncStep2(doc: Y.Doc): Uint8Array;
+export declare function encodeDocUpdate(update: Uint8Array): Uint8Array;
+export declare function encodeAwarenessQuery(): Uint8Array;
+export declare function encodeAwarenessUpdate(awareness: awarenessProtocol.Awareness, clients: number[]): Uint8Array;
+export declare function applyProviderMessage(options: ApplyProviderMessageOptions): Uint8Array[];

package/dist/codec.js

@@ -0,0 +1,65 @@
+import * as decoding from 'lib0/decoding';
+import * as encoding from 'lib0/encoding';
+import * as awarenessProtocol from 'y-protocols/awareness';
+import * as syncProtocol from 'y-protocols/sync';
+export const MESSAGE_SYNC = 0;
+export const MESSAGE_AWARENESS = 1;
+export const MESSAGE_QUERY_AWARENESS = 3;
+export function encodeSyncStep1(doc) {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, MESSAGE_SYNC);
+    syncProtocol.writeSyncStep1(encoder, doc);
+    return encoding.toUint8Array(encoder);
+}
+export function encodeSyncStep2(doc) {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, MESSAGE_SYNC);
+    syncProtocol.writeSyncStep2(encoder, doc);
+    return encoding.toUint8Array(encoder);
+}
+export function encodeDocUpdate(update) {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, MESSAGE_SYNC);
+    syncProtocol.writeUpdate(encoder, update);
+    return encoding.toUint8Array(encoder);
+}
+export function encodeAwarenessQuery() {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, MESSAGE_QUERY_AWARENESS);
+    return encoding.toUint8Array(encoder);
+}
+export function encodeAwarenessUpdate(awareness, clients) {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, MESSAGE_AWARENESS);
+    encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(awareness, clients));
+    return encoding.toUint8Array(encoder);
+}
+export function applyProviderMessage(options) {
+    const decoder = decoding.createDecoder(options.payload);
+    const messageType = decoding.readVarUint(decoder);
+    switch (messageType) {
+        case MESSAGE_SYNC: {
+            const encoder = encoding.createEncoder();
+            encoding.writeVarUint(encoder, MESSAGE_SYNC);
+            const syncMessageType = syncProtocol.readSyncMessage(decoder, encoder, options.doc, options.origin);
+            if (syncMessageType === syncProtocol.messageYjsSyncStep2) {
+                options.onSynced?.();
+            }
+            if (syncMessageType === syncProtocol.messageYjsSyncStep1) {
+                return [encoding.toUint8Array(encoder)];
+            }
+            return [];
+        }
+        case MESSAGE_QUERY_AWARENESS: {
+            return [
+                encodeAwarenessUpdate(options.awareness, Array.from(options.awareness.getStates().keys())),
+            ];
+        }
+        case MESSAGE_AWARENESS: {
+            awarenessProtocol.applyAwarenessUpdate(options.awareness, decoding.readVarUint8Array(decoder), options.origin);
+            return [];
+        }
+        default:
+            return [];
+    }
+}

package/dist/crypto.d.ts

@@ -0,0 +1,3 @@
+export declare function deriveRoomKey(password: string | null | undefined, roomName: string): Promise<CryptoKey | null>;
+export declare function encryptFrame(payload: Uint8Array, key: CryptoKey | null): Promise<Uint8Array>;
+export declare function decryptFrame(payload: Uint8Array, key: CryptoKey | null): Promise<Uint8Array>;

package/dist/crypto.js

@@ -0,0 +1,56 @@
+const encoder = new TextEncoder();
+const PASSWORD_KDF_ITERATIONS = 210000;
+function concatBytes(...arrays) {
+    const total = arrays.reduce((sum, array) => sum + array.byteLength, 0);
+    const merged = new Uint8Array(total);
+    let offset = 0;
+    for (const array of arrays) {
+        merged.set(array, offset);
+        offset += array.byteLength;
+    }
+    return merged;
+}
+export async function deriveRoomKey(password, roomName) {
+    if (!password) {
+        return null;
+    }
+    const subtle = globalThis.crypto?.subtle;
+    if (!subtle) {
+        throw new Error('Password support requires Web Crypto (crypto.subtle).');
+    }
+    const baseKey = await subtle.importKey('raw', encoder.encode(password), 'PBKDF2', false, ['deriveKey']);
+    return subtle.deriveKey({
+        name: 'PBKDF2',
+        salt: encoder.encode(`openrtc-yjs-room:${roomName}`),
+        iterations: PASSWORD_KDF_ITERATIONS,
+        hash: 'SHA-256',
+    }, baseKey, { name: 'AES-GCM', length: 256 }, false, ['encrypt', 'decrypt']);
+}
+export async function encryptFrame(payload, key) {
+    if (!key) {
+        return payload;
+    }
+    const subtle = globalThis.crypto?.subtle;
+    if (!subtle) {
+        throw new Error('Password support requires Web Crypto (crypto.subtle).');
+    }
+    const iv = globalThis.crypto.getRandomValues(new Uint8Array(12));
+    const cipherBuffer = await subtle.encrypt({ name: 'AES-GCM', iv }, key, payload);
+    return concatBytes(new Uint8Array([1]), iv, new Uint8Array(cipherBuffer));
+}
+export async function decryptFrame(payload, key) {
+    if (!key) {
+        return payload;
+    }
+    if (payload.byteLength < 14 || payload[0] !== 1) {
+        throw new Error('Encrypted provider payload is malformed.');
+    }
+    const subtle = globalThis.crypto?.subtle;
+    if (!subtle) {
+        throw new Error('Password support requires Web Crypto (crypto.subtle).');
+    }
+    const iv = payload.slice(1, 13);
+    const cipher = payload.slice(13);
+    const plainBuffer = await subtle.decrypt({ name: 'AES-GCM', iv }, key, cipher);
+    return new Uint8Array(plainBuffer);
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { OpenrtcProvider, } from './provider.js';
+export { roomNameToOpenrtcRoomId } from './roomName.js';
+export type { OpenrtcAuthMode, OpenrtcProviderEvents, OpenrtcProviderOptions, OpenrtcTransports, PeersEventPayload, StatusEventPayload, SyncedEventPayload, } from './types.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { OpenrtcProvider, } from './provider.js';
+export { roomNameToOpenrtcRoomId } from './roomName.js';

package/dist/provider.d.ts

@@ -0,0 +1,82 @@
+import * as awarenessProtocol from 'y-protocols/awareness';
+import type * as Y from 'yjs';
+import type { OpenrtcProviderEvents, OpenrtcProviderOptions } from './types.js';
+type EventName = keyof OpenrtcProviderEvents;
+type EventListener<K extends EventName> = (payload: OpenrtcProviderEvents[K]) => void;
+export declare class OpenrtcProvider {
+    readonly roomName: string;
+    readonly doc: Y.Doc;
+    readonly awareness: awarenessProtocol.Awareness;
+    readonly maxConns: number;
+    private readonly options;
+    private readonly providerId;
+    private readonly listeners;
+    private readonly keyPromise;
+    private readonly filterBcConns;
+    private readonly docUpdateHandler;
+    private readonly awarenessUpdateHandler;
+    private readonly destroyHandler;
+    private runtimeLease;
+    private runtime;
+    private roomId;
+    private localNodeId;
+    private broadcastTransport;
+    private stopWatchingRoom;
+    private stopRuntimeConnections;
+    private stopRuntimeConnectionStates;
+    private readonly roomMembers;
+    private readonly openrtcConnections;
+    private readonly bcPeers;
+    private readonly pendingNodeIds;
+    private shouldConnect;
+    private destroyed;
+    private synced;
+    private localObserversAttached;
+    private connectPromise;
+    private reconcileTimer;
+    private runtimeRefreshTimer;
+    private readonly diagnostics;
+    constructor(roomName: string, doc: Y.Doc, options?: OpenrtcProviderOptions);
+    get connected(): boolean;
+    on<K extends EventName>(name: K, listener: EventListener<K>): EventListener<K>;
+    off<K extends EventName>(name: K, listener: EventListener<K>): void;
+    once<K extends EventName>(name: K, listener: EventListener<K>): void;
+    emit<K extends EventName>(name: K, payload: OpenrtcProviderEvents[K]): void;
+    connect(): void;
+    disconnect(): void;
+    destroy(): void;
+    diagnosticSnapshot(): typeof this.diagnostics;
+    private warnCompatibilityOptions;
+    private emitStatus;
+    private emitSynced;
+    private emitPeers;
+    private attachLocalObservers;
+    private detachLocalObservers;
+    private connectInternal;
+    private connectWithRetry;
+    private resolveRoomCandidates;
+    private joinFirstAvailableRoom;
+    private joinOrCreateRuntimeRoom;
+    private joinRoomAfterCreate;
+    private requestReconcile;
+    private replaceRoomMembers;
+    private reconcilePeers;
+    private hasBcNodeId;
+    private isRelevantConnection;
+    private refreshKnownRuntimeConnections;
+    private startRuntimeConnectionRefresh;
+    private resyncPeer;
+    private sendInitialSync;
+    private attachConnection;
+    private sendToConnection;
+    private sendControlToConnection;
+    private sendBroadcastPayload;
+    private broadcastProviderPayload;
+    private broadcastInitialBcState;
+    private handleIncomingPayload;
+    private updateSyncedState;
+    private disconnectOwnedResources;
+    private disconnectInternal;
+    private destroyInternal;
+}
+export {};