@sanity/client 8.6.1 → 8.7.0

package/dist/media-library.d.ts

@@ -1,4 +1,4 @@
-import { _r as VideoSubtitleInfoPublic, dr as VideoPlaybackInfoSigned, fr as VideoPlaybackTokens, gr as VideoSubtitleInfo, hr as VideoRenditionInfoSigned, mr as VideoRenditionInfoPublic, or as VideoPlaybackInfo, pr as VideoRenditionInfo, vr as VideoSubtitleInfoSigned } from "./types-B1XLvey7.js";
+import { _r as VideoRenditionInfoPublic, br as VideoSubtitleInfoPublic, gr as VideoRenditionInfo, hr as VideoPlaybackTokens, lr as VideoPlaybackInfo, mr as VideoPlaybackInfoSigned, vr as VideoRenditionInfoSigned, xr as VideoSubtitleInfoSigned, yr as VideoSubtitleInfo } from "./types-Do7-A3K9.js";
 /**
  * Check if the entire playback info response requires signed URLs
  * @public

package/dist/{types-B1XLvey7.d.ts → types-Do7-A3K9.d.ts}

@@ -9776,6 +9776,50 @@ declare global {
    * direct dependency, how many copies of it are installed, and from every subpath export.
    */
   interface SanityQueries {}
+  /**
+   * Schema types, keyed first by resource and then read as a union. Empty by default; a
+   * multi-resource `sanity typegen` run registers one entry per configured resource:
+   * ```ts
+   * declare global {
+   *   interface SanitySchemasByResource {
+   *     'ppsg7ml5.test': Author | Movie | Slug
+   *   }
+   * }
+   * ```
+   * A resource key is the same string the SDK uses for its runtime cache: `projectId.dataset`
+   * for a dataset, with no prefix. Consumers select one document type out of the union by its
+   * `_type`, so the union may include object types that are not documents.
+   */
+  interface SanitySchemasByResource {}
+  /**
+   * Query result types, keyed by resource and then by GROQ query string. Empty by default; a
+   * multi-resource `sanity typegen` run registers the queries it finds per resource:
+   * ```ts
+   * declare global {
+   *   interface SanityQueriesByResource {
+   *     'ppsg7ml5.test': {'*[_type == "post"]': PostsQueryResult}
+   *   }
+   * }
+   * ```
+   * The flat `SanityQueries` registry stays as it is. It cannot express two datasets whose
+   * schemas give the same query text different result types, which is what this adds.
+   */
+  interface SanityQueriesByResource {}
+  /**
+   * Projection result types, keyed by resource, then document type, then projection string.
+   * Empty by default:
+   * ```ts
+   * declare global {
+   *   interface SanityProjectionsByResource {
+   *     'ppsg7ml5.test': {author: {'{name}': {name: string | null}}}
+   *   }
+   * }
+   * ```
+   * A projection applies to a document the caller identifies by handle, so the same projection
+   * text resolves differently per document type as well as per resource. That is why there is a
+   * document-type level here and not in `SanityQueriesByResource`.
+   */
+  interface SanityProjectionsByResource {}
 }
 /**
  * The query registry as seen from `@sanity/client`. Inherits every query registered on the global
@@ -9798,6 +9842,25 @@ declare global {
  * @public
  */
 interface SanityQueries extends globalThis.SanityQueries {}
