Package Health Score

51 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.0.6	\|	09/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.2	\|	06/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.3	\|	11/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.2	\|	08/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	06/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (4,633)

GitHub Stars: 104
Forks: 13
Contributors: 20

Direct Usage Popularity

The npm package json8-patch receives a total of 4,633 downloads a week. As such, we scored json8-patch popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package json8-patch, we found that it has been starred 104 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the json8-patch repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like json8-patch is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 7
Open PR: 15
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of json8-patch based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for json8-patch is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 7.6.0

Age: 9 years
Dependencies: 2 Direct
Versions: 18
Install Size: 30.7 kB
Dist-tags: 1
# of Files: 23
Maintainers: 1
TS Typings: Yes

json8-patch has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use json8-patch?

To help you get started, we've collected the most common ways that json8-patch is being used within popular public projects.

caohanyang / json_diff_rfc6902 / tests / diff.js View on Github

console.time("jdr-diff");
  // var jdr_patch = jdr.diff(f_old, f_new);  , HASH_ID: "title"
  var jdr_patch = jdr.diff(f_old, f_new, {OBJ_COM: true, ARR_COM: true});
  console.timeEnd("jdr-diff");

  console.time("jiff-diff");
  var jiff_patch = jiff.diff(f_old, f_new, jiff_options);
  console.timeEnd("jiff-diff");
  console.time("fjp-diff");
  var fjp_patch = fjp.compare(f_old, f_new);
  console.timeEnd("fjp-diff");
  console.time("rfc6902");
  var rfc6902_patch = rfc6902.createPatch(f_old, f_new);
  console.timeEnd("rfc6902");
  console.time("json8");
  var json8_patch = json8.diff(f_old, f_new);
  console.timeEnd("json8");

  // Use fjp to apply the patch fjp_patch jdr_patch jiff_patch
  fjp.apply(f_old, fjp_patch);

  jdr.apply(app_old, jdr_patch);

  fs.writeFile(root + "jdr_patch.json", JSON.stringify(jdr_patch, null, 2));
  fs.writeFile(root + "fjp_patch.json", JSON.stringify(fjp_patch, null, 2));
  fs.writeFile(root + "jiff_patch.json", JSON.stringify(jiff_patch, null, 2));
  fs.writeFile(root + "rfc6902_patch.json", JSON.stringify(rfc6902_patch, null, 2));
  fs.writeFile(root + "json8_patch.json", JSON.stringify(json8_patch, null, 2));
  fs.writeFile(root + "fjp_new.json", JSON.stringify(f_old, null, 2));
  fs.writeFile(root + "jdr_new.json", JSON.stringify(app_old, null, 2));
  // fs.writeFile(root + "new_ori.json", JSON.stringify(f_new, null, 2));
  // fs.writeFile(root + "old_ori.json", JSON.stringify(old_ori, null, 2));

View more ways to use json8-patch

JSON8 Patch

Introduction

JSON Patch RFC 6902 (and diff) implementation for JavaScript.

See jsonpatch.com for more information about JSON Patch.

JSON8 Patch passes the entire json-patch-tests suite; see Tests

Introduction
Comparison
Getting started
Methods
- apply
- patch
- revert
- buildRevertPatch
- diff
- valid
- concat
- Operations
  - add
  - remove
  - replace
  - move
  - copy
  - test
- Extra operations
  - get
  - has
- Patch size
  - pack
  - unpack

Comparison

module	root₀	atomic₁	mutates₂
json8-patch	☑	☑	☑
jsonpatch	☑	☐	☑
jiff	☑	☐	☑
json-patch	☐	☐	☑
fast-json-patch	☐	☐	☑

Getting started

npm install json8-patch

const ooPatch = require("json8-patch");

For performance concerns JSON8 Patch may mutate target document; if you want it to use its own copy use:

var oo = require("json8");
var myDocument = { foo: "bar" };
var doc = oo.clone(myDocument);

See clone.

JSON8 Patch never mutates patches.

↑

Methods

apply

demo/playground

doc = ooPatch.apply(doc, patch).doc;

ooPatch.apply (and other ooPatch methods) returns an object with a doc property because per specification a patch can replace the original root document.

The operation is atomic, if any of the patch operation fails, the document will be restored to its original state and an error will be thrown.

↑

patch

Alias for apply method.

↑

revert

If the patch or apply method is called with a third argument {reversible: true} it will return an additional value in the form of a revert property.

The revert object can be used to revert a patch on a document.

// apply the patch with the reversible option
var applyResult = ooPatch.apply(doc, patch, { reversible: true });
doc = applyResult.doc;

// revert the patch
doc = ooPatch.revert(doc, applyResult.revert).doc;
// doc is strictly identical to the original

See also buildRevertPatch which offers more flexibility.

↑

buildRevertPatch

demo/playground

Builds a valid JSON Patch from the result of a reversible apply operation. You can then use this patch with apply method to revert a previously applied patch.

// apply the patch
var applyResult = ooPatch.apply(doc, patch, { reversible: true });
doc = applyResult.doc;

// revert the patch
var revertPatch = ooPatch.buildRevertPatch(applyResult.revert); // this is a valid JSON Patch
doc = ooPatch.apply(doc, revertPatch).doc;
// doc is strictly identical to the original

Because buildRevertPatch + apply offers more flexibility over revert it is preferred.

use pack/unpack with the result of buildRevertPatch making it ideal for storage or transport
reverse a revert (and so on...) with {reversible: true}
diff between reverts
merge multiple reverts into one
rebase reverts

↑

diff

demo/playground

Returns a diff in the form of a JSON Patch for 2 JSON values.

