@socket-mesh/server 18.0.5 → 18.1.0

package/README.md

@@ -1,7 +1,7 @@
-# SocketCluster server
-Minimal server module for SocketCluster.
+# SocketMesh server
+Minimal server module for SocketMesh.
 
-This is a stand-alone server module for SocketCluster.
+This is a stand-alone server module for SocketMesh.
 SocketCluster's protocol is backwards compatible with the SocketCluster protocol.
 
 ## Setting up
@@ -82,16 +82,16 @@ let agServer = socketClusterServer.attach(httpServer, {
 - **More readable**: Code is written sequentially from top to bottom. It avoids event handler callback hell. It's also much easier to write and read complex integration test scenarios.
 - **More succinct**: Event streams can be easily chained, filtered and combined using a declarative syntax (e.g. using async generators).
 - **More manageable**: No need to remember to unbind listeners with `removeListener(...)`; just `break` out of the `for-await-of` loop to stop consuming. This also encourages a more declarative style of coding which reduces the likelihood of memory leaks and unintended side effects.
-- **Less error-prone**: Each event/RPC/message can be processed sequentially in the same order that they were sent without missing any data; even if asynchronous calls are made inside middleware or listeners. On the other hand, with `EventEmitter`, the listener function for the same event cannot be prevented from running multiple times in parallel; also, asynchronous calls within middleware and listeners can affect the final order of actions; all this can cause unintended side effects.
+- **Less error-prone**: Each event/RPC/message can be processed sequentially in the same order that they were sent without missing any data; even if asynchronous calls are made inside plugin or listeners. On the other hand, with `EventEmitter`, the listener function for the same event cannot be prevented from running multiple times in parallel; also, asynchronous calls within plugin and listeners can affect the final order of actions; all this can cause unintended side effects.
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2013-2023 SocketCluster.io
+Copyright (c) 2013-2024 SocketMesh.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/broker/broker-events.d.ts

@@ -0,0 +1,16 @@
+export type BrokerEvent<T> = ErrorEvent | PublishEvent<T> | ReadyEvent | SubscribeEvent | UnsubscribeEvent;
+export interface ErrorEvent {
+    error: Error;
+}
+export interface ReadyEvent {
+}
+export interface SubscribeEvent {
+    channel: string;
+}
+export interface UnsubscribeEvent {
+    channel: string;
+}
+export interface PublishEvent<T> {
+    channel: string;
+    data: T;
+}

package/dist/broker/broker.d.ts

@@ -0,0 +1,28 @@
+import { AsyncStreamEmitter } from "@socket-mesh/async-stream-emitter";
+import { DemuxedConsumableStream, StreamEvent } from "@socket-mesh/stream-demux";
+import { BrokerEvent, ErrorEvent, PublishEvent, ReadyEvent, SubscribeEvent, UnsubscribeEvent } from "./broker-events.js";
+import { ChannelMap } from "@socket-mesh/channels";
+import { Exchange } from "./exchange.js";
+import { ExchangeClient } from "./exchange-client.js";
+export declare abstract class Broker<T extends ChannelMap> extends AsyncStreamEmitter<BrokerEvent<T[keyof T]>> {
+    isReady: boolean;
+    constructor();
+    emit(event: 'error', data: ErrorEvent): void;
+    emit(event: 'publish', data: PublishEvent<T[keyof T]>): void;
+    emit(event: 'ready', data: ReadyEvent): void;
+    emit(event: 'subscribe', data: SubscribeEvent): void;
+    emit(event: 'unsubscribe', data: UnsubscribeEvent): void;
+    listen(): DemuxedConsumableStream<StreamEvent<BrokerEvent<T[keyof T]>>>;
+    listen(event: 'ready'): DemuxedConsumableStream<ReadyEvent>;
+    listen(event: 'publish'): DemuxedConsumableStream<PublishEvent<T[keyof T]>>;
+    listen(event: 'error'): DemuxedConsumableStream<ErrorEvent>;
+    listen(event: 'subscribe'): DemuxedConsumableStream<SubscribeEvent>;
+    listen(event: 'unsubscribe'): DemuxedConsumableStream<UnsubscribeEvent>;
+    abstract readonly exchange: Exchange<T>;
+    abstract subscribe(socket: ExchangeClient, channelName: string): Promise<void>;
+    abstract subscriptions(): string[];
+    abstract isSubscribed(channelName: string): boolean;
+    abstract unsubscribe(socket: ExchangeClient, channelName: string): Promise<void>;
+    abstract transmitPublish<U extends keyof T & string>(channelName: U, data: T[U], suppressEvent?: boolean): Promise<void>;
+    abstract invokePublish<U extends keyof T & string>(channelName: U, data: T[U], suppressEvent?: boolean): Promise<void>;
+}

package/dist/broker/broker.js

@@ -0,0 +1,17 @@
+import { AsyncStreamEmitter } from "@socket-mesh/async-stream-emitter";
+export class Broker extends AsyncStreamEmitter {
+    constructor() {
+        super();
+        this.isReady = false;
+        setTimeout(() => {
+            this.isReady = true;
+            this.emit('ready', {});
+        }, 0);
+    }
+    emit(event, data) {
+        super.emit(event, data);
+    }
+    listen(event) {
+        return super.listen(event);
+    }
+}

package/dist/broker/exchange-client.d.ts

@@ -0,0 +1,5 @@
+import { PublishOptions } from "@socket-mesh/channels";
+export interface ExchangeClient {
+    id: string;
+    transmit(event: '#publish', options: PublishOptions): Promise<void>;
+}

package/dist/broker/exchange.d.ts

@@ -0,0 +1,4 @@
+import { ChannelMap, Channels } from "@socket-mesh/channels";
+export declare abstract class Exchange<T extends ChannelMap> extends Channels<T> {
+    id: string;
+}

package/dist/broker/exchange.js

@@ -0,0 +1,3 @@
+import { Channels } from "@socket-mesh/channels";
+export class Exchange extends Channels {
+}

package/dist/broker/simple-broker.d.ts

@@ -0,0 +1,16 @@
+import { Broker } from "./broker.js";
+import { ChannelMap } from "@socket-mesh/channels";
+import { SimpleExchange } from "./simple-exchange.js";
+import { ExchangeClient } from "./exchange-client.js";
+export declare class SimpleBroker<T extends ChannelMap> extends Broker<T> {
+    readonly exchange: SimpleExchange<T>;
+    private readonly _clientSubscribers;
+    private readonly _clientSubscribersCounter;
+    constructor();
+    subscribe(client: ExchangeClient, channelName: string): Promise<void>;
+    unsubscribe(client: ExchangeClient, channelName: string): Promise<void>;
+    subscriptions(): string[];
+    isSubscribed(channelName: string): boolean;
+    invokePublish<U extends keyof T & string>(channelName: U, data: T[U], suppressEvent?: boolean): Promise<void>;
+    transmitPublish<U extends keyof T & string>(channelName: U, data: T[U], suppressEvent?: boolean): Promise<void>;
+}

package/dist/broker/simple-broker.js

@@ -0,0 +1,65 @@
+import { Broker } from "./broker.js";
+import { SimpleExchange } from "./simple-exchange.js";
+export class SimpleBroker extends Broker {
+    constructor() {
+        super();
+        this.exchange = new SimpleExchange(this);
+        this._clientSubscribers = {};
+        this._clientSubscribersCounter = {};
+    }
+    async subscribe(client, channelName) {
+        if (!this._clientSubscribers[channelName]) {
+            this._clientSubscribers[channelName] = {};
+            this._clientSubscribersCounter[channelName] = 0;
+            this.emit('subscribe', { channel: channelName });
+        }
+        if (!this._clientSubscribers[channelName][client.id]) {
+            this._clientSubscribersCounter[channelName]++;
+        }
+        this._clientSubscribers[channelName][client.id] = client;
+    }
+    async unsubscribe(client, channelName) {
+        if (this._clientSubscribers[channelName]) {
+            if (this._clientSubscribers[channelName][client.id]) {
+                this._clientSubscribersCounter[channelName]--;
+                delete this._clientSubscribers[channelName][client.id];
+                if (this._clientSubscribersCounter[channelName] <= 0) {
+                    delete this._clientSubscribers[channelName];
+                    delete this._clientSubscribersCounter[channelName];
+                    this.emit('unsubscribe', { channel: channelName });
+                }
+            }
+        }
+    }
+    subscriptions() {
+        return Object.keys(this._clientSubscribers);
+    }
+    isSubscribed(channelName) {
+        return !!this._clientSubscribers[channelName];
+    }
+    // In this implementation of the broker engine, both invokePublish and transmitPublish
+    // methods are the same. In alternative implementations, they could be different.
+    invokePublish(channelName, data, suppressEvent) {
+        return this.transmitPublish(channelName, data, suppressEvent);
+    }
+    async transmitPublish(channelName, data, suppressEvent) {
+        const packet = {
+            channel: channelName,
+            data
+        };
+        const subscriberClients = this._clientSubscribers[channelName] || {};
+        const work = [];
+        for (const i in subscriberClients) {
+            work.push(subscriberClients[i].transmit('#publish', packet));
+        }
+        const result = await Promise.allSettled(work);
+        for (const item of result) {
+            if (item.status === 'rejected') {
+                this.emit('error', item.reason);
+            }
+        }
+        if (!suppressEvent) {
+            this.emit('publish', packet);
+        }
+    }
+}

package/dist/broker/simple-exchange.d.ts

@@ -0,0 +1,13 @@
+import { ChannelDetails, ChannelMap, ChannelsOptions, PublishOptions } from "@socket-mesh/channels";
+import { Broker } from "./broker.js";
+import { Exchange } from "./exchange.js";
+export declare class SimpleExchange<T extends ChannelMap> extends Exchange<T> {
+    readonly id: string;
+    private readonly _broker;
+    constructor(broker: Broker<T>, options?: ChannelsOptions);
+    protected trySubscribe(channel: ChannelDetails): Promise<void>;
+    protected tryUnsubscribe(channel: ChannelDetails): Promise<void>;
+    transmit(event: '#publish', packet: PublishOptions): Promise<void>;
+    transmitPublish<U extends keyof T & string>(channelName: U, data: T[U]): Promise<void>;
+    invokePublish<U extends keyof T & string>(channelName: U, data: T[U]): Promise<void>;
+}

package/dist/broker/simple-exchange.js

@@ -0,0 +1,33 @@
+import { Exchange } from "./exchange.js";
+export class SimpleExchange extends Exchange {
+    constructor(broker, options) {
+        super(options);
+        this.id = 'exchange';
+        this._broker = broker;
+    }
+    async trySubscribe(channel) {
+        channel.state = 'subscribed';
+        this._channelEventDemux.write(`${channel.name}/subscribe`, { channel: channel.name });
+        this._broker.subscribe(this, channel.name);
+        this.emit('subscribe', { channel: channel.name, options: channel.options });
+    }
+    async tryUnsubscribe(channel) {
+        delete this._channelMap[channel.name];
+        if (channel.state === 'subscribed') {
+            this._channelEventDemux.write(`${channel.name}/unsubscribe`, { channel: channel.name });
+            await this._broker.unsubscribe(this, channel.name);
+            this.emit('unsubscribe', { channel: channel.name });
+        }
+    }
+    async transmit(event, packet) {
+        if (event === '#publish') {
+            this._channelDataDemux.write(packet.channel, packet.data);
+        }
+    }
+    async transmitPublish(channelName, data) {
+        await this._broker.transmitPublish(channelName, data);
+    }
+    async invokePublish(channelName, data) {
+        await this._broker.invokePublish(channelName, data);
+    }
+}

package/dist/handlers/authenticate.d.ts

@@ -0,0 +1,20 @@
+import { RequestHandlerArgs, SocketTransport } from "@socket-mesh/core";
+import jwt from "jsonwebtoken";
+import { AuthTokenError } from "@socket-mesh/errors";
+import { AuthEngine } from "@socket-mesh/auth-engine";
+import { AuthToken, SignedAuthToken } from "@socket-mesh/auth";
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { ServerSocket } from "../server-socket.js";
+import { BasicServerMap } from "../maps/server-map.js";
+export type AuthInfo = ValidAuthInfo | InvalidAuthInfo;
+export interface InvalidAuthInfo {
+    signedAuthToken: SignedAuthToken;
+    authError: AuthTokenError;
+}
+export interface ValidAuthInfo {
+    signedAuthToken: SignedAuthToken;
+    authToken: AuthToken;
+}
+export declare function authenticateHandler({ isRpc, options: signedAuthToken, socket, transport }: RequestHandlerArgs<string, BasicSocketMapServer, ServerSocket<BasicServerMap>>): Promise<void>;
+export declare function validateAuthToken(auth: AuthEngine, authToken: SignedAuthToken, verificationOptions?: jwt.VerifyOptions): Promise<AuthInfo>;
+export declare function processAuthentication(socket: ServerSocket<BasicServerMap>, transport: SocketTransport<BasicSocketMapServer>, authInfo: AuthInfo): Promise<boolean>;

package/dist/handlers/authenticate.js

@@ -0,0 +1,67 @@
+import { AuthTokenError, AuthTokenExpiredError, AuthTokenInvalidError, AuthTokenNotBeforeError, InvalidActionError } from "@socket-mesh/errors";
+const HANDSHAKE_REJECTION_STATUS_CODE = 4008;
+;
+export async function authenticateHandler({ isRpc, options: signedAuthToken, socket, transport }) {
+    if (!isRpc) {
+        socket.disconnect(HANDSHAKE_REJECTION_STATUS_CODE);
+        throw new InvalidActionError('Handshake request was malformatted');
+    }
+    const authInfo = await validateAuthToken(socket.server.auth, signedAuthToken);
+    await processAuthentication(socket, transport, authInfo);
+}
+export async function validateAuthToken(auth, authToken, verificationOptions) {
+    try {
+        return {
+            signedAuthToken: authToken,
+            authToken: await auth.verifyToken(authToken, verificationOptions)
+        };
+    }
+    catch (error) {
+        return {
+            signedAuthToken: authToken,
+            authError: processTokenError(error)
+        };
+    }
+}
+function processTokenError(err) {
+    if (err.name === 'TokenExpiredError' && 'expiredAt' in err) {
+        return new AuthTokenExpiredError(err.message, err.expiredAt);
+    }
+    if (err.name === 'JsonWebTokenError') {
+        return new AuthTokenInvalidError(err.message);
+    }
+    if (err.name === 'NotBeforeError' && 'date' in err) {
+        // In this case, the token is good; it's just not active yet.
+        return new AuthTokenNotBeforeError(err.message, err.date);
+    }
+    return new AuthTokenError(err.message);
+}
+export async function processAuthentication(socket, transport, authInfo) {
+    if ('authError' in authInfo) {
+        await transport.changeToUnauthenticatedState();
+        // If the error is related to the JWT being badly formatted, then we will
+        // treat the error as a socket error.
+        if (authInfo.signedAuthToken != null) {
+            transport.onError(authInfo.authError);
+            if (authInfo.authError instanceof AuthTokenError) {
+                socket.emit('badAuthToken', { error: authInfo.authError, signedAuthToken: authInfo.signedAuthToken });
+            }
+        }
+        throw authInfo.authError;
+    }
+    for (const plugin of socket.server.plugins) {
+        if (plugin.onAuthenticate) {
+            try {
+                plugin.onAuthenticate(authInfo);
+            }
+            catch (err) {
+                await transport.changeToUnauthenticatedState();
+                if (err instanceof AuthTokenError) {
+                    socket.emit('badAuthToken', { error: err, signedAuthToken: authInfo.signedAuthToken });
+                }
+                throw err;
+            }
+        }
+    }
+    return await transport.setAuthorization(authInfo.signedAuthToken, authInfo.authToken);
+}

package/dist/handlers/handshake.d.ts

@@ -0,0 +1,7 @@
+import { HandshakeOptions, HandshakeStatus } from "@socket-mesh/client";
+import { RequestHandlerArgs } from "@socket-mesh/core";
+import { BasicServerMap } from "../maps/server-map.js";
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { ServerSocket } from "../server-socket.js";
+import { ServerTransport } from "../server-transport.js";
+export declare function handshakeHandler({ options, socket, transport }: RequestHandlerArgs<HandshakeOptions, BasicSocketMapServer, ServerSocket<BasicServerMap>, ServerTransport<BasicServerMap>>): Promise<HandshakeStatus>;

package/dist/handlers/handshake.js

@@ -0,0 +1,61 @@
+import { wait } from "@socket-mesh/core";
+import { processAuthentication, validateAuthToken } from "./authenticate.js";
+import { dehydrateError } from "@socket-mesh/errors";
+const HANDSHAKE_REJECTION_STATUS_CODE = 4008;
+export async function handshakeHandler({ options, socket, transport }) {
+    const server = socket.server;
+    const wasAuthenticated = !!transport.signedAuthToken;
+    const authInfo = await validateAuthToken(server.auth, options.authToken);
+    for (const plugin of server.plugins) {
+        if (plugin.onHandshake) {
+            try {
+                await plugin.onHandshake({
+                    socket,
+                    transport,
+                    authInfo: 'authError' in authInfo ?
+                        { signedAuthToken: options.authToken, authError: authInfo.authError } :
+                        { signedAuthToken: options.authToken, authToken: authInfo.authToken }
+                });
+            }
+            catch (err) {
+                if (err.statusCode == null) {
+                    err.statusCode = HANDSHAKE_REJECTION_STATUS_CODE;
+                }
+                throw err;
+            }
+        }
+    }
+    let authError = undefined;
+    let changed;
+    try {
+        changed = await processAuthentication(socket, transport, authInfo);
+        if (socket.status === 'closed') {
+            return;
+        }
+    }
+    catch (err) {
+        if (options.authToken) {
+            // Because the token is optional as part of the handshake, we don't count
+            // it as an error if the token wasn't provided.
+            authError = dehydrateError(err);
+        }
+    }
+    transport.setReadyStatus(server.pingTimeoutMs, authError);
+    // Needs to be executed after the connection event to allow consumers to be setup.
+    await wait(0);
+    if (changed) {
+        transport.triggerAuthenticationEvents(false, wasAuthenticated);
+    }
+    if (authError) {
+        return {
+            id: socket.id,
+            pingTimeoutMs: server.pingTimeoutMs,
+            authError
+        };
+    }
+    return {
+        id: socket.id,
+        pingTimeoutMs: server.pingTimeoutMs,
+        authToken: options.authToken
+    };
+}

package/dist/handlers/publish.d.ts

@@ -0,0 +1,9 @@
+import { RequestHandlerArgs } from "@socket-mesh/core";
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { PublishOptions } from "@socket-mesh/channels";
+import { ServerSocket } from "../server-socket.js";
+import { BasicServerMap } from "../maps/server-map.js";
+import { ServerTransport } from "../server-transport.js";
+export declare function publishHandler({ socket, transport, options }: RequestHandlerArgs<PublishOptions, BasicSocketMapServer<{}, {
+    [channel: string]: any;
+}>, ServerSocket<BasicServerMap>, ServerTransport<BasicServerMap>>): Promise<void>;

package/dist/handlers/publish.js

@@ -0,0 +1,21 @@
+import { InvalidActionError } from "@socket-mesh/errors";
+export async function publishHandler({ socket, transport, options }) {
+    if (!socket.server.allowClientPublish) {
+        throw new InvalidActionError('Client publish feature is disabled');
+    }
+    if (typeof options.channel !== 'string' || !options.data) {
+        throw new InvalidActionError('Publish channel name was malformatted');
+    }
+    let data = options.data;
+    for (const plugin of socket.server.plugins) {
+        if (plugin.onPublishIn) {
+            data = await plugin.onPublishIn({
+                channel: options.channel,
+                data,
+                socket,
+                transport
+            });
+        }
+    }
+    await socket.server.exchange.invokePublish(options.channel, data);
+}

package/dist/handlers/remove-auth-token.d.ts

@@ -0,0 +1,3 @@
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { SocketTransport } from "@socket-mesh/core";
+export declare function deauthenticate(transport: SocketTransport<BasicSocketMapServer>): Promise<boolean>;

package/dist/handlers/remove-auth-token.js

@@ -0,0 +1,7 @@
+export async function deauthenticate(transport) {
+    if (await transport.changeToUnauthenticatedState()) {
+        await transport.transmit('#removeAuthToken');
+        return true;
+    }
+    return false;
+}

package/dist/handlers/subscribe.d.ts

@@ -0,0 +1,7 @@
+import { BasicServerMap } from "../maps/server-map.js";
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { SubscribeOptions } from "@socket-mesh/client";
+import { RequestHandlerArgs } from "@socket-mesh/core";
+import { ServerSocket } from "../server-socket.js";
+import { ServerTransport } from "../server-transport.js";
+export declare function subscribeHandler({ socket, transport, options }: RequestHandlerArgs<SubscribeOptions, BasicSocketMapServer, ServerSocket<BasicServerMap>, ServerTransport<BasicServerMap>>): Promise<void>;

package/dist/handlers/subscribe.js

@@ -0,0 +1,43 @@
+import { BrokerError, InvalidActionError } from "@socket-mesh/errors";
+export async function subscribeHandler({ socket, transport, options }) {
+    if (socket.status !== 'ready') {
+        // This is an invalid state; it means the client tried to subscribe before
+        // having completed the handshake.
+        throw new InvalidActionError('Cannot subscribe socket to a channel before it has completed the handshake');
+    }
+    const state = socket.state;
+    const server = socket.server;
+    if (server.socketChannelLimit && state.channelSubscriptionsCount >= server.socketChannelLimit) {
+        throw new InvalidActionError(`Socket ${socket.id} tried to exceed the channel subscription limit of ${server.socketChannelLimit}`);
+    }
+    const { channel, ...channelOptions } = options;
+    for (const plugin of socket.server.plugins) {
+        if (plugin.onSubscribe) {
+            await plugin.onSubscribe({ channel, options, socket, transport });
+        }
+    }
+    try {
+        if (state.channelSubscriptions == null) {
+            state.channelSubscriptions = {};
+        }
+        if (state.channelSubscriptionsCount == null) {
+            state.channelSubscriptionsCount = 0;
+        }
+        if (state.channelSubscriptions[channel] == null) {
+            state.channelSubscriptions[channel] = true;
+            state.channelSubscriptionsCount++;
+        }
+        try {
+            await server.brokerEngine.subscribe(transport, channel);
+        }
+        catch (error) {
+            delete state.channelSubscriptions[channel];
+            state.channelSubscriptionsCount--;
+            throw error;
+        }
+        server.exchange.emit('subscribe', { channel, options: channelOptions });
+    }
+    catch (err) {
+        throw new BrokerError(`Failed to subscribe socket to the ${options.channel} channel - ${err}`);
+    }
+}

package/dist/handlers/unsubscribe.d.ts

@@ -0,0 +1,6 @@
+import { RequestHandlerArgs } from "@socket-mesh/core";
+import { BasicSocketMapServer } from "../maps/socket-map.js";
+import { ServerSocket } from "../server-socket.js";
+import { BasicServerMap } from "../maps/server-map.js";
+import { ServerTransport } from "../server-transport.js";
+export declare function unsubscribeHandler({ transport, options: channel }: RequestHandlerArgs<string, BasicSocketMapServer, ServerSocket<BasicServerMap>, ServerTransport<BasicServerMap>>): Promise<void>;

package/dist/handlers/unsubscribe.js

@@ -0,0 +1,9 @@
+import { BrokerError } from "@socket-mesh/errors";
+export async function unsubscribeHandler({ transport, options: channel }) {
+    try {
+        await transport.unsubscribe(channel);
+    }
+    catch (err) {
+        throw new BrokerError(`Failed to unsubscribe socket from the ${channel} channel - ${err}`);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import http from "http";
+import { Server } from "./server.js";
+import { ServerOptions } from "./server-options.js";
+import { ServerMap } from "./maps/server-map.js";
+export { Server } from "./server.js";
+export { ServerSocket } from "./server-socket.js";
+export { PluginType } from "@socket-mesh/core";
+export { BasicServerMap } from "./maps/server-map.js";
+export { BasicSocketMapServer } from "./maps/socket-map.js";
+/**
+ * Creates an http.Server exclusively used for WS upgrades.
+ *
+ * @param {Number} port
+ * @param {Function} callback
+ * @param {Object} options
+ * @return {AGServer} websocket cluster server
+ * @api public
+ */
+export declare function listen<T extends ServerMap>(): Server<T>;
+export declare function listen<T extends ServerMap>(port: number, options: ServerOptions<T>): Server<T>;
+export declare function listen<T extends ServerMap>(port: number, options: ServerOptions<T>, fn: () => void): Server<T>;
+/**
+ * Captures upgrade requests for a http.Server.
+ *
+ * @param {http.Server} server
+ * @param {Object} options
+ * @return {AGServer} websocket cluster server
+ * @api public
+ */
+export declare function attach<T extends ServerMap>(server: http.Server, options?: ServerOptions<T>): Server<T>;

package/{index.js → dist/index.js}

@@ -1,21 +1,21 @@
 import http from "http";
 import { Server } from "./server.js";
 export { Server } from "./server.js";
-export { ServerSocket } from "./serversocket.js";
-export { SocketState } from "./socket-state.js";
-export { MiddlewareType } from "./middleware-type.js";
-export * from "./action.js";
+export { ServerSocket } from "./server-socket.js";
 export function listen(port, options, fn) {
     if (typeof options === 'function') {
         fn = options;
         options = {};
     }
+    else if (!options) {
+        options = {};
+    }
     const server = http.createServer((req, res) => {
         res.writeHead(501);
         res.end('Not Implemented');
     });
+    options.server = server;
     const socketClusterServer = attach(server, options);
-    socketClusterServer.httpServer = server;
     server.listen(port, fn);
     return socketClusterServer;
 }
@@ -32,7 +32,7 @@ export function attach(server, options) {
     if (options == null) {
         options = {};
     }
-    options.httpServer = server;
+    options.server = server;
     return new Server(options);
 }
 ;

package/dist/maps/client-map.d.ts

@@ -0,0 +1,10 @@
+import { PublicMethodMap } from "@socket-mesh/core";
+import { ServerMap } from "./server-map.js";
+export interface ClientMapFromServer<T extends ServerMap> {
+    Channel: T['Channel'];
+    Incoming: T['Outgoing'] & T['PrivateOutgoing'];
+    Service: T['Service'];
+    Outgoing: PublicMethodMap;
+    PrivateOutgoing: T['PrivateIncoming'];
+    State: object;
+}

package/dist/maps/client-map.js

@@ -0,0 +1 @@
+export {};

package/dist/maps/server-map.d.ts

@@ -0,0 +1,24 @@
+import { ChannelMap } from "@socket-mesh/channels";
+import { ClientPrivateMap, ServerPrivateMap } from "@socket-mesh/client";
+import { PrivateMethodMap, PublicMethodMap, ServiceMap } from "@socket-mesh/core";
+import { ServerSocketState } from "../server-socket-state.js";
+export interface ServerMap {
+    Channel: ChannelMap;
+    Service: ServiceMap;
+    Incoming: PublicMethodMap;
+    Outgoing: PublicMethodMap;
+    PrivateIncoming: PrivateMethodMap;
+    PrivateOutgoing: PrivateMethodMap;
+    ServerState: object;
+    State: object;
+}
+export interface BasicServerMap<TIncoming extends PublicMethodMap = {}, TChannels extends ChannelMap = {}, TState extends object = {}, TOutgoing extends object = {}> {
+    Channel: TChannels;
+    Service: {};
+    Incoming: TIncoming;
+    Outgoing: TOutgoing;
+    PrivateIncoming: ServerPrivateMap;
+    PrivateOutgoing: ClientPrivateMap;
+    ServerState: {};
+    State: TState & ServerSocketState;
+}

package/dist/maps/server-map.js

@@ -0,0 +1 @@
+export {};