@sanity/assist 5.0.4 → 6.0.0

package/dist/index.d.ts

@@ -1,29 +1,10 @@
-import {AgentActionPath} from '@sanity/client/stega'
-import {CurrentUser} from 'sanity'
-import {DocumentFieldActionDivider} from 'sanity'
-import {DocumentFieldActionGroup} from 'sanity'
-import {DocumentFieldActionItem} from 'sanity'
-import {JSX} from 'react/jsx-runtime'
-import {ObjectSchemaType} from 'sanity'
-import {Path} from 'sanity'
-import {Plugin as Plugin_2} from 'sanity'
-import {PortableTextBlock} from '@portabletext/types'
-import {PortableTextMarkDefinition} from '@portabletext/types'
-import {PortableTextSpan} from '@portabletext/types'
-import {SanityClient} from 'sanity'
-import type {SanityClient as SanityClient_2} from '@sanity/client'
-import {SanityDocumentLike} from 'sanity'
-import {SchemaType} from 'sanity'
-
-declare interface AgentActionConditionalPath {
-  path: AgentActionPath
-  readOnly: boolean
-  hidden: boolean
-}
-
-export declare const assist: Plugin_2<void | AssistPluginConfig>
-
-export declare interface AssistConfig {
+import * as sanity from "sanity";
+import { CurrentUser, DocumentFieldActionDivider, DocumentFieldActionGroup, DocumentFieldActionItem, ObjectSchemaType, Path, SanityClient, SanityDocumentLike, SchemaType } from "sanity";
+import { SanityClient as SanityClient$1 } from "@sanity/client";
+import { AgentActionPath } from "@sanity/client/stega";
+import { PortableTextBlock, PortableTextMarkDefinition, PortableTextSpan } from "@portabletext/types";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+interface AssistConfig {
   /**
    * As of v3.0 Assist can write to date and datetime fields.
    *
@@ -41,7 +22,7 @@ export declare interface AssistConfig {
    * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
    * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    */
-  localeSettings?: (context: LocaleSettingsContext) => LocaleSettings
+  localeSettings?: (context: LocaleSettingsContext) => LocaleSettings;
   /**
    * The max depth for document paths AI Assist will write to.
    *
@@ -57,7 +38,7 @@ export declare interface AssistConfig {
    *
    * Default: 4
    */
-  maxPathDepth?: number
+  maxPathDepth?: number;
   /**
    * Influences how much the output of an instruction will vary.
    *
@@ -70,38 +51,46 @@ export declare interface AssistConfig {
    *
    * Default: 0.3
    */
-  temperature?: number
+  temperature?: number;
+}
+interface LocaleSettingsContext {
+  user: CurrentUser;
+  defaultSettings: LocaleSettings;
 }
-
-export declare type AssistFieldActionGroup = Omit<
-  DocumentFieldActionGroup,
-  'renderAsButton' | 'expanded' | 'children'
-> & {
+interface LocaleSettings {
   /**
-   * `children` can include undefined entries in the action array. These will be filtered out.
-   * If the group has no defined children, the group will also be filtered out.
+   * A valid Unicode BCP 47 locale identifier used to interpret and format
+   * natural language inputs and date output. Examples include "en-US", "fr-FR", or "ja-JP".
+   *
+   * This affects how phrases like "next Friday" or "in two weeks" are parsed,
+   * and how resulting dates are presented (e.g., 12-hour vs 24-hour format).
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
+   */
+  locale: string;
+  /**
+   * A valid IANA time zone identifier used to resolve relative and absolute
+   * date expressions to a specific point in time. Examples include
+   * "America/New_York", "Europe/Paris", or "Asia/Tokyo".
+   *
+   * This ensures phrases like "tomorrow at 9am" are interpreted correctly
+   * based on the user's local time.
+   *
+   * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    */
-  children: (AssistFieldActionNode | undefined)[]
+  timeZone: string;
 }
-
-export declare type AssistFieldActionItem = Omit<
-  DocumentFieldActionItem,
-  'renderAsButton' | 'selected' | 'onAction'
-> & {
-  onAction: () => void | Promise<void>
+interface AgentActionConditionalPath {
+  path: AgentActionPath;
+  readOnly: boolean;
+  hidden: boolean;
 }
-
-export declare type AssistFieldActionNode =
-  | AssistFieldActionItem
-  | AssistFieldActionGroup
-  | DocumentFieldActionDivider
-
-export declare interface AssistFieldActionProps {
+interface AssistFieldActionProps {
   /**
    * `actionType` will be `document` for action invoked from the top right document action menu, and
    * `field` when invoked from a field action menu.
    */
-  actionType: 'document' | 'field'
+  actionType: 'document' | 'field';
   /**
    * This is the id of the current document pane; it contains `drafts.`or `versions. prefix` ect depending on context.
    * Use this for `documentId` when calling any `client.agent.action`.
@@ -119,25 +108,25 @@ export declare interface AssistFieldActionProps {
    * })
    * ```
    */
-  documentIdForAction: string
+  documentIdForAction: string;
   /**
    * Schema type of the current document.
    * @see documentIdForAction
    */
-  documentSchemaType: ObjectSchemaType
+  documentSchemaType: ObjectSchemaType;
   /**
    * Returns the current document value.
    *
    * Prefer passing this function to your hooks instead of passing the document value directly to avoid unnecessary re-renders.
    * @see documentIdForAction
    */
-  getDocumentValue: () => SanityDocumentLike
+  getDocumentValue: () => SanityDocumentLike;
   /**
    * Returns the current readOnly and hidden state of all conditional members in the current document form.
    *
    * Intended to be passed to agent actions `conditionalPaths.paths`.
    */
-  getConditionalPaths: () => AgentActionConditionalPath[]
+  getConditionalPaths: () => AgentActionConditionalPath[];
   /**
    * `schemaId` for the current workspace.
    *
@@ -159,7 +148,7 @@ export declare interface AssistFieldActionProps {
    *
    * ```
    */
-  schemaId: string
+  schemaId: string;
   /**
    * This is the schema type of the field the actions will be attached to (ie, schemaType for `path`)
    *
@@ -180,7 +169,7 @@ export declare interface AssistFieldActionProps {
    * })
    * ```
    */
-  path: AgentActionPath
+  path: AgentActionPath;
   /**
    * This is the schema type of the field the actions will be attached to (ie, schemaType for `path`).
    *
@@ -205,7 +194,7 @@ export declare interface AssistFieldActionProps {
    *
    * ```
    */
-  schemaType: SchemaType
+  schemaType: SchemaType;
   /**
    * Schema type of the parent field or array item holding this field.
    *
@@ -214,147 +203,46 @@ export declare interface AssistFieldActionProps {
    * @see schemaType
    * @see documentSchemaType
    */
-  parentSchemaType?: SchemaType
-}
-
-export declare interface AssistOptions {
-  aiAssist?: {
-    /** Set to true to disable assistance for this field or type */
-    exclude?: boolean
-    /**
-     * Set to true to add translation field-action to the field.
-     * Only has an effect in document types configured for document or field level translations.
-     */
-    translateAction?: boolean
-  }
-}
-
-declare interface AssistPluginConfig {
-  translate?: TranslationConfig
-  /**
-   * Config that affects all instructions
-   */
-  assist?: AssistConfig
-  fieldActions?: {
-    title?: string
-    /**
-     * The returned array can include `undefined` entries in the action array. These will be filtered out.
-     */
-    useFieldActions?: (props: AssistFieldActionProps) => (AssistFieldActionNode | undefined)[]
-  }
-  /**
-   * @internal
-   */
-  __customApiClient?: (defaultClient: SanityClient_2) => SanityClient_2
-  /**
-   * @internal
-   */
-  __presets?: Record<string, AssistPreset>
-}
-
-declare interface AssistPreset {
-  fields?: PresetField[]
-}
-
-declare interface ContextBlock {
-  _type: typeof instructionContextTypeName
-  reference?: {
-    _type: 'reference'
-    _ref?: string
-  }
+  parentSchemaType?: SchemaType;
 }
-
-export declare const contextDocumentTypeName: 'assist.instruction.context'
-
-/**
- *
- */
-export declare interface CustomInput {
+type AssistFieldActionNode = AssistFieldActionItem | AssistFieldActionGroup | DocumentFieldActionDivider;
+type AssistFieldActionItem = Omit<DocumentFieldActionItem, 'renderAsButton' | 'selected' | 'onAction'> & {
+  onAction: () => void | Promise<void>;
+};
+type AssistFieldActionGroup = Omit<DocumentFieldActionGroup, 'renderAsButton' | 'expanded' | 'children'> & {
   /**
-   * Id for the input
-   */
-  id: string
-  /**
-   * Title of the input field
-   */
-  title: string
-  /**
-   * Additional info that will be displayed over the input
-   */
-  description?: string
-}
-
-export declare type CustomInputResult = {
-  /**
-   * Identifies which custom input the `result`belongs to
-   */
-  input: CustomInput
-  /**
-   * The text provided by the user in the input
+   * `children` can include undefined entries in the action array. These will be filtered out.
+   * If the group has no defined children, the group will also be filtered out.
    */
-  result: string
+  children: (AssistFieldActionNode | undefined)[];
+};
+declare function defineAssistFieldAction(action: Omit<AssistFieldActionItem, 'type'>): AssistFieldActionItem;
+declare function defineFieldActionDivider(): DocumentFieldActionDivider;
+declare function defineAssistFieldActionGroup(group: Omit<AssistFieldActionGroup, 'type'>): AssistFieldActionGroup;
+interface Language {
+  id: string;
+  title?: string;
 }
-
-/**
- * Default implementation for plugin config `translate.field.translationOutputs`
- *
- * @see FieldTranslationConfig#translationOutputs
- */
-export declare const defaultLanguageOutputs: TranslationOutputsFunction
-
-export declare function defineAssistFieldAction(
-  action: Omit<AssistFieldActionItem, 'type'>,
-): AssistFieldActionItem
-
-export declare function defineAssistFieldActionGroup(
-  group: Omit<AssistFieldActionGroup, 'type'>,
-): AssistFieldActionGroup
-
-export declare function defineFieldActionDivider(): DocumentFieldActionDivider
-
-export declare interface DocumentMember {
-  schemaType: SchemaType
-  path: Path
-  name: string
-  value: unknown
+interface DocumentMember {
+  schemaType: SchemaType;
+  path: Path;
+  name: string;
+  value: unknown;
 }
-
-export declare interface DocumentTranslationConfig {
-  /**
-   * Path to language field in documents. Can be a hidden field.
-   * For instance: 'config.language'
-   *
-   * For projects that use the `@sanity/document-internationalization` plugin,
-   * this should be the same as `languageField` config for that plugin.
-   *
-   * Default: 'language'
-   */
-  languageField: string
-  /**
-   * `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
-   *
-   * If defined, this property will add a translate instruction to these document types.
-   * If undefined, the instruction will be added to all documents with aiAssistance enabled and a field matching `documentLanguageField` config.
-   *
-   * Documents with translation support will get a "Translate document>" instruction added.
-   **/
-  documentTypes?: string[]
-}
-
-declare interface FieldRef extends PortableTextMarkDefinition {
-  _type: typeof fieldReferenceTypeName
-  path?: string
+interface TranslationOutput {
+  /** Language id */
+  id: string;
+  outputPath: Path;
 }
-
-declare const fieldReferenceTypeName: 'sanity.assist.instruction.fieldRef'
-
-export declare interface FieldTranslationConfig {
+type TranslationOutputsFunction = (documentMember: DocumentMember, enclosingType: SchemaType, translateFromLanguageId: string, translateToLanguageIds: string[]) => TranslationOutput[] | undefined;
+type LanguageCallback = (client: SanityClient, selectedLanguageParams: Record<string, unknown>) => Promise<Language[]>;
+interface FieldTranslationConfig {
   /**
    * `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
    *
    * If defined, matching document will get a "Translate fields" instruction added.
    **/
-  documentTypes?: string[]
+  documentTypes?: string[];
   /**
    *
    * Used for display strings in the Studio, and to determine languages for field level translations
@@ -362,13 +250,13 @@ export declare interface FieldTranslationConfig {
    * If the studio is using the sanity-plugin-internationalized-array plugin, this
    * should be set to the same configuration.
    */
-  languages: Language[] | LanguageCallback
+  languages: Language[] | LanguageCallback;
   /**
    * API version for client passed to LanguageCallback for languages
    * https://www.sanity.io/docs/api-versioning
    * @defaultValue '2022-11-27'
    */
-  apiVersion?: string
+  apiVersion?: string;
   /**
    * Specify fields that should be available in the languages callback:
    * ```tsx
@@ -384,7 +272,7 @@ export declare interface FieldTranslationConfig {
    * If the studio is using the sanity-plugin-internationalized-array plugin, this
    * should be set to the same configuration.
    */
-  selectLanguageParams?: Record<string, string>
+  selectLanguageParams?: Record<string, string>;
   /**
    * `translationOutputs` is used when the "Translate fields" instruction is started by a Studio user.
    *
@@ -437,7 +325,7 @@ export declare interface FieldTranslationConfig {
    *
    * @see #maxPathDepth
    **/
-  translationOutputs?: TranslationOutputsFunction
+  translationOutputs?: TranslationOutputsFunction;
   /**
    * The max depth for document paths AI Assist will translate.
    *
@@ -450,139 +338,48 @@ export declare interface FieldTranslationConfig {
    *
    * Default: 6
    */
-  maxPathDepth?: number
-}
-
-export declare type GetUserInput = (args: {
-  /**
-   * Dialog title
-   */
-  title: string
-  /**
-   * One titled input per array item
-   */
-  inputs: CustomInput[]
-}) => Promise<CustomInputResult[] | undefined>
-
-declare type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock | ContextBlock
-
-declare const instructionContextTypeName: 'sanity.assist.instruction.context'
-
-/**
- * Returns true if the `schemaType` or any of its parent types (`schemaType.type`)` has `name` equal
- * to `typeName`.
- *
- * Useful for checking if `schemaType` is a type alias of `ìmage`, `code` or similar.
- */
-export declare function isType(schemaType: SchemaType, typeName: string): boolean
-
-export declare interface Language {
-  id: string
-  title?: string
+  maxPathDepth?: number;
 }
-
-export declare type LanguageCallback = (
-  client: SanityClient,
-  selectedLanguageParams: Record<string, unknown>,
-) => Promise<Language[]>
-
-export declare interface LocaleSettings {
+interface DocumentTranslationConfig {
   /**
-   * A valid Unicode BCP 47 locale identifier used to interpret and format
-   * natural language inputs and date output. Examples include "en-US", "fr-FR", or "ja-JP".
+   * Path to language field in documents. Can be a hidden field.
+   * For instance: 'config.language'
    *
-   * This affects how phrases like "next Friday" or "in two weeks" are parsed,
-   * and how resulting dates are presented (e.g., 12-hour vs 24-hour format).
+   * For projects that use the `@sanity/document-internationalization` plugin,
+   * this should be the same as `languageField` config for that plugin.
    *
-   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
+   * Default: 'language'
    */
-  locale: string
+  languageField: string;
   /**
-   * A valid IANA time zone identifier used to resolve relative and absolute
-   * date expressions to a specific point in time. Examples include
-   * "America/New_York", "Europe/Paris", or "Asia/Tokyo".
+   * `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
    *
-   * This ensures phrases like "tomorrow at 9am" are interpreted correctly
-   * based on the user's local time.
+   * If defined, this property will add a translate instruction to these document types.
+   * If undefined, the instruction will be added to all documents with aiAssistance enabled and a field matching `documentLanguageField` config.
    *
-   * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-   */
-  timeZone: string
-}
-
-export declare interface LocaleSettingsContext {
-  user: CurrentUser
-  defaultSettings: LocaleSettings
-}
-
-declare interface OutputFieldItem {
-  _type: typeof outputFieldTypeName
-  _key: string
-  relativePath?: string
-}
-
-declare const outputFieldTypeName: 'sanity.assist.output.field'
-
-declare interface OutputTypeItem {
-  _type: typeof outputTypeTypeName
-  _key: string
-  type?: string
-  relativePath?: string
-}
-
-declare const outputTypeTypeName: 'sanity.assist.output.type'
-
-declare interface PresetField {
-  path?: string
-  instructions?: PresetInstruction[]
-}
-
-declare interface PresetInstruction {
-  _key: string
-  prompt?: PromptTextBlock[]
-  title?: string
-  /**
-   * String key from `@sanity/icons` IconMap
-   */
-  icon?: string
-  /**
-   * Type/field filter
-   */
-  output?: (OutputFieldItem | OutputTypeItem)[]
-}
-
-declare type PromptTextBlock = Omit<
-  PortableTextBlock<never, InlinePromptBlock, 'normal', never>,
-  '_type'
-> & {
-  _type: 'block'
+   * Documents with translation support will get a "Translate document>" instruction added.
+   **/
+  documentTypes?: string[];
 }
-
-export declare function SchemaTypeTool(): JSX.Element
-
-export declare type TranslateStyleguide =
-  | string
-  | ((context: TranslateStyleguideContext) => Promise<string>)
-
-export declare interface TranslateStyleguideContext {
-  documentId: string
-  schemaType: ObjectSchemaType
-  client: SanityClient
+interface TranslateStyleguideContext {
+  documentId: string;
+  schemaType: ObjectSchemaType;
+  client: SanityClient;
   /**
    * Only provided for field translations
    */
-  translatePath?: Path
+  translatePath?: Path;
 }
-
-export declare interface TranslationConfig {
+type TranslateStyleguide = string | ((context: TranslateStyleguideContext) => Promise<string>);
+interface TranslationConfig {
   /**
    * Config for document types with fields in multiple languages in the same document.
    */
-  field?: FieldTranslationConfig
+  field?: FieldTranslationConfig;
   /**
    * Config for document types with a single language field that determines the language for the whole document.
    */
-  document?: DocumentTranslationConfig
+  document?: DocumentTranslationConfig;
   /**
    * A "style guide" that can be used to provide guidance on how to translate content.
    * Will be passed to the LLM - ergo this is only a guide and the model _may_ not
@@ -590,95 +387,100 @@ export declare interface TranslationConfig {
    *
    * When providing a function, consider caching the results of any async operation; it will invoked every time translate runs
    */
-  styleguide?: TranslateStyleguide
+  styleguide?: TranslateStyleguide;
 }
-
-export declare interface TranslationOutput {
-  /** Language id */
-  id: string
-  outputPath: Path
+declare const userInputTypeName: "sanity.assist.instruction.userInput";
+declare const instructionContextTypeName: "sanity.assist.instruction.context";
+declare const fieldReferenceTypeName: "sanity.assist.instruction.fieldRef";
+declare const contextDocumentTypeName: "assist.instruction.context";
+declare const outputFieldTypeName: "sanity.assist.output.field";
+declare const outputTypeTypeName: "sanity.assist.output.type";
+interface PresetInstruction {
+  _key: string;
+  prompt?: PromptTextBlock[];
+  title?: string;
+  /**
+   * String key from `@sanity/icons` IconMap
+   */
+  icon?: string;
+  /**
+   * Type/field filter
+   */
+  output?: (OutputFieldItem | OutputTypeItem)[];
 }
-
-export declare type TranslationOutputsFunction = (
-  documentMember: DocumentMember,
-  enclosingType: SchemaType,
-  translateFromLanguageId: string,
-  translateToLanguageIds: string[],
-) => TranslationOutput[] | undefined
-
-declare interface UserInputBlock {
-  _type: typeof userInputTypeName
-  _key: string
-  message?: string
-  description?: string
+interface PresetField {
+  path?: string;
+  instructions?: PresetInstruction[];
+}
+interface AssistPreset {
+  fields?: PresetField[];
+}
+interface FieldRef extends PortableTextMarkDefinition {
+  _type: typeof fieldReferenceTypeName;
+  path?: string;
+}
+interface ContextBlock {
+  _type: typeof instructionContextTypeName;
+  reference?: {
+    _type: 'reference';
+    _ref?: string;
+  };
+}
+interface UserInputBlock {
+  _type: typeof userInputTypeName;
+  _key: string;
+  message?: string;
+  description?: string;
+}
+type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock | ContextBlock;
+type PromptTextBlock = Omit<PortableTextBlock<never, InlinePromptBlock, 'normal', never>, '_type'> & {
+  _type: 'block';
+};
+interface OutputFieldItem {
+  _type: typeof outputFieldTypeName;
+  _key: string;
+  relativePath?: string;
+}
+interface OutputTypeItem {
+  _type: typeof outputTypeTypeName;
+  _key: string;
+  type?: string;
+  relativePath?: string;
+}
+interface AssistPluginConfig {
+  translate?: TranslationConfig;
+  /**
+   * Config that affects all instructions
+   */
+  assist?: AssistConfig;
+  fieldActions?: {
+    title?: string;
+    /**
+     * The returned array can include `undefined` entries in the action array. These will be filtered out.
+     */
+    useFieldActions?: (props: AssistFieldActionProps) => (AssistFieldActionNode | undefined)[];
+  };
+  /**
+   * @internal
+   */
+  __customApiClient?: (defaultClient: SanityClient$1) => SanityClient$1;
+  /**
+   * @internal
+   */
+  __presets?: Record<string, AssistPreset>;
+}
+declare const assist: sanity.Plugin<void | AssistPluginConfig>;
+declare function SchemaTypeTool(): react_jsx_runtime0.JSX.Element;
+interface AssistOptions {
+  aiAssist?: {
+    /** Set to true to disable assistance for this field or type */exclude?: boolean;
+    /**
+     * Set to true to add translation field-action to the field.
+     * Only has an effect in document types configured for document or field level translations.
+     */
+    translateAction?: boolean;
+  };
 }
-
-declare const userInputTypeName: 'sanity.assist.instruction.userInput'
-
-/**
- * `useUserInput` returns a function that can be used to await user input.
- *
- * Useful for custom `fieldActions` to get user input for populating Agent Action requests,.
- *
- * ```ts
- *  fieldActions: {
- *   useFieldActions: (props) => {
- *     const {
- *       documentSchemaType,
- *       schemaId,
- *       getDocumentValue,
- *       getConditionalPaths,
- *       documentIdForAction,
- *     } = props
- *     const client = useClient({apiVersion: 'vX'})
- *     const getUserInput = useUserInput()
- *     return useMemo(() => {
- *       return [
- *         defineAssistFieldAction({
- *           title: 'Log user input',
- *           icon: UserIcon,
- *           onAction: async () => {
- *             const input = await getUserInput({
- *               title: 'Topic',
- *               inputs: [{id: 'about', title: 'What should the article be about?'}],
- *             })
- *             if (!input) return // user canceled input
- *             await client.agent.action.generate({
- *               schemaId,
- *               targetDocument: {
- *                 operation: 'createIfNotExists',
- *                 _id: documentIdForAction,
- *                 _type: documentSchemaType.name,
- *                 initialValues: getDocumentValue(),
- *               },
- *               instruction: `
- *                   Create a document about the following topic:
- *                   $about
- *                   ---
- *                `,
- *               instructionParams: {about: input[0].result},
- *               conditionalPaths: {paths: getConditionalPaths()},
- *             })
- *           },
- *         }),
- *       ]
- *     }, [
- *       client,
- *       documentSchemaType,
- *       schemaId,
- *       getDocumentValue,
- *       getConditionalPaths,
- *       documentIdForAction,
- *       getUserInput,
- *     ])
- *   },
- * }
- * ```
- */
-export declare function useUserInput(): GetUserInput
-
-export {}
-
 declare module 'sanity' {
   interface ArrayOptions extends AssistOptions {}
   interface BlockOptions extends AssistOptions {}
@@ -725,7 +527,7 @@ declare module 'sanity' {
        * })
        * ```
        */
-      imageInstructionField?: string
+      imageInstructionField?: string;
       /**
        * When set, an image description will be automatically created for the image.
        *
@@ -756,36 +558,146 @@ declare module 'sanity' {
        * })
        * ```
        */
-      imageDescriptionField?:
-        | string
-        | {
-            path: string
-            /**
-             * When updateOnImageChange is true (or undefined), whenever the
-             * image asset changes, imageDescriptionField will be regenerated.
-             *
-             * default:  true
-             * */
-            updateOnImageChange?: boolean
-          }
-    }
+      imageDescriptionField?: string | {
+        path: string;
+        /**
+         * When updateOnImageChange is true (or undefined), whenever the
+         * image asset changes, imageDescriptionField will be regenerated.
+         *
+         * default:  true
+         * */
+        updateOnImageChange?: boolean;
+      };
+    };
   }
   interface NumberOptions extends AssistOptions {}
   interface ObjectOptions extends AssistOptions {}
   interface ReferenceBaseOptions {
     aiAssist?: {
-      /** Set to true to disable assistance for this field or type */
-      exclude?: boolean
+      /** Set to true to disable assistance for this field or type */exclude?: boolean;
       /**
        * When set, the reference field will allow instructions to be added to it.
        * Should be the name of the embeddings-index where assist will look for contextually relevant documents
        * */
-      embeddingsIndex?: string
-    }
+      embeddingsIndex?: string;
+    };
   }
   interface SlugOptions extends AssistOptions {}
   interface StringOptions extends AssistOptions {}
   interface TextOptions extends AssistOptions {}
   interface UrlOptions extends AssistOptions {}
   interface EmailOptions extends AssistOptions {}
+} //# sourceMappingURL=typeDefExtensions.d.ts.map
+/**
+ * Default implementation for plugin config `translate.field.translationOutputs`
+ *
+ * @see FieldTranslationConfig#translationOutputs
+ */
+declare const defaultLanguageOutputs: TranslationOutputsFunction;
+type GetUserInput = (args: {
+  /**
+   * Dialog title
+   */
+  title: string;
+  /**
+   * One titled input per array item
+   */
+  inputs: CustomInput[];
+}) => Promise<CustomInputResult[] | undefined>;
+/**
+ *
+ */
+interface CustomInput {
+  /**
+   * Id for the input
+   */
+  id: string;
+  /**
+   * Title of the input field
+   */
+  title: string;
+  /**
+   * Additional info that will be displayed over the input
+   */
+  description?: string;
 }
+type CustomInputResult = {
+  /**
+   * Identifies which custom input the `result`belongs to
+   */
+  input: CustomInput;
+  /**
+   * The text provided by the user in the input
+   */
+  result: string;
+};
+/**
+ * `useUserInput` returns a function that can be used to await user input.
+ *
+ * Useful for custom `fieldActions` to get user input for populating Agent Action requests,.
+ *
+ * ```ts
+ *  fieldActions: {
+ *   useFieldActions: (props) => {
+ *     const {
+ *       documentSchemaType,
+ *       schemaId,
+ *       getDocumentValue,
+ *       getConditionalPaths,
+ *       documentIdForAction,
+ *     } = props
+ *     const client = useClient({apiVersion: 'vX'})
+ *     const getUserInput = useUserInput()
+ *     return useMemo(() => {
+ *       return [
+ *         defineAssistFieldAction({
+ *           title: 'Log user input',
+ *           icon: UserIcon,
+ *           onAction: async () => {
+ *             const input = await getUserInput({
+ *               title: 'Topic',
+ *               inputs: [{id: 'about', title: 'What should the article be about?'}],
+ *             })
+ *             if (!input) return // user canceled input
+ *             await client.agent.action.generate({
+ *               schemaId,
+ *               targetDocument: {
+ *                 operation: 'createIfNotExists',
+ *                 _id: documentIdForAction,
+ *                 _type: documentSchemaType.name,
+ *                 initialValues: getDocumentValue(),
+ *               },
+ *               instruction: `
+ *                   Create a document about the following topic:
+ *                   $about
+ *                   ---
+ *                `,
+ *               instructionParams: {about: input[0].result},
+ *               conditionalPaths: {paths: getConditionalPaths()},
+ *             })
+ *           },
+ *         }),
+ *       ]
+ *     }, [
+ *       client,
+ *       documentSchemaType,
+ *       schemaId,
+ *       getDocumentValue,
+ *       getConditionalPaths,
+ *       documentIdForAction,
+ *       getUserInput,
+ *     ])
+ *   },
+ * }
+ * ```
+ */
+declare function useUserInput(): GetUserInput;
+/**
+ * Returns true if the `schemaType` or any of its parent types (`schemaType.type`)` has `name` equal
+ * to `typeName`.
+ *
+ * Useful for checking if `schemaType` is a type alias of `ìmage`, `code` or similar.
+ */
+declare function isType(schemaType: SchemaType, typeName: string): boolean;
+export { AssistConfig, type AssistFieldActionGroup, type AssistFieldActionItem, type AssistFieldActionNode, type AssistFieldActionProps, AssistOptions, type CustomInput, type CustomInputResult, DocumentMember, DocumentTranslationConfig, FieldTranslationConfig, type GetUserInput, Language, LanguageCallback, LocaleSettings, LocaleSettingsContext, SchemaTypeTool, TranslateStyleguide, TranslateStyleguideContext, TranslationConfig, TranslationOutput, TranslationOutputsFunction, assist, contextDocumentTypeName, defaultLanguageOutputs, defineAssistFieldAction, defineAssistFieldActionGroup, defineFieldActionDivider, isType, useUserInput };
+//# sourceMappingURL=index.d.ts.map