angelia.io 4.0.87 → 4.0.89

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "angelia.io",
-	"version": "4.0.87",
+	"version": "4.0.89",
 	"description": "WebSockets Server and Client API for node.js and the browser, with rooms support.",
 	"author": "@titoBouzout @boredofnames",
 	"license": "GPL",
@@ -13,7 +13,8 @@
 		"./client": {
 			"types": "./types/client/index.js",
 			"default": "./client/index.js"
-		}
+		},
+		"./*": null
 	},
 	"dependencies": {
 		"bufferutil": "^4.0.8",

package/readme.md

@@ -213,8 +213,7 @@ As in `socket.on('connect', () => console.log('connect happened!'))`
    flag `persistent`
 4. a socket will leave automatically all rooms on disconnection
 5. `socket.rooms` is a set with all the rooms the socket joined
-6. a room list is an iterable that returns all of the sockets in the
-   room
+6. `id` is assigned to the room on creation
 
 ```js
 import { Room, Rooms } from 'angelia.io/server'
@@ -245,14 +244,14 @@ const games = new Rooms(GameRoom)
 
 class Connection {
 	connect(socket) {
-		game.join(socket, 'room id here')
-		socket.room.id === 'room id here'
+		games.join(socket, 'room id here')
+		socket.game.id === 'room id here'
 		console.log(socket.rooms)
-		game.leave(socket, 'room id here')
+		games.leave(socket, 'room id here')
 
-		game.join(socket, 'a different room')
-		socket.room.id === 'a different room'
-		game.leave(socket, 'a different room')
+		games.join(socket, 'a different room')
+		socket.game.id === 'a different room'
+		games.leave(socket, 'a different room')
 	}
 }
 
@@ -262,6 +261,8 @@ Server.listen()
 
 ### `Room` Class
 
+Iterating returns the sockets
+
 | signature                             | kind    | description                                      |
 | ------------------------------------- | ------- | ------------------------------------------------ |
 | `onCreate(socket)`                    | method  | dispatched when the room is created              |
@@ -272,11 +273,38 @@ Server.listen()
 | `connections`                         | number  | number of sockets in the room                    |
 | `sockets`                             | Set     | sockets in the room                              |
 | `emit(key, [value])`                  | method  | emits to all sockets in the room                 |
-| `once(key, [value])`                  | method  | emits once all sockets in the room               |
+| `once(key, [value])`                  | method  | emits once to all sockets in the room            |
 | `broadcast(socket, key, [value])`     | method  | emits to other sockets in the room               |
 | `broadcastOnce(socket, key, [value])` | method  | emits once to other sockets in the room          |
 | `id`                                  | any     | the room id                                      |
 
+### `Rooms` Class
+
+Iterating returns the rooms
+
+| signature                             | kind     | description                                   |
+| ------------------------------------- | -------- | --------------------------------------------- |
+| `get(id)`                             | method   | gets room with such an `id`                   |
+| `join(socket, [id])`                  | method   | adds socket to room `id`                      |
+| `leave(socket, [id])`                 | method   | removes socket from room `id`                 |
+| `connections`                         | number   | number of sockets in this room list           |
+| `sockets`                             | Iterator | sockets in this room list                     |
+| `emit(key, [value])`                  | method   | emits to all sockets in this room list        |
+| `once(key, [value])`                  | method   | emits once to all sockets in this room list   |
+| `broadcast(socket, key, [value])`     | method   | emits to other sockets in this room list      |
+| `broadcastOnce(socket, key, [value])` | method   | emits once to other sockets in this room list |
+| `map(fn)`                             | method   | returns mapped array                          |
+| `filter(fn)`                          | method   | returns mapped filtered array                 |
+
+### `sockets` Object
+
+Like `Set` but with two aditional methods
+
+| signature    | kind   | description                   |
+| ------------ | ------ | ----------------------------- |
+| `map(fn)`    | method | returns mapped array          |
+| `filter(fn)` | method | returns mapped filtered array |
+
 ## Authors
 
 - Tito Bouzout https://github.com/titoBouzout

package/server/Emitter.js

@@ -1,7 +1,9 @@
+import { MapeableSet } from './utils.js'
+
 export class Emitter {
 	constructor() {
-		/** @type Set<import('./Socket.js').Socket> */
-		this.sockets = new Set()
+		/** @type MapeableSet<import('./Socket.js').Socket> */
+		this.sockets = new MapeableSet()
 	}
 
 	get connections() {
@@ -20,6 +22,7 @@ export class Emitter {
 			socket.once(d)
 		}
 	}
+	/** @param me {import('./Socket.js').Socket} */
 	broadcast(me, k, v) {
 		const d = [k, v]
 		for (const socket of this.sockets) {
@@ -28,6 +31,7 @@ export class Emitter {
 			}
 		}
 	}
+	/** @param me {import('./Socket.js').Socket} */
 	broadcastOnce(me, k, v) {
 		const d = [k, v]
 		for (const socket of this.sockets) {

package/server/Room.js

@@ -6,11 +6,16 @@ export class Room extends Emitter {
 	id
 	persistent
 
+	/** @param socket {import('./Socket.js').Socket} */
 	onCreate(socket) {}
+	/** @param socket {import('./Socket.js').Socket} */
 	onDelete(socket) {}
+	/** @param socket {import('./Socket.js').Socket} */
 	onJoin(socket) {}
+	/** @param socket {import('./Socket.js').Socket} */
 	onLeave(socket) {}
 
+	/** @param socket {import('./Socket.js').Socket} */
 	[join](socket) {
 		this.sockets.add(socket)
 
@@ -18,6 +23,7 @@ export class Room extends Emitter {
 
 		this.onJoin(socket)
 	}
+	/** @param socket {import('./Socket.js').Socket} */
 	[leave](socket) {
 		this.sockets.delete(socket)
 

package/server/Rooms.js

@@ -1,34 +1,74 @@
-import { join, leave } from './constants.js'
+import { join, leave, parent } from './constants.js'
+import { Emitter } from './Emitter.js'
+import { arrayFrom } from './utils.js'
 
-export class Rooms {
-	constructor(Room) {
-		this.Room = Room
+export class Rooms extends Emitter {
+	/** @param {Object} RoomClass */
+	constructor(RoomClass) {
+		super()
+
+		this.RoomClass = RoomClass
 		this.rooms = new Map()
+
+		Object.defineProperty(this, 'sockets', {
+			get: this.Sockets.bind(this),
+			enumerable: true,
+		})
 	}
+
+	get(id) {
+		return this.rooms.get(id)
+	}
+
 	join(socket, id = undefined) {
 		let room = this.rooms.get(id)
 		if (!room) {
-			room = new this.Room()
-			room.id = room.id || id
+			room = new this.RoomClass()
+			room[parent] = this
+			room.id = id
 			this.rooms.set(id, room)
 
 			room.onCreate(socket)
 		}
-
 		room[join](socket)
 	}
+
 	leave(socket, id = undefined) {
 		const room = this.rooms.get(id)
 		if (room) {
 			room[leave](socket)
-
-			if (!room.persistent && room.size === 0) {
-				room.onDelete(socket)
+			if (!room.persistent && room.sockets.size === 0) {
 				this.rooms.delete(id)
+				room.onDelete(socket)
 			}
 		}
 	}
 
+	get connections() {
+		let count = 0
+		for (const room of this.rooms.values()) {
+			count += room.sockets.size
+		}
+		return count
+	}
+
+	*Sockets() {
+		for (const room of this.rooms.values()) {
+			for (const socket of room.sockets) {
+				yield socket
+			}
+		}
+	}
+
+	map(fn) {
+		return arrayFrom(this.rooms.values(), fn)
+	}
+	filter(fn) {
+		return this.map().filter(fn)
+	}
+	toJSON() {
+		return this.map()
+	}
 	[Symbol.iterator]() {
 		return this.rooms.values()
 	}

package/server/Server.js

@@ -158,7 +158,7 @@ export default new (class Server extends Emitter {
 	on(listener) {
 		const instance = new listener()
 
-		const methods = [
+		const methods = listener.listeners || [
 			// todo maybe use getPrototypeOf ?
 			...Object.getOwnPropertyNames(instance.__proto__),
 			...Object.getOwnPropertyNames(instance),
@@ -175,6 +175,8 @@ export default new (class Server extends Emitter {
 				}
 			}
 		}
+
+		return instance
 	}
 
 	// private

package/server/Socket.js

@@ -1,6 +1,12 @@
-import { leave } from './constants.js'
+import { parent } from './constants.js'
 
-import { fromEntries, inspect, isArray, parse } from './utils.js'
+import {
+	fromEntries,
+	inspect,
+	isArray,
+	MapeableSet,
+	parse,
+} from './utils.js'
 
 export class Socket {
 	constructor(socket, server, request) {
@@ -34,7 +40,7 @@ export class Socket {
 		this.ping = 0
 		this.timedout = false
 
-		this.rooms = new Set()
+		this.rooms = new MapeableSet()
 	}
 	emit(k, v, cb) {
 		if (!this.messages.length) {
@@ -91,7 +97,7 @@ export class Socket {
 		this.server.sockets.delete(this)
 
 		for (const room of this.rooms) {
-			room[leave](this)
+			room[parent].leave(this, room.id)
 		}
 
 		this.server.events.disconnect &&
@@ -155,7 +161,7 @@ export class Socket {
 						this.server.events[m[0]](
 							this,
 							m[1],
-							m[2] && this.doreply.bind(null, m[2]),
+							m[2] && this.doreply.bind(this, m[2]),
 						)
 					} else {
 						this.server.messagesGarbage++

package/server/constants.js

@@ -1,2 +1,3 @@
 export const join = Symbol('join')
 export const leave = Symbol('leave')
+export const parent = Symbol('parent')

package/server/utils.js

@@ -1,5 +1,3 @@
-// utils
-
 export const empty = () => Object.create(null)
 
 export const now = Date.now
@@ -16,6 +14,8 @@ export const isArray = Array.isArray
 
 export const fromEntries = Object.fromEntries
 
+export const arrayFrom = Array.from
+
 export function ListenerTemplate() {
 	const fns = []
 	function Listener(...args) {
@@ -45,3 +45,12 @@ export const frame = function (
 	opcode: 1,
 	fin: true,
 })
+
+export class MapeableSet extends Set {
+	map(fn) {
+		return arrayFrom(this, fn)
+	}
+	filter(fn) {
+		return this.map().filter(fn)
+	}
+}

package/types/server/Emitter.d.ts

@@ -1,9 +1,12 @@
 export class Emitter {
-    /** @type Set<import('./Socket.js').Socket> */
-    sockets: Set<import("./Socket.js").Socket>;
-    get connections(): number;
+    /** @type MapeableSet<import('./Socket.js').Socket> */
+    sockets: MapeableSet<import("./Socket.js").Socket>;
+    get connections(): any;
     emit(k: any, v: any): void;
     once(k: any, v: any): void;
-    broadcast(me: any, k: any, v: any): void;
-    broadcastOnce(me: any, k: any, v: any): void;
+    /** @param me {import('./Socket.js').Socket} */
+    broadcast(me: import("./Socket.js").Socket, k: any, v: any): void;
+    /** @param me {import('./Socket.js').Socket} */
+    broadcastOnce(me: import("./Socket.js").Socket, k: any, v: any): void;
 }
+import { MapeableSet } from './utils.js';

package/types/server/Room.d.ts

@@ -1,13 +1,19 @@
 export class Room extends Emitter {
     id: any;
     persistent: any;
-    onCreate(socket: any): void;
-    onDelete(socket: any): void;
-    onJoin(socket: any): void;
-    onLeave(socket: any): void;
-    [join](socket: any): void;
-    [leave](socket: any): void;
-    [Symbol.iterator](): Set<import("./Socket.js").Socket>;
+    /** @param socket {import('./Socket.js').Socket} */
+    onCreate(socket: import("./Socket.js").Socket): void;
+    /** @param socket {import('./Socket.js').Socket} */
+    onDelete(socket: import("./Socket.js").Socket): void;
+    /** @param socket {import('./Socket.js').Socket} */
+    onJoin(socket: import("./Socket.js").Socket): void;
+    /** @param socket {import('./Socket.js').Socket} */
+    onLeave(socket: import("./Socket.js").Socket): void;
+    /** @param socket {import('./Socket.js').Socket} */
+    [join](socket: import("./Socket.js").Socket): void;
+    /** @param socket {import('./Socket.js').Socket} */
+    [leave](socket: import("./Socket.js").Socket): void;
+    [Symbol.iterator](): any;
 }
 import { Emitter } from './Emitter.js';
 import { join } from './constants.js';

package/types/server/Rooms.d.ts

@@ -1,8 +1,15 @@
-export class Rooms {
-    constructor(Room: any);
-    Room: any;
+export class Rooms extends Emitter {
+    /** @param {Object} RoomClass */
+    constructor(RoomClass: any);
+    RoomClass: any;
     rooms: Map<any, any>;
+    get(id: any): any;
     join(socket: any, id?: undefined): void;
     leave(socket: any, id?: undefined): void;
+    Sockets(): Generator<any, void, unknown>;
+    map(fn: any): any[];
+    filter(fn: any): any[];
+    toJSON(): any[];
     [Symbol.iterator](): MapIterator<any>;
 }
+import { Emitter } from './Emitter.js';

package/types/server/Server.d.ts

@@ -49,7 +49,7 @@ declare const _default: {
      * @template T
      * @param {T} listener
      */
-    on<T>(listener: T): void;
+    on<T>(listener: T): any;
     onconnect: (socket: any, request: any) => void;
     onerror: (err: any) => void;
     nextQueue(socket: any): void;
@@ -63,12 +63,12 @@ declare const _default: {
     [inspect](): any & {
         sockets: string;
     };
-    sockets: Set<import("./Socket.js").Socket>;
-    readonly connections: number;
+    sockets: import("./utils.js").MapeableSet<import("./Socket.js").Socket>;
+    readonly connections: any;
     emit(k: any, v: any): void;
     once(k: any, v: any): void;
-    broadcast(me: any, k: any, v: any): void;
-    broadcastOnce(me: any, k: any, v: any): void;
+    broadcast(me: import("./Socket.js").Socket, k: any, v: any): void;
+    broadcastOnce(me: import("./Socket.js").Socket, k: any, v: any): void;
 };
 export default _default;
 import { inspect } from './utils.js';

package/types/server/Socket.d.ts

@@ -20,7 +20,7 @@ export class Socket {
     contacted: any;
     ping: number;
     timedout: boolean;
-    rooms: Set<any>;
+    rooms: MapeableSet;
     emit(k: any, v: any, cb: any): void;
     once(k: any, v: any): void;
     disconnect(noReconnect: any): void;
@@ -44,4 +44,5 @@ export class Socket {
         readyState: any;
     };
 }
+import { MapeableSet } from './utils.js';
 import { inspect } from './utils.js';

package/types/server/constants.d.ts

@@ -1,2 +1,3 @@
 export const join: unique symbol;
 export const leave: unique symbol;
+export const parent: unique symbol;

package/types/server/utils.d.ts

@@ -23,4 +23,16 @@ export const fromEntries: {
     };
     (entries: Iterable<readonly any[]>): any;
 };
+export const arrayFrom: {
+    <T>(arrayLike: ArrayLike<T>): T[];
+    <T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
+    <T>(iterable: Iterable<T> | ArrayLike<T>): T[];
+    <T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
+};
 export const frame: (data?: any) => any;
+export class MapeableSet extends Set<any> {
+    constructor(values?: readonly any[] | null | undefined);
+    constructor(iterable?: Iterable<any> | null | undefined);
+    map(fn: any): any[];
+    filter(fn: any): any[];
+}