@sanity/client 7.26.1 → 7.27.0

package/dist/stega.d.cts

@@ -417,14 +417,7 @@ export declare interface ArchiveReleaseAction {
 
 /** @public */
 export declare type AssetMetadataType =
-  | 'location'
-  | 'exif'
-  | 'image'
-  | 'palette'
-  | 'lqip'
-  | 'blurhash'
-  | 'thumbhash'
-  | 'none'
+  'location' | 'exif' | 'image' | 'palette' | 'lqip' | 'blurhash' | 'thumbhash' | 'none'
 
 /** @internal */
 export declare class AssetsClient {
@@ -866,17 +859,13 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | DeprecatedPreviewDrafts
-  | 'published'
-  | 'drafts'
-  | 'raw'
-  | StackablePerspective[]
+  DeprecatedPreviewDrafts | 'published' | 'drafts' | 'raw' | StackablePerspective[]
 
 /** @public */
 export declare type ClientReturn<
   GroqString extends string,
   Fallback = Any,
-> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
+> = GroqString extends keyof SanityQueries_2 ? SanityQueries_2[GroqString] : Fallback
 
 /**
  * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use
@@ -1041,14 +1030,12 @@ declare interface ContentSourceMapDocumentBase_2 {
 
 /** @public */
 export declare type ContentSourceMapDocuments = (
-  | ContentSourceMapDocument
-  | ContentSourceMapRemoteDocument
+  ContentSourceMapDocument | ContentSourceMapRemoteDocument
 )[]
 
 /** @public */
 declare type ContentSourceMapDocuments_2 = (
-  | ContentSourceMapDocument_2
-  | ContentSourceMapRemoteDocument_2
+  ContentSourceMapDocument_2 | ContentSourceMapRemoteDocument_2
 )[]
 
 /**
@@ -1101,9 +1088,7 @@ declare type ContentSourceMapMappings_2 = Record<string, ContentSourceMapMapping
 
 /** @alpha */
 export declare type ContentSourceMapParsedPath = (
-  | string
-  | number
-  | ContentSourceMapParsedPathKeyedSegment
+  string | number | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
@@ -1120,8 +1105,7 @@ declare type ContentSourceMapPaths_2 = string[]
 
 /** @public */
 export declare type ContentSourceMapQueryResponse =
-  | RawQueryResponse<unknown>
-  | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
+  RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
 
 /** @public */
 export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
@@ -1775,8 +1759,7 @@ export declare function formatQueryParseError(
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionAsync
@@ -1795,8 +1778,7 @@ declare interface GenerateExistingDocumentRequest {
 
 /** @beta */
 export declare type GenerateInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | GenerateSyncInstruction<T>
-  | GenerateAsyncInstruction<T>
+  GenerateSyncInstruction<T> | GenerateAsyncInstruction<T>
 
 /**  @beta */
 export declare type GenerateOperation = 'set' | 'append' | 'mixed'
@@ -1927,8 +1909,7 @@ declare interface GenerateRequestBase extends AgentActionRequestBase {
 
 /** @beta */
 declare type GenerateSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionSync
@@ -2275,12 +2256,7 @@ export declare function _listen<
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any> = Record<string, Any>> =
-  | MutationEvent<R>
-  | ReconnectEvent
-  | WelcomeBackEvent
-  | ResetEvent
-  | WelcomeEvent
-  | OpenEvent
+  MutationEvent<R> | ReconnectEvent | WelcomeBackEvent | ResetEvent | WelcomeEvent | OpenEvent
 
 /**
  * Maps a ListenOptions object and returns the Listen events opted for, e.g:
@@ -2420,11 +2396,7 @@ export declare class LiveClient {
 
 /** @public */
 export declare type LiveEvent =
-  | LiveEventRestart
-  | LiveEventReconnect
-  | LiveEventMessage
-  | LiveEventWelcome
-  | LiveEventGoAway
+  LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway
 
 /**
  * The `id` field is the position at which the connection was rejected or closed.
@@ -2486,8 +2458,7 @@ declare type Logger_2 =
 declare type MapListenEventNamesToListenEvents<
   R extends Record<string, Any> = Record<string, Any>,
   Events extends (ResumableListenEventNames | ListenEventName)[] = (
-    | ResumableListenEventNames
-    | ListenEventName
+    ResumableListenEventNames | ListenEventName
   )[],
 > = Events extends (infer E)[]
   ? E extends 'welcome'
@@ -4214,21 +4185,18 @@ export declare type PatchBuilder = (patch: Patch) => Patch
 
 /** @beta */
 export declare type PatchDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | PatchDocumentSync<T>
-  | PatchDocumentAsync<T>
+  PatchDocumentSync<T> | PatchDocumentAsync<T>
 
 /** @beta */
 declare type PatchDocumentAsync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionAsync
 
 /** @beta */
 declare type PatchDocumentSync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionSync
@@ -4394,8 +4362,7 @@ declare interface PromptJsonResponse<T extends Record<string, Any> = Record<stri
 
 /** @beta */
 export declare type PromptRequest<T extends Record<string, Any> = Record<string, Any>> = (
-  | PromptTextResponse
-  | PromptJsonResponse<T>
+  PromptTextResponse | PromptJsonResponse<T>
 ) &
   PromptRequestBase
 
@@ -4540,9 +4507,7 @@ export declare interface PublishReleaseAction {
 
 /** @public */
 export declare type QueryOptions =
-  | FilteredResponseQueryOptions
-  | UnfilteredResponseQueryOptions
-  | UnfilteredResponseWithoutQuery
+  FilteredResponseQueryOptions | UnfilteredResponseQueryOptions | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -5185,8 +5150,10 @@ export declare type ResumableListenEventNames =
   | 'reset'
 
 /** @public */
-export declare interface ResumableListenOptions
-  extends Omit<ListenOptions, 'events' | 'enableResume'> {
+export declare interface ResumableListenOptions extends Omit<
+  ListenOptions,
+  'events' | 'enableResume'
+> {
   /**
    * If this is enabled, the client will normally resume events upon reconnect
    * Note that you should also subscribe to `reset`-events and handle the case where the backend is unable to resume
@@ -6112,8 +6079,28 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
-/** @public */
-export declare interface SanityQueries {}
+/**
+ * The query registry as seen from `@sanity/client`. Inherits every query registered on the global
+ * `SanityQueries` interface, and still accepts the older module augmentation form:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries {
+ *     '*[_type == "post"]': PostsQueryResult
+ *   }
+ * }
+ * ```
+ * `@sanity/client` releases that predate the global registry only read this interface, so a
+ * generated file that registers queries globally can bridge them with an augmentation that adds
+ * the global as a base type. It is harmless on releases that already inherit it:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries extends globalThis.SanityQueries {}
+ * }
+ * ```
+ * @public
+ */
+declare interface SanityQueries_2 extends globalThis.SanityQueries {}
+export {SanityQueries_2 as SanityQueries}
 
 /** @internal */
 export declare interface SanityReference {
@@ -6428,10 +6415,7 @@ export declare type StudioBaseRoute = {
 
 /** @alpha */
 export declare type StudioBaseUrl =
-  | `/${string}`
-  | `${string}.sanity.studio`
-  | `https://${string}`
-  | string
+  `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
 
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
@@ -6555,8 +6539,7 @@ export declare type TransactionMutationOptions =
 
 /** @beta */
 export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TransformDocumentSync<T>
-  | TransformDocumentAsync
+  TransformDocumentSync<T> | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
@@ -6820,8 +6803,7 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 
 /** @beta */
 export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TranslateDocumentSync<T>
-  | TranslateDocumentAsync
+  TranslateDocumentSync<T> | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
@@ -7106,10 +7088,7 @@ export declare const vercelStegaCleanAll: typeof stegaClean
 
 /** @public */
 export declare type VersionAction =
-  | CreateVersionAction
-  | DiscardVersionAction
-  | ReplaceVersionAction
-  | UnpublishVersionAction
+  CreateVersionAction | DiscardVersionAction | ReplaceVersionAction | UnpublishVersionAction
 
 /** @public */
 export declare interface VideoPlaybackInfo<
@@ -7134,8 +7113,7 @@ export declare interface VideoPlaybackInfo<
 
 /** @public */
 export declare type VideoPlaybackInfoItem =
-  | VideoPlaybackInfoItemPublic
-  | VideoPlaybackInfoItemSigned
+  VideoPlaybackInfoItemPublic | VideoPlaybackInfoItemSigned
 
 /** @public */
 export declare interface VideoPlaybackInfoItemPublic {

package/dist/stega.d.ts

@@ -417,14 +417,7 @@ export declare interface ArchiveReleaseAction {
 
 /** @public */
 export declare type AssetMetadataType =
-  | 'location'
-  | 'exif'
-  | 'image'
-  | 'palette'
-  | 'lqip'
-  | 'blurhash'
-  | 'thumbhash'
-  | 'none'
+  'location' | 'exif' | 'image' | 'palette' | 'lqip' | 'blurhash' | 'thumbhash' | 'none'
 
 /** @internal */
 export declare class AssetsClient {
@@ -866,17 +859,13 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | DeprecatedPreviewDrafts
-  | 'published'
-  | 'drafts'
-  | 'raw'
-  | StackablePerspective[]
+  DeprecatedPreviewDrafts | 'published' | 'drafts' | 'raw' | StackablePerspective[]
 
 /** @public */
 export declare type ClientReturn<
   GroqString extends string,
   Fallback = Any,
-> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
+> = GroqString extends keyof SanityQueries_2 ? SanityQueries_2[GroqString] : Fallback
 
 /**
  * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use
@@ -1041,14 +1030,12 @@ declare interface ContentSourceMapDocumentBase_2 {
 
 /** @public */
 export declare type ContentSourceMapDocuments = (
-  | ContentSourceMapDocument
-  | ContentSourceMapRemoteDocument
+  ContentSourceMapDocument | ContentSourceMapRemoteDocument
 )[]
 
 /** @public */
 declare type ContentSourceMapDocuments_2 = (
-  | ContentSourceMapDocument_2
-  | ContentSourceMapRemoteDocument_2
+  ContentSourceMapDocument_2 | ContentSourceMapRemoteDocument_2
 )[]
 
 /**
@@ -1101,9 +1088,7 @@ declare type ContentSourceMapMappings_2 = Record<string, ContentSourceMapMapping
 
 /** @alpha */
 export declare type ContentSourceMapParsedPath = (
-  | string
-  | number
-  | ContentSourceMapParsedPathKeyedSegment
+  string | number | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
@@ -1120,8 +1105,7 @@ declare type ContentSourceMapPaths_2 = string[]
 
 /** @public */
 export declare type ContentSourceMapQueryResponse =
-  | RawQueryResponse<unknown>
-  | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
+  RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
 
 /** @public */
 export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
@@ -1775,8 +1759,7 @@ export declare function formatQueryParseError(
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionAsync
@@ -1795,8 +1778,7 @@ declare interface GenerateExistingDocumentRequest {
 
 /** @beta */
 export declare type GenerateInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | GenerateSyncInstruction<T>
-  | GenerateAsyncInstruction<T>
+  GenerateSyncInstruction<T> | GenerateAsyncInstruction<T>
 
 /**  @beta */
 export declare type GenerateOperation = 'set' | 'append' | 'mixed'
@@ -1927,8 +1909,7 @@ declare interface GenerateRequestBase extends AgentActionRequestBase {
 
 /** @beta */
 declare type GenerateSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionSync
@@ -2275,12 +2256,7 @@ export declare function _listen<
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any> = Record<string, Any>> =
-  | MutationEvent<R>
-  | ReconnectEvent
-  | WelcomeBackEvent
-  | ResetEvent
-  | WelcomeEvent
-  | OpenEvent
+  MutationEvent<R> | ReconnectEvent | WelcomeBackEvent | ResetEvent | WelcomeEvent | OpenEvent
 
 /**
  * Maps a ListenOptions object and returns the Listen events opted for, e.g:
@@ -2420,11 +2396,7 @@ export declare class LiveClient {
 
 /** @public */
 export declare type LiveEvent =
-  | LiveEventRestart
-  | LiveEventReconnect
-  | LiveEventMessage
-  | LiveEventWelcome
-  | LiveEventGoAway
+  LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway
 
 /**
  * The `id` field is the position at which the connection was rejected or closed.
@@ -2486,8 +2458,7 @@ declare type Logger_2 =
 declare type MapListenEventNamesToListenEvents<
   R extends Record<string, Any> = Record<string, Any>,
   Events extends (ResumableListenEventNames | ListenEventName)[] = (
-    | ResumableListenEventNames
-    | ListenEventName
+    ResumableListenEventNames | ListenEventName
   )[],
 > = Events extends (infer E)[]
   ? E extends 'welcome'
@@ -4214,21 +4185,18 @@ export declare type PatchBuilder = (patch: Patch) => Patch
 
 /** @beta */
 export declare type PatchDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | PatchDocumentSync<T>
-  | PatchDocumentAsync<T>
+  PatchDocumentSync<T> | PatchDocumentAsync<T>
 
 /** @beta */
 declare type PatchDocumentAsync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionAsync
 
 /** @beta */
 declare type PatchDocumentSync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionSync
@@ -4394,8 +4362,7 @@ declare interface PromptJsonResponse<T extends Record<string, Any> = Record<stri
 
 /** @beta */
 export declare type PromptRequest<T extends Record<string, Any> = Record<string, Any>> = (
-  | PromptTextResponse
-  | PromptJsonResponse<T>
+  PromptTextResponse | PromptJsonResponse<T>
 ) &
   PromptRequestBase
 
@@ -4540,9 +4507,7 @@ export declare interface PublishReleaseAction {
 
 /** @public */
 export declare type QueryOptions =
-  | FilteredResponseQueryOptions
-  | UnfilteredResponseQueryOptions
-  | UnfilteredResponseWithoutQuery
+  FilteredResponseQueryOptions | UnfilteredResponseQueryOptions | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -5185,8 +5150,10 @@ export declare type ResumableListenEventNames =
   | 'reset'
 
 /** @public */
-export declare interface ResumableListenOptions
-  extends Omit<ListenOptions, 'events' | 'enableResume'> {
+export declare interface ResumableListenOptions extends Omit<
+  ListenOptions,
+  'events' | 'enableResume'
+> {
   /**
    * If this is enabled, the client will normally resume events upon reconnect
    * Note that you should also subscribe to `reset`-events and handle the case where the backend is unable to resume
@@ -6112,8 +6079,28 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
-/** @public */
-export declare interface SanityQueries {}
+/**
+ * The query registry as seen from `@sanity/client`. Inherits every query registered on the global
+ * `SanityQueries` interface, and still accepts the older module augmentation form:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries {
+ *     '*[_type == "post"]': PostsQueryResult
+ *   }
+ * }
+ * ```
+ * `@sanity/client` releases that predate the global registry only read this interface, so a
+ * generated file that registers queries globally can bridge them with an augmentation that adds
+ * the global as a base type. It is harmless on releases that already inherit it:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries extends globalThis.SanityQueries {}
+ * }
+ * ```
+ * @public
+ */
+declare interface SanityQueries_2 extends globalThis.SanityQueries {}
+export {SanityQueries_2 as SanityQueries}
 
 /** @internal */
 export declare interface SanityReference {
@@ -6428,10 +6415,7 @@ export declare type StudioBaseRoute = {
 
 /** @alpha */
 export declare type StudioBaseUrl =
-  | `/${string}`
-  | `${string}.sanity.studio`
-  | `https://${string}`
-  | string
+  `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
 
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
@@ -6555,8 +6539,7 @@ export declare type TransactionMutationOptions =
 
 /** @beta */
 export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TransformDocumentSync<T>
-  | TransformDocumentAsync
+  TransformDocumentSync<T> | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
@@ -6820,8 +6803,7 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 
 /** @beta */
 export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TranslateDocumentSync<T>
-  | TranslateDocumentAsync
+  TranslateDocumentSync<T> | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
@@ -7106,10 +7088,7 @@ export declare const vercelStegaCleanAll: typeof stegaClean
 
 /** @public */
 export declare type VersionAction =
-  | CreateVersionAction
-  | DiscardVersionAction
-  | ReplaceVersionAction
-  | UnpublishVersionAction
+  CreateVersionAction | DiscardVersionAction | ReplaceVersionAction | UnpublishVersionAction
 
 /** @public */
 export declare interface VideoPlaybackInfo<
@@ -7134,8 +7113,7 @@ export declare interface VideoPlaybackInfo<
 
 /** @public */
 export declare type VideoPlaybackInfoItem =
-  | VideoPlaybackInfoItemPublic
-  | VideoPlaybackInfoItemSigned
+  VideoPlaybackInfoItemPublic | VideoPlaybackInfoItemSigned
 
 /** @public */
 export declare interface VideoPlaybackInfoItemPublic {
@@ -7240,3 +7218,23 @@ export declare type WelcomeEvent = {
 }
 
 export {}
+
+declare global {
+  /**
+   * Query result types, keyed by GROQ query string. Empty by default, `sanity typegen` registers
+   * the queries it finds:
+   * ```ts
+   * declare global {
+   *   interface SanityQueries {
+   *     '*[_type == "post"]': PostsQueryResult
+   *   }
+   * }
+   * ```
+   * `client.fetch(query)` and `ClientReturn<typeof query>` then resolve to the registered type.
+   *
+   * The registry is a global rather than a module augmentation of `@sanity/client` so that it
+   * does not depend on module resolution: it resolves the same whether `@sanity/client` is a
+   * direct dependency, how many copies of it are installed, and from every subpath export.
+   */
+  interface SanityQueries {}
+}