y-openrtc 2.0.1 → 2.2.0

package/README.md

@@ -13,7 +13,7 @@ pnpm add y-openrtc yjs
 ```ts
 import * as Y from 'yjs';
 import { OpenRTC } from 'openrtc';
-import { OpenrtcProvider } from 'y-openrtc';
+import { YProvider } from 'y-openrtc';
 
 const rtc = OpenRTC({ apiKey: '<your public OpenRTC API key>' });
 const room = await rtc.rooms.join('my-room', {
@@ -21,7 +21,7 @@ const room = await rtc.rooms.join('my-room', {
   membership: 'ephemeral',
 });
 const doc = new Y.Doc();
-const provider = new OpenrtcProvider('my-room', doc, {
+const provider = new YProvider('my-room', doc, {
   room,
 });
 ```
@@ -31,7 +31,7 @@ const provider = new OpenrtcProvider('my-room', doc, {
 ```ts
 import * as Y from 'yjs';
 import { OpenRTC } from 'openrtc';
-import { OpenrtcProvider } from 'y-openrtc';
+import { YProvider } from 'y-openrtc';
 
 const room = await rtc.rooms.join('private-room', {
   access: 'authenticated',
@@ -39,7 +39,7 @@ const room = await rtc.rooms.join('private-room', {
 });
 
 const doc = new Y.Doc();
-const provider = new OpenrtcProvider('my-room', doc, {
+const provider = new YProvider('my-room', doc, {
   room,
 });
 ```
@@ -58,7 +58,7 @@ const rtc = OpenRTC({
   },
 });
 const room = await rtc.rooms.join('private-room', { access: 'capability' });
-const provider = new OpenrtcProvider('private-room', doc, { room });
+const provider = new YProvider('private-room', doc, { room });
 ```
 
 Keep TURN credentials server-generated and short lived. Do not commit `.env` files or long-lived secrets.
@@ -74,7 +74,7 @@ Keep TURN credentials server-generated and short lived. Do not commit `.env` fil
 
 ## Live test env
 
-The live test at `tests/OpenrtcProvider.live.test.ts` reads package-local env values.
+The live test at `tests/YProvider.live.test.ts` reads package-local env values.
 
 Create `openrtc/packages/y-openrtc/.env.local` with:
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { OpenrtcProvider, } from './provider.js';
-export { roomNameToOpenrtcRoomId } from './roomName.js';
-export type { OpenrtcProviderEvents, OpenrtcProviderOptions, OpenrtcTransports, PeersEventPayload, StatusEventPayload, SyncedEventPayload, } from './types.js';
+export { YProvider, } from './provider.js';
+export { roomIdFromName } from './roomName.js';
+export type { ProviderEvents, YProviderOptions, Transports, PeersEventPayload, StatusEventPayload, SyncedEventPayload, } from './types.js';
 export { runtimeFromRoom } from './roomRuntime.js';

package/dist/index.js

@@ -1,3 +1,3 @@
-export { OpenrtcProvider, } from './provider.js';
-export { roomNameToOpenrtcRoomId } from './roomName.js';
+export { YProvider, } from './provider.js';
+export { roomIdFromName } from './roomName.js';
 export { runtimeFromRoom } from './roomRuntime.js';

package/dist/provider.d.ts

@@ -1,9 +1,9 @@
 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 {
+import type { ProviderEvents, YProviderOptions } from './types.js';
+type EventName = keyof ProviderEvents;
+type EventListener<K extends EventName> = (payload: ProviderEvents[K]) => void;
+export declare class YProvider {
     readonly roomName: string;
     readonly doc: Y.Doc;
     readonly awareness: awarenessProtocol.Awareness;
@@ -35,12 +35,12 @@ export declare class OpenrtcProvider {
     private connectPromise;
     private reconcileTimer;
     private readonly diagnostics;
-    constructor(roomName: string, doc: Y.Doc, options?: OpenrtcProviderOptions);
+    constructor(roomName: string, doc: Y.Doc, options?: YProviderOptions);
     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;
+    emit<K extends EventName>(name: K, payload: ProviderEvents[K]): void;
     connect(): void;
     disconnect(): void;
     destroy(): void;

package/dist/provider.js

@@ -2,7 +2,7 @@ import * as awarenessProtocol from 'y-protocols/awareness';
 import { BroadcastMeshTransport } from './broadcast.js';
 import { applyProviderMessage, encodeAwarenessQuery, encodeAwarenessUpdate, encodeDocUpdate, encodeSyncStep1, encodeSyncStep2, } from './codec.js';
 import { decryptFrame, deriveRoomKey, encryptFrame } from './crypto.js';
-import { roomNameToOpenrtcRoomId } from './roomName.js';
+import { roomIdFromName } from './roomName.js';
 import { acquireRuntimeLease } from './runtimePool.js';
 const warnedCompatibilityOptions = new Set();
 function createProviderId() {
@@ -33,7 +33,7 @@ function hasActiveMember(member) {
     const lastSeenAt = member.lastSeenAt ?? member.joinedAt ?? 0;
     return now - lastSeenAt <= 5 * 60 * 1000;
 }
-function shouldInitiateConnection(localNodeId, remoteNodeId) {
+function shouldInitiate(localNodeId, remoteNodeId) {
     return localNodeId.localeCompare(remoteNodeId) < 0;
 }
 function normalizeOpenrtcRoomId(roomId) {
@@ -74,7 +74,7 @@ function isClosedConnectionSendError(error) {
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
-export class OpenrtcProvider {
+export class YProvider {
     constructor(roomName, doc, options = {}) {
         this.providerId = createProviderId();
         this.listeners = new Map();
@@ -273,7 +273,7 @@ export class OpenrtcProvider {
         }
         this.runtime = runtime;
         this.localNodeId = await runtime.getNodeId();
-        const preferredRoomId = normalizeOpenrtcRoomId(this.options.roomIdOverride ?? await roomNameToOpenrtcRoomId(this.roomName));
+        const preferredRoomId = normalizeOpenrtcRoomId(this.options.roomIdOverride ?? await roomIdFromName(this.roomName));
         const roomCandidates = this.resolveRoomCandidates(preferredRoomId);
         this.attachLocalObservers();
         this.stopRuntimeConnections = runtime.onConnection((connection) => {
@@ -282,8 +282,8 @@ export class OpenrtcProvider {
             }
             this.attachConnection(connection);
         });
-        if (typeof runtime.onConnectionStateChange === 'function') {
-            const stopRuntimeConnectionStates = runtime.onConnectionStateChange((state) => {
+        if (typeof runtime.onStateChange === 'function') {
+            const stopRuntimeConnectionStates = runtime.onStateChange((state) => {
                 if (!this.shouldConnect || state.state !== 'connected') {
                     return;
                 }
@@ -489,7 +489,7 @@ export class OpenrtcProvider {
             }
         }
         const connectableMembers = candidates.filter((member) => desiredNodeIds.has(member.nodeId) &&
-            shouldInitiateConnection(localNodeId, member.nodeId) &&
+            shouldInitiate(localNodeId, member.nodeId) &&
             !this.openrtcConnections.has(member.nodeId) &&
             !this.pendingNodeIds.has(member.nodeId));
         await Promise.allSettled(connectableMembers.map(async (member) => {

package/dist/roomName.d.ts

@@ -1 +1 @@
-export declare function roomNameToOpenrtcRoomId(roomName: string): Promise<string>;
+export declare function roomIdFromName(roomName: string): Promise<string>;

package/dist/roomName.js

@@ -24,7 +24,7 @@ async function sha256Hex(text) {
     const digest = await subtle.digest('SHA-256', encoder.encode(text));
     return toHex(new Uint8Array(digest));
 }
-export async function roomNameToOpenrtcRoomId(roomName) {
+export async function roomIdFromName(roomName) {
     const normalized = roomName.trim();
     if (!normalized) {
         throw new Error('roomName must be a non-empty string.');

package/dist/roomRuntime.d.ts

@@ -1,4 +1,4 @@
-import type { OpenRTCRoomHandle } from 'openrtc';
+import type { Room } from 'openrtc';
 import type { RuntimeClient } from 'openrtc/runtime';
 /** One-handle adapter; cast is isolated here so provider code cannot see legacy construction. */
-export declare function runtimeFromRoom(room: OpenRTCRoomHandle): RuntimeClient;
+export declare function runtimeFromRoom(room: Room): RuntimeClient;

package/dist/roomRuntime.js

@@ -55,7 +55,7 @@ export function runtimeFromRoom(room) {
             publish();
             return room.peers.watch(publish);
         },
-        onConnectionStateChange: room.diagnostics.onConnectionStateChange,
+        onStateChange: room.diagnostics.onStateChange,
         getConnections: connections,
         connectByTicket: ({ ticket, timeoutMs }) => room.peers.connect({ ticket, timeoutMs }),
     };

package/dist/runtimePool.d.ts

@@ -1,9 +1,9 @@
 import type { RuntimeClient } from 'openrtc/runtime';
-import type { OpenrtcProviderOptions } from './types.js';
+import type { YProviderOptions } from './types.js';
 export interface RuntimeLease {
     runtime: RuntimeClient;
     owned: boolean;
     ensureReady(): Promise<RuntimeClient>;
     release(): Promise<void>;
 }
-export declare function acquireRuntimeLease(options: OpenrtcProviderOptions): RuntimeLease;
+export declare function acquireRuntimeLease(options: YProviderOptions): RuntimeLease;

package/dist/types.d.ts

@@ -1,11 +1,11 @@
-import type { OpenRTCOptions, OpenRTCRoomHandle } from 'openrtc';
+import type { Options, Room } from 'openrtc';
 import type { RuntimeClient } from 'openrtc/runtime';
 import type { Awareness } from 'y-protocols/awareness';
-export type OpenrtcTransports = OpenRTCOptions['transports'];
-export interface OpenrtcProviderOptions {
+export type Transports = Options['transports'];
+export interface YProviderOptions {
     runtime?: RuntimeClient;
     /** Preferred 2.0 path: one already-activated collaborative room. */
-    room?: OpenRTCRoomHandle;
+    room?: Room;
     awareness?: Awareness;
     password?: string | null;
     maxConns?: number;
@@ -45,7 +45,7 @@ export interface PeersEventPayload {
      */
     awarenessPeers: number[];
 }
-export interface OpenrtcProviderEvents {
+export interface ProviderEvents {
     status: StatusEventPayload;
     synced: SyncedEventPayload;
     peers: PeersEventPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "y-openrtc",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "private": false,
   "type": "module",
   "sideEffects": false,
@@ -37,13 +37,13 @@
     "build": "rm -rf dist && tsc",
     "prepublishOnly": "pnpm run build",
     "test": "vitest run tests",
-    "test:deterministic": "vitest run tests/TetrisSync.test.ts tests/TetrisPeerDiagnostic.test.ts tests/OpenrtcProvider.test.ts tests/RoomRuntime.test.ts tests/PublicPackageGuard.test.ts tests/crypto.test.ts",
+    "test:deterministic": "vitest run tests/TetrisSync.test.ts tests/TetrisPeerDiagnostic.test.ts tests/YProvider.test.ts tests/RoomRuntime.test.ts tests/PublicPackageGuard.test.ts tests/crypto.test.ts",
     "test:watch": "vitest",
-    "test:live": "vitest run tests/OpenrtcProvider.live.test.ts"
+    "test:live": "vitest run tests/YProvider.live.test.ts"
   },
   "dependencies": {
     "lib0": "^0.2.114",
-    "openrtc": "^2.0.1",
+    "openrtc": "^2.2.0",
     "y-protocols": "^1.0.6"
   },
   "peerDependencies": {