@eleven-am/pondsocket 0.1.126 → 0.1.128

package/schema.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clientMessageSchema = void 0;
+const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const zod_1 = require("zod");
-const enums_1 = require("./enums");
 exports.clientMessageSchema = zod_1.z.object({
     event: zod_1.z.string(),
     requestId: zod_1.z.string(),
     channelName: zod_1.z.string(),
     payload: zod_1.z.record(zod_1.z.any()),
-    action: zod_1.z.nativeEnum(enums_1.ClientActions),
-    addresses: zod_1.z.union([zod_1.z.nativeEnum(enums_1.ChannelReceiver), zod_1.z.array(zod_1.z.string())]).optional(),
+    action: zod_1.z.nativeEnum(pondsocket_common_1.ClientActions),
+    addresses: zod_1.z.union([zod_1.z.nativeEnum(pondsocket_common_1.ChannelReceiver), zod_1.z.array(zod_1.z.string())]).optional(),
 });

package/server/pondSocket.js

@@ -14,11 +14,11 @@ var _PondSocket_instances, _PondSocket_server, _PondSocket_socketServer, _PondSo
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PondSocket = void 0;
 const http_1 = require("http");
+const pondsocket_common_1 = require("@eleven-am/pondsocket-common");
 const ws_1 = require("ws");
 const middleware_1 = require("../abstracts/middleware");
 const endpoint_1 = require("../endpoint/endpoint");
 const response_1 = require("../endpoint/response");
