event names: use dashes instead of periods

src/Client.ts

@@ -12,7 +12,7 @@ import type {
   Message,
   PeerSocketMap,
   UserName,
-} from "./lib/types.js"
+} from "./types.js"
 
 const { version } = pkg
 const HEARTBEAT = pack({ type: "Heartbeat" })
@@ -36,7 +36,7 @@ export interface PeerEventPayload {
  * ```ts
  * client = new Client({ userName: 'my-peer-userName', url })
  *   .join('my-document-userName')
- *   .on('peer.connect', ({documentId, userName, socket}) => {
+ *   .on('peer-connect', ({documentId, userName, socket}) => {
  *     // send a message
  *     socket.send('Hello!')
  *
@@ -125,7 +125,7 @@ export class Client extends EventEmitter<ClientEvents> {
         this.retryDelay = this.minRetryDelay
         this.shouldReconnectIfClosed = true
         this.drainQueue()
-        this.emit("server.connect")
+        this.emit("server-connect")
         this.open = true
 
         this.heartbeat = setInterval(
@@ -159,7 +159,7 @@ export class Client extends EventEmitter<ClientEvents> {
 
             // add the socket to the map for this peer
             peer.set(documentId, peerConnection)
-            this.emit("peer.connect", {
+            this.emit("peer-connect", {
               userName,
               documentId,
               socket: peerConnection,
@@ -169,7 +169,7 @@ export class Client extends EventEmitter<ClientEvents> {
           // if the other end disconnects, we disconnect
           peerConnection.onclose = () => {
             this.closeSocket(userName, documentId)
-            this.emit("peer.disconnect", {
+            this.emit("peer-disconnect", {
               userName,
               documentId,
               socket: peerConnection,
@@ -183,7 +183,7 @@ export class Client extends EventEmitter<ClientEvents> {
 
       .on("close", () => {
         this.open = false
-        this.emit("server.disconnect")
+        this.emit("server-disconnect")
 
         // stop heartbeat
         clearInterval(this.heartbeat)

src/Server.ts

@@ -13,15 +13,9 @@ import {
   ConnectRequestParams,
   DocumentId,
   Message,
+  ServerEvents,
   UserName,
-} from "./lib/types.js"
-
-type ServerEvents = {
-  ready: () => void
-  close: () => void
-  error: (payload: { error: Error; data: Uint8Array }) => void
-  introduction: (userName: UserName) => void
-}
+} from "./types.js"
 
 /**
  * This server provides two services:

src/index.ts

@@ -1,4 +1,4 @@
 export { Server } from "./Server.js"
 export { Client } from "./Client.js"
 
-export { Message, DocumentId, UserName } from "./lib/types.js"
+export { Message, DocumentId, UserName } from "./types.js"

src/lib/deduplicate.ts

@@ -1,4 +1,4 @@
-import type { DocumentId } from "./types.js"
+import type { DocumentId } from "../types.js"
 
 export const deduplicate = (acc: DocumentId[], documentId: string) =>
   acc.includes(documentId) ? acc : acc.concat(documentId)

src/lib/intersection.ts

@@ -1,4 +1,4 @@
-import type { DocumentId } from "./types.js"
+import type { DocumentId } from "../types.js"
 
 export const intersection = (a: DocumentId[] = [], b: DocumentId[] = []) =>
   a.filter(documentId => b.includes(documentId))

src/test/Client.test.ts

@@ -3,7 +3,7 @@ import { describe, expect, it } from "vitest"
 import { Client } from "../Client.js"
 import { eventPromise } from "../lib/eventPromise.js"
 import { DocumentId, Server } from "../index.js"
-import { PeerEventPayload } from "../lib/types.js"
+import { PeerEventPayload } from "../types.js"
 import { pack, unpack } from "../lib/msgpack.js"
 import { WebSocket } from "isomorphic-ws"
 
@@ -60,33 +60,6 @@ it("both peers have the second document", async () => {
   await teardown()
 })
 
-// it("emits peer.connect only once per peer connection", async () => {
-//   // Alice and Bob both join a documentId
-//   const documentId = `some-other-test-documentId-${testId}`
-
-//   const { url, teardown } = await setup()
-//   let connections = 0
-//   const alice = new Client({ userName: `alice-${testId}`, url })
-
-//   alice.on("peer.connect", () => {
-//     connections++
-//     if (connections > 1) throw new Error(`peer connect emitted ${connections}x`)
-//   })
-//   const bob = new Client({ userName: `bob-${testId}`, url })
-
-//   bob.join(documentId)
-//   alice.join(documentId)
-//   alice.join(documentId)
-
-//   await allConnected(alice, bob)
-
-//   expect(alice.has(bob.userName, documentId)).toBe(true)
-//   expect(bob.has(alice.userName, documentId)).toBe(true)
-
-//   await pause(500)
-//   await teardown()
-// })
-
 it("leaves a documentId", async () => {
   // Alice and Bob both join a documentId
   const { alice, bob, documentId, teardown } = await setup()
@@ -204,7 +177,7 @@ it("closes when server disconnects", async () => {
   expect(bob.open).toBe(true)
 
   teardown()
-  await eventPromise(alice, "server.disconnect")
+  await eventPromise(alice, "server-disconnect")
   expect(alice.open).toBe(false)
 })
 
@@ -216,7 +189,7 @@ const allDisconnected = (a: Client, b: Client) =>
 
 const connection = (a: Client, b: Client, documentId?: DocumentId) =>
   new Promise<WebSocket>(resolve =>
-    a.on("peer.connect", ({ userName, documentId: d, socket }) => {
+    a.on("peer-connect", ({ userName, documentId: d, socket }) => {
       if (
         userName === b.userName &&
         // are we waiting to connect on a specific document ID?
@@ -228,7 +201,7 @@ const connection = (a: Client, b: Client, documentId?: DocumentId) =>
 
 const disconnection = (a: Client, b: Client) =>
   new Promise<void>(resolve =>
-    a.on("peer.disconnect", ({ userName = "" }) => {
+    a.on("peer-disconnect", ({ userName = "" }) => {
       if (userName === b.userName) resolve()
     })
   )

src/test/Server.test.ts

@@ -5,7 +5,7 @@ import { eventPromise } from "../lib/eventPromise.js"
 import { isReady } from "../lib/isReady.js"
 import { pack, unpack } from "../lib/msgpack.js"
 import { pause } from "../lib/pause.js"
-import type { Message } from "../lib/types.js"
+import type { Message } from "../types.js"
 
 // const log = debug('lf:relay:tests')
 

src/lib/types.ts → src/types.ts

@@ -38,11 +38,11 @@ export namespace Message {
 }
 
 export type ClientEvents = {
-  "server.connect": () => void
-  "server.disconnect": () => void
+  "server-connect": () => void
+  "server-disconnect": () => void
   error: (err: Error) => void
-  "peer.connect": (payload: PeerEventPayload) => void
-  "peer.disconnect": (payload: PeerEventPayload) => void
+  "peer-connect": (payload: PeerEventPayload) => void
+  "peer-disconnect": (payload: PeerEventPayload) => void
 }
 export interface PeerEventPayload {
   documentId: DocumentId
@@ -65,4 +65,11 @@ export interface ClientOptions {
   backoffFactor?: number
 }
 
+export type ServerEvents = {
+  ready: () => void
+  close: () => void
+  error: (payload: { error: Error; data: Uint8Array }) => void
+  introduction: (userName: UserName) => void
+}
+
 export type PeerSocketMap = Map<DocumentId, WebSocket | null>