chore(deps): update dependency @sanity/client to v8 - #1500
Open
renovate[bot] wants to merge 1 commit into
Open
Conversation
renovate
Bot
added
dependencies
✅ Deploy Preview for netlify-plugins ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![kodiakhq[bot]](https://avatars.githubusercontent.com/in/29196?s=60&v=4){kind=small}
renovate
Bot
force-pushed
the
renovate/sanity-client-8.x
branch
from
August 20, 2026 23:56
09c43a5 to
f9c2683
Compare
renovate
Bot
force-pushed
the
renovate/sanity-client-8.x
branch
from
August 22, 2026 15:52
f9c2683 to
d5be075
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:
^3.3.6→^8.0.0Release Notes
sanity-io/client (@sanity/client)
v8.2.0Compare Source
Minor Changes
add collaboration comments client (
@alpha) (#1235) (5906f72)add variant actions (#1279) (dd25720)
Adds
CreateVariantAction,EditVariantAction,DeleteVariantAction,PublishVariantActionandUnpublishVariantAction, along with aVariantActionunion, covering thesanity.action.document.variant.*actions. They are included in theActionunion, soclient.action()accepts them.Each action addresses a variant document by the
publishedId,variantIdandbundleIdtriplerather than by document ID, since the API derives the document ID from those three values.
Note that
Actionwidening is a breaking change for code that exhaustively switches onAction['actionType']with aneverfallthrough, which will need to handle the new cases.v8.1.0Compare Source
Minor Changes
add
client.functions.invoke()for calling deployed functions on demand (#1258) (4c2f718)Invoke a Sanity Pubsub Function by the
name. Onlysanity.function.pubsubfunctions can beinvoked on demand.
Available in two forms,
client.functions.invoke()resolves with the function's return value,client.observable.functions.invoke()emits it and accepts anevent.datapayload,a per-call
timeoutand anAbortSignal.Names are only unique within a stack, so resolving one requires a
stackId, either from the newstackIdclient config option or from the request. That resolution costs one extra request percall. A function that returns nothing resolves to
undefined.Stacks deployed at organization scope are reached with the new
organizationIdclient configoption, or a per-call
organizationId. It takes precedence overprojectId, which becomesoptional in that case.
add request handler for client integrations (#1286) (a9db52f)
add variant definition actions (#1278) (7c98361)
Adds
CreateVariantDefinitionAction,EditVariantDefinitionActionandDeleteVariantDefinitionAction, along with aVariantDefinitionActionunion, covering thesanity.action.variant.definition.*actions. They are included in theActionunion, soclient.action()accepts them.Note that
Actionwidening is a breaking change for code that exhaustively switches onAction['actionType']with aneverfallthrough, which will need to handle the new cases.Patch Changes
route the live-events CORS probe through the configured transport (#1282) (aaada67)
The
/check/corsprobe thatclient.live.events()uses to distinguish a CORSrejection from other connection failures called the global
fetchdirectly, soa custom
resolveFetchor an explicitproxywas not applied to it. It nowresolves the same fetch the EventSource connection uses.
reword the
createVersion()warning aboutbaseId(#1282) (aaada67)createVersion({document})warned that "the recommended approach is to provide abaseIdandreleaseIdinstead", which reads as a correction even when the caller had no other option:baseIdcreates a version of a document that already exists, so creating a genuinely new document inside a release can only be done by passingdocument.The client cannot tell those two cases apart, so the warning is now phrased as a condition rather than a correction: "If you are creating a version of a document that already exists, prefer providing
baseIdandreleaseIdinstead." No behavior changed, and both forms remain supported.correct the return type of
delete()andmutate()when called with no options (#1282) (aaada67)client.delete(id)andclient.mutate(mutations)were typed to resolve to adocument (
SanityDocument<R>) when called without an options argument, butthey actually resolve to a mutation result object
(
{transactionId, documentIds, results},MultipleMutationResult). Thedocument is genuinely mutated, but code that read
._idoff the resolvedvalue was reading
undefinedat runtime without any type error. Theunderlying method (
create()) does return the document by default, so thiswas easy to assume also held for
delete()andmutate()- it does not.Both methods now correctly type as resolving to
MultipleMutationResultbydefault, matching the (unchanged) runtime behavior, on both the
promise-based and observable clients.
Released as a patch rather than a major even though a declared type changed. Code that read
._idoff the result was readingundefinedat runtime, so no working application can have depended on the old type: anything that type-checked against it was already broken when it ran. What changes is that the mistake is now visible at compile time instead of at runtime.If
tscstarts failing on one of these calls, that failure is pointing at a real bug. To fix it:{returnFirst: true, returnDocuments: true}explicitly:
await client.delete(id, {returnFirst: true, returnDocuments: true}).documentIds(ordocumentIdwithreturnFirst: true) off the result instead of_id.No runtime behavior changed - this only corrects the public types.
populate server-sent event IDs on Cloudflare Workers (#1282) (aaada67)
client.live.events()andclient.listen()readlastEventIdoff theMessageEventthateventsourceconstructs. workerd does not carry that memberthrough the
MessageEventconstructor's init dict, so on bare Cloudflare Workersevery event arrived with an empty
id. Raising theeventsourcefloor to>= 5.1.0picks up the fix.return the asset from
assets.upload()against a Media Library (#1282) (aaada67)client.assets.upload()resolved toundefinedwhen the client was configured against a Media Library (resource: {type: 'media-library', id}), even though the upload succeeded server-side. Content Lake's upload endpoint responds with{document: {...}}, andupload()unwrapped that key unconditionally - but the Media Library upload endpoint responds with{asset: {...}}instead, so the unwrap producedundefined.upload()now unwraps.assetfor a Media Library response and.documentotherwise, on both the promise-based and observable clients. It resolves to the uploaded asset instead ofundefined.The Media Library asset shape is not the same as a Content Lake asset document: it is a
sanity.assetdocument that tracks one or more uploaded versions viacurrentVersion/versions, rather than a document withurl,size,mimeType, and so on. That shape is now exported asMediaLibraryAssetDocument.The declared return type is knowingly incomplete, and this is a patch on purpose. Which shape you get back depends on how the client is configured, not on the arguments to
upload(), so no overload can discriminate it. Expressing it would mean widening the return type into a union that every existing caller has to narrow - a breaking change for all users, to correct the typing of a much less common configuration. So the declared type still describes only the Content Lake shape. If you upload to a Media Library, narrow the result yourself (for example, check forcurrentVersion) or annotate it asSanityImageAssetDocument | MediaLibraryAssetDocument. Typing this accurately is deferred to the next major.v8.0.0Compare Source
Major Changes
require node 22.12 or higher, use fetch (#1217) (29b9601)
HttpRequestEvent,ResponseEvent, andProgressEventare removed. Observable asset uploads now emitUploadEvent<T>.unstable__adapterandunstable__environmentexports are removed.ClientErrorandServerErrormessages now include the HTTP status text._requestHandlerclient config option andRequestHandlertype are removed.requesterclient config option is removed. Useheadersconfiguration and a customfetchinstead.proxyoption is removed. Configureproxyon the client or through proxy environment variables.HTTP_PROXY,HTTPS_PROXY, andNO_PROXYafter process startup no longer affect requests.ENOTFOUNDerrors are retried for idempotent requests. SetmaxRetries: 0to fail immediately.HttpRequestcontract now uses get-it v9 fetch-shaped request options instead of the v8 request shape.config.resolveFetchtakes precedence over the environment resolver.esm.sh.typesVersionsdeclarations are removed. Use TypeScriptmoduleResolutionset tonode16,nodenext, orbundler.mainandmodulepackage fields are removed. Consumers must resolve the package throughexports.Patch Changes
restore editor autocomplete for
StackablePerspectiveandStudioBaseUrl(#1264) (5b0e529)Both types applied the
& {}autocomplete idiom around the whole union rather than around thestringmember, as in('published' | 'drafts' | string) & {}. That collapses to plainstring,so editors offered no completions for
publishedordrafts, and the three template literalpatterns in
StudioBaseUrlhad no effect. Assignability is unchanged, so this only addssuggestions that were always intended to be there.
deps: update dependency nanoid to v6 (#1267) (c6fc253)
v7.26.2Compare Source
Bug Fixes
v7.26.1Compare Source
Bug Fixes
v7.26.0Compare Source
Features
v7.25.0Compare Source
Features
v7.24.0Compare Source
Features
v7.23.2Compare Source
Bug Fixes
v7.23.1Compare Source
Bug Fixes
v7.23.0Compare Source
Features
v7.22.1Compare Source
Bug Fixes
v7.22.0Compare Source
Features
v7.21.0Compare Source
Features
Bug Fixes
v7.20.0Compare Source
Features
v7.19.0Compare Source
Features
v7.18.0Compare Source
Features
Bug Fixes
v7.17.0Compare Source
Features
onlyExplicitMembershipoption toprojects.list()(#1200) (96619c5)v7.16.0Compare Source
Features
v7.15.0Compare Source
Features
v7.14.1Compare Source
Bug Fixes
v7.14.0Compare Source
Features
Bug Fixes
v7.13.2Compare Source
Bug Fixes
v7.13.1Compare Source
Bug Fixes
v7.13.0Compare Source
Features
v7.12.1Compare Source
Bug Fixes
v7.12.0Compare Source
Features
v7.11.2Compare Source
Bug Fixes
v7.11.1Compare Source
Bug Fixes
v7.11.0Compare Source
Features
v7.10.0Compare Source
Features
v7.9.0Compare Source
Features
v7.8.2Compare Source
Bug Fixes
v7.8.1Compare Source
Bug Fixes
providerproperty toCurrentSanityUsertype (#1115) (5d98eca)v7.8.0Compare Source
Features
baseIdandversionIdinstead ofdocument(#1108) (aaa1042)v7.7.0Compare Source
Features
isHttpErrormethod (and sharedHttpErrorinterface) (#1112) (98ee6d3)v7.6.0Compare Source
Features
v7.5.0Compare Source
Features
agent.action.transformcan now transform images to text descriptions (#1096) (609e572)v7.4.1Compare Source
Bug Fixes
v7.4.0Compare Source
Features
Bug Fixes
v7.3.0Compare Source
Features
v7.2.2Compare Source
Bug Fixes
v7.2.1Compare Source
Bug Fixes
nanoidto ensure compatibility with node < 22 (#1076) (368a12d)v7.2.0Compare Source
Features
v7.1.0Compare Source
Features
v7.0.0Compare Source
⚠ BREAKING CHANGES
Bug Fixes
v6.29.1Compare Source
Bug Fixes
v6.29.0Compare Source
Features
v6.28.4Compare Source
Bug Fixes
withCredentialsif token is set (#1037) (0d0730a)v6.28.3Compare Source
Bug Fixes
v6.28.2Compare Source
Bug Fixes
v6.28.1Compare Source
Bug Fixes
v6.28.0Compare Source
Features
Bug Fixes
previewDrafts-perspective in favor ofdrafts(#1007) (3b03ac5)v6.27.2Compare Source
Bug Fixes
includeDraftsno longer require vX (#991) (22e50aa)v6.27.1Compare Source
Bug Fixes
Cannot read properties of undefined(cb80d68)v6.27.0Compare Source
Features
applySourceDocuments(#981) (ab82a35)v6.26.1Compare Source
Bug Fixes
perspectiveto edit links (#979) (65ce82d)isDraftsearch param (#978) (08d189d)v6.26.0Compare Source
Features
v6.25.0Compare Source
Features
v6.24.4Compare Source
Bug Fixes
v6.24.3Compare Source
Bug Fixes
v6.24.2Compare Source
Bug Fixes
v6.24.1Compare Source
Bug Fixes
validateApiPerspectivea TS asserter (#936) (baaa62c)v6.24.0Compare Source
Features
Bug Fixes
validateApiPerspective(b73ae46)v6.23.0Compare Source
Features
Bug Fixes
v6.22.5Compare Source
Bug Fixes
v6.22.4Compare Source
Bug Fixes
textThemeto deny list (39edfe1)Id(81aa664)v6.22.3Compare Source
Bug Fixes
v6.22.2Compare Source
Bug Fixes
withCredentialsandtagsupport (#898) (4f882c9)v6.22.1Compare Source
Bug Fixes
listenerNameproperty on welcome event (#894) (6173089)v6.22.0Compare Source
Features
includeDraftsoption (#890) (e1406b1)Bug Fixes
v6.21.3Compare Source
Bug Fixes
signalongetDocument(s)to cancel requests (#881) (13d71bb)v6.21.2Compare Source
Bug Fixes
v6.21.1Compare Source
Bug Fixes
v6.21.0Compare Source
Features
v6.20.2Compare Source
Bug Fixes
v6.20.1Compare Source
Bug Fixes
v6.20.0Compare Source
Features
client.live.events()API is now stable (#843) (d03fc09)v6.19.2Compare Source
Bug Fixes
v6.19.1Compare Source
Bug Fixes
v6.19.0Compare Source
Features
v6.18.3Compare Source
Bug Fixes
v6.18.2Compare Source
Bug Fixes
v6.18.1Compare Source
Bug Fixes
client.listenmemory leak (#805) (d2e468a)v6.18.0Compare Source
Features
v6.17.3Compare Source
Bug Fixes
Configuration
📅 Schedule: (UTC)
* 0-3 * * 1)🚦 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.