@sanity/assist 1.2.15 → 2.0.0

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/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,12 +15,11 @@ 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} from './types'
 
 export interface AssistPluginConfig {
-  /**
-   * Set this to false to disable model migration from the alpha version of this plugin
-   */
-  alphaMigration?: boolean
+  translate?: TranslationConfig
 
   /**
    * @internal
@@ -36,16 +35,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 +59,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/presence/AssistAvatar.tsx

@@ -88,7 +88,7 @@ export function AssistAvatar(props: {state?: 'present' | 'active'}) {
       </Outline>
       <IconDisc>
         <Text as="span" size={0} style={{color: 'inherit'}}>
-          <SparklesIcon />
+          <SparklesIcon style={{color: 'inherit'}} />
         </Text>
       </IconDisc>
     </Root>

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',
+            },
+          ],
+        }),
+      ],
+    }),
   ],
 })
 

package/src/schemas/serialize/serializeSchema.test.ts

@@ -32,7 +32,7 @@ describe('serializeSchema', () => {
           name: 'article',
           fields: [{type: 'string', name: 'title'}],
           options: {
-            aiWritingAssistance: {
+            aiAssist: {
               exclude: true,
             },
           },
@@ -123,7 +123,7 @@ describe('serializeSchema', () => {
   })
 
   test('should not serialize excluded fields or types or types with every member excluded', () => {
-    const options: AssistOptions = {aiWritingAssistance: {exclude: true}}
+    const options: AssistOptions = {aiAssist: {exclude: true}}
 
     const schema = Schema.compile({
       name: 'test',
@@ -138,14 +138,14 @@ describe('serializeSchema', () => {
               name: 'excludedObject',
               // all fields excluded should exclude field
               fields: [{type: 'string', name: 'title', options}],
-              options: {aiWritingAssistance: {exclude: true}},
+              options: {aiAssist: {exclude: true}},
             }),
             defineField({
               type: 'array',
               name: 'excludedArray',
               // all items excluded should exclude field
               of: [{type: 'object', name: 'remove', options}, {type: 'excluded'}],
-              options: {aiWritingAssistance: {exclude: true}},
+              options: {aiAssist: {exclude: true}},
             }),
             //image without extra fields should be excluded
             defineField({type: 'image', name: 'image'}),
@@ -169,7 +169,7 @@ describe('serializeSchema', () => {
           type: 'object',
           name: 'excluded',
           fields: [{type: 'string', name: 'title', options}],
-          options: {aiWritingAssistance: {exclude: true}},
+          options: {aiAssist: {exclude: true}},
         }),
         ...mockStudioTypes,
       ],
@@ -484,7 +484,7 @@ describe('serializeSchema', () => {
     ])
   })
 
-  test('should exclude truthy hidden and readonly', () => {
+  test('should annotate truthy readonly', () => {
     const schema = Schema.compile({
       name: 'test',
       types: [
@@ -492,7 +492,7 @@ describe('serializeSchema', () => {
           type: 'document',
           name: 'article',
           fields: [
-            {type: 'string', name: 'title', hidden: () => true},
+            {type: 'string', name: 'title', readOnly: () => true},
             {type: 'some', name: 'some'},
           ],
         },
@@ -507,6 +507,237 @@ describe('serializeSchema', () => {
 
     const serializedTypes = serializeSchema(schema, {leanFormat: true})
 
-    expect(serializedTypes).toEqual([])
+    expect(serializedTypes).toEqual([
+      {
+        name: 'article',
+        title: 'Article',
+        type: 'document',
+        fields: [
+          {name: 'title', readOnly: 'function', title: 'Title', type: 'string'},
+          {name: 'some', readOnly: true, title: 'Some', type: 'some'},
+        ],
+      },
+      {
+        name: 'some',
+        readOnly: true,
+        title: 'Some',
+        type: 'object',
+        fields: [{name: 'title', title: 'Title', type: 'string'}],
+      },
+    ])
+  })
+
+  test('should annotate truthy hidden', () => {
+    const schema = Schema.compile({
+      name: 'test',
+      types: [
+        {
+          type: 'document',
+          name: 'article',
+          fields: [
+            {type: 'string', name: 'title', hidden: true},
+            {type: 'some', name: 'some'},
+          ],
+        },
+        defineType({
+          type: 'object',
+          name: 'some',
+          hidden: () => true,
+          fields: [{type: 'string', name: 'title'}],
+        }),
+      ],
+    })
+
+    const serializedTypes = serializeSchema(schema, {leanFormat: true})
+
+    expect(serializedTypes).toEqual([
+      {
+        name: 'article',
+        title: 'Article',
+        type: 'document',
+        fields: [
+          {hidden: true, name: 'title', title: 'Title', type: 'string'},
+          {hidden: 'function', name: 'some', title: 'Some', type: 'some'},
+        ],
+      },
+      {
+        hidden: 'function',
+        name: 'some',
+        title: 'Some',
+        type: 'object',
+        fields: [{name: 'title', title: 'Title', type: 'string'}],
+      },
+    ])
+  })
+
+  test('should serialize annotations', () => {
+    const schema = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'object',
+          name: 'annotation',
+          fields: [defineField({type: 'string', name: 'fact', title: 'Fact'})],
+        }),
+        defineType({
+          name: 'blockAlias',
+          type: 'block',
+          marks: {annotations: [{type: 'annotation'}]},
+        }),
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [
+            {
+              type: 'array',
+              name: 'inlinePte',
+              of: [
+                defineArrayMember({
+                  type: 'block',
+                  marks: {
+                    annotations: [
+                      defineArrayMember({
+                        type: 'object',
+                        name: 'inline-annotation',
+                        fields: [defineField({type: 'string', name: 'fact', title: 'Fact'})],
+                      }),
+                    ],
+                  },
+                }),
+              ],
+            },
+            {type: 'array', name: 'pte', of: [{type: 'blockAlias'}]},
+          ],
+        }),
+      ],
+    })
+
+    const serializedTypes = serializeSchema(schema, {leanFormat: true})
+
+    expect(serializedTypes).toEqual([
+      {
+        name: 'annotation',
+        title: 'Annotation',
+        type: 'object',
+        fields: [{name: 'fact', title: 'Fact', type: 'string'}],
+      },
+      {
+        name: 'article',
+        title: 'Article',
+        type: 'document',
+        fields: [
+          {
+            name: 'inlinePte',
+            title: 'Inline Pte',
+            type: 'array',
+            of: [
+              {
+                name: 'block',
+                title: 'Block',
+                type: 'block',
+                inlineOf: [],
+                annotations: [
+                  {
+                    name: 'inline-annotation',
+                    title: 'Inline Annotation',
+                    type: 'object',
+                    fields: [{name: 'fact', title: 'Fact', type: 'string'}],
+                  },
+                ],
+              },
+            ],
+          },
+          {
+            name: 'pte',
+            of: [{name: 'blockAlias', title: 'Block', type: 'blockAlias'}],
+            title: 'Pte',
+            type: 'array',
+          },
+        ],
+      },
+      {
+        name: 'blockAlias',
+        title: 'Block',
+        type: 'block',
+        annotations: [{name: 'annotation', title: 'Annotation', type: 'annotation'}],
+        inlineOf: [],
+      },
+    ])
+  })
+
+  test('should serialize inline block types', () => {
+    const schema = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'object',
+          name: 'inline-block',
+          fields: [
+            defineField({type: 'string', name: 'fact', title: 'Fact'}),
+            defineField({type: 'blockAlias', name: 'recurse', title: 'Recursive'}),
+          ],
+        }),
+        defineType({
+          name: 'blockAlias',
+          type: 'block',
+          of: [{type: 'inline-block'}],
+        }),
+        defineType({
+          type: 'document',
+          name: 'article',
+          fields: [{type: 'array', name: 'pte', of: [{type: 'blockAlias'}]}],
+        }),
+      ],
+    })
+
+    const serializedTypes = serializeSchema(schema, {leanFormat: true})
+
+    expect(serializedTypes).toEqual([
+      {
+        name: 'article',
+        title: 'Article',
+        type: 'document',
+        fields: [
+          {
+            name: 'pte',
+            of: [
+              {
+                name: 'blockAlias',
+                title: 'Block',
+                type: 'blockAlias',
+              },
+            ],
+            title: 'Pte',
+            type: 'array',
+          },
+        ],
+      },
+      {
+        name: 'blockAlias',
+        title: 'Block',
+        type: 'block',
+        annotations: [],
+        inlineOf: [
+          {
+            name: 'inline-block',
+            title: 'Inline Block',
+            type: 'inline-block',
+          },
+        ],
+      },
+      {
+        name: 'inline-block',
+        title: 'Inline Block',
+        type: 'object',
+        fields: [
+          {name: 'fact', title: 'Fact', type: 'string'},
+          {
+            name: 'recurse',
+            title: 'Recursive',
+            type: 'blockAlias',
+          },
+        ],
+      },
+    ])
   })
 })