@sanity/assist 1.2.16 → 2.0.1

package/src/helpers/assistSupported.ts

@@ -1,41 +1,34 @@
-import {SchemaType} from 'sanity'
+import {ReferenceOptions, SchemaType} from 'sanity'
 import {AssistOptions} from '../schemas/typeDefExtensions'
 import {isType} from './typeUtils'
 
 export function isSchemaAssistEnabled(type: SchemaType) {
-  return !(type.options as AssistOptions | undefined)?.aiWritingAssistance?.exclude
+  return !(type.options as AssistOptions | undefined)?.aiAssist?.exclude
 }
 
-export function isAssistSupported(type: SchemaType, allowReadonlyHidden = false) {
+export function isAssistSupported(type: SchemaType) {
   if (!isSchemaAssistEnabled(type)) {
     return false
   }
 
-  if (isDisabled(type, allowReadonlyHidden)) {
+  if (isDisabled(type)) {
     return false
   }
 
   if (type.jsonType === 'array') {
-    const unsupportedArray = type.of.every((t) => isDisabled(t, allowReadonlyHidden))
+    const unsupportedArray = type.of.every((t) => isDisabled(t))
     return !unsupportedArray
   }
 
   if (type.jsonType === 'object') {
-    const unsupportedObject = type.fields.every((field) =>
-      isDisabled(field.type, allowReadonlyHidden)
-    )
+    const unsupportedObject = type.fields.every((field) => isDisabled(field.type))
     return !unsupportedObject
   }
   return true
 }
 
-function isDisabled(type: SchemaType, allowReadonlyHidden: boolean) {
-  const readonlyHidden = !!type.readOnly || !!type.hidden
-  return (
-    !isSchemaAssistEnabled(type) ||
-    isUnsupportedType(type) ||
-    (!allowReadonlyHidden && readonlyHidden)
-  )
+function isDisabled(type: SchemaType) {
+  return !isSchemaAssistEnabled(type) || isUnsupportedType(type)
 }
 
 function isUnsupportedType(type: SchemaType) {
@@ -43,7 +36,8 @@ function isUnsupportedType(type: SchemaType) {
     type.jsonType === 'number' ||
     type.name === 'sanity.imageCrop' ||
     type.name === 'sanity.imageHotspot' ||
-    isType(type, 'reference') ||
+    (isType(type, 'reference') &&
+      !(type?.options as ReferenceOptions)?.aiAssist?.embeddingsIndex) ||
     isType(type, 'crossDatasetReference') ||
     isType(type, 'slug') ||
     isType(type, 'url') ||

package/src/helpers/conditionalMembers.test.ts

@@ -0,0 +1,200 @@
+import {describe, expect, test} from 'vitest'
+import {Schema} from '@sanity/schema'
+import {ArraySchemaType, defineField, defineType, ObjectSchemaType} from 'sanity'
+import {getConditionalMembers} from './conditionalMembers'
+
+describe('conditionalMembers', () => {
+  test('should not include paths without conditional hidden/readonly', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [{type: 'string', name: 'title'}],
+        }),
+      ],
+    }).get('article')
+
+    const docState = {
+      path: [],
+      schemaType: docSchema,
+      members: [
+        {
+          kind: 'field',
+          field: {path: [docSchema.fields[0].name], schemaType: docSchema.fields[0].type},
+        },
+      ],
+    } as any
+    const conditionalMembers = getConditionalMembers(docState)
+
+    expect(conditionalMembers).toEqual([])
+  })
+
+  test('should include path with conditional readonly', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [{type: 'string', name: 'title', readOnly: () => false}],
+        }),
+      ],
+    }).get('article')
+
+    const docState = {
+      path: [],
+      schemaType: docSchema,
+      members: [
+        {
+          kind: 'field',
+          field: {path: [docSchema.fields[0].name], schemaType: docSchema.fields[0].type},
+        },
+      ],
+    } as any
+    const conditionalMembers = getConditionalMembers(docState)
+
+    expect(conditionalMembers).toEqual([{path: 'title', hidden: false, readOnly: false}])
+  })
+
+  test('should include array item path with conditional readonly', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [{type: 'array', name: 'array', of: [{type: 'string', readOnly: () => true}]}],
+        }),
+      ],
+    }).get('article')
+
+    const docState = {
+      path: [],
+      schemaType: docSchema,
+      members: [
+        {
+          kind: 'field',
+          field: {
+            path: [docSchema.fields[0].name],
+            schemaType: docSchema.fields[0].type,
+            members: [
+              {
+                kind: 'item',
+                item: {
+                  path: [docSchema.fields[0].name, 0],
+                  schemaType: (docSchema.fields[0].type as ArraySchemaType).of[0],
+                  readOnly: true,
+                },
+              },
+            ],
+          },
+        },
+      ],
+    } as any
+    const conditionalMembers = getConditionalMembers(docState)
+
+    expect(conditionalMembers).toEqual([
+      {
+        path: 'array[0]',
+        hidden: false,
+        readOnly: true,
+      },
+    ])
+  })
+
+  test('should include object path with conditional hidden', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [
+            defineField({
+              type: 'object',
+              name: 'object',
+              fields: [{type: 'string', name: 'title', hidden: () => false}],
+            }),
+          ],
+        }),
+      ],
+    }).get('article')
+
+    const docState = {
+      path: [],
+      schemaType: docSchema,
+      members: [
+        {
+          kind: 'field',
+          field: {
+            path: [docSchema.fields[0].name],
+            schemaType: docSchema.fields[0].type,
+            members: [
+              {
+                kind: 'field',
+                field: {
+                  path: [docSchema.fields[0].name, 'title'],
+                  schemaType: (docSchema.fields[0].type as ObjectSchemaType).fields[0].type,
+                },
+              },
+            ],
+          },
+        },
+      ],
+    } as any
+    const conditionalMembers = getConditionalMembers(docState)
+
+    expect(conditionalMembers).toEqual([
+      {
+        path: 'object.title',
+        hidden: false,
+        readOnly: false,
+      },
+    ])
+  })
+
+  test('should include path with fieldset with conditional state', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          fieldsets: [{name: 'set', hidden: () => false}],
+          fields: [{type: 'string', fieldset: 'set', name: 'title'}],
+        }),
+      ],
+    }).get('article')
+
+    const docState = {
+      path: [],
+      schemaType: docSchema,
+      members: [
+        {
+          kind: 'fieldSet',
+          fieldSet: {
+            name: 'set',
+            path: ['set'],
+            members: [
+              {
+                kind: 'field',
+                field: {path: [docSchema.fields[0].name], schemaType: docSchema.fields[0].type},
+              },
+            ],
+          },
+        },
+      ],
+    } as any
+    const conditionalMembers = getConditionalMembers(docState)
+
+    expect(conditionalMembers).toEqual([
+      {
+        path: 'title',
+        hidden: false,
+        readOnly: false,
+      },
+    ])
+  })
+})

package/src/helpers/conditionalMembers.ts

@@ -0,0 +1,127 @@
+/* eslint-disable max-depth */
+import {
+  ArrayOfObjectsFormNode,
+  ArrayOfObjectsItemMember,
+  ArrayOfPrimitivesFormNode,
+  DocumentFormNode,
+  FieldsetState,
+  isObjectSchemaType,
+  ObjectFormNode,
+  Path,
+  pathToString,
+  SchemaType,
+} from 'sanity'
+
+const MAX_DEPTH = 8
+
+export interface ConditionalMemberState {
+  path: string
+  hidden: boolean
+  readOnly: boolean
+}
+
+interface ConditionalMemberInnerState extends ConditionalMemberState {
+  conditional: boolean
+}
+
+/**
+ * This is used to statically determine the state of the functions on the server-side.
+ * Paths which has a schema with conditional config should be considered hidden: true and/or readOnly: true
+ * Only conditional paths are included, as static props can be determined from schema.
+ *
+ * Returns paths that has conditional hidden or readOnly schema config (function) and that.
+ * Form-state does not contain hidden members.
+ *
+ * Note:
+ * * If a parent path is hidden, no child paths are included
+ * * If a parent path is readOnly, no child paths are included
+ * * If a path is hidden, it is not included; only conditionally visible paths will be returned, with hidden: false
+ */
+export function getConditionalMembers(docState: DocumentFormNode): ConditionalMemberState[] {
+  const doc: ConditionalMemberInnerState = {
+    path: '',
+    hidden: false,
+    readOnly: !!docState.readOnly,
+    conditional: typeof docState.schemaType.hidden === 'function',
+  }
+  return [doc, ...extractConditionalPaths(docState, MAX_DEPTH)]
+    .filter((v) => v.conditional)
+    .map(({conditional, ...state}) => ({...state}))
+}
+
+function isConditional(schemaType: SchemaType) {
+  return typeof schemaType.hidden === 'function' || typeof schemaType.readOnly === 'function'
+}
+
+function conditionalState(memberState: {
+  path: Path
+  schemaType: SchemaType
+  readOnly?: boolean
+}): ConditionalMemberInnerState {
+  return {
+    path: pathToString(memberState.path),
+    readOnly: !!memberState.readOnly,
+    hidden: false, // if its in members, its not hidden
+    conditional: isConditional(memberState.schemaType),
+  }
+}
+
+function extractConditionalPaths(
+  node: ObjectFormNode | FieldsetState,
+  maxDepth: number
+): ConditionalMemberInnerState[] {
+  if (node.path.length >= maxDepth) {
+    return []
+  }
+
+  return node.members.reduce<ConditionalMemberInnerState[]>((acc, member) => {
+    if (member.kind === 'error') {
+      return acc
+    }
+    if (member.kind === 'field') {
+      const schemaType = member.field.schemaType
+      if (schemaType.jsonType === 'object') {
+        const innerFields = member.field.readOnly
+          ? []
+          : extractConditionalPaths(member.field as ObjectFormNode, maxDepth)
+        return [...acc, conditionalState(member.field), ...innerFields]
+      } else if (schemaType.jsonType === 'array') {
+        const array = member.field as ArrayOfObjectsFormNode | ArrayOfPrimitivesFormNode
+
+        let arrayPaths: ConditionalMemberInnerState[] = []
+        const isObjectsArray = array.members.some(
+          (m) => m.kind === 'item' && isObjectSchemaType(m.item.schemaType)
+        )
+        if (!array.readOnly) {
+          for (const arrayMember of array.members) {
+            if (arrayMember.kind === 'error') {
+              continue
+            }
+
+            const innerFields =
+              isObjectsArray && !arrayMember.item.readOnly
+                ? extractConditionalPaths((arrayMember as ArrayOfObjectsItemMember).item, maxDepth)
+                : []
+
+            arrayPaths = [...arrayPaths, conditionalState(arrayMember.item), ...innerFields]
+          }
+        }
+        return [...acc, conditionalState(array), ...arrayPaths]
+      }
+
+      return [...acc, conditionalState(member.field)]
+    } else if (member.kind === 'fieldSet') {
+      const conditionalFieldset = !!(node as ObjectFormNode).schemaType?.fieldsets?.some(
+        (f) => !f.single && f.name === member.fieldSet.name && typeof f.hidden === 'function'
+      )
+      const innerFields = extractConditionalPaths(member.fieldSet, maxDepth).map((f) => ({
+        ...f,
+        // if fieldset is conditional, visible fields must also be considered conditional
+        conditional: conditionalFieldset ?? f.conditional,
+      }))
+      return [...acc, ...innerFields]
+    }
+
+    return acc
+  }, [])
+}

package/src/helpers/misc.ts

@@ -4,13 +4,17 @@ import {useMemo} from 'react'
 
 export function usePathKey(path: Path | string) {
   return useMemo(() => {
-    if (path.length) {
-      return Array.isArray(path) ? pathToString(path) : path
-    }
-    return documentRootKey
+    return getPathKey(path)
   }, [path])
 }
 
+export function getPathKey(path: Path | string) {
+  if (path.length) {
+    return Array.isArray(path) ? pathToString(path) : path
+  }
+  return documentRootKey
+}
+
 export function getInstructionTitle(instruction?: StudioInstruction) {
   return instruction?.title ?? 'Untitled'
 }

package/src/helpers/typeUtils.ts

@@ -18,13 +18,27 @@ export function isImage(schemaType: SchemaType) {
   return isType(schemaType, 'image')
 }
 
-export function getCaptionFieldOption(schemaType: SchemaType | undefined): string | undefined {
+export function getDescriptionFieldOption(schemaType: SchemaType | undefined): string | undefined {
   if (!schemaType) {
     return undefined
   }
-  const captionField = (schemaType.options as ImageOptions)?.captionField
-  if (captionField) {
-    return captionField
+  const descriptionField = (schemaType.options as ImageOptions)?.aiAssist?.imageDescriptionField
+  if (descriptionField) {
+    return descriptionField
   }
-  return getCaptionFieldOption(schemaType.type)
+  return getDescriptionFieldOption(schemaType.type)
+}
+
+export function getImageInstructionFieldOption(
+  schemaType: SchemaType | undefined
+): string | undefined {
+  if (!schemaType) {
+    return undefined
+  }
+  const imageInstructionField = (schemaType.options as ImageOptions)?.aiAssist
+    ?.imageInstructionField
+  if (imageInstructionField) {
+    return imageInstructionField
+  }
+  return getImageInstructionFieldOption(schemaType.type)
 }

package/src/index.ts

@@ -1,6 +1,9 @@
 export * from './schemas/typeDefExtensions'
 export * from './schemas/serialize/SchemTypeTool'
 
+export {defaultLanguageOutputs} from './translate/paths'
+export * from './translate/types'
+
 export {contextDocumentTypeName} from './types'
 
 export {assist} from './plugin'

package/src/plugin.tsx

@@ -15,17 +15,21 @@ import {createAssistDocumentPresence} from './presence/AssistDocumentPresence'
 import {isSchemaAssistEnabled} from './helpers/assistSupported'
 import {isImage} from './helpers/typeUtils'
 import {ImageContextProvider} from './components/ImageContext'
+import {TranslationConfig} from './translate/types'
+import {assistDocumentTypeName, AssistPreset} from './types'
 
 export interface AssistPluginConfig {
+  translate?: TranslationConfig
+
   /**
-   * Set this to false to disable model migration from the alpha version of this plugin
+   * @internal
    */
-  alphaMigration?: boolean
+  __customApiClient?: (defaultClient: SanityClient) => SanityClient
 
   /**
    * @internal
    */
-  __customApiClient?: (defaultClient: SanityClient) => SanityClient
+  __presets?: Record<string, AssistPreset>
 }
 
 export const assist = definePlugin<AssistPluginConfig | void>((config) => {
@@ -36,16 +40,23 @@ export const assist = definePlugin<AssistPluginConfig | void>((config) => {
     schema: {
       types: schemaTypes,
     },
+    i18n: {
+      bundles: [{}],
+    },
 
     document: {
       inspectors: (prev, context) => {
-        const docSchema = context.schema.get(context.documentType)
+        const documentType = context.documentType
+        const docSchema = context.schema.get(documentType)
         if (docSchema && isSchemaAssistEnabled(docSchema)) {
           return [...prev, assistInspector]
         }
         return prev
       },
       unstable_fieldActions: (prev, {documentType, schema}) => {
+        if (documentType === assistDocumentTypeName) {
+          return []
+        }
         const docSchema = schema.get(documentType)
         if (docSchema && isSchemaAssistEnabled(docSchema)) {
           return [...prev, assistFieldActions]
@@ -53,6 +64,9 @@ export const assist = definePlugin<AssistPluginConfig | void>((config) => {
         return prev
       },
       unstable_languageFilter: (prev, {documentId, schema, schemaType}) => {
+        if (schemaType === assistDocumentTypeName) {
+          return []
+        }
         const docSchema = schema.get(schemaType)
         if (docSchema && isObjectSchemaType(docSchema) && isSchemaAssistEnabled(docSchema)) {
           return [...prev, createAssistDocumentPresence(documentId, docSchema)]

package/src/schemas/assistDocumentSchema.tsx

@@ -18,6 +18,8 @@ import {
   instructionContextTypeName,
   instructionTaskTypeName,
   instructionTypeName,
+  outputFieldTypeName,
+  outputTypeTypeName,
   promptTypeName,
   userInputTypeName,
 } from '../types'
@@ -37,11 +39,13 @@ import {PromptInput} from '../assistDocument/components/instruction/PromptInput'
 import {instructionGuideUrl} from '../constants'
 import {InstructionsArrayField} from '../assistDocument/components/InstructionsArrayField'
 import {getFieldRefsWithDocument} from '../assistInspector/helpers'
+import {InstructionOutputField} from '../assistDocument/components/instruction/InstructionOutputField'
+import {InstructionOutputInput} from '../assistDocument/components/instruction/InstructionOutputInput'
 
 export const fieldReference = defineType({
   type: 'object',
   name: fieldReferenceTypeName,
-  title: 'Document field',
+  title: 'Field',
   icon: ThListIcon,
 
   fields: [
@@ -329,6 +333,41 @@ export const instruction = defineType({
         return context.currentUser?.id ?? ''
       },
     }),
+    defineField({
+      type: 'array',
+      name: 'output',
+      title: 'Output filter',
+      components: {
+        input: InstructionOutputInput,
+        field: InstructionOutputField,
+      },
+      of: [
+        defineArrayMember({
+          type: 'object' as const,
+          name: outputFieldTypeName,
+          title: 'Output field',
+          fields: [
+            {
+              type: 'string',
+              name: 'path',
+              title: 'Path',
+            },
+          ],
+        }),
+        defineArrayMember({
+          type: 'object' as const,
+          name: outputTypeTypeName,
+          title: 'Output type',
+          fields: [
+            {
+              type: 'string',
+              name: 'type',
+              title: 'Type',
+            },
+          ],
+        }),
+      ],
+    }),
   ],
 })