+/**
+ * The schema registry as seen from `@sanity/client`. Inherits every resource registered on the
+ * global `SanitySchemasByResource`, and also accepts a module augmentation, the same way
+ * {@link SanityQueries} does.
+ * @public
+ */
+interface SanitySchemasByResource extends globalThis.SanitySchemasByResource {}
+/**
+ * The per-resource query registry as seen from `@sanity/client`. Inherits every resource
+ * registered on the global `SanityQueriesByResource`, and also accepts a module augmentation.
+ * @public
+ */
+interface SanityQueriesByResource extends globalThis.SanityQueriesByResource {}
+/**
+ * The projection registry as seen from `@sanity/client`. Inherits every resource registered on
+ * the global `SanityProjectionsByResource`, and also accepts a module augmentation.
+ * @public
+ */
+interface SanityProjectionsByResource extends globalThis.SanityProjectionsByResource {}
 /** @public */
 type ClientReturn$1<GroqString extends string, Fallback = Any$1> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback;
 /**
@@ -10015,5 +10078,5 @@ interface MediaLibraryAssetDocument {
   parent?: SanityReference | null;
   rootDirectory?: Any$1;
 }
-export { DisconnectEvent as $, UploadClientConfig as $n, CollaborationCommentFieldValue as $r, QueryWithoutParams as $t, ContentSourceMapMappings as A, AgentActionPathSegment as Ai, SanityReference as An, ObservableProjectsClient as Ar, MediaLibraryAssetVersion as At, CreateVersionAction as B, TransactionAllDocumentIdsMutationOptions as Bn, ObservablePatchBuilder as Br, MutationSelection as Bt, ContentSourceMap$1 as C, PromptRequest as Ci, SanityDocument$1 as Cn, GenerateTarget as Cr, LiveEventGoAway as Ct, ContentSourceMapDocuments$1 as D, AgentActionParam as Di, SanityProject as Dn, SanityClient$1 as Dr, LiveEventWelcome as Dt, ContentSourceMapDocumentValueSource as E, PatchTarget as Ei, SanityImagePalette as En, ObservableSanityClient$1 as Er, LiveEventRestart as Et, ContentSourceMapValueMapping as F, GroqAgentActionParam as Fi, StackablePerspective as Fn, InvokeFunctionOptions as Fr, Mutation as Ft, DatasetResponse as G, UnarchiveReleaseAction as Gn, ObservablePatch as Gr, PatchOperations as Gt, DatasetAclMode as H, TransactionFirstDocumentIdMutationOptions as Hn, PatchBuilder as Hr, OpenEvent as Ht, CreateAction as I, StillImageFormat as In, InvokeFunctionRequest as Ir, MutationError as It, DeleteReleaseAction as J, UnpublishAction as Jn, types_d_exports as Jr, PublishReleaseAction as Jt, DatasetsResponse as K, UnfilteredResponseQueryOptions as Kn, Patch as Kr, PatchSelection as Kt, CreateReleaseAction as L, StoryboardTransformOptions as Ln, DatasetsClient as Lr, MutationErrorItem as Lt, ContentSourceMapRemoteDocument as M, ConstantAgentActionParam as Mi, ScheduleReleaseAction as Mn, MediaLibraryVideoClient as Mr, MediaLibraryVideoPlaybackTransformations as Mt, ContentSourceMapSource as N, DocumentAgentActionParam as Ni, SingleActionResult as Nn, ObservableMediaLibraryVideoClient as Nr, MultipleActionResult as Nt, ContentSourceMapLiteralSource as O, AgentActionParams as Oi, SanityProjectMember as On, ObservableUsersClient as Or, MediaLibraryAssetDocument as Ot, ContentSourceMapUnknownSource as P, FieldAgentActionParam as Pi, SingleMutationResult as Pn, InvokeFunctionEvent as Pr, MultipleMutationResult as Pt, DiscardVersionAction as Q, UploadBody as Qn, CollaborationCommentDocument as Qr, QueryParseError as Qt, CreateVariantAction as R, SyncTag as Rn, ObservableDatasetsClient as Rr, MutationEvent as Rt, ClientVariantConditions as S, TransformTargetInclude as Si, SanityAssetDocument as Sn, GenerateOperation as Sr, LiveEvent as St, ContentSourceMapDocumentBase as T, PatchOperation as Ti, SanityImageAssetDocument as Tn, GenerateTargetInclude as Tr, LiveEventReconnect as Tt, DatasetCreateOptions as U, TransactionFirstDocumentMutationOptions as Un, Transaction as Ur, PartialExcept as Ut, CurrentSanityUser as V, TransactionAllDocumentsMutationOptions as Vn, ObservableTransaction as Vr, MutationSelectionQueryParams as Vt, DatasetEditOptions as W, TransactionMutationOptions as Wn, BasePatch as Wr, PatchMutationOperation as Wt, DeleteVariantDefinitionAction as X, UnpublishVersionAction as Xn, ObservableCollaborationCommentsClient as Xr, QueryOptions as Xt, DeleteVariantAction as Y, UnpublishVariantAction as Yn, CollaborationCommentsClient as Yr, PublishVariantAction as Yt, DiscardAction as Z, UnscheduleReleaseAction as Zn, CollaborationCommentCreate as Zr, QueryParams as Zt, ChannelErrorEvent as _, ImageDescriptionOperation as _i, Requester as _n, VideoSubtitleInfoPublic as _r, InsertPatch as _t, AllDocumentsMutationOptions as a, CollaborationCommentStatus as ai, ReleaseCardinality as an, VersionAction as ar, EditableReleaseDocument as at, ClientReturn$1 as b, TransformTarget as bi, ResumableListenEventNames as bn, WelcomeEvent as br, ListenOptions as bt, Any$1 as c, CollaborationCommentsListenOptions as ci, ReleaseState as cn, VideoPlaybackInfoItemPublic as cr, ErrorProps as ct, AssetMetadataType as d, _listen as di, ReplaceVersionAction as dn, VideoPlaybackInfoSigned as dr, FirstDocumentMutationOptions as dt, CollaborationCommentMessage as ei, RawQueryResponse$1 as en, UploadEvent as er, EXPERIMENTAL_API_WARNING as et, AttributeSet as f, AssetsClient as fi, RequestHandler as fn, VideoPlaybackTokens as fr, FitMode as ft, BaseMutationOptions as g, TranslateTargetInclude as gi, RequestUrlOptions as gn, VideoSubtitleInfo as gr, InitializedClientConfig$1 as gt, BaseActionOptions as h, TranslateTarget as hi, RequestOptions$1 as hn, VideoRenditionInfoSigned as hr, ImportReleaseAction as ht, AllDocumentIdsMutationOptions as i, CollaborationCommentSelection as ii, ReleaseAction as in, VariantDefinitionAction as ir, EditVariantDefinitionAction as it, ContentSourceMapPaths as j, AgentActionTarget as ji, SanityUser as jn, ProjectsClient as jr, MediaLibraryPlaybackInfoOptions as jt, ContentSourceMapMapping as k, AgentActionPath as ki, SanityQueries as kn, UsersClient as kr, MediaLibraryAssetInstanceIdentifier as kt, ApiError as l, CollaborationCommentsRequestOptions as li, ReleaseType as ln, VideoPlaybackInfoItemSigned as lr, FilteredResponseQueryOptions as lt, AuthProviderResponse as m, TranslateDocument as mi, RequestObservableOptions as mn, VideoRenditionInfoPublic as mr, IdentifiedSanityDocumentStub as mt, ActionError as n, CollaborationCommentRange as ni, RawRequestOptions as nn, UploadResponseEvent as nr, EditReleaseAction as nt, AnimatedImageFormat as o, CollaborationCommentTarget as oi, ReleaseDocument as on, VideoPlaybackInfo as or, EmbeddingsSettings as ot, AuthProvider as p, ObservableAssetsClient as pi, RequestHandlerOptions as pn, VideoRenditionInfo as pr, HttpRequest as pt, DeleteAction as q, UnfilteredResponseWithoutQuery as qn, LiveClient as qr, PublishAction as qt, ActionErrorItem as r, CollaborationCommentReactionShortName as ri, ReconnectEvent as rn, VariantAction as rr, EditVariantAction as rt, AnimatedTransformOptions as s, CollaborationCommentUpdate as si, ReleaseId as sn, VideoPlaybackInfoItem as sr, EmbeddingsSettingsBody as st, Action as t, CollaborationCommentPortableTextBlock as ti, RawQuerylessQueryResponse as tn, UploadProgressEvent as tr, EditAction as tt, ArchiveReleaseAction as u, CollaborationCommentsWriteOptions as ui, ReplaceDraftAction as un, VideoPlaybackInfoPublic as ur, FirstDocumentIdMutationOptions as ut, ClientConfig$1 as v, TransformDocument as vi, ResetEvent as vn, VideoSubtitleInfoSigned as vr, ListenEvent as vt, ContentSourceMapDocument as w, PatchDocument as wi, SanityDocumentStub as wn, GenerateTargetDocument as wr, LiveEventMessage as wt, ClientVariant as x, TransformTargetDocument as xi, ResumableListenOptions as xn, GenerateInstruction as xr, ListenParams as xt, ClientPerspective$1 as y, TransformOperation as yi, ResponseQueryOptions as yn, WelcomeBackEvent as yr, ListenEventName as yt, CreateVariantDefinitionAction as z, ThumbnailTransformOptions as zn, BaseTransaction as zr, MutationOperation as zt };
-//# sourceMappingURL=types-B1XLvey7.d.ts.map
+export { DisconnectEvent as $, UnpublishVersionAction as $n, ObservableCollaborationCommentsClient as $r, QueryWithoutParams as $t, ContentSourceMapMappings as A, AgentActionParam as Ai, SanityQueries as An, SanityClient$1 as Ar, MediaLibraryAssetVersion as At, CreateVersionAction as B, StoryboardTransformOptions as Bn, DatasetsClient as Br, MutationSelection as Bt, ContentSourceMap$1 as C, TransformTarget as Ci, SanityDocument$1 as Cn, WelcomeEvent as Cr, LiveEventGoAway as Ct, ContentSourceMapDocuments$1 as D, PatchDocument as Di, SanityProject as Dn, GenerateTargetDocument as Dr, LiveEventWelcome as Dt, ContentSourceMapDocumentValueSource as E, PromptRequest as Ei, SanityImagePalette as En, GenerateTarget as Er, LiveEventRestart as Et, ContentSourceMapValueMapping as F, ConstantAgentActionParam as Fi, ScheduleReleaseAction as Fn, MediaLibraryVideoClient as Fr, Mutation as Ft, DatasetResponse as G, TransactionFirstDocumentIdMutationOptions as Gn, PatchBuilder as Gr, PatchOperations as Gt, DatasetAclMode as H, ThumbnailTransformOptions as Hn, BaseTransaction as Hr, OpenEvent as Ht, CreateAction as I, DocumentAgentActionParam as Ii, SingleActionResult as In, ObservableMediaLibraryVideoClient as Ir, MutationError as It, DeleteReleaseAction as J, UnarchiveReleaseAction as Jn, ObservablePatch as Jr, PublishReleaseAction as Jt, DatasetsResponse as K, TransactionFirstDocumentMutationOptions as Kn, Transaction as Kr, PatchSelection as Kt, CreateReleaseAction as L, FieldAgentActionParam as Li, SingleMutationResult as Ln, InvokeFunctionEvent as Lr, MutationErrorItem as Lt, ContentSourceMapRemoteDocument as M, AgentActionPath as Mi, SanityReference as Mn, UsersClient as Mr, MediaLibraryVideoPlaybackTransformations as Mt, ContentSourceMapSource as N, AgentActionPathSegment as Ni, SanitySchemasByResource as Nn, ObservableProjectsClient as Nr, MultipleActionResult as Nt, ContentSourceMapLiteralSource as O, PatchOperation as Oi, SanityProjectMember as On, GenerateTargetInclude as Or, MediaLibraryAssetDocument as Ot, ContentSourceMapUnknownSource as P, AgentActionTarget as Pi, SanityUser as Pn, ProjectsClient as Pr, MultipleMutationResult as Pt, DiscardVersionAction as Q, UnpublishVariantAction as Qn, CollaborationCommentsClient as Qr, QueryParseError as Qt, CreateVariantAction as R, GroqAgentActionParam as Ri, StackablePerspective as Rn, InvokeFunctionOptions as Rr, MutationEvent as Rt, ClientVariantConditions as S, TransformOperation as Si, SanityAssetDocument as Sn, WelcomeBackEvent as Sr, LiveEvent as St, ContentSourceMapDocumentBase as T, TransformTargetInclude as Ti, SanityImageAssetDocument as Tn, GenerateOperation as Tr, LiveEventReconnect as Tt, DatasetCreateOptions as U, TransactionAllDocumentIdsMutationOptions as Un, ObservablePatchBuilder as Ur, PartialExcept as Ut, CurrentSanityUser as V, SyncTag as Vn, ObservableDatasetsClient as Vr, MutationSelectionQueryParams as Vt, DatasetEditOptions as W, TransactionAllDocumentsMutationOptions as Wn, ObservableTransaction as Wr, PatchMutationOperation as Wt, DeleteVariantDefinitionAction as X, UnfilteredResponseWithoutQuery as Xn, LiveClient as Xr, QueryOptions as Xt, DeleteVariantAction as Y, UnfilteredResponseQueryOptions as Yn, Patch as Yr, PublishVariantAction as Yt, DiscardAction as Z, UnpublishAction as Zn, types_d_exports as Zr, QueryParams as Zt, ChannelErrorEvent as _, TranslateDocument as _i, Requester as _n, VideoRenditionInfoPublic as _r, InsertPatch as _t, AllDocumentsMutationOptions as a, CollaborationCommentRange as ai, ReleaseCardinality as an, UploadResponseEvent as ar, EditableReleaseDocument as at, ClientReturn$1 as b, ImageDescriptionOperation as bi, ResumableListenEventNames as bn, VideoSubtitleInfoPublic as br, ListenOptions as bt, Any$1 as c, CollaborationCommentStatus as ci, ReleaseState as cn, VersionAction as cr, ErrorProps as ct, AssetMetadataType as d, CollaborationCommentsListenOptions as di, ReplaceVersionAction as dn, VideoPlaybackInfoItemPublic as dr, FirstDocumentMutationOptions as dt, CollaborationCommentCreate as ei, RawQueryResponse$1 as en, UnscheduleReleaseAction as er, EXPERIMENTAL_API_WARNING as et, AttributeSet as f, CollaborationCommentsRequestOptions as fi, RequestHandler as fn, VideoPlaybackInfoItemSigned as fr, FitMode as ft, BaseMutationOptions as g, ObservableAssetsClient as gi, RequestUrlOptions as gn, VideoRenditionInfo as gr, InitializedClientConfig$1 as gt, BaseActionOptions as h, AssetsClient as hi, RequestOptions$1 as hn, VideoPlaybackTokens as hr, ImportReleaseAction as ht, AllDocumentIdsMutationOptions as i, CollaborationCommentPortableTextBlock as ii, ReleaseAction as in, UploadProgressEvent as ir, EditVariantDefinitionAction as it, ContentSourceMapPaths as j, AgentActionParams as ji, SanityQueriesByResource as jn, ObservableUsersClient as jr, MediaLibraryPlaybackInfoOptions as jt, ContentSourceMapMapping as k, PatchTarget as ki, SanityProjectionsByResource as kn, ObservableSanityClient$1 as kr, MediaLibraryAssetInstanceIdentifier as kt, ApiError as l, CollaborationCommentTarget as li, ReleaseType as ln, VideoPlaybackInfo as lr, FilteredResponseQueryOptions as lt, AuthProviderResponse as m, _listen as mi, RequestObservableOptions as mn, VideoPlaybackInfoSigned as mr, IdentifiedSanityDocumentStub as mt, ActionError as n, CollaborationCommentFieldValue as ni, RawRequestOptions as nn, UploadClientConfig as nr, EditReleaseAction as nt, AnimatedImageFormat as o, CollaborationCommentReactionShortName as oi, ReleaseDocument as on, VariantAction as or, EmbeddingsSettings as ot, AuthProvider as p, CollaborationCommentsWriteOptions as pi, RequestHandlerOptions as pn, VideoPlaybackInfoPublic as pr, HttpRequest as pt, DeleteAction as q, TransactionMutationOptions as qn, BasePatch as qr, PublishAction as qt, ActionErrorItem as r, CollaborationCommentMessage as ri, ReconnectEvent as rn, UploadEvent as rr, EditVariantAction as rt, AnimatedTransformOptions as s, CollaborationCommentSelection as si, ReleaseId as sn, VariantDefinitionAction as sr, EmbeddingsSettingsBody as st, Action as t, CollaborationCommentDocument as ti, RawQuerylessQueryResponse as tn, UploadBody as tr, EditAction as tt, ArchiveReleaseAction as u, CollaborationCommentUpdate as ui, ReplaceDraftAction as un, VideoPlaybackInfoItem as ur, FirstDocumentIdMutationOptions as ut, ClientConfig$1 as v, TranslateTarget as vi, ResetEvent as vn, VideoRenditionInfoSigned as vr, ListenEvent as vt, ContentSourceMapDocument as w, TransformTargetDocument as wi, SanityDocumentStub as wn, GenerateInstruction as wr, LiveEventMessage as wt, ClientVariant as x, TransformDocument as xi, ResumableListenOptions as xn, VideoSubtitleInfoSigned as xr, ListenParams as xt, ClientPerspective$1 as y, TranslateTargetInclude as yi, ResponseQueryOptions as yn, VideoSubtitleInfo as yr, ListenEventName as yt, CreateVariantDefinitionAction as z, StillImageFormat as zn, InvokeFunctionRequest as zr, MutationOperation as zt };
+//# sourceMappingURL=types-Do7-A3K9.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "8.6.1",
+  "version": "8.7.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "api",
@@ -49,9 +49,9 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "eventsource": "^5.1.1",
-    "get-it": "^9.5.4",
-    "obug": "^2.1.4",
+    "eventsource": "^5.1.2",
+    "get-it": "^9.5.7",
+    "obug": "^3.0.0",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {

package/src/types.ts

@@ -2298,6 +2298,53 @@ declare global {
    * direct dependency, how many copies of it are installed, and from every subpath export.
    */
   interface SanityQueries {}
