chore(deps): update dependency @napi-rs/keyring to v2 - #1375
Open
renovate[bot] wants to merge 1 commit into
Open
chore(deps): update dependency @napi-rs/keyring to v2#1375renovate[bot] wants to merge 1 commit into
renovate[bot] wants to merge 1 commit into
Conversation
renovate
Bot
force-pushed
the
renovate/napi-rs-keyring-2.x
branch
6 times, most recently
from
September 2, 2026 11:52
5309cee to
6465544
Compare
renovate
Bot
force-pushed
the
renovate/napi-rs-keyring-2.x
branch
from
September 2, 2026 12:03
6465544 to
e801b8d
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
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.
This PR contains the following updates:
^1.3.0→^2.0.0Release Notes
Brooooooklyn/keyring-node (@napi-rs/keyring)
v2.0.0Compare Source
This release changes how credential store errors are reported. Success and "not found" results are unchanged, but provider failures that were previously silenced now throw (sync API) or reject (async API).
1. Reads:
getPassword()/getSecret()Previously, any failure reading the credential store — a locked keychain, denied access, an OS error — was swallowed and returned as
null/undefined, indistinguishable from "no credential stored".Now only a genuinely missing credential (
NoEntry) returns the absent result. Every other error throws or rejects:null/undefinednull/undefined(unchanged)null/undefined2. Deletes:
deleteCredential()/deletePassword()Previously, any delete failure returned
false, so a failed delete looked identical to "credential was already gone" — leaving callers unable to tell whether the secret was actually removed.Now
falseonly means the credential did not exist (NoEntry). A failed delete throws or rejects:truetrue(unchanged)falsefalse(unchanged)falseA
falseresult now guarantees the credential is absent from the store.3. TypeScript: async
deletePassword()return typeThe async
deletePassword()alias is now correctly declared asPromise<boolean>instead ofPromise<unknown>. This is a narrowing and is source-compatible for typical usage, but code that treated the result asunknownmay need a small type adjustment.These changes apply to both
Entry(sync) andAsyncEntry(async), including thedeletePassword()aliases.🔧 Migration Guide
If you only check for absent credentials — no change needed
If you call reads/deletes without error handling — add it
Code that previously "worked" against a locked or inaccessible store will now surface the error. This is the main thing to audit when upgrading:
Sync API
The same applies to the sync
Entrymethods, which now throw on provider errors instead of returningnull/false:Why this change
The new behavior matches the documented node-keytar compatibility contract: missing credentials resolve as
null, while native failures reject. Previously.ok()/.is_ok()conversions at the N-API boundary erased that distinction, so a locked keychain looked like an empty one. See #136 and #138 for details.What's Changed
Full Changelog: Brooooooklyn/keyring-node@v1.3.0...v2.0.0
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.