PeculiarVentures / webcrypto / 40493967121

75%

push

github

build!: ship ESM-only output for Node.js ^20.19.0 || >=22.12.0 (#97)

Replace rollup and @rollup/plugin-typescript with tsdown, using the
pvtsutils/webcrypto-core config with platform "node" (the mechanisms
use node:crypto) and the SPDX banner. Types are generated from the
source, so the hand-written index.d.ts is gone. tsconfig follows
pvtsutils with lib DOM, types ["node"] and experimentalDecorators
(@JsonProp in src). Type-only imports for verbatimModuleSyntax, tslib
dropped, dev dependencies updated (TypeScript stays on 6).

Crypto.subtle is typed with the DOM SubtleCrypto overloads on top of
core's type, so consumer code written against the old index.d.ts
(EcdsaParams/AesGcmParams literals, `as const` usages) still compiles.
src/index.spec.ts covers that. @types/node stays on 25: 26 drops the
crypto.RsaPublicKey/RsaPrivateKey option types the RSA code uses.

BREAKING CHANGE: @peculiar/webcrypto is ESM-only and requires Node.js
^20.19.0 || >=22.12.0 (was >=14.18.0). The bundles
build/webcrypto.js (CommonJS) and build/webcrypto.es.js and the
hand-written index.d.ts are replaced by unbundled ES modules with
build/index.js and build/index.d.ts as the entry point; the
react-native field is removed. Deep imports into build/ are blocked by
exports. CommonJS code can still require("@peculiar/webcrypto") on
supported Node.js versions through require(esm); Node.js 22.0-22.11
can't. TypeScript projects that compile to CommonJS need "module":
"node20" or "nodenext". The exported names (Crypto, CryptoKey) are
unchanged; their declarations are now generated, so Crypto shows its
webcrypto-core base class. See "Breaking Changes In v2" in the README.

189 of 337 branches covered (56.08%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

928 of 1156 relevant lines covered (80.28%)

18.78 hits per line