@sanity/assist 5.0.3 → 6.0.0

package/src/assistDocument/hooks/useInstructionToaster.tsx

@@ -1,75 +0,0 @@
-import {useToast} from '@sanity/ui'
-import {addSeconds, isAfter} from 'date-fns'
-import {useEffect, useRef} from 'react'
-import {ObjectSchemaType, useCurrentUser} from 'sanity'
-
-import {getInstructionTitle} from '../../helpers/misc'
-import {InstructionTask} from '../../types'
-import {useStudioAssistDocument} from './useStudioAssistDocument'
-
-const NO_TASKS: InstructionTask[] = []
-
-export function useInstructionToaster(documentId: string, documentSchemaType: ObjectSchemaType) {
-  const assistDocument = useStudioAssistDocument({documentId, schemaType: documentSchemaType})
-
-  const assistDocLoaded = !!assistDocument
-  const currentUser = useCurrentUser()
-  const toast = useToast()
-  const tasks = assistDocument?.tasks
-  const previousTasks = useRef<InstructionTask[] | undefined | 'initial'>('initial')
-
-  useEffect(() => {
-    if (!assistDocLoaded) {
-      return
-    }
-
-    if (previousTasks.current !== 'initial') {
-      const prevTaskByKey = Object.fromEntries(
-        (previousTasks.current ?? NO_TASKS).map((run) => [run._key, run]),
-      )
-      const endedTasks = tasks
-        ?.filter((task) => task.startedByUserId === currentUser?.id)
-        .filter((task) => {
-          const prevTask = prevTaskByKey[task._key]
-          return (!prevTask && task.ended) || (!prevTask?.ended && task.ended)
-        })
-        // filter out old stuff
-        .filter((task) => task.ended && isAfter(addSeconds(new Date(task.ended), 30), new Date()))
-
-      endedTasks?.forEach((task) => {
-        const title = task.title ?? getInstructionTitle(task.instruction)
-        if (task.reason === 'error') {
-          toast.push({
-            title: `Failed: ${title}`,
-            status: 'error',
-            description: `Instruction failed. ${task.message ?? ''}`,
-            closable: true,
-            duration: 10000,
-          })
-        } else if (task.reason === 'timeout') {
-          toast.push({
-            title: `Timeout: ${title}`,
-            status: 'error',
-            description: `Instruction timed out.`,
-            closable: true,
-          })
-        } else if (task.reason === 'success') {
-          toast.push({
-            title: `Success: ${title}`,
-            status: 'success',
-            description: `Instruction completed.`,
-            closable: true,
-          })
-        } else if (task.reason === 'aborted') {
-          toast.push({
-            title: `Canceled: ${title}`,
-            status: 'warning',
-            description: `Instruction canceled.`,
-            closable: true,
-          })
-        }
-      })
-    }
-    previousTasks.current = tasks
-  }, [tasks, previousTasks, toast, currentUser, assistDocLoaded])
-}

package/src/assistDocument/hooks/useStudioAssistDocument.ts

@@ -1,99 +0,0 @@
-import {useEffect, useMemo} from 'react'
-import {type ObjectSchemaType, typed, useClient, useCurrentUser} from 'sanity'
-
-import {maxHistoryVisibilityMs} from '../../constants'
-import {assistDocumentId, assistTasksStatusId} from '../../helpers/ids'
-import {
-  assistDocumentTypeName,
-  type AssistTasksStatus,
-  assistTasksStatusTypeName,
-  type InstructionTask,
-  type StudioAssistDocument,
-  type StudioAssistField,
-  type StudioInstruction,
-} from '../../types'
-import {useDocumentState} from './useDocumentState'
-
-interface UseAssistDocumentProps {
-  documentId: string
-  schemaType: ObjectSchemaType
-  initDoc?: boolean
-}
-
-export function useStudioAssistDocument({
-  documentId,
-  schemaType,
-  initDoc,
-}: UseAssistDocumentProps): StudioAssistDocument | undefined {
-  const documentTypeName = schemaType.name
-  const currentUser = useCurrentUser()
-
-  const assistDocument = useDocumentState<StudioAssistDocument>(
-    assistDocumentId(documentTypeName),
-    assistDocumentTypeName,
-  )
-  const assistTasksStatus = useDocumentState<AssistTasksStatus>(
-    assistTasksStatusId(documentId ?? ''),
-    assistTasksStatusTypeName,
-  )
-
-  const client = useClient({apiVersion: '2023-01-01'})
-
-  useEffect(() => {
-    if (!assistDocument && initDoc) {
-      client
-        .createIfNotExists({
-          _id: assistDocumentId(documentTypeName),
-          _type: assistDocumentTypeName,
-        })
-        .catch(() => {
-          // best effort
-        })
-    }
-  }, [client, assistDocument, documentTypeName, initDoc])
-
-  return useMemo(() => {
-    if (!assistDocument) {
-      return undefined
-    }
-    const tasks = assistTasksStatus?.tasks ?? []
-    const fields = (assistDocument?.fields ?? []).map((assistField): StudioAssistField => {
-      return {
-        ...assistField,
-        tasks: tasks.filter((task) => task.path === assistField.path),
-        instructions: assistField.instructions
-          ?.filter((p) => !p.userId || p.userId === currentUser?.id)
-          .map((instruction) => asStudioInstruction(instruction, tasks)),
-      }
-    })
-    return typed<StudioAssistDocument>({
-      ...assistDocument,
-      tasks: tasks?.map((task) => {
-        const instruction = fields
-          .find((f) => f.path === task.path)
-          ?.instructions?.find((i) => i._key === task.instructionKey)
-        return {
-          ...task,
-          instruction,
-        }
-      }),
-      fields: fields,
-    })
-  }, [assistDocument, assistTasksStatus, currentUser])
-}
-
-function asStudioInstruction(
-  instruction: StudioInstruction,
-  run: InstructionTask[],
-): StudioInstruction {
-  return {
-    ...instruction,
-    tasks: run
-      .filter((task) => task.instructionKey === instruction._key)
-      .filter(
-        (task) =>
-          task.started &&
-          new Date().getTime() - new Date(task.started).getTime() < maxHistoryVisibilityMs,
-      ),
-  }
-}

package/src/assistDocument/index.ts

@@ -1 +0,0 @@
-export * from './AssistDocumentContextProvider'

package/src/assistFormComponents/AssistField.tsx

@@ -1,63 +0,0 @@
-import {Box, Flex} from '@sanity/ui'
-import {useMemo} from 'react'
-import {FieldProps, isArraySchemaType} from 'sanity'
-
-import {assistFormId} from '../_lib/form/constants'
-import {isAssistSupported} from '../helpers/assistSupported'
-import {isPortableTextArray, isType} from '../helpers/typeUtils'
-import {AiFieldPresence} from '../presence/AiFieldPresence'
-import {useAssistPresence} from '../presence/useAssistPresence'
-import {contextDocumentTypeName} from '../types'
-
-export function AssistFieldWrapper(props: FieldProps) {
-  const {schemaType} = props
-
-  const isSupported = useMemo(() => isAssistSupported(schemaType), [schemaType])
-
-  if (
-    !isSupported ||
-    schemaType.name.startsWith('sanity.') ||
-    schemaType.name === contextDocumentTypeName
-  ) {
-    return props.renderDefault(props)
-  }
-  if (
-    !isType(props.schemaType, 'document') &&
-    props.inputId !== 'root' &&
-    props.inputId !== assistFormId
-  ) {
-    return <AssistField {...props}>{props.children}</AssistField>
-  }
-
-  return props.renderDefault(props)
-}
-
-export function AssistField(props: FieldProps) {
-  const isPortableText = useMemo(
-    () => !!(isArraySchemaType(props.schemaType) && isPortableTextArray(props.schemaType)),
-    [props.schemaType],
-  )
-
-  const presence = useAssistPresence(props.path, isPortableText)
-  const singlePresence = presence[0]
-
-  const actions = (
-    <Flex gap={2} align="center" justify="space-between">
-      {singlePresence && (
-        <Box>
-          <AiFieldPresence presence={singlePresence} />
-        </Box>
-      )}
-    </Flex>
-  )
-
-  return props.renderDefault({
-    ...props,
-
-    actions: props.actions,
-
-    // Render presence in the internal slot (between presence and the field actions)
-    // eslint-disable-next-line camelcase
-    __internal_slot: actions,
-  })
-}

package/src/assistFormComponents/AssistFormBlock.tsx

@@ -1,31 +0,0 @@
-import {Box, Flex} from '@sanity/ui'
-import {useCallback} from 'react'
-import {BlockProps, PatchEvent, useFormCallbacks} from 'sanity'
-
-import {ErrorWrapper} from '../components/SafeValueInput'
-import {AiFieldPresence} from '../presence/AiFieldPresence'
-import {useAssistPresence} from '../presence/useAssistPresence'
-
-export function AssistFormBlock(props: BlockProps) {
-  const presence = useAssistPresence(props.path, true)
-  const {onChange} = useFormCallbacks()
-  const key = props.value._key
-  const localOnChange = useCallback(
-    (patchEvent: PatchEvent) => {
-      if (!key) {
-        return
-      }
-      onChange(PatchEvent.from(patchEvent).prefixAll({_key: key}))
-    },
-    [onChange, key],
-  )
-  const singlePresence = presence[0]
-  return (
-    <ErrorWrapper onChange={localOnChange}>
-      <Flex align="center" justify="space-between">
-        <Box flex={1}>{props.renderDefault(props)}</Box>
-        {singlePresence && <AiFieldPresence presence={singlePresence} />}
-      </Flex>
-    </ErrorWrapper>
-  )
-}

package/src/assistFormComponents/AssistInlineFormBlock.tsx

@@ -1,13 +0,0 @@
-import {createContext} from 'react'
-import {BlockProps} from 'sanity'
-
-// workaround for preview value sometimes lagging behind
-export const InlineBlockValueContext = createContext<unknown>(undefined)
-
-export function AssistInlineFormBlock(props: BlockProps) {
-  return (
-    <InlineBlockValueContext.Provider value={props.value}>
-      <>{props.renderDefault(props)}</>
-    </InlineBlockValueContext.Provider>
-  )
-}

package/src/assistFormComponents/AssistItem.tsx

@@ -1,21 +0,0 @@
-import {Box, Flex} from '@sanity/ui'
-import {ItemProps} from 'sanity'
-
-import {AiFieldPresence} from '../presence/AiFieldPresence'
-import {useAssistPresence} from '../presence/useAssistPresence'
-
-export function AssistItem(props: ItemProps) {
-  const {path} = props
-  const presence = useAssistPresence(path, true)
-
-  return (
-    <Flex align="center" width="fill" style={{position: 'relative'}}>
-      <Box flex={1}>{props.renderDefault({...props})}</Box>
-      {presence.map((pre) => (
-        <Box key={pre.user.id} style={{position: 'absolute', right: 35}}>
-          <AiFieldPresence presence={pre} />
-        </Box>
-      ))}
-    </Flex>
-  )
-}

package/src/assistFormComponents/validation/listItem.tsx

@@ -1,63 +0,0 @@
-import {Box, type ButtonTone, Flex, MenuItem, Stack, Text} from '@sanity/ui'
-import {useCallback} from 'react'
-import type {Path, ValidationMarker} from 'sanity'
-import {styled} from 'styled-components'
-
-interface ValidationListItemProps {
-  marker: ValidationMarker
-  onClick?: (path?: Path) => void
-  path: string
-  truncate?: boolean
-}
-
-const StyledText = styled(Text)`
-  white-space: initial;
-`
-
-const MENU_ITEM_TONES: Record<'error' | 'warning' | 'info', ButtonTone> = {
-  error: 'critical',
-  warning: 'caution',
-  info: 'primary',
-}
-
-export function ListItem(props: ValidationListItemProps) {
-  const {marker, onClick, path, truncate} = props
-
-  const handleClick = useCallback(() => {
-    if (onClick) {
-      onClick(marker.path)
-    }
-  }, [marker.path, onClick])
-
-  const menuItemTone = MENU_ITEM_TONES[marker?.level] || undefined
-
-  const children = (
-    <Flex>
-      {/*      <Box>
-        <Text size={1}>
-          {marker.level === 'error' && <ErrorOutlineIcon />}
-          {marker.level === 'warning' && <WarningOutlineIcon />}
-          {marker.level === 'info' && <InfoOutlineIcon />}
-        </Text>
-      </Box>*/}
-
-      <Stack space={2} flex={1}>
-        {path && (
-          <StyledText size={1} weight="semibold">
-            {path}
-          </StyledText>
-        )}
-        {marker.item?.message && (
-          <StyledText muted size={1} textOverflow={truncate ? 'ellipsis' : undefined}>
-            {marker.item?.message}
-          </StyledText>
-        )}
-      </Stack>
-    </Flex>
-  )
-  return (
-    <MenuItem padding={1} onClick={handleClick} radius={2} tone={menuItemTone}>
-      <Box padding={2}>{children}</Box>
-    </MenuItem>
-  )
-}

package/src/assistFormComponents/validation/validationList.tsx

@@ -1,90 +0,0 @@
-import {Container} from '@sanity/ui'
-import {useCallback} from 'react'
-import {
-  isValidationErrorMarker,
-  isValidationInfoMarker,
-  isValidationWarningMarker,
-  ObjectSchemaType,
-  Path,
-  ValidationMarker,
-} from 'sanity'
-
-import {ListItem} from './listItem'
-
-/** @internal */
-export interface ValidationListProps {
-  documentType?: ObjectSchemaType
-  kind?: 'simple'
-  validation: ValidationMarker[]
-  onFocus?: (path: Path) => void
-  onClose?: () => void
-  truncate?: boolean
-}
-
-export function ValidationList(props: ValidationListProps) {
-  const {documentType, kind, validation, onFocus, onClose, truncate} = props
-  const errors = validation.filter(isValidationErrorMarker)
-  const warnings = validation.filter(isValidationWarningMarker)
-  const info = validation.filter(isValidationInfoMarker)
-
-  const handleClick = useCallback(
-    (path: Path = []) => {
-      if (onFocus) onFocus(path)
-      if (onClose) onClose()
-    },
-    [onFocus, onClose],
-  )
-
-  const resolvePathTitle = (path: Path) => {
-    const fields = documentType && documentType.fields
-    const field = fields && fields.find((curr) => curr.name === path[0])
-
-    return (field && field.type.title) || ''
-  }
-
-  const hasErrors = errors.length > 0
-  const hasWarnings = warnings.length > 0
-  const hasInfo = info.length > 0
-
-  if (!hasErrors && !hasWarnings && !hasInfo) {
-    return null
-  }
-
-  return (
-    <Container width={0} data-kind={kind} data-testid="validation-list">
-      {hasErrors &&
-        errors.map((_error, i) => (
-          <ListItem
-            // eslint-disable-next-line react/no-array-index-key
-            key={i}
-            truncate={truncate}
-            path={resolvePathTitle(_error.path)}
-            marker={_error}
-            onClick={handleClick}
-          />
-        ))}
-      {hasWarnings &&
-        warnings.map((_warning, i) => (
-          <ListItem
-            // eslint-disable-next-line react/no-array-index-key
-            key={i}
-            truncate={truncate}
-            path={resolvePathTitle(_warning.path)}
-            marker={_warning}
-            onClick={handleClick}
-          />
-        ))}
-      {hasInfo &&
-        info.map((_info, i) => (
-          <ListItem
-            // eslint-disable-next-line react/no-array-index-key
-            key={i}
-            truncate={truncate}
-            path={resolvePathTitle(_info.path)}
-            marker={_info}
-            onClick={handleClick}
-          />
-        ))}
-    </Container>
-  )
-}