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

@icapps/chat-astrum

v3.2.0

Published

Chat module ESS

Downloads

17

Readme

ESS Chat module

Module to create custom chat setup

Context

This module allows to have conversations with one or more recipients into a chat. Socket.io is being used for realtime messages.

Installation

Install via npm

npm install @icapps/chat-astrum

or via yarn

yarn add @icapps/chat-astrum

Usage

const chat = require('@icapps/chat-astrum');
import * as chat from '@icapps/chat-astrum';

Prerequisites

MongoDB

The module uses a MongoDB database combined with mongoose. In order to run everything smoothly you have to make sure a mongoDB is available.

More information on MongoDB

Available methods

db

These are related to all MongoDB operations.

openConnection(url)

Open a connection to MongoDB. This is required to do before trying to fetch any data from other methods below.

  db.openConnection('mongodb://localhost:27017/db')

socket

These are related to all socket.io operations

startSockerServer(server, options)

Start a new socket server instance. This should be called before trying to use any other socket methods. This uses a global singleton so you will always have one connection being used throughout all socket functions.

  const app = http.createServer(); // Also works with Express server
  const connection = socket.startSockerServer(app, {
    path: '/socket',
    serveClient: false,
    ...more socket options
  });

All options can be found here

More information on socket.io

addNamespace(name)

Add a new namespace onto the socket. Will always check if the namespace already exists and only add when non-existing.

  socket.addNamespace('superCoolNamespace');

conversation

findConversationById(id)

Find an existing by its id (asynchronous)

  await conversation.findConversationById('...');

findMyConversations(rights, filters)

List all available conversations for a specific department and employment. (asynchronous)

  await conversation.findMyConversations({
      departmentId: '...',
      employmentId: '...',
  },
  {
      limit: 10, // Optional
      offset: 0, // Optional
  })

startConversation(participants)

Start a new conversation (asynchronous)

  await conversation.startConversation({
      employmentIds: ['firstId', 'secondId'],
  });

leave(conversationId, employmentId)

Leave a conversation (asynchronous)

  await conversation.leave('myConvId', 'myEmplId');

deleteConversation(conversationId)

Deletes a conversation (asynchronous)

  await conversation.deleteConversation('myConvId');

markAsRead(conversationId, employmentId)

Mark a conversation as read (asynchronous)

  await conversation.markAsRead('myConvId', 'myEmplId');

addJoinedDepartmentLaterOn(employmentId, departmentIds)

Adds a meta tag indicating when an employment joined a department conversation

  await conversation.addJoinedDepartmentLaterOn('employmentId', ['departmentId']);

message

sendMessage(roomId, message)

Send a message to a specific room (conversation)

  await message.sendMessage('myRoomId', {
    message: 'This is a message',
    senderId: 'specificEmploymentId',
    firstName: 'Willem',
    lastName: 'Le carrotier',
  });

Tests

  • You can run npm run test to run all tests
  • You can run npm run test:coverage to run all tests with coverage report