{"slug":"upgrade-brief-shopttyass-85f-workers-dev-breaking-7e4a89","title":"npm breaking changes between two versions of a package, before a package upgrade","host":"upgrade-brief.shopttyass-85f.workers.dev","method":"GET","resource":"https://upgrade-brief.shopttyass-85f.workers.dev/breaking","category":"other","description":"npm breaking changes between two versions of a package, before a package upgrade: the documented breaking changes per version, read from the real CHANGELOG, GitHub release notes and alpha/beta/rc notes, plus major version bumps, Node.js engine, ESM/CJS, exports and peer dependency changes, migration","price_listed":0.005,"price_asked":0.005,"state":"answering","state_label":"Answering","checks_7d":1,"answered_7d":1,"latency_ms_median":484,"reported_calls_30d":4,"reported_payers_30d":3,"networks":["eip155:8453","solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"],"badge":"unverified","paid_checks_7d":0,"paid_ok_7d":0,"example_input":{"method":"GET","queryParams":{"from":"4.21.0","package":"express","to":"5.0.0"},"type":"http"},"output_schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","properties":{"input":{"additionalProperties":false,"properties":{"method":{"enum":["GET"],"type":"string"},"queryParams":{"additionalProperties":false,"properties":{"from":{"description":"Version you are on now: exact ('4.21.0'), or a major/minor prefix ('4', '4.21') resolved to its newest stable release","type":"string"},"package":{"description":"npm package name, e.g. 'express', 'next' or '@types/node'","type":"string"},"prereleases":{"default":"false","description":"Include alpha/beta/rc/canary versions in the range","enum":["true","false"],"type":"string"},"to":{"default":"latest","description":"Target version: exact, or a major/minor prefix ('5', '5.1') resolved to the first stable release of that series (5.0.0). Default: the latest stable release ('latest')","type":"string"}},"required":["package","from"],"type":"object"},"type":{"const":"http","type":"string"}},"required":["type","method"],"type":"object"},"output":{"properties":{"example":{"properties":{"asOf":{"type":"string"},"attribution":{"type":"string"},"breaking":{"description":"Documented breaking changes, newest version first","items":{"properties":{"bump":{"enum":["major","minor","patch","prerelease"],"type":"string"},"items":{"items":{"type":"string"},"type":"array"},"publishedAt":{"description":"ISO date","type":["string","null"]},"source":{"description":"Where the notes came from","type":["string","null"]},"version":{"type":"string"}},"type":"object"},"type":"array"},"coverage":{"properties":{"versionsWithNotes":{"type":"integer"},"versionsWithoutNotes":{"items":{"type":"string"},"type":"array"}},"type":"object"},"degraded":{"description":"true when GitHub was read without an API token (fewer release notes reachable)","type":"boolean"},"from":{"type":"string"},"fromPublishedAt":{"description":"ISO date","type":["string","null"]},"includesPrereleases":{"type":"boolean"},"latest":{"description":"Latest stable version","type":["string","null"]},"majorBumps":{"items":{"type":"string"},"type":"array"},"manifestChanges":{"description":"Differences between the two package.json manifests (engines, module type, exports, peer and direct dependencies)","properties":{"dependencies":{"type":"object"},"engines":{"type":"object"},"flags":{"description":"Human-readable manifest changes likely to affect consumers","items":{"type":"string"},"type":"array"},"moduleType":{"type":"object"},"peerDependencies":{"type":"object"}},"type":["object","null"]},"migrationGuides":{"description":"Migration / upgrade guide links found in the notes","items":{"type":"string"},"type":"array"},"notes":{"items":{"type":"string"},"type":"array"},"package":{"type":"string"},"repository":{"description":"Source repository URL","type":["string","null"]},"sources":{"items":{"type":"string"},"type":"array"},"summary":{"type":"string"},"to":{"type":"string"},"toPublishedAt":{"description":"ISO date","type":["string","null"]},"verdict":{"enum":["BREAKING_CHANGES_LIKELY","REVIEW_MANIFEST_CHANGES","NO_BREAKING_CHANGES_DOCUMENTED","UNKNOWN_INCOMPLETE_NOTES"],"type":"string"},"versionsInRange":{"description":"Versions after 'from' up to and including 'to'","type":"integer"}},"required":["package","from","to","verdict","summary","breaking"],"type":"object"},"type":{"type":"string"}},"required":["type"],"type":"object"}},"required":["input"],"type":"object"},"history":[{"day":"2026-10-24","reachable":true,"status":402,"valid_402":true,"asked_usdc":0.005,"price_match":true,"latency_ms":484,"error":null}],"description_full":"npm breaking changes between two versions of a package, before a package upgrade: the documented breaking changes per version, read from the real CHANGELOG, GitHub release notes and alpha/beta/rc notes, plus major version bumps, Node.js engine, ESM/CJS, exports and peer dependency changes, migration guide links and a verdict. Exact versions or a major ('4'); a source URL for every item. One call per dependency upgrade.","last_updated":"2026-10-23T22:57:18.612Z","schemes":["exact"]}