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

@ubio/protocol

v7.6.7

Published

ubio Automation Protocol

Downloads

220

Readme

ubio Automation Protocol

Terminology

Domain is a collection of input, output and type definitions. Domains are uniquely identified by id which is a PascalCase string. Example: FlightBooking.

Definition is a JSON Schema object, uniquely identified by id, which consists of domain id and definition key, separated with dot. Example: Generic.Price.

Definitions also have $id attribute which is a fragment identifier used to uniquely reference definitions in JSON Schema validation. Example: #Generic.Price.

Quick Start

To make changes to protocol src/schema/ files need to be updated and schema.json regenerated.

Since current codebase may be not compatible with the recent version of nodejs, you may need docker-compose.yml to test changes locally.

Additionally, protocol URL is hardcoded and points to production environment, thus you may need to temporary override it to see changes on http://localhost:8080/. Edit site/provider.js but DO NOT commit it to GH repo with your other changes:

export const provider = new ProtocolProvider({
    url: 'http://localhost:8080/schema.json', // ! \\
    autoRefresh: true,
    ttl: 60000
});

Build ./public static files:

$ docker-compose run build

Run nginx and open browser to test it:

$ docker-compose up nginx -d
$ open 'http://localhost:8080/'

Shut down and cleanup when done:

$ docker-compose down

Don't forget to revert site/provider.js:

$ git checkout site/provider.js

Good luck!