@folklore/socket 0.4.30 → 0.4.33

package/dist/{es.js → index.js}

@@ -1,14 +1,17 @@
-import createDebug from 'debug';
+import { EventEmitter } from '@folklore/events';
 import invariant from 'invariant';
 import isFunction from 'lodash/isFunction';
-import EventEmitter from 'wolfy87-eventemitter';
 import isString from 'lodash/isString';
+import createDebug from 'debug';
 import isArray from 'lodash/isArray';
-import React, { useMemo, useState, useRef, useCallback, useEffect, useContext } from 'react';
-import PropTypes from 'prop-types';
+import { createContext, useMemo, useState, useRef, useCallback, useEffect, useContext } from 'react';
 import { jsx } from 'react/jsx-runtime';
 
-const debug$3 = createDebug('folklore:socket:pubnub');
+let debug = createDebug('folklore:socket');
+function setDebug(newDebug) {
+  debug = isString(newDebug) ? createDebug(newDebug) : newDebug;
+}
+
 class PubNubSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -58,7 +61,7 @@ class PubNubSocket extends EventEmitter {
     }
   }
   updateChannels(channels) {
-    debug$3(`Updating channels: ${channels.join(', ')}`);
+    debug(`[PubNub] Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -77,13 +80,13 @@ class PubNubSocket extends EventEmitter {
     if (this.pubnub !== null) {
       return;
     }
-    debug$3('Init');
+    debug('[PubNub] Init');
     this.destroyed = false;
     const loadPubnub = this.PubNub !== null ? Promise.resolve() : this.loadPubNub();
     loadPubnub.then(() => this.createPubNub()).then(() => this.onReady());
   }
   loadPubNub() {
-    debug$3('Load PubNub');
+    debug('[PubNub] Load library');
     return import('pubnub').then(({
       default: PubNub
     }) => {
@@ -94,6 +97,7 @@ class PubNubSocket extends EventEmitter {
     if (this.destroyed) {
       return;
     }
+    debug('[PubNub] Create client');
     const {
       PubNub
     } = this;
@@ -127,19 +131,19 @@ class PubNubSocket extends EventEmitter {
     }
     this.pubnub = null;
     this.ready = false;
-    debug$3('Destroyed.');
+    debug('[PubNub] Destroyed.');
   }
   start() {
     if (this.started) {
-      debug$3('Skipping start: Already started.');
+      debug('[PubNub] Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$3('Skipping start: Already starting.');
+      debug('[PubNub] Skipping start: Already starting.');
       return;
     }
     if (this.channels.length === 0) {
-      debug$3('Skipping start: No channels.');
+      debug('[PubNub] Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -151,7 +155,7 @@ class PubNubSocket extends EventEmitter {
     this.starting = true;
     this.pubnub.subscribe({
       channels: this.channels,
-      subscriptionOptions,
+      ...(subscriptionOptions || {}),
       withPresence
     });
     this.emit('start');
@@ -160,7 +164,7 @@ class PubNubSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$3('Stopping...');
+    debug('[PubNub] Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -170,7 +174,7 @@ class PubNubSocket extends EventEmitter {
     this.emit('stop');
   }
   send(data) {
-    debug$3('Sending', data);
+    debug('[PubNub] Sending', data);
     return new Promise((resolve, reject) => {
       this.pubnub.publish(data, (status, response) => {
         if (status.error) {
@@ -187,160 +191,6 @@ class PubNubSocket extends EventEmitter {
   }
 }
 
-const debug$2 = createDebug('folklore:socket:socketio');
-class SocketIOSocket extends EventEmitter {
-  constructor(opts) {
-    super();
-    this.options = {
-      uuid: null,
-      host: 'http://127.0.0.1',
-      path: null,
-      query: null,
-      ...opts
-    };
-    this.onReady = this.onReady.bind(this);
-    this.onConnect = this.onConnect.bind(this);
-    this.onMessage = this.onMessage.bind(this);
-    this.ready = false;
-    this.shouldStart = false;
-    this.started = false;
-    this.starting = false;
-    this.Manager = null;
-    this.io = null;
-    this.sockets = {};
-    this.channels = [];
-    this.init();
-  }
-  onReady() {
-    this.ready = true;
-    this.emit('ready');
-  }
-  onConnect(channel) {
-    debug$2('Socket connected on %s', channel);
-    if (!this.started) {
-      this.started = true;
-      this.starting = false;
-      this.emit('started');
-    }
-  }
-  onMessage(message, channel) {
-    debug$2('Message received on %s %o', channel, message);
-    this.emit('message', message, channel);
-  }
-  init() {
-    import('socket.io-client').then(({
-      default: IO
-    }) => {
-      this.Manager = IO.Manager;
-    }).then(() => this.createManager()).then(() => this.onReady()).then(() => {
-      if (this.shouldStart) {
-        this.start();
-      }
-    });
-  }
-  createManager() {
-    const {
-      Manager
-    } = this;
-    const {
-      host,
-      ...opts
-    } = this.options;
-    this.io = new Manager(host, {
-      autoConnect: false,
-      ...opts
-    });
-  }
-  updateChannels(channels) {
-    debug$2(`Updating channels: ${channels.join(', ')}`);
-    const {
-      shouldStart,
-      started,
-      starting
-    } = this;
-    if (started || starting) {
-      this.stop();
-    }
-    this.channels = channels;
-    if (started || starting || shouldStart) {
-      this.start();
-    }
-  }
-  start() {
-    if (this.started) {
-      debug$2('Skipping start: Already started.');
-      return;
-    }
-    if (this.starting) {
-      debug$2('Skipping start: Already starting.');
-      return;
-    }
-    if (this.io === null) {
-      debug$2('Socket.io not ready.');
-      this.shouldStart = true;
-      return;
-    }
-    if (this.channels.length === 0) {
-      debug$2('Skipping start: No channels.');
-      this.shouldStart = true;
-      return;
-    }
-    this.shouldStart = false;
-    this.starting = true;
-    this.sockets = this.channels.reduce((map, channel) => ({
-      ...map,
-      [channel]: this.createSocket(channel)
-    }), {});
-    this.emit('start');
-  }
-  stop() {
-    if (!this.started && !this.starting) {
-      return;
-    }
-    debug$2('Stopping...');
-    this.shouldStart = false;
-    this.started = false;
-    this.starting = false;
-    Object.values(this.sockets).forEach(socket => this.stopSocket(socket));
-    this.emit('stop');
-  }
-  createSocket(channel) {
-    const socket = this.io.socket(`/${channel.replace(/^\//, '')}`);
-    socket.on('message', message => this.onMessage(message, channel));
-    socket.on('connect', () => this.onConnect(channel));
-    socket.open();
-    return socket;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  stopSocket(socket) {
-    socket.off('connect');
-    socket.off('message');
-    socket.close();
-    return socket;
-  }
-  destroy() {
-    this.stop();
-    this.sockets = {};
-    if (this.io !== null) {
-      this.io.close();
-      this.io = null;
-    }
-  }
-  send(data) {
-    const {
-      channel,
-      message
-    } = data;
-    const channels = !isArray(channel) ? [channel] : channel;
-    channels.forEach(ch => {
-      this.sockets[ch].send(message);
-    });
-    return Promise.resolve();
-  }
-}
-
-const debug$1 = createDebug('folklore:socket:pusher');
 class PusherSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -384,7 +234,7 @@ class PusherSocket extends EventEmitter {
     }
   }
   updateChannels(channels) {
-    debug$1(`Updating channels: ${channels.join(', ')}`);
+    debug(`Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -403,13 +253,13 @@ class PusherSocket extends EventEmitter {
     if (this.pusher !== null) {
       return;
     }
-    debug$1('Init');
+    debug('[Pusher] Init');
     this.destroyed = false;
     const loadPusher = this.Pusher !== null ? Promise.resolve() : this.loadPusher();
     loadPusher.then(() => this.createPusher()).then(() => this.onReady());
   }
   loadPusher() {
-    debug$1('Load Pusher');
+    debug('[Pusher] Load Pusher');
     return import('pusher-js').then(({
       default: Pusher
     }) => {
@@ -420,7 +270,7 @@ class PusherSocket extends EventEmitter {
     if (this.destroyed) {
       return;
     }
-    debug$1('Create Pusher appKey: %s', this.options.appKey);
+    debug('[Pusher] Create Pusher appKey: %s', this.options.appKey);
     const {
       Pusher
     } = this;
@@ -436,24 +286,24 @@ class PusherSocket extends EventEmitter {
     this.pusher = null;
     this.clients = {};
     this.ready = false;
-    debug$1('Destroyed.');
+    debug('[Pusher] Destroyed.');
   }
   start() {
     if (this.started) {
-      debug$1('Skipping start: Already started.');
+      debug('[Pusher] Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$1('Skipping start: Already starting.');
+      debug('[Pusher] Skipping start: Already starting.');
       return;
     }
     if (this.pusher === null) {
-      debug$1('Socket.io not ready.');
+      debug('[Pusher] Socket.io not ready.');
       this.shouldStart = true;
       return;
     }
     if (this.channels.length === 0) {
-      debug$1('Skipping start: No channels.');
+      debug('[Pusher] Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -470,7 +320,7 @@ class PusherSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$1('Stopping...');
+    debug('[Pusher] Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -483,28 +333,176 @@ class PusherSocket extends EventEmitter {
     const channel = this.pusher.subscribe(channelName);
     channel.bind_global((event, data) => this.onMessage({
       event,
-      data
-    }, channel));
+      data,
+      channel
+    }));
     return channel;
   }
-
-  // eslint-disable-next-line class-methods-use-this
   stopClient(channelName, channel) {
     channel.unbind_global();
     this.pusher.unsubscribe(channelName);
     return channel;
   }
   send(data) {
-    debug$1('Sending', data);
+    debug('[Pusher] Sending', data);
     return new Promise(resolve => {
       const {
         channel,
         event = null,
         data: eventData
       } = data;
-      this.pusher.trigger(channel, event || 'message', eventData);
-      resolve();
+      this.pusher.send_event(event || 'message', eventData, channel);
+      resolve(data);
+    });
+  }
+}
+
+class SocketIOSocket extends EventEmitter {
+  constructor(opts) {
+    super();
+    this.options = {
+      uuid: null,
+      host: 'http://127.0.0.1',
+      path: null,
+      query: null,
+      ...opts
+    };
+    this.onReady = this.onReady.bind(this);
+    this.onConnect = this.onConnect.bind(this);
+    this.onMessage = this.onMessage.bind(this);
+    this.ready = false;
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    this.Manager = null;
+    this.io = null;
+    this.sockets = {};
+    this.channels = [];
+    this.init();
+  }
+  onReady() {
+    this.ready = true;
+    this.emit('ready');
+  }
+  onConnect(channel) {
+    debug('[socket.io] Socket connected on %s', channel);
+    if (!this.started) {
+      this.started = true;
+      this.starting = false;
+      this.emit('started');
+    }
+  }
+  onMessage(message, channel) {
+    debug('[socket.io] Message received on %s %o', channel, message);
+    this.emit('message', message);
+  }
+  init() {
+    import('socket.io-client').then(({
+      Manager
+    }) => {
+      this.Manager = Manager;
+    }).then(() => this.createManager()).then(() => this.onReady()).then(() => {
+      if (this.shouldStart) {
+        this.start();
+      }
+    });
+  }
+  createManager() {
+    const {
+      Manager
+    } = this;
+    const {
+      host,
+      ...opts
+    } = this.options;
+    this.io = new Manager(host, {
+      autoConnect: false,
+      ...opts
+    });
+  }
+  updateChannels(channels) {
+    debug(`[socket.io] Updating channels: ${channels.join(', ')}`);
+    const {
+      shouldStart,
+      started,
+      starting
+    } = this;
+    if (started || starting) {
+      this.stop();
+    }
+    this.channels = channels;
+    if (started || starting || shouldStart) {
+      this.start();
+    }
+  }
+  start() {
+    if (this.started) {
+      debug('[socket.io] Skipping start: Already started.');
+      return;
+    }
+    if (this.starting) {
+      debug('[socket.io] Skipping start: Already starting.');
+      return;
+    }
+    if (this.io === null) {
+      debug('[socket.io] not ready.');
+      this.shouldStart = true;
+      return;
+    }
+    if (this.channels.length === 0) {
+      debug('[socket.io] Skipping start: No channels.');
+      this.shouldStart = true;
+      return;
+    }
+    this.shouldStart = false;
+    this.starting = true;
+    this.sockets = this.channels.reduce((map, channel) => ({
+      ...map,
+      [channel]: this.createSocket(channel)
+    }), {});
+    this.emit('start');
+  }
+  stop() {
+    if (!this.started && !this.starting) {
+      return;
+    }
+    debug('[socket.io] Stopping...');
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    Object.values(this.sockets).forEach(socket => this.stopSocket(socket));
+    this.emit('stop');
+  }
+  createSocket(channel) {
+    const socket = this.io.socket(`/${channel.replace(/^\//, '')}`);
+    socket.on('message', message => this.onMessage(message, channel));
+    socket.on('connect', () => this.onConnect(channel));
+    socket.open();
+    return socket;
+  }
+  stopSocket(socket) {
+    socket.off('connect');
+    socket.off('message');
+    socket.close();
+    return socket;
+  }
+  destroy() {
+    this.stop();
+    this.sockets = {};
+    if (this.io !== null) {
+      this.io = null;
+    }
+  }
+  send(data) {
+    const {
+      channel,
+      message
+    } = data;
+    const channels = !isArray(channel) ? [channel] : channel;
+    channels.forEach(ch => {
+      this.sockets[ch].send(message);
     });
+    return Promise.resolve();
   }
 }
 
@@ -515,8 +513,8 @@ var SocketAdapters = {
 };
 
 const normalize = str => str.replace(/[^a-z0-9]+/gi, '').toLowerCase();
-const debug = createDebug('folklore:socket');
 class Socket extends EventEmitter {
+  static adapters = {};
   static getAdapters() {
     return Socket.adapters;
   }
@@ -668,6 +666,8 @@ class Socket extends EventEmitter {
       return;
     }
     debug('Init');
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const {
       adapter: adapterKey,
       channels,
@@ -752,49 +752,24 @@ Socket.adapters = {
   ...SocketAdapters
 };
 
-const SocketContext = /*#__PURE__*/React.createContext({
+const SocketContext = /*#__PURE__*/createContext({
   socket: null,
   subscribe: () => {},
-  unsubscribe: () => {}
+  unsubscribe: () => {},
+  channels: []
 });
 
-const propTypes = {
-  socket: PropTypes.instanceOf(Socket),
-  adapter: PropTypes.string,
-  host: PropTypes.string,
-  namespace: PropTypes.string,
-  uuid: PropTypes.string,
-  publishKey: PropTypes.string,
-  subscribeKey: PropTypes.string,
-  secretKey: PropTypes.string,
-  channels: PropTypes.arrayOf(PropTypes.string),
-  autoStart: PropTypes.bool,
-  children: PropTypes.node
-};
-const defaultProps = {
-  socket: null,
-  adapter: 'pubnub',
-  host: null,
-  namespace: null,
-  uuid: null,
-  publishKey: null,
-  subscribeKey: null,
-  secretKey: null,
-  channels: [],
-  autoStart: false,
-  children: null
-};
 function SocketContainer({
-  children,
-  socket,
-  autoStart,
-  adapter,
-  host,
-  namespace,
-  uuid,
-  publishKey,
-  subscribeKey,
-  secretKey,
+  children = null,
+  socket = null,
+  autoStart = false,
+  adapter = 'pubnub',
+  host = null,
+  namespace = null,
+  uuid = null,
+  publishKey = null,
+  subscribeKey = null,
+  secretKey = null,
   channels: initialChannels,
   ...props
 }) {
@@ -835,14 +810,14 @@ function SocketContainer({
     }, channelsCountRef.current);
     updateChannels(Object.keys(channelsCountRef.current));
   }, [updateChannels]);
-  const subscribe = useCallback(channelsToAdd => addToChannelsCount(channelsToAdd), [addToChannelsCount]);
-  const unsubscribe = useCallback(channelsToRemove => removeToChannelsCount(channelsToRemove), [removeToChannelsCount]);
+  const subscribe = useCallback(channelsToAdd => addToChannelsCount(isString(channelsToAdd) ? [channelsToAdd] : channelsToAdd), [addToChannelsCount]);
+  const unsubscribe = useCallback(channelsToRemove => removeToChannelsCount(isString(channelsToRemove) ? [channelsToRemove] : channelsToRemove), [removeToChannelsCount]);
   useEffect(() => {
-    subscribe(initialChannels);
+    subscribe(initialChannels || []);
     return () => {
-      unsubscribe(initialChannels);
+      unsubscribe(initialChannels || []);
     };
-  }, [initialChannels, subscribe, unsubscribe]);
+  }, [initialChannels || [], subscribe, unsubscribe]);
   useEffect(() => {
     finalSocket.init();
     if (autoStart) {
@@ -863,8 +838,6 @@ function SocketContainer({
     children: children
   });
 }
-SocketContainer.propTypes = propTypes;
-SocketContainer.defaultProps = defaultProps;
 
 const getDisplayName = WrappedComponent => WrappedComponent.displayName || WrappedComponent.name || 'Component';
 const withSocket = WrappedComponent => {
@@ -884,11 +857,12 @@ const withSocket = WrappedComponent => {
   return WithSocketComponent;
 };
 
-const useSocket = (channelNames = null, {
-  socket: customSocket = null,
-  onMessage: customOnMessage = null,
-  keepAlive = true
-} = {}) => {
+function useSocket(channelNames = null, opts = {}) {
+  const {
+    socket: customSocket = null,
+    onMessage: customOnMessage = null,
+    keepAlive = true
+  } = opts || {};
   const {
     socket: contextSocket,
     subscribe,
@@ -947,6 +921,6 @@ const useSocket = (channelNames = null, {
     subscribe,
     unsubscribe
   };
-};
+}
 
-export { Socket, SocketContainer, SocketContext, Socket as default, useSocket, withSocket };
+export { Socket, SocketContainer, SocketContext, debug, Socket as default, setDebug, useSocket, withSocket };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@folklore/socket",
-    "version": "0.4.30",
+    "version": "0.4.33",
     "description": "Socket utilities",
     "keywords": [
         "javascript",
@@ -27,26 +27,34 @@
             "email": "nrb@folklore.email"
         }
     ],
-    "main": "dist/cjs.js",
-    "module": "dist/es.js",
+    "type": "module",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+        ".": {
+            "default": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
     "files": [
         "dist"
     ],
     "scripts": {
-        "clean": "rm -rf dist",
-        "build": "rollup --bundleConfigAsCjs --config ../../rollup.config.js",
-        "prepublishOnly": "npm run clean && npm run build"
+        "build": "../../scripts/prepare-package.sh --types",
+        "prepublishOnly": "npm run build"
+    },
+    "publishConfig": {
+        "access": "public"
     },
     "dependencies": {
         "@babel/runtime": "^7.4.3",
+        "@folklore/events": "^0.0.12",
         "debug": "^3.1.0",
         "invariant": "^2.2.2",
         "lodash": "^4.17.4",
-        "prop-types": "^15.6.0",
         "pubnub": "^10.1.0",
         "pusher-js": "^8.0.0",
-        "socket.io-client": "^4.1.2",
-        "wolfy87-eventemitter": "^5.2.4"
+        "socket.io-client": "^4.1.2"
     },
     "devDependencies": {
         "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
@@ -56,5 +64,5 @@
         "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
         "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
     },
-    "gitHead": "ac2a28eb9ac66baf8b2203307806e752719e771c"
+    "gitHead": "560661f2ec3b2be074323a5501b55ab452728168"
 }