@sanity/assist 4.0.2 → 4.2.0

package/README.md

@@ -407,6 +407,16 @@ The **Generate image description** action will automatically run whenever the im
 `imageDescriptionField` can be a nested field, if the image has an object field, i.e. `imageDescriptionField: 'wrapper.altText'`.
 Fields within array items are not supported.
 
+By default, the caption field will regenerate whenever the image asset changes. To disable this behavior use the following configuration:
+```ts
+{
+  imageDescriptionField: {
+    path: 'wrapper.altText',
+      updateOnImageChange: false
+  }
+}
+```
+
 ## Image generation
 
 <img width="600" alt="image" src="https://github.com/sanity-io/assist/assets/835514/c4de6791-f530-4cd1-b0c2-96ef988bc256">
@@ -915,6 +925,21 @@ the plugin will throw upon studio startup.
 Note that this is currently only available on a global level - it can not be defined
 per-field for now.
 
+### Dynamic styleguide
+
+As of 4.1.0 it is also possible to provide a styleguide async function.
+The function is passed a context object with Sanity client and the current documentId and schemaType. 
+
+Consider caching the results: the function is invoked every time translate runs.
+
+```ts
+assist({
+  translate: {
+    styleguide: ({client, documentId, schemaType}) => client.fetch('* [_id=="styleguide.singleton"][0].styleguide')
+  },
+})
+```
+
 ## Caveats
 
 Large Language Models (LLMs) are a new technology. Constraints and limitations are still being explored,

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import {CurrentUser} from 'sanity'
 import {JSX as JSX_2} from 'react/jsx-runtime'
+import {ObjectSchemaType} from 'sanity'
 import {Path} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PortableTextBlock} from '@portabletext/types'
@@ -339,6 +340,20 @@ declare type PromptTextBlock = Omit<
 
 export declare function SchemaTypeTool(): JSX_2.Element
 
+export declare type TranslateStyleguide =
+  | string
+  | ((context: TranslateStyleguideContext) => Promise<string>)
+
+export declare interface TranslateStyleguideContext {
+  documentId: string
+  schemaType: ObjectSchemaType
+  client: SanityClient
+  /**
+   * Only provided for field translations
+   */
+  translatePath?: Path
+}
+
 export declare interface TranslationConfig {
   /**
    * Config for document types with fields in multiple languages in the same document.
@@ -352,8 +367,10 @@ export declare interface TranslationConfig {
    * A "style guide" that can be used to provide guidance on how to translate content.
    * Will be passed to the LLM - ergo this is only a guide and the model _may_ not
    * always follow it to the letter.
+   *
+   * When providing a function, consider caching the results of any async operation; it will invoked every time translate runs
    */
-  styleguide?: string
+  styleguide?: TranslateStyleguide
 }
 
 export declare interface TranslationOutput {
@@ -457,7 +474,18 @@ declare module 'sanity' {
        * })
        * ```
        */
-      imageDescriptionField?: string
+      imageDescriptionField?:
+        | string
+        | {
+            path: string
+            /**
+             * When updateOnImageChange is true (or undefined), whenever the
+             * image asset changes, imageDescriptionField will be regenerated.
+             *
+             * default:  true
+             * */
+            updateOnImageChange?: boolean
+          }
     }
   }
   interface NumberOptions extends AssistOptions {}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import {CurrentUser} from 'sanity'
 import {JSX as JSX_2} from 'react/jsx-runtime'
+import {ObjectSchemaType} from 'sanity'
 import {Path} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
 import {PortableTextBlock} from '@portabletext/types'
@@ -339,6 +340,20 @@ declare type PromptTextBlock = Omit<
 
 export declare function SchemaTypeTool(): JSX_2.Element
 
+export declare type TranslateStyleguide =
+  | string
+  | ((context: TranslateStyleguideContext) => Promise<string>)
+
+export declare interface TranslateStyleguideContext {
+  documentId: string
+  schemaType: ObjectSchemaType
+  client: SanityClient
+  /**
+   * Only provided for field translations
+   */
+  translatePath?: Path
+}
+
 export declare interface TranslationConfig {
   /**
    * Config for document types with fields in multiple languages in the same document.
@@ -352,8 +367,10 @@ export declare interface TranslationConfig {
    * A "style guide" that can be used to provide guidance on how to translate content.
    * Will be passed to the LLM - ergo this is only a guide and the model _may_ not
    * always follow it to the letter.
+   *
+   * When providing a function, consider caching the results of any async operation; it will invoked every time translate runs
    */
-  styleguide?: string
+  styleguide?: TranslateStyleguide
 }
 
 export declare interface TranslationOutput {
@@ -457,7 +474,18 @@ declare module 'sanity' {
        * })
        * ```
        */
-      imageDescriptionField?: string
+      imageDescriptionField?:
+        | string
+        | {
+            path: string
+            /**
+             * When updateOnImageChange is true (or undefined), whenever the
+             * image asset changes, imageDescriptionField will be regenerated.
+             *
+             * default:  true
+             * */
+            updateOnImageChange?: boolean
+          }
     }
   }
   interface NumberOptions extends AssistOptions {}

package/dist/index.esm.js

@@ -221,7 +221,16 @@ function isImage(schemaType) {
   return isType(schemaType, "image");
 }
 function getDescriptionFieldOption(schemaType) {
-  return schemaType ? schemaType.options?.aiAssist?.imageDescriptionField || getDescriptionFieldOption(schemaType.type) : void 0;
+  if (!schemaType)
+    return;
+  const descriptionField = schemaType.options?.aiAssist?.imageDescriptionField;
+  return typeof descriptionField == "string" ? {
+    path: descriptionField,
+    updateOnImageChange: !0
+  } : descriptionField ? {
+    path: descriptionField.path,
+    updateOnImageChange: descriptionField.updateOnImageChange ?? !0
+  } : getDescriptionFieldOption(schemaType.type);
 }
 function getImageInstructionFieldOption(schemaType) {
   return schemaType ? schemaType.options?.aiAssist?.imageInstructionField || getImageInstructionFieldOption(schemaType.type) : void 0;
@@ -642,30 +651,36 @@ function useTranslate(apiClient) {
       translatePath,
       fieldLanguageMap,
       conditionalMembers
-    }) => (setLoading(!0), apiClient.request({
-      method: "POST",
-      url: `/assist/tasks/translate/${apiClient.config().dataset}?projectId=${apiClient.config().projectId}`,
-      body: {
-        documentId,
-        types,
-        languagePath,
-        userStyleguide: styleguide,
-        fieldLanguageMap,
-        conditionalMembers,
-        translatePath: translatePath.length === 0 ? documentRootKey : pathToString(translatePath),
-        userId: user?.id
+    }) => {
+      setLoading(!0);
+      async function run() {
+        return apiClient.request({
+          method: "POST",
+          url: `/assist/tasks/translate/${apiClient.config().dataset}?projectId=${apiClient.config().projectId}`,
+          body: {
+            documentId,
+            types,
+            languagePath,
+            userStyleguide: await styleguide(),
+            fieldLanguageMap,
+            conditionalMembers,
+            translatePath: translatePath.length === 0 ? documentRootKey : pathToString(translatePath),
+            userId: user?.id
+          }
+        });
       }
-    }).catch((e) => {
-      throw toast.push({
-        status: "error",
-        title: "Translate failed",
-        description: e.message
-      }), setLoading(!1), e;
-    }).finally(() => {
-      setTimeout(() => {
-        setLoading(!1);
-      }, 2e3);
-    })),
+      return run().catch((e) => {
+        throw toast.push({
+          status: "error",
+          title: "Translate failed",
+          description: e.message
+        }), setLoading(!1), e;
+      }).finally(() => {
+        setTimeout(() => {
+          setLoading(!1);
+        }, 2e3);
+      });
+    },
     [setLoading, apiClient, toast, user, types]
   );
   return useMemo(
@@ -2220,6 +2235,21 @@ function AssistConnectorsOverlay(props) {
     DEBUG
   ] });
 }