-const enums_1 = require("../enums");
 const matcher_1 = require("../matcher/matcher");
 class PondSocket {
     constructor(server, socketServer) {
@@ -108,9 +108,10 @@ _PondSocket_server = new WeakMap(), _PondSocket_socketServer = new WeakMap(), _P
             __classPrivateFieldGet(this, _PondSocket_socketServer, "f").emit('connection', socket);
             __classPrivateFieldGet(this, _PondSocket_middleware, "f").run(request, socket, () => {
                 const message = {
-                    action: enums_1.ServerActions.ERROR,
-                    event: enums_1.ErrorTypes.HANDLER_NOT_FOUND,
-                    channelName: enums_1.SystemSender.ENDPOINT,
+                    action: pondsocket_common_1.ServerActions.ERROR,
+                    event: pondsocket_common_1.ErrorTypes.HANDLER_NOT_FOUND,
+                    channelName: pondsocket_common_1.SystemSender.ENDPOINT,
+                    requestId: (0, pondsocket_common_1.uuid)(),
                     payload: {
                         message: 'No endpoint found',
                         code: 404,

package/types.d.ts

@@ -1,17 +1,9 @@
 import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
 
-import type { ModuleMetadata, DynamicModule, Type } from '@nestjs/common';
-import type { Express } from 'express';
 import { WebSocketServer } from 'ws';
 
 type Unsubscribe = () => void;
 
-type Constructor<T> = new (...args: any[]) => T;
-declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;
-declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
-declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
-declare type ParameterDecorator = (target: Object, propertyKey: string | symbol | undefined, parameterIndex: number) => void;
-
 export type default_t<T = any> = Record<string, T>;
 type IsParam<Path> = Path extends `:${infer Param}` ? Param : never;
 
@@ -33,11 +25,6 @@ type Params<Path> = {
     [Key in FilteredParams<Path>]: string
 }
 
-interface EndpointMetadata {
-    path?: string;
-    channels: Constructor<NonNullable<unknown>>[];
-}
-
 type PondPath<Path extends string> = Path | RegExp;
 
 type EventParams<Path> = {
@@ -51,11 +38,6 @@ type PondMessage = PondObject;
 type PondAssigns = PondObject;
 type JoinParams = PondObject;
 
-interface PresencePayload {
-    changed: PondPresence;
-    presence: PondPresence[];
-}
-
 interface UserPresences {
     [userId: string]: PondPresence;
 }
@@ -64,12 +46,6 @@ interface UserAssigns {
     [userId: string]: PondAssigns;
 }
 
-interface Metadata extends Omit<ModuleMetadata, 'controllers'> {
-    endpoints: Constructor<NonNullable<unknown>>[];
-    guards?: Constructor<CanActivate>[];
-    isGlobal?: boolean;
-}
-
 type PondEvent<Path> = EventParams<Path> & {
     payload: PondMessage;
     event: string;
@@ -89,131 +65,15 @@ interface LeaveEvent {
 
 type LeaveCallback = (event: LeaveEvent) => void;
 
-type ParamDecoratorCallback<Input> = (data: Input, context: Context) => unknown | Promise<unknown>;
 
 type PondEvenType = { [key: string]: PondMessage };
 
-type NestFuncType<Event extends string, Payload extends PondMessage> = {
-    event?: Event;
-    broadcast?: Event;
-    assigns?: PondAssigns;
-    presence?: PondPresence;
-    updatePresence?: PondPresence;
-} & Payload;
-
-type NestReturnType<EventType extends PondEvenType, Event extends keyof EventType> = Event extends string ?
-    NestFuncType<Event, EventType[Event]> :
-    never;
-
 interface UserData {
     assigns: PondAssigns;
     presence: PondPresence;
     id: string;
 }
 
-export interface CanActivate {
-
-    /**
-     * @desc Whether the client can continue with the request
-     * @param context - The context of the request
-     */
-    canActivate(context: Context): boolean | Promise<boolean>;
-}
-
-export enum ChannelState {
-    IDLE = 'IDLE',
-    JOINING = 'JOINING',
-    JOINED = 'JOINED',
-    STALLED = 'STALLED',
-    CLOSED = 'CLOSED',
-}
-
-declare class Context<Path extends string = string> {
-    /**
-     * @desc The request object, available in onJoin handlers
-     */
-    joinRequest: JoinRequest<Path> | null;
-
-    /**
-     * @desc The request object, available in onEvent handlers
-     */
-    eventRequest: EventRequest<Path> | null;
-
-    /**
-     * @desc The request object, available in onConnection handlers
-     */
-    connection: IncomingConnection<Path> | null;
-
-    /**
-     * @desc The leave event, available in onLeave handlers
-     */
-    leveeEvent: LeaveEvent | null;
-
-    /**
-     * @desc The response object, available in onJoin handlers
-     */
-    joinResponse: JoinResponse | null;
-
-    /**
-     * @desc The response object, available in onEvent handlers
-     */
-    eventResponse: EventResponse | null;
-
-    /**
-     * @desc The response object, available in onConnection handlers
-     */
-    connectionResponse: ConnectionResponse | null;
-
-    /**
-     * @desc The user data, available in onJoin, onEvent handlers
-     */
-    user: UserData | null;
-
-    /**
-     * @desc The channel, available in onJoin, onEvent handlers
-     */
-    channel: Channel | null;
-
-    /**
-     * @desc The assigns, available in onJoin, onEvent handlers
-     */
-    presence: UserPresences | null;
-
-    /**
-     * @desc The assigns, available in onJoin, onEvent handlers
-     */
-    event: PondEvent<Path> | null;
-
-    /**
-     * @desc The assigns, available in onJoin, onEvent handlers
-     */
-    assigns: PondAssigns | null;
-
-    /**
-     * @desc Returns the *type* of the controller class which the current handler belongs to.
-     */
-    getClass<T = any>(): Type<T>;
-
-    /**
-     * @desc Returns a reference to the handler (method) that will be invoked next in the
-     * request pipeline.
-     */
-    getHandler(): Function;
-
-    /**
-     * @desc Adds request data to the context
-     * @param key - the key to add
-     * @param value - the value to add
-     */
-    public addData(key: string, value: unknown): void;
-
-    /**
-     * @desc Retrieves request data from the context
-     * @param key - the key to retrieve
-     */
-    public getData<A = unknown>(key: string): A | null;
-}
-
 declare class AbstractRequest<Path extends string> {
     event: PondEvent<Path>;
 
@@ -322,125 +182,6 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
     closeChannel (reason: string): void;
 }
 
-export declare class ClientChannel<EventType extends PondEvenType = PondEvenType> {
-    channelState: ChannelState;
-
-    /**
-     * @desc Connects to the channel.
-     */
-    join (): void;
-
-    /**
-     * @desc Disconnects from the channel.
-     */
-    leave (): void;
-
-    /**
-     * @desc Monitors the channel for messages.
-     * @param callback - The callback to call when a message is received.
-     */
-    onMessage (callback: (event: keyof EventType, message: EventType[keyof EventType]) => void): Unsubscribe;
-
-    /**
-     * @desc Monitors the channel for messages.
-     * @param event - The event to monitor.
-     * @param callback - The callback to call when a message is received.
-     */
-    onMessageEvent <Key extends keyof EventType> (event: Key, callback: (message: EventType[Key]) => void): Unsubscribe;
-
-    /**
-     * @desc Monitors the channel state of the channel.
-     * @param callback - The callback to call when the connection state changes.
-     */
-    onChannelStateChange (callback: (connected: ChannelState) => void): Unsubscribe;
-
-    /**
-     * @desc Detects when clients join the channel.
-     * @param callback - The callback to call when a client joins the channel.
-     */
-    onJoin (callback: (presence: PondPresence) => void): Unsubscribe;
-
-    /**
-     * @desc Detects when clients leave the channel.
-     * @param callback - The callback to call when a client leaves the channel.
-     */
-    onLeave (callback: (presence: PondPresence) => void): Unsubscribe;
-
-    /**
-     * @desc Detects when clients change their presence in the channel.
-     * @param callback - The callback to call when a client changes their presence in the channel.
-     */
-    onPresenceChange (callback: (presence: PresencePayload) => void): Unsubscribe;
-
-    /**
-     * @desc Sends a message to specific clients in the channel.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     * @param recipient - The clients to send the message to.
-     */
-    sendMessage <Key extends keyof EventType> (event: Key, payload: EventType[Key], recipient: string[]): void;
-
-    /**
-     * @desc Sends a message to the server and waits for a response.
-     * @param sentEvent - The event to send.
-     * @param payload - The message to send.
-     * @param responseEvent - The event to wait for.
-     */
-    sendForResponse <ResponseKey extends keyof EventType, SentKey extends keyof EventType> (sentEvent: SentKey, payload: EventType[SentKey], responseEvent: ResponseKey): Promise<EventType[ResponseKey]>;
-
-    /**
-     * @desc Broadcasts a message to every other client in the channel except yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcastFrom <Key extends keyof EventType> (event: Key, payload: EventType[Key]): void;
-
-    /**
-     * @desc Broadcasts a message to the channel, including yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcast <Key extends keyof EventType> (event: Key, payload: EventType[Key]): void;
-
-    /**
-     * @desc Gets the current presence of the channel.
-     */
-    getPresence (): PondPresence[];
-
-    /**
-     * @desc Monitors the presence of the channel.
-     * @param callback - The callback to call when the presence changes.
-     */
-    onUsersChange (callback: (users: PondPresence[]) => void): Unsubscribe;
-
-    /**
-     * @desc Checks if the channel is connected.
-     */
-    isConnected (): boolean;
-
-    /**
-     * @desc Checks if the channel is stalled.
-     */
-    isStalled (): boolean;
-
-    /**
-     * @desc Checks if the channel is closed.
-     */
-    isClosed (): boolean;
-
-    /**
-     * @desc Monitors the connection state of the channel.
-     * @param callback - The callback to call when the connection state changes.
-     */
-    onConnectionChange (callback: (connected: boolean) => void): Unsubscribe;
-
-    /**
-     * @desc Gets the first response from the channel.
-     * @param event - The event to monitor.
-     */
-    getFirstResponse <Key extends keyof EventType> (event: Key): Promise<EventType[Key]>;
-}
-
 declare class Endpoint {
     /**
      * @desc Adds a new PondChannel to this path on this endpoint
@@ -678,7 +419,7 @@ export declare class PondChannel <EventType extends PondEvenType = PondEvenType>
      * @desc Gets a channel by name
      * @param channelName - The name of the channel to get
      */
-    public getChannel <EventType extends PondEvenType = PondEvenType> (channelName: string): Channel<EventType> | null;
+    public getChannel (channelName: string): Channel<EventType> | null;
 }
 
 declare class PondSocket {
@@ -714,240 +455,3 @@ declare class PondSocket {
      */
     createEndpoint<Path extends string> (path: PondPath<Path>, handler: (request: IncomingConnection<Path>, response: ConnectionResponse) => void | Promise<void>): Endpoint;
 }
-
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-interface PondSocketExpressApp extends Express {
-
-    /**
-     * @desc Accepts a new socket upgrade request on the provided endpoint using the handler function to authenticate the socket
-     * @param path - the pattern to accept || can also be a regex
-     * @param handler - the handler function to authenticate the socket
-     * @example
-     * const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
-     *    const token = req.query.token;
-     *    if (!token)
-     *       return res.reject('No token provided');
-     *    res.accept({
-     *       assign: {
-     *           token
-     *       }
-     *    });
-     * })
-     */
-    upgrade<Path extends string> (path: PondPath<Path>, handler: (request: IncomingConnection<Path>, response: ConnectionResponse) => void | Promise<void>): Endpoint;
-}
-
-declare class PondClient {
-    constructor (endpoint: string, params?: Record<string, any>);
-
-    /**
-     * @desc Connects to the server and returns the socket.
-     */
-    connect (backoff?: number): void;
-
-    /**
-     * @desc Returns the current state of the socket.
-     */
-    getState (): boolean;
-
-    /**
-     * @desc Disconnects the socket.
-     */
-    disconnect (): void;
-
-    /**
-     * @desc Creates a channel with the given name and params.
-     * @param name - The name of the channel.
-     * @param params - The params to send to the server.
-     */
-    createChannel <EventType extends PondEvenType = PondEvenType> (name: string, params?: JoinParams): ClientChannel<EventType>;
-
-    /**
-     * @desc Subscribes to the connection state.
-     * @param callback - The callback to call when the state changes.
-     */
-    onConnectionChange (callback: (state: boolean) => void): Unsubscribe;
-}
-
-declare const pondSocket: (app: Express) => PondSocketExpressApp;
-
-/**
- * @desc The Decorator for retrieving the JoinRequest object from the request in a handler
- * @returns {JoinRequest}
- */
-declare function GetJoinRequest(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the JoinResponse object from the response in a handler
- * @returns {JoinResponse}
- */
-declare function GetJoinResponse(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the JoinParams object from the request in a handler
- * @returns {JoinParams}
- */
-declare function GetJoinParams(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the UserData object from the request in a handler
- * @returns {UserData}
- */
-declare function GetUserData(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the Channel object from the request in a handler
- * @returns {Channel}
- */
-declare function GetInternalChannel(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the UserPresences object from the request in a handler
- * @returns {UserPresences}
- */
-declare function GetUserPresences(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the event payload from the request in a handler
- * @returns {PondMessage}
- */
-declare function GetEventPayload(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the EventRequest Params object from the request in a handler
- * @returns {Params}
- */
-declare function GetEventParams(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the EventRequest Query object from the request in a handler
- * @returns {Record<string, string>}
- */
-declare function GetEventQuery(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the EventResponse in a handler
- * @returns {EventResponse}
- */
-declare function GetEventResponse(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the EventRequest in a handler
- * @returns {EventRequest}
- */
-declare function GetEventRequest(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionReQuest in a handler
- * @returns {IncomingConnection}
- */
-declare function GetConnectionRequest(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionResponse in a handler
- * @returns {ConnectionResponse}
- */
-declare function GetConnectionResponse(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionRequestId in a handler
- * @returns {string}
- */
-declare function GetConnectionRequestId(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionParams in a handler
- * @returns {Params}
- */
-declare function GetConnectionParams(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionHeaders from the request in a handler
- * @returns {IncomingHttpHeaders}
- */
-declare function GetConnectionHeaders(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the ConnectionQuery in a handler
- * @returns {Record<string, string>}
- */
-declare function GetConnectionQuery(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the LeaveEvent in a handler
- * @returns {LeaveEvent}
- */
-declare function GetLeaveEvent(): ParameterDecorator;
-
-/**
- * @desc The Decorator for retrieving the Channel object from the request in a handler
- * @returns {Channel}
- */
-declare function GetChannel (): ParameterDecorator;
-
-/**
- * @desc Function to create a param decorator
- * @param callback - The callback to call when the decorator is used
- * @returns {ReturnType<callback>}
- */
-declare function createParamDecorator<Input> (callback: ParamDecoratorCallback<Input>): (input: Input) => ParameterDecorator;
-
-/**
- * @desc Marks a method as a handler for JoinRequest events. Throwing an error will reject the request with the error message.
- */
-declare function OnJoinRequest(): MethodDecorator;
-
-/**
- * @desc Marks a method as a handler for events with the specified name. Throwing an error will reject the request with the error message
- * @param event - The name of the event to handle.
- */
-declare function OnEvent(event?: string): MethodDecorator;
-
-/**
- * @desc Marks a method as a handler for Leave events. Useful for cleaning up resources when a user leaves.
- */
-declare function OnLeaveEvent (): MethodDecorator;
-
-/**
- * @desc Marks a method as a handler for ConnectionRequest events. Throwing an error will reject the request with the error message.
- */
-declare function OnConnectionRequest(): MethodDecorator;
-
-/**
- * Decorator to mark a class as a channel.
- * @param path - The path for the channel (default is '*').
- */
-declare function DChannel(path?: string): ClassDecorator;
-
-/**
- * Decorator to retrieve the channel instance as a read-only property in a class.
- * It may either return an instance of the PondChannel if no name is provided otherwise an instance of Channel or null (depending on if a client is connected)
- * @param name - The name of the channel to return
- */
-declare function ChannelInstance(name?: string): PropertyDecorator;
-
-/**
- * Decorator to retrieve the endpoint instance as a read-only property in a class.
- */
-declare function EndpointInstance (): PropertyDecorator;
-
-/**
- * Decorator to mark a class as an endpoint.
- * @param metadata - The metadata for the endpoint.
- */
-declare function DEndpoint(metadata: EndpointMetadata): ClassDecorator;
-
-/**
- * Decorator to add a guard to a class or method.
- * @param guards - The guards to add.
- */
-declare function PondGuards (...guards: Constructor<CanActivate>[]): MethodDecorator & ClassDecorator;
-
-declare class PondSocketModule {
-    /**
-     * @desc Creates a new PondSocketModule
-     * @param metadata - The metadata for the module
-     */
-    static forRoot (metadata: Metadata): DynamicModule;
-}

package/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });