@sanity/assist 2.0.4 → 3.0.0

package/src/assistInspector/AssistInspector.tsx

@@ -2,36 +2,43 @@ import {ArrowRightIcon, CloseIcon, PlayIcon, RetryIcon} from '@sanity/icons'
 import {Box, Button, Card, Flex, Spinner, Stack, Text} from '@sanity/ui'
 import {useCallback, useMemo, useRef} from 'react'
 import {
-  DocumentInspectorProps,
+  type DocumentInspectorProps,
   PresenceOverlay,
   useEditState,
   VirtualizerScrollInstanceProvider,
 } from 'sanity'
 import {
   DocumentInspectorHeader,
-  DocumentPaneNode,
+  type DocumentPaneNode,
   DocumentPaneProvider,
   useDocumentPane,
-} from 'sanity/desk'
+} from 'sanity/structure'
+import {styled} from 'styled-components'
+
 import {DocumentForm} from '../_lib/form'
-import {assistDocumentTypeName, fieldPathParam, instructionParam} from '../types'
-import {FieldRef, getFieldTitle, useAiPaneRouter, useSelectedField, useTypePath} from './helpers'
-import styled from 'styled-components'
+import {TypePathContext} from '../assistDocument/components/AssistDocumentForm'
 import {useStudioAssistDocument} from '../assistDocument/hooks/useStudioAssistDocument'
-import {InstructionTaskHistoryButton} from './InstructionTaskHistoryButton'
-import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
-import {giveFeedbackUrl, pluginTitle, releaseAnnouncementUrl, salesUrl} from '../constants'
-import {assistDocumentId} from '../helpers/ids'
 import {
   getAssistableDocId,
   isDocAssistable,
   useRequestRunInstruction,
 } from '../assistDocument/RequestRunInstructionProvider'
+import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
+import {giveFeedbackUrl, pluginTitle, releaseAnnouncementUrl, salesUrl} from '../constants'
+import {getConditionalMembers} from '../helpers/conditionalMembers'
+import {assistDocumentId} from '../helpers/ids'
 import {InspectorOnboarding} from '../onboarding/InspectorOnboarding'
 import {inspectorOnboardingKey, useOnboardingFeature} from '../onboarding/onboardingStore'
-import {TypePathContext} from '../assistDocument/components/AssistDocumentForm'
+import {assistDocumentTypeName, fieldPathParam, instructionParam} from '../types'
 import {FieldTitle} from './FieldAutocomplete'
