feat: improve diff values typing

DoneDeal0 · DoneDeal0 · commit e20a14b5b731 · 2026-05-25T21:04:11.000+02:00
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -7,4 +7,5 @@ export default [
   { settings: { react: { version: "detect" } } },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
+  { rules: { "preserve-caught-error": "off" } },
 ];
diff --git a/jest.setup.ts b/jest.setup.ts
@@ -1,6 +1,4 @@
 import { TextEncoder, TextDecoder } from "util";
 
-//@ts-expect-error - the TextEncoder is valid
 global.TextEncoder = TextEncoder;
-//@ts-expect-error - the TextDecoder is valid
 global.TextDecoder = TextDecoder;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@donedeal0/superdiff",
-  "version": "4.2.2",
+  "version": "4.2.3",
   "type": "module",
   "description": "Superdiff provides a rich and readable diff for arrays, objects, texts and coordinates. It supports stream and file inputs for handling large datasets efficiently, is battle-tested, has zero dependencies, and offers a top-tier performance.",
   "main": "dist/index.js",
@@ -45,42 +45,42 @@
       ]
     ]
   },
- "keywords": [
-  "array-comparison",
-  "array-diff",
-  "chunks",
-  "code-diff",
-  "compare",
-  "comparison-tool",
-  "coordinates",
-  "data-diff",
-  "deep-comparison",
-  "deep-diff",
-  "deep-object-diff",
-  "diff",
-  "file-diff",
-  "geo-diff",
-  "geo-distance",
-  "haversine",
-  "isequal",
-  "json-diff",
-  "json",
-  "lat-long",
-  "lcs",
-  "list-diff",
-  "object-comparison",
-  "object-diff",
-  "object-difference",
-  "object",
-  "stream-diff",
-  "streaming-diff",
-  "streaming",
-  "string-diff",
-  "text-diff",
-  "textdiff",
-  "vincenty",
-  "word-diff"
-],
+  "keywords": [
+    "array-comparison",
+    "array-diff",
+    "chunks",
+    "code-diff",
+    "compare",
+    "comparison-tool",
+    "coordinates",
+    "data-diff",
+    "deep-comparison",
+    "deep-diff",
+    "deep-object-diff",
+    "diff",
+    "file-diff",
+    "geo-diff",
+    "geo-distance",
+    "haversine",
+    "isequal",
+    "json-diff",
+    "json",
+    "lat-long",
+    "lcs",
+    "list-diff",
+    "object-comparison",
+    "object-diff",
+    "object-difference",
+    "object",
+    "stream-diff",
+    "streaming-diff",
+    "streaming",
+    "string-diff",
+    "text-diff",
+    "textdiff",
+    "vincenty",
+    "word-diff"
+  ],
   "scripts": {
     "benchmark": "tsx benchmark/index.ts",
     "build": "tsup",
@@ -93,32 +93,33 @@
     "tsc": "tsc --noEmit --incremental"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
+    "@eslint/js": "^10.0.1",
     "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",
-    "@swc/core": "^1.15.8",
+    "@swc/core": "^1.15.40",
     "@swc/jest": "^0.2.39",
     "@types/arr-diff": "^4.0.3",
     "@types/deep-diff": "^1.0.5",
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.9.1",
     "arr-diff": "^4.0.0",
     "blob-polyfill": "^9.0.20240710",
     "deep-diff": "^1.0.2",
     "deep-object-diff": "^1.1.9",
     "diff": "^8.0.2",
-    "eslint": "^9.21.0",
+    "eslint": "^10.4.0",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jsdom": "^26.0.0",
+    "jest": "^30.4.2",
+    "jest-environment-jsdom": "^30.4.1",
+    "jsdom": "^29.1.1",
     "microdiff": "^1.5.0",
-    "prettier": "^3.5.2",
-    "swc-loader": "^0.2.6",
+    "prettier": "^3.8.3",
+    "swc-loader": "^0.2.7",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.52.0",
-    "web-streams-polyfill": "^4.2.0"
+    "tsx": "^4.22.3",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.60.0",
+    "web-streams-polyfill": "^4.3.0"
   }
 }
diff --git a/src/lib/list-diff/index.ts b/src/lib/list-diff/index.ts
@@ -19,12 +19,12 @@ function getDiffStatus(statusMap: Set<ListStatus>): ListStatus {
   return ListStatus.UPDATED;
 }
 
