Merge upstream

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,25 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

README.md

@@ -12,7 +12,11 @@
   <a href="https://github.com/MetinSeylan/Vue-Socket.io/"><img src="https://img.shields.io/npm/l/vue-socket.io.svg"/></a>
   <a href="https://github.com/MetinSeylan/Vue-Socket.io/"><img src="https://img.shields.io/github/stars/MetinSeylan/Vue-Socket.io.svg"/></a>
 </p>
-
+<p align="center">
+<a href="https://www.patreon.com/MetinSeylan">
+	<img alt="Patreon" src="https://c5.patreon.com/external/logo/become_a_patron_button.png" height="50" />
+</a>
+</p>
 <p>Vue-Socket.io is a socket.io integration for Vuejs, easy to use, supporting Vuex and component level socket consumer managements<p>
 
 ###### Demo
@@ -58,6 +62,7 @@ import Vue from 'vue'
 import store from './store'
 import App from './App.vue'
 import VueSocketIO from 'vue-socket.io'
+import SocketIO from 'socket.io-client'
 
 const options = { path: '/my-app/' }; //Options object to pass into SocketIO
 
@@ -87,7 +92,6 @@ connection|String/Socket.io-client|`null`|Required|Websocket server url or socke
 vuex.store|Vuex|`null`|Optional|Vuex store instance
 vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions
 vuex.mutationPrefix|String |`null`|Optional|Prefix for emitting server side vuex mutations
-vuex.options.useConnectionNamespace |Boolean|`false`|Optional|Use more than one connection namespace
 
 #### 🌈 Component Level Usage
 
