json-diff-ts 4.8.0 → 4.8.1

package/README.md

@@ -10,7 +10,6 @@
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Node.js](https://img.shields.io/node/v/json-diff-ts.svg)](https://nodejs.org/)
 
 ## Overview
 
@@ -18,9 +17,9 @@
 
 ### 🚀 **Why Choose json-diff-ts?**
 
-- **🔥 Zero dependencies** - Lightweight bundle size (21KB minified)
+- **🔥 Zero dependencies** - Lightweight bundle size
 - **⚡ High performance** - Optimized algorithms for fast JSON diffing and patching
-- **🎯 94%+ test coverage** - Thoroughly tested with comprehensive test suite
+- **🎯 95%+ test coverage** - Thoroughly tested with comprehensive test suite
 - **📦 Modern ES modules** - Full TypeScript support with tree-shaking
 - **🔧 Flexible API** - Compare, diff, patch, and atomic operations
 - **🌐 Universal** - Works in browsers, Node.js, and edge environments
@@ -117,6 +116,14 @@ const newData = {
 };
 
 const diffs = diff(oldData, newData, { embeddedObjKeys: { characters: 'id' } });
+console.log(diffs);
+// First operations:
+// [
+//   { type: 'UPDATE', key: 'location', value: 'Yavin Base', oldValue: 'Tatooine' },
+//   { type: 'UPDATE', key: 'mission', value: 'Destroy Death Star', oldValue: 'Rescue Princess' },
+//   { type: 'UPDATE', key: 'status', value: 'Complete', oldValue: 'In Progress' },
+//   ...
+// ]
 ```
 
 #### Advanced Options
@@ -245,10 +252,14 @@ Apply or revert changes to JSON objects.
 import { applyChangeset, revertChangeset } from 'json-diff-ts';
 
 // Apply changes
-applyChangeset(oldData, diffs);
-
-// Revert changes  
-revertChangeset(newData, diffs);
+const updated = applyChangeset(oldData, diffs);
+console.log(updated);
+// { location: 'Yavin Base', mission: 'Destroy Death Star', status: 'Complete', ... }
+
+// Revert changes
+const reverted = revertChangeset(newData, diffs);
+console.log(reverted);
+// { location: 'Tatooine', mission: 'Rescue Princess', status: 'In Progress', ... }
 ```
 
 ## API Reference
@@ -282,6 +293,12 @@ interface Options {
 }
 ```
 
+| Option | Type | Description |
+| ------ | ---- | ----------- |
+| `embeddedObjKeys` | `Record<string, string | Function>` or `Map<string | RegExp, string | Function>` | Map paths of arrays to a key or resolver function used to match elements when diffing. Use a `Map` for regex paths. |
+| `keysToSkip` | `string[]` | Dotted paths to exclude from comparison, e.g. `"meta.info"`. |
+| `treatTypeChangeAsReplace` | `boolean` | When `true` (default), a type change results in a REMOVE/ADD pair. Set to `false` to treat it as an UPDATE. |
+
 ### Change Types
 
 ```typescript
@@ -294,6 +311,7 @@ enum Operation {
 
 ## Release Notes
 
+- **v4.8.1:** Improved documentation with working examples and detailed options.
 - **v4.8.0:** Significantly reduced bundle size by completely removing es-toolkit dependency and implementing custom utility functions. This change eliminates external dependencies while maintaining identical functionality and improving performance.
 
 - **v4.7.0:** Optimized bundle size and performance by replacing es-toolkit/compat with es-toolkit for difference, intersection, and keyBy functions
@@ -388,4 +406,4 @@ This project takes inspiration and code from [diff-json](https://www.npmjs.com/p
 
 json-diff-ts is open-sourced software licensed under the [MIT license](LICENSE).
 
-The original diff-json project is also under the MIT License. For more information, refer to its [license details](https://www.npmjs.com/package/diff-json#license).
+The original diff-json project is also under the MIT License. For more information, refer to its [license details](https://www.npmjs.com/package/diff-json#license).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-diff-ts",
-  "version": "4.8.0",
+  "version": "4.8.1",
   "description": "Modern TypeScript JSON diff library - Zero dependencies, high performance, ESM + CommonJS support. Calculate and apply differences between JSON objects with advanced features like key-based array diffing, JSONPath support, and atomic changesets.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",