chore(npm)!: release 4.0.0 - #207
Merged
Merged
Conversation
The published 3.0.1 predates the TypeScript migration, and the npm package has since gained changes that are breaking for consumers of that release, so this takes a major version rather than a minor. BREAKING CHANGE: `deserializePage`/`deserializePages` no longer filter deprecated content. In 3.0.1 they stripped deprecated elements and their essences; they are now thin, deprecated aliases for the generic `deserialize`, which returns every resource the response contains, so callers that relied on the old filtering will now see the deprecated elements. The package also introduces an `exports` map -- only `.` and `./deserialize` are importable, so deep imports into the package break. Additionally ships `.d.ts` type declarations, and adds a `prepare` script that builds the compiled `dist/` before publish and on git-based installs, so it can no longer drift from `src/`.
tvdeyen
changed the title
tvdeyen
force-pushed
the
chore/npm-3.1.0
branch
from
August 31, 2026 13:27
54fe791 to
bb8f3a3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Releases the first TypeScript build of the npm package as 4.0.0 — a major bump, because the package has breaking changes for consumers of the currently-published
3.0.1(which predates the TS work).Breaking —
deserializePage/deserializePagesno longer filter deprecated content. In3.0.1these were Alchemy-aware and stripped deprecated elements and their essences. They are now thin,@deprecatedaliases for the genericdeserialize, which returns every resource the response contains. Callers relying on the old filtering will now see the deprecated elements. (deprecatedis an admin-only hint and must not alter serialized output, which is why the filtering was removed.)Breaking — an
exportsmap is introduced.3.0.1exposed onlymain, so any path was importable. Now only.and./deserializeare exported; deep imports into the package break.Additive — ships
.d.tstype declarations (root +./deserializesubpath).deserializeitself is unchanged (<T>(document)).Release hygiene — adds a
preparescript (pnpm run build) so the compileddist/(JS + declarations) is regenerated before publish and on git-based installs, instead of relying on a hand-committed build staying in sync withsrc/.npm-only; does not touch the gem or its release workflow. (Branch name still says
3.1.0— cosmetic; the released version is4.0.0.)