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

@slip-sockets/stack

v4.0.7

Published

A serverless GRIP/Pushpin like WebSocket server for AWS API Gateway

Downloads

17

Readme

SLIP Sockets Stack

This library and CDK project creates a websocket server similar to PUSHPIN and the GRIP protocol. It will make HTTP requests to your backend app in response to events (connection, disconnection and text frames). It manages a pub sub infrastructure so you can publish events to all connected websockets, and it has a client library for communication.

This is the CDK Stack for slip-sockets. It will create the aws infrastructure needed to run the Slip Socket websocket server.

Database

This will create a DDB table called Connections

  • partitionKey: connectionId
  • sortKey: channel

It also has a GSI for fetching connections in a channel

  • partitionKey: channel

CDK Stack / CLI

You may clone this repository and use the CDK cli to deploy the infrastructure with ENV varible configurations. It's name is defaults to slip-sockets but it can be configured with environment variables.

The following environment variables are used to configure the stack;

  • TARGET_URL - the url to send events to (required)
  • JWT_SECRET - the secret used to sign JWT tokens (required)
  • STACK_NAME - the name of the stack (optional, defaults to slip-sockets)
  • DOMAIN_NAME - the custom domain name to use for the websocket, the DNS must be managed by route53 (optional)

The stack has the following outputs, they are written to a file called cdk-outputs.json in the root of the project and output when deployed.

  • slip-sockets.controlApi - URL of the controlApi for the SlipSocketsPublisher
  • slip-sockets.targetUrl - URL of your backend app
  • slip-sockets.websocketUrl - wss:// url for clients to connect to
  • slip-sockets.region - AWS region of the stack

Useful commands

For most of these commands the required environment variables must be set

  • pnpm run deploy:production deploy this stack to your default AWS account/region
  • pnpm run deploy:staging deploy this stack to your default AWS account/region
  • pnpm cdk diff compare deployed stack with current state
  • pnpm cdk synth emits the synthesized CloudFormation template
  • pnpm npx wscat -c wss://your-url-hostname connect to the websocket with wscat, first deploy might take a few minutes after deploy to respond