stelar-time-real 1.2.2 → 2.0.0

package/README.md

@@ -558,6 +558,16 @@ client.emitBinary('upload', fileData);
 
 ## Changelog
 
+### v2.0.0
+- 🎉 **TypeScript!** - Código fuente ahora es TypeScript
+- Tipos completos para IDEs (VS Code, WebStorm, etc.)
+- Autocompletado y verificación de tipos
+- Compatibilidad total con JS (los usuarios reciben archivos .js)
+- Los tipos .d.ts se generan automáticamente
+
+### v1.2.3
+- Cleanup: código fantasma eliminado (_parent, _children, _externalServer)
+
 ### v1.2.2
 - Bugfix: métodos duplicados en client.js
 

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "stelar-time-real",
-  "version": "1.2.2",
-  "description": "WebSocket liviano y rápido sin dependecias. Alternativa a socket.io, namespaces, ACKs y archivos binarios.",
-  "main": "src/index.js",
+  "version": "2.0.0",
+  "description": "WebSocket liviano y rápido sin dependendas en TypeScript. Alternativa a socket.io, namespaces, ACKs y archivos binarios.",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "websocket",
     "real-time",
@@ -33,5 +38,9 @@
   ],
   "dependencies": {
     "ws": "^8.14.0"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.10",
+    "typescript": "^5.3.0"
   }
 }

package/src/client.d.ts

@@ -0,0 +1,52 @@
+export interface StelarClientOptions {
+    reconnection?: boolean;
+    reconnectionAttempts?: number;
+    reconnectionDelay?: number;
+    heartbeatInterval?: number;
+    ackTimeout?: number;
+}
+export interface StelarEmitOptions {
+    ack?: string;
+}
+export type StelarEventHandler = (data: unknown) => void;
+export type StelarBinaryHandler = (buffer: ArrayBuffer) => void;
+declare class StelarClient {
+    private url;
+    private options;
+    private ws;
+    private events;
+    private _wildcardHandler;
+    private connected;
+    private id;
+    private _reconnectAttempts;
+    private _hbTimer;
+    private _isManualClose;
+    private _acks;
+    constructor(urlOrPort?: string | number, options?: StelarClientOptions);
+    setUrl(url: string): this;
+    on(event: string, handler: StelarEventHandler): this;
+    off(event: string, handler: StelarEventHandler): this;
+    onAll(handler: (data: {
+        event: string;
+        data: unknown;
+        isBinary?: boolean;
+        buffer?: ArrayBuffer;
+    }) => void): this;
+    onAck(name: string, handler: StelarEventHandler): this;
+    emit(event: string, data?: unknown, opts?: StelarEmitOptions): this;
+    emitBinary(event: string, data: ArrayBuffer): this;
+    sendFile(file: ArrayBuffer): this;
+    sendImage(blob: ArrayBuffer): this;
+    request(event: string, data: unknown, ackName: string): Promise<unknown>;
+    joinRoom(room: string): this;
+    leaveRoom(): this;
+    private startHeartbeat;
+    private stopHeartbeat;
+    private _connect;
+    connect(callback?: () => void): this;
+    disconnect(): this;
+    isConnected(): boolean;
+    getUrl(): string;
+}
+export default StelarClient;
+//# sourceMappingURL=client.d.ts.map

package/src/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["client.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;AACzD,MAAM,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;AAEhE,cAAM,YAAY;IAChB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,OAAO,CAAgC;IAC/C,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,MAAM,CAAyC;IACvD,OAAO,CAAC,gBAAgB,CAA6G;IACrI,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,EAAE,CAAuB;IACjC,OAAO,CAAC,kBAAkB,CAAK;IAC/B,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,KAAK,CAAyC;gBAE1C,SAAS,GAAE,MAAM,GAAG,MAAyB,EAAE,OAAO,GAAE,mBAAwB;IAkB5F,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKzB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAKpD,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAOrD,KAAK,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,GAAG,IAAI;IAKhH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAKtD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,GAAE,iBAAsB,GAAG,IAAI;IAWvE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,IAAI;IAalD,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAIjC,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAIlC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBxE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK5B,SAAS,IAAI,IAAI;IAKjB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,QAAQ;IAgFhB,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAapC,UAAU,IAAI,IAAI;IAOlB,WAAW,IAAI,OAAO;IAItB,MAAM,IAAI,MAAM;CAGjB;AAED,eAAe,YAAY,CAAC"}

package/src/client.js

