fast-equals 5.3.3 → 5.4.0

package/package.json

@@ -6,43 +6,40 @@
   },
   "description": "A blazing fast equality comparison, either shallow or deep",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^29.0.0",
-    "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-replace": "^6.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.3.0",
-    "@types/lodash": "^4.17.20",
-    "@types/node": "^24.10.1",
+    "@planttheidea/build-tools": "^1.2.3",
+    "@types/lodash": "^4.17.21",
+    "@types/node": "^24.10.3",
     "@types/ramda": "^0.31.1",
-    "@types/react": "^19.2.3",
+    "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.46.4",
-    "@typescript-eslint/parser": "^8.46.4",
-    "@vitest/coverage-v8": "4.0.8",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "@vitest/coverage-v8": "^4.0.15",
+    "cli-table3": "^0.6.5",
     "decircularize": "^1.0.0",
     "deep-eql": "^5.0.2",
     "deep-equal": "^2.2.3",
     "dequal": "^2.0.3",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.2",
     "eslint-friendly-formatter": "^4.0.1",
     "eslint-plugin-import": "^2.32.0",
     "fast-deep-equal": "^3.1.3",
     "fast-glob": "^3.3.3",
     "lodash": "^4.17.21",
     "nano-equal": "^2.0.2",
-    "prettier": "^3.6.2",
-    "react": "^19.2.0",
-    "react-dom": "^19.2.0",
+    "prettier": "^3.7.4",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
     "react-fast-compare": "^3.2.2",
-    "release-it": "^19.0.6",
-    "rollup": "^4.53.2",
+    "release-it": "^19.1.0",
+    "rollup": "^4.53.3",
     "shallow-equal-fuzzy": "^0.0.2",
-    "tinybench": "^5.1.0",
+    "tinybench": "^6.0.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.4",
+    "typescript-eslint": "^8.49.0",
     "underscore": "^1.13.7",
-    "vite": "^7.2.2",
-    "vitest": "^4.0.8"
+    "vite": "^7.2.7",
+    "vitest": "^4.0.15"
   },
   "engines": {
     "node": ">=6.0.0"
@@ -50,27 +47,25 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/esm/types/index.d.mts",
-        "default": "./dist/esm/index.mjs"
+        "types": "./dist/es/index.d.mts",
+        "default": "./dist/es/index.mjs"
       },
       "require": {
-        "types": "./dist/cjs/types/index.d.cts",
+        "types": "./dist/cjs/index.d.cts",
         "default": "./dist/cjs/index.cjs"
       },
       "default": {
-        "types": "./dist/umd/types/index.d.ts",
+        "types": "./dist/umd/index.d.ts",
         "default": "./dist/umd/index.js"
       }
     }
   },
   "files": [
     "dist",
-    "src",
-    "CHANGELOG.md",
-    "index.d.ts",
     "LICENSE",
-    "package.json",
-    "README.md"
+    "README.md",
+    "index.d.ts",
+    "package.json"
   ],
   "homepage": "https://github.com/planttheidea/fast-equals#readme",
   "keywords": [
@@ -82,35 +77,37 @@
   ],
   "license": "MIT",
   "main": "dist/cjs/index.cjs",
