npmpackage.info

Gathering detailed insights and metrics for adonis-vue-websocket

adonis-vue-websocket

This package add new layer for use original AdonisWSClient for Adonis 4.1 in your vue.js project

2.0.2

JavaScript

25.30 kB

15,989 1.3

Installations

npm install adonis-vue-websocket

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

11.15.0

NPM Version

6.10.2 Pull Requests

Open

25

Total

33

Closed

7

Merged

1

Issues

Open

1

Total

1

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 2 Contributors

Languages

JavaScript

Vue

CSS

HTML

JavaScript (87.94%)

Vue (7.53%)

CSS (2.9%)

HTML (1.63%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

reg2005

Download Statistics

Total Downloads

15,989

Last Day

Last Week

Last Month

Last Year

2,147

GitHub Statistics

2 Stars

13 Commits

4 Forks

1 Watchers

26 Branches

2 Contributors

Updated on Feb 19, 2022

Bundle Size

70.65 kB

Minified

25.30 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.2

Package Id

adonis-vue-websocket@2.0.2

Unpacked Size

894.05 kB

Size

359.93 kB

File Count

NPM Version

6.10.2

Node Version

11.15.0

Total Downloads

Cumulative downloads

Total Downloads

15,989

Last Day

Compared to previous day

Last Week

80%

Compared to previous week

Last Month

25.4%

Compared to previous month

Last Year

-17.8%

2,147

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

vue

Adonis websocket client for VueJS

How it works

This package add new layer for use original AdonisWSClient in your vue.js project:

1//For global acceess
2Vue.ws
3
4//In vue component
5this.$ws

For example you can handle adonisWS events in your vue components:

1this.$ws.$on(`${topicName}|ABOUT_MESSAGE`, d => console.log(d))

Emit events from Vue components you can:

1//if this topic does not exist, $emitToServer automatic trying to create it
2this.$ws.$emitToServer(topicName, 'hello', {message: 'message})

Install

npm

1npm install adonis-vue-websocket

yarn

1yarn add adonis-vue-websocket

Usage

1. Connect plugin

You can to plug original AdonisWSClient and connect with library:

1import Ws from '@adonisjs/websocket-client'
2import WsPlugin from 'adonis-vue-websocket'
3Vue.use(WsPlugin, { adonisWS: Ws })

I recommend this way: add AdonisWS in index.html (for disable native AdonisJS logs):

1<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/7.4.3/polyfill.min.js"></script>
2<script src="https://unpkg.com/@adonisjs/websocket-client@1.0.9/dist/Ws.browser.min.js"></script>

and connect with library in main.js:

1import WsPlugin from 'adonis-vue-websocket'
2Vue.use(WsPlugin, { adonisWS: window.adonis.Ws })

2. Init connection

Create file src/WsSubscriptions.js with content:

1import Vue from "vue";
2
3const userTopicSubscriptions = id => {
4  if (id) {
5    let subscription = Vue.ws.socket.getSubscription(`user:${id}`);
6    if (!subscription) {
7      subscription = Vue.ws.subscribe(`user:${id}`);
8    }
9    subscription.on("HELLO_EVENT", data => {
10      console.log('Hello (event handled in src/WsSubscriptions.js)', data)
11    });
12  }
13};
14
15export default async () => {
16  return new Promise((resolve, reject) => {
17    Vue.ws.disconnect()
18    Vue.ws.connect(
19        {
20            wsDomain: "ws://localhost:3333", 
21            jwtToken: null
22        }, 
23        { 
24            path: 'adonis-ws', 
25            reconnectionAttempts: 300, 
26            reconnectionDelay: 5000 
27        }
28    );
29    Vue.ws.socket.on("open", () => {
30      userTopicSubscriptions(1);
31      resolve()
32    });
33    
34    // FOR EXAMPLE you can observe for userId or another variable from Vuex
35    // store.watch(
36    //   () => store.getters.vgUserUid,
37    //   async id => {
38    //     if (id) {
39    //       userTopicSubscriptions(uid);
40    //     }
41    //   }
42    // );
43  })
44};

In app.vue:

1<template>
2  <div id="app">
3    <div id="nav">
4      <router-link to="/">Home</router-link> |
5      <router-link to="/about">About</router-link>
6    </div>
7    <router-view v-if="!loading"/>
8  </div>
9</template>
10
11<script>
12import WsSubscriptions from './WsSubscriptions'
13export default {
14  data () {
15    return {
16      loading: true
17    }
18  },
19  async created() {
20    await WsSubscriptions()
21    this.loading = false
22  }
23}
24</script>

3. Handle and emit events

You can handle events in any .js and .vue files and components, for example in vue component:

1<template>
2  <div class="about">
3    <h1>This is an about page</h1>
4    <el-input v-model="message"/>
5    <el-button @click="sendHello">Send!</el-button>
6  </div>
7</template>
8<script>
9const topicName = 'user:1'
10export default {
11  data() {
12    return {
13      message: 'Hello from about page!'
14    }
15  },
16  mounted() {
17    this.$ws.$on(`${topicName}|ABOUT_MESSAGE`, this.handleAboutMessageEvent) 
18    this.$ws.$on('ABOUT_MESSAGE', this.handleAboutMessageEvent)
19  },
20  beforeDestroy(){
21    //Remove listeners when component destroy
22    this.$ws.$off(`${topicName}|ABOUT_MESSAGE`, this.handleAboutMessageEvent);
23    this.$ws.$off('ABOUT_MESSAGE', this.handleAboutMessageEvent);
24  },
25  methods: {
26    handleAboutMessageEvent(data){
27        console.log("handled in src/views/About.vue", data)
28    },
29    sendHello(){
30      this.$ws.$emitToServer(topicName, 'hello', {message: this.message})
31    }
32  }
33}
34</script>

Profit!

Test

1git clone https://github.com/reg2005/adonis-vue-websocket.git
2cd adonis-vue-websocket

In first terminal

1cd example/back
2cp .env.example .env
3npm install
4adonis serve --dev

In second terminal

1cd example/front 
2npm install
3yarn serve

And open front in your browser

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

108 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.3

/10

Last Scanned on 2025-03-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More