-function getLeanDiff(
-  diff: ListDiff["diff"],
+function getLeanDiff<T>(
+  diff: ListDiff<T>["diff"],
   showOnly: ListDiffOptions["showOnly"] = [],
-): ListDiff["diff"] {
+): ListDiff<T>["diff"] {
   const set = new Set(showOnly);
-  const leanDiff: ListDiff["diff"] = [];
+  const leanDiff: ListDiff<T>["diff"] = [];
   for (let i = 0; i < diff.length; i++) {
     if (set.has(diff[i].status)) {
       leanDiff.push(diff[i]);
@@ -37,8 +37,8 @@ function formatSingleListDiff<T>(
   listData: T[],
   status: ListStatus,
   options: ListDiffOptions,
-): ListDiff {
-  const diff: ListDiff["diff"] = new Array(listData.length);
+): ListDiff<T> {
+  const diff: ListDiff<T>["diff"] = new Array(listData.length);
   const isAdded = status === ListStatus.ADDED;
   for (let i = 0; i < listData.length; i++) {
     diff[i] = {
@@ -89,7 +89,7 @@ export const getListDiff = <T>(
   prevList: T[] | undefined | null,
   nextList: T[] | undefined | null,
   options: ListDiffOptions = DEFAULT_LIST_DIFF_OPTIONS,
-): ListDiff => {
+): ListDiff<T> => {
   if (!prevList && !nextList) {
     return { type: "list", status: ListStatus.EQUAL, diff: [] };
   }
@@ -100,7 +100,7 @@ export const getListDiff = <T>(
     return formatSingleListDiff(prevList as T[], ListStatus.DELETED, options);
   }
 
-  const diff: ListDiff["diff"] = [];
+  const diff: ListDiff<T>["diff"] = [];
   const previousMap = new Map<string, ListData<T>>();
   const statusMap = new Set<ListStatus>();
   const { referenceKey, ignoreArrayOrder } = options;
diff --git a/src/lib/stream-list-diff/client/stream-list-diff-client.test.ts b/src/lib/stream-list-diff/client/stream-list-diff-client.test.ts
@@ -2,15 +2,15 @@
  * @jest-environment jsdom
  */
 import "blob-polyfill";
-import { ReadableStream } from "web-streams-polyfill";
+import { ReadableStream as ReadableStreamPolyfill } from "web-streams-polyfill";
 import prevListFile from "@mocks/prevList.json";
 import nextListFile from "@mocks/nextList.json";
 import { ListStatus } from "@models/list";
 import { StreamListDiff } from "@models/stream";
 import { streamListDiff } from ".";
 
 // @ts-expect-error - the ReadableStream polyfill is necessary to test ReadableStream in a Node environment.
-global.ReadableStream = ReadableStream;
+global.ReadableStream = ReadableStreamPolyfill;
 
 describe("data emission", () => {
   it("emits 'data' event and consider the all the nextList added if no prevList is provided", (done) => {
diff --git a/src/lib/stream-list-diff/client/stream-list-diff-client.worker.test.ts b/src/lib/stream-list-diff/client/stream-list-diff-client.worker.test.ts
@@ -2,8 +2,7 @@
  * @jest-environment jsdom
  */
 import "blob-polyfill";
-import "jsdom";
-import { ReadableStream } from "web-streams-polyfill";
+import { ReadableStream as ReadableStreamPolyfill } from "web-streams-polyfill";
 import prevListFile from "@mocks/prevList.json";
 import nextListFile from "@mocks/nextList.json";
 import { ListStatus } from "@models/list";
@@ -55,7 +54,7 @@ class Worker {
 // @ts-expect-error - a Worker polyfill is necessary to test a Web Worker in a Node environment.
 global.Worker = Worker;
 // @ts-expect-error - the ReadableStream polyfill is necessary to test ReadableStream in a Node environment.
-global.ReadableStream = ReadableStream;
+global.ReadableStream = ReadableStreamPolyfill;
 
 describe("data emission", () => {
   it("emits 'data' event and consider the all the nextList added if no prevList is provided", (done) => {
diff --git a/src/lib/stream-list-diff/server/worker/utils.ts b/src/lib/stream-list-diff/server/worker/utils.ts
@@ -54,7 +54,7 @@ export async function generateWorker<T extends Record<string, unknown>>(
         worker.terminate();
       }
     });
-    worker.on(WorkerEvent.Error, (err) =>
+    worker.on(WorkerEvent.Error, (err: Error) =>
       emitter.emit(StreamEvent.Error, new Error(err.message)),
     );
   } catch (err) {
diff --git a/src/models/list/index.ts b/src/models/list/index.ts
@@ -30,11 +30,11 @@ export type ListData<T> = {
   value: T;
 };
 
-export type ListDiff = {
+export type ListDiff<T = unknown> = {
   type: "list";
   status: `${ListStatus}`;
   diff: {
-    value: unknown;
+    value: T;
     previousIndex: number | null;
     index: number | null;
     status: `${ListStatus}`;
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,13 +1,15 @@
 {
   "exclude": ["node_modules", "dist"],
-  "include": ["src"],
+  "include": ["src", "jest.setup.ts"],
   "compilerOptions": {
+    "rootDir": ".",
     "declaration": true,
     "declarationDir": "./dist",
     "lib": ["esnext", "dom"],
+   "types": ["jest", "node"],
     "module": "esnext",
     "target": "esnext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "noUnusedParameters": true,
     "esModuleInterop": true,
     "noImplicitAny": true,
@@ -16,7 +18,6 @@
     "resolveJsonModule": true,
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true ,
-    "baseUrl": ".",
     "paths": {
       "@lib/*": ["./src/lib/*"],
       "@mocks/*": ["./src/mocks/*"],

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ export async function generateWorker<T extends Record<string, unknown>>(`
`54`	`54`	`worker.terminate();`
`55`	`55`	`}`
`56`	`56`	`});`
`57`		`- worker.on(WorkerEvent.Error, (err) =>`
	`57`	`+ worker.on(WorkerEvent.Error, (err: Error) =>`
`58`	`58`	`emitter.emit(StreamEvent.Error, new Error(err.message)),`
`59`	`59`	`);`
`60`	`60`	`} catch (err) {`