json-joy

What is json-joy?

The json-joy npm package provides a set of tools for working with JSON data, including JSON Patch, JSON CRDT (Conflict-free Replicated Data Types), and JSON Schema validation. It is designed to facilitate collaborative applications and data synchronization.

What are json-joy's main functionalities?

JSON Patch

JSON Patch allows you to apply a series of operations to a JSON document. The code sample demonstrates how to replace the value of a key in a JSON object.

const { applyPatch } = require('json-joy/lib/json-patch');

const document = { foo: 'bar' };
const patch = [{ op: 'replace', path: '/foo', value: 'baz' }];
const result = applyPatch(document, patch);
console.log(result); // { foo: 'baz' }

JSON CRDT

JSON CRDTs (Conflict-free Replicated Data Types) enable collaborative editing and data synchronization. The code sample shows how to create a CRDT and apply an operation to set a value.

const { createCRDT } = require('json-joy/lib/crdt');

const crdt = createCRDT();
crdt.apply({ type: 'set', path: '/foo', value: 'bar' });
console.log(crdt.state); // { foo: 'bar' }

JSON Schema Validation

JSON Schema Validation allows you to validate JSON documents against a schema. The code sample demonstrates how to validate a JSON object against a schema.

const { validate } = require('json-joy/lib/json-schema');

const schema = { type: 'object', properties: { foo: { type: 'string' } }, required: ['foo'] };
const document = { foo: 'bar' };
const result = validate(schema, document);
console.log(result.valid); // true

Other packages similar to json-joy

fast-json-patch

fast-json-patch is a library for applying JSON Patch operations. It is similar to json-joy's JSON Patch functionality but focuses solely on JSON Patch operations without additional features like CRDT or schema validation.

json-schema

json-schema is a library for validating JSON documents against JSON Schema. It is similar to json-joy's JSON Schema validation functionality but does not include JSON Patch or CRDT features.

automerge

automerge is a library for building collaborative applications using CRDTs. It is similar to json-joy's CRDT functionality but focuses more on collaborative editing and data synchronization.

README

json-joy

json-joy library implements cutting-edge real-time and collaborative editing algorithms and other utilities for JSON data models. Major focus of json-joy is development of the JSON CRDT protocol, a Conflict-free Replicated Data Type that enables seamless merging of changes in JSON data models, avoiding conflicts between replicas.

• Website
• Documentation
• Blog posts
  • Fuzz Testing RGA CRDT
  • Benchmarking JSON Serialization Codecs
  • List CRDT Benchmarks
  • Blazing Fast List CRDT
• JSON CRDT specification
• JSON CRDT Patch specification
• JSON Expression specification
• JSON Reactive RPC specification
• Compact JSON encoding
• API Reference
• Test coverage

Notable features

• Full JSON implementation as a CRDT (Conflict-free Replicated Datatype).
• The fastest list CRDT implementation in JavaScript.
• The fastest text OT (Operational Transformation) implementation in JavaScript.
• The fastest implementation of CBOR, DAG-CBOR, MessagePack, UBJSON, and JSON codecs in JavaScript.
• The fastest (HTTP) router implementation in JavaScript.
• The fastest JSON schema validation implementation in JavaScript.
• Very fast binary tree (Radix, AVL, Red-black*, Splay) implementations in JavaScript.
• Very fast JSON Patch (and JSON Pointer) implementation in JavaScript, including many non-standard operations, and JSON Predicate implementation.
• Very fast JSON Expression implementation in JavaScript.