@sanity/assist 3.0.5 → 3.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "description": "You create the instructions; Sanity AI Assist does the rest.",
   "keywords": [
     "sanity",

package/src/assistDocument/components/AssistDocumentForm.tsx

@@ -1,5 +1,5 @@
 import {Card, Stack, Text} from '@sanity/ui'
-import {createContext, useContext, useEffect, useMemo, useRef} from 'react'
+import {useContext, useEffect, useMemo, useRef} from 'react'
 import {
   FormCallbacksProvider,
   FormCallbacksValue,
@@ -21,7 +21,6 @@ import {
 
 import {useAiPaneRouter} from '../../assistInspector/helpers'
 import {useAiAssistanceConfig} from '../../assistLayout/AiAssistanceConfigContext'
-import {documentTypeFromAiDocumentId} from '../../helpers/ids'
 import {
   AssistDocument,
   AssistField,
@@ -32,13 +31,12 @@ import {
   instructionParam,
   StudioInstruction,
 } from '../../types'
+import {AssistTypeContext} from './AssistTypeContext'
 import {BackToInstructionListLink} from './instruction/BackToInstructionsLink'
 import {SelectedFieldContextProvider, SelectedFieldContextValue} from './SelectedFieldContext'
 
 const EMPTY_FIELDS: AssistField[] = []
 
-export const TypePathContext = createContext<string | undefined>(undefined)
-
 export function AssistDocumentForm(props: ObjectInputProps) {
   if (props.readOnly) {
     return (
@@ -55,16 +53,9 @@ function AssistDocumentFormEditable(props: ObjectInputProps) {
   const id = value?._id
   const fields = value?.fields
 
-  const targetDocumentType = useMemo(() => {
-    if (!id) {
-      return undefined
-    }
-    return documentTypeFromAiDocumentId(id)
-  }, [id])
-
   const {params, setParams} = useAiPaneRouter()
   const pathKey = params[fieldPathParam]
-  const typePath = useContext(TypePathContext)
+  const {typePath, documentType: targetDocumentType} = useContext(AssistTypeContext)
   const instruction = params[instructionParam]
 
   const activeKey = useMemo(() => {

package/src/assistDocument/components/AssistTypeContext.tsx

@@ -0,0 +1,7 @@
+import {createContext} from 'react'
+
+export interface AssistTypeContextValue {
+  typePath?: string
+  documentType?: string
+}
+export const AssistTypeContext = createContext<AssistTypeContextValue>({})

package/src/assistDocument/components/instruction/FieldRefInput.tsx

@@ -4,12 +4,12 @@ import {set, StringInputProps} from 'sanity'
 
 import {FieldAutocomplete} from '../../../assistInspector/FieldAutocomplete'
 import {FieldRef} from '../../../assistInspector/helpers'
-import {TypePathContext} from '../AssistDocumentForm'
+import {AssistTypeContext} from '../AssistTypeContext'
 import {SelectedFieldContext} from '../SelectedFieldContext'
 
 export function FieldRefPathInput(props: StringInputProps) {
   const documentSchema = useContext(SelectedFieldContext)?.documentSchema
-  const typePath = useContext(TypePathContext)
+  const {typePath} = useContext(AssistTypeContext)
   const ref = useRef<HTMLDivElement>(null)
   const id = useId()
   const {onChange} = props

package/src/assistDocument/components/instruction/InstructionOutputInput.tsx

@@ -168,7 +168,7 @@ function ArrayOutputInput({
           <Flex key={itemType.name}>
             <Selectable
               value={itemType.name}
-              title={isType(itemType, 'block') ? 'Text' : itemType.title ?? itemType.name}
+              title={isType(itemType, 'block') ? 'Text' : (itemType.title ?? itemType.name)}
               arrayValue={value as OutputTypeItem[] | undefined}
               onChange={onSelectChange}
             />

package/src/assistDocument/components/instruction/appearance/InstructionVisibility.tsx

@@ -8,7 +8,7 @@ export function InstructionVisibility(props: StringInputProps) {
   const user = useCurrentUser()
 
   const handleChange = useCallback(() => {
-    const newValue = value ? '' : user?.id ?? ''
+    const newValue = value ? '' : (user?.id ?? '')
     onChange(newValue ? set(newValue) : unset())
   }, [onChange, user, value])
 

package/src/assistInspector/AssistInspector.tsx

@@ -16,7 +16,7 @@ import {
 import {styled} from 'styled-components'
 
 import {DocumentForm} from '../_lib/form'
-import {TypePathContext} from '../assistDocument/components/AssistDocumentForm'
+import {AssistTypeContext} from '../assistDocument/components/AssistTypeContext'
 import {useStudioAssistDocument} from '../assistDocument/hooks/useStudioAssistDocument'
 import {
   getAssistableDocId,
@@ -290,6 +290,8 @@ export function AssistInspector(props: DocumentInspectorProps) {
     return <div {..._props} style={{height: '100%', flex: 1, overflow: 'auto'}} />
   }, [])
 
+  const assistTypeContext = useMemo(() => ({typePath, documentType}), [typePath, documentType])
+
   if (!documentId || !schemaType || schemaType.jsonType !== 'object') {
     return (
       <Card flex={1} padding={4}>
@@ -319,7 +321,7 @@ export function AssistInspector(props: DocumentInspectorProps) {
             <PresenceOverlay>
               <Box padding={4}>
                 {selectedField && (
-                  <TypePathContext.Provider value={typePath}>
+                  <AssistTypeContext.Provider value={assistTypeContext}>
                     <VirtualizerScrollInstanceProvider
                       scrollElement={boundary.current}
                       containerElement={boundary}
@@ -333,7 +335,7 @@ export function AssistInspector(props: DocumentInspectorProps) {
                         <DocumentForm />
                       </DocumentPaneProvider>
                     </VirtualizerScrollInstanceProvider>
-                  </TypePathContext.Provider>
+                  </AssistTypeContext.Provider>
                 )}
               </Box>
             </PresenceOverlay>

package/src/assistInspector/InstructionTaskHistoryButton.tsx

@@ -112,7 +112,7 @@ export function InstructionTaskHistoryButton(props: InstructionTaskHistoryButton
           const instruction = instructions?.find((i) => i._key === task.instructionKey)
           return {
             ...task,
-            title: showTitles ? task.title ?? getInstructionTitle(instruction) : undefined,
+            title: showTitles ? (task.title ?? getInstructionTitle(instruction)) : undefined,
             cancel: () => cancelRun(task._key),
           }
         }) ?? []
@@ -187,6 +187,7 @@ const TaskStatusButton = forwardRef(function TaskStatusButton(
   return (
     <StatusButton
       label={`${pluginTitle} status`}
+      aria-label={`${pluginTitle} status`}
       icon={isRunning ? SyncSpinningIcon : hasErrors ? ErrorOutlineIcon : CheckmarkCircleIcon}
       mode="bleed"
       onClick={onClick}

package/src/helpers/conditionalMembers.test.ts

@@ -59,6 +59,34 @@ describe('conditionalMembers', () => {
     expect(conditionalMembers).toEqual([{path: 'title', hidden: false, readOnly: false}])
   })
 
+  test('regression test: should include document path with conditional readonly and no hidden', () => {
+    const docSchema: ObjectSchemaType = Schema.compile({
+      name: 'test',
+      types: [
+        defineType({
+          type: 'document',
+          name: 'article',
+          readOnly: () => false,
+          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([{path: '', hidden: false, readOnly: false}])
+  })
+
   test('should include array item path with conditional readonly', () => {
     const docSchema: ObjectSchemaType = Schema.compile({
       name: 'test',

package/src/helpers/conditionalMembers.ts

@@ -42,7 +42,7 @@ export function getConditionalMembers(docState: DocumentFormNode): ConditionalMe
     path: '',
     hidden: false,
     readOnly: !!docState.readOnly,
-    conditional: typeof docState.schemaType.hidden === 'function',
+    conditional: isConditional(docState.schemaType),
   }
   return (
     [doc, ...extractConditionalPaths(docState, MAX_DEPTH)]

package/src/helpers/ids.test.ts

@@ -0,0 +1,17 @@
+import {describe, expect, test} from 'vitest'
+
+import {assistDocumentId} from './ids'
+
+describe('ids', () => {
+  test('assistDocumentId should replace illegal id chars with _', () => {
+    const testCases = [
+      {schemaType: 'test', assistId: 'sanity.assist.schemaType.test'},
+      {schemaType: 'test-type', assistId: 'sanity.assist.schemaType.test-type'},
+      {schemaType: 'test/type', assistId: 'sanity.assist.schemaType.test_type'},
+      {schemaType: '%broken©™£€∞', assistId: 'sanity.assist.schemaType._broken_____'},
+    ]
+    const outputs = testCases.map((testCase) => assistDocumentId(testCase.schemaType))
+    const expected = testCases.map((testCase) => testCase.assistId)
+    expect(outputs).toEqual(expected)
+  })
+})

package/src/helpers/ids.ts

@@ -1,17 +1,13 @@
 import {assistDocumentIdPrefix, assistDocumentStatusIdPrefix} from '../types'
 
-const aiDocPrefixPattern = new RegExp(`^${assistDocumentIdPrefix}`)
+const illegalIdChars = /[^a-zA-Z0-9._-]/g
 
 export function publicId(id: string) {
   return id.replace('drafts.', '')
 }
 
 export function assistDocumentId(documentType: string) {
-  return `${assistDocumentIdPrefix}${documentType}`
-}
-
-export function documentTypeFromAiDocumentId(id: string) {
-  return id.replace(aiDocPrefixPattern, '')
+  return `${assistDocumentIdPrefix}${documentType}`.replace(illegalIdChars, '_')
 }
 
 export function assistTasksStatusId(documentId: string) {

package/src/schemas/assistDocumentSchema.tsx

@@ -170,7 +170,7 @@ export const promptContext = defineType({
     },
     prepare(select) {
       return select.ref
-        ? contextDocumentSchema?.preview?.prepare?.(select) ?? select
+        ? (contextDocumentSchema?.preview?.prepare?.(select) ?? select)
         : {title: 'No reference selected', media: contextDocumentSchema.icon}
     },
   },

package/src/schemas/serialize/serializeSchema.ts

@@ -89,7 +89,7 @@ function getBaseFields(
     options: Object.keys(schemaOptions).length ? schemaOptions : undefined,
     values: Array.isArray(type?.options?.list)
       ? type?.options?.list.map((v: string | {value: string; title: string}) =>
-          typeof v === 'string' ? v : v.value ?? `${v.title}`,
+          typeof v === 'string' ? v : (v.value ?? `${v.title}`),
         )
       : undefined,
     of: 'of' in type && typeName === 'array' ? arrayOf(type, schema, options) : undefined,
@@ -156,7 +156,7 @@ function serializeMember(
   options: Options | undefined,
 ): SerializedSchemaMember {
   const typeNameExists = !!schema.get(type?.name)
-  const typeName = typeNameExists ? type.name : type.type?.name ?? ''
+  const typeName = typeNameExists ? type.name : (type.type?.name ?? '')
   return removeUndef({
     ...(options?.leanFormat ? {} : {_type: assistSerializedFieldTypeName}),
     name: name,