+
+  /**
+   * Schema types, keyed first by resource and then read as a union. Empty by default; a
+   * multi-resource `sanity typegen` run registers one entry per configured resource:
+   * ```ts
+   * declare global {
+   *   interface SanitySchemasByResource {
+   *     'ppsg7ml5.test': Author | Movie | Slug
+   *   }
+   * }
+   * ```
+   * A resource key is the same string the SDK uses for its runtime cache: `projectId.dataset`
+   * for a dataset, with no prefix. Consumers select one document type out of the union by its
+   * `_type`, so the union may include object types that are not documents.
+   */
+  interface SanitySchemasByResource {}
+
+  /**
+   * Query result types, keyed by resource and then by GROQ query string. Empty by default; a
+   * multi-resource `sanity typegen` run registers the queries it finds per resource:
+   * ```ts
+   * declare global {
+   *   interface SanityQueriesByResource {
+   *     'ppsg7ml5.test': {'*[_type == "post"]': PostsQueryResult}
+   *   }
+   * }
+   * ```
+   * The flat `SanityQueries` registry stays as it is. It cannot express two datasets whose
+   * schemas give the same query text different result types, which is what this adds.
+   */
+  interface SanityQueriesByResource {}
+
+  /**
+   * Projection result types, keyed by resource, then document type, then projection string.
+   * Empty by default:
+   * ```ts
+   * declare global {
+   *   interface SanityProjectionsByResource {
+   *     'ppsg7ml5.test': {author: {'{name}': {name: string | null}}}
+   *   }
+   * }
+   * ```
+   * A projection applies to a document the caller identifies by handle, so the same projection
+   * text resolves differently per document type as well as per resource. That is why there is a
+   * document-type level here and not in `SanityQueriesByResource`.
+   */
+  interface SanityProjectionsByResource {}
 }
 
 /**
@@ -2322,6 +2369,28 @@ declare global {
  */
 export interface SanityQueries extends globalThis.SanityQueries {}
 
+/**
+ * The schema registry as seen from `@sanity/client`. Inherits every resource registered on the
+ * global `SanitySchemasByResource`, and also accepts a module augmentation, the same way
+ * {@link SanityQueries} does.
+ * @public
+ */
+export interface SanitySchemasByResource extends globalThis.SanitySchemasByResource {}
+
+/**
+ * The per-resource query registry as seen from `@sanity/client`. Inherits every resource
+ * registered on the global `SanityQueriesByResource`, and also accepts a module augmentation.
+ * @public
+ */
+export interface SanityQueriesByResource extends globalThis.SanityQueriesByResource {}
+
+/**
+ * The projection registry as seen from `@sanity/client`. Inherits every resource registered on
+ * the global `SanityProjectionsByResource`, and also accepts a module augmentation.
+ * @public
+ */
+export interface SanityProjectionsByResource extends globalThis.SanityProjectionsByResource {}
+
 /** @public */
 export type ClientReturn<
   GroqString extends string,