@sanity/assist 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "You create the instructions; Sanity AI Assist does the rest.",
   "keywords": [
     "sanity",
@@ -70,7 +70,7 @@
     "@rollup/plugin-image": "^3.0.3",
     "@sanity/pkg-utils": "^2.4.10",
     "@sanity/plugin-kit": "^3.1.10",
-    "@sanity/semantic-release-preset": "^4.1.6",
+    "@sanity/semantic-release-preset": "^4.1.7",
     "@types/react": "^18.2.37",
     "@types/styled-components": "^5.1.30",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
@@ -87,7 +87,7 @@
     "react-dom": "^18.2.0",
     "rimraf": "^5.0.5",
     "sanity": "^3.28.0",
-    "semantic-release": "^21.1.2",
+    "semantic-release": "^23.0.2",
     "styled-components": "^6.1.1",
     "typescript": "^5.3.3",
     "vitest": "^1.2.1"

package/src/assistDocument/components/AssistDocumentForm.tsx

@@ -6,6 +6,7 @@ import {
   documentRootKey,
   fieldPathParam,
   instructionParam,
+  StudioInstruction,
 } from '../../types'
 import {createContext, useContext, useEffect, useMemo, useRef} from 'react'
 import {
@@ -16,6 +17,7 @@ import {
   KeyedSegment,
   ObjectInputProps,
   ObjectSchemaType,
+  PatchEvent,
   Path,
   SchemaType,
   set,
@@ -30,6 +32,7 @@ import {useAiPaneRouter} from '../../assistInspector/helpers'
 import {SelectedFieldContextProvider, SelectedFieldContextValue} from './SelectedFieldContext'
 import {Card, Stack, Text} from '@sanity/ui'
 import {documentTypeFromAiDocumentId} from '../../helpers/ids'
+import {useAiAssistanceConfig} from '../../assistLayout/AiAssistanceConfigContext'
 
 const EMPTY_FIELDS: AssistField[] = []
 
@@ -104,8 +107,6 @@ function AssistDocumentFormEditable(props: ObjectInputProps) {
     }
   }, [title, documentSchema, onChange, id])
 
-  const fieldExists = !!fields?.some((f) => f._key === typePath)
-
   const {onPathOpen, ...formCallbacks} = useFormCallbacks()
 
   const newCallbacks: FormCallbacksValue = useMemo(
@@ -141,7 +142,8 @@ function AssistDocumentFormEditable(props: ObjectInputProps) {
           key={typePath}
           pathKey={typePath}
           activePath={activePath}
-          fieldExists={fieldExists}
+          fields={fields}
+          documentSchema={documentSchema}
           onChange={onChange}
         />
         {instruction && <BackToInstructionListLink />}
@@ -195,36 +197,78 @@ function useSelectedSchema(
 function FieldsInitializer({
   pathKey,
   activePath,
-  fieldExists,
+  fields,
+  documentSchema,
   onChange,
 }: {
   pathKey?: string
   activePath?: Path
-  fieldExists: boolean
+  fields: AssistField[] | undefined
+  documentSchema: ObjectSchemaType | undefined
   onChange: ObjectInputProps['onChange']
 }) {
+  const {
+    config: {__presets: presets},
+  } = useAiAssistanceConfig()
+
+  const existingField = fields?.find((f) => f._key === pathKey)
+  const documentPresets = !!documentSchema?.name && presets?.[documentSchema?.name]
+
+  const missingPresetInstructions = useMemo(() => {
+    if (!documentPresets || !pathKey) {
+      return undefined
+    }
+    const existingInstructions = existingField?.instructions
+    const presetField = documentPresets.fields?.find((f) => f.path === pathKey)
+    return presetField?.instructions?.filter(
+      (i) => !existingInstructions?.some((ei) => ei._key === i._key)
+    )
+  }, [documentPresets, pathKey, existingField])
+
   // need this to not fire onChange twice in React strict mode
   const initialized = useRef(false)
   useEffect(() => {
-    if (initialized.current || fieldExists || activePath || !pathKey) {
+    if (initialized.current || !pathKey) {
+      return
+    }
+    if (existingField && !missingPresetInstructions?.length) {
       return
     }
-    onChange([
-      setIfMissing([], ['fields']),
-      insert(
-        [
-          typed<AssistField>({
-            _key: pathKey,
-            _type: assistFieldTypeName,
-            path: pathKey,
-          }),
-        ],
-        'after',
-        ['fields', -1]
-      ),
-    ])
+
+    let event = PatchEvent.from([setIfMissing([], ['fields'])])
+    if (!existingField) {
+      event = event.append(
+        insert(
+          [
+            typed<AssistField>({
+              _key: pathKey,
+              _type: assistFieldTypeName,
+              path: pathKey,
+            }),
+          ],
+          'after',
+          ['fields', -1]
+        )
+      )
+    }
+    if (missingPresetInstructions?.length) {
+      event = event.append(
+        insert(
+          missingPresetInstructions.map(
+            (preset): StudioInstruction => ({
+              ...preset,
+              _type: 'sanity.assist.instruction',
+              prompt: preset.prompt?.map((p) => ({markDefs: [], ...p})),
+            })
+          ),
+          'after',
+          ['fields', {_key: pathKey}, 'instructions', -1]
+        )
+      )
+    }
+    onChange(event)
     initialized.current = true
-  }, [activePath, onChange, pathKey, fieldExists])
+  }, [activePath, onChange, pathKey, existingField, missingPresetInstructions])
 
   return null
 }

package/src/components/ImageContext.tsx

@@ -2,7 +2,7 @@ import {createContext, useEffect, useMemo, useState} from 'react'
 import {InputProps, pathToString, useSyncState} from 'sanity'
 import {getDescriptionFieldOption, getImageInstructionFieldOption} from '../helpers/typeUtils'
 import {useAssistDocumentContext} from '../assistDocument/AssistDocumentContext'
-import {useApiClient, useGenerateCaption} from '../useApiClient'
+import {canUseAssist, useApiClient, useGenerateCaption} from '../useApiClient'
 import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
 import {publicId} from '../helpers/ids'
 
@@ -20,7 +20,7 @@ export function ImageContextProvider(props: InputProps) {
   const [assetRefState, setAssetRefState] = useState<string | undefined>(assetRef)
 
   const {documentId, documentSchemaType} = useAssistDocumentContext()
-  const {config} = useAiAssistanceConfig()
+  const {config, status} = useAiAssistanceConfig()
   const apiClient = useApiClient(config?.__customApiClient)
   const {generateCaption} = useGenerateCaption(apiClient)
 
@@ -28,11 +28,18 @@ export function ImageContextProvider(props: InputProps) {
 
   useEffect(() => {
     const descriptionField = getDescriptionFieldOption(schemaType)
-    if (assetRef && documentId && descriptionField && assetRef !== assetRefState && !isSyncing) {
+    if (
+      assetRef &&
+      documentId &&
+      descriptionField &&
+      assetRef !== assetRefState &&
+      !isSyncing &&
+      canUseAssist(status)
+    ) {
       setAssetRefState(assetRef)
       generateCaption({path: pathToString([...path, descriptionField]), documentId: documentId})
     }
-  }, [schemaType, path, assetRef, assetRefState, documentId, generateCaption, isSyncing])
+  }, [schemaType, path, assetRef, assetRefState, documentId, generateCaption, isSyncing, status])
 
   const context: ImageContextValue = useMemo(() => {
     const descriptionField = getDescriptionFieldOption(schemaType)

package/src/fieldActions/generateCaptionActions.tsx

@@ -2,11 +2,14 @@ import {DocumentFieldAction, DocumentFieldActionGroup, DocumentFieldActionItem}
 import {ImageIcon} from '@sanity/icons'
 import {useContext, useMemo} from 'react'
 import {usePathKey} from '../helpers/misc'
-import {useApiClient, useGenerateCaption} from '../useApiClient'
+import {canUseAssist, useApiClient, useGenerateCaption} from '../useApiClient'
 import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
 import {useAssistDocumentContext} from '../assistDocument/AssistDocumentContext'
 import {ImageContext} from '../components/ImageContext'
 import {Box, Spinner} from '@sanity/ui'
+import {useDocumentPane} from 'sanity/desk'
+import {aiInspectorId} from '../assistInspector/constants'
+import {fieldPathParam, instructionParam} from '../types'
 
 function node(node: DocumentFieldActionItem | DocumentFieldActionGroup) {
   return node
@@ -16,11 +19,11 @@ export const generateCaptionsActions: DocumentFieldAction = {
   name: 'sanity-assist-generate-captions',
   useAction(props) {
     const pathKey = usePathKey(props.path)
+    const {openInspector} = useDocumentPane()
 
-    const {config} = useAiAssistanceConfig()
+    const {config, status} = useAiAssistanceConfig()
     const apiClient = useApiClient(config?.__customApiClient)
     const {generateCaption, loading} = useGenerateCaption(apiClient)
-
     const imageContext = useContext(ImageContext)
 
     if (imageContext && pathKey === imageContext?.imageDescriptionPath) {
@@ -43,13 +46,21 @@ export const generateCaptionsActions: DocumentFieldAction = {
             if (loading) {
               return
             }
+            if (!canUseAssist(status)) {
+              openInspector(aiInspectorId, {
+                [fieldPathParam]: pathKey,
+                [instructionParam]: undefined as any,
+              })
+              return
+            }
+
             generateCaption({path: pathKey, documentId: documentId ?? ''})
           },
           renderAsButton: true,
           disabled: loading,
           hidden: !imageContext.assetRef,
         })
-      }, [generateCaption, pathKey, documentId, loading, imageContext])
+      }, [generateCaption, pathKey, documentId, loading, imageContext, status, openInspector])
     }
 
     // works but not supported by types

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/plugin.tsx

@@ -16,7 +16,7 @@ import {isSchemaAssistEnabled} from './helpers/assistSupported'
 import {isImage} from './helpers/typeUtils'
 import {ImageContextProvider} from './components/ImageContext'
 import {TranslationConfig} from './translate/types'
-import {assistDocumentTypeName} from './types'
+import {assistDocumentTypeName, AssistPreset} from './types'
 
 export interface AssistPluginConfig {
   translate?: TranslationConfig
@@ -25,6 +25,11 @@ export interface AssistPluginConfig {
    * @internal
    */
   __customApiClient?: (defaultClient: SanityClient) => SanityClient
+
+  /**
+   * @internal
+   */
+  __presets?: Record<string, AssistPreset>
 }
 
 export const assist = definePlugin<AssistPluginConfig | void>((config) => {

package/src/types.ts

@@ -68,14 +68,42 @@ export interface AssistDocument extends SanityDocument {
   instructions?: StudioInstruction[]
 }
 
-export interface StudioAssistDocument {
+export interface PresetInstruction {
+  _key: string
+  prompt?: PromptTextBlock[]
+
+  title?: string
+  /**
+   * String key from @sanity/icons IconMap
+   */
+  icon?: string
+
+  /**
+   * Type/field filter
+   */
+  output?: (OutputFieldItem | OutputTypeItem)[]
+}
+
+export interface PresetField {
+  path?: string
+  instructions?: PresetInstruction[]
+}
+
+export interface AssistPreset {
+  fields?: PresetField[]
+}
+
+export interface SanityAssistDocument {
   _id: string
   _type: typeof assistDocumentTypeName
   fields?: StudioAssistField[]
+}
 
-  // added
+export interface StudioAssistDocument extends SanityAssistDocument {
+  // added after loading
   tasks?: InstructionTask[]
 }
+
 export interface AssistField {
   _key: string
   _type: typeof assistFieldTypeName
@@ -113,7 +141,10 @@ export interface UserInputBlock {
 }
 
 export type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock | ContextBlock
-export type PromptTextBlock = PortableTextBlock<never, InlinePromptBlock, 'normal', never>
+export type PromptTextBlock = Omit<
+  PortableTextBlock<never, InlinePromptBlock, 'normal', never>,
+  '_type'
+> & {_type: 'block'}
 
 export type PromptBlock = PromptTextBlock | FieldRef | ContextBlock | UserInputBlock
 

package/src/useApiClient.ts

@@ -39,6 +39,10 @@ export interface TranslateRequest {
 
 const basePath = '/assist/tasks/instruction'
 
+export function canUseAssist(status: InstructStatus | undefined) {
+  return status?.enabled && status.initialized && status.validToken
+}
+
 export function useApiClient(customApiClient?: (defaultClient: SanityClient) => SanityClient) {
   const client = useClient({apiVersion: '2023-06-05'})
   return useMemo(