@@ -1,237 +1,215 @@
 class StelarClient {
-  constructor(urlOrPort = 'localhost:3000', options = {}) {
-    if (typeof urlOrPort === 'number') {
-      this.url = `ws://localhost:${urlOrPort}`;
-    } else if (urlOrPort.includes('://')) {
-      this.url = urlOrPort.startsWith('http') ? 'ws' + urlOrPort.slice(4) : urlOrPort;
-    } else {
-      this.url = `ws://${urlOrPort}`;
-    }
-
-    this.options = {
-      reconnection: options.reconnection !== false,
-      reconnectionAttempts: options.reconnectionAttempts || 5,
-      reconnectionDelay: options.reconnectionDelay || 1000,
-      heartbeatInterval: options.heartbeatInterval || 30000,
-      ackTimeout: options.ackTimeout || 5000
-    };
-
-    this.ws = null;
-    this.events = {};
-    this._wildcardHandler = null;
-    this.connected = false;
-    this.id = null;
-    this._reconnectAttempts = 0;
-    this._hbTimer = null;
-    this._isManualClose = false;
-    this._acks = {};
-  }
-
-  setUrl(url) {
-    this.url = url;
-    return this;
-  }
-
-  on(event, handler) {
-    this.events[event] = handler;
-    return this;
-  }
-
-  off(event, handler) {
-    if (this.events[event] === handler) {
-      delete this.events[event];
-    }
-    return this;
-  }
-
-  onAll(handler) {
-    this._wildcardHandler = handler;
-    return this;
-  }
-
-  onAck(name, handler) {
-    this._acks[name] = handler;
-    return this;
-  }
-
-  emit(event, data, opts = {}) {
-    if (this.ws && this.ws.readyState === WebSocket.OPEN) {
-      const payload = { event, data };
-      if (opts.ack) {
-        payload._ackName = opts.ack;
-      }
-      this.ws.send(JSON.stringify(payload));
-    }
-    return this;
-  }
-
-  emitBinary(event, data) {
-    if (this.ws && this.ws.readyState === WebSocket.OPEN) {
-      const header = JSON.stringify({ event });
-      const headerBytes = new TextEncoder().encode(header);
-      const combined = new Uint8Array(headerBytes.length + 1 + data.byteLength);
-      combined.set(headerBytes, 0);
-      combined[headerBytes.length] = 0;
-      combined.set(new Uint8Array(data), headerBytes.length + 1);
-      this.ws.send(combined);
-    }
-    return this;
-  }
-
-  sendFile(file) {
-    return this.emitBinary('file', file);
-  }
-
-  sendImage(blob) {
-    return this.emitBinary('image', blob);
-  }
-
-  request(event, data, ackName) {
-    return new Promise((resolve, reject) => {
-      const timeout = setTimeout(() => {
-        reject(new Error(`ACK '${ackName}' timeout`));
-      }, this.options.ackTimeout);
-
-      const handler = (responseData) => {
-        clearTimeout(timeout);
-        this.off(ackName, handler);
-        resolve(responseData);
-      };
-
-      this.on(ackName, handler);
-      this.emit(event, data, { ack: ackName });
-    });
-  }
-
-  joinRoom(room) {
-    this.emit('join-room', room);
-    return this;
-  }
-
-  leaveRoom() {
-    this.emit('leave-room', {});
-    return this;
-  }
-
-  _startHeartbeat() {
-    this._hbTimer = setInterval(() => {
-      if (this.ws && this.ws.readyState === WebSocket.OPEN) {
-        this.emit('pong', Date.now());
-      }
-    }, this.options.heartbeatInterval);
-  }
-
-  _stopHeartbeat() {
-    if (this._hbTimer) {
-      clearInterval(this._hbTimer);
-      this._hbTimer = null;
-    }
-  }
-
-  _connect() {
-    this._isManualClose = false;
-    this.ws = new WebSocket(this.url);
-
-    this.ws.onopen = () => {
-      this.connected = true;
-      this._reconnectAttempts = 0;
-      if (this.events['connect']) this.events['connect']();
-      this._startHeartbeat();
-    };
-
-    this.ws.binaryType = 'arraybuffer';
-
-    this.ws.onmessage = (e) => {
-      try {
-        if (e.data instanceof ArrayBuffer) {
-          const view = new Uint8Array(e.data);
-          let headerEnd = -1;
-          for (let i = 0; i < view.length; i++) {
-            if (view[i] === 0) {
-              headerEnd = i;
-              break;
+    constructor(urlOrPort = 'localhost:3000', options = {}) {
+        this.ws = null;
+        this.events = new Map();
+        this._wildcardHandler = null;
+        this.connected = false;
+        this.id = null;
+        this._reconnectAttempts = 0;
+        this._hbTimer = null;
+        this._isManualClose = false;
+        this._acks = new Map();
+        if (typeof urlOrPort === 'number') {
+            this.url = `ws://localhost:${urlOrPort}`;
+        }
+        else if (urlOrPort.includes('://')) {
+            this.url = urlOrPort.startsWith('http') ? 'ws' + urlOrPort.slice(4) : urlOrPort;
+        }
+        else {
+            this.url = `ws://${urlOrPort}`;
+        }
+        this.options = {
+            reconnection: options.reconnection !== false,
+            reconnectionAttempts: options.reconnectionAttempts || 5,
+            reconnectionDelay: options.reconnectionDelay || 1000,
+            heartbeatInterval: options.heartbeatInterval || 30000,
+            ackTimeout: options.ackTimeout || 5000
+        };
+    }
+    setUrl(url) {
+        this.url = url;
+        return this;
+    }
+    on(event, handler) {
+        this.events.set(event, handler);
+        return this;
+    }
+    off(event, handler) {
+        if (this.events.get(event) === handler) {
+            this.events.delete(event);
+        }
+        return this;
+    }
+    onAll(handler) {
+        this._wildcardHandler = handler;
+        return this;
+    }
+    onAck(name, handler) {
+        this._acks.set(name, handler);
+        return this;
+    }
+    emit(event, data, opts = {}) {
+        if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+            const payload = { event, data };
+            if (opts.ack) {
+                payload._ackName = opts.ack;
             }
-          }
-          if (headerEnd === -1) return;
-
-          const headerStr = new TextDecoder().decode(view.slice(0, headerEnd));
-          const header = JSON.parse(headerStr);
-          const buffer = view.slice(headerEnd + 1);
-
-          if (this.events[header.event]) {
-            this.events[header.event](buffer);
-          }
-          if (this._wildcardHandler) {
-            this._wildcardHandler({ event: header.event, data: buffer, buffer, isBinary: true });
-          }
-          return;
+            this.ws.send(JSON.stringify(payload));
         }
-
-        const msg = JSON.parse(e.data);
-        const { event, data, _isAck } = msg;
-
-        if (event === 'ping') return;
-
-        if (_isAck && this._acks[event]) {
-          this._acks[event](data);
-          return;
+        return this;
+    }
+    emitBinary(event, data) {
+        if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+            const header = JSON.stringify({ event });
+            const headerBytes = new TextEncoder().encode(header);
+            const combined = new Uint8Array(headerBytes.length + 1 + data.byteLength);
+            combined.set(headerBytes, 0);
+            combined[headerBytes.length] = 0;
+            combined.set(new Uint8Array(data), headerBytes.length + 1);
+            this.ws.send(combined);
         }
-
-        if (this.events[event]) this.events[event](data);
-
-        if (this._wildcardHandler) {
-          this._wildcardHandler({ event, data });
+        return this;
+    }
+    sendFile(file) {
+        return this.emitBinary('file', file);
+    }
+    sendImage(blob) {
+        return this.emitBinary('image', blob);
+    }
+    request(event, data, ackName) {
+        return new Promise((resolve, reject) => {
+            const timeout = setTimeout(() => {
+                reject(new Error(`ACK '${ackName}' timeout`));
+            }, this.options.ackTimeout);
+            const handler = (responseData) => {
+                clearTimeout(timeout);
+                this._acks.delete(ackName);
+                resolve(responseData);
+            };
+            this._acks.set(ackName, handler);
+            this.emit(event, data, { ack: ackName });
+        });
+    }
+    joinRoom(room) {
+        this.emit('join-room', room);
+        return this;
+    }
+    leaveRoom() {
+        this.emit('leave-room', {});
+        return this;
+    }
+    startHeartbeat() {
+        this._hbTimer = setInterval(() => {
+            if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+                this.emit('pong', Date.now());
+            }
+        }, this.options.heartbeatInterval);
+    }
+    stopHeartbeat() {
+        if (this._hbTimer) {
+            clearInterval(this._hbTimer);
+            this._hbTimer = null;
         }
-      } catch (err) {}
-    };
-
-    this.ws.onclose = () => {
-      this.connected = false;
-      this._stopHeartbeat();
-      if (this.events['disconnect']) this.events['disconnect']();
-
-      if (!this._isManualClose && this.options.reconnection && this._reconnectAttempts < this.options.reconnectionAttempts) {
-        this._reconnectAttempts++;
-        if (this.events['reconnecting']) this.events['reconnecting'](this._reconnectAttempts);
-        setTimeout(() => this._connect(), this.options.reconnectionDelay * this._reconnectAttempts);
-      }
-    };
-
-    this.ws.onerror = (err) => {
-      if (this.events['error']) this.events['error'](err);
-    };
-
-    return this;
-  }
-
-  connect(callback) {
-    this._connect();
-    if (callback) {
-      const checkConnection = setInterval(() => {
-        if (this.connected) {
-          clearInterval(checkConnection);
-          callback();
+    }
+    _connect() {
+        this._isManualClose = false;
+        this.ws = new WebSocket(this.url);
+        this.ws.onopen = () => {
+            this.connected = true;
+            this._reconnectAttempts = 0;
+            const handler = this.events.get('connect');
+            if (handler)
+                handler(undefined);
+            this.startHeartbeat();
+        };
+        this.ws.binaryType = 'arraybuffer';
+        this.ws.onmessage = (e) => {
+            try {
+                if (e.data instanceof ArrayBuffer) {
+                    const view = new Uint8Array(e.data);
+                    let headerEnd = -1;
+                    for (let i = 0; i < view.length; i++) {
+                        if (view[i] === 0) {
+                            headerEnd = i;
+                            break;
+                        }
+                    }
+                    if (headerEnd === -1)
+                        return;
+                    const headerStr = new TextDecoder().decode(view.slice(0, headerEnd));
+                    const header = JSON.parse(headerStr);
+                    const buffer = view.slice(headerEnd + 1);
+                    const handler = this.events.get(header.event);
+                    if (handler) {
+                        handler(buffer.buffer);
+                    }
+                    else if (this._wildcardHandler) {
+                        this._wildcardHandler({ event: header.event, data: buffer.buffer, isBinary: true, buffer: buffer.buffer });
+                    }
+                    return;
+                }
+                const msg = JSON.parse(e.data);
+                const { event, data, _isAck } = msg;
+                if (event === 'ping')
+                    return;
+                if (_isAck && this._acks.has(event)) {
+                    const handler = this._acks.get(event);
+                    handler(data);
+                    return;
+                }
+                const handler = this.events.get(event);
+                if (handler)
+                    handler(data);
+                if (this._wildcardHandler) {
+                    this._wildcardHandler({ event, data });
+                }
+            }
+            catch { }
+        };
+        this.ws.onclose = () => {
+            this.connected = false;
+            this.stopHeartbeat();
+            const handler = this.events.get('disconnect');
+            if (handler)
+                handler(undefined);
+            if (!this._isManualClose && this.options.reconnection && this._reconnectAttempts < this.options.reconnectionAttempts) {
+                this._reconnectAttempts++;
+                const reconHandler = this.events.get('reconnecting');
+                if (reconHandler)
+                    reconHandler(this._reconnectAttempts);
+                setTimeout(() => this.connect(), this.options.reconnectionDelay * this._reconnectAttempts);
+            }
+        };
+        this.ws.onerror = (err) => {
+            const handler = this.events.get('error');
+            if (handler)
+                handler(err);
+        };
+    }
+    connect(callback) {
+        this._connect();
+        if (callback) {
+            const checkConnection = setInterval(() => {
+                if (this.connected) {
+                    clearInterval(checkConnection);
+                    callback();
+                }
+            }, 100);
         }
-      }, 100);
-    }
-    return this;
-  }
-
-  disconnect() {
-    this._isManualClose = true;
-    this._stopHeartbeat();
-    if (this.ws) this.ws.close();
-    return this;
-  }
-
-  isConnected() {
-    return this.connected;
-  }
-
-  getUrl() {
-    return this.url;
-  }
+        return this;
+    }
+    disconnect() {
+        this._isManualClose = true;
+        this.stopHeartbeat();
+        if (this.ws)
+            this.ws.close();
+        return this;
+    }
+    isConnected() {
+        return this.connected;
+    }
+    getUrl() {
+        return this.url;
+    }
 }
-
-if (typeof window !== 'undefined') window.StelarClient = StelarClient;
-export default StelarClient;
+export default StelarClient;