@eleven-am/pondsocket 0.1.128 → 0.1.130

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.128",
+  "version": "0.1.130",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -34,7 +34,7 @@
     "url": "git+https://github.com/Eleven-am/pondSocket.git"
   },
   "dependencies": {
-    "@eleven-am/pondsocket-common": "^0.0.6",
+    "@eleven-am/pondsocket-common": "^0.0.7",
     "ws": "^8.16.0",
     "zod": "^3.22.4"
   },

package/types.d.ts

@@ -2,8 +2,6 @@ import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
 
 import { WebSocketServer } from 'ws';
 
-type Unsubscribe = () => void;
-
 export type default_t<T = any> = Record<string, T>;
 type IsParam<Path> = Path extends `:${infer Param}` ? Param : never;
 
@@ -11,16 +9,6 @@ type FilteredParams<Path> = Path extends `${infer First}/${infer Second}`
     ? IsParam<First> | FilteredParams<Second>
     : IsParam<Path>
 
-/**
- * @desc The type for the params in a request
- * @typeParam Path - The path to get the params from
- * @example
- *
- * const params: Params<'/api/:id'> = {
- *    id: '123',
- *    foo: 'bar', // Error: Type 'string' is not assignable to type 'undefined'
- * }
- */
 type Params<Path> = {
     [Key in FilteredParams<Path>]: string
 }
@@ -38,14 +26,6 @@ type PondMessage = PondObject;
 type PondAssigns = PondObject;
 type JoinParams = PondObject;
 
