npm breaking changes between two versions of a package, before a package upgrade

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.

Paid test badge: not yet. The checks above are free: we call the tool without paying and read the payment request it sends back. The Verified badge needs paid calls whose answers match the promised output, and nobody can buy a badge.

Endpoint

GET https://upgrade-brief.shopttyass-85f.workers.dev/breaking

Our checks, last 30 days

Example input (from the provider)

{
  "method": "GET",
  "queryParams": {
    "from": "4.21.0",
    "package": "express",
    "to": "5.0.0"
  },
  "type": "http"
}

Promised output schema (from the provider)

{
  "$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": 

This page as JSON