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

warehouse.ai-status-models

v2.0.3

Published

models for warehouse.ai-status-api

Downloads

10

Readme

warehouse.ai-status-models

Version npm License npm Downloads Build Status Dependencies

Datastar models for the Warehouse.ai-status-api.

Install

npm install warehouse.ai-status-models --save

Usage

const dynamoClient = new AWS.DynamoDB({ /* connection config */ });
const dynamodb = require('dynamodb');
dynamodb.dynamoDriver(dynamoClient);
const models = require('warehouse.ai-status-models')(dynamodb);

// from dynastar.define we get...
const Status = models.Status;

Status.findOne({ ... }).then(res => { ... }).catch(err => { ... });

API

All schemas for the API documentation are written using Joi notation.

Schemas

Status (Status)

Generic status information

Column | Type | Summary ------------------ | ---------------- | ------------ pkg (pk) | string | Name of a package env (pk) | string | What environment is this build made for (dev, test, etc.) version (pk) | string | What version of a package does this status represent previousVersion | string | The previous version number total | number | Total progress as percentage error | boolean | Did the build error createdAt | timestamp | Time of creation updatedAt | timestamp | Time of last update complete | boolean | Did the build complete

StatusHead (StatusHead)

Generic status information but just for he latest version for a given pkg and env. Refer to the table above for details. The properties error and complete do not exist on this table.

StatusEvent (StatusEvent)

A detailed event for the various stages of a build process containing message and optional details properties as well as locale and whether it is and error or not.

Column | Type | Summary ------------------ | ---------------- | ------------ pkg (pk) | string | Name of a package env (pk) | string | What environment is this build made for (dev, test, etc.) version (pk) | string | What version of a package does this status represent locale | string | Build locale error | boolean | Is the status event an error message | string | Status message details | string | Message details createdAt | timestamp | Time of creation eventId | string (timeUUID)| Unique id sortable by time

StatusCounter (StatusCounter)

A simple distributed counter model that is incremented when a locale build has completed in order to compute progress based on total amount of locales.

Column | Type | Summary ------------------ | ---------------- | ------------ pkg (pk) | string | Name of a package env (pk) | string | What environment is this build made for (dev, test, etc.) version (pk) | string | What version of a package does this status represent count | counter | Incrementable counter

Test

Before running tests, spin up an instance of localstack by running

npm run localstack

Then run:

npm test