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

wrms

v0.0.3

Published

WRMS API wrapper

Downloads

11

Readme

WRMS interface

An API client interface to WRMS.

pipeline status coverage report

Usage

const WRMS = require('wrms')
const wrms = new WRMS({
                        endpoint: 'https://wrms.example.org',
                        username: 'username',
                        password: 'password'
                      })

wrms.user.lookup({field: 'email', key: '[email protected]'})
    .then((res) => {
        // res is a resultset of users
    })

wrms.work_request.search({q: 'search term'})
    .then((res) => {
        // res is a resultset of work requests
    })

Tests

Credentials for tests live in .env. These need to be valid for your WRMS environment (eg WRMS_TEST_USER_MAIL will be an existing user's email). See tests for more.

WRMS_URL=https://wrms.example.org
WRMS_USERNAME=exampleuser
WRMS_PASSWORD=secretpass
[email protected]
WRMS_TEST_WR_SEARCH_TERM="search term"
WRMS_TEST_WR_ID=123

But wait! There's more variables you can set in .env.

  • WRMS_SSL_INSECURE=true when someone forgets to renew a cert

TODO

  • Permit new WRMS(creds) to accept { endpoint: 'xx', wrms3_auth: 'xyz' } if we already have a cookie. (Is this a good idea or does it encourage bad ones?)
  • Do we need WRMSv2 API endpoints? Seems like there are some useful parts there, like "recent timesheets".
  • If WRMS_EXTRA_COOKIES isn't set, politely reject calls to v2 API.
  • docs/assign-user.js - WRMS forms don't let you easily assign a user to a ticket outside their systems, but I suspect API will.
  • Is api.php/times/record API v1, and api2/request_update API v2? Does API v2 correspond to WRMS v3? (api2/login returns wrms3_auth cookie). Yes. API v1 is WRMS v2; API v2 is WRMS v3.

References

Related projects

Other things that might be of interest.