@sanity/assist 3.2.2 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "3.2.2",
+  "version": "4.0.0",
   "description": "You create the instructions; Sanity AI Assist does the rest.",
   "keywords": [
     "sanity",
@@ -65,7 +65,7 @@
     "@rollup/plugin-image": "^3.0.3",
     "@sanity/pkg-utils": "^6.1.0",
     "@sanity/plugin-kit": "^3.1.10",
-    "@sanity/schema": "^3.80.0",
+    "@sanity/schema": "^3.81.0",
     "@sanity/semantic-release-preset": "^4.1.7",
     "@types/lodash": "^4.17.0",
     "@types/lodash-es": "^4.17.12",
@@ -83,9 +83,9 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "^5.0.5",
-    "sanity": "^3.80.0",
+    "sanity": "^3.81.0",
     "semantic-release": "^23.0.8",
-    "styled-components": "^6.1.8",
+    "styled-components": "^6.1.16",
     "typescript": "^5.7.2",
     "vitest": "^1.4.0"
   },

package/src/assistInspector/AssistInspector.tsx

@@ -367,7 +367,7 @@ export function AssistInspector(props: DocumentInspectorProps) {
                 mode="ghost"
                 disabled={isEmptyPrompt || instructionLoading}
                 fontSize={1}
-                icon={instructionLoading ? <Spinner /> : PlayIcon}
+                icon={instructionLoading ? <Spinner style={{marginTop: 3}} /> : PlayIcon}
                 onClick={runCurrentInstruction}
                 padding={3}
                 text={'Run instruction'}

package/src/assistTypes.ts

@@ -0,0 +1,83 @@
+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/helpers/assistSupported.ts

@@ -34,17 +34,12 @@ function isDisabled(type: SchemaType) {
 
 function isUnsupportedType(type: SchemaType) {
   return (
-    type.jsonType === 'number' ||
     type.name === 'sanity.imageCrop' ||
     type.name === 'sanity.imageHotspot' ||
     isType(type, 'globalDocumentReference') ||
     (isType(type, 'reference') &&
       !(type?.options as ReferenceOptions)?.aiAssist?.embeddingsIndex) ||
     isType(type, 'crossDatasetReference') ||
-    isType(type, 'slug') ||
-    isType(type, 'url') ||
-    isType(type, 'date') ||
-    isType(type, 'datetime') ||
     isType(type, 'file')
   )
 }

package/src/index.ts

@@ -4,3 +4,4 @@ export * from './schemas/typeDefExtensions'
 export {defaultLanguageOutputs} from './translate/paths'
 export * from './translate/types'
 export {contextDocumentTypeName} from './types'
+export * from './assistTypes'

package/src/plugin.tsx

@@ -19,10 +19,16 @@ import {createAssistDocumentPresence} from './presence/AssistDocumentPresence'
 import {schemaTypes} from './schemas'
 import {TranslationConfig} from './translate/types'
 import {assistDocumentTypeName, AssistPreset} from './types'
+import {AssistConfig} from './assistTypes'
 
 export interface AssistPluginConfig {
   translate?: TranslationConfig
 
+  /**
+   * Config that affects all instructions
+   */
+  assist?: AssistConfig
+
   /**
    * @internal
    */
@@ -37,6 +43,8 @@ export interface AssistPluginConfig {
 export const assist = definePlugin<AssistPluginConfig | void>((config) => {
   const configWithDefaults = config ?? {}
   const styleguide = configWithDefaults.translate?.styleguide || ''
+  const maxPathDepth = configWithDefaults.assist?.maxPathDepth
+  const temperature = configWithDefaults.assist?.temperature
 
   if (styleguide.length > 2000) {
     throw new Error(
@@ -44,6 +52,18 @@ export const assist = definePlugin<AssistPluginConfig | void>((config) => {
     )
   }
 
+  if (maxPathDepth !== undefined && (maxPathDepth < 1 || maxPathDepth > 12)) {
+    throw new Error(
+      `[${packageName}]: \`assist.maxPathDepth\` must be be in the range [1,12] inclusive, but was ${maxPathDepth}`,
+    )
+  }
+
+  if (temperature !== undefined && (temperature < 0 || temperature > 1)) {
+    throw new Error(
+      `[${packageName}]: \`assist.maxPathDepth\` must be be in the range [0,1] inclusive, but was ${temperature}`,
+    )
+  }
+
   return {
     name: packageName,
     // the addition of global references broke auto updating studios

package/src/schemas/serialize/serializeSchema.test.ts

@@ -150,11 +150,6 @@ describe('serializeSchema', () => {
             }),
             //image without extra fields should be excluded
             defineField({type: 'image', name: 'image'}),
-            // unsupported types
-            defineField({type: 'number', name: 'number'}),
-            defineField({type: 'slug', name: 'slug'}),
-            defineField({type: 'url', name: 'url'}),
-            defineField({type: 'datetime', name: 'datetime'}),
             defineField({type: 'file', name: 'file'}),
             defineField({type: 'reference', name: 'reference', to: [{type: 'excluded'}]}),
             defineField({
@@ -717,7 +712,14 @@ describe('serializeSchema', () => {
         name: 'blockAlias',
         title: 'Block',
         type: 'block',
-        annotations: [],
+        annotations: [
+          {
+            fields: [{name: 'href', title: 'Link', type: 'url'}],
+            name: 'link',
+            title: 'Link',
+            type: 'object',
+          },
+        ],
         inlineOf: [
           {
             name: 'inline-block',

package/src/useApiClient.ts

@@ -3,6 +3,7 @@ import {useToast} from '@sanity/ui'
 import {useCallback, useMemo, useState} from 'react'
 import {Path, pathToString, useClient, useCurrentUser, useSchema} from 'sanity'
 
+import {useAiAssistanceConfig} from './assistLayout/AiAssistanceConfigContext'
 import {ConditionalMemberState} from './helpers/conditionalMembers'
 import {serializeSchema} from './schemas/serialize/serializeSchema'
 import {FieldLanguageMap} from './translate/paths'
@@ -40,13 +41,14 @@ export interface TranslateRequest {
 }
 
 const basePath = '/assist/tasks/instruction'
+const API_VERSION_WITH_EXTENDED_TYPES = '2025-04-01'
 
 export function canUseAssist(status: InstructStatus | undefined) {
   return status?.enabled && status.initialized && status.validToken
 }
 
 export function useApiClient(customApiClient?: (defaultClient: SanityClient) => SanityClient) {
-  const client = useClient({apiVersion: '2023-06-05'})
+  const client = useClient({apiVersion: API_VERSION_WITH_EXTENDED_TYPES})
   return useMemo(
     () => (customApiClient ? customApiClient(client) : client),
     [client, customApiClient],
@@ -278,9 +280,27 @@ export function useRunInstructionApi(apiClient: SanityClient) {
   const schema = useSchema()
   const types = useMemo(() => serializeSchema(schema, {leanFormat: true}), [schema])
 
+  const {
+    config: {assist: assistConfig},
+  } = useAiAssistanceConfig()
+
   const runInstruction = useCallback(
     (request: RunInstructionRequest) => {
+      if (!user) {
+        toast.push({
+          status: 'error',
+          title: 'Unable to get user for instruction.',
+        })
+        return undefined
+      }
       setLoading(true)
+
+      const {timeZone, locale} = Intl.DateTimeFormat().resolvedOptions()
+      const defaultLocaleSettings = {timeZone, locale}
+      const localeSettings =
+        assistConfig?.localeSettings?.({user, defaultSettings: defaultLocaleSettings}) ??
+        defaultLocaleSettings
+
       return apiClient
         .request({
           method: 'POST',
@@ -291,6 +311,8 @@ export function useRunInstructionApi(apiClient: SanityClient) {
             ...request,
             types,
             userId: user?.id,
+            localeSettings,
+            maxPathDepth: assistConfig?.maxPathDepth,
           },
         })
         .catch((e) => {
@@ -305,7 +327,7 @@ export function useRunInstructionApi(apiClient: SanityClient) {
           setLoading(false)
         })
     },
-    [apiClient, types, user, toast],
+    [apiClient, types, user, toast, assistConfig],
   )
 
   return useMemo(