itty-sockets 0.7.1 → 0.8.0

package/connect.d.ts

@@ -1,4 +1,3 @@
-type IttySocketEvent<BaseFormat> = BaseFormat extends UseItty ? 'open' | 'close' | 'message' | 'join' | 'leave' : 'open' | 'close' | 'message';
 type Timestamp = {
     date: number;
 };
@@ -6,24 +5,22 @@ type UserDetails = {
     uid: string;
     alias?: string;
 };
-type OptionalUserDetails = {
+type EventBase = Timestamp & {
     uid?: string;
     alias?: string;
 };
-export type UseItty<MessageType = any> = {
-    message: MessageType;
-} & UserDetails & Timestamp;
-export type MessageEvent<MessageType = any> = {
-    message: MessageType;
-} & Timestamp & OptionalUserDetails;
+export type IttyProtocol = UserDetails & Timestamp;
+export type MessageEvent<T = any> = {
+    message: T;
+} & EventBase;
 export type JoinEvent = {
     type: 'join';
     users: number;
-} & Timestamp & OptionalUserDetails;
+} & EventBase;
 export type LeaveEvent = {
     type: 'leave';
     users: number;
-} & Timestamp & OptionalUserDetails;
+} & EventBase;
 export type ErrorEvent = {
     type: 'error';
     message: string;
@@ -34,31 +31,44 @@ export type IttySocketOptions = {
     echo?: true;
     announce?: true;
 };
+type EventUnion<Events> = {
+    [K in Exclude<keyof Events & string, 'message'>]: {
+        type: K;
+    } & Events[K];
+}[Exclude<keyof Events & string, 'message'>] | (Events extends {
+    message: infer M;
+} ? M : never);
+type SendFn<Base, Events extends Record<string, any>> = keyof Events extends never ? <T = any>(message: T, ...args: Base extends IttyProtocol ? [uid?: string] : []) => IttySocket<Base, Events> : (message: EventUnion<Events>, ...args: Base extends IttyProtocol ? [uid?: string] : []) => IttySocket<Base, Events>;
 export interface IttySocketConnect {
-    <BaseFormat = object>(...args: BaseFormat extends UseItty ? [channelID: string, options?: IttySocketOptions] : [url: string, queryParams?: any]): IttySocket<BaseFormat>;
+    <Events extends Record<string, any> = Record<string, never>>(url: `ws://${string}` | `wss://${string}`, queryParams?: any): IttySocket<object, Events>;
+    <Events extends Record<string, any> = Record<string, never>>(channelID: string, options?: IttySocketOptions): IttySocket<IttyProtocol, Events>;
 }
-type UseIttyEvents<BaseFormat> = {
-    on(type: 'join', listener: (event: JoinEvent) => any): IttySocket<BaseFormat>;
-    on(type: 'leave', listener: (event: LeaveEvent) => any): IttySocket<BaseFormat>;
-    on(type: 'error', listener: (event: ErrorEvent) => any): IttySocket<BaseFormat>;
-};
-type SendMessage<BaseFormat> = BaseFormat extends UseItty ? <MessageFormat = any>(message: MessageFormat, uid?: string) => IttySocket<BaseFormat> : <MessageFormat = any>(message: MessageFormat) => IttySocket<BaseFormat>;
-export type IttySocket<BaseFormat = object> = {
-    open: () => IttySocket<BaseFormat>;
-    close: () => IttySocket<BaseFormat>;
-    send: SendMessage<BaseFormat>;
-    push: SendMessage<BaseFormat>;
-    remove(type: IttySocketEvent<BaseFormat>, listener: () => any): IttySocket<BaseFormat>;
-    remove(type: string, listener: () => any): IttySocket<BaseFormat>;
-    on(type: 'open', listener: () => any): IttySocket<BaseFormat>;
-    on(type: 'close', listener: () => any): IttySocket<BaseFormat>;
-    on<MessageFormat = BaseFormat>(type: 'message', listener: (event: BaseFormat & MessageFormat) => any): IttySocket<BaseFormat>;
-    on<MessageFormat = BaseFormat>(type: string, listener: (event: BaseFormat & MessageFormat & {
+export type IttySocket<Base = object, Events extends Record<string, any> = Record<string, never>> = {
+    open: () => IttySocket<Base, Events>;
+    close: () => IttySocket<Base, Events>;
+    send: SendFn<Base, Events>;
+    push: SendFn<Base, Events>;
+    remove(type: string, listener: () => any): IttySocket<Base, Events>;
+    on(type: 'open', listener: () => any): IttySocket<Base, Events>;
+    on(type: 'close', listener: () => any): IttySocket<Base, Events>;
+    on<K extends keyof Events & string>(type: K, listener: (event: Base & Events[K] & {
+        type: K;
+        message: Events[K];
+    }) => any): IttySocket<Base, Events>;
+    on<T = any>(type: 'message', listener: (event: Base & {
+        message: T;
+    }) => any): IttySocket<Base, Events>;
+} & (Base extends IttyProtocol ? {
+    on(type: 'join', listener: (event: JoinEvent) => any): IttySocket<Base, Events>;
+    on(type: 'leave', listener: (event: LeaveEvent) => any): IttySocket<Base, Events>;
+    on(type: 'error', listener: (event: ErrorEvent) => any): IttySocket<Base, Events>;
+} : object) & {
+    on<T = Record<string, any>>(type: string, listener: (event: Base & T & {
         type: string;
-    }) => any): IttySocket<BaseFormat>;
-    on<MessageFormat = BaseFormat>(type: (event?: any) => any, listener: (event: BaseFormat & MessageFormat & {
+    }) => any): IttySocket<Base, Events>;
+    on<T = Record<string, any>>(type: (event?: any) => any, listener: (event: Base & T & {
         type: string;
-    }) => any): IttySocket<BaseFormat>;
-} & (BaseFormat extends UseItty ? UseIttyEvents<BaseFormat> : object);
+    }) => any): IttySocket<Base, Events>;
+};
 export declare let connect: IttySocketConnect;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itty-sockets",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "WebSockets : simplified and minified.",
   "type": "module",
   "exports": {
@@ -34,6 +34,6 @@
   },
   "devDependencies": {
     "@types/bun": "^1.2.3",
-    "itty-packager": "^1.7.0"
+    "itty-packager": "^1.8.1"
   }
 }