@@ -124,6 +128,35 @@ this.sockets.subscribe('EVENT_NAME', (data) => {
 this.sockets.unsubscribe('EVENT_NAME');
 ```
 
+##### Defining handlers for events with special characters
+
+<p>If you want to handle 'kebab-case', or "event with space inside it" events, then you have to define it via the following way</p>
+
+``` javascript
+export default {
+  name: 'Test',
+  sockets: {
+    connect: function () {
+      console.log('socket to notification channel connected')
+    },
+  },
+
+  data () {
+    return {
+      something: [
+         // ... something here for the data if you need.
+      ]
+    }
+  },
+
+  mounted () {
+    this.$socket.subscribe("kebab-case", function(data) {
+        console.log("This event was fired by eg. sio.emit('kebab-case')", data)
+    })
+  }
+}
+```
+
 #### 🏆 Vuex Integration
 <p>When you set store parameter in installation, `Vue-Socket.io` will start sending events to Vuex store. If you set both prefix for vuex, you can use `actions` and `mutations` at the same time. But, best way to use is just `actions`</p>
 
@@ -148,41 +181,6 @@ export default new Vuex.Store({
 })
 ```
 
-#### 🏆 Connection Namespace
-<p>When you need to handle more than one namespaced connection, you need to set the `useConnectionNamespace` property of
-the options object to true. What this does is telling the plugin that you are going to be using more than one namespaced connection and you want to put every connection in their own `$socket` key.</p>
-
-``` javascript
-import Vue from 'vue'
-import store from './store'
-import App from './App.vue'
-import VueSocketIO from 'vue-socket.io'
-
-Vue.use(new VueSocketIO({
-    debug: true,
-    connection: 'http://metinseylan.com:1992/mynamespace',
-    vuex: {
-        store,
-        options: {
-            useConnectionNamespace: true
-        }
-    },
-    options: { path: "/my-app/" } //Optional options
-}))
-
-new Vue({
-    router,
-    store,
-    render: h => h(App)
-}).$mount('#app')
-```
-
-Then use it like this:
-
-``` javascript
-Vue.$socket.mynamespace.emit('emit_method', data)
-```
-
 ## Stargazers over time
 
 [![Stargazers over time](https://starcharts.herokuapp.com/MetinSeylan/Vue-Socket.io.svg)](https://starcharts.herokuapp.com/MetinSeylan/Vue-Socket.io)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vue-socket.io",
   "author": "Metin Seylan <metinsyln@gmail.com>",
-  "version": "3.0.7",
+  "version": "3.0.10",
   "description": "socket.io implementation for Vue.js and Vuex",
   "main": "dist/vue-socketio.js",
   "scripts": {
@@ -38,8 +38,6 @@
     "@babel/preset-env": "^7.1.0",
     "babel-loader": "^8.0.4",
     "cross-env": "^5.2.0",
-    "vue": "^2.6.10",
-    "vuex": "^3.1.1",
     "webpack": "^4.23.1",
     "webpack-cli": "^3.1.2"
   }

src/index.js

@@ -1,8 +1,8 @@
-import Mixin from "./mixin";
+import Mixin from './mixin';
-import Logger from "./logger";
+import Logger from './logger';
-import Listener from "./listener";
+import Listener from './listener';
-import Emitter from "./emitter";
+import Emitter from './emitter';
-import SocketIO from "socket.io-client";
+import SocketIO from 'socket.io-client';
 
 export default class VueSocketIO {
 
@@ -19,8 +19,6 @@ export default class VueSocketIO {
         Logger.debug = debug;
         Logger.darkMode = darkMode;
         this.io = this.connect(connection, options);
-        this.useConnectionNamespace = (options && options.useConnectionNamespace);
-        this.namespaceName = (options && options.namespaceName);
         this.emitter = new Emitter(vuex);
         this.listener = new Listener(this.io, this.emitter);
 
@@ -32,48 +30,40 @@ export default class VueSocketIO {
      */
     install(Vue){
 
-        const namespace = this.namespaceName || this.io.nsp.replace("/", "");
-
-        if (this.useConnectionNamespace) {
-          if (typeof Vue.prototype.$socket === "object") {
-            Vue.prototype.$socket = {
-              ...Vue.prototype.$socket,
-              [namespace]: this.io
-            };
-
-            Vue.prototype.$vueSocketIo = {...Vue.prototype.$vueSocketIo, [namespace]: this};
-          } else {
-            Vue.prototype.$socket = {
-              [namespace]: this.io
-            };
-            Vue.prototype.$vueSocketIo = { [namespace]: this};
-          }
-        } else {
         Vue.prototype.$socket = this.io;
         Vue.prototype.$vueSocketIo = this;
-        }
-      
         Vue.mixin(Mixin);
 
         Logger.info('Vue-Socket.io plugin enabled');
 
     }
 
+
     /**
      * registering SocketIO instance
      * @param connection
      * @param options
      */
-  connect(connection, options) {
+    connect(connection, options){
-    if (connection && typeof connection === "object") {
+
-      Logger.info(`Received socket.io-client instance`);
+        if(connection && typeof connection === 'object'){
+
+            Logger.info('Received socket.io-client instance');
+
             return connection;
-    } else if (typeof connection === "string") {
+
-      const io = SocketIO(connection, options);
+        } else if(typeof connection === 'string'){
-      Logger.info(`Received connection string`);
+
-      return (this.io = io);
+            Logger.info('Received connection string');
+
+            return this.io = SocketIO(connection, options);
+
         } else {
-      throw new Error("Unsupported connection type");
+
+            throw new Error('Unsupported connection type');
+
         }
+
     }
+
 }

src/mixin.js

@@ -7,21 +7,14 @@ export default {
 
         if(!this.sockets) this.sockets = {};
 
-        if (typeof this.$vueSocketIo === 'object') {
+        this.sockets.subscribe = (event, callback) => {
-            for (const namespace of Object.keys(this.$vueSocketIo)) {
-                this.sockets[namespace] = {
-                    subscribe: (event, callback) => {
-                        this.$vueSocketIo[namespace].emitter.addListener(event, callback, this);
-                    },
-                    unsubscribe: (event) => {
-                        this.$vueSocketIo[namespace].emitter.removeListener(event, this);
-                    }
-                }
-            }
-        } else {
             this.$vueSocketIo.emitter.addListener(event, callback, this);
+        };
+
+        this.sockets.unsubscribe = (event) => {
             this.$vueSocketIo.emitter.removeListener(event, this);
-        }
+        };
+
     },
 
     /**
@@ -31,19 +24,6 @@ export default {
 
         if(this.$options.sockets){
 
-            if (typeof this.$vueSocketIo === 'object') {
-                for (const namespace of Object.keys(this.$vueSocketIo)) {
-                    if (this.$options.sockets[namespace]) {
-                        Object.keys(this.$options.sockets[namespace]).forEach(event => {
-
-                            if(event !== 'subscribe' && event !== 'unsubscribe') {
-                                this.$vueSocketIo[namespace].emitter.addListener(event, this.$options.sockets[namespace][event], this);
-                            }
-            
-                        });
-                    }
-                }
-            } else {
             Object.keys(this.$options.sockets).forEach(event => {
 
                 if(event !== 'subscribe' && event !== 'unsubscribe') {
@@ -51,7 +31,7 @@ export default {
                 }
 
             });
-            }
+
         }
 
     },
@@ -63,23 +43,11 @@ export default {
 
         if(this.$options.sockets){
 
-            if (typeof this.$vueSocketIo === 'object') {
-                for (const namespace of Object.keys(this.$vueSocketIo)) {
-                    if (this.$options.sockets[namespace]) {
-                        Object.keys(this.$options.sockets[namespace]).forEach(event => {
-
-                            this.$vueSocketIo[namespace].emitter.removeListener(event, this);
-            
-                        });
-                    }
-                }
-            } else {
             Object.keys(this.$options.sockets).forEach(event => {
 
                 this.$vueSocketIo.emitter.removeListener(event, this);
 
             });
-            }
 
         }