Skip to content

CHANGELOG.md

Latest commit

 

History

History
95 lines (53 loc) · 4.81 KB

CHANGELOG.md

File metadata and controls

95 lines (53 loc) · 4.81 KB
Raw

invert-color — Changelog

All notable changes to this project are documented here. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.0.0 (2026-07-23)

⚠️ Breaking: this release is ESM-only. require('invert-color') and the UMD browser bundle (lib/invert.min.js) are gone, and the minimum Node.js is now 20. Staying on CommonJS/UMD? Pin npm i invert-color@2. Everything below the packaging is source-compatible — the invert() API is unchanged.

Modernization release. The callable API — invert(), invert.asRGB(), invert.asRgbArray(), invert.asRgbObject() and invert.defaultThreshold — behaves exactly as in v2; the only runtime-behavior change is stricter, more predictable handling of out-of-range and malformed input (see below).

Added

  • CSS rgb() / rgba() string input. invert('rgb(40, 43, 53)') and invert('rgba(40, 43, 53, 0.5)') now work; an rgba() alpha below 1 is preserved on invert() as the trailing hex byte (#rrggbbaa), while asRGB / asRgbArray return RGB only. Resolves #21 (#22, thanks @luatnd).
  • Plain number[] array input. invert.asRGB(channels) where channels: number[] now type-checks — the accepted array type was widened from the strict [number, number, number] tuple (still the return type). Resolves #23.
  • A named export: import { invert } from 'invert-color' now works alongside the default import invert from 'invert-color' (both resolve to the same function).
  • Input validation. Array/object colors must have exactly 3 finite channels — a wrong-length array or a non-finite channel (NaN/Infinity) now throws a clear error, matching the existing HEX validation.

Changed

  • BREAKING — ESM-only. Dropped the CommonJS and UMD bundles; the package now ships a single ESM build with type declarations. require('invert-color') and the lib/invert.min.js browser file are gone. If you need CommonJS/UMD, pin invert-color@2.
  • BREAKING — engines. Now requires Node.js >= 20.
  • Out-of-range channels are now clamped to 0–255 and rounded, so they degrade predictably (invert([300, 300, 300]) → '#000000'). Previously such values produced an artifact of the last two hex digits (→ '#2d2d2d'). Valid 0–255 colors are unaffected.
  • Rewrote the internals against modern JavaScript: String.prototype.padStart, object spread, the ** operator, and small pure helpers replace the hand-rolled zero-pad, Object.assign and Math.pow. Output for valid colors is identical.
  • Enabled strict TypeScript; tightened and re-exampled the public type declarations (TSDoc with @example blocks).

Removed

  • The browser, module and jsnext:main bundle fields and the multi-format build (rollup + uglify). Replaced by a single tsc build and an exports map.

Tooling

  • Migrated the toolchain: Biome (from TSLint), Vitest (from Jest), GitHub Actions (from Travis), and Stryker mutation testing.
  • Test suite reaches 100% coverage (statements, branches, functions, lines) and a 100% mutation score.

2.0.0 (2018-11-09)

Changed

  • BREAKING: Switched to a default export only, for consistency. Added ESM, UMD and CommonJS bundles (via rollup). See the Usage section.
  • package.json now also defines module, jsnext:main and browser alongside main.

Added

  • threshold: number option to the BlackWhite interface. Fixes #16.
  • invert.defaultThreshold constant.

1.5.0 (2018-08-22)

Changed

  • Re-written in TypeScript.

Added

  • .asRGB() — alias of .asRgbObject().

1.2.3 (2018-04-05)

Changed

1.2.2 (2017-12-07)

Fixed

  • An issue with UMD output. Fixes #7.

Tooling

  • Adapted webpack for UMD.

1.2.0 (2017-11-24)

Added

  • UMD support. (PR #6 by @criography — revised for the latest Babel.)

Tooling

  • Migrated tests to Jest (dropped Jasmine).

1.1.0 (2017-11-07)

Added

  • Ability to customize black/white color values. (PR #3 by @BrainCrumbz)

Fixed

1.0.0 (2017-08-22)

  • Initial version.