-import {getConditionalMembers} from '../helpers/conditionalMembers'
+import {
+  type FieldRef,
+  getFieldTitle,
+  useAiPaneRouter,
+  useSelectedField,
+  useTypePath,
+} from './helpers'
+import {InstructionTaskHistoryButton} from './InstructionTaskHistoryButton'
 
 const CardWithShadowBelow = styled(Card)`
   position: relative;
@@ -172,8 +179,8 @@ export function AssistInspectorWrapper(props: DocumentInspectorProps) {
               context.error
                 ? 'Retry'
                 : status?.initialized && !status.validToken
-                ? `Restore ${pluginTitle}`
-                : `Enable ${pluginTitle} now`
+                  ? `Restore ${pluginTitle}`
+                  : `Enable ${pluginTitle} now`
             }
             tone="primary"
             onClick={context.init}
@@ -224,11 +231,11 @@ export function AssistInspector(props: DocumentInspectorProps) {
   const tasks = useMemo(
     () =>
       assistDocument?.tasks?.filter((i) => !instructionKey || i.instructionKey === instructionKey),
-    [assistDocument?.tasks, instructionKey]
+    [assistDocument?.tasks, instructionKey],
   )
   const instructions = useMemo(
     () => assistDocument?.fields?.flatMap((f) => f.instructions ?? []),
-    [assistDocument?.fields]
+    [assistDocument?.fields],
   )
 
   const promptValue = instruction?.prompt
@@ -252,7 +259,7 @@ export function AssistInspector(props: DocumentInspectorProps) {
         type: assistDocumentTypeName,
       },
     }),
-    [aiDocId]
+    [aiDocId],
   )
 
   const runCurrentInstruction = useCallback(
@@ -268,7 +275,7 @@ export function AssistInspector(props: DocumentInspectorProps) {
         instruction,
         conditionalMembers: formStateRef.current ? getConditionalMembers(formStateRef.current) : [],
       }),
-    [pathKey, instruction, typePath, documentType, assistableDocId, requestRunInstruction]
+    [pathKey, instruction, typePath, documentType, assistableDocId, requestRunInstruction],
   )
 
   const Region = useCallback((_props: any) => {

package/src/assistInspector/FieldAutocomplete.tsx

@@ -1,9 +1,10 @@
 import {SearchIcon} from '@sanity/icons'
 import {Autocomplete, Box, Breadcrumbs, Card, Flex, Text} from '@sanity/ui'
 import {createElement, useCallback, useMemo} from 'react'
-import {FieldRef, getFieldRefs, getFieldRefsWithDocument} from './helpers'
 import {ObjectSchemaType} from 'sanity'
+
 import {isType} from '../helpers/typeUtils'
+import {FieldRef, getFieldRefs, getFieldRefsWithDocument} from './helpers'
 
 interface FieldSelectorProps {
   id: string
@@ -25,7 +26,7 @@ export function FieldAutocomplete(props: FieldSelectorProps) {
   }, [schemaType, includeDocument])
   const currentField = useMemo(
     () => fieldRefs.find((f) => f.key === fieldPath),
-    [fieldPath, fieldRefs]
+    [fieldPath, fieldRefs],
   )
 
   const autocompleteOptions = useMemo(
@@ -34,7 +35,7 @@ export function FieldAutocomplete(props: FieldSelectorProps) {
         .filter((field) => (filter ? filter(field) : true))
         .filter((f) => !isType(f.schemaType, 'reference'))
         .map((field) => ({value: field.key, field})),
-    [fieldRefs, filter]
+    [fieldRefs, filter],
   )
 
   const renderOption = useCallback((option: {value: string; field: FieldRef}) => {

package/src/assistInspector/InstructionTaskHistoryButton.tsx

@@ -1,5 +1,10 @@
-import {AssistTasksStatus, InstructionTask, StudioInstruction, TaskEndedReason} from '../types'
-import {createElement, ForwardedRef, forwardRef, useCallback, useMemo, useState} from 'react'
+import {
+  CheckmarkCircleIcon,
+  ClockIcon,
+  CloseCircleIcon,
+  ErrorOutlineIcon,
+  SyncIcon,
+} from '@sanity/icons'
 import {
   Box,
   Button,
@@ -13,19 +18,15 @@ import {
   useGlobalKeyDown,
   useLayer,
 } from '@sanity/ui'
-import {
-  CheckmarkCircleIcon,
-  ClockIcon,
-  CloseCircleIcon,
-  ErrorOutlineIcon,
-  SyncIcon,
-} from '@sanity/icons'
+import {createElement, type ForwardedRef, forwardRef, useCallback, useMemo, useState} from 'react'
+import {StatusButton, type StatusButtonProps, typed, useClient} from 'sanity'
+import {keyframes, styled} from 'styled-components'
+
 import {TimeAgo} from '../components/TimeAgo'
-import {StatusButton, StatusButtonProps, typed, useClient} from 'sanity'
-import {getInstructionTitle} from '../helpers/misc'
-import styled, {keyframes} from 'styled-components'
-import {assistTasksStatusId} from '../helpers/ids'
 import {maxHistoryVisibilityMs, pluginTitle} from '../constants'
+import {assistTasksStatusId} from '../helpers/ids'
+import {getInstructionTitle} from '../helpers/misc'
+import type {AssistTasksStatus, InstructionTask, StudioInstruction, TaskEndedReason} from '../types'
 
 export interface InstructionTaskHistoryButtonProps {
   documentId?: string
@@ -96,7 +97,7 @@ export function InstructionTaskHistoryButton(props: InstructionTaskHistoryButton
         .commit()
         .catch(console.error)
     },
-    [client, documentId]
+    [client, documentId],
   )
 
   const titledTasks = useMemo(() => {
@@ -105,7 +106,7 @@ export function InstructionTaskHistoryButton(props: InstructionTaskHistoryButton
         ?.filter(
           (task) =>
             task.started &&
-            new Date().getTime() - new Date(task.started).getTime() < maxHistoryVisibilityMs
+            new Date().getTime() - new Date(task.started).getTime() < maxHistoryVisibilityMs,
         )
         .map((task): CancelableInstructionTask => {
           const instruction = instructions?.find((i) => i._key === task.instructionKey)
@@ -124,7 +125,7 @@ export function InstructionTaskHistoryButton(props: InstructionTaskHistoryButton
   const isRunning = useMemo(() => titledTasks.some((r) => !r.ended), [titledTasks])
   const hasErrors = useMemo(
     () => titledTasks.some((r) => r.reason === 'error' || r.reason === 'timeout'),
-    [titledTasks]
+    [titledTasks],
   )
 
   const [open, setOpen] = useState(false)
@@ -179,7 +180,7 @@ const TaskStatusButton = forwardRef(function TaskStatusButton(
     onClick: () => void
     selected: boolean
   },
-  ref: ForwardedRef<HTMLButtonElement>
+  ref: ForwardedRef<HTMLButtonElement>,
 ) {
   const {disabled, hasErrors, isRunning, onClick, selected} = props
 
@@ -210,8 +211,8 @@ function TaskList(props: {onEscape: () => void; tasks: CancelableInstructionTask
           onEscape()
         }
       },
-      [isTopLayer, onEscape]
-    )
+      [isTopLayer, onEscape],
+    ),
   )
 
   return (

package/src/assistInspector/helpers.ts

@@ -7,24 +7,25 @@ import {
   OlistIcon,
   StringIcon,
 } from '@sanity/icons'
+import {extractWithPath} from '@sanity/mutator'
+import {type ComponentType, useContext, useMemo} from 'react'
 import {
-  ArraySchemaType,
+  type ArraySchemaType,
   isKeySegment,
   isObjectSchemaType,
-  ObjectSchemaType,
-  Path,
+  type ObjectSchemaType,
+  type Path,
   pathToString,
-  SanityDocumentLike,
-  SchemaType,
+  type SanityDocumentLike,
+  type SchemaType,
   stringToPath,
 } from 'sanity'
-import {ComponentType, useContext, useMemo} from 'react'
-import {AssistInspectorRouteParams, documentRootKey, fieldPathParam} from '../types'
-import {type PaneRouterContextValue, usePaneRouter} from 'sanity/desk'
+import {type PaneRouterContextValue, usePaneRouter} from 'sanity/structure'
+
+import {SelectedFieldContext} from '../assistDocument/components/SelectedFieldContext'
 import {isAssistSupported} from '../helpers/assistSupported'
 import {isPortableTextArray, isType} from '../helpers/typeUtils'
-import {SelectedFieldContext} from '../assistDocument/components/SelectedFieldContext'
-import {extractWithPath} from '@sanity/mutator'
+import {type AssistInspectorRouteParams, documentRootKey, fieldPathParam} from '../types'
 
 export interface FieldRef {
   key: string
@@ -74,7 +75,7 @@ export function getFieldRefsWithDocument(schemaType: ObjectSchemaType): FieldRef
 export function getFieldRefs(
   schemaType: ObjectSchemaType,
   parent?: FieldRef,
-  depth = 0
+  depth = 0,
 ): FieldRef[] {
   if (depth >= maxDepth) {
     return []
@@ -171,14 +172,14 @@ export function useTypePath(doc: SanityDocumentLike, pathString: string) {
 
 export function useSelectedField(
   documentSchemaType?: SchemaType,
-  path?: string
+  path?: string,
 ): FieldRef | undefined {
   const selectableFields = useMemo(
     () =>
       documentSchemaType && isObjectSchemaType(documentSchemaType)
         ? getFieldRefsWithDocument(documentSchemaType)
         : [],
-    [documentSchemaType]
+    [documentSchemaType],
   )
 
   return useMemo(() => {
@@ -207,7 +208,7 @@ export function useAiPaneRouter() {
   const paneRouter = usePaneRouter()
 
   return useMemo(
-    () => ({...paneRouter, params: paneRouter.params ?? {}} as AiPaneRouter),
-    [paneRouter]
+    () => ({...paneRouter, params: paneRouter.params ?? {}}) as AiPaneRouter,
+    [paneRouter],
   )
 }

package/src/assistInspector/index.ts

@@ -1,9 +1,10 @@
 import {SparklesIcon} from '@sanity/icons'
 import {DocumentInspector, typed} from 'sanity'
-import {aiInspectorId} from './constants'
-import {AssistInspectorWrapper} from './AssistInspector'
-import {AssistInspectorRouteParams, fieldPathParam, instructionParam} from '../types'
+
 import {pluginTitle} from '../constants'
+import {AssistInspectorRouteParams, fieldPathParam, instructionParam} from '../types'
+import {AssistInspectorWrapper} from './AssistInspector'
+import {aiInspectorId} from './constants'
 
 export const assistInspector: DocumentInspector = {
   name: aiInspectorId,

package/src/assistLayout/AiAssistanceConfigContext.tsx

@@ -7,6 +7,7 @@ import {
   useMemo,
   useState,
 } from 'react'
+
 import {AssistPluginConfig} from '../plugin'
 import {InstructStatus, useApiClient, useGetInstructStatus, useInitInstruct} from '../useApiClient'
 

package/src/assistLayout/AssistLayout.tsx

@@ -1,14 +1,15 @@
+import {ThemeProvider} from '@sanity/ui'
 import {useState} from 'react'
 import {LayoutProps} from 'sanity'
+
 import {Connector, ConnectorsProvider} from '../_lib/connector'
 import {AssistConnectorsOverlay} from '../assistConnectors'
 import {AssistPluginConfig} from '../plugin'
-import {AiAssistanceConfigProvider} from './AiAssistanceConfigContext'
-import {RunInstructionRequest} from '../useApiClient'
+import {FieldTranslationProvider} from '../translate/FieldTranslationProvider'
 import {StudioInstruction} from '../types'
+import {RunInstructionRequest} from '../useApiClient'
+import {AiAssistanceConfigProvider} from './AiAssistanceConfigContext'
 import {RunInstructionProvider} from './RunInstructionProvider'
-import {ThemeProvider} from '@sanity/ui'
-import {FieldTranslationProvider} from '../translate/FieldTranslationProvider'
 
 export interface AIStudioLayoutProps extends LayoutProps {
   config: AssistPluginConfig

package/src/assistLayout/RunInstructionProvider.tsx

@@ -1,12 +1,11 @@
-import {Button, Dialog, Flex, Stack, Text, TextArea, Tooltip} from '@sanity/ui'
-import {getInstructionTitle} from '../helpers/misc'
 import {PlayIcon} from '@sanity/icons'
+import {Button, Dialog, Flex, Stack, Text, TextArea, Tooltip} from '@sanity/ui'
 import {
   createContext,
-  Dispatch,
-  FormEvent,
-  PropsWithChildren,
-  SetStateAction,
+  type Dispatch,
+  type FormEvent,
+  type PropsWithChildren,
+  type SetStateAction,
   useCallback,
   useContext,
   useEffect,
@@ -15,11 +14,13 @@ import {
   useRef,
   useState,
 } from 'react'
-import {UserInputBlock, userInputTypeName} from '../types'
-import {RunInstructionArgs} from './AssistLayout'
+import {FormFieldHeaderText} from 'sanity'
+
+import {getInstructionTitle} from '../helpers/misc'
+import {type UserInputBlock, userInputTypeName} from '../types'
 import {useApiClient, useRunInstructionApi} from '../useApiClient'
 import {useAiAssistanceConfig} from './AiAssistanceConfigContext'
-import {FormFieldHeaderText} from 'sanity'
+import type {RunInstructionArgs} from './AssistLayout'
 
 type BlockInputs = Record<string, string>
 const NO_INPUT: BlockInputs = {}
@@ -42,6 +43,7 @@ function isUserInputBlock(block: {_type: string}): block is UserInputBlock {
   return block._type === userInputTypeName
 }
 
+// eslint-disable-next-line @typescript-eslint/ban-types
 export function RunInstructionProvider(props: PropsWithChildren<{}>) {
   const {config} = useAiAssistanceConfig()
   const apiClient = useApiClient(config?.__customApiClient)
@@ -63,7 +65,7 @@ export function RunInstructionProvider(props: PropsWithChildren<{}>) {
       const instructionKey = instruction._key
       const userInputBlocks = instruction?.prompt
         ?.flatMap((block) =>
-          block._type === 'block' ? block.children.filter(isUserInputBlock) : [block]
+          block._type === 'block' ? block.children.filter(isUserInputBlock) : [block],
         )
         .filter(isUserInputBlock)
 
@@ -81,16 +83,17 @@ export function RunInstructionProvider(props: PropsWithChildren<{}>) {
         userInputBlocks,
       })
     },
-    [setRunRequest, runInstructionRequest, loading]
+    [runInstructionRequest, loading],
   )
 
   const close = useCallback(() => {
     setRunRequest(undefined)
     setInputs(NO_INPUT)
-  }, [setRunRequest, setInputs])
+  }, [])
 
   const runWithInput = useCallback(() => {
     if (runRequest) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const {instruction, userTexts, ...request} = runRequest
       runInstructionRequest({
         ...request,
@@ -110,7 +113,7 @@ export function RunInstructionProvider(props: PropsWithChildren<{}>) {
     () =>
       (runRequest?.userInputBlocks?.length ?? 0) >
       Object.entries(inputs).filter(([, value]) => !!value).length,
-    [runRequest?.userInputBlocks, inputs]
+    [runRequest?.userInputBlocks, inputs],
   )
 
   const runButton = (
@@ -126,7 +129,7 @@ export function RunInstructionProvider(props: PropsWithChildren<{}>) {
 
   const contextValue: RunInstructionContextValue = useMemo(
     () => ({runInstruction, instructionLoading: loading}),
-    [runInstruction, loading]
+    [runInstruction, loading],
   )
 
   return (
@@ -192,7 +195,7 @@ function UserInput(props: {
         [key]: (e.currentTarget ?? e.target).value,
       }))
     },
-    [key, setInputs]
+    [key, setInputs],
   )
 
   const value = useMemo(() => inputs[key], [inputs, key])

package/src/components/FadeInContent.tsx

@@ -1,5 +1,5 @@
-import {forwardRef, ReactElement, ReactNode} from 'react'
-import styled, {keyframes} from 'styled-components'
+import {forwardRef, type ReactElement, type ReactNode} from 'react'
+import {keyframes, styled} from 'styled-components'
 
 const fadeIn = keyframes`
   0% {
@@ -30,7 +30,7 @@ export const FadeInContent = forwardRef(function FadeInContent(
     ms?: number
     durationMs?: number
   },
-  ref: any
+  ref: any,
 ): ReactElement {
   return (
     <FadeInDiv ref={ref} style={{animationDuration: `${durationMs}ms`}}>

package/src/components/HideReferenceChangedBannerInput.tsx

@@ -1,6 +1,6 @@
-import {ObjectInputProps} from 'sanity'
 import {Box} from '@sanity/ui'
 import {useEffect, useRef} from 'react'
+import {ObjectInputProps} from 'sanity'
 
 export function HideReferenceChangedBannerInput(props: ObjectInputProps) {
   const ref = useRef<HTMLDivElement>(null)

package/src/components/ImageContext.tsx

@@ -1,11 +1,12 @@
 import {createContext, useEffect, useMemo, useState} from 'react'
-import {InputProps, pathToString, useSyncState} from 'sanity'
-import {getDescriptionFieldOption, getImageInstructionFieldOption} from '../helpers/typeUtils'
+import {type InputProps, pathToString, useSyncState} from 'sanity'
+import {usePaneRouter} from 'sanity/structure'
+
 import {useAssistDocumentContext} from '../assistDocument/AssistDocumentContext'
-import {canUseAssist, useApiClient, useGenerateCaption} from '../useApiClient'
 import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
 import {publicId} from '../helpers/ids'
-import {usePaneRouter} from 'sanity/desk'
+import {getDescriptionFieldOption, getImageInstructionFieldOption} from '../helpers/typeUtils'
+import {canUseAssist, useApiClient, useGenerateCaption} from '../useApiClient'
 
 export interface ImageContextValue {
   imageDescriptionPath?: string

package/src/components/SafeValueInput.tsx

@@ -1,8 +1,9 @@
-import {InputProps, isArraySchemaType, PatchEvent, unset} from 'sanity'
-import {ErrorInfo, PropsWithChildren, useCallback, useMemo, useState} from 'react'
 import {Box, Button, Card, ErrorBoundary, Flex, Stack, Text} from '@sanity/ui'
+import {type ErrorInfo, type PropsWithChildren, useCallback, useMemo, useState} from 'react'
+import {type InputProps, isArraySchemaType, PatchEvent, unset} from 'sanity'
+import {styled} from 'styled-components'
+
 import {isPortableTextArray} from '../helpers/typeUtils'
-import styled from 'styled-components'
 
 const WrapPreCard = styled(Card)`
   & pre {
@@ -19,17 +20,14 @@ export function SafeValueInput(props: InputProps) {
 }
 
 export function ErrorWrapper(
-  props: PropsWithChildren<{onChange: (patchEvent: PatchEvent) => void}>
+  props: PropsWithChildren<{onChange: (patchEvent: PatchEvent) => void}>,
 ) {
   const {onChange} = props
   const [error, setError] = useState<Error | undefined>()
 
-  const catchError = useCallback(
-    (params: {error: Error; info: ErrorInfo}) => {
-      setError(params.error)
-    },
-    [setError]
-  )
+  const catchError = useCallback((params: {error: Error; info: ErrorInfo}) => {
+    setError(params.error)
+  }, [])
 
   const unsetValue = useCallback(() => {
     onChange(PatchEvent.from(unset()))
@@ -65,7 +63,7 @@ export function ErrorWrapper(
 function PteValueFixer(props: InputProps) {
   const isPortableText = useMemo(
     () => isArraySchemaType(props.schemaType) && isPortableTextArray(props.schemaType),
-    [props.schemaType]
+    [props.schemaType],
   )
   const value = props.value
   if (isPortableText && value && !(value as any[]).length) {

package/src/components/TimeAgo.tsx

@@ -1,5 +1,5 @@
-import {useEffect, useReducer} from 'react'
 import formatDistanceToNow from 'date-fns/formatDistanceToNow'
+import {useEffect, useReducer} from 'react'
 
 function useInterval(ms: number) {
   const [tick, update] = useReducer((n) => n + 1, 0)