+function validateStyleguide(styleguide) {
+  if (styleguide && styleguide.length > 2e3)
+    throw new Error(
+      `[${packageName}]: \`translate.styleguide\` value is too long. It must be 2000 characters or less, but was ${styleguide.length} characters`
+    );
+  return styleguide;
+}
+function createStyleGuideResolver(styleguide, context) {
+  return async () => {
+    if (typeof styleguide != "function")
+      return styleguide;
+    const styleguideResult = await styleguide(context);
+    return validateStyleguide(styleguideResult);
+  };
+}
 const getLanguageParams = (select, document2) => {
   if (!select || !document2)
     return {};
@@ -2341,7 +2371,9 @@ function hasValuesToTranslate(fieldLanguageMaps, fromLanguage, basePath2) {
 function FieldTranslationProvider(props) {
   const { config: assistConfig } = useAiAssistanceConfig(), apiClient = useApiClient(assistConfig.__customApiClient), styleguide = assistConfig.translate?.styleguide, config = assistConfig.translate?.field, { translate: runTranslate } = useTranslate(apiClient), [dialogOpen, setDialogOpen] = useState(!1), [fieldTranslationParams, setFieldTranslationParams] = useState(), [languages, setLanguages] = useState(), [fromLanguage, setFromLanguage] = useState(void 0), [toLanguages, setToLanguages] = useState(void 0), [fieldLanguageMaps, setFieldLanguageMaps] = useState(), close = useCallback(() => {
     setDialogOpen(!1), setLanguages(void 0), setFieldTranslationParams(void 0);
-  }, []), languageClient = useClient({ apiVersion: config?.apiVersion ?? "2022-11-27" }), documentId = fieldTranslationParams?.document?._id, id = useId(), selectFromLanguage = useCallback(
+  }, []), languageClient = useClient({
+    apiVersion: config?.apiVersion ?? API_VERSION_WITH_EXTENDED_TYPES
+  }), documentId = fieldTranslationParams?.document?._id, id = useId(), selectFromLanguage = useCallback(
     (from, languages2, params) => {
       const { document: document2, documentSchema } = params ?? {};
       if (setFromLanguage(from), !document2 || !documentSchema || !params || !languages2) {
@@ -2398,7 +2430,12 @@ function FieldTranslationProvider(props) {
     fieldLanguageMaps && documentId && translatePath && runTranslate({
       documentId,
       translatePath,
-      styleguide,
+      styleguide: createStyleGuideResolver(styleguide, {
+        client: languageClient,
+        documentId,
+        schemaType: fieldTranslationParams?.documentSchema,
+        translatePath
+      }),
       fieldLanguageMap: fieldLanguageMaps.map((map) => ({
         ...map,
         // eslint-disable-next-line max-nested-callbacks
@@ -2414,7 +2451,9 @@ function FieldTranslationProvider(props) {
     close,
     toLanguages,
     fieldTranslationParams?.translatePath,
-    fieldTranslationParams?.conditionalMembers
+    fieldTranslationParams?.conditionalMembers,
+    fieldTranslationParams?.documentSchema,
+    languageClient
   ]), runButton = /* @__PURE__ */ jsx(
     Button,
     {
@@ -2544,8 +2583,8 @@ function ImageContextProvider(props) {
   ), isShowingOlderRevision = !!usePaneRouter().params?.rev;
   useEffect(() => {
     const descriptionField = getDescriptionFieldOption(schemaType);
-    assetRef && assistableDocumentId && descriptionField && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
-      path: pathToString([...path, descriptionField]),
+    assetRef && assistableDocumentId && descriptionField?.updateOnImageChange && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
+      path: pathToString([...path, descriptionField.path]),
       documentId: assistableDocumentId
     }));
   }, [
@@ -2563,7 +2602,7 @@ function ImageContextProvider(props) {
   const context = useMemo(() => {
     const descriptionField = getDescriptionFieldOption(schemaType), imageInstructionField = getImageInstructionFieldOption(schemaType);
     return {
-      imageDescriptionPath: descriptionField ? pathToString([...path, descriptionField]) : void 0,
+      imageDescriptionPath: descriptionField?.path ? pathToString([...path, descriptionField.path]) : void 0,
       imageInstructionPath: imageInstructionField ? pathToString([...path, imageInstructionField]) : void 0,
       assetRef
     };
@@ -2602,7 +2641,7 @@ function useAssistSupported(path, schemaType) {
 const translateActions = {
   name: "sanity-assist-translate",
   useAction(props) {
-    const { config, status } = useAiAssistanceConfig(), apiClient = useApiClient(config?.__customApiClient), {
+    const { config, status } = useAiAssistanceConfig(), apiClient = useApiClient(config?.__customApiClient), client = useClient({ apiVersion: API_VERSION_WITH_EXTENDED_TYPES }), {
       schemaType: fieldSchemaType,
       path,
       documentId,
@@ -2630,7 +2669,11 @@ const translateActions = {
             translationApi.loading || !languagePath || !documentId || translate({
               languagePath,
               translatePath: path,
-              styleguide,
+              styleguide: createStyleGuideResolver(styleguide, {
+                client,
+                documentId,
+                schemaType: documentSchemaType
+              }),
               documentId: documentId ?? "",
               conditionalMembers: formStateRef.current ? getConditionalMembers(formStateRef.current) : []
             });
@@ -2646,7 +2689,9 @@ const translateActions = {
         translationApi.loading,
         documentTranslationEnabled,
         path,
-        readOnly
+        readOnly,
+        client,
+        documentSchemaType
       ]), fieldTranslate = useFieldTranslation(), openFieldTranslation = useDraftDelayedTask({
         documentOnChange,
         isDocAssistable: documentIsAssistable ?? !1,
@@ -3887,11 +3932,7 @@ const instructionForm = [
   contextDocumentSchema
 ], assist = definePlugin((config) => {
   const configWithDefaults = config ?? {}, styleguide = configWithDefaults.translate?.styleguide || "", maxPathDepth = configWithDefaults.assist?.maxPathDepth, temperature = configWithDefaults.assist?.temperature;
-  if (styleguide.length > 2e3)
-    throw new Error(
-      `[${packageName}]: \`translate.styleguide\` value is too long. It must be 2000 characters or less, was ${styleguide.length} characters`
-    );
-  if (maxPathDepth !== void 0 && (maxPathDepth < 1 || maxPathDepth > 12))
+  if (typeof styleguide == "string" && validateStyleguide(styleguide), maxPathDepth !== void 0 && (maxPathDepth < 1 || maxPathDepth > 12))
     throw new Error(
       `[${packageName}]: \`assist.maxPathDepth\` must be be in the range [1,12] inclusive, but was ${maxPathDepth}`
     );