@sanity/client 8.4.0 → 8.6.0

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

@@ -959,7 +959,10 @@ type TranslateDocumentSync<T extends Record<string, Any$1> = Record<string, Any$
 type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync;
 /** @beta */
 type TranslateDocument<T extends Record<string, Any$1> = Record<string, Any$1>> = TranslateDocumentSync<T> | TranslateDocumentAsync;
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableAgentsActionClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -985,7 +988,10 @@ declare class ObservableAgentsActionClient {
     _id: string;
   } : IdentifiedSanityDocumentStub & DocumentShape>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class AgentActionsClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -1024,7 +1030,10 @@ declare class AgentActionsClient {
     _id: string;
   } : IdentifiedSanityDocumentStub & DocumentShape>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableAssetsClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -1059,7 +1068,10 @@ declare class ObservableAssetsClient {
     document: SanityAssetDocument | SanityImageAssetDocument;
   }>>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class AssetsClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -2105,7 +2117,7 @@ interface paths {
     get?: never;
     /**
      * Record a conversation
-     * @description Upserts the conversation telemetry for one thread. `threadId` identifies the conversation within your organization — reuse means the same conversation. Messages replace the stored transcript wholesale; `metadata` and model fields only overwrite when present. Last write per thread wins — retries are safe.
+     * @description Upserts the conversation telemetry for one thread. `threadId` identifies the conversation within your organization — reuse means the same conversation. Messages replace the stored transcript wholesale; `metadata`, `sharing`, and model fields only overwrite when present. Last write per thread wins — retries are safe. `sharing` records your opt-in to share telemetry with Sanity: metadata-only metrics, or full transcripts.
      */
     put: operations['saveConversation'];
     post?: never;
@@ -2175,6 +2187,15 @@ interface components {
       /** Format: date-time */
       classifiedAt: string | null;
       classificationError: string | null;
+      /**
+       * @description ConversationSharing
+       * @default null
+       */
+      sharing: {
+        metrics?: boolean;
+        conversations?: boolean;
+        contact?: string;
+      } | null;
     };
     /** @description A `sanity.context.entry` document, one outline node stored in the bound dataset. Not returned by any endpoint; published so GROQ reads against the dataset can be typed. The entries endpoints serve the validated wire view. */
     EntryDoc: {
@@ -2530,6 +2551,11 @@ interface operations {
               refreshInFlight: boolean;
               openIssueCount: number;
               instructionCount: number;
+              /** @description Actor */
+              createdBy: {
+                id: string | null;
+                displayName: string | null;
+              } | null;
               /** Format: date-time */
               createdAt: string;
               /** Format: date-time */
@@ -2622,6 +2648,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -2704,6 +2735,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -2818,6 +2854,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -3831,6 +3872,12 @@ interface operations {
           metadata?: {
             [key: string]: string | string[];
           };
+          /** @description ConversationSharing */
+          sharing?: {
+            metrics?: boolean;
+            conversations?: boolean;
+            contact?: string;
+          };
         };
       };
     };
@@ -3883,6 +3930,12 @@ interface operations {
             /** Format: date-time */
             classifiedAt: string | null;
             classificationError: string | null;
+            /** @description ConversationSharing */
+            sharing: {
+              metrics?: boolean;
+              conversations?: boolean;
+              contact?: string;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -3964,6 +4017,12 @@ interface operations {
             /** Format: date-time */
             classifiedAt: string | null;
             classificationError: string | null;
+            /** @description ConversationSharing */
+            sharing: {
+              metrics?: boolean;
+              conversations?: boolean;
+              contact?: string;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -4873,6 +4932,7 @@ declare class ObservableContextClient {
 }
 /**
  * @public
+ * @inline
  */
 declare class LiveClient {
   #private;
@@ -5250,7 +5310,10 @@ declare class ObservableTransaction extends BaseTransaction {
    */
   patch(patch: ObservablePatch): this;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableDatasetsClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -5294,7 +5357,10 @@ declare class ObservableDatasetsClient {
    */
   editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Observable<void>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class DatasetsClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -5434,7 +5500,10 @@ declare class FunctionsClient {
   }): Promise<R>;
   invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions): Promise<R | undefined>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableMediaLibraryVideoClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -5446,7 +5515,10 @@ declare class ObservableMediaLibraryVideoClient {
    */
   getPlaybackInfo(assetIdentifier: MediaLibraryAssetInstanceIdentifier, options?: MediaLibraryPlaybackInfoOptions): Observable<VideoPlaybackInfo>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class MediaLibraryVideoClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -5469,7 +5541,10 @@ type OmittedProjectFields<T extends ListOptions | undefined> = (T extends {
 } ? 'members' : never) | (T extends {
   includeFeatures: false;
 } ? 'features' : never);
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableProjectsClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -5490,7 +5565,10 @@ declare class ObservableProjectsClient {
    */
   getById(projectId: string): Observable<SanityProject>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ProjectsClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -5511,7 +5589,10 @@ declare class ProjectsClient {
    */
   getById(projectId: string): Promise<SanityProject>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableReleasesClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -5756,7 +5837,10 @@ declare class ObservableReleasesClient {
     releaseId: string;
   }, options?: BaseMutationOptions): Observable<RawQueryResponse$1<SanityDocument$1[]>>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ReleasesClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -5992,7 +6076,10 @@ declare class ReleasesClient {
     releaseId: string;
   }, options?: BaseMutationOptions): Promise<RawQueryResponse$1<SanityDocument$1[]>>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableUsersClient {
   #private;
   constructor(client: ObservableSanityClient$1, httpRequest: HttpRequest);
@@ -6003,7 +6090,10 @@ declare class ObservableUsersClient {
    */
   getById<T extends string>(id: T): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class UsersClient {
   #private;
   constructor(client: SanityClient$1, httpRequest: HttpRequest);
@@ -6017,15 +6107,52 @@ declare class UsersClient {
 /** @public */
 declare class ObservableSanityClient$1 {
   #private;
+  /**
+   * Upload, fetch and delete assets (images and files) in the configured dataset
+   *
+   * @category Assets
+   */
   assets: ObservableAssetsClient;
+  /**
+   * Create, list, edit and delete datasets in the configured project
+   *
+   * @category Projects & Datasets
+   */
   datasets: ObservableDatasetsClient;
+  /**
+   * Subscribe to live content updates through the Live Content API
+   *
+   * @category Real-time
+   */
   live: LiveClient;
+  /**
+   * Interact with Media Library assets
+   *
+   * @category Assets
+   */
   mediaLibrary: {
+    /** Upload and manage Media Library video assets */
     video: ObservableMediaLibraryVideoClient;
   };
+  /**
+   * Fetch information about the projects the authenticated user has access to
+   *
+   * @category Projects & Datasets
+   */
   projects: ObservableProjectsClient;
+  /**
+   * Fetch information about users in the configured project
+   *
+   * @category Projects & Datasets
+   */
   users: ObservableUsersClient;
+  /**
+   * Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+   *
+   * @category Agent Actions
+   */
   agent: {
+    /** Run individual Agent Action operations */
     action: ObservableAgentsActionClient;
   };
   collaboration: {
@@ -6033,20 +6160,31 @@ declare class ObservableSanityClient$1 {
     comments: ObservableCollaborationCommentsClient;
   };
   functions: ObservableFunctionsClient;
+  /**
+   * Create and manage content releases and their scheduled publishing
+   *
+   * @category Releases
+   */
   releases: ObservableReleasesClient;
   /** @beta */
   context: ObservableContextClient;
   /**
-   * Instance properties
+   * Listen to document changes matching a GROQ query, delivered as server-sent events
+   *
+   * @category Real-time
    */
   listen: typeof _listen;
   constructor(httpRequest: HttpRequest, config?: ClientConfig$1);
   /**
    * Clone the client - returns a new instance
+   *
+   * @category Configuration
    */
   clone(): ObservableSanityClient$1;
   /**
    * Returns the current client configuration
+   *
+   * @category Configuration
    */
   config(): InitializedClientConfig$1;
   /**
@@ -6056,12 +6194,16 @@ declare class ObservableSanityClient$1 {
   /**
    * Clone the client with a new (partial) configuration.
    *
+   * @category Configuration
+   *
    * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig$1>): ObservableSanityClient$1;
   /**
    * Perform a GROQ-query against the configured dataset.
    *
+   * @category Querying
+   *
    * @param query - GROQ-query to perform
    */
   fetch<R = Any$1, Q extends QueryWithoutParams = QueryWithoutParams, const G extends string = string>(query: G, params?: Q | QueryWithoutParams): Observable<ClientReturn$1<G, R>>;
@@ -6092,6 +6234,8 @@ declare class ObservableSanityClient$1 {
   /**
    * Fetch a single document with the given ID.
    *
+   * @category Querying
+   *
    * @param id - Document ID to fetch
    * @param options - Request options
    */
@@ -6119,6 +6263,8 @@ declare class ObservableSanityClient$1 {
    * The order/position of documents is preserved based on the original array of IDs.
    * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to fetch
    * @param options - Request options
    */
@@ -6129,6 +6275,8 @@ declare class ObservableSanityClient$1 {
    * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
    * Returns a set of the IDs that exist.
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to check
    * @param options - Request options
    */
@@ -6140,6 +6288,8 @@ declare class ObservableSanityClient$1 {
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6180,6 +6330,8 @@ declare class ObservableSanityClient$1 {
    * Create a document if no document with the same ID already exists.
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6220,6 +6372,8 @@ declare class ObservableSanityClient$1 {
    * Create a document if it does not exist, or replace a document with the same document ID
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to either create or replace
    * @param options - Mutation options
    */
@@ -6344,6 +6498,8 @@ declare class ObservableSanityClient$1 {
    * Deletes a document with the given document ID.
    * Returns an observable that resolves to the deleted document.
    *
+   * @category Mutations
+   *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
@@ -6429,6 +6585,8 @@ declare class ObservableSanityClient$1 {
    * * Discarding a version with no `releaseId` will discard the draft version of the published document.
    * * If the draft or release version does not exist, any error will throw.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to discard the document from.
    *   - `publishedId` - The published ID of the document to discard.
@@ -6464,6 +6622,8 @@ declare class ObservableSanityClient$1 {
    * * Replacing a version with no `releaseId` will replace the draft version of the published document.
    * * At least one of the **version** or **published** documents must exist.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `document` - The new document to replace the version with.
    *   - `releaseId` - The ID of the release where the document version is replaced.
@@ -6536,6 +6696,8 @@ declare class ObservableSanityClient$1 {
    * @remarks
    * * If the published document does not exist, an error will be thrown.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to unpublish the document from.
    *   - `publishedId` - The published ID of the document to unpublish.
@@ -6556,6 +6718,8 @@ declare class ObservableSanityClient$1 {
    * Perform mutation operations against the configured dataset
    * Returns an observable that resolves to the first mutated document.
    *
+   * @category Mutations
+   *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
    */
@@ -6595,6 +6759,8 @@ declare class ObservableSanityClient$1 {
   /**
    * Create a new buildable patch of operations to perform
    *
+   * @category Mutations
+   *
    * @param documentId - Document ID to patch
    * @param operations - Optional object of patch operations to initialize the patch instance with
    * @returns Patch instance - call `.commit()` to perform the operations defined
@@ -6619,12 +6785,16 @@ declare class ObservableSanityClient$1 {
   /**
    * Create a new transaction of mutations
    *
+   * @category Mutations
+   *
    * @param operations - Optional array of mutation operations to initialize the transaction instance with
    */
   transaction<R extends Record<string, Any$1> = Record<string, Any$1>>(operations?: Mutation<R>[]): ObservableTransaction;
   /**
    * Perform action operations against the configured dataset
    *
+   * @category Mutations
+   *
    * @param operations - Action operation(s) to execute
    * @param options - Action options
    */
@@ -6632,12 +6802,16 @@ declare class ObservableSanityClient$1 {
   /**
    * Perform an HTTP request against the Sanity API
    *
+   * @category HTTP
+   *
    * @param options - Request options
    */
   request<R = Any$1>(options: RawRequestOptions): Observable<R>;
   /**
    * Get a Sanity API URL for the URI provided
    *
+   * @category HTTP
+   *
    * @param uri - URI/path to build URL for
    * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
@@ -6645,6 +6819,8 @@ declare class ObservableSanityClient$1 {
   /**
    * Get a Sanity API URL for the data operation and path provided
    *
+   * @category HTTP
+   *
    * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
    * @param path - Path to append after the operation
    */
@@ -6653,15 +6829,52 @@ declare class ObservableSanityClient$1 {
 /** @public */
 declare class SanityClient$1 {
   #private;
+  /**
+   * Upload, fetch and delete assets (images and files) in the configured dataset
+   *
+   * @category Assets
+   */
   assets: AssetsClient;
+  /**
+   * Create, list, edit and delete datasets in the configured project
+   *
+   * @category Projects & Datasets
+   */
   datasets: DatasetsClient;
+  /**
+   * Subscribe to live content updates through the Live Content API
+   *
+   * @category Real-time
+   */
   live: LiveClient;
+  /**
+   * Interact with Media Library assets
+   *
+   * @category Assets
+   */
   mediaLibrary: {
+    /** Upload and manage Media Library video assets */
     video: MediaLibraryVideoClient;
   };
+  /**
+   * Fetch information about the projects the authenticated user has access to
+   *
+   * @category Projects & Datasets
+   */
   projects: ProjectsClient;
+  /**
+   * Fetch information about users in the configured project
+   *
+   * @category Projects & Datasets
+   */
   users: UsersClient;
+  /**
+   * Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+   *
+   * @category Agent Actions
+   */
   agent: {
+    /** Run individual Agent Action operations */
     action: AgentActionsClient;
   };
   collaboration: {
@@ -6669,24 +6882,37 @@ declare class SanityClient$1 {
     comments: CollaborationCommentsClient;
   };
   functions: FunctionsClient;
+  /**
+   * Create and manage content releases and their scheduled publishing
+   *
+   * @category Releases
+   */
   releases: ReleasesClient;
   /** @beta */
   context: ContextClient;
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
+   *
+   * @category Configuration
    */
   observable: ObservableSanityClient$1;
   /**
-   * Instance properties
+   * Listen to document changes matching a GROQ query, delivered as server-sent events
+   *
+   * @category Real-time
    */
   listen: typeof _listen;
   constructor(httpRequest: HttpRequest, config?: ClientConfig$1);
   /**
    * Clone the client - returns a new instance
+   *
+   * @category Configuration
    */
   clone(): SanityClient$1;
   /**
    * Returns the current client configuration
+   *
+   * @category Configuration
    */
   config(): InitializedClientConfig$1;
   /**
@@ -6696,12 +6922,16 @@ declare class SanityClient$1 {
   /**
    * Clone the client with a new (partial) configuration.
    *
+   * @category Configuration
+   *
    * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig$1>): SanityClient$1;
   /**
    * Perform a GROQ-query against the configured dataset.
    *
+   * @category Querying
+   *
    * @param query - GROQ-query to perform
    */
   fetch<R = Any$1, Q extends QueryWithoutParams = QueryWithoutParams, const G extends string = string>(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn$1<G, R>>;
@@ -6732,6 +6962,8 @@ declare class SanityClient$1 {
   /**
    * Fetch a single document with the given ID.
    *
+   * @category Querying
+   *
    * @param id - Document ID to fetch
    * @param options - Request options
    */
@@ -6759,6 +6991,8 @@ declare class SanityClient$1 {
    * The order/position of documents is preserved based on the original array of IDs.
    * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to fetch
    * @param options - Request options
    */
@@ -6770,6 +7004,8 @@ declare class SanityClient$1 {
    * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
    * Returns a set of the IDs that exist.
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to check
    * @param options - Request options
    */
@@ -6781,6 +7017,8 @@ declare class SanityClient$1 {
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6821,6 +7059,8 @@ declare class SanityClient$1 {
    * Create a document if no document with the same ID already exists.
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6861,6 +7101,8 @@ declare class SanityClient$1 {
    * Create a document if it does not exist, or replace a document with the same document ID
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to either create or replace
    * @param options - Mutation options
    */
@@ -6973,6 +7215,8 @@ declare class SanityClient$1 {
    * Deletes a document with the given document ID.
    * Returns a promise that resolves to the deleted document.
    *
+   * @category Mutations
+   *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
@@ -7058,6 +7302,8 @@ declare class SanityClient$1 {
    * * Discarding a version with no `releaseId` will discard the draft version of the published document.
    * * If the draft or release version does not exist, any error will throw.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to discard the document from.
    *   - `publishedId` - The published ID of the document to discard.
@@ -7093,6 +7339,8 @@ declare class SanityClient$1 {
    * * Replacing a version with no `releaseId` will replace the draft version of the published document.
    * * At least one of the **version** or **published** documents must exist.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `document` - The new document to replace the version with.
    *   - `releaseId` - The ID of the release where the document version is replaced.
@@ -7165,6 +7413,8 @@ declare class SanityClient$1 {
    * @remarks
    * * If the published document does not exist, an error will be thrown.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to unpublish the document from.
    *   - `publishedId` - The published ID of the document to unpublish.
@@ -7185,6 +7435,8 @@ declare class SanityClient$1 {
    * Perform mutation operations against the configured dataset
    * Returns a promise that resolves to the first mutated document.
    *
+   * @category Mutations
+   *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
    */
@@ -7224,6 +7476,8 @@ declare class SanityClient$1 {
   /**
    * Create a new buildable patch of operations to perform
    *
+   * @category Mutations
+   *
    * @param documentId - Document ID to patch
    * @param operations - Optional object of patch operations to initialize the patch instance with
    * @returns Patch instance - call `.commit()` to perform the operations defined
@@ -7248,6 +7502,8 @@ declare class SanityClient$1 {
   /**
    * Create a new transaction of mutations
    *
+   * @category Mutations
+   *
    * @param operations - Optional array of mutation operations to initialize the transaction instance with
    */
   transaction<R extends Record<string, Any$1> = Record<string, Any$1>>(operations?: Mutation<R>[]): Transaction;
@@ -7255,6 +7511,8 @@ declare class SanityClient$1 {
    * Perform action operations against the configured dataset
    * Returns a promise that resolves to the transaction result
    *
+   * @category Mutations
+   *
    * @param operations - Action operation(s) to execute
    * @param options - Action options
    */
@@ -7263,6 +7521,8 @@ declare class SanityClient$1 {
    * Perform a request against the Sanity API
    * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
    *
+   * @category HTTP
+   *
    * @param options - Request options
    * @returns Promise resolving to the response body
    */
@@ -7281,6 +7541,8 @@ declare class SanityClient$1 {
   /**
    * Get a Sanity API URL for the URI provided
    *
+   * @category HTTP
+   *
    * @param uri - URI/path to build URL for
    * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
@@ -7288,6 +7550,8 @@ declare class SanityClient$1 {
   /**
    * Get a Sanity API URL for the data operation and path provided
    *
+   * @category HTTP
+   *
    * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
    * @param path - Path to append after the operation
    */
@@ -8086,7 +8350,7 @@ type DatasetAclMode = 'public' | 'private' | 'custom';
 /** @public */
 type DatasetCreateOptions = {
   aclMode?: DatasetAclMode;
-  description?: string;
+  description?: string | null;
   embeddings?: {
     enabled: boolean;
     projection?: string;
@@ -8095,7 +8359,7 @@ type DatasetCreateOptions = {
 /** @public */
 type DatasetEditOptions = {
   aclMode?: DatasetAclMode;
-  description?: string;
+  description?: string | null;
 };
 /** @public */
 type EmbeddingsSettings = {
@@ -8112,13 +8376,13 @@ type EmbeddingsSettingsBody = {
 type DatasetResponse = {
   datasetName: string;
   aclMode: DatasetAclMode;
-  description: string;
+  description: string | null;
 };
 /** @public */
 type DatasetsResponse = {
   name: string;
   aclMode: DatasetAclMode;
-  description: string;
+  description?: string;
   createdAt: string;
   createdByUserId: string;
   addonFor: string | null;
@@ -9494,8 +9758,46 @@ interface LiveEventGoAway {
 }
 /** @public */
 type LiveEvent = LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway;
-/** @public */
-interface SanityQueries {}
+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 {}
+}
+/**
+ * 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
+ */
+interface SanityQueries extends globalThis.SanityQueries {}
 /** @public */
 type ClientReturn$1<GroqString extends string, Fallback = Any$1> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback;
 /**
@@ -9714,4 +10016,4 @@ interface MediaLibraryAssetDocument {
   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-DiPF0ENT.d.ts.map
+//# sourceMappingURL=types-B1XLvey7.d.ts.map