-  "module": "dist/esm/index.mjs",
+  "module": "dist/es/index.mjs",
   "name": "fast-equals",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/planttheidea/fast-equals.git"
   },
   "scripts": {
-    "benchmark": "npm run build:esm && node benchmark/index.js",
-    "build": "npm run build:esm && npm run build:cjs && npm run build:umd && npm run build:min && npm run build:types",
-    "build:cjs": "rm -rf dist/cjs && NODE_ENV=production rollup -c config/rollup/config.cjs.js && tsc -p ./config/tsconfig/cjs.json && node scripts/create-cts-files.js",
-    "build:esm": "rm -rf dist/esm && NODE_ENV=production rollup -c config/rollup/config.esm.js && tsc -p ./config/tsconfig/esm.json && node scripts/create-mts-files.js",
-    "build:min": "rm -rf dist/min && NODE_ENV=production rollup -c config/rollup/config.min.js && tsc -p ./config/tsconfig/min.json",
-    "build:types": "node scripts/fallback-types.js",
-    "build:umd": "rm -rf dist/umd && NODE_ENV=production rollup -c config/rollup/config.umd.js && tsc -p ./config/tsconfig/umd.json",
-    "dev": "vite --config config/vite.config.js",
-    "format": "prettier **/*.ts --write",
-    "lint": "eslint src/*.ts",
+    "benchmark": "npm run build && node benchmark/index.js",
+    "build": "npm run clean && npm run build:dist && npm run build:types",
+    "build:dist": "NODE_ENV=production rollup -c config/rollup.config.js",
+    "build:types": "pti fix-types -l dist",
+    "clean": "rm -rf dist",
+    "clean:cjs": "rm -rf dist/cjs",
+    "clean:es": "rm -rf dist/es",
+    "clean:umd": "rm -rf dist/umd",
+    "dev": "vite --config=config/vite.config.ts",
+    "format": "prettier . --log-level=warn --write",
+    "format:check": "prettier . --log-level=warn --check",
+    "lint": "eslint --max-warnings=0",
     "lint:fix": "npm run lint -- --fix",
+    "release:alpha": "release-it --config=config/release-it/alpha.json",
+    "release:beta": "release-it --config=config/release-it/beta.json",
+    "release:rc": "release-it --config=config/release-it/rc.json",
+    "release:scripts": "npm run format:check && npm run typecheck && npm run lint && npm run test && npm run build",
+    "release:stable": "release-it --config=config/release-it/stable.json",
     "start": "npm run dev",
-    "release": "release-it",
-    "release:beta": "release-it --config=.release-it.beta.json",
-    "release:scripts": "npm run typecheck && npm run lint && npm run test:coverage && npm run build",
-    "test": "vitest run",
-    "test:coverage": "rm -rf coverage && vitest run --coverage",
-    "test:watch": "vitest",
+    "test": "vitest run --config=config/vitest.config.ts",
     "typecheck": "tsc --noEmit"
   },
   "sideEffects": false,
   "type": "module",
   "types": "./index.d.ts",
-  "version": "5.3.3"
+  "version": "5.4.0"
 }

package/CHANGELOG.md