ooPatch.diff(true, false);
// [{"op": "replace", "path": "", "value": "false"}]

ooPatch.diff([], []);
// []

ooPatch.diff({}, { foo: "bar" });
// [{"op": "add", "path": "/foo", "value": "bar"}]

↑

valid

Returns true if the patch is valid, false otherwise.

This method only check for JSON Patch semantic. If you need to verify the patch is JSON valid, use oo.valid

ooPatch.valid({})  // false
ooPatch.valid([{}] // false
ooPatch.valid([{op: "foo", path: null, value: undefined}]) // false
ooPatch.valid([{op: "add", path: "/foo"}]) // false

ooPatch.valid([]) // true
ooPatch.valid([{op: "add", path: "/foo", value: "bar"}]) // true

↑

concat

Concats multiple patches into one.

var patch1 = [{ op: "add", value: "bar", path: "/foo" }];
var patch2 = [{ op: "remove", path: "/foo" }];
var patch = ooPatch.concat(patch1, patch2);
// patch is
// [
//   { op: "add", value: "bar", path: "/foo" },
//   { op: "remove", path: "/foo" }
// ];

↑

Operations

add, copy, replace, move, remove, test operations return an object of the form {doc: document, previous: value}

doc is the patched document
previous is the previous/replaced value

add

doc = ooPatch.add(doc, "/foo", "foo").doc;

↑

remove

doc = ooPatch.remove(doc, "/foo").doc;

↑

replace

doc = ooPatch.replace(doc, "/foo", "foo").doc;

↑

move

doc = ooPatch.move(doc, "/foo", "/bar").doc;

↑

copy

doc = ooPatch.copy(doc, "/foo", "/bar").doc;

↑

test

doc = ooPatch.test(doc, "/foo", "bar").doc;

↑

Extra operations

Those are not part of the standard and are only provided for convenience.

get

ooPatch.get(doc, "/foo");
// returns value at /foo

↑

has

ooPatch.has(doc, "/foo");
// returns true if there is a value at /foo

↑

Patch size

Per specification patches are pretty verbose. JSON8 provides pack and unpack methods to reduce the size of patches and save memory/space/bandwidth.

Size (in bytes) comparaison for the following patch file

[
  { "op": "add", "path": "/a/b/c", "value": ["foo", "bar"] },
  { "op": "remove", "path": "/a/b/c" },
  { "op": "replace", "path": "/a/b/c", "value": 42 },
  { "op": "move", "from": "/a/b/c", "path": "/a/b/d" },
  { "op": "copy", "from": "/a/b/c", "path": "/a/b/e" },
  { "op": "test", "path": "/a/b/c", "value": "foo" }
]

format	size (in bytes)
unpacked	313
unpacked gzip	148
packed	151
packed gzip	99

In pratice I'd recommand to use pack/unpack if

data compression cannot be used on the transport of the patch
keeping a large amount of patches in memory/on disk

↑

pack

demo/playground

var patch = [
  { op: "add", path: "/a/b/c", value: ["foo", "bar"] },
  { op: "remove", path: "/a/b/c" },
  { op: "replace", path: "/a/b/c", value: 42 },
  { op: "move", from: "/a/b/c", path: "/a/b/d" },
  { op: "copy", from: "/a/b/c", path: "/a/b/e" },
  { op: "test", path: "/a/b/c", value: "foo" },
];

var packed = ooPatch.pack(patch);

Here is what packed looks like

[
  [0, "/a/b/c", ["foo", "bar"]],
  [1, "/a/b/c"],
  [2, "/a/b/c", 42],
  [3, "/a/b/d", "/a/b/c"],
  [4, "/a/b/e", "/a/b/c"],
  [5, "/a/b/c", "foo"]
]

↑

unpack

demo/playground

var patch = ooPatch.unpack(packed);
// [{...}, {...}, ...]

↑

Footnotes

root

Refers to the library ability to replace/remove root (/) on your target.

Lack of this ability makes the library unable to comply with the specification and will result in unknown/inconsistent states for your target documents.

[
  { "op": "replace", "path": "/", "value": "{}" },
  { "op": "remove", "path": "/" }
]

atomic

Refers to the library ability to revert successful patch operations after a failure on the mutated target.

Lack of this ability makes the library unable to comply with the specification and will result in unknown/inconsistent states for your target documents.

https://tools.ietf.org/html/rfc6902#section-5

mutates

Refers to the ability of the library to mutates the target document.

It is best to choose a library which mutate the target document because it leaves you with the choice of creating a shallow copy first.

↑

json8-patch dependencies

json8 json8-pointer

json8-patch development dependencies

fast-json-patch jiff json-patch json-patch-test-suite jsonpatch

FAQs

What is json8-patch?

JSON Patch toolkit for JavaScript. Visit Snyk Advisor to see a full health score report for json8-patch, including popularity, security, maintenance & community analysis.

Is json8-patch popular?

The npm package json8-patch receives a total of 4,633 weekly downloads. As such, json8-patch popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is json8-patch well maintained?

We found indications that json8-patch is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is json8-patch safe to use?

The npm package json8-patch was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 November-2024, at 08:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,633)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use json8-patch?

JSON8 Patch

Introduction

Comparison

Getting started

Methods

apply

patch

revert

buildRevertPatch

diff

valid

concat

Operations

add

remove

replace

move

copy

test

Extra operations

get

has

Patch size

pack

unpack

Footnotes

root

atomic

mutates

json8-patch dependencies

json8-patch development dependencies

FAQs

What is json8-patch?

Is json8-patch popular?

Is json8-patch well maintained?

Is json8-patch safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues