@sanity/assist 2.0.4 → 3.0.0

package/src/schemas/serialize/serializeSchema.ts

@@ -9,6 +9,9 @@ import {
   SchemaType,
   typed,
 } from 'sanity'
+
+import {isAssistSupported} from '../../helpers/assistSupported'
+import {isType} from '../../helpers/typeUtils'
 import {
   assistSchemaIdPrefix,
   assistSerializedFieldTypeName,
@@ -17,8 +20,6 @@ import {
   SerializedSchemaType,
 } from '../../types'
 import {hiddenTypes} from './schemaUtils'
-import {isAssistSupported} from '../../helpers/assistSupported'
-import {isType} from '../../helpers/typeUtils'
 
 interface Options {
   leanFormat?: boolean
@@ -54,7 +55,7 @@ export function serializeSchema(schema: Schema, options?: Options): SerializedSc
 function getSchemaStub(
   schemaType: SchemaType,
   schema: Schema,
-  options?: Options
+  options?: Options,
 ): SerializedSchemaType {
   if (!schemaType.type?.name) {
     console.error('Missing type name', schemaType.type)
@@ -78,7 +79,7 @@ function getBaseFields(
   schema: Schema,
   type: SchemaType,
   typeName: string,
-  options: Options | undefined
+  options: Options | undefined,
 ) {
   const schemaOptions: SerializedSchemaType['options'] = removeUndef({
     imagePromptField: (type.options as ImageOptions)?.aiAssist?.imageInstructionField,
@@ -88,7 +89,7 @@ function getBaseFields(
     options: Object.keys(schemaOptions).length ? schemaOptions : undefined,
     values: Array.isArray(type?.options?.list)
       ? type?.options?.list.map((v: string | {value: string; title: string}) =>
-          typeof v === 'string' ? v : v.value ?? `${v.title}`
+          typeof v === 'string' ? v : v.value ?? `${v.title}`,
         )
       : undefined,
     of: 'of' in type && typeName === 'array' ? arrayOf(type, schema, options) : undefined,
@@ -114,15 +115,15 @@ function getBaseFields(
       typeof type.readOnly === 'function'
         ? ('function' as const)
         : type.readOnly
-        ? true
-        : undefined,
+          ? true
+          : undefined,
   })
 }
 
 function serializeFields(
   schema: Schema,
   schemaType: ObjectSchemaType,
-  options: Options | undefined
+  options: Options | undefined,
 ) {
   const fields = schemaType.fieldsets
     ? schemaType.fieldsets.flatMap((fs) =>
@@ -138,7 +139,7 @@ function serializeFields(
                 hidden:
                   typeof fs.hidden === 'function' ? fs.hidden : fs.hidden ? true : f.type.hidden,
               },
-            }))
+            })),
       )
     : schemaType.fields
 
@@ -152,7 +153,7 @@ function serializeMember(
   schema: Schema,
   type: SchemaType,
   name: string,
-  options: Options | undefined
+  options: Options | undefined,
 ): SerializedSchemaMember {
   const typeNameExists = !!schema.get(type?.name)
   const typeName = typeNameExists ? type.name : type.type?.name ?? ''
@@ -168,7 +169,7 @@ function serializeMember(
 function serializeInlineOf(
   blockSchemaType: ObjectSchemaType,
   schema: Schema,
-  options: Options | undefined
+  options: Options | undefined,
 ): SerializedSchemaMember[] | undefined {
   const childrenField = blockSchemaType.fields.find((f) => f.name === 'children')
   const childrenType = childrenField?.type
@@ -181,14 +182,14 @@ function serializeInlineOf(
       of: childrenType.of.filter((t) => !isType(t, 'span')),
     },
     schema,
-    options
+    options,
   )
 }
 
 function serializeAnnotations(
   blockSchemaType: ObjectSchemaType,
   schema: Schema,
-  options: Options | undefined
+  options: Options | undefined,
 ): SerializedSchemaMember[] | undefined {
   const markDefs = blockSchemaType.fields.find((f) => f.name === 'markDefs')
   const marksType = markDefs?.type
@@ -201,7 +202,7 @@ function serializeAnnotations(
 function arrayOf(
   arrayType: ArraySchemaType,
   schema: Schema,
-  options: Options | undefined
+  options: Options | undefined,
 ): SerializedSchemaMember[] {
   return arrayType.of
     .filter((type) => isAssistSupported(type))

package/src/schemas/serializedSchemaTypeSchema.ts

@@ -1,6 +1,7 @@
+import {CodeIcon, StarIcon} from '@sanity/icons'
 import {defineField, defineType} from 'sanity'
+
 import {assistSerializedFieldTypeName, assistSerializedTypeName} from '../types'
-import {CodeIcon, StarIcon} from '@sanity/icons'
 
 export const serializedSchemaField = defineType({
   type: 'object',

package/src/translate/FieldTranslationProvider.tsx

@@ -1,27 +1,34 @@
+import {PlayIcon} from '@sanity/icons'
+import {Box, Button, Checkbox, Dialog, Flex, Radio, Spinner, Stack, Text, Tooltip} from '@sanity/ui'
 import {
   createContext,
-  PropsWithChildren,
+  type PropsWithChildren,
   useCallback,
   useContext,
   useId,
   useMemo,
   useState,
 } from 'react'
-import {ObjectSchemaType, Path, pathToString, SanityDocumentLike, useClient} from 'sanity'
+import {
+  type ObjectSchemaType,
+  type Path,
+  pathToString,
+  type SanityDocumentLike,
+  useClient,
+} from 'sanity'
+
 import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
+import type {ConditionalMemberState} from '../helpers/conditionalMembers'
 import {useApiClient, useTranslate} from '../useApiClient'
-import {Box, Button, Checkbox, Dialog, Flex, Radio, Spinner, Stack, Text, Tooltip} from '@sanity/ui'
+import {getLanguageParams} from './getLanguageParams'
+import {getPreferredToFieldLanguages, setPreferredToFieldLanguages} from './languageStore'
 import {
   defaultLanguageOutputs,
-  FieldLanguageMap,
+  type FieldLanguageMap,
   getDocumentMembersFlat,
   getFieldLanguageMap,
 } from './paths'
-import {PlayIcon} from '@sanity/icons'
-import {Language} from './types'
-import {getLanguageParams} from './getLanguageParams'
-import {getPreferredToFieldLanguages, setPreferredToFieldLanguages} from './languageStore'
-import {ConditionalMemberState} from '../helpers/conditionalMembers'
+import type {Language} from './types'
 
 interface FieldTranslationParams {
   document: SanityDocumentLike
@@ -47,16 +54,17 @@ export function useFieldTranslation() {
 function hasValuesToTranslate(
   fieldLanguageMaps: FieldLanguageMap[] | undefined,
   fromLanguage: Language | undefined,
-  basePath: Path
+  basePath: Path,
 ) {
   return fieldLanguageMaps?.some(
     (map) =>
       map.inputLanguageId === fromLanguage?.id &&
       map.inputPath &&
-      pathToString(map.inputPath).startsWith(pathToString(basePath))
+      pathToString(map.inputPath).startsWith(pathToString(basePath)),
   )
 }
 
+// eslint-disable-next-line @typescript-eslint/ban-types
 export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
   const {config: assistConfig} = useAiAssistanceConfig()
   const apiClient = useApiClient(assistConfig.__customApiClient)
@@ -86,7 +94,7 @@ export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
     (
       from: Language,
       languages: Language[] | undefined,
-      params: FieldTranslationParams | undefined
+      params: FieldTranslationParams | undefined,
     ) => {
       const {document, documentSchema} = params ?? {}
       setFromLanguage(from)
@@ -98,7 +106,7 @@ export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
       const preferred = getPreferredToFieldLanguages(from.id)
       const allToLanguages = languages.filter((l) => l.id !== from?.id)
       const filteredToLanguages = allToLanguages.filter(
-        (l) => !preferred.length || preferred.includes(l.id)
+        (l) => !preferred.length || preferred.includes(l.id),
       )
 
       setToLanguages(filteredToLanguages)
@@ -111,21 +119,21 @@ export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
           docMembers,
           fromId,
           allToIds.filter((toId) => fromId !== toId),
-          config?.translationOutputs ?? defaultLanguageOutputs
+          config?.translationOutputs ?? defaultLanguageOutputs,
         )
         setFieldLanguageMaps(transMap)
       } else {
         setFieldLanguageMaps(undefined)
       }
     },
-    [config]
+    [config],
   )
 
   const toggleToLanguage = useCallback(
     (
       toggledLang: Language,
       toLanguages: Language[] | undefined,
-      languages: Language[] | undefined
+      languages: Language[] | undefined,
     ) => {
       if (!languages || !fromLanguage) {
         return
@@ -134,17 +142,17 @@ export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
       const newToLangs = languages.filter(
         (anyLang) =>
           !!toLanguages?.find(
-            (selectedLang) => toggledLang.id !== selectedLang.id && selectedLang.id === anyLang.id
+            (selectedLang) => toggledLang.id !== selectedLang.id && selectedLang.id === anyLang.id,
           ) ||
-          (toggledLang.id === anyLang.id && !wasSelected)
+          (toggledLang.id === anyLang.id && !wasSelected),
       )
       setToLanguages(newToLangs)
       setPreferredToFieldLanguages(
         fromLanguage.id,
-        newToLangs.map((l) => l.id)
+        newToLangs.map((l) => l.id),
       )
     },
-    [fromLanguage]
+    [fromLanguage],
   )
 
   const openFieldTranslation = useCallback(
@@ -163,7 +171,7 @@ export function FieldTranslationProvider(props: PropsWithChildren<{}>) {
         console.error('No languages available for selected language params', languageParams)
       }
     },
-    [selectFromLanguage, config, languageClient]
+    [selectFromLanguage, config, languageClient],
   )
 
   const contextValue: FieldTranslationContextValue = useMemo(() => {
@@ -298,7 +306,7 @@ function ToLanguageCheckbox(props: {
   toggleToLanguage: (
     toggledLang: Language,
     toLanguages: Language[] | undefined,
-    languages: Language[] | undefined
+    languages: Language[] | undefined,
   ) => void
   languages: Language[]
 }) {
@@ -306,7 +314,7 @@ function ToLanguageCheckbox(props: {
   const langId = checkboxLanguage.id
   const onChange = useCallback(
     () => toggleToLanguage(checkboxLanguage, toLanguages, languages),
-    [toggleToLanguage, checkboxLanguage, toLanguages, languages]
+    [toggleToLanguage, checkboxLanguage, toLanguages, languages],
   )
   return (
     <Flex
@@ -334,7 +342,7 @@ function FromLanguageRadio(props: {
   selectFromLanguage: (
     from: Language,
     languages: Language[] | undefined,
-    params: FieldTranslationParams | undefined
+    params: FieldTranslationParams | undefined,
   ) => void
   languages: Language[] | undefined
   fieldTranslationParams: FieldTranslationParams | undefined
@@ -344,7 +352,7 @@ function FromLanguageRadio(props: {
 
   const onChange = useCallback(
     () => selectFromLanguage(radioLanguage, languages, fieldTranslationParams),
-    [selectFromLanguage, radioLanguage, languages, fieldTranslationParams]
+    [selectFromLanguage, radioLanguage, languages, fieldTranslationParams],
   )
   return (
     <Flex key={langId} gap={3} align="center" as={'label'}>

package/src/translate/getLanguageParams.ts

@@ -1,9 +1,9 @@
-import {SanityDocumentLike} from 'sanity'
-import get from 'lodash/get'
+import {get} from 'lodash'
+import type {SanityDocumentLike} from 'sanity'
 
 export const getLanguageParams = (
   select: Record<string, string> | undefined,
-  document: SanityDocumentLike | undefined
+  document: SanityDocumentLike | undefined,
 ): Record<string, unknown> => {
   if (!select || !document) {
     return {}
@@ -16,7 +16,7 @@ export const getLanguageParams = (
     if (Array.isArray(value)) {
       // If there are references in the array, ensure they have `_ref` set, otherwise they are considered empty and can safely be ignored
       value = value.filter((item) =>
-        typeof item === 'object' ? item?._type !== 'reference' || '_ref' in item : true
+        typeof item === 'object' ? item?._type !== 'reference' || '_ref' in item : true,
       )
     }
     selectedValue[key] = value

package/src/translate/paths.test.ts

@@ -1,9 +1,16 @@
-import {describe, expect, test} from 'vitest'
 import {Schema} from '@sanity/schema'
-import {defineType, ObjectSchemaType, pathToString, SanityDocumentLike, typed} from 'sanity'
+import {
+  defineType,
+  type ObjectSchemaType,
+  pathToString,
+  type SanityDocumentLike,
+  typed,
+} from 'sanity'
+import {describe, expect, test} from 'vitest'
+
 import {
   defaultLanguageOutputs,
-  FieldLanguageMap,
+  type FieldLanguageMap,
   getDocumentMembersFlat,
   getFieldLanguageMap,
 } from './paths'
@@ -82,7 +89,7 @@ describe('paths', () => {
           inputPath: ['translations', {_key: 'en'}],
           outputs: [{id: 'nb', outputPath: ['translations', {_key: 'nb'}]}],
         },
-      ])
+      ]),
     )
   })
 

package/src/translate/paths.ts

@@ -1,13 +1,14 @@
+import {extractWithPath} from '@sanity/mutator'
 import {
   isDocumentSchemaType,
   isKeySegment,
-  ObjectSchemaType,
-  Path,
+  type ObjectSchemaType,
+  type Path,
   pathToString,
-  SanityDocumentLike,
+  type SanityDocumentLike,
 } from 'sanity'
-import {extractWithPath} from '@sanity/mutator'
-import {DocumentMember, TranslationOutput, TranslationOutputsFunction} from './types'
+
+import type {DocumentMember, TranslationOutput, TranslationOutputsFunction} from './types'
 
 export interface FieldLanguageMap {
   inputLanguageId: string
@@ -30,7 +31,7 @@ function extractPaths(
   doc: SanityDocumentLike,
   schemaType: ObjectSchemaType,
   path: Path,
-  maxDepth: number
+  maxDepth: number,
 ): DocumentMember[] {
   if (path.length >= maxDepth) {
     return []
@@ -75,7 +76,7 @@ function extractPaths(
                 itemPath,
                 item,
                 itemSchema,
-              }
+              },
             )
           }
           if (item._key && itemSchema) {
@@ -83,7 +84,7 @@ function extractPaths(
               doc,
               itemSchema as ObjectSchemaType,
               itemPath,
-              maxDepth
+              maxDepth,
             )
             const arrayMember = {
               path: itemPath,
@@ -112,7 +113,7 @@ export const defaultLanguageOutputs: TranslationOutputsFunction = function (
   member,
   enclosingType,
   translateFromLanguageId,
-  translateToLanguageIds
+  translateToLanguageIds,
 ) {
   if (
     member.schemaType.jsonType === 'object' &&
@@ -146,7 +147,7 @@ export function getFieldLanguageMap(
   documentMembers: DocumentMember[],
   translateFromLanguageId: string,
   outputLanguageIds: string[],
-  langFn: TranslationOutputsFunction
+  langFn: TranslationOutputsFunction,
 ): FieldLanguageMap[] {
   const translationMaps: FieldLanguageMap[] = []
   for (const member of documentMembers) {
@@ -159,7 +160,7 @@ export function getFieldLanguageMap(
       member,
       enclosingType,
       translateFromLanguageId,
-      outputLanguageIds
+      outputLanguageIds,
     )?.filter((translation) => translation.id !== translateFromLanguageId)
 
     if (translations) {

package/src/translate/translateActions.tsx

@@ -1,22 +1,23 @@
 /* eslint-disable react-hooks/rules-of-hooks */
-import {
+import {TranslateIcon} from '@sanity/icons'
+import {Box, Spinner} from '@sanity/ui'
+import {useMemo, useRef} from 'react'
+import type {
   DocumentFieldAction,
   DocumentFieldActionGroup,
   DocumentFieldActionItem,
   DocumentFieldActionProps,
   ObjectSchemaType,
 } from 'sanity'
-import {TranslateIcon} from '@sanity/icons'
-import {useMemo, useRef} from 'react'
-import {useApiClient, useTranslate} from '../useApiClient'
+import {useDocumentPane} from 'sanity/structure'
+
+import {useDraftDelayedTask} from '../assistDocument/RequestRunInstructionProvider'
 import {useAiAssistanceConfig} from '../assistLayout/AiAssistanceConfigContext'
-import {Box, Spinner} from '@sanity/ui'
 import {isAssistSupported} from '../helpers/assistSupported'
-import {useDocumentPane} from 'sanity/desk'
-import {useFieldTranslation} from './FieldTranslationProvider'
-import {useDraftDelayedTask} from '../assistDocument/RequestRunInstructionProvider'
-import {AssistOptions} from '../schemas/typeDefExtensions'
 import {getConditionalMembers} from '../helpers/conditionalMembers'
+import type {AssistOptions} from '../schemas/typeDefExtensions'
+import {useApiClient, useTranslate} from '../useApiClient'
+import {useFieldTranslation} from './FieldTranslationProvider'
 
 function node(node: DocumentFieldActionItem | DocumentFieldActionGroup) {
   return node
@@ -163,7 +164,7 @@ export const translateActions: DocumentFieldAction = {
           fieldTransEnabled,
           path,
           readOnly,
-        ]
+        ],
       )
 
       // eslint-disable-next-line react-hooks/rules-of-hooks
@@ -176,7 +177,7 @@ export const translateActions: DocumentFieldAction = {
           icon: () => null,
           title: 'Translation',
           children: [translateDocumentAction, translateFieldsAction].filter(
-            (c): c is DocumentFieldActionItem => !!c
+            (c): c is DocumentFieldActionItem => !!c,
           ),
           expanded: true,
         })

package/src/translate/types.ts

@@ -22,12 +22,12 @@ export type TranslationOutputsFunction = (
   documentMember: DocumentMember,
   enclosingType: SchemaType,
   translateFromLanguageId: string,
-  translateToLanguageIds: string[]
+  translateToLanguageIds: string[],
 ) => TranslationOutput[] | undefined
 
 export type LanguageCallback = (
   client: SanityClient,
-  selectedLanguageParams: Record<string, unknown>
+  selectedLanguageParams: Record<string, unknown>,
 ) => Promise<Language[]>
 
 export interface FieldTranslationConfig {

package/src/useApiClient.ts

@@ -47,7 +47,7 @@ export function useApiClient(customApiClient?: (defaultClient: SanityClient) =>
   const client = useClient({apiVersion: '2023-06-05'})
   return useMemo(
     () => (customApiClient ? customApiClient(client) : client),
-    [client, customApiClient]
+    [client, customApiClient],
   )
 }
 
@@ -102,7 +102,7 @@ export function useTranslate(apiClient: SanityClient) {
           }, 2000)
         })
     },
-    [setLoading, apiClient, toast, user, types]
+    [setLoading, apiClient, toast, user, types],
   )
 
   return useMemo(
@@ -110,7 +110,7 @@ export function useTranslate(apiClient: SanityClient) {
       translate,
       loading,
     }),
-    [translate, loading]
+    [translate, loading],
   )
 }
 
@@ -155,7 +155,7 @@ export function useGenerateCaption(apiClient: SanityClient) {
           }, 2000)
         })
     },
-    [setLoading, apiClient, toast, user, types]
+    [setLoading, apiClient, toast, user, types],
   )
 
   return useMemo(
@@ -163,7 +163,7 @@ export function useGenerateCaption(apiClient: SanityClient) {
       generateCaption,
       loading,
     }),
-    [generateCaption, loading]
+    [generateCaption, loading],
   )
 }
 
@@ -208,7 +208,7 @@ export function useGenerateImage(apiClient: SanityClient) {
           }, 2000)
         })
     },
-    [setLoading, apiClient, toast, user, types]
+    [setLoading, apiClient, toast, user, types],
   )
 
   return useMemo(
@@ -216,7 +216,7 @@ export function useGenerateImage(apiClient: SanityClient) {
       generateImage,
       loading,
     }),
-    [generateImage, loading]
+    [generateImage, loading],
   )
 }
 
@@ -301,7 +301,7 @@ export function useRunInstructionApi(apiClient: SanityClient) {
           setLoading(false)
         })
     },
-    [apiClient, types, user, toast]
+    [apiClient, types, user, toast],
   )
 
   return useMemo(
@@ -309,6 +309,6 @@ export function useRunInstructionApi(apiClient: SanityClient) {
       runInstruction,
       loading,
     }),
-    [runInstruction, loading]
+    [runInstruction, loading],
   )
 }

package/dist/index.cjs.mjs

@@ -1,7 +0,0 @@
-import cjs from './index.js';
-
-export const SchemaTypeTool = cjs.SchemaTypeTool;
-export const assist = cjs.assist;
-export const contextDocumentTypeName = cjs.contextDocumentTypeName;
-export const defaultLanguageOutputs = cjs.defaultLanguageOutputs;
-