-interface UserPresences {
-    [userId: string]: PondPresence;
-}
-
-interface UserAssigns {
-    [userId: string]: PondAssigns;
-}
-
 type PondEvent<Path> = EventParams<Path> & {
     payload: PondMessage;
     event: string;
@@ -68,29 +48,29 @@ type LeaveCallback = (event: LeaveEvent) => void;
 
 type PondEvenType = { [key: string]: PondMessage };
 
-interface UserData {
-    assigns: PondAssigns;
-    presence: PondPresence;
+interface UserData<PresenceType extends PondPresence, AssignType extends PondAssigns> {
+    assigns: AssignType;
+    presence: PresenceType;
     id: string;
 }
 
-declare class AbstractRequest<Path extends string> {
+declare class AbstractRequest<Path extends string, PresenceType extends PondPresence, AssignType extends PondAssigns> {
     event: PondEvent<Path>;
 
     channelName: string;
 
-    assigns: UserAssigns;
+    assigns: Record<string, AssignType>;
 
-    presence: UserPresences;
+    presence: Record<string, PresenceType>;
 }
 
-declare class EventRequest<Path extends string> extends AbstractRequest<Path> {
-    user: UserData;
+declare class EventRequest<Path extends string, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> extends AbstractRequest<Path, PresenceType, AssignType> {
+    user: UserData<PresenceType, AssignType>;
 
     channel: Channel;
 }
 
-declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
+declare class EventResponse<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Whether the server has responded to the request
      */
@@ -100,7 +80,7 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
      * @desc Accepts the request and optionally assigns data to the client
      * @param assigns - the data to assign to the client
      */
-    accept (assigns?: PondAssigns): EventResponse;
+    accept (assigns?: AssignType): EventResponse;
 
     /**
      * @desc Rejects the request and optionally assigns data to the client
@@ -108,7 +88,7 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
      * @param errorCode - the error code
      * @param assigns - the data to assign to the client
      */
-    reject (message?: string, errorCode?: number, assigns?: PondAssigns): EventResponse;
+    reject (message?: string, errorCode?: number, assigns?: AssignType): EventResponse;
 
     /**
      * @desc Emits a direct message to the client, accepting the request
@@ -116,7 +96,7 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
      * @param payload - the payload to send
      * @param assigns - the data to assign to the client
      */
-    send (event: string, payload: PondMessage, assigns?: PondAssigns): void;
+    send (event: string, payload: PondMessage, assigns?: AssignType): void;
 
     /**
      * @desc Emits a direct message to the client without accepting the request
@@ -124,7 +104,7 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
      * @param payload - the payload to send
      * @param assigns - the data to assign to the client
      */
-    sendOnly <Key extends keyof EventType> (event: Key, payload: EventType[Key], assigns?: PondAssigns): void;
+    sendOnly <Key extends keyof EventType> (event: Key, payload: EventType[Key], assigns?: AssignType): void;
 
     /**
      * @desc Sends a message to all clients in the channel
@@ -153,14 +133,14 @@ declare class EventResponse<EventType extends PondEvenType = PondEvenType> {
      * @param presence - the initial presence data
      * @param userId - the id of the user to track
      */
-    trackPresence (presence: PondPresence, userId?: string): EventResponse;
+    trackPresence (presence: PresenceType, userId?: string): EventResponse;
 
     /**
      * @desc Updates a user's presence in the channel
      * @param presence - the updated presence data
      * @param userId - the id of the user to update
      */
-    updatePresence (presence: PondPresence, userId?: string): EventResponse;
+    updatePresence (presence: PresenceType, userId?: string): EventResponse;
 
     /**
      * @desc Removes a user's presence from the channel
@@ -197,7 +177,7 @@ declare class Endpoint {
      *         response.reject('You are not an admin', 403);
      * });
      */
-    createChannel<Path extends string> (path: PondPath<Path>, handler: (request: JoinRequest<Path>, response: JoinResponse) => void | Promise<void>): PondChannel;
+    createChannel<Path extends string, EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> (path: PondPath<Path>, handler: (request: JoinRequest<Path, PresenceType, AssignType>, response: JoinResponse<EventType, PresenceType, AssignType>) => void | Promise<void>): PondChannel<EventType, PresenceType, AssignType>;
 
     /**
      * @desc Broadcasts a message to all clients connected to this endpoint
@@ -213,7 +193,7 @@ declare class Endpoint {
     closeConnection (clientIds: string | string[]): void;
 }
 
-export declare class Channel<EventType extends PondEvenType = PondEvenType> {
+export declare class Channel<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * The name of the channel.
      */
@@ -222,13 +202,13 @@ export declare class Channel<EventType extends PondEvenType = PondEvenType> {
     /**
      * @desc Gets the current assign data for the channel.
      */
-    getAssigns (): UserAssigns;
+    getAssigns (): Record<string, AssignType>;
 
     /**
      * @desc Gets the assign date for a specific user.
      * @param userId - The id of the user to get the assign data for.
      */
-    getUserData (userId: string): UserData;
+    getUserData (userId: string): AssignType | null;
 
     /**
      * @desc Broadcasts a message to every client in the channel,
@@ -273,7 +253,7 @@ export declare class Channel<EventType extends PondEvenType = PondEvenType> {
      * @param userId - the id of the user to track
      * @param presence - the presence of the user
      */
-    trackPresence (userId: string, presence: PondPresence): void;
+    trackPresence (userId: string, presence: PresenceType): void;
 
     /**
      * @desc removes a user's presence from the channel
@@ -286,18 +266,18 @@ export declare class Channel<EventType extends PondEvenType = PondEvenType> {
      * @param userId - the id of the user to update
      * @param presence - the new presence of the user
      */
-    updatePresence (userId: string, presence: PondPresence): void;
+    updatePresence (userId: string, presence: PresenceType): void;
 }
 
-declare class JoinRequest<Path extends string> extends AbstractRequest<Path> {
+declare class JoinRequest<Path extends string, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> extends AbstractRequest<Path, PresenceType, AssignType> {
     joinParams: JoinParams;
 
-    user: UserData;
+    user: UserData<PresenceType, AssignType>;
 
     channel: Channel;
 }
 
-declare class JoinResponse<EventType extends PondEvenType = PondEvenType> {
+declare class JoinResponse<EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Whether the server has responded to the request
      */
@@ -307,7 +287,7 @@ declare class JoinResponse<EventType extends PondEvenType = PondEvenType> {
      * @desc Accepts the request and optionally assigns data to the client
      * @param assigns - the data to assign to the client
      */
-    accept (assigns?: PondAssigns): JoinResponse;
+    accept (assigns?: AssignType): JoinResponse;
 
     /**
      * @desc Rejects the request and optionally assigns data to the client
@@ -322,7 +302,7 @@ declare class JoinResponse<EventType extends PondEvenType = PondEvenType> {
      * @param payload - the payload to send
      * @param assigns - the data to assign to the client
      */
-    send <Key extends keyof EventType> (event: Key, payload: EventType[Key], assigns?: PondAssigns): JoinResponse;
+    send <Key extends keyof EventType> (event: Key, payload: EventType[Key], assigns?: AssignType): JoinResponse;
 
     /**
      * @desc Emits a message to all clients in the channel
@@ -350,7 +330,7 @@ declare class JoinResponse<EventType extends PondEvenType = PondEvenType> {
      * @desc tracks the presence of a client
      * @param presence - the presence data to track
      */
-    trackPresence (presence: PondPresence): JoinResponse;
+    trackPresence (presence: PresenceType): JoinResponse;
 }
 
 declare class ConnectionResponse {
@@ -381,7 +361,7 @@ declare class ConnectionResponse {
     send (event: string, payload: PondMessage, assigns?: PondAssigns): void;
 }
 
-export declare class PondChannel <EventType extends PondEvenType = PondEvenType> {
+export declare class PondChannel <EventType extends PondEvenType = PondEvenType, PresenceType extends PondPresence = PondPresence, AssignType extends PondAssigns = PondAssigns> {
     /**
      * @desc Handles an event request made by a user
      * @param event - The event to listen for
@@ -393,7 +373,7 @@ export declare class PondChannel <EventType extends PondEvenType = PondEvenType>
      *     });
      * });
      */
-    onEvent<Event extends string> (event: PondPath<Event>, handler: (request: EventRequest<Event>, response: EventResponse<EventType>) => void | Promise<void>): void;
+    onEvent<Event extends string> (event: PondPath<Event>, handler: (request: EventRequest<Event, PresenceType, AssignType>, response: EventResponse<EventType, PresenceType, AssignType>) => void | Promise<void>): void;
 
     /**
      * @desc Broadcasts a message to all users in a channel
@@ -419,7 +399,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 (channelName: string): Channel<EventType> | null;
+    public getChannel (channelName: string): Channel<EventType, PresenceType, AssignType>;
 }
 
 declare class PondSocket {