fix: date objs compare & types

Author: Thanga-Ganapathy

.changeset/breezy-buses-fly.md

@@ -0,0 +1,5 @@
+---
+"@opentf/obj-diff": minor
+---
+
+Added diff function to deep diff two objects.

.changeset/config.json

@@ -7,7 +7,7 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["docs"],
+  "ignore": [],
   "privatePackages": false,
   "bumpVersionsWithWorkspaceProtocolOnly": true
 }

.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Publish package
+        run: cd packages/obj-diff && npx jsr publish

README.md

@@ -1,2 +1,227 @@
+<img align="left" src="https://open-tech-foundation.pages.dev/img/Logo.svg" width="50" height="50">
+
+&nbsp;[OPEN TECH FOUNDATION](https://open-tech-foundation.pages.dev/)
+
+<div align="center">
+
 # obj-diff
-The Fast,Accurate,JavaScript Object Diffing Library.
+
+</div>
+
+> The Fast, Accurate, JavaScript Objects Diffing Library.
+
+## Features
+
+- Deep Objects Diffing
+
+- Supports More Object Types, eg: `Map`, `Set`
+
+- TypeScript Support
+
+## Supported Types
+
+- Primitives
+  - Undefined
+  - Null
+  - Number
+  - String
+  - Boolean
+  - BigInt
+
+- Objects
+  - Plain Objects, eg: `{}`
+  - Array
+  - Date
+  - Map
+  - Set
+
+## Installation
+
+Install it using your favourite package manager.
+
+```sh
+npm install @opentf/obj-diff
+```
+
+```sh
+yarn add @opentf/obj-diff
+```
+
+```sh
+pnpm add @opentf/obj-diff
+```
+
+```sh
+bun add @opentf/obj-diff
+```
+
+```sh
+deno add @opentf/obj-diff
+```
+
+## Usage
+
+```js
+import { diff } from '@opentf/obj-diff';
+
+diff(obj1: object, obj2: object): Array<DiffResult>
+```
+
+```ts
+type DiffResult = {
+  t: 0 | 1 | 2; // The type of diff, 0 - Deleted, 1 - Created, 2 - Updated
+  p: Array<string | number>; // The object path
+  v?: unknown; // The current value
+};
+```
+
+## Examples
+
+1. Diff two simple objects.
+
+```js
+const a = {a: 1, b: 2};
+const b = {a: 2, c: 3};
+
+diff(a, b);
+/*
+[
+  {
+    t: 2,
+    p: ["a"],
+    v: 2,
+  },
+  {
+    t: 0,
+    p: ["b"],
+  },
+  {
+    t: 1,
+    p: ["c"],
+    v: 5,
+  },
+]
+*/
+```
+
+2. Diff two arrays.
+
+```js
+const a = [1, 2, 3, 4, 5];
+const b = [1, 3, 5];
+
+diff(a, b);
+/* 
+[
+  {
+    t: 2,
+    p: [1],
+    v: 3,
+  },
+  {
+    t: 2,
+    p: [2],
+    v: 5,
+  },
+  {
+    t: 0,
+    p: [3],
+  },
+  {
+    t: 0,
+    p: [4],
+  },
+]
+*/
+```
+
+3. Deep diff two objects.
+
+```js
+const a = {
+  foo: {
+    bar: {
+      a: ['a', 'b'],
+      b: 2,
+      c: ['x', 'y'],
+      e: 100
+    }
+  },
+  buzz: 'world'
+};
+
+const b = {
+  foo: {
+    bar: {
+      a: ['a'],
+      b: 2,
+      c: ['x', 'y', 'z'],
+      d: 'Hello, world!'
+    }
+  },
+  buzz: 'fizz'
+};
+
+diff(a, b);
+/*
+[
+  {
+    t: 0,
+    p: ["foo", "bar", "a", 1],
+  },
+  {
+    t: 1,
+    p: ["foo", "bar", "c", 2],
+    v: "z",
+  },
+  {
+    t: 0,
+    p: ["foo", "bar", "e"],
+  },
+  {
+    t: 1,
+    p: ["foo", "bar", "d"],
+    v: "Hello, world!",
+  },
+  {
+    t: 2,
+    p: ["buzz"],
+    v: "fizz",
+  },
+]
+*/
+```
+
+## Benchmark
+
+```diff
+┌───┬──────────────────┬─────────┬───────────────────┬────────┬─────────┐
+│   │ Task Name        │ ops/sec │ Average Time (ns) │ Margin │ Samples │
+├───┼──────────────────┼─────────┼───────────────────┼────────┼─────────┤
++ 0 │ diff             │ 252,694 │ 3957.346814404028 │ ±1.60% │ 25270   │
+│ 1 │ microdiff        │ 218,441 │ 4577.892286564301 │ ±0.92% │ 21845   │
+│ 2 │ deep-object-diff │ 121,385 │ 8238.188318642591 │ ±1.66% │ 12139   │
+│ 3 │ just-diff        │ 105,292 │ 9497.35384615396  │ ±1.66% │ 10530   │
+│ 4 │ deep-diff        │ 160,802 │ 6218.820533549017 │ ±1.59% │ 16081   │
+└───┴──────────────────┴─────────┴───────────────────┴────────┴─────────┘
+```
+
+
+### Running benchmarks
+
+```sh
+$ bun run build
+$ bun benchmark.js
+```
+
+## Articles
+
+Please read our important articles:
+
+- [Introducing Our New JavaScript Standard Library](https://ganapathy.hashnode.dev/introducing-our-new-javascript-standard-library)
+
+- [You Don’t Need JavaScript Native Methods](https://ganapathy.hashnode.dev/you-dont-need-javascript-native-methods)
+
+## License
+
+Copyright (c) [Thanga Ganapathy](https://github.com/Thanga-Ganapathy) ([MIT License](./LICENSE)).

benchmark.js

@@ -1,7 +1,7 @@
 import { Bench, hrtimeNow } from "tinybench";
 import mdiff from "microdiff";
-import { diff } from "./packages/obj-diff/src";
-import { diff as deepObjDiff } from "deep-object-diff";
+import { diff } from "./packages/obj-diff/dist/index";
+import { detailedDiff } from "deep-object-diff";
 import { diff as justDiff } from "just-diff";
 import deepDiff from "deep-diff";
 
@@ -66,7 +66,7 @@ bench
     mdiff(obj1, obj2);
   })
   .add("deep-object-diff", () => {
-    deepObjDiff(obj1, obj2);
+    detailedDiff(obj1, obj2);
   })
   .add("just-diff", () => {
     justDiff(obj1, obj2);

package.json

@@ -1,9 +1,13 @@
 {
   "private": true,
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "pnpm --filter=@opentf/obj-diff run build",
+    "test": "pnpm --filter=@opentf/obj-diff run test",
+    "ci": "pnpm --filter=@opentf/obj-diff run ci",
+    "publish-packages": "pnpm run build && pnpm run test && changeset version && changeset publish"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.27.1",
     "deep-diff": "^1.0.2",
     "deep-object-diff": "^1.1.9",
     "just-diff": "^6.0.2",

packages/obj-diff/__tests__/diff.test.ts

@@ -125,6 +125,8 @@ describe("diff", () => {
   });
 
   test("objects", () => {
+    expect(diff({ a: undefined }, { a: undefined })).toEqual([]);
+    expect(diff({ a: undefined }, {})).toEqual([{ t: 0, p: ["a"] }]);
     expect(diff({ a: 1 }, { a: 1 })).toEqual([]);
     expect(diff({ a: 1 }, { a: 2 })).toEqual([{ t: 2, p: ["a"], v: 2 }]);
     expect(diff({ a: 1 }, { a: 1, b: 2 })).toEqual([{ t: 1, p: ["b"], v: 2 }]);

packages/obj-diff/eslint.config.js

@@ -0,0 +1,10 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+export default [
+  {languageOptions: { globals: {...globals.browser, ...globals.node} }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

packages/obj-diff/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentf/obj-diff",
-  "description": "The Fast,Accurate,JavaScript Object Diffing Library.",
+  "description": "The Fast,Accurate,JavaScript Objects Diffing Library.",
   "version": "0.0.0",
   "author": {
     "name": "Thanga Ganapathy",
@@ -32,8 +32,7 @@
     "build": "tsup",
     "test": "jest",
     "lint": "eslint src/** --fix",
-    "check-types": "tsc --noEmit",
-    "ci": "pnpm run build && pnpm run test && pnpm run lint && pnpm run check-types"
+    "ci": "pnpm run build && pnpm run test && pnpm run lint"
   },
   "files": [
     "dist"
@@ -43,8 +42,14 @@
     "provenance": true
   },
   "devDependencies": {
+    "@eslint/js": "^9.1.1",
+    "@swc/jest": "^0.2.36",
     "@types/jest": "^29.5.12",
+    "eslint": "^9.1.1",
+    "globals": "^15.0.0",
+    "jest": "^29.7.0",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.7.1"
   }
 }