@folklore/socket 0.4.17 → 0.4.19

package/dist/cjs.js

@@ -6,13 +6,13 @@ var createDebug = require('debug');
 var invariant = require('invariant');
 var isFunction = require('lodash/isFunction');
 var EventEmitter = require('wolfy87-eventemitter');
+var isString = require('lodash/isString');
 var isArray = require('lodash/isArray');
 var React = require('react');
 var PropTypes = require('prop-types');
 var jsxRuntime = require('react/jsx-runtime');
-var isString = require('lodash/isString');
 
-const debug$2 = createDebug('folklore:socket:pubnub');
+const debug$3 = createDebug('folklore:socket:pubnub');
 class PubNubSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -61,7 +61,7 @@ class PubNubSocket extends EventEmitter {
     }
   }
   updateChannels(channels) {
-    debug$2(`Updating channels: ${channels.join(', ')}`);
+    debug$3(`Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -80,13 +80,13 @@ class PubNubSocket extends EventEmitter {
     if (this.pubnub !== null) {
       return;
     }
-    debug$2('Init');
+    debug$3('Init');
     this.destroyed = false;
     const loadPubnub = this.PubNub !== null ? Promise.resolve() : this.loadPubNub();
     loadPubnub.then(() => this.createPubNub()).then(() => this.onReady());
   }
   loadPubNub() {
-    debug$2('Load PubNub');
+    debug$3('Load PubNub');
     return import('pubnub').then(_ref2 => {
       let {
         default: PubNub
@@ -127,19 +127,19 @@ class PubNubSocket extends EventEmitter {
     }
     this.pubnub = null;
     this.ready = false;
-    debug$2('Destroyed.');
+    debug$3('Destroyed.');
   }
   start() {
     if (this.started) {
-      debug$2('Skipping start: Already started.');
+      debug$3('Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$2('Skipping start: Already starting.');
+      debug$3('Skipping start: Already starting.');
       return;
     }
     if (this.channels.length === 0) {
-      debug$2('Skipping start: No channels.');
+      debug$3('Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -154,7 +154,7 @@ class PubNubSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$2('Stopping...');
+    debug$3('Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -164,7 +164,7 @@ class PubNubSocket extends EventEmitter {
     this.emit('stop');
   }
   send(data) {
-    debug$2('Sending', data);
+    debug$3('Sending', data);
     return new Promise((resolve, reject) => {
       this.pubnub.publish(data, (status, response) => {
         if (status.error) {
@@ -181,7 +181,7 @@ class PubNubSocket extends EventEmitter {
   }
 }
 
-const debug$1 = createDebug('folklore:socket:socketio');
+const debug$2 = createDebug('folklore:socket:socketio');
 class SocketIOSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -210,7 +210,7 @@ class SocketIOSocket extends EventEmitter {
     this.emit('ready');
   }
   onConnect(channel) {
-    debug$1('Socket connected on %s', channel);
+    debug$2('Socket connected on %s', channel);
     if (!this.started) {
       this.started = true;
       this.starting = false;
@@ -218,7 +218,7 @@ class SocketIOSocket extends EventEmitter {
     }
   }
   onMessage(message, channel) {
-    debug$1('Message received on %s %o', channel, message);
+    debug$2('Message received on %s %o', channel, message);
     this.emit('message', message, channel);
   }
   init() {
@@ -247,7 +247,7 @@ class SocketIOSocket extends EventEmitter {
     });
   }
   updateChannels(channels) {
-    debug$1(`Updating channels: ${channels.join(', ')}`);
+    debug$2(`Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -263,20 +263,20 @@ class SocketIOSocket extends EventEmitter {
   }
   start() {
     if (this.started) {
-      debug$1('Skipping start: Already started.');
+      debug$2('Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$1('Skipping start: Already starting.');
+      debug$2('Skipping start: Already starting.');
       return;
     }
     if (this.io === null) {
-      debug$1('Socket.io not ready.');
+      debug$2('Socket.io not ready.');
       this.shouldStart = true;
       return;
     }
     if (this.channels.length === 0) {
-      debug$1('Skipping start: No channels.');
+      debug$2('Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -292,7 +292,7 @@ class SocketIOSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$1('Stopping...');
+    debug$2('Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -335,9 +335,178 @@ class SocketIOSocket extends EventEmitter {
   }
 }
 
+const debug$1 = createDebug('folklore:socket:pusher');
+class PusherSocker extends EventEmitter {
+  constructor(opts) {
+    super();
+    this.options = {
+      uuid: null,
+      publishKey: null,
+      subscribeKey: null,
+      secretKey: null,
+      ...opts
+    };
+    this.onReady = this.onReady.bind(this);
+    this.onConnected = this.onConnected.bind(this);
+    this.onMessage = this.onMessage.bind(this);
+    this.destroyed = false;
+    this.ready = false;
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    this.Pusher = null;
+    this.pusher = null;
+    this.channels = [];
+    this.clients = {};
+    this.init();
+  }
+  onReady() {
+    if (this.destroyed) {
+      return;
+    }
+    this.ready = true;
+    this.emit('ready');
+  }
+  onConnected() {
+    this.started = true;
+    this.starting = false;
+    this.emit('started');
+  }
+  onMessage(message) {
+    this.emit('message', message);
+    if (typeof message.event !== 'undefined') {
+      this.emit(message.event, message.data || message);
+    }
+  }
+  updateChannels(channels) {
+    debug$1(`Updating channels: ${channels.join(', ')}`);
+    const {
+      shouldStart,
+      started,
+      starting
+    } = this;
+    if (started || starting) {
+      this.stop();
+    }
+    this.channels = channels;
+    if (started || starting || shouldStart) {
+      this.shouldStart = false;
+      this.start();
+    }
+  }
+  init() {
+    if (this.pusher !== null) {
+      return;
+    }
+    debug$1('Init');
+    this.destroyed = false;
+    const loadPusher = this.Pusher !== null ? Promise.resolve() : this.loadPusher();
+    loadPusher.then(() => this.createPusher()).then(() => this.onReady());
+  }
+  loadPusher() {
+    debug$1('Load PusherJs');
+    return import('pusher-js').then(_ref => {
+      let {
+        default: Pusher
+      } = _ref;
+      this.Pusher = Pusher;
+    });
+  }
+  createPusher() {
+    if (this.destroyed) {
+      return;
+    }
+    const {
+      Pusher
+    } = this;
+    const {
+      appKey,
+      ...options
+    } = this.options;
+    this.pusher = new Pusher(appKey, options);
+  }
+  destroy() {
+    this.destroyed = true;
+    this.stop();
+    this.pusher = null;
+    this.clients = {};
+    this.ready = false;
+    debug$1('Destroyed.');
+  }
+  start() {
+    if (this.started) {
+      debug$1('Skipping start: Already started.');
+      return;
+    }
+    if (this.starting) {
+      debug$1('Skipping start: Already starting.');
+      return;
+    }
+    if (this.io === null) {
+      debug$1('Socket.io not ready.');
+      this.shouldStart = true;
+      return;
+    }
+    if (this.channels.length === 0) {
+      debug$1('Skipping start: No channels.');
+      this.shouldStart = true;
+      return;
+    }
+    this.shouldStart = false;
+    this.starting = true;
+    this.pusher.connection.bind('connected', this.onConnected);
+    this.clients = this.channels.reduce((map, channel) => ({
+      ...map,
+      [channel]: this.createClient(channel)
+    }), {});
+    this.emit('start');
+  }
+  stop() {
+    if (!this.started && !this.starting) {
+      return;
+    }
+    debug$1('Stopping...');
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    this.pusher.connection.unbind('connected');
+    Object.keys(this.clients).forEach(channelName => this.stopClient(channelName, this.clients[channelName]));
+    this.clients = {};
+    this.emit('stop');
+  }
+  createClient(channelName) {
+    const channel = this.pusher.subscribe(channelName);
+    channel.bind_global((event, data) => this.onMessage({
+      event,
+      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);
+    return new Promise(resolve => {
+      const {
+        channel,
+        event = null,
+        data: eventData
+      } = data;
+      this.pusher.trigger(channel, event || 'message', eventData);
+      resolve();
+    });
+  }
+}
+
 var SocketAdapters = {
   PubNub: PubNubSocket,
-  SocketIO: SocketIOSocket
+  SocketIO: SocketIOSocket,
+  Pusher: PusherSocker
 };
 
 const normalize = str => str.replace(/[^a-z0-9]+/gi, '').toLowerCase();
@@ -499,7 +668,7 @@ class Socket extends EventEmitter {
       channels,
       ...adapterOptions
     } = this.options;
-    const SocketAdapter = Socket.getAdapter(adapterKey);
+    const SocketAdapter = isString(adapterKey) ? Socket.getAdapter(adapterKey) : adapterKey;
     this.adapter = new SocketAdapter(adapterOptions);
     const methods = ['start', 'stop', 'destroy', 'updateChannels', 'send'];
     methods.forEach(method => {
@@ -610,7 +779,7 @@ const defaultProps = {
   autoStart: false,
   children: null
 };
-const SocketContainer = function (_ref) {
+function SocketContainer(_ref) {
   let {
     children,
     socket,
@@ -622,9 +791,11 @@ const SocketContainer = function (_ref) {
     publishKey,
     subscribeKey,
     secretKey,
-    channels: initialChannels
+    channels: initialChannels,
+    ...props
   } = _ref;
   const finalSocket = React.useMemo(() => socket || new Socket({
+    ...props,
     adapter,
     host,
     namespace,
@@ -683,7 +854,7 @@ const SocketContainer = function (_ref) {
     value: value,
     children: children
   });
-};
+}
 SocketContainer.propTypes = propTypes;
 SocketContainer.defaultProps = defaultProps;
 

package/dist/es.js

@@ -2,13 +2,13 @@ import createDebug from 'debug';
 import invariant from 'invariant';
 import isFunction from 'lodash/isFunction';
 import EventEmitter from 'wolfy87-eventemitter';
+import isString from 'lodash/isString';
 import isArray from 'lodash/isArray';
 import React, { useMemo, useState, useRef, useCallback, useEffect, useContext } from 'react';
 import PropTypes from 'prop-types';
 import { jsx } from 'react/jsx-runtime';
-import isString from 'lodash/isString';
 
-const debug$2 = createDebug('folklore:socket:pubnub');
+const debug$3 = createDebug('folklore:socket:pubnub');
 class PubNubSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -57,7 +57,7 @@ class PubNubSocket extends EventEmitter {
     }
   }
   updateChannels(channels) {
-    debug$2(`Updating channels: ${channels.join(', ')}`);
+    debug$3(`Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -76,13 +76,13 @@ class PubNubSocket extends EventEmitter {
     if (this.pubnub !== null) {
       return;
     }
-    debug$2('Init');
+    debug$3('Init');
     this.destroyed = false;
     const loadPubnub = this.PubNub !== null ? Promise.resolve() : this.loadPubNub();
     loadPubnub.then(() => this.createPubNub()).then(() => this.onReady());
   }
   loadPubNub() {
-    debug$2('Load PubNub');
+    debug$3('Load PubNub');
     return import('pubnub').then(_ref2 => {
       let {
         default: PubNub
@@ -123,19 +123,19 @@ class PubNubSocket extends EventEmitter {
     }
     this.pubnub = null;
     this.ready = false;
-    debug$2('Destroyed.');
+    debug$3('Destroyed.');
   }
   start() {
     if (this.started) {
-      debug$2('Skipping start: Already started.');
+      debug$3('Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$2('Skipping start: Already starting.');
+      debug$3('Skipping start: Already starting.');
       return;
     }
     if (this.channels.length === 0) {
-      debug$2('Skipping start: No channels.');
+      debug$3('Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -150,7 +150,7 @@ class PubNubSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$2('Stopping...');
+    debug$3('Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -160,7 +160,7 @@ class PubNubSocket extends EventEmitter {
     this.emit('stop');
   }
   send(data) {
-    debug$2('Sending', data);
+    debug$3('Sending', data);
     return new Promise((resolve, reject) => {
       this.pubnub.publish(data, (status, response) => {
         if (status.error) {
@@ -177,7 +177,7 @@ class PubNubSocket extends EventEmitter {
   }
 }
 
-const debug$1 = createDebug('folklore:socket:socketio');
+const debug$2 = createDebug('folklore:socket:socketio');
 class SocketIOSocket extends EventEmitter {
   constructor(opts) {
     super();
@@ -206,7 +206,7 @@ class SocketIOSocket extends EventEmitter {
     this.emit('ready');
   }
   onConnect(channel) {
-    debug$1('Socket connected on %s', channel);
+    debug$2('Socket connected on %s', channel);
     if (!this.started) {
       this.started = true;
       this.starting = false;
@@ -214,7 +214,7 @@ class SocketIOSocket extends EventEmitter {
     }
   }
   onMessage(message, channel) {
-    debug$1('Message received on %s %o', channel, message);
+    debug$2('Message received on %s %o', channel, message);
     this.emit('message', message, channel);
   }
   init() {
@@ -243,7 +243,7 @@ class SocketIOSocket extends EventEmitter {
     });
   }
   updateChannels(channels) {
-    debug$1(`Updating channels: ${channels.join(', ')}`);
+    debug$2(`Updating channels: ${channels.join(', ')}`);
     const {
       shouldStart,
       started,
@@ -259,20 +259,20 @@ class SocketIOSocket extends EventEmitter {
   }
   start() {
     if (this.started) {
-      debug$1('Skipping start: Already started.');
+      debug$2('Skipping start: Already started.');
       return;
     }
     if (this.starting) {
-      debug$1('Skipping start: Already starting.');
+      debug$2('Skipping start: Already starting.');
       return;
     }
     if (this.io === null) {
-      debug$1('Socket.io not ready.');
+      debug$2('Socket.io not ready.');
       this.shouldStart = true;
       return;
     }
     if (this.channels.length === 0) {
-      debug$1('Skipping start: No channels.');
+      debug$2('Skipping start: No channels.');
       this.shouldStart = true;
       return;
     }
@@ -288,7 +288,7 @@ class SocketIOSocket extends EventEmitter {
     if (!this.started && !this.starting) {
       return;
     }
-    debug$1('Stopping...');
+    debug$2('Stopping...');
     this.shouldStart = false;
     this.started = false;
     this.starting = false;
@@ -331,9 +331,178 @@ class SocketIOSocket extends EventEmitter {
   }
 }
 
+const debug$1 = createDebug('folklore:socket:pusher');
+class PusherSocker extends EventEmitter {
+  constructor(opts) {
+    super();
+    this.options = {
+      uuid: null,
+      publishKey: null,
+      subscribeKey: null,
+      secretKey: null,
+      ...opts
+    };
+    this.onReady = this.onReady.bind(this);
+    this.onConnected = this.onConnected.bind(this);
+    this.onMessage = this.onMessage.bind(this);
+    this.destroyed = false;
+    this.ready = false;
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    this.Pusher = null;
+    this.pusher = null;
+    this.channels = [];
+    this.clients = {};
+    this.init();
+  }
+  onReady() {
+    if (this.destroyed) {
+      return;
+    }
+    this.ready = true;
+    this.emit('ready');
+  }
+  onConnected() {
+    this.started = true;
+    this.starting = false;
+    this.emit('started');
+  }
+  onMessage(message) {
+    this.emit('message', message);
+    if (typeof message.event !== 'undefined') {
+      this.emit(message.event, message.data || message);
+    }
+  }
+  updateChannels(channels) {
+    debug$1(`Updating channels: ${channels.join(', ')}`);
+    const {
+      shouldStart,
+      started,
+      starting
+    } = this;
+    if (started || starting) {
+      this.stop();
+    }
+    this.channels = channels;
+    if (started || starting || shouldStart) {
+      this.shouldStart = false;
+      this.start();
+    }
+  }
+  init() {
+    if (this.pusher !== null) {
+      return;
+    }
+    debug$1('Init');
+    this.destroyed = false;
+    const loadPusher = this.Pusher !== null ? Promise.resolve() : this.loadPusher();
+    loadPusher.then(() => this.createPusher()).then(() => this.onReady());
+  }
+  loadPusher() {
+    debug$1('Load PusherJs');
+    return import('pusher-js').then(_ref => {
+      let {
+        default: Pusher
+      } = _ref;
+      this.Pusher = Pusher;
+    });
+  }
+  createPusher() {
+    if (this.destroyed) {
+      return;
+    }
+    const {
+      Pusher
+    } = this;
+    const {
+      appKey,
+      ...options
+    } = this.options;
+    this.pusher = new Pusher(appKey, options);
+  }
+  destroy() {
+    this.destroyed = true;
+    this.stop();
+    this.pusher = null;
+    this.clients = {};
+    this.ready = false;
+    debug$1('Destroyed.');
+  }
+  start() {
+    if (this.started) {
+      debug$1('Skipping start: Already started.');
+      return;
+    }
+    if (this.starting) {
+      debug$1('Skipping start: Already starting.');
+      return;
+    }
+    if (this.io === null) {
+      debug$1('Socket.io not ready.');
+      this.shouldStart = true;
+      return;
+    }
+    if (this.channels.length === 0) {
+      debug$1('Skipping start: No channels.');
+      this.shouldStart = true;
+      return;
+    }
+    this.shouldStart = false;
+    this.starting = true;
+    this.pusher.connection.bind('connected', this.onConnected);
+    this.clients = this.channels.reduce((map, channel) => ({
+      ...map,
+      [channel]: this.createClient(channel)
+    }), {});
+    this.emit('start');
+  }
+  stop() {
+    if (!this.started && !this.starting) {
+      return;
+    }
+    debug$1('Stopping...');
+    this.shouldStart = false;
+    this.started = false;
+    this.starting = false;
+    this.pusher.connection.unbind('connected');
+    Object.keys(this.clients).forEach(channelName => this.stopClient(channelName, this.clients[channelName]));
+    this.clients = {};
+    this.emit('stop');
+  }
+  createClient(channelName) {
+    const channel = this.pusher.subscribe(channelName);
+    channel.bind_global((event, data) => this.onMessage({
+      event,
+      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);
+    return new Promise(resolve => {
+      const {
+        channel,
+        event = null,
+        data: eventData
+      } = data;
+      this.pusher.trigger(channel, event || 'message', eventData);
+      resolve();
+    });
+  }
+}
+
 var SocketAdapters = {
   PubNub: PubNubSocket,
-  SocketIO: SocketIOSocket
+  SocketIO: SocketIOSocket,
+  Pusher: PusherSocker
 };
 
 const normalize = str => str.replace(/[^a-z0-9]+/gi, '').toLowerCase();
@@ -495,7 +664,7 @@ class Socket extends EventEmitter {
       channels,
       ...adapterOptions
     } = this.options;
-    const SocketAdapter = Socket.getAdapter(adapterKey);
+    const SocketAdapter = isString(adapterKey) ? Socket.getAdapter(adapterKey) : adapterKey;
     this.adapter = new SocketAdapter(adapterOptions);
     const methods = ['start', 'stop', 'destroy', 'updateChannels', 'send'];
     methods.forEach(method => {
@@ -606,7 +775,7 @@ const defaultProps = {
   autoStart: false,
   children: null
 };
-const SocketContainer = function (_ref) {
+function SocketContainer(_ref) {
   let {
     children,
     socket,
@@ -618,9 +787,11 @@ const SocketContainer = function (_ref) {
     publishKey,
     subscribeKey,
     secretKey,
-    channels: initialChannels
+    channels: initialChannels,
+    ...props
   } = _ref;
   const finalSocket = useMemo(() => socket || new Socket({
+    ...props,
     adapter,
     host,
     namespace,
@@ -679,7 +850,7 @@ const SocketContainer = function (_ref) {
     value: value,
     children: children
   });
-};
+}
 SocketContainer.propTypes = propTypes;
 SocketContainer.defaultProps = defaultProps;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@folklore/socket",
-    "version": "0.4.17",
+    "version": "0.4.19",
     "description": "Socket utilities",
     "keywords": [
         "javascript",
@@ -44,6 +44,7 @@
         "lodash": "^4.17.4",
         "prop-types": "^15.6.0",
         "pubnub": "^4.18.0",
+        "pusher-js": "^8.0.0",
         "socket.io-client": "^4.1.2",
         "wolfy87-eventemitter": "^5.2.4"
     },
@@ -55,5 +56,5 @@
         "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
         "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
     },
-    "gitHead": "c13ef70b8126b3182b3e3365f34f9231fa9b1535"
+    "gitHead": "1f1b7ab751c4497df25a3dda97cd84f793ff720f"
 }