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

json-patch-query

v1.5.1

Published

Implementation of JSON Patch Query as proposed by the TM Forum

Downloads

8,670

Readme

JSON Patch Query

This library aims to implement the specification outlined by the TM Forum outlined here

Usage

JSONPatchQuery.apply(document: any, patch: Operation[]): any

Accepts a document and an array of patch operations to be performed on the document. Individual patch operation must adhere to the operations listed in JSON Patch RFC6902 and use a path property that adheres to the JSON Path Format.

Returns the mutated document.

Examples

For working examples of JSON Patch Query, look at the src/test/unit.test.ts file in this repository, where there a wide variety of examples executing the different operations.

Edge Cases

Consider a document that has two items that may have an ambiguous JSON path, in this case, it's two orderItem objects that have productOffering.id equal to 1513:

{
  "id": "3774",
  "description": "This product order covers ...",
  "requestedCompletionDate": "2017-07-14",
  "orderItem": [{
    "action": "add",
    "quantity": 1,
    "productOffering": {
      "href": "/productOffering/1513",
      "id": "1513",
      "name": "Offer Good Plan"
    },
    "product": {
      "relatedParty": [{
        "id": "7894",
        "name": "Mary",
        "role": "customer"
      }]
    }
  }, {
    "action": "add",
    "quantity": 2,
    "productOffering": {
      "href": "/productOffering/1513",
      "id": "1513",
      "name": "Offer Good Plan"
    },
    "product": {
      "relatedParty": [{
        "id": "3456",
        "name": "John",
        "role": "customer"
      }]
    }
  }]
}

You may update the relatedParty of a specific orderItem with a JSON path as follows:

// Update the name where the relatedParty.id of the product is 7894
$.orderItem[?(@.productOffering.id=="1513")].product.relatedParty[?(@.id=="7894")].name

However, if you wanted to update the quantity of the same orderItem, a JSON path with a query would not be possible, instead you would need to provide the index upfront.

// ❌ JSON Path does not support nested queries, quantity cannot be updated this way
$.orderItem[?(@.productOffering.id=="1513" && @.product.relatedParty[?(@.id=="7894")])].quantity

// ✅ Update the quantity of the orderItem where the relatedParty.id of the product is 7894 (with a fixed index)
$.orderItem[?(@.productOffering.id=="1513" && @.product.relatedParty[0].id=="7894")].quantity

This limitation is due to the way that JSON Path traverses the document whilst performing the query. Once it has gone down the tree, it can no longer go back up the tree to retrieve the property. Additionally, nested queries are not supported within JSON Path.

That is, unlike XPath, JSON Path does not have operations for accessing parent or sibling nodes from the given node.