@sanity/client 7.5.0 → 7.7.0

package/dist/stega.browser.d.cts

@@ -692,6 +692,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -1385,6 +1409,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1849,6 +1893,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1871,7 +1934,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1945,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -1943,6 +2031,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -5811,6 +5908,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.browser.d.ts

@@ -692,6 +692,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -1385,6 +1409,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1849,6 +1893,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1871,7 +1934,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1945,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -1943,6 +2031,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -5811,6 +5908,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.d.cts

@@ -692,6 +692,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -1385,6 +1409,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1849,6 +1893,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1871,7 +1934,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1945,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -1943,6 +2031,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -5811,6 +5908,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/dist/stega.d.ts

@@ -692,6 +692,30 @@ export declare interface ClientConfig {
    */
   headers?: Record<string, string>
   ignoreBrowserTokenWarning?: boolean
+  /**
+   * Ignore specific warning messages from the client.
+   *
+   * @remarks
+   * - String values perform substring matching (not exact matching) against warning messages
+   * - RegExp values are tested against the full warning message
+   * - Array values allow multiple patterns to be specified
+   *
+   * @example
+   * ```typescript
+   * // Ignore warnings containing "experimental"
+   * ignoreWarnings: 'experimental'
+   *
+   * // Ignore multiple warning types
+   * ignoreWarnings: ['experimental', 'deprecated']
+   *
+   * // Use regex for exact matching
+   * ignoreWarnings: /^This is an experimental API version$/
+   *
+   * // Mix strings and regex patterns
+   * ignoreWarnings: ['rate limit', /^deprecated/i]
+   * ```
+   */
+  ignoreWarnings?: string | RegExp | Array<string | RegExp>
   withCredentials?: boolean
   allowReconfigure?: boolean
   timeout?: number
@@ -1385,6 +1409,26 @@ export declare type EventSourceEvent<Name extends string> = ServerSentEvent<Name
  */
 export declare type EventSourceInstance = InstanceType<typeof globalThis.EventSource>
 
+/**
+ * A string constant containing the experimental API version warning message.
+ * Use this with the `ignoreWarnings` option to suppress warnings when using experimental API versions.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, EXPERIMENTAL_API_WARNING } from '@sanity/client'
+ *
+ * const client = createClient({
+ *   projectId: 'your-project-id',
+ *   dataset: 'production',
+ *   apiVersion: 'vX', // experimental version
+ *   ignoreWarnings: EXPERIMENTAL_API_WARNING
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare const EXPERIMENTAL_API_WARNING = 'This is an experimental API version'
+
 /**
  *
  *
@@ -1849,6 +1893,25 @@ export declare interface GroqAgentActionParam {
   params?: Record<string, string>
 }
 
+/**
+ * Shared properties for HTTP errors (eg both ClientError and ServerError)
+ * Use `isHttpError` for type narrowing and accessing response properties.
+ *
+ * @public
+ */
+export declare interface HttpError {
+  statusCode: number
+  message: string
+  response: {
+    body: unknown
+    url: string
+    method: string
+    headers: Record<string, string>
+    statusCode: number
+    statusMessage: string | null
+  }
+}
+
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1871,7 +1934,7 @@ export declare type IdentifiedSanityDocumentStub<
  * @see #TransformOperation
  * @beta
  */
-export declare interface ImageDescriptionOperation {
+export declare type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -1882,7 +1945,32 @@ export declare interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
@@ -1943,6 +2031,15 @@ export declare type InsertPatch =
       items: Any[]
     }
 
+/**
+ * Checks if the provided error is an HTTP error.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is an HTTP error, `false` otherwise.
+ * @public
+ */
+export declare function isHttpError(error: unknown): error is HttpError
+
 /** @internal */
 export declare function isQueryParseError(error: object): error is QueryParseError
 
@@ -5811,6 +5908,11 @@ declare type TransformDocumentSync<T extends Record<string, Any> = Record<string
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export declare type TransformOperation = 'set' | ImageDescriptionOperation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "7.5.0",
+  "version": "7.7.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/agent/actions/transform.ts

@@ -180,7 +180,7 @@ export type TransformTargetDocument =
  * @see #TransformOperation
  * @beta
  */
-export interface ImageDescriptionOperation {
+export type ImageDescriptionOperation = {
   type: 'image-description'
   /**
    * When omitted, parent image value will be inferred from the arget path.
@@ -191,7 +191,32 @@ export interface ImageDescriptionOperation {
    * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
    */
   sourcePath?: AgentActionPath
-}
+} & (
+  | {
+      /**
+       * When omitted, parent image value will be inferred from the target path.
+       *
+       * When specified, the `sourcePath` should be a path to an image (or image asset) field:
+       * - `['image']`
+       * - `['wrapper', 'mainImage']`
+       * - `['heroImage', 'asset'] // the asset segment is optional, but supported`
+       *
+       * Incompatible with `imageUrl`
+       *
+       */
+      sourcePath?: AgentActionPath
+      imageUrl?: never
+    }
+  | {
+      /**
+       * When specified, the image source to be described will be fetched from the URL.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+      sourcePath?: never
+    }
+)
 
 /**
  *
@@ -222,6 +247,11 @@ export interface ImageDescriptionOperation {
  * - `target: {path: ['wrapper', 'title'], operation: {type: 'image-description', sourcePath: ['array', {_key: 'abc'}, 'image'] }`
  * - `target: {path: ['wrapper'], include: ['portableTextField'], operation: {type: 'image-description', sourcePath: ['image', 'asset'] }, instruction: 'Use formatting and headings to describe the image in great detail' }`
  *
+ * ### Targeting images outside the document (URL)
+ * If the source image is available on a https URL outside the target document, it is possible to get a description for it using `imageUrl`.
+ *
+ * Example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', imageUrL: 'https://www.sanity.io/static/images/favicons/android-icon-192x192.png?v=2' }`
  * @beta
  */
 export type TransformOperation = 'set' | ImageDescriptionOperation

package/src/defineCreateClient.ts

@@ -21,6 +21,8 @@ export {
   ClientError,
   CorsOriginError,
   formatQueryParseError,
+  type HttpError,
+  isHttpError,
   isQueryParseError,
   ServerError,
 } from './http/errors'
@@ -45,7 +47,9 @@ export default function defineCreateClientExports<
   const defaultRequester = defineHttpRequest(envMiddleware)
 
   const createClient = (config: ClientConfigType) => {
-    const clientRequester = defineHttpRequest(envMiddleware)
+    const clientRequester = defineHttpRequest(envMiddleware, {
+      ignoreWarnings: config.ignoreWarnings,
+    })
     return new ClassConstructor(
       (options, requester) =>
         (requester || clientRequester)({