@sanity/client 7.5.0 → 7.7.0

package/dist/index.browser.d.cts

@@ -698,6 +698,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
@@ -1274,6 +1298,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'
+
 /**
  *
  *
@@ -1689,6 +1733,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>
@@ -1711,7 +1774,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.
@@ -1722,7 +1785,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 {
@@ -1773,6 +1861,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
 
@@ -5553,6 +5650,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/index.browser.d.ts

@@ -698,6 +698,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
@@ -1274,6 +1298,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'
+
 /**
  *
  *
@@ -1689,6 +1733,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>
@@ -1711,7 +1774,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.
@@ -1722,7 +1785,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 {
@@ -1773,6 +1861,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
 
@@ -5553,6 +5650,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/index.browser.js

@@ -75,6 +75,12 @@ function columnToLine(column, lines) {
   };
 }
 const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
+function isHttpError(error) {
+  if (!isRecord(error))
+    return !1;
+  const response = error.response;
+  return !(typeof error.statusCode != "number" || typeof error.message != "string" || !isRecord(response) || typeof response.body > "u" || typeof response.url != "string" || typeof response.method != "string" || typeof response.headers != "object" || typeof response.statusCode != "number");
+}
 class ClientError extends Error {
   response;
   statusCode = 400;
@@ -175,22 +181,22 @@ const httpError = {
     return res;
   }
 };
-function printWarnings() {
-  const seen = {};
+function printWarnings(config = {}) {
+  const seen = {}, shouldIgnoreWarning = (message) => config.ignoreWarnings === void 0 ? !1 : (Array.isArray(config.ignoreWarnings) ? config.ignoreWarnings : [config.ignoreWarnings]).some((pattern) => typeof pattern == "string" ? message.includes(pattern) : pattern instanceof RegExp ? pattern.test(message) : !1);
   return {
     onResponse: (res) => {
       const warn = res.headers["x-sanity-warning"], warnings = Array.isArray(warn) ? warn : [warn];
       for (const msg of warnings)
-        !msg || seen[msg] || (seen[msg] = !0, console.warn(msg));
+        !msg || seen[msg] || shouldIgnoreWarning(msg) || (seen[msg] = !0, console.warn(msg));
       return res;
     }
   };
 }
-function defineHttpRequest(envMiddleware2) {
+function defineHttpRequest(envMiddleware2, config = {}) {
   return getIt([
     retry({ shouldRetry }),
     ...envMiddleware2,
-    printWarnings(),
+    printWarnings(config),
     jsonRequest(),
     jsonResponse(),
     progress(),
@@ -280,7 +286,7 @@ const VALID_ASSET_TYPES = ["image", "file"], VALID_INSERT_LOCATIONS = ["before",
 }, resourceGuard = (service, config) => {
   if (config["~experimental_resource"])
     throw new Error(`\`${service}\` does not support resource-based operations`);
-};
+}, EXPERIMENTAL_API_WARNING = "This is an experimental API version";
 function once(fn) {
   let didCall = !1, returnValue;
   return (...args) => (didCall || (returnValue = fn(...args), didCall = !0), returnValue);
@@ -2661,7 +2667,9 @@ class SanityClient {
 }
 function defineCreateClientExports(envMiddleware2, ClassConstructor) {
   return { requester: defineHttpRequest(envMiddleware2), createClient: (config) => {
-    const clientRequester = defineHttpRequest(envMiddleware2);
+    const clientRequester = defineHttpRequest(envMiddleware2, {
+      ignoreWarnings: config.ignoreWarnings
+    });
     return new ClassConstructor(
       (options, requester2) => (requester2 || clientRequester)({
         maxRedirects: 0,
@@ -2688,6 +2696,7 @@ export {
   ConnectionFailedError,
   CorsOriginError,
   DisconnectError,
+  EXPERIMENTAL_API_WARNING,
   MessageError,
   MessageParseError,
   ObservablePatch,
@@ -2701,6 +2710,7 @@ export {
   createClient,
   deprecatedCreateClient as default,
   formatQueryParseError,
+  isHttpError,
   isQueryParseError,
   requester,
   adapter as unstable__adapter,