@tsed/socketio 8.0.0-alpha.5 → 8.0.0-alpha.6

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;
-    };
-}

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

@@ -1,4 +0,0 @@
-export interface SocketInjectableNsp {
-    propertyKey: string;
-    nsp?: string | RegExp;
-}

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

@@ -1,7 +0,0 @@
-import { MetadataTypes } from "@tsed/core";
-import { SocketFilters } from "./SocketFilters.js";
-export interface SocketParamMetadata extends Partial<MetadataTypes> {
-    filter: SocketFilters;
-    mapIndex?: number;
-    useMapper?: boolean;
-}

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

@@ -1,7 +0,0 @@
-/**
- *
- */
-export declare enum SocketProviderTypes {
-    SERVICE = "service",
-    MIDDLEWARE = "middleware"
-}

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

@@ -1,8 +0,0 @@
-/**
- * @ignore
- */
-export declare enum SocketReturnsTypes {
-    BROADCAST = "broadcast",
-    BROADCAST_OTHERS = "broadcastOthers",
-    EMIT = "emit"
-}

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

@@ -1,8 +0,0 @@
-import SocketIO from "socket.io";
-declare global {
-    namespace TsED {
-        interface Configuration {
-            socketIO: Partial<SocketIO.ServerOptions>;
-        }
-    }
-}

package/lib/types-esm/services/SocketIOServer.d.ts

@@ -1,4 +0,0 @@
-import { Server } from "socket.io";
-export type SocketIOServer = Server;
-export declare const SocketIOServer: typeof Server;
-export { Server };

package/lib/types-esm/services/SocketIOService.d.ts

@@ -1,29 +0,0 @@
-import { InjectorService, Provider } from "@tsed/common";
-import * as SocketIO from "socket.io";
-/**
- *
- */
-export declare class SocketIOService {
-    private injector;
-    private io;
-    /**
-     *
-     * @type {Map<any, any>}
-     */
-    private namespaces;
-    constructor(injector: InjectorService, io: SocketIO.Server);
-    /**
-     *
-     * @param {string} namespace
-     * @returns {SocketIO.Namespace}
-     */
-    getNsp(namespace?: string | RegExp): {
-        nsp: SocketIO.Namespace;
-        instances: any[];
-    };
-    /**
-     *
-     * @param {Provider<any>} provider
-     */
-    addSocketProvider(provider: Provider<any>): void;
-}