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

@warp-works/warpjs-change-logs

v2.0.2

Published

Change logs library for WarpJS.

Downloads

11

Readme

WarpJS ChangeLogs

This package allows to add change logs to a WarpJS document.

Setup

npm install --save @warp-works/warpjs-change-logs

Usage

const ChangeLogs = require('@warp-works/warpjs-change-logs');

// get the instance
ChangeLogs.add(action, user, instance, data)
// save instance

const resource = ChangeLogs.toFormResource(instance, domain, persistence, routeName, userEntity);

API

.ACTIONS

Object containing list of available actions. Also see issue #1.

.Error

Error thrown if any issue.

.add(action, user, instance, data)

Adds a new change log. This will modify instance in-place and will return instance so it will be easy to chain operations if desired.

Promise.resolve()
  .then(() => somethingToGetInstance(persistence))
  .then((instance) => ChangeLogs.add(
    ChangeLogs.ACTIONS.UPDATE_VALUE, // action
    { id: 1, type: 'User', Name: 'John Doe', UserName: 'jdoe' }, // user
    instance,
    { key: 'Basic:Name', oldValue: 'Jhon Doe', newValue: 'John Doe' } // data
  ))
  .then((instance) => somethingToSave(persistence, instance))
  ...

Parameters:

  • action: For available actions, see ACTIONS. But also consider issue #1.
  • user: Object representation of the user. It should have the form of { id, type, Name, UserName }.
  • instance: Document instance.
  • data: Object to be saved in the change logs. It usually has the form of { key, label, type, id }, but refer to individual action to see what it expects.

.toFormResource(domain, persistence, routeName, userEntity)

Builds an array of change logs resources. This can then be embedded into an HAL resource.

const resource = ...hal...;
Promise.resolve()
  .then(() => ChangeLogs.toFormResource('a', persistence, 'my:route', userEntity))
  .then((changeLogs) => resource.embed('changeLogs', changeLogs))
;

Parameters:

  • domain: Domain name.
  • persistence: Persistence instance.
  • routeName: Name of the route to use from RoutesInfo. It will pass in {domain, type, id}. type and id are taken from the data that was passed in when used .add() above.
  • userEntity: The User entity that will be used to retrieve the display picture.