@sanity/assist 1.2.15-lang.6 → 1.2.15-lang.8

package/README.md

@@ -16,6 +16,7 @@
   - [Disable for a field](#disable-for-a-field)
   - [Disable for an array type](#disable-for-an-array-type)
   - [Unsupported types](#unsupported-types)
+  - [Hidden and readOnly fields](#hidden-and-readonly-fields)
   - [Reference support](#reference-support)
   - [Troubleshooting](#troubleshooting)
 - [Included document types](#included-document-types)
@@ -186,14 +187,25 @@ The following types are not supported, and behave as excluded types:
 * [File](https://www.sanity.io/docs/file-type) (never supported, even when file has custom fields)
 * [Reference](https://www.sanity.io/docs/reference-type) (supported when configured with embeddingsIndex)
 
-Types and fields with `hidden` or `readonly` with a truthy value (`true` or `function`) are not supported.
-(Hidden and readOnly fields can be referenced in instructions still)
-
 Fields with these types will not be changed by the assistant, do not have AI Assist actions, and cannot be referenced in instructions.
 
 Objects where all fields are excluded or unsupported and arrays where all member types are excluded or unsupported
 will also be excluded.
 
+### Hidden adn readOnly fields
+
+In AI Assist 2.0 and later, conditionally `hidden` and `readOnly` fields can have instructions.
+These fields can be written to by an instruction, as long as the field is non-hidden and writable when the instruction is started.
+
+Fields with `hidden` or `readOnly` set to literal `true` will be skipped by AI Assist.
+
+*Note*: An instruction will not re-evaluate these states during a run.
+Ie, if an instructions writes to a field that will make another field in the studio readonly or hidden,
+the running instruction will still consider these as if in their original state.
+
+If it is essential that AI Assist *never* writes to a conditional field,
+it should be marked with `options.aiWritingAssistance.exclude: true`.
+
 ### Reference support
 
 #### Create an Embeddings-index

package/dist/index.cjs.mjs

@@ -3,4 +3,5 @@ import cjs from './index.js';
 export const SchemaTypeTool = cjs.SchemaTypeTool;
 export const assist = cjs.assist;
 export const contextDocumentTypeName = cjs.contextDocumentTypeName;
+export const defaultLanguageOutputs = cjs.defaultLanguageOutputs;
 

package/dist/index.d.ts

@@ -21,10 +21,6 @@ export declare interface AssistOptions {
 
 declare interface AssistPluginConfig {
   translate?: TranslationConfig
-  /**
-   * Set this to false to disable model migration from the alpha version of this plugin
-   */
-  alphaMigration?: boolean
   /**
    * @internal
    */
@@ -33,13 +29,21 @@ declare interface AssistPluginConfig {
 
 export declare const contextDocumentTypeName: 'assist.instruction.context'
 
-declare interface DocumentMember {
+/**
+ * Default implementation for plugin config `translate.field.translationOutputs`
+ *
+ * @see FieldTranslationConfig#translationOutputs
+ */
+export declare const defaultLanguageOutputs: TranslationOutputsFunction
+
+export declare interface DocumentMember {
   schemaType: SchemaType
   path: Path
   name: string
+  value: unknown
 }
 
-declare interface DocumentTranslationConfig {
+export declare interface DocumentTranslationConfig {
   /**
    * Path to language field in documents. Can be a hidden field.
    * For instance: 'config.language'
@@ -61,7 +65,7 @@ declare interface DocumentTranslationConfig {
   documentTypes?: string[]
 }
 
-declare interface FieldTranslationConfig {
+export declare interface FieldTranslationConfig {
   /**
    * `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
    *
@@ -152,19 +156,19 @@ declare interface FieldTranslationConfig {
   translationOutputs?: TranslationOutputsFunction
 }
 
-declare interface Language {
+export declare interface Language {
   id: string
   title?: string
 }
 
-declare type LanguageCallback = (
+export declare type LanguageCallback = (
   client: SanityClient,
   selectedLanguageParams: Record<string, unknown>,
 ) => Promise<Language[]>
 
 export declare function SchemaTypeTool(): JSX_2.Element
 
-declare interface TranslationConfig {
+export declare interface TranslationConfig {
   /**
    * Config for document types with fields in multiple languages in the same document.
    */
@@ -175,13 +179,13 @@ declare interface TranslationConfig {
   document?: DocumentTranslationConfig
 }
 
-declare interface TranslationOutput {
+export declare interface TranslationOutput {
   /** Language id */
   id: string
   outputPath: Path
 }
 
-declare type TranslationOutputsFunction = (
+export declare type TranslationOutputsFunction = (
   documentMember: DocumentMember,
   enclosingType: SchemaType,
   translateFromLanguageId: string,