@@ -1,364 +0,0 @@
-# fast-equals CHANGELOG
-
-## 5.3.3
-
-- [#147](https://github.com/planttheidea/fast-equals/pull/147) - Fix type resolution when using `Node16` as `moduleResolution` in TypeScript (fixes [#145](https://github.com/planttheidea/fast-equals/issues/145))
-
-## 5.3.2
-
-- [#154](https://github.com/planttheidea/fast-equals/pull/154) - Use include with `"files"` instead of exclude with `.npmignore` (Thanks [@43081j](https://github.com/43081j))
-- [#155](https://github.com/planttheidea/fast-equals/pull/155) - Upgrade build dependencies to resolve security vulnerabilities
-
-## 5.3.1
-
-- [#153](https://github.com/planttheidea/fast-equals/pull/153) - Avoid publishing `.yarn` folder
-
-## 5.3.0
-
-- [#150](https://github.com/planttheidea/fast-equals/pull/150/files) - Add support for `unknownTagComparators` in custom configuration (thanks to @mrcljx for the idea)
-
-## 5.2.2
-
-- [#139](https://github.com/planttheidea/fast-equals/pull/139/files) - Add file extensions to type definition files to allow it to work in projects with `NodeNext` module resolution
-
-## 5.2.1
-
-### Bugfixes
-
-- [#138](https://github.com/planttheidea/fast-equals/pull/138) - Actually fix reference to `src` code in `index.d.ts` by flattening types in file
-
-## 5.2.0
-
-### Enhancements
-
-- Support Preact objects in equality comparison
-
-### Bugfixes
-
-- [#137](https://github.com/planttheidea/fast-equals/pull/137) - Fix circular React references in object comparisons
-
-## 5.1.3
-
-### Enhancements
-
-- [#136](https://github.com/planttheidea/fast-equals/pull/136) - More than double speed of iterables (`Map` / `Set`) equality comparisons
-
-### Maintenance
-
-- [#135](https://github.com/planttheidea/fast-equals/pull/135) - Include `dequal` and `dequal/lite` in benchmark comparisons
-
-## 5.1.2
-
-### Maintenance
-
-Re-release of `5.1.0` with correct pre-release setup.
-
-## 5.1.1
-
-**DO NOT USE**
-
-This was an accidental pre-release when cleaning up release setup.
-
-## 5.1.0
-
-### Enhancements
-
-- [#127](https://github.com/planttheidea/fast-equals/pull/127) - Add support for custom `Function` instance comparisons (resolves [#118](https://github.com/planttheidea/fast-equals/issues/118))
-- [#128](https://github.com/planttheidea/fast-equals/pull/128) - Add support for `URL` instance comparisons (resolves [#121](https://github.com/planttheidea/fast-equals/issues/121))
-- [#129](https://github.com/planttheidea/fast-equals/pull/129) - Add support for `Error` instance comparisons (resolves [#123](https://github.com/planttheidea/fast-equals/issues/123))
-- [#130](https://github.com/planttheidea/fast-equals/pull/130) - Add support for custom `Number` instance comparisons (resolves [#112](https://github.com/planttheidea/fast-equals/issues/112))
-
-### Bugfixes
-
-- [#132](https://github.com/planttheidea/fast-equals/pull/126) - Fix `assert.deepEqual` check in benchmark (resolves [#125](https://github.com/planttheidea/fast-equals/issues/125))
-- [#126](https://github.com/planttheidea/fast-equals/pull/132) - Export explicit types via `export type` (attempts to resolve [#114](https://github.com/planttheidea/fast-equals/issues/114))
-
-## 5.0.1
-
-### Bugfixes
-
-- Fix reference to `metaOverride` in typings and documentation (holdover from temporary API in v5 beta)
-
-## 5.0.0
-
-### Breaking changes
-
-#### `constructor` equality now required
-
-To align with other implementations common in the community, but also to be more functionally correct, the two objects being compared now must have equal `constructor`s.
-
-#### `Map` / `Set` comparisons no longer support IE11
-
-In previous verisons, `.forEach()` was used to ensure that support for `Symbol` was not required, as IE11 did not have `Symbol` and therefore both `Map` and `Set` did not have iterator-based methods such as `.values()` or `.entries()`. Since IE11 is no longer a supported browser, and support for those methods is present in all browsers and Node for quite a while, the comparison has moved to use these methods. This results in a ~20% performance increase.
-
-#### `createCustomEqual` contract has changed
-
-To better facilitate strict comparisons, but also to allow for `meta` use separate from caching, the contract for `createCustomEqual` has changed. See the [README documentation](./README.md#createcustomequal) for more details, but froma high-level:
-
-- `meta` is no longer passed through to equality comparators, but rather a general `state` object which contains `meta`
-- `cache` now also lives on the `state` object, which allows for use of the `meta` property separate from but in parallel with the circular cache
-- `equals` is now on `state`, which prevents the need to pass through the separate `isEqual` method for the equality comparator
-
-#### `createCustomCircularEqual` has been removed
-
-You can create a custom circular equality comparator through `createCustomEqual` now by providing `circular: true` to the options.
-
-#### Custom `meta` values are no longer passed at callsite
-
-To use `meta` properties for comparisons, they must be returned in a `createState` method.
-
-#### Deep links have changed
-
-If you were deep-linking into a specific asset type (ESM / CJS / UMD), they have changed location.
-
-**NOTE**: You may no longer need to deep-link, as [the build resolution has improved](#better-build-system-resolution).
-
-### Enhancements
-
-#### New "strict" comparators available
-
-The following new comparators are available:
-
-- `strictDeepEqual`
-- `strictShallowEqual`
-- `strictCircularDeepEqual`
-- `strictCircularShallowEqual`
-
-This will perform the same comparisons as their non-strict counterparts, but will verify additional properties (non-enumerable properties on objects, keyed objects on `Array` / `Map` / `Set`) and that the descriptors for the properties align.
-
-#### `TypedArray` support
-
-Support for comparing all typed array values is now supported, and you can provide a custom comparator via the new `areTypedArraysEqual` option in the `createCustomEqual` configuration.
-
-#### Better build system resolution
-
-The library now leverages the `exports` property in the `package.json` to provide builds specific to your method of consumption (ESM / CommonJS / UMD). There is still a minified UMD version available if you want to use it instead.
-
-#### `arePrimitiveWrappersEqual` option added to `createCustomEqual` configuration
-
-If you want a custom comparator for primitive wrappers (`new Boolean()` / `new Number()` / `new String()`) it is now available.
-
-## 4.0.3
-
-- Remove unnecessary second strict equality check for objects in edge-case scenarios
-
-## 4.0.2
-
-- [#85](https://github.com/planttheidea/fast-equals/issues/85) - `createCustomCircularEqual` typing is incorrect
-
-## 4.0.1
-
-- [#81](https://github.com/planttheidea/fast-equals/issues/81) - Fix typing issues related to importing in `index.d.ts` file
-
-## 4.0.0
-
-### Breaking Changes
-
-#### Certain ES2015 features are now required
-
-In previous versions, there were automatic fallbacks for certain ES2015 features if they did not exist:
-
-- [`RegExp.prototype.flags`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/flags)
-- [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)
-
-Due to the omnipresence of support in both browser and NodeJS, these have been deprecated. There is still an option if you require support for these legacy environments, however; see [`createCustomEqual`](./README.md#createcustomequal) and [`createCustomCircularEqual`](./README.md#createcustomcircularequal) for more details.
-
-#### `createCustomEqual` contract has changed
-
-To allow more flexibility and customizability for a variety of edge cases, `createCustomEqual` now allows override of specific type value comparisons in addition to the general comparator it did prior. See [the documentation](./README.md#createcustomequal) for more details.
-
-### Enhancements
-
-#### `createCustomCircularEqual` added
-
-Like `createCustomEqual`, it will create a custom equality comparator, with the exception that it will handle circular references. See [the documentation](./README.md#createcustomcircularequal) for more details.
-
-#### Cross-realm comparisons are now supported
-
-Prior to `4.x.x.`, `instanceof` was used internally for checking of object classes, which only worked when comparing objects from the same [Realm](https://262.ecma-international.org/6.0/#sec-code-realms). This has changed to instead use an object's [StringTag](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag), which is not realm-specific.
-
-#### TypeScript typings improved
-
-For better typing in edge-case scenarios like custom comparators with `meta` values, typings have been refactored for accuracy and better narrow flow-through.
-
-## 3.0.3
-
-- Fix [#77](https://github.com/planttheidea/fast-equals/issues/73) - better circular object validation
-
-## 3.0.2
-
-- Fix [#73](https://github.com/planttheidea/fast-equals/issues/73) - support comparison of primitive wrappers
-- [#76](https://github.com/planttheidea/fast-equals/pull/76) - improve speed and accuracy of `RegExp` comparison in modern environments
-
-## 3.0.1
-
-- Fix [#71](https://github.com/planttheidea/fast-equals/pull/71) - use generic types for better type flow-through
-
-## 3.0.0
-
-### Breaking changes
-
-When creating a custom equality comparator via `createCustomEqual`, the equality method has an expanded contract:
-
-```ts
-// Before
-type EqualityComparator = (objectA: any, objectB: any, meta: any) => boolean;
-
-// After
-type InternalEqualityComparator = (
-  objectA: any,
-  objectB: any,
-  indexOrKeyA: any,
-  indexOrKeyB: any,
-  parentA: any,
-  parentB: any,
-  meta: any,
-) => boolean;
-```
-
-If you have a custom equality comparator, you can ignore the differences by just passing additional `undefined` parameters, or you can use the parameters to further improve / clarify the logic.
-
-- Add [#57](https://github.com/planttheidea/fast-equals/pull/57) - support additional metadata for custom equality comparators
-
-## 2.0.4
-
-- Fix [#58](https://github.com/planttheidea/fast-equals/issues/58) - duplicate entries in `Map` / `Set` can create false equality success
-- [#60](https://github.com/planttheidea/fast-equals/issues/60) - Add documentation for key equality of `Map` being a part of `deepEqual`
-
-## 2.0.3
-
-- Fix [#50](https://github.com/planttheidea/fast-equals/pull/50) - copy-pasta in cacheable check
-
-## 2.0.2
-
-- Optimize iterables comparisons to not double-iterate
-- Optimize loop-based comparisons for speed
-- Improve cache handling in circular handlers
-- Improve stability of memory by reducing variable instantiation
-
-## 2.0.1
-
-- Fix [#41](https://github.com/planttheidea/fast-equals/pull/41) - prevent `.rpt2_cache` directory from being published for better CI environment support (thanks [@herberttn](https://github.com/herberttn))
-
-## 2.0.0
-
-### Breaking changes
-
-- There are longer `fast-equals/es`, `fast-equals/lib`, `fast-equals/mjs` locations
-  - Instead, there are 3 builds in `dist` for different consumption types:
-    - `fast-equals.js` (UMD / `browser`)
-    - `fast-equals.esm.js` (ESM / `module`)
-    - `fast-equals.cjs.js` (CommonJS / `main`)
-- There is no default export anymore, only the previously-existing named exports
-  - To get all into a namespace, use `import * as fe from 'fast-equals`
-
-### Updates
-
-- Rewritten completely in TypeScript
-- Improve speed of `Map` / `Set` comparisons
-- Improve speed of React element comparisons
-
-### Fixes
-
-- Consider pure objects (`Object.create(null)`) to be plain objects
-- Fix typings for `createCustomEqual`
-
-## 1.6.3
-
-- Check the size of the iterable before converting to arrays
-
-## 1.6.2
-
-- Fix [#23](https://github.com/planttheidea/fast-equals/issues/23) - false positives for map
-- Replace `uglify` with `terser`
-- Use `rollup` to build all the distributables (`main`, `module`, and `browser`)
-  - Maintain `lib` and `es` transpilations in case consumers were deep-linking
-
-## 1.6.1
-
-- Upgrade to `babel@7`
-- Add `"sideEffects": false` to `package.json` for better tree-shaking in `webpack`
-
-## 1.6.0
-
-- Add ESM support for NodeJS with separate [`.mjs` extension](https://nodejs.org/api/esm.html) exports
-
-## 1.5.3
-
-- Fix `Map` / `Set` comparison to not require order to match to be equal
-
-## 1.5.2
-
-- Improve speed of object comparison through custom `hasKey` method
-
-## 1.5.1
-
-- Fix lack of support for `unicode` and `sticky` RegExp flag checks
-
-## 1.5.0
-
-- Add [`circularDeepEqual`](README.md#circulardeepequal) and [`circularShallowEqual`](README.md#circularshallowequal) methods
-- Add `meta` third parameter to `comparator` calls, for use with `createCustomEqual` method
-
-## 1.4.1
-
-- Fix issue where `lastIndex` was not being tested on `RegExp` objects
-
-## 1.4.0
-
-- Add support for comparing promise-like objects (strict equality only)
-
-## 1.3.1
-
-- Make `react` comparison more accurate, and a touch faster
-
-## 1.3.0
-
-- Add support for deep-equal comparisons between `react` elements
-- Add comparison with `react-fast-compare`
-- Use `rollup` for `dist` file builds
-
-## 1.2.1
-
-- Fix errors from TypeScript typings in strict mode (thanks [@HitoriSensei](https://github.com/HitoriSensei))
-
-## 1.2.0
-
-- Surface `isSameValueZero` as [`sameValueZeroEqual`](#samevaluezeroequal) option
-
-## 1.1.0
-
-- Add TypeScript typings (thanks [@josh-sachs](https://github.com/josh-sachs))
-
-## 1.0.6
-
-- Support invalid date equality via `isSameValueZero`
-
-## 1.0.5
-
-- Replace `isStrictlyEqual` with `isSameValueZero` to ensure that `shallowEqual` accounts for `NaN` equality
-
-## 1.0.4
-
-- Only check values when comparing `Set` objects (improves performance of `Set` check by ~12%)
-
-## 1.0.3
-
-- Make `Map` and `Set` comparisons more explicit
-
-## 1.0.2
-
-- Fix symmetrical comparison of iterables
-- Reduce footprint
-
-## 1.0.1
-
-- Prevent babel transpilation of `typeof` into helper for faster runtime
-
-## 1.0.0
-
-- Initial release
-
-```
-
-```

package/dist/cjs/types/comparator.d.cts

@@ -1,26 +0,0 @@
-import type { ComparatorConfig, CreateState, CustomEqualCreatorOptions, EqualityComparator, InternalEqualityComparator } from './internalTypes.d.cts';
-interface CreateIsEqualOptions<Meta> {
-    circular: boolean;
-    comparator: EqualityComparator<Meta>;
-    createState: CreateState<Meta> | undefined;
-    equals: InternalEqualityComparator<Meta>;
-    strict: boolean;
-}
-/**
- * Create a comparator method based on the type-specific equality comparators passed.
- */
-export declare function createEqualityComparator<Meta>({ areArraysEqual, areDatesEqual, areErrorsEqual, areFunctionsEqual, areMapsEqual, areNumbersEqual, areObjectsEqual, arePrimitiveWrappersEqual, areRegExpsEqual, areSetsEqual, areTypedArraysEqual, areUrlsEqual, unknownTagComparators, }: ComparatorConfig<Meta>): EqualityComparator<Meta>;
-/**
- * Create the configuration object used for building comparators.
- */
-export declare function createEqualityComparatorConfig<Meta>({ circular, createCustomConfig, strict, }: CustomEqualCreatorOptions<Meta>): ComparatorConfig<Meta>;
-/**
- * Default equality comparator pass-through, used as the standard `isEqual` creator for
- * use inside the built comparator.
- */
-export declare function createInternalEqualityComparator<Meta>(compare: EqualityComparator<Meta>): InternalEqualityComparator<Meta>;
-/**
- * Create the `isEqual` function used by the consuming application.
- */
-export declare function createIsEqual<Meta>({ circular, comparator, createState, equals, strict, }: CreateIsEqualOptions<Meta>): <A, B>(a: A, b: B) => boolean;
-export {};