Docs

• add instructions for quasar framework (#452)
• fix typo (#439)

Chores

• update dependency vue to v2.6.11
• update dependency vue-class-component to v7.2.3
• update dependency eslint to v7
• update dependency rollup to v2.9.1
• update dependency jest to v26.0.1
• update dependency babel to v7.9.6
• update dependency @vue/test-utils to v1.0.2

Fixes

• Fix Vue plugin export in UMD build (#419, thanks @mila76 for finding)

Features

• Reactive properties this.$socket.connected and this.$socket.disconnected support (Closes #17) Docs
• ECMAScript / TypeScript @Socket() decorator support (Closes #357) Docs

Bug fixes

• Proper unsubscribing from dynamic listeners and non-dynamic listeners #408 #407 #400

Breaking changes

• socket.io-client instance moved from this.$socket to this.socket.client. Please check usages before upgrading

- this.$socket.emit('anything');
+ this.$socket.client.emit('anything');

• Dynamic socket event listeners API change (no more relies on Proxy API)

- this.$options.sockets.event_name = (payload) => {
-  console.log(payload)
- });
+ this.$socket.$subscribe('event_name', (payload) => {
+  console.log(payload)
+ });

• If you are using library in CommonJS environment you might need to change the usage:

- const VueSocketIOExt = require('vue-socket.io-extended');
+ const VueSocketIOExt = require('vue-socket.io-extended').default;
const io = require('socket.io-client');

const socket = io('http://socketserver.com:1923');

Vue.use(VueSocketIOExt, socket);

Other changes

• IE 11 fully supported now
• No more security vulnerabilities in the dev dependencies
• Bundle now properly transpiled to ESM
• Stop polyfilling dead browsers (e.g. IE 10)
• Twitter feed example now lives in the repo (more examples soon)

Bug Fixes

• deps: update dependency camelcase to v5.2.0 (89ea893)
• deps: update dependency camelcase to v5.3.0 (cefb582)
• deps: update dependency camelcase to v5.3.1 (f6dc7a4)
• mixin: fix issue #400, unable to unsubscribe from dynamic listener (d2ccf99) thanks to @jonakirke94

Chores

• Rebuild with latest dependencies

Bug Fixes

• Syntax error in IE11 (closes #253 and #238), thanks to @barrymckay397

Chores

• Rebuild with latest deps
• Moved to babel.config.js

Bug Fixes

• core: correct option merging strategy for sockets prop (30b728b), closes #189
• build: fix error "Error: Farm is ended, no more calls can be done to it" (2b4e5a8)

Features

• basic TypeScript types (a91c343), closes #52, thanks to @TotomInc

Features

You can now access default plugin options if you need it (e.g. re-use default eventToActionTransformer function):

import VueSocketIOExt from 'vue-socket.io-extended';
VueSocketIOExt.defaults // -> { actionPrefix: '...', mutationPrefix: '...', ... }

• options: make default options read-only (2d9c23e)
• options: move default options to separate file and export it (2ddbfad)
• options: move export to plugin field (instead of named export) (7f4960b)

Options support

This release introduces options support - hooray 🎉 . That means you can tweak the library to better fit your project needs. So now you can:

• use custom prefix for actions (instead of default socket_), closes #25
• use custom prefix for mutations (instead of default SOCKET_), closes #25
• use custom function to convert event to action (instead of default camelcase)
• use custom function to convert event to mutation (instead of default uppercase)

Read more in configuration section. That's all for now

Upgrade guide

If you are using store - keep reading, if not - stop reading right here because there nothing to update for you 😄.
Previously it was possible to pass store as third argument to enable vuex integration but now third argument is an options object. So, you need to pass store as part of options to enable it.

In short:

- Vue.use(VueSocketio, io('http://socketserver.com:1923'), store);
+ Vue.use(VueSocketio, io('http://socketserver.com:1923'), { store });

Bug fixes

• prevent crash during SSR (as library no more uses window directly)

Other improvements

• correctly detects is Proxy natively supported by browser (no more issue with polyfill)
• potentially improves testing experience for mixin as we can mock proxy support now
• rebuild with [email protected] & [email protected]

Bug fixes

• prevent crash when Proxy API is not supported by browser (41490fc)

Features

• Observer: unwrap data while passing to mutation/action (37430ed, fixes #47)
• Compatibility: add String.prototype.starsWith polyfill (1839542, fixes #27)

Bracking changes

• force user to provide socket.io-client instance (87738e5), fixes #19

• chore: integrate with codecov to gather code coverage reports
• refactor: separate EvenEmitter class from global EvenEmitter instance
• tests: cover EventEmitter, Observer and mixin by unit tests
• fix: correctly convert event name to camelcased vuex action name

• feat: move to babel-preset-env instead of babel-preset-es2015 (which is deprecated now)
• chore: enable CircleCI integration to check PRs before merge
• chore: setup success build check on CI
• chore bootstrap eslint to enforce code style based on airbnb configuration
• chore: bootstrap test environment using jest
• chore: setup test run on CI
• refactor: update code based on eslint rules (auto-fix)
• chore: add script for release generation
• chore: add script for release note generation

• build with rollup instead of webpack
• add package-lock to git, better npm@5 support
• move babel config to .babelrc file
• expose ESM build as well as UMD

• initial fork from vue-socket.io
• update repo and package file
• publish on npm