@tsed/socketio 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/decorators/input.d.ts

@@ -1,20 +0,0 @@
-/**
- * Attach the decorated method to the socket event.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Input("event")
- *   myMethod(@Args(0) data: any, @Nsp socket) {
- *
- *   }
- * }
- * ```
- *
- * @decorator
- * @param eventName
- */
-export declare function Input(eventName: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/lib/types-esm/decorators/inputAndBroadcast.d.ts

@@ -1,20 +0,0 @@
-/**
- * Attach the decorated method to the socket event and broadcast the response to all clients.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @InputAndBroadcast("event")
- *   async myMethod(@Args(0) data: any, @Nsp socket) {
- *      return {data: "data"};
- *   }
- * }
- * ```
- *
- * @decorator
- * @param eventName
- */
-export declare function InputAndBroadcast(eventName: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/lib/types-esm/decorators/inputAndBroadcastOthers.d.ts

@@ -1,20 +0,0 @@
-/**
- * Attach the decorated method to the socket event and broadcast the response to all clients with the exception of the connected customer.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @InputAndBroadcastOthers("event")
- *   async myMethod(@Args(0) data: any, @Nsp socket) {
- *      return {data: "data"};
- *   }
- * }
- * ```
- *
- * @decorator
- * @param eventName
- */
-export declare function InputAndBroadcastOthers(eventName: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/lib/types-esm/decorators/inputAndEmit.d.ts

@@ -1,20 +0,0 @@
-/**
- * Attach the decorated method to the socket event and emit the response to the client.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @InputAndEmit("event")
- *   async myMethod(@Args(0) data: any, @Nsp socket) {
- *      return {data: "data"};
- *   }
- * }
- * ```
- *
- * @decorator
- * @param eventName
- */
-export declare function InputAndEmit(eventName: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/lib/types-esm/decorators/io.d.ts

@@ -1,20 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Inject the [SocketIO.Server](https://socket.io/docs/server-api/) instance in the decorated parameter.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *   constructor(@IO private io: Server) {}
- * }
- * ```
- *
- * @param target
- * @param targetKey
- * @param descriptor
- * @decorator
- */
-export declare function IO(): (...args: any[]) => any;
-export declare function IO(target: Type<any>, targetKey: string | symbol | undefined, descriptor: TypedPropertyDescriptor<Function> | number): any;

package/lib/types-esm/decorators/nsp.d.ts

@@ -1,72 +0,0 @@
-import { Namespace as NamespaceType } from "socket.io";
-export type Namespace = NamespaceType;
-export type Nsp = NamespaceType;
-/**
- * Inject the [SocketIO.Namespace](https://socket.io/docs/rooms-and-namespaces/#namespaces) instance in the decorated parameter.
- * Note that when using dynamic namespaces, when injecting a parameter, you may want to consider using @SocketNsp instead.
- *
- * ### Example
- *
- * ```typescript
- * import {Nsp, SocketService, Input} from "@tsed/socketio";
- *
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Nsp
- *   nsp: SocketIO.Namespace; // will inject SocketIO.Namespace (not available on constructor)
- *
- *   @Nsp("/my-other-namespace")
- *   nspOther: SocketIO.Namespace; // communication between two namespace
- *
- *   @Nsp(/regexp/)
- *   nspDynamic: SocketIO.Namespace; // will inject a dynamic namespace (not available on constructor)
- *
- *   @Input("event")
- *   myMethod(@Nsp namespace: SocketIO.Namespace) {
- *
- *   }
- * }
- * ```
- *
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function Nsp(target: any, propertyKey?: string, index?: number): any;
-/**
- * Inject the [SocketIO.Namespace](https://socket.io/docs/rooms-and-namespaces/#namespaces) instance in the decorated parameter.
- * Note that when using dynamic namespaces, when injecting a parameter, you may want to consider using @SocketNsp instead.
- *
- * ### Example
- *
- * ```typescript
- * import {Namespace, SocketService, Input} from "@tsed/socketio";
- *
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Namespace
- *   nsp: SocketIO.Namespace; // will inject SocketIO.Namespace (not available on constructor)
- *
- *   @Namespace("/my-other-namespace")
- *   nspOther: SocketIO.Namespace; // communication between two namespace
- *
- *   @Namespace(/regexp/)
- *   nspDynamic: SocketIO.Namespace; // will inject a dynamic namespace (not available on constructor)
- *
- *   @Input("event")
- *   myMethod(@Namespace namespace: Namespace) {
- *
- *   }
- * }
- * ```
- *
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @alias {Nsp}
- * @decorator
- */
-export declare function Namespace(target: any, propertyKey?: string, index?: number): any;

package/lib/types-esm/decorators/reason.d.ts

@@ -1,25 +0,0 @@
-/**
- * Inject the disconnection reason into the decorated parameter.
- *
- * This decorator is used in conjunction with the `$onDisconnect` event handler to handle disconnection reasons in SocketIO services.
- * It allows you to access the reason for the disconnection in your method implementation. For details please refer to the [Socket.io documentation](https://socket.io/docs/v4/server-api/#event-disconnect).
- *
- * @example
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *   public async $onDisconnect(
- *     @Reason reason: string = ''
- *   ) {
- *      // your implementation
- *   }
- * }
- * ```
- *
- * @experimental This decorator is experimental and may change or be removed in future versions.
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function Reason(target: unknown, propertyKey: string, index: number): void;

package/lib/types-esm/decorators/socket.d.ts

@@ -1,25 +0,0 @@
-import { Socket as SocketType } from "socket.io";
-export type Socket = SocketType;
-/**
- * Inject the Socket instance in the decorated parameter.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Input("event")
- *   myMethod(@Socket socket) {
- *
- *   }
- * }
- * ```
- *
- * @experimental
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function Socket(target: any, propertyKey: string, index: number): any;

package/lib/types-esm/decorators/socketErr.d.ts

@@ -1,21 +0,0 @@
-/**
- * Inject the error in the parameters
- *
- * ### Example
- *
- * ```typescript
- * @SocketMiddlewareError()
- * export class MyMiddleware {
- *
- *   myMethod(@SocketErr err: any, @Args() arguments: any[]) {
- *
- *   }
- * }
- * ```
- *
- * @decorator
- * @param target
- * @param propertyKey
- * @param index
- */
-export declare function SocketErr(target: any, propertyKey: string, index: number): any;

package/lib/types-esm/decorators/socketEventName.d.ts

@@ -1,21 +0,0 @@
-/**
- * Inject the Socket instance in the decorated parameter.
- *
- * ### Example
- *
- * ```typescript
- * @SocketMiddleware("/nsp")
- * export class MyMiddleware {
- *   use(@SocketEventName eventName: string) {
- *
- *   }
- * }
- * ```
- *
- * @experimental
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function SocketEventName(target: any, propertyKey: string, index: number): any;

package/lib/types-esm/decorators/socketFilter.d.ts

@@ -1,9 +0,0 @@
-import { SocketFilters } from "../interfaces/SocketFilters.js";
-/**
- *
- * @param {SocketFilters} filter
- * @param {number} mapIndex
- * @returns {(target: any, propertyKey: string, index: number) => Store}
- * @decorator
- */
-export declare function SocketFilter(filter: SocketFilters, mapIndex?: number): (target: any, propertyKey: string, index: number) => void;

package/lib/types-esm/decorators/socketMiddleware.d.ts

@@ -1,54 +0,0 @@
-/**
- * Declare a new SocketMiddleware.
- *
- * ### Example
- *
- * A middleware can be also used on a `SocketService` either on a class or on a method.
- *
- * Here an example of a middleware:
- *
- * ```typescript
- * @SocketMiddleware()
- * export class UserConverterSocketMiddleware {
- *     constructor(private converterService: ConverterService) {
- *     }
- *     async use(@Args() args: any[]) {
- *
- *         let [user] = args;
- *         // update Arguments
- *         user = this.converterService.deserialize(user, User);
- *
- *         return [user];
- *     }
- * }
- * ```
- * > The user instance will be forwarded to the next middleware and to your decorated method.
- *
- * Then:
- *
- * ```typescript
- * import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args} from "@tsed/socketio";
- * import {UserConverterSocketMiddleware} from "../middlewares.js";
- * import {User} from "../models/User.js";
- *
- * @SocketService("/my-namespace")
- * @SocketUseBefore(UserConverterSocketMiddleware) // global version
- * export class MySocketService {
- *
- *    @Input("eventName")
- *    @Emit("responseEventName") // or Broadcast or BroadcastOthers
- *    @SocketUseBefore(UserConverterSocketMiddleware)
- *    async myMethod(@Args(0) user: User) {
- *
- *        console.log(user);
- *
- *        return user;
- *    }
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @experimental
- */
-export declare function SocketMiddleware(): Function;

package/lib/types-esm/decorators/socketMiddlewareError.d.ts

@@ -1,50 +0,0 @@
-/**
- * Declare a new SocketMiddlewareError.
- *
- * ### Example
- *
- * A middleware can be also used on a `SocketService` either on a class or on a method.
- *
- * Here an example of a middleware:
- *
- * ```typescript
- * import {SocketMiddlewareError, SocketErr, Socket, Args} from "@tsed/socketio";
- *
- * @SocketMiddlewareError()
- * export class ErrorHandlerSocketMiddleware {
- *    async use(@SocketEventName, @SocketErr err: any, @Socket socket: SocketIO.Socket) {
- *        console.error(err);
- *        socket.emit("error", {message: "An error has occured"})
- *    }
- * }
- * ```
- *
- * Then:
- *
- * ```typescript
- * import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args} from "@tsed/socketio";
- * import {ErrorHandlerSocketMiddleware} from "../middlewares.js";
- * import {User} from "../models/User.js";
- *
- * @SocketService("/my-namespace")
- * @SocketUseAfter(ErrorHandlerSocketMiddleware) // global version
- * export class MySocketService {
- *
- *    @Input("eventName")
- *    @Emit("responseEventName") // or Broadcast or BroadcastOthers
- *    @SocketUseAfter(ErrorHandlerSocketMiddleware)
- *    async myMethod(@Args(0) userName: User) {
- *
- *        console.log(user);
- *        throw new Error("Error");
- *
- *        return user;
- *    }
- * }
- * ```
- *
- * @returns {Function}
- * @decorator
- * @experimental
- */
-export declare function SocketMiddlewareError(): Function;

package/lib/types-esm/decorators/socketNsp.d.ts

@@ -1,26 +0,0 @@
-import { Namespace } from "./nsp.js";
-export type SocketNsp = Namespace;
-/**
- * Inject the [SocketIO.Namespace](https://socket.io/docs/rooms-and-namespaces/#namespaces) instance in the decorated parameter.
- * This namespace may differ from the default namespace when using dynamic namespaces.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService(/nsp-.+/)
- * export class MyWS {
- *
- *   @Input("event")
- *   myMethod(@SocketNsp nsp: SocketNsp) {
- *
- *   }
- * }
- * ```
- *
- * @experimental
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function SocketNsp(target: any, propertyKey: string, index: number): any;

package/lib/types-esm/decorators/socketReturns.d.ts

@@ -1,9 +0,0 @@
-import { SocketReturnsTypes } from "../interfaces/SocketReturnsTypes.js";
-/**
- *
- * @param {string} eventName
- * @param {SocketReturnsTypes} type
- * @returns {(target: any, propertyKey: string, descriptor: PropertyDescriptor) => void}
- * @decorator
- */
-export declare function SocketReturns(eventName: string, type: SocketReturnsTypes): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/lib/types-esm/decorators/socketService.d.ts

@@ -1,11 +0,0 @@
-/**
- * The decorators `@SocketService()` declare a new socket service (and service) can be injected in other service or controller on there `constructor`.
- * All services annotated with `@SocketService()` are constructed one time.
- *
- * > `@SocketService()` use the `reflect-metadata` to collect and inject service on controllers or other services.
- *
- * @param namespace
- * @returns {Function}
- * @decorator
- */
-export declare function SocketService(namespace?: string | RegExp): any;

package/lib/types-esm/decorators/socketSession.d.ts

@@ -1,44 +0,0 @@
-export type SocketSession = Map<string, any>;
-/**
- * Inject the socket session data in the decorated parameter.
- *
- * ### Example
- *
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Input("event")
- *   myMethod(@SocketSession session: SocketSession) {
- *     console.log(session);
- *   }
- * }
- * ```
- *
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @decorator
- */
-export declare function SocketSession(target: any, propertyKey: string, index: number): void;
-/**
- * Inject the raw `socket.data` in the decorated parameter.
- *
- * @example
- * ```typescript
- * @SocketService("/nsp")
- * export class MyWS {
- *
- *   @Input("event")
- *   myMethod(@RawSocketSession session: Record<string, unknown>) {
- *     console.log(session);
- *   }
- * }
- * ```
- *
- * @param target
- * @param {string} propertyKey
- * @param {number} index
- * @constructor
- */
-export declare function RawSocketSession(target: any, propertyKey: string, index: number): void;

package/lib/types-esm/decorators/socketUseAfter.d.ts

@@ -1,52 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Attach a Socket Middleware to a method or a class.
- *
- * ### Example
- *
- * A middleware can be also used on a `SocketService` either on a class or on a method.
- *
- * Here an example of a middleware:
- *
- * ```typescript
- * import {SocketMiddlewareError, SocketErr, Socket, Args} from "@tsed/socketio";
- *
- * @SocketMiddlewareError()
- * export class ErrorHandlerSocketMiddleware {
- *    async use(@SocketErr() err: any, @Socket socket: SocketIO.Socket) {
- *        console.error(err);
- *        socket.emit("error", {message: "An error has occured"})
- *    }
- * }
- * ```
- *
- * Then:
- *
- * ```typescript
- * import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args} from "@tsed/socketio";
- * import {ErrorHandlerSocketMiddleware} from "../middlewares.js";
- * import {User} from "../models/User.js";
- *
- * @SocketService("/my-namespace")
- * @SocketUseAfter(ErrorHandlerSocketMiddleware) // global version
- * export class MySocketService {
- *
- *    @Input("eventName")
- *    @Emit("responseEventName") // or Broadcast or BroadcastOthers
- *    @SocketUseAfter(ErrorHandlerSocketMiddleware)
- *    async myMethod(@Args(0) userName: User) {
- *
- *        console.log(user);
- *        throw new Error("Error");
- *
- *        return user;
- *    }
- * }
- * ```
- *
- * @returns {(target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void}
- * @decorator
- * @experimental
- * @param middlewares
- */
-export declare function SocketUseAfter(...middlewares: Type<any>[]): (target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void;

package/lib/types-esm/decorators/socketUseBefore.d.ts

@@ -1,56 +0,0 @@
-import { Type } from "@tsed/core";
-/**
- * Attach a Socket Middleware to a method or a class.
- *
- * ### Example
- *
- * A middleware can be also used on a `SocketService` either on a class or on a method.
- *
- * Here an example of a middleware:
- *
- * ```typescript
- * @SocketMiddleware()
- * export class UserConverterSocketMiddleware {
- *     constructor(private converterService: ConverterService) {
- *     }
- *     async use(@Args() args: any[]) {
- *
- *         let [user] = args;
- *         // update Arguments
- *         user = ConverterService.deserialize(user, User);
- *
- *         return [user];
- *     }
- * }
- * ```
- * > The user instance will be forwarded to the next middleware and to your decorated method.
- *
- * Then:
- *
- * ```typescript
- * import {SocketService, SocketUseAfter, SocketUseBefore, Emit, Input, Args} from "@tsed/socketio";
- * import {UserConverterSocketMiddleware} from "../middlewares.js";
- * import {User} from "../models/User.js";
- *
- * @SocketService("/my-namespace")
- * @SocketUseBefore(UserConverterSocketMiddleware) // global version
- * export class MySocketService {
- *
- *    @Input("eventName")
- *    @Emit("responseEventName") // or Broadcast or BroadcastOthers
- *    @SocketUseBefore(UserConverterSocketMiddleware)
- *    async myMethod(@Args(0) user: User) {
- *
- *        console.log(user);
- *
- *        return user;
- *    }
- * }
- * ```
- *
- * @returns {(target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void}
- * @decorator
- * @experimental
- * @param middlewares
- */
-export declare function SocketUseBefore(...middlewares: Type<any>[]): (target: any, propertyKey?: string, descriptor?: PropertyDescriptor) => void;

package/lib/types-esm/index.d.ts

@@ -1,41 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./class/SocketHandlersBuilder.js";
-export * from "./class/SocketProviderMetadata.js";
-export * from "./class/SocketSessionData.js";
-export * from "./constants/constants.js";
-export * from "./decorators/args.js";
-export * from "./decorators/broadcast.js";
-export * from "./decorators/broadcastOthers.js";
-export * from "./decorators/emit.js";
-export * from "./decorators/input.js";
-export * from "./decorators/inputAndBroadcast.js";
-export * from "./decorators/inputAndBroadcastOthers.js";
-export * from "./decorators/inputAndEmit.js";
-export * from "./decorators/io.js";
-export * from "./decorators/nsp.js";
-export * from "./decorators/reason.js";
-export * from "./decorators/socket.js";
-export * from "./decorators/socketErr.js";
-export * from "./decorators/socketEventName.js";
-export * from "./decorators/socketFilter.js";
-export * from "./decorators/socketMiddleware.js";
-export * from "./decorators/socketMiddlewareError.js";
-export * from "./decorators/socketNsp.js";
-export * from "./decorators/socketReturns.js";
-export * from "./decorators/socketService.js";
-export * from "./decorators/socketSession.js";
-export * from "./decorators/socketUseAfter.js";
-export * from "./decorators/socketUseBefore.js";
-export * from "./interfaces/interfaces.js";
-export * from "./interfaces/OnNamespaceInit.js";
-export * from "./interfaces/SocketFilters.js";
-export * from "./interfaces/SocketHandlerMetadata.js";
-export * from "./interfaces/SocketInjectableNsp.js";
-export * from "./interfaces/SocketParamMetadata.js";
-export * from "./interfaces/SocketProviderTypes.js";
-export * from "./interfaces/SocketReturnsTypes.js";
-export * from "./services/SocketIOServer.js";
-export * from "./services/SocketIOService.js";
-export * from "./SocketIOModule.js";

package/lib/types-esm/interfaces/OnNamespaceInit.d.ts

@@ -1,7 +0,0 @@
-import { Namespace } from "socket.io";
-/**
- *
- */
-export interface OnNamespaceInit {
-    $onNamespaceInit(nsp: Namespace): void;
-}

package/lib/types-esm/interfaces/SocketFilters.d.ts

@@ -1,14 +0,0 @@
-/**
- * @ignore
- */
-export declare enum SocketFilters {
-    ARGS = "args",
-    SOCKET = "socket",
-    EVENT_NAME = "eventName",
-    NSP = "nsp",
-    SESSION = "session",
-    RAW_SESSION = "raw_session",
-    ERR = "error",
-    SOCKET_NSP = "socket_nsp",
-    REASON = "reason"
-}

package/lib/types-esm/interfaces/SocketHandlerMetadata.d.ts

@@ -1,18 +0,0 @@
-import { SocketParamMetadata } from "./SocketParamMetadata.js";
-import { SocketReturnsTypes } from "./SocketReturnsTypes.js";
-/**
- *
- */
-export interface SocketHandlerMetadata {
-    eventName?: string;
-    methodClassName: string;
-    useBefore?: any[];
-    useAfter?: any[];
-    parameters?: {
-        [key: number]: SocketParamMetadata;
-    };
-    returns?: {
-        type: SocketReturnsTypes;
-        eventName: string;
-    };
-}