@sanity/client 7.4.1 → 7.5.0-agent-actions.0

package/dist/index.browser.d.cts

@@ -1706,6 +1706,47 @@ export declare type IdentifiedSanityDocumentStub<
   _id: string
 } & SanityDocumentStub
 
+/**
+ *
+ * @see #TransformOperation
+ * @beta
+ */
+export declare type ImageDescriptionOperation = {
+  type: 'image-description'
+  /**
+   * When omitted, parent image value will be inferred from the arget 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`
+   */
+  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
+    }
+  | {
+      /**
+       * When specified, the image source for the description will be fetched from the URL over https.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+    }
+)
+
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
@@ -5506,6 +5547,39 @@ declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
 declare type TransformDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
   TransformRequestBase & AgentActionSync
 
+/**
+ *
+ * ## `set` by default
+ * By default, Transform will change the value of every target field in place using a set operation.
+ *
+ * ## Image description
+ *
+ * ### Targeting image fields
+ * Images can be transformed to a textual description by targeting a `string`, `text` or Portable Text field (`array` with `block`)
+ * with `operation: {type: 'image-description'}`.
+ *
+ * Custom instructions for image description targets will be used to generate the description.
+ *
+ * Such targets must be a descendant field of an image object.
+ *
+ * For example:
+ * - `target: {path: ['image', 'description'], operation: {type: 'image-description'} }`
+ * - `target: {path: ['array', {_key: 'abc'}, 'alt'], operation: {type: 'image-description'} } //assuming the item in the array on the key-ed path is an image`
+ * - `target: {path: ['image'], include: ['portableTextField'], operation: {type: 'image-description'}, instruction: 'Use formatting and headings to describe the image in great detail' }`
+ *
+ * ### Targeting non-image fields
+ * If the target image description lives outside an image object, use the `sourcePath` option to specify the path to the image field.
+ * `sourcePath` must be an image or image asset field.
+ *
+ * For example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', sourcePath: ['image', 'asset'] }`
+ * - `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' }`
+ *
+ * @beta
+ */
+export declare type TransformOperation = 'set' | ImageDescriptionOperation
+
 /** @beta */
 declare interface TransformRequestBase extends AgentActionRequestBase {
   /** schemaId as reported by sanity deploy / sanity schema store */
@@ -5647,7 +5721,10 @@ declare interface TransformRequestBase extends AgentActionRequestBase {
   target?: TransformTarget | TransformTarget[]
 }
 
-/**  @beta */
+/**
+ * @see #TransformOperation
+ * @beta
+ * */
 export declare interface TransformTarget extends AgentActionTarget {
   /**
    * Specifies a tailored instruction of this target.
@@ -5663,6 +5740,11 @@ export declare interface TransformTarget extends AgentActionTarget {
    * Fields or array items not on the include list, are implicitly excluded.
    */
   include?: (AgentActionPathSegment | TransformTargetInclude)[]
+  /**
+   * Default: `set`
+   * @see #TransformOperation
+   */
+  operation?: TransformOperation
 }
 
 /**
@@ -5688,7 +5770,10 @@ export declare type TransformTargetDocument =
       _id: string
     }
 
-/**  @beta */
+/**
+ * @see #TransformOperation
+ * @beta
+ * */
 export declare interface TransformTargetInclude extends AgentActionTargetInclude {
   /**
    * Specifies a tailored instruction of this target.
@@ -5703,6 +5788,11 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
    * Fields or array items not on the include list, are implicitly excluded.
    */
   include?: (AgentActionPathSegment | TransformTargetInclude)[]
+  /**
+   * Default: `set`
+   * @see #TransformOperation
+   */
+  operation?: TransformOperation
 }
 
 /** @beta */

package/dist/index.browser.d.ts

@@ -1706,6 +1706,47 @@ export declare type IdentifiedSanityDocumentStub<
   _id: string
 } & SanityDocumentStub
 
+/**
+ *
+ * @see #TransformOperation
+ * @beta
+ */
+export declare type ImageDescriptionOperation = {
+  type: 'image-description'
+  /**
+   * When omitted, parent image value will be inferred from the arget 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`
+   */
+  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
+    }
+  | {
+      /**
+       * When specified, the image source for the description will be fetched from the URL over https.
+       *
+       * Incompatible with `sourcePath`
+       */
+      imageUrl?: `https://${string}`
+    }
+)
+
 /** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
@@ -5506,6 +5547,39 @@ declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
 declare type TransformDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
   TransformRequestBase & AgentActionSync
 
+/**
+ *
+ * ## `set` by default
+ * By default, Transform will change the value of every target field in place using a set operation.
+ *
+ * ## Image description
+ *
+ * ### Targeting image fields
+ * Images can be transformed to a textual description by targeting a `string`, `text` or Portable Text field (`array` with `block`)
+ * with `operation: {type: 'image-description'}`.
+ *
+ * Custom instructions for image description targets will be used to generate the description.
+ *
+ * Such targets must be a descendant field of an image object.
+ *
+ * For example:
+ * - `target: {path: ['image', 'description'], operation: {type: 'image-description'} }`
+ * - `target: {path: ['array', {_key: 'abc'}, 'alt'], operation: {type: 'image-description'} } //assuming the item in the array on the key-ed path is an image`
+ * - `target: {path: ['image'], include: ['portableTextField'], operation: {type: 'image-description'}, instruction: 'Use formatting and headings to describe the image in great detail' }`
+ *
+ * ### Targeting non-image fields
+ * If the target image description lives outside an image object, use the `sourcePath` option to specify the path to the image field.
+ * `sourcePath` must be an image or image asset field.
+ *
+ * For example:
+ * - `target: {path: ['description'], operation: operation: {type: 'image-description', sourcePath: ['image', 'asset'] }`
+ * - `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' }`
+ *
+ * @beta
+ */
+export declare type TransformOperation = 'set' | ImageDescriptionOperation
+
 /** @beta */
 declare interface TransformRequestBase extends AgentActionRequestBase {
   /** schemaId as reported by sanity deploy / sanity schema store */
@@ -5647,7 +5721,10 @@ declare interface TransformRequestBase extends AgentActionRequestBase {
   target?: TransformTarget | TransformTarget[]
 }
 
-/**  @beta */
+/**
+ * @see #TransformOperation
+ * @beta
+ * */
 export declare interface TransformTarget extends AgentActionTarget {
   /**
    * Specifies a tailored instruction of this target.
@@ -5663,6 +5740,11 @@ export declare interface TransformTarget extends AgentActionTarget {
    * Fields or array items not on the include list, are implicitly excluded.
    */
   include?: (AgentActionPathSegment | TransformTargetInclude)[]
+  /**
+   * Default: `set`
+   * @see #TransformOperation
+   */
+  operation?: TransformOperation
 }
 
 /**
@@ -5688,7 +5770,10 @@ export declare type TransformTargetDocument =
       _id: string
     }
 
-/**  @beta */
+/**
+ * @see #TransformOperation
+ * @beta
+ * */
 export declare interface TransformTargetInclude extends AgentActionTargetInclude {
   /**
    * Specifies a tailored instruction of this target.
@@ -5703,6 +5788,11 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
    * Fields or array items not on the include list, are implicitly excluded.
    */
   include?: (AgentActionPathSegment | TransformTargetInclude)[]
+  /**
+   * Default: `set`
+   * @see #TransformOperation
+   */
+  operation?: TransformOperation
 }
 
 /** @beta */