@socket-mesh/server 17.3.1

package/README.md

@@ -0,0 +1,97 @@
+# SocketCluster server
+Minimal server module for SocketCluster.
+
+This is a stand-alone server module for SocketCluster.
+SocketCluster's protocol is backwards compatible with the SocketCluster protocol.
+
+## Setting up
+
+You will need to install both ```socketcluster-server``` and ```socketcluster-client``` (https://github.com/SocketCluster/socketcluster-client).
+
+To install this module:
+```bash
+npm install socketcluster-server
+```
+
+## Usage
+
+You need to attach it to an existing Node.js http or https server (example):
+```js
+const http = require('http');
+const socketClusterServer = require('socketcluster-server');
+
+let httpServer = http.createServer();
+let agServer = socketClusterServer.attach(httpServer);
+
+(async () => {
+  // Handle new inbound sockets.
+  for await (let {socket} of agServer.listener('connection')) {
+
+    (async () => {
+      // Set up a loop to handle and respond to RPCs for a procedure.
+      for await (let req of socket.procedure('customProc')) {
+        if (req.data.bad) {
+          let error = new Error('Server failed to execute the procedure');
+          error.name = 'BadCustomError';
+          req.error(error);
+        } else {
+          req.end('Success');
+        }
+      }
+    })();
+
+    (async () => {
+      // Set up a loop to handle remote transmitted events.
+      for await (let data of socket.receiver('customRemoteEvent')) {
+        // ...
+      }
+    })();
+
+  }
+})();
+
+httpServer.listen(8000);
+```
+
+For more detailed examples of how to use SocketCluster, see `test/integration.js`.
+Also, see tests from the `socketcluster-client` module.
+
+SocketCluster can work without the `for-await-of` loop; a `while` loop with `await` statements can be used instead.
+See https://github.com/SocketCluster/stream-demux#usage
+
+## Compatibility mode
+
+For compatibility with existing SocketCluster clients, set the `protocolVersion` to `1` and make sure that the `path` matches your old client path:
+
+```js
+let agServer = socketClusterServer.attach(httpServer, {
+  protocolVersion: 1,
+  path: '/socketcluster/'
+});
+```
+
+## Running the tests
+
+- Clone this repo: `git clone git@github.com:SocketCluster/socketcluster-server.git`
+- Navigate to project directory: `cd socketcluster-server`
+- Install all dependencies: `npm install`
+- Run the tests: `npm test`
+
+## Benefits of async `Iterable` over `EventEmitter`
+
+- **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.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013-2023 SocketCluster.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.

package/action.d.ts

@@ -0,0 +1,109 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { AuthTokenError, AuthTokenExpiredError } from "@socket-mesh/errors";
+import { AuthState, AuthToken, SignedAuthToken } from "@socket-mesh/auth";
+import { IncomingMessage } from 'http';
+import { DataPacket } from "@socket-mesh/simple-broker";
+import { ChannelOptions } from "@socket-mesh/channel";
+import { Request } from "@socket-mesh/request";
+import { ServerSocket } from "./serversocket";
+export declare enum ActionType {
+    HANDSHAKE_WS = "handshakeWS",
+    HANDSHAKE_SC = "handshakeSC",
+    MESSAGE = "message",
+    TRANSMIT = "transmit",
+    INVOKE = "invoke",
+    SUBSCRIBE = "subscribe",
+    PUBLISH_IN = "publishIn",
+    PUBLISH_OUT = "publishOut",
+    AUTHENTICATE = "authenticate"
+}
+export interface ActionResult<T> {
+    data: T;
+    options?: ActionOptions;
+}
+export interface ActionOptions {
+    useCache: boolean;
+}
+export declare abstract class Action<T, U extends ActionType = ActionType> {
+    readonly type: U;
+    readonly promise: Promise<ActionResult<T> | undefined>;
+    outcome: 'allowed' | 'blocked' | null;
+    private _resolve;
+    private _reject;
+    constructor(type: U);
+    allow(packet?: ActionResult<T>): void;
+    block(error: Error): void;
+}
+export type MiddlewareAction<T> = ActionTransmit<T> | ActionInvoke<T> | ActionPublishIn<T> | ActionPublishOut<T> | ActionSubscribe<T> | ActionHandshakeSC<T> | ActionHandshakeWS | ActionAuthenticate<T> | ActionMessage<T>;
+export type InboundAction<T> = ActionAuthenticate<T> | ActionTransmit<T> | ActionInvoke<T> | ActionPublishIn<T> | ActionSubscribe<T>;
+export declare class ActionHandshakeWS extends Action<undefined, ActionType.HANDSHAKE_WS> {
+    constructor(request: IncomingMessage);
+    request: IncomingMessage;
+}
+export type AuthInfo = {
+    signedAuthToken: SignedAuthToken;
+    authTokenError: AuthTokenError;
+    authToken: null;
+    authState: AuthState;
+} | {
+    signedAuthToken: SignedAuthToken;
+    authTokenError: null;
+    authToken: AuthToken;
+    authState: AuthState;
+};
+export declare class ActionHandshakeSC<T> extends Action<AuthInfo, ActionType.HANDSHAKE_SC> {
+    constructor(socket: ServerSocket<T>, request: Request<{
+        authToken: string;
+    }>, data: AuthInfo);
+    request: Request<{
+        authToken: string;
+    }>;
+    socket: ServerSocket<T>;
+    data: AuthInfo;
+}
+export declare class ActionMessage<T> extends Action<string | ArrayBuffer | Buffer[], ActionType.MESSAGE> {
+    constructor(socket: ServerSocket<T>, data: string | ArrayBuffer | Buffer[]);
+    socket: ServerSocket<T>;
+    data: string | ArrayBuffer | Buffer[];
+}
+export declare class ActionTransmit<T> extends Action<T, ActionType.TRANSMIT> {
+    constructor(socket: ServerSocket<T>, receiver: string, packet: DataPacket<T>);
+    socket: ServerSocket<T>;
+    authTokenExpiredError?: AuthTokenExpiredError;
+    receiver: string;
+    data?: DataPacket<T>;
+}
+export declare class ActionInvoke<T> extends Action<T, ActionType.INVOKE> {
+    constructor(socket: ServerSocket<T>, procedure: string, packet?: DataPacket<T>);
+    socket: ServerSocket<T>;
+    authTokenExpiredError?: AuthTokenExpiredError;
+    procedure: string;
+    data?: DataPacket<T>;
+}
+export declare class ActionSubscribe<T> extends Action<ChannelOptions, ActionType.SUBSCRIBE> {
+    constructor(socket: ServerSocket<T>, packet?: DataPacket<ChannelOptions>);
+    socket: ServerSocket<T>;
+    authTokenExpiredError?: AuthTokenExpiredError;
+    channel?: string;
+    data?: ChannelOptions;
+}
+export declare class ActionPublishIn<T> extends Action<T, ActionType.PUBLISH_IN> {
+    constructor(socket: ServerSocket<T>, packet?: Partial<DataPacket<T>>);
+    socket: ServerSocket<T>;
+    authTokenExpiredError?: AuthTokenExpiredError;
+    channel?: string;
+    data?: T;
+}
+export declare class ActionPublishOut<T> extends Action<T, ActionType.PUBLISH_OUT> {
+    constructor(socket: ServerSocket<T>);
+    socket: ServerSocket<T>;
+    channel?: string;
+    data?: T;
+}
+export declare class ActionAuthenticate<T> extends Action<undefined, ActionType.AUTHENTICATE> {
+    constructor(socket: ServerSocket<T>, authToken: AuthToken, signedAuthToken: SignedAuthToken);
+    socket: ServerSocket<T>;
+    authToken: AuthToken;
+    signedAuthToken: string;
+}

package/action.js

@@ -0,0 +1,112 @@
+import { InvalidActionError } from "@socket-mesh/errors";
+export var ActionType;
+(function (ActionType) {
+    ActionType["HANDSHAKE_WS"] = "handshakeWS";
+    ActionType["HANDSHAKE_SC"] = "handshakeSC";
+    ActionType["MESSAGE"] = "message";
+    ActionType["TRANSMIT"] = "transmit";
+    ActionType["INVOKE"] = "invoke";
+    ActionType["SUBSCRIBE"] = "subscribe";
+    ActionType["PUBLISH_IN"] = "publishIn";
+    ActionType["PUBLISH_OUT"] = "publishOut";
+    ActionType["AUTHENTICATE"] = "authenticate";
+})(ActionType || (ActionType = {}));
+export class Action {
+    constructor(type) {
+        this.type = type;
+        this.outcome = null;
+        this.promise = new Promise((resolve, reject) => {
+            this._resolve = resolve;
+            this._reject = reject;
+        });
+    }
+    allow(packet) {
+        if (this.outcome) {
+            throw new InvalidActionError(`Action ${this.type} has already been ${this.outcome}; cannot allow`);
+        }
+        this.outcome = 'allowed';
+        this._resolve(packet);
+    }
+    block(error) {
+        if (this.outcome) {
+            throw new InvalidActionError(`Action ${this.type} has already been ${this.outcome}; cannot block`);
+        }
+        this.outcome = 'blocked';
+        this._reject(error);
+    }
+}
+export class ActionHandshakeWS extends Action {
+    constructor(request) {
+        super(ActionType.HANDSHAKE_WS);
+        this.request = request;
+    }
+}
+export class ActionHandshakeSC extends Action {
+    constructor(socket, request, data) {
+        super(ActionType.HANDSHAKE_SC);
+        this.socket = socket;
+        this.request = request;
+        this.data = data;
+    }
+}
+export class ActionMessage extends Action {
+    constructor(socket, data) {
+        super(ActionType.MESSAGE);
+        this.socket = socket;
+        this.data = data;
+    }
+}
+export class ActionTransmit extends Action {
+    constructor(socket, receiver, packet) {
+        super(ActionType.TRANSMIT);
+        this.socket = socket;
+        this.receiver = receiver;
+        if (packet !== undefined) {
+            this.data = packet;
+        }
+    }
+}
+export class ActionInvoke extends Action {
+    constructor(socket, procedure, packet) {
+        super(ActionType.INVOKE);
+        this.socket = socket;
+        this.procedure = procedure;
+        if (packet !== undefined) {
+            this.data = packet;
+        }
+    }
+}
+export class ActionSubscribe extends Action {
+    constructor(socket, packet) {
+        super(ActionType.SUBSCRIBE);
+        this.socket = socket;
+        if (packet) {
+            this.channel = packet.channel;
+            this.data = packet.data;
+        }
+    }
+}
+export class ActionPublishIn extends Action {
+    constructor(socket, packet) {
+        super(ActionType.PUBLISH_IN);
+        this.socket = socket;
+        if (packet) {
+            this.channel = packet.channel;
+            this.data = packet.data;
+        }
+    }
+}
+export class ActionPublishOut extends Action {
+    constructor(socket) {
+        super(ActionType.PUBLISH_OUT);
+        this.socket = socket;
+    }
+}
+export class ActionAuthenticate extends Action {
+    constructor(socket, authToken, signedAuthToken) {
+        super(ActionType.AUTHENTICATE);
+        this.socket = socket;
+        this.authToken = authToken;
+        this.signedAuthToken = signedAuthToken;
+    }
+}

package/events.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="node" />
+import { AuthToken, SignedAuthToken, AuthStateChange } from "@socket-mesh/auth";
+import { ChannelOptions } from "@socket-mesh/channel";
+export type ServerSocketEvents = RawMessage | AuthStateChanged | AuthTokenSigned | Authenticated | Deauthenticated | BadAuthToken | Connected | Subscribed | Unsubscribed | ConnectAborted | Disconnected | Closed | ErrorOccurred | void;
+export type RawMessage = {
+    message: string | ArrayBuffer | Buffer[];
+};
+export interface AuthStateChanged extends AuthStateChange {
+    authToken?: AuthToken | null;
+}
+export interface AuthTokenSigned {
+    signedAuthToken: SignedAuthToken;
+}
+export interface Authenticated {
+    authToken?: AuthToken | null;
+}
+export interface Deauthenticated {
+    oldAuthToken?: AuthToken | null;
+}
+export interface BadAuthToken {
+    authError: Error;
+    signedAuthToken: string;
+}
+export interface Connected {
+    id: string;
+    pingTimeout: number;
+    authError?: Error;
+    isAuthenticated: boolean;
+}
+export interface Subscribed {
+    channel: string;
+    subscriptionOptions: ChannelOptions;
+}
+export interface Unsubscribed {
+    channel: string;
+}
+export interface ConnectAborted {
+    code: number;
+    reason: string;
+}
+export interface Disconnected {
+    code: number;
+    reason: string;
+}
+export interface Closed {
+    code: number;
+    reason: string;
+}
+export interface ErrorOccurred {
+    error: Error;
+}
+export interface WarningOccurred {
+    warning: Error;
+}

package/events.js

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

package/inbound-packet.d.ts

@@ -0,0 +1,48 @@
+import { SignedAuthToken } from "@socket-mesh/auth";
+import { ChannelOptions } from "@socket-mesh/channel";
+import { DataPacket } from "@socket-mesh/simple-broker";
+export type InboundPacket<T> = InboundHandshakePacket | InboundDataPacket<T> | InboundPublishPacket<T> | InboundSubscribePacket | InboundUnsubscribePacket | InboundAuthenticatePacket | InboundRemoveAuthTokenPacket;
+export interface InboundHandshakePacket {
+    event: '#handshake';
+    cid: number;
+    data: {
+        authToken: SignedAuthToken;
+    };
+}
+export interface InboundSubscribePacket {
+    event: '#subscribe';
+    cid: number;
+    data: DataPacket<ChannelOptions>;
+}
+export interface InboundUnsubscribePacket {
+    event: '#unsubscribe';
+    cid?: number;
+    data: string;
+}
+export interface InboundPublishPacket<T> {
+    event: '#publish';
+    cid?: number;
+    data?: Partial<DataPacket<T>>;
+}
+export interface InboundAuthenticatePacket {
+    event: '#authenticate';
+    cid: number;
+    data: string;
+}
+export interface InboundRemoveAuthTokenPacket {
+    event: '#removeAuthToken';
+    data: undefined;
+}
+export interface InboundDataPacket<T> {
+    event: string | null;
+    rid: number | null;
+    cid?: number | null;
+    data: DataPacket<T>;
+    error: any;
+}
+export declare function isHandshakePacket<T>(packet: InboundPacket<T>): packet is InboundHandshakePacket;
+export declare function isSubscribePacket<T>(packet: InboundPacket<T>): packet is InboundSubscribePacket;
+export declare function isUnsubscribePacket<T>(packet: InboundPacket<T>): packet is InboundUnsubscribePacket;
+export declare function isPublishPacket<T>(packet: InboundPacket<T>): packet is InboundPublishPacket<T>;
+export declare function isAuthenticatePacket<T>(packet: InboundPacket<T>): packet is InboundAuthenticatePacket;
+export declare function isRemoveAuthTokenPacket<T>(packet: InboundPacket<T>): packet is InboundRemoveAuthTokenPacket;

package/inbound-packet.js

@@ -0,0 +1,18 @@
+export function isHandshakePacket(packet) {
+    return packet.event === '#handshake';
+}
+export function isSubscribePacket(packet) {
+    return packet.event === '#subscribe';
+}
+export function isUnsubscribePacket(packet) {
+    return packet.event === '#unsubscribe';
+}
+export function isPublishPacket(packet) {
+    return packet.event === '#publish';
+}
+export function isAuthenticatePacket(packet) {
+    return packet.event === '#authenticate';
+}
+export function isRemoveAuthTokenPacket(packet) {
+    return packet.event === '#removeAuthToken';
+}

package/index.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+import http from "http";
+import { Server } from "./server";
+import { ServerOptions } from "./server-options";
+export { Server } from "./server";
+export { ServerSocket } from "./serversocket";
+/**
+ * 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>(): Server<T>;
+export declare function listen<T>(port: number, fn: () => void): Server<T>;
+export declare function listen<T>(port: number, options: ServerOptions): Server<T>;
+export declare function listen<T>(port: number, options: ServerOptions, 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>(server: http.Server, options?: ServerOptions): Server<T>;

package/index.js

@@ -0,0 +1,35 @@
+import http from "http";
+import { Server } from "./server";
+export { Server } from "./server";
+export { ServerSocket } from "./serversocket";
+export function listen(port, options, fn) {
+    if (typeof options === 'function') {
+        fn = options;
+        options = {};
+    }
+    const server = http.createServer((req, res) => {
+        res.writeHead(501);
+        res.end('Not Implemented');
+    });
+    const socketClusterServer = attach(server, options);
+    socketClusterServer.httpServer = server;
+    server.listen(port, fn);
+    return socketClusterServer;
+}
+;
+/**
+ * Captures upgrade requests for a http.Server.
+ *
+ * @param {http.Server} server
+ * @param {Object} options
+ * @return {AGServer} websocket cluster server
+ * @api public
+ */
+export function attach(server, options) {
+    if (options == null) {
+        options = {};
+    }
+    options.httpServer = server;
+    return new Server(options);
+}
+;

package/middleware-stream.d.ts

@@ -0,0 +1,7 @@
+import { WritableConsumableStream } from "@socket-mesh/writable-consumable-stream";
+import { MiddlewareType } from "./middleware-type";
+import { Action } from "./action";
+export declare class MiddlewareStream<T> extends WritableConsumableStream<Action<T>> {
+    readonly type: MiddlewareType;
+    constructor(type: MiddlewareType);
+}

package/middleware-stream.js

@@ -0,0 +1,7 @@
+import { WritableConsumableStream } from "@socket-mesh/writable-consumable-stream";
+export class MiddlewareStream extends WritableConsumableStream {
+    constructor(type) {
+        super();
+        this.type = type;
+    }
+}

package/middleware-type.d.ts

@@ -0,0 +1,6 @@
+export declare enum MiddlewareType {
+    MIDDLEWARE_HANDSHAKE = "handshake",
+    MIDDLEWARE_INBOUND_RAW = "inboundRaw",
+    MIDDLEWARE_INBOUND = "inbound",
+    MIDDLEWARE_OUTBOUND = "outbound"
+}

package/middleware-type.js

@@ -0,0 +1,7 @@
+export var MiddlewareType;
+(function (MiddlewareType) {
+    MiddlewareType["MIDDLEWARE_HANDSHAKE"] = "handshake";
+    MiddlewareType["MIDDLEWARE_INBOUND_RAW"] = "inboundRaw";
+    MiddlewareType["MIDDLEWARE_INBOUND"] = "inbound";
+    MiddlewareType["MIDDLEWARE_OUTBOUND"] = "outbound";
+})(MiddlewareType || (MiddlewareType = {}));

package/outbound-packet.d.ts

@@ -0,0 +1,25 @@
+import { DataPacket } from "@socket-mesh/simple-broker";
+export type OutboundPacket<T> = OutboundPublishPacket<T> | OutboundTransmitPacket<T> | OutboundInvokePacket<T>;
+export interface OutboundPublishPacket<T> {
+    event: '#publish';
+    data: DataPacket<T>;
+    options?: OutboundPacketOptions;
+}
+export interface OutboundTransmitPacket<T> {
+    event: string;
+    data: T;
+    options?: OutboundPacketOptions;
+}
+export interface OutboundInvokePacket<T> {
+    event: string;
+    data: T;
+    options?: OutboundPacketOptions;
+    resolve: (value: any) => void;
+    reject: (err: Error) => void;
+}
+export interface OutboundPacketOptions {
+    ackTimeout?: number;
+    useCache?: boolean;
+    stringifiedData?: string;
+}
+export declare function isPublishOutPacket<T>(packet: OutboundPacket<T>): packet is OutboundPublishPacket<T>;

package/outbound-packet.js

@@ -0,0 +1,3 @@
+export function isPublishOutPacket(packet) {
+    return packet.event === '#publish';
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@socket-mesh/server",
+  "version": "17.3.1",
+  "description": "Server module for SocketMesh",
+  "main": "index.js",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/socket-mesh/server.git"
+  },
+  "dependencies": {
+    "@socket-mesh/async-stream-emitter": "^4.2.4",
+		"@socket-mesh/consumable-stream": "3.2.0",
+    "@socket-mesh/auth": "^2.1.5",
+    "@socket-mesh/errors": "^3.0.4",
+    "@socket-mesh/formatter": "^4.0.3",
+    "@socket-mesh/request": "^2.0.3",
+    "@socket-mesh/server-auth": "^0.0.3",
+    "@socket-mesh/simple-broker": "^5.1.5",
+    "@socket-mesh/stream-demux": "^9.0.5",
+    "@socket-mesh/writable-consumable-stream": "^4.2.0",
+		"@socket-mesh/channel": "6.0.15",
+    "base64id": "^2.0.0",
+    "clone-deep": "^4.0.1",
+    "jsonwebtoken": "^9.0.0",
+    "ws": "^8.13.0"
+  },
+  "devDependencies": {
+    "@socket-mesh/local-storage": "^1.0.0",
+    "@types/base64id": "^2.0.0",
+    "@types/clone-deep": "^4.0.1",
+    "@types/jsonwebtoken": "^9.0.1",
+    "@types/ws": "^8.5.4",
+    "cross-env": "^7.0.3",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "scripts": {
+    "build": "node ./scripts/build.mjs && tsc",
+    "deploy": "cd dist && npm publish --access public",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --config ./jest.config.ts"
+  },
+  "keywords": [
+    "websocket",
+    "realtime",
+    "socketcluster",
+    "socketmesh"
+  ],
+  "author": "Jonathan Gros-Dubois <grosjona@yahoo.com.au>",
+  "contributors": [
+    "Greg Kimmy",
+    {
+      "name": "Jonathan Gros-Dubois",
+      "email": "grosjona@yahoo.com.au"
+    }
+  ],
+  "license": "MIT"
+}

package/request.d.ts

@@ -0,0 +1,26 @@
+import { Request } from "@socket-mesh/request";
+import { RequestSocket } from "@socket-mesh/request/request";
+import { Connected } from "./events";
+import { DataPacket } from "@socket-mesh/simple-broker";
+import { ChannelOptions } from "@socket-mesh/channel";
+export type InboundRequest<T> = HandshakeRequest | SubscribeRequest | UnsubscribeRequest | AuthenticateRequest | PublishRequest<T>;
+export interface HandshakeData {
+    authToken: string;
+}
+export declare class HandshakeRequest extends Request<HandshakeData, Connected> {
+    constructor(socket: RequestSocket, id: number, procedureName: '#handshake', data: HandshakeData);
+}
+export type SubscribeRequest = Request<Partial<DataPacket<ChannelOptions>>, void>;
+export type PublishRequest<T> = Request<Partial<DataPacket<T>>, void>;
+export declare class UnsubscribeRequest extends Request<string, void> {
+    constructor(socket: RequestSocket, id: number, procedureName: '#unsubscribe', data: string);
+}
+export interface AuthenticateData {
+    isAuthenticated: boolean;
+    authError: Error | null;
+}
+export declare class AuthenticateRequest extends Request<string, AuthenticateData> {
+    constructor(socket: RequestSocket, id: number, procedureName: '#authenticate', data: string);
+}
+export declare function isSubscribeRequest(request: Request<unknown>): request is SubscribeRequest;
+export declare function isPublishRequest<T>(request: Request<unknown>): request is PublishRequest<T>;