@sanity/assist 1.2.16 → 2.0.0

package/src/types.ts

@@ -1,4 +1,4 @@
-import {SanityDocument, ValidationMarker} from 'sanity'
+import {SanityDocument} from 'sanity'
 import {PortableTextBlock, PortableTextMarkDefinition, PortableTextSpan} from '@portabletext/types'
 
 //id prefixes
@@ -26,6 +26,9 @@ export const fieldPresenceTypeName = 'sanity.assist.instructionTask.presence' as
 export const assistSerializedTypeName = 'sanity.assist.serialized.type' as const
 export const assistSerializedFieldTypeName = 'sanity.assist.serialized.field' as const
 
+export const outputFieldTypeName = 'sanity.assist.output.field' as const
+export const outputTypeTypeName = 'sanity.assist.output.type' as const
+
 //url params
 export const inspectParam = 'inspect' as const
 export const fieldPathParam = 'pathKey' as const
@@ -34,27 +37,29 @@ export const instructionParam = 'instruction' as const
 // other constants
 export const documentRootKey = '<document>'
 
-export interface SerializedSchemaMember {
+export type SerializedSchemaMember = Omit<SerializedSchemaType, 'name' | '_type'> & {
   _type?: typeof assistSerializedFieldTypeName
-  type: string
-  name: string
-  title?: string
-  values?: string[]
-  of?: SerializedSchemaMember[]
-  to?: {type: string}[]
+  name?: string
 }
 
 export interface SerializedSchemaType {
   _type?: typeof assistSerializedTypeName
   _id?: string
   type: string
+  name: string
   title?: string
-  name?: string
   fields?: SerializedSchemaMember[]
-  of?: {type: string}[]
-  to?: {type: string}[]
+  of?: SerializedSchemaMember[]
+  to?: SerializedSchemaMember[]
+  annotations?: SerializedSchemaMember[]
+  inlineOf?: SerializedSchemaMember[]
+  values?: string[] | {value: string; title?: string}[]
+  hidden?: boolean | 'function'
+  readOnly?: boolean | 'function'
   options?: {
+    /** equivalent to options.aiAssist.imageDescriptionField - not renamed in the api for backwards compatability */
     imagePromptField?: string
+    embeddingsIndex?: string
   }
 }
 
@@ -149,10 +154,10 @@ export interface StudioInstruction {
   userId?: string
   title?: string
   placeholder?: string
+  output?: (OutputFieldItem | OutputTypeItem)[]
 
   //added after query / synthetic fields
   tasks?: InstructionTask[]
-  validation?: ValidationMarker[]
 }
 
 export interface AssistTasksStatus {
@@ -166,3 +171,19 @@ export interface AssistInspectorRouteParams {
   [fieldPathParam]?: string
   [instructionParam]?: string
 }
+
+export interface OutputFieldItem {
+  _type: typeof outputFieldTypeName
+  _key: string
+  //path relative to the field the instruction is for (same as _key)
+  relativePath?: string
+}
+
+export interface OutputTypeItem {
+  _type: typeof outputTypeTypeName
+  _key: string
+  /* array item type name */
+  type?: string
+  //path relative to the array-field the instruction is for, can be empty string (the array itself, same as _key)
+  relativePath?: string
+}

package/src/useApiClient.ts

@@ -1,8 +1,11 @@
-import {useClient, useCurrentUser, useSchema} from 'sanity'
+import {Path, pathToString, useClient, useCurrentUser, useSchema} from 'sanity'
 import {useCallback, useMemo, useState} from 'react'
 import {serializeSchema} from './schemas/serialize/serializeSchema'
 import {useToast} from '@sanity/ui'
 import {SanityClient} from '@sanity/client'
+import {FieldLanguageMap} from './translate/paths'
+import {documentRootKey} from './types'
+import {ConditionalMemberState} from './helpers/conditionalMembers'
 
 export interface UserTextInstance {
   blockKey: string
@@ -17,6 +20,7 @@ export interface RunInstructionRequest {
   instructionKey: string
   userId?: string
   userTexts?: UserTextInstance[]
+  conditionalMembers?: ConditionalMemberState[]
 }
 
 export interface InstructStatus {
@@ -25,6 +29,14 @@ export interface InstructStatus {
   validToken: boolean
 }
 
+export interface TranslateRequest {
+  documentId: string
+  translatePath: Path
+  languagePath?: string
+  fieldLanguageMap?: FieldLanguageMap[]
+  conditionalMembers?: ConditionalMemberState[]
+}
+
 const basePath = '/assist/tasks/instruction'
 
 export function useApiClient(customApiClient?: (defaultClient: SanityClient) => SanityClient) {
@@ -35,6 +47,69 @@ export function useApiClient(customApiClient?: (defaultClient: SanityClient) =>
   )
 }
 
+export function useTranslate(apiClient: SanityClient) {
+  const [loading, setLoading] = useState(false)
+  const user = useCurrentUser()
+  const schema = useSchema()
+  const types = useMemo(() => serializeSchema(schema, {leanFormat: true}), [schema])
+  const toast = useToast()
+
+  const translate = useCallback(
+    ({
+      documentId,
+      languagePath,
+      translatePath,
+      fieldLanguageMap,
+      conditionalMembers,
+    }: TranslateRequest) => {
+      setLoading(true)
+
+      return apiClient
+        .request({
+          method: 'POST',
+          url: `/assist/tasks/translate/${apiClient.config().dataset}?projectId=${
+            apiClient.config().projectId
+          }`,
+          body: {
+            documentId,
+            types,
+            languagePath,
+            fieldLanguageMap,
+            conditionalMembers,
+            translatePath:
+              translatePath.length === 0 ? documentRootKey : pathToString(translatePath),
+            userId: user?.id,
+          },
+        })
+        .catch((e) => {
+          toast.push({
+            status: 'error',
+            title: 'Translate failed',
+            description: e.message,
+          })
+          setLoading(false)
+          throw e
+        })
+        .finally(() => {
+          // adding some artificial delay here
+          // server responds with 201 then proceeds; we dont need to allow spamming the button
+          setTimeout(() => {
+            setLoading(false)
+          }, 2000)
+        })
+    },
+    [setLoading, apiClient, toast, user, types]
+  )
+
+  return useMemo(
+    () => ({
+      translate,
+      loading,
+    }),
+    [translate, loading]
+  )
+}
+
 export function useGenerateCaption(apiClient: SanityClient) {
   const [loading, setLoading] = useState(false)
   const user = useCurrentUser()
@@ -62,7 +137,7 @@ export function useGenerateCaption(apiClient: SanityClient) {
         .catch((e) => {
           toast.push({
             status: 'error',
-            title: 'Generate caption failed',
+            title: 'Generate image description failed',
             description: e.message,
           })
           setLoading(false)
@@ -88,6 +163,59 @@ export function useGenerateCaption(apiClient: SanityClient) {
   )
 }
 
+export function useGenerateImage(apiClient: SanityClient) {
+  const [loading, setLoading] = useState(false)
+  const user = useCurrentUser()
+  const schema = useSchema()
+  const types = useMemo(() => serializeSchema(schema, {leanFormat: true}), [schema])
+  const toast = useToast()
+
+  const generateImage = useCallback(
+    ({path, documentId}: {path: string; documentId: string}) => {
+      setLoading(true)
+
+      return apiClient
+        .request({
+          method: 'POST',
+          url: `/assist/tasks/generate-image/${apiClient.config().dataset}?projectId=${
+            apiClient.config().projectId
+          }`,
+          body: {
+            path,
+            documentId,
+            types,
+            userId: user?.id,
+          },
+        })
+        .catch((e) => {
+          toast.push({
+            status: 'error',
+            title: 'Generate image from prompt failed',
+            description: e.message,
+          })
+          setLoading(false)
+          throw e
+        })
+        .finally(() => {
+          // adding some artificial delay here
+          // server responds with 201 then proceeds; we dont need to allow spamming the button
+          setTimeout(() => {
+            setLoading(false)
+          }, 2000)
+        })
+    },
+    [setLoading, apiClient, toast, user, types]
+  )
+
+  return useMemo(
+    () => ({
+      generateImage,
+      loading,
+    }),
+    [generateImage, loading]
+  )
+}
+
 export function useGetInstructStatus(apiClient: SanityClient) {
   const [loading, setLoading] = useState(true)
 

package/src/assistLayout/AlphaMigration.tsx

@@ -1,310 +0,0 @@
-import {SanityClient, SanityDocument, useClient} from 'sanity'
-import {useCallback, useEffect, useState} from 'react'
-import {Box, Button, Card, Dialog, Spinner, Stack, Text, useToast} from '@sanity/ui'
-import {CheckmarkIcon} from '@sanity/icons'
-import {
-  LegacyAssistDocument,
-  legacyAssistDocumentIdPrefix,
-  legacyAssistDocumentTypeName,
-  legacyAssistStatusDocumentTypeName,
-  LegacyContextBlock,
-  legacyContextDocumentTypeName,
-  LegacyFieldRef,
-  LegacyPromptBlock,
-  LegacyPromptTextBlock,
-  LegacyUserInputBlock,
-} from '../legacy-types'
-import {assistDocumentId} from '../helpers/ids'
-import {
-  assistDocumentIdPrefix,
-  assistDocumentTypeName,
-  AssistField,
-  assistFieldTypeName,
-  contextDocumentTypeName,
-  fieldReferenceTypeName,
-  InlinePromptBlock,
-  instructionContextTypeName,
-  instructionTypeName,
-  PromptBlock,
-  userInputTypeName,
-} from '../types'
-import {PortableTextSpan} from '@portabletext/types'
-import {pluginTitle} from '../constants'
-
-const NO_ASSIST_DOCS: LegacyAssistDocument[] = []
-const NO_CONTEXT_DOCS: SanityDocument[] = []
-const NO_IDS: string[] = []
-
-interface MigratedContextDoc {
-  _id: string
-  _alphaId: string
-}
-
-type Task = (subtaskProgress: (percentage: number) => void) => Promise<void>
-
-export function AlphaMigration() {
-  const [alphaAssistDocs, setAlphaAssistDocs] = useState(NO_ASSIST_DOCS)
-  const [contextDocs, setContextDocs] = useState(NO_CONTEXT_DOCS)
-  const [staleStatusDocIds, setStaleStatusDocs] = useState(NO_IDS)
-  const [error, setError] = useState<Error | undefined>(undefined)
-  const [progress, setProgress] = useState<number | undefined>(undefined)
-  const toast = useToast()
-  const client = useClient({apiVersion: '2023-06-01'})
-
-  useEffect(() => {
-    let canUpdate = true
-    client
-      .fetch<{
-        assistDocs?: LegacyAssistDocument[]
-        staleStatusDocIds?: string[]
-        contextDocs?: SanityDocument[]
-      }>(
-        `
-    {
-      "assistDocs": *[_type=="${legacyAssistDocumentTypeName}"],
-      "staleStatusDocIds": *[_type=="${legacyAssistStatusDocumentTypeName}"]._id,
-      "contextDocs": *[_type=="${legacyContextDocumentTypeName}"],
-     }
-    `
-      )
-      .then((result) => {
-        if (!canUpdate || !result) {
-          return
-        }
-        setAlphaAssistDocs(result?.assistDocs ?? NO_ASSIST_DOCS)
-        setStaleStatusDocs(result?.staleStatusDocIds ?? NO_IDS)
-        setContextDocs(result?.contextDocs ?? NO_CONTEXT_DOCS)
-      })
-    return () => {
-      canUpdate = false
-    }
-  }, [client, setAlphaAssistDocs, setStaleStatusDocs, setContextDocs])
-
-  const convert = useCallback(async () => {
-    try {
-      setProgress(0.0001)
-
-      const tasks: Task[] = [
-        () => convertContextDocs(client, contextDocs),
-        (subtaskProgress) => deleteDocs(client, staleStatusDocIds, subtaskProgress),
-        (subtaskProgress) => convertDocs(client, alphaAssistDocs, subtaskProgress),
-        (subtaskProgress) =>
-          deleteDocs(
-            client,
-            contextDocs.map((d) => d._id),
-            subtaskProgress
-          ),
-      ]
-
-      const taskSize = 1 / tasks.length
-      for (let i = 0; i < tasks.length; i++) {
-        const startProgress = i / tasks.length
-        await tasks[i]((subProgress) => setProgress(startProgress + subProgress * taskSize))
-        setProgress((i + 1) / tasks.length)
-      }
-
-      setProgress(1)
-      setAlphaAssistDocs(NO_ASSIST_DOCS)
-      setContextDocs(NO_CONTEXT_DOCS)
-      setStaleStatusDocs(NO_IDS)
-      toast.push({
-        title: `Converted instructions to new format.`,
-        status: 'success',
-        closable: true,
-      })
-    } catch (e: any) {
-      console.error(e)
-      toast.push({
-        title: `An error occurred`,
-        status: 'error',
-        closable: true,
-      })
-      setError(e)
-      setProgress(undefined)
-    }
-  }, [contextDocs, client, alphaAssistDocs, staleStatusDocIds, setProgress, toast])
-
-  if (
-    (alphaAssistDocs.length || staleStatusDocIds.length || contextDocs.length) &&
-    (!progress || progress < 1)
-  ) {
-    return (
-      <Dialog id="outdated-assist-docs" header={pluginTitle}>
-        <Card padding={3}>
-          <Stack space={4} style={{maxWidth: 500}}>
-            <Text size={1}>
-              It seems like this workspace contains documents from an{' '}
-              <strong>older version of {pluginTitle}</strong>.
-            </Text>
-            <Text size={1}>Cleanup is required.</Text>
-            {error ? (
-              <Card padding={2} tone="critical" border>
-                <Text size={1}>An error occurred. See console for details.</Text>{' '}
-              </Card>
-            ) : null}
-            <Button
-              icon={
-                progress ? (
-                  <Box style={{marginTop: 5}}>
-                    <Spinner />
-                  </Box>
-                ) : (
-                  CheckmarkIcon
-                )
-              }
-              disabled={!!progress}
-              text={progress ? `${Math.floor(progress * 100)}%` : 'Ok, convert to new format!'}
-              tone="primary"
-              onClick={convert}
-            />
-          </Stack>
-        </Card>
-      </Dialog>
-    )
-  }
-
-  return null
-}
-
-async function deleteDocs(
-  client: SanityClient,
-  ids: string[],
-  updateProgress: (percentage: number) => void
-) {
-  const chunkSize = 50
-  for (let i = 0; i < ids.length; i += chunkSize) {
-    const progressCount = Math.min(ids.length, i + chunkSize)
-    const chunk = ids.slice(i, progressCount)
-    const trans = client.transaction()
-    chunk.forEach((id) => trans.delete(id))
-    await trans.commit()
-    updateProgress(progressCount / ids.length)
-  }
-}
-
-async function convertContextDocs(client: SanityClient, docs: SanityDocument[]) {
-  const trans = client.transaction()
-
-  for (const doc of docs) {
-    const {_id, _type, ...rest} = doc
-    trans.createOrReplace({
-      ...rest,
-      _id: `port.${_id}`,
-      _alphaId: _id,
-      _type: contextDocumentTypeName,
-    })
-  }
-
-  await trans.commit()
-}
-
-async function convertDocs(
-  client: SanityClient,
-  docs: LegacyAssistDocument[],
-  updateProgress: (percentage: number) => void
-) {
-  const chunkSize = 10
-  for (let i = 0; i < docs.length; i += chunkSize) {
-    const progressCount = Math.min(docs.length, i + chunkSize)
-    const chunk = docs.slice(i, progressCount)
-
-    const trans = client.transaction()
-    const contextDocs: MigratedContextDoc[] = await client.fetch(
-      `*[_type=="${contextDocumentTypeName}" && _alphaId != null]{_id, _alphaId}`
-    )
-
-    chunk.forEach((oldDoc) => {
-      const documentType = oldDoc._id.replace(
-        new RegExp(`^(${legacyAssistDocumentIdPrefix}|${assistDocumentIdPrefix})`),
-        ''
-      )
-
-      const id = assistDocumentId(documentType)
-
-      const fields: AssistField[] = (oldDoc.fields ?? [])
-        .filter((field) => field.instructions?.length)
-        .map((oldField) => {
-          const instructions = (oldField.instructions ?? []).map((inst) => {
-            // eslint-disable-next-line max-nested-callbacks
-            const prompt = (inst.prompt ?? []).map((block) => {
-              return mapBlock(block, contextDocs) as PromptBlock
-            })
-            return {
-              ...inst,
-              _type: instructionTypeName,
-              prompt,
-            }
-          })
-          return {
-            ...oldField,
-            _type: assistFieldTypeName,
-            instructions,
-          }
-        })
-
-      if (fields.length) {
-        trans.createOrReplace({
-          _id: id,
-          _type: assistDocumentTypeName,
-          fields,
-        })
-      }
-      trans.delete(oldDoc._id)
-    })
-    await trans.commit()
-    updateProgress(progressCount / docs.length)
-  }
-}
-
-type Blocks = LegacyPromptBlock | LegacyPromptTextBlock | PortableTextSpan
-
-function isFieldRef(block: Blocks): block is LegacyFieldRef {
-  return block._type === 'sanity.ai.prompt.fieldRef'
-}
-
-function isContext(block: Blocks): block is LegacyContextBlock {
-  return block._type === 'sanity.ai.prompt.context'
-}
-
-function isUserInput(block: Blocks): block is LegacyUserInputBlock {
-  return block._type === 'sanity.ai.prompt.userInput'
-}
-
-function isSpan(block: Blocks): block is PortableTextSpan {
-  return block._type === 'span'
-}
-
-function mapBlock(
-  block: Blocks,
-  migratedContexts: MigratedContextDoc[]
-): PromptBlock | InlinePromptBlock {
-  if (isFieldRef(block)) {
-    return {...block, _type: fieldReferenceTypeName}
-  }
-  if (isUserInput(block)) {
-    return {...block, _type: userInputTypeName}
-  }
-  if (isContext(block)) {
-    const newBlock = {
-      ...block,
-      _type: instructionContextTypeName,
-      reference: {
-        _type: 'reference',
-        _ref:
-          migratedContexts.find((c) => c._alphaId === block.reference?._ref)?._id ??
-          block.reference?._ref,
-      },
-    } as const
-    return newBlock
-  }
-  if (isSpan(block)) {
-    return block
-  }
-  const textBlock = block
-  return {
-    ...textBlock,
-    children: (textBlock.children ?? []).map(
-      (child) => mapBlock(child, migratedContexts) as InlinePromptBlock
-    ),
-  }
-}

package/src/legacy-types.ts

@@ -1,72 +0,0 @@
-import {SanityDocument} from 'sanity'
-import {PortableTextBlock, PortableTextMarkDefinition, PortableTextSpan} from '@portabletext/types'
-
-//id prefixes
-export const legacyAssistDocumentIdPrefix = 'sanity.ai.'
-
-export const legacyAssistDocumentTypeName = 'sanity.ai.docType' as const
-const aiFieldTypeName = 'sanity.ai.docType.field' as const
-const instructionTypeName = 'sanity.ai.field.instruction' as const
-
-const userInputTypeName = 'sanity.ai.prompt.userInput' as const
-const promptContextTypeName = 'sanity.ai.prompt.context' as const
-const fieldReferenceTypeName = 'sanity.ai.prompt.fieldRef' as const
-
-export const legacyContextDocumentTypeName = 'ai.instruction.context' as const
-
-export const legacyAssistStatusDocumentTypeName = 'sanity.ai.instructionStatus' as const
-
-export interface FieldPrompts {
-  _key: string
-  _type: typeof aiFieldTypeName
-  path?: string
-  instructions?: LegacyInstruction[]
-}
-
-export interface LegacyAssistDocument extends SanityDocument {
-  fields: FieldPrompts[]
-}
-
-export interface LegacyFieldRef extends PortableTextMarkDefinition {
-  _type: typeof fieldReferenceTypeName
-  path?: string
-}
-
-export interface LegacyContextBlock {
-  _type: typeof promptContextTypeName
-  reference?: {
-    _type: 'reference'
-    _ref?: string
-  }
-}
-
-export interface LegacyUserInputBlock {
-  _type: typeof userInputTypeName
-  _key: string
-  message?: string
-  description?: string
-}
-
-export type LegacyPromptTextBlock = PortableTextBlock<
-  never,
-  PortableTextSpan | LegacyFieldRef | LegacyUserInputBlock | LegacyContextBlock,
-  'normal',
-  never
->
-
-export type LegacyPromptBlock =
-  | LegacyPromptTextBlock
-  | LegacyFieldRef
-  | LegacyContextBlock
-  | LegacyUserInputBlock
-
-export interface LegacyInstruction {
-  _key: string
-  _type: typeof instructionTypeName
-  prompt?: LegacyPromptBlock[]
-
-  icon?: string
-  userId?: string
-  title?: string
-  placeholder?: string
-}