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

@tillhub/schemas

v6.347.0

Published

All Tillhub API OpenAPI 3 compatible JSON Schemas.

Downloads

3,919

Readme

Tillhub API Schemas CircleCI semantic-release

All Tillhub API OpenAPI 3 compatible JSON Schemas.

Getting Started

npm install @tillhub/schemas

Use this library to pre-validate request objects. This will always be up-to-date and versioned, since the Tillhub API uses this library as well.

const createCartSchema = require('@tillhub/schemas').v1.carts.create.request
console.log(createCartSchema)
// prints a JS object of the full schema
// {
//   type: 'object',
//   additionalProperties: true,
//   properties: {
//     ...
//   }
// }

Release flow

Releases are automated with @semantic-release. For triggering a new release just use commit messages started from "feat" or "fix" prefix which is part of proper message format (please do not forget about it!).

CricleCI takes care of publishing the package. it will only trigger on the master branch. After the PR is merged into master, CircleCI will start the deployment process:

  1. It will checkout the project and installs the dependencies.
  2. Linter will check the code.
  3. It will run the tests to make sure everything runs perfectly.
  4. Code will be compiled.
  5. Finally, it will publish the new version by running semantic-release.

Contributing

Contributions are welcome in the case of falsy information. Those schemas are used as internaly driven data logic and quality.

Contributors should commit only via the following command. Deployment and change tracking is automatised by the underlying semantic-release implementation.

npm run commit

Resources CRUD CLI

Use the schema cli to create new resources automatically using Hygen:

$ npm run new:schema
> # interactive CLI

It will create the resources for the new schema and the route for it. Feel free to edit any files you need and don't forget to add the custom properties (if necessary) on:

/lib/<version>/base.js

License

Apache-2.0