@botpress/messaging-client

v1.2.2

An http client to interact with the botpress Messaging Server For more information about how to use this package see README

Latest version published 1 year ago

License: AGPL-3.0

NPM

GitHub

Package Health Score

59 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.2.2	\|	04/2023	Popular	0 C 0 H 0 M 0 L	1 H 0 M 0 L
1.1.9	\|	03/2022		0 C 0 H 0 M 0 L	1 H 0 M 0 L
0.0.14	\|	01/2022		0 C 0 H 0 M 0 L	1 H 0 M 0 L

License

AGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,072)

GitHub Stars: 35
Forks: 38
Contributors: 20

Direct Usage Popularity

The npm package @botpress/messaging-client receives a total of 1,072 downloads a week. As such, we scored @botpress/messaging-client popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @botpress/messaging-client, we found that it has been starred 35 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @botpress/messaging-client repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @botpress/messaging-client is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 1
Last Release: 1 year ago
Last Commit: 22 days ago

Further analysis of the maintenance status of @botpress/messaging-client based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for @botpress/messaging-client is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 4 Direct
Versions: 30
Install Size: 60.6 kB
Dist-tags: 1
# of Files: 26
Maintainers: 7
TS Typings: No

@botpress/messaging-client has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Botpress Messaging Client

An HTTP client to make requests to the Botpress Messaging Server and receive webhook events using Express

Installation

Requires Node.js 16

yarn add @botpress/messaging-client
npm install @botpress/messaging-client
pnpm add @botpress/messaging-client

Basic Usage

Initialize the client and respond to messages

// ensure your Express app has the json middleware
app.use(express.json())

// initialize client with your credentials
const client = new MessagingClient({
  clientId: 'my-client-id',
  clientToken: 'my-client-token',
  webhookToken: 'my-webhook-token'
})

// listen for webhook events by providing an express router
client.setup(router)

// register callback method for incoming messages and respond to user
client.on('message', async (e) => {
  await client.createMessage(e.conversationId, undefined, { text: `Hello I'm a bot!` })
})

More Events

The Messaging Server also produces these webhook events

client.on('user', async ({ userId }) => {
  console.log(`new user: ${userId}!`)
})

client.on('started', async ({ userId, conversationId, channel }) => {
  console.log(`new conversation started by ${userId} on ${channel} : ${conversationId}!`)
})

client.on('feedback', async ({ userId, conversationId, channel, messageId, feedback }) => {
  console.log(
    `feedback given by ${userId} on ${channel} in convo ${conversationId} on message ${messageId} : ${feedback}!`
  )
})

@botpress/messaging-client dependencies

@botpress/messaging-base axios cookie joi

@botpress/messaging-client development dependencies

@types/cookie @types/express @types/jest @types/node @types/uuid uuid

FAQs

What is @botpress/messaging-client?

An http client to interact with the botpress Messaging Server. Visit Snyk Advisor to see a full health score report for @botpress/messaging-client, including popularity, security, maintenance & community analysis.

Is @botpress/messaging-client popular?

The npm package @botpress/messaging-client receives a total of 1,072 weekly downloads. As such, @botpress/messaging-client popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @botpress/messaging-client well maintained?

We found indications that @botpress/messaging-client maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @botpress/messaging-client safe to use?

While scanning the latest version of @botpress/messaging-client, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 16 April-2024, at 01:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP