@sanity/assist 5.0.4 → 6.0.1

package/src/assistLayout/RunInstructionProvider.tsx

@@ -1,278 +0,0 @@
-import {PlayIcon} from '@sanity/icons'
-import {Button, Dialog, Flex, Stack, Text, TextArea, Tooltip} from '@sanity/ui'
-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 type {RunInstructionArgs} from './AssistLayout'
-import {CustomInputResult, GetUserInput} from '../fieldActions/useUserInput'
-import {
-  createContext,
-  type Dispatch,
-  type FormEvent,
-  type PropsWithChildren,
-  type SetStateAction,
-  useCallback,
-  useContext,
-  useEffect,
-  useId,
-  useMemo,
-  useRef,
-  useState,
-} from 'react'
-
-type BlockInputs = Record<string, string>
-const NO_INPUT: BlockInputs = {}
-
-export interface RunInstructionContextValue {
-  runInstruction: (req: RunInstructionArgs) => void
-  getUserInput: GetUserInput
-  instructionLoading: boolean
-}
-
-export const RunInstructionContext = createContext<RunInstructionContextValue>({
-  runInstruction: () => {},
-  getUserInput: async () => undefined,
-  instructionLoading: false,
-})
-
-export function useRunInstruction() {
-  return useContext(RunInstructionContext)
-}
-
-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)
-  const {runInstruction: runInstructionRequest, loading} = useRunInstructionApi(apiClient)
-
-  const id = useId()
-
-  const [inputs, setInputs] = useState(NO_INPUT)
-  const [runRequest, setRunRequest] = useState<
-    | (RunInstructionArgs & {userInputBlocks: UserInputBlock[]})
-    | {dialogTitle: string; userInputBlocks: UserInputBlock[]}
-    | undefined
-  >()
-
-  const [resolveUserInput, setResolveUserInput] =
-    useState<
-      (
-        value: CustomInputResult[] | PromiseLike<CustomInputResult[] | undefined> | undefined,
-      ) => void
-    >()
-
-  const getUserInput: GetUserInput = useCallback(async ({title, inputs}) => {
-    const userInputBlocks: UserInputBlock[] = inputs.map((input, i) => ({
-      _type: userInputTypeName,
-      _key: input.id ?? `${i}`,
-      message: input.title,
-      description: input.description,
-    }))
-
-    if (!userInputBlocks.length) {
-      return undefined
-    }
-    setRunRequest({dialogTitle: title, userInputBlocks})
-    return new Promise<CustomInputResult[] | undefined>((resolve) => {
-      setResolveUserInput(() => resolve)
-    })
-  }, [])
-
-  const runInstruction = useCallback(
-    (req: RunInstructionArgs) => {
-      if (loading) {
-        return
-      }
-      const {instruction, ...request} = req
-      const instructionKey = instruction._key
-      const userInputBlocks = instruction?.prompt
-        ?.flatMap((block) =>
-          block._type === 'block' ? block.children.filter(isUserInputBlock) : [block],
-        )
-        .filter(isUserInputBlock)
-
-      if (!userInputBlocks?.length) {
-        runInstructionRequest({
-          ...request,
-          instructionKey,
-          userTexts: undefined,
-        })
-        return
-      }
-
-      setRunRequest({
-        ...req,
-        userInputBlocks,
-      })
-    },
-    [runInstructionRequest, loading],
-  )
-
-  const close = useCallback(() => {
-    setRunRequest(undefined)
-    setInputs(NO_INPUT)
-    if (resolveUserInput) {
-      resolveUserInput(undefined)
-    }
-    setResolveUserInput(undefined)
-  }, [resolveUserInput])
-
-  const runWithInput = useCallback(() => {
-    if (runRequest) {
-      if ('instruction' in runRequest) {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const {instruction, userTexts, ...request} = runRequest
-        runInstructionRequest({
-          ...request,
-          instructionKey: instruction._key,
-          userTexts: Object.entries(inputs).map(([key, value]) => ({
-            blockKey: key,
-            userInput: value,
-          })),
-        })
-      } else {
-        const userInputs = Object.values(inputs).map((input, i) => {
-          const userInputBlock = runRequest.userInputBlocks[i]
-          return {
-            input: {
-              id: userInputBlock._key,
-              title: userInputBlock.message ?? '',
-              description: userInputBlock.description,
-            },
-            result: input,
-          }
-        })
-        resolveUserInput?.(userInputs)
-        setResolveUserInput(undefined)
-      }
-    }
-    close()
-  }, [close, runInstructionRequest, runRequest, inputs, resolveUserInput])
-
-  const open = !!runRequest
-
-  const runDisabled = useMemo(
-    () =>
-      (runRequest?.userInputBlocks?.length ?? 0) >
-      Object.entries(inputs).filter(([, value]) => !!value).length,
-    [runRequest?.userInputBlocks, inputs],
-  )
-
-  const runButton = (
-    <Button
-      text="Run instruction"
-      onClick={runWithInput}
-      tone="primary"
-      icon={PlayIcon}
-      style={{width: '100%'}}
-      disabled={runDisabled}
-    />
-  )
-
-  const contextValue: RunInstructionContextValue = useMemo(
-    () => ({runInstruction, getUserInput, instructionLoading: loading}),
-    [runInstruction, loading],
-  )
-
-  return (
-    <RunInstructionContext.Provider value={contextValue}>
-      {open ? (
-        <Dialog
-          id={id}
-          open={open}
-          onClose={close}
-          width={1}
-          header={
-            'dialogTitle' in runRequest
-              ? runRequest.dialogTitle
-              : getInstructionTitle(runRequest?.instruction)
-          }
-          footer={
-            <Flex justify="space-between" padding={2} flex={1}>
-              {runDisabled ? (
-                <Tooltip
-                  content={
-                    <Flex padding={2}>
-                      <Text>Unable to run instruction. All fields must have a value.</Text>
-                    </Flex>
-                  }
-                  placement="top"
-                >
-                  <Flex flex={1}>{runButton}</Flex>
-                </Tooltip>
-              ) : (
-                runButton
-              )}
-            </Flex>
-          }
-        >
-          <Stack padding={4} space={2}>
-            {runRequest?.userInputBlocks?.map((block, i) => (
-              <UserInput
-                key={block._key}
-                block={block}
-                autoFocus={i === 0}
-                inputs={inputs}
-                setInputs={setInputs}
-              />
-            ))}
-          </Stack>
-        </Dialog>
-      ) : null}
-      {props.children}
-    </RunInstructionContext.Provider>
-  )
-}
-
-export function UserInput(props: {
-  block: UserInputBlock
-  inputs: BlockInputs
-  setInputs: Dispatch<SetStateAction<BlockInputs>>
-  autoFocus?: boolean
-}) {
-  const {block, autoFocus, setInputs, inputs} = props
-  const key = block._key
-  const textAreaRef = useRef<HTMLTextAreaElement>(null)
-
-  const onChange = useCallback(
-    (e: FormEvent<HTMLTextAreaElement>) => {
-      setInputs((current) => ({
-        ...current,
-        [key]: (e.currentTarget ?? e.target).value,
-      }))
-    },
-    [key, setInputs],
-  )
-
-  const value = useMemo(() => inputs[key], [inputs, key])
-
-  useEffect(() => {
-    if (!autoFocus) {
-      return
-    }
-    setTimeout(() => textAreaRef.current?.focus(), 0)
-  }, [autoFocus])
-
-  return (
-    <Stack padding={2} space={3}>
-      <FormFieldHeaderText
-        title={block?.message ?? 'Provide more context'}
-        description={block.description}
-      />
-      <TextArea
-        ref={textAreaRef}
-        rows={4}
-        value={value}
-        onChange={onChange}
-        style={{resize: 'vertical'}}
-      />
-    </Stack>
-  )
-}

package/src/assistLayout/fieldRefCache.tsx

@@ -1,34 +0,0 @@
-import {
-  asFieldRefsByTypePath,
-  FieldRef,
-  getFieldRefs as createFieldRefs,
-} from '../assistInspector/helpers'
-import type {ObjectSchemaType} from 'sanity'
-
-export function createFieldRefCache() {
-  const byType: Record<
-    string,
-    | {
-        fieldRefs: FieldRef[]
-        fieldRefsByTypePath: Record<string, FieldRef | undefined>
-      }
-    | undefined
-  > = {}
-
-  function getRefsForType(schemaType: ObjectSchemaType) {
-    const documentType = schemaType.name
-    const cached = byType[documentType]
-    if (cached) return cached
-
-    const fieldRefs = createFieldRefs(schemaType)
-    const fieldRefsByTypePath = asFieldRefsByTypePath(fieldRefs)
-    const refs = {
-      fieldRefs,
-      fieldRefsByTypePath,
-    }
-    byType[documentType] = refs
-    return refs
-  }
-
-  return getRefsForType
-}

package/src/assistTypes.ts

@@ -1,83 +0,0 @@
-import {CurrentUser} from 'sanity'
-
-export interface AssistConfig {
-  /**
-   * As of v3.0 Assist can write to date and datetime fields.
-   *
-   * If this function is omitted from config, the plugin will use the default timeZone and locale
-   * in the browser:
-   *
-   * ```ts
-   * const {timeZone, locale} = Intl.DateTimeFormat().resolvedOptions()
-   * ```
-   *
-   * The function will be called any time an instruction runs.
-   *
-   * @see #LocaleSettings.locale
-   * @see #LocaleSettings.timeZone
-   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
-   * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-   */
-  localeSettings?: (context: LocaleSettingsContext) => LocaleSettings
-
-  /**
-   * The max depth for document paths AI Assist will write to.
-   *
-   * Depth is based on field path segments:
-   * - `title` has depth 1
-   * - `array[_key="no"].title` has depth 3
-   *
-   * Be careful not to set this too high in studios with recursive document schemas, as it could have
-   * negative impact on performance.
-   *
-   * Depth will be counted from the field the instruction is run from. For example, if an instruction
-   * is attached to depth 6, the count starts from there (at 0, not at 6).
-   *
-   * Default: 4
-   */
-  maxPathDepth?: number
-
-  /**
-   * Influences how much the output of an instruction will vary.
-   *
-   * Min: 0 – re-running an instruction will often produce the same outcomes
-   * Max: 1 – re-running an instruction can produce wildly different outcomes
-   *
-   * This parameter applies to _all_ instructions in the studio.
-   *
-   * Prior to v3.0, this defaulted to 0
-   *
-   * Default: 0.3
-   */
-  temperature?: number
-}
-
-export interface LocaleSettingsContext {
-  user: CurrentUser
-  defaultSettings: LocaleSettings
-}
-
-export interface LocaleSettings {
-  /**
-   * A valid Unicode BCP 47 locale identifier used to interpret and format
-   * natural language inputs and date output. Examples include "en-US", "fr-FR", or "ja-JP".
-   *
-   * This affects how phrases like "next Friday" or "in two weeks" are parsed,
-   * and how resulting dates are presented (e.g., 12-hour vs 24-hour format).
-   *
-   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#getcanonicalocales
-   */
-  locale: string
-
-  /**
-   * A valid IANA time zone identifier used to resolve relative and absolute
-   * date expressions to a specific point in time. Examples include
-   * "America/New_York", "Europe/Paris", or "Asia/Tokyo".
-   *
-   * This ensures phrases like "tomorrow at 9am" are interpreted correctly
-   * based on the user's local time.
-   *
-   * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-   */
-  timeZone: string
-}

package/src/components/AssistFeatureBadge.tsx

@@ -1,9 +0,0 @@
-import {Badge} from '@sanity/ui'
-
-export function AssistFeatureBadge() {
-  return (
-    <Badge fontSize={0} style={{margin: '-2px 0'}} tone="primary">
-      Beta
-    </Badge>
-  )
-}

package/src/components/FadeInContent.tsx

@@ -1,40 +0,0 @@
-import {forwardRef, type ReactElement, type ReactNode} from 'react'
-import {keyframes, styled} from 'styled-components'
-
-const fadeIn = keyframes`
-  0% {
-    opacity: 0;
-    transform: scale(0.75);
-  }
-  40% {
-    opacity: 0;
-    transform: scale(0.75);
-  }
-  100% {
-    opacity: 1;
-    transform: scale(1);
-  }
-`
-
-const FadeInDiv = styled.div`
-  animation-name: ${fadeIn};
-  animation-timing-function: ease-in-out;
-`
-
-export const FadeInContent = forwardRef(function FadeInContent(
-  {
-    children,
-    durationMs = 250,
-  }: {
-    children?: ReactNode
-    ms?: number
-    durationMs?: number
-  },
-  ref: any,
-): ReactElement {
-  return (
-    <FadeInDiv ref={ref} style={{animationDuration: `${durationMs}ms`}}>
-      {children}
-    </FadeInDiv>
-  )
-})

package/src/components/HideReferenceChangedBannerInput.tsx

@@ -1,25 +0,0 @@
-import {Box} from '@sanity/ui'
-import {useEffect, useRef} from 'react'
-import {ObjectInputProps} from 'sanity'
-
-export function HideReferenceChangedBannerInput(props: ObjectInputProps) {
-  const ref = useRef<HTMLDivElement>(null)
-
-  // hides "reference was changed" banner (it is incorrectly flashing because the pane handler does not support the way wie use the assist pane)
-  useEffect(() => {
-    const parent = ref.current?.closest('[data-testid="pane-content"]')
-    if (!parent) {
-      return
-    }
-    const style = document.createElement('style')
-    const parentId = `id-${Math.random()}`.replace('.', '-')
-    parent.id = parentId
-
-    style.innerText = `
-      #${parentId} [data-testid="reference-changed-banner"] { display: none; }
-    `
-    parent.prepend(style)
-  }, [ref])
-
-  return <Box ref={ref}>{props.renderDefault(props)}</Box>
-}

package/src/components/ImageContext.tsx

@@ -1,85 +0,0 @@
-import {createContext, useEffect, useMemo, useState} from 'react'
-import {getPublishedId, type InputProps, pathToString, usePerspective, useSyncState} from 'sanity'
-import {usePaneRouter} from 'sanity/structure'
-
-import {useAssistDocumentContext} from '../assistDocument/AssistDocumentContext'
-import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
-import {getDescriptionFieldOption, getImageInstructionFieldOption} from '../helpers/typeUtils'
-import {canUseAssist, useApiClient, useGenerateCaption} from '../useApiClient'
-
-export interface ImageContextValue {
-  imageDescriptionPath?: string
-  imageInstructionPath?: string
-  assetRef?: string
-}
-
-export const ImageContext = createContext<ImageContextValue>({})
-
-export function ImageContextProvider(props: InputProps) {
-  const {schemaType, path, value, readOnly} = props
-  const assetRef = (value as any)?.asset?._ref
-  const {selectedReleaseId} = usePerspective()
-  const [assetRefState, setAssetRefState] = useState<string | undefined>(assetRef)
-
-  const {assistableDocumentId, documentSchemaType} = useAssistDocumentContext()
-  const {config, status} = useAiAssistanceConfig()
-  const apiClient = useApiClient(config?.__customApiClient)
-  const {generateCaption} = useGenerateCaption(apiClient)
-
-  const {isSyncing} = useSyncState(
-    getPublishedId(assistableDocumentId),
-    documentSchemaType.name,
-    selectedReleaseId,
-  )
-
-  const router = usePaneRouter()
-  const isShowingOlderRevision = !!router.params?.rev
-
-  useEffect(() => {
-    const descriptionField = getDescriptionFieldOption(schemaType)
-    if (
-      assetRef &&
-      assistableDocumentId &&
-      descriptionField?.updateOnImageChange &&
-      assetRef !== assetRefState &&
-      !isSyncing &&
-      !isShowingOlderRevision &&
-      !readOnly
-    ) {
-      setAssetRefState(assetRef)
-      if (canUseAssist(status)) {
-        generateCaption({
-          path: pathToString([...path, descriptionField.path]),
-          documentId: assistableDocumentId,
-        })
-      }
-    }
-  }, [
-    schemaType,
-    path,
-    assetRef,
-    assetRefState,
-    assistableDocumentId,
-    generateCaption,
-    isSyncing,
-    status,
-    readOnly,
-    isShowingOlderRevision,
-  ])
-
-  const context: ImageContextValue = useMemo(() => {
-    const descriptionField = getDescriptionFieldOption(schemaType)
-    const imageInstructionField = getImageInstructionFieldOption(schemaType)
-    return {
-      imageDescriptionPath: descriptionField?.path
-        ? pathToString([...path, descriptionField.path])
-        : undefined,
-      imageInstructionPath: imageInstructionField
-        ? pathToString([...path, imageInstructionField])
-        : undefined,
-      assetRef,
-    }
-  }, [schemaType, path, assetRef])
-
-  return <ImageContext.Provider value={context}>{props.renderDefault(props)}</ImageContext.Provider>
-}

package/src/components/SafeValueInput.tsx

