npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@janiscommerce/conversation

v2.0.0

Published

A package to send notifications using Janis Conversation Service

Downloads

828

Readme

conversation

Build Status Coverage Status npm version

A package to send notifications using Janis Conversation Service

Installation

npm install @janiscommerce/conversation

Available methods

Configuration methods

The methods that you can use to create the notification: (All these methods are chainable)

  • setTopic [topic: String] : This method sets which template should use the notification
  • setData [data: Object]: This method sets the data that eventually the template should use when sending the notification.
  • setEntity [entity: String|Number]: This method sets the entity related to the notification.
  • setEntityId [entityId: String|Number]: This method sets the entity ID related to the notification.
  • setUserCreated [userCreated: String]: This method sets the User ID related to the user that triggered the notification.
  • setClientCode [clientCode: String] This method should be used to be able to make requests "on behalf" of the client, in case the session has not been injected.

Method of use

  • send This method sends the notification set using the Conversation package. Returns the ID of the created message.

ClientCode injection

The package uses the Janis Conversation Service, so it needs the clientCode to be able to use it's API. You have two ways to do so:

  • Instanciate the package in a sessioned class using this.session.getSessionInstance(Conversation) (see @janiscommerce/api-session)
  • Setting the clientCode using the conversation.setClientCode('clientCode') method

Errors

The errors are informed with a ConversationError. This object has a code that can be useful for a correct error handling or debugging. The codes are the following:

| Code | Description | |------|--------------------------------| | 1 | Required field missing | | 2 | Invalid field type | | 3 | Microservice call Error |

Examples

Client injection

With clientCode

const { Conversation } = require('@janiscommerce/conversation');

const conversation = new Conversation();

await conversation.setTopic('example-topic')
	.setClientCode('client-code')
	.send();

With session

const { Conversation } = require('@janiscommerce/conversation');
const API = require('@janiscommerce/api');

class ApiExample extends API {

	async process() {

		const conversation = this.session.getSessionInstance(Conversation);

		try {
			await conversation.setTopic('example-topic').send();
		} catch(error) {
			console.log(error);
		}
	}
}

module.exports = ApiExample;

Examples

Send a message

Basic usage

const { Conversation } = require('@janiscommerce/conversation');

const conversation = new Conversation();

await conversation.setClientCode('client-code')
	.setTopic('example-topic')
	.send();

Complete Usage

const { Conversation } = require('@janiscommerce/conversation');

const conversation = new Conversation();

await conversation.setClientCode('client-code')
	.setTopic('example-topic')
	.setEntity('order')
	.setEntityId('5de565c07de99000110dcdef')
	.setUserCreated('6de565c07de99000110dcdef')
	.setData({
		someField: 'someFieldValue',
		otherField: 'otherFieldValue'
	})
	.send();