@@ -1,74 +0,0 @@
-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'
-
-const WrapPreCard = styled(Card)`
-  & pre {
-    white-space: pre-wrap !important;
-  }
-`
-
-export function SafeValueInput(props: InputProps) {
-  return (
-    <ErrorWrapper onChange={props.onChange}>
-      <PteValueFixer {...props} />
-    </ErrorWrapper>
-  )
-}
-
-export function ErrorWrapper(
-  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)
-  }, [])
-
-  const unsetValue = useCallback(() => {
-    onChange(PatchEvent.from(unset()))
-    setError(undefined)
-  }, [onChange])
-  const dismiss = useCallback(() => setError(undefined), [])
-  const catcher = <ErrorBoundary onCatch={catchError}>{props.children}</ErrorBoundary>
-
-  return error ? (
-    <Card border tone="critical" padding={2} contentEditable={false}>
-      <Stack space={3}>
-        <Text muted weight="semibold">
-          An error occurred.
-        </Text>
-
-        <WrapPreCard flex={1} padding={2} tone="critical" border>
-          {catcher}
-        </WrapPreCard>
-
-        <Flex width="fill" flex={1} gap={3}>
-          <Box flex={1}>
-            <Button text="Dismiss" onClick={dismiss} tone="primary" />
-          </Box>
-          <Button text="Unset value" onClick={unsetValue} tone="critical" />
-        </Flex>
-      </Stack>
-    </Card>
-  ) : (
-    catcher
-  )
-}
-
-function PteValueFixer(props: InputProps) {
-  const isPortableText = useMemo(
-    () => isArraySchemaType(props.schemaType) && isPortableTextArray(props.schemaType),
-    [props.schemaType],
-  )
-  const value = props.value
-  if (isPortableText && value && !(value as any[]).length) {
-    return props.renderDefault({...props, value: undefined})
-  }
-
-  return props.renderDefault(props)
-}

package/src/components/TimeAgo.tsx

@@ -1,18 +0,0 @@
-import {formatDistanceToNow} from 'date-fns'
-import {useEffect, useReducer} from 'react'
-
-function useInterval(ms: number) {
-  const [tick, update] = useReducer((n) => n + 1, 0)
-
-  useEffect(() => {
-    const i = setInterval(update, ms)
-    return () => clearInterval(i)
-  }, [ms])
-  return tick
-}
-
-export function TimeAgo({date}: {date?: string}) {
-  useInterval(1000)
-  const timeSince = formatDistanceToNow(date ? new Date(date) : new Date())
-  return <span title={timeSince}>{timeSince} ago</span>
-}

package/src/constants.ts

@@ -1,20 +0,0 @@
-import {minutesToMilliseconds} from 'date-fns'
-
-export const releaseAnnouncementUrl =
-  'https://www.sanity.io/blog/sanity-ai-assist-announcement?utm_source=sanity-assist-plugin&utm_medium=organic_social&utm_campaign=ai-assist&utm_content='
-
-export const instructionGuideUrl =
-  'https://sanity.io/guides/getting-started-with-ai-assist-instructions?utm_source=sanity-assist-plugin&utm_medium=organic_social&utm_campaign=ai-assist&utm_content='
-
-export const giveFeedbackUrl = 'https://forms.gle/Kwz7CThxGeA2GiEU8'
-
-export const salesUrl =
-  'https://www.sanity.io/contact/sales?utm_source=sanity-assist-plugin&utm_medium=organic_social&utm_campaign=ai-assist&utm_content='
-
-export const packageName = '@sanity/assist'
-
-export const pluginTitle = 'Sanity AI Assist'
-
-export const pluginTitleShort = 'AI Assist'
-
-export const maxHistoryVisibilityMs = minutesToMilliseconds(30)

package/src/fieldActions/PrivateIcon.tsx

@@ -1,20 +0,0 @@
-import {LockIcon} from '@sanity/icons'
-import {Text, Tooltip} from '@sanity/ui'
-
-export function PrivateIcon() {
-  return (
-    <Tooltip
-      content={
-        <Text size={1} style={{whiteSpace: 'nowrap'}}>
-          Only visible to you
-        </Text>
-      }
-      fallbackPlacements={['bottom']}
-      padding={2}
-      placement="top"
-      portal
-    >
-      <LockIcon />
-    </Tooltip>
-  )
-}