@sanity/assist 2.0.0 → 2.0.1

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import {JSX as JSX_2} from 'react/jsx-runtime'
 import {Path} from 'sanity'
 import {Plugin as Plugin_2} from 'sanity'
+import {PortableTextBlock} from '@portabletext/types'
+import {PortableTextMarkDefinition} from '@portabletext/types'
+import {PortableTextSpan} from '@portabletext/types'
 import {SanityClient} from 'sanity'
 import {SanityClient as SanityClient_2} from '@sanity/client'
 import {SchemaType} from 'sanity'
@@ -25,6 +28,22 @@ declare interface AssistPluginConfig {
    * @internal
    */
   __customApiClient?: (defaultClient: SanityClient_2) => SanityClient_2
+  /**
+   * @internal
+   */
+  __presets?: Record<string, AssistPreset>
+}
+
+declare interface AssistPreset {
+  fields?: PresetField[]
+}
+
+declare interface ContextBlock {
+  _type: typeof instructionContextTypeName
+  reference?: {
+    _type: 'reference'
+    _ref?: string
+  }
 }
 
 export declare const contextDocumentTypeName: 'assist.instruction.context'
@@ -65,6 +84,13 @@ export declare interface DocumentTranslationConfig {
   documentTypes?: string[]
 }
 
+declare interface FieldRef extends PortableTextMarkDefinition {
+  _type: typeof fieldReferenceTypeName
+  path?: string
+}
+
+declare const fieldReferenceTypeName: 'sanity.assist.instruction.fieldRef'
+
 export declare interface FieldTranslationConfig {
   /**
    * `documentTypes` should be an array of strings where each entry must match a name from your document schemas.
@@ -156,6 +182,10 @@ export declare interface FieldTranslationConfig {
   translationOutputs?: TranslationOutputsFunction
 }
 
+declare type InlinePromptBlock = PortableTextSpan | FieldRef | UserInputBlock | ContextBlock
+
+declare const instructionContextTypeName: 'sanity.assist.instruction.context'
+
 export declare interface Language {
   id: string
   title?: string
@@ -166,6 +196,49 @@ export declare type LanguageCallback = (
   selectedLanguageParams: Record<string, unknown>,
 ) => Promise<Language[]>
 
+declare interface OutputFieldItem {
+  _type: typeof outputFieldTypeName
+  _key: string
+  relativePath?: string
+}
+
+declare const outputFieldTypeName: 'sanity.assist.output.field'
+
+declare interface OutputTypeItem {
+  _type: typeof outputTypeTypeName
+  _key: string
+  type?: string
+  relativePath?: string
+}
+
+declare const outputTypeTypeName: 'sanity.assist.output.type'
+
+declare interface PresetField {
+  path?: string
+  instructions?: PresetInstruction[]
+}
+
+declare interface PresetInstruction {
+  _key: string
+  prompt?: PromptTextBlock[]
+  title?: string
+  /**
+   * String key from @sanity/icons IconMap
+   */
+  icon?: string
+  /**
+   * Type/field filter
+   */
+  output?: (OutputFieldItem | OutputTypeItem)[]
+}
+
+declare type PromptTextBlock = Omit<
+  PortableTextBlock<never, InlinePromptBlock, 'normal', never>,
+  '_type'
+> & {
+  _type: 'block'
+}
+
 export declare function SchemaTypeTool(): JSX_2.Element
 
 export declare interface TranslationConfig {
@@ -192,6 +265,15 @@ export declare type TranslationOutputsFunction = (
   translateToLanguageIds: string[],
 ) => TranslationOutput[] | undefined
 
+declare interface UserInputBlock {
+  _type: typeof userInputTypeName
+  _key: string
+  message?: string
+  description?: string
+}
+
+declare const userInputTypeName: 'sanity.assist.instruction.userInput'
+
 export {}
 
 declare module 'sanity' {

package/dist/index.esm.js

@@ -885,12 +885,15 @@ function TimeAgo(_ref3) {
 }
 function usePathKey(path) {
   return useMemo(() => {
-    if (path.length) {
-      return Array.isArray(path) ? pathToString(path) : path;
-    }
-    return documentRootKey;
+    return getPathKey(path);
   }, [path]);
 }
+function getPathKey(path) {
+  if (path.length) {
+    return Array.isArray(path) ? pathToString(path) : path;
+  }
+  return documentRootKey;
+}
 function getInstructionTitle(instruction) {
   var _a;
   return (_a = instruction == null ? void 0 : instruction.title) != null ? _a : "Untitled";
@@ -1099,6 +1102,9 @@ function TaskItem(props) {
   });
 }
 const basePath = "/assist/tasks/instruction";
+function canUseAssist(status) {
+  return (status == null ? void 0 : status.enabled) && status.initialized && status.validToken;
+}
 function useApiClient(customApiClient) {
   const client = useClient({
     apiVersion: "2023-06-05"
@@ -1757,7 +1763,6 @@ function AssistDocumentFormEditable(props) {
       onChange(set((_a = documentSchema.title) != null ? _a : documentSchema.name, ["title"]));
     }
   }, [title, documentSchema, onChange, id]);
-  const fieldExists = !!(fields == null ? void 0 : fields.some(f => f._key === typePath));
   const {
     onPathOpen,
     ...formCallbacks
@@ -1789,7 +1794,8 @@ function AssistDocumentFormEditable(props) {
       children: [/* @__PURE__ */jsx(FieldsInitializer, {
         pathKey: typePath,
         activePath,
-        fieldExists,
+        fields,
+        documentSchema,
         onChange
       }, typePath), instruction && /* @__PURE__ */jsx(BackToInstructionListLink, {}), activePath && /* @__PURE__ */jsx(FormCallbacksProvider, {
         ...newCallbacks,
@@ -1837,21 +1843,60 @@ function FieldsInitializer(_ref9) {
   let {
     pathKey,
     activePath,
-    fieldExists,
+    fields,
+    documentSchema,
     onChange
   } = _ref9;
+  const {
+    config: {
+      __presets: presets
+    }
+  } = useAiAssistanceConfig();
+  const existingField = fields == null ? void 0 : fields.find(f => f._key === pathKey);
+  const documentPresets = !!(documentSchema == null ? void 0 : documentSchema.name) && (presets == null ? void 0 : presets[documentSchema == null ? void 0 : documentSchema.name]);
+  const missingPresetInstructions = useMemo(() => {
+    var _a, _b;
+    if (!documentPresets || !pathKey) {
+      return void 0;
+    }
+    const existingInstructions = existingField == null ? void 0 : existingField.instructions;
+    const presetField = (_a = documentPresets.fields) == null ? void 0 : _a.find(f => f.path === pathKey);
+    return (_b = presetField == null ? void 0 : presetField.instructions) == null ? void 0 : _b.filter(i => !(existingInstructions == null ? void 0 : existingInstructions.some(ei => ei._key === i._key)));
+  }, [documentPresets, pathKey, existingField]);
   const initialized = useRef(false);
   useEffect(() => {
-    if (initialized.current || fieldExists || activePath || !pathKey) {
+    if (initialized.current || !pathKey) {
       return;
     }
-    onChange([setIfMissing([], ["fields"]), insert([typed({
-      _key: pathKey,
-      _type: assistFieldTypeName,
-      path: pathKey
-    })], "after", ["fields", -1])]);
+    if (existingField && !(missingPresetInstructions == null ? void 0 : missingPresetInstructions.length)) {
+      return;
+    }
+    let event = PatchEvent.from([setIfMissing([], ["fields"])]);
+    if (!existingField) {
+      event = event.append(insert([typed({
+        _key: pathKey,
+        _type: assistFieldTypeName,
+        path: pathKey
+      })], "after", ["fields", -1]));
+    }
+    if (missingPresetInstructions == null ? void 0 : missingPresetInstructions.length) {
+      event = event.append(insert(missingPresetInstructions.map(preset => {
+        var _a;
+        return {
+          ...preset,
+          _type: "sanity.assist.instruction",
+          prompt: (_a = preset.prompt) == null ? void 0 : _a.map(p => ({
+            markDefs: [],
+            ...p
+          }))
+        };
+      }), "after", ["fields", {
+        _key: pathKey
+      }, "instructions", -1]));
+    }
+    onChange(event);
     initialized.current = true;
-  }, [activePath, onChange, pathKey, fieldExists]);
+  }, [activePath, onChange, pathKey, existingField, missingPresetInstructions]);
   return null;
 }
 function FieldAutocomplete(props) {
@@ -5310,7 +5355,11 @@ const contextDocumentSchema = defineType({
 // Strict ESM env, designed to run outside Node.js in envs that provide WebCrypto (deno, browsers, etc)
 
 function getRandomValues(typedArray) {
-  return window.crypto.getRandomValues(typedArray);
+  const crypto = typeof window !== 'undefined' && 'crypto' in window ? window.crypto : globalThis.crypto;
+  if (!crypto || !crypto.getRandomValues) {
+    throw new Error('WebCrypto not available in this environment');
+  }
+  return crypto.getRandomValues(typedArray);
 }
 function whatwgRNG() {
   let length = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 16;
@@ -5318,7 +5367,7 @@ function whatwgRNG() {
   getRandomValues(rnds8);
   return rnds8;
 }
-const getByteHexTable = (() => {
+const getByteHexTable = /* @__PURE__ */(() => {
   let table;
   return () => {
     if (table) {
@@ -6130,7 +6179,8 @@ function ImageContextProvider(props) {
     documentSchemaType
   } = useAssistDocumentContext();
   const {
-    config
+    config,
+    status
   } = useAiAssistanceConfig();
   const apiClient = useApiClient(config == null ? void 0 : config.__customApiClient);
   const {
@@ -6141,14 +6191,14 @@ function ImageContextProvider(props) {
   } = useSyncState(publicId(documentId), documentSchemaType.name);
   useEffect(() => {
     const descriptionField = getDescriptionFieldOption(schemaType);
-    if (assetRef && documentId && descriptionField && assetRef !== assetRefState && !isSyncing) {
+    if (assetRef && documentId && descriptionField && assetRef !== assetRefState && !isSyncing && canUseAssist(status)) {
       setAssetRefState(assetRef);
       generateCaption({
         path: pathToString([...path, descriptionField]),
         documentId
       });
     }
-  }, [schemaType, path, assetRef, assetRefState, documentId, generateCaption, isSyncing]);
+  }, [schemaType, path, assetRef, assetRefState, documentId, generateCaption, isSyncing, status]);
   const context = useMemo(() => {
     const descriptionField = getDescriptionFieldOption(schemaType);
     const imageInstructionField = getImageInstructionFieldOption(schemaType);
@@ -6171,7 +6221,11 @@ const generateCaptionsActions = {
   useAction(props) {
     const pathKey = usePathKey(props.path);
     const {
-      config
+      openInspector
+    } = useDocumentPane();
+    const {
+      config,
+      status
     } = useAiAssistanceConfig();
     const apiClient = useApiClient(config == null ? void 0 : config.__customApiClient);
     const {
@@ -6201,6 +6255,13 @@ const generateCaptionsActions = {
             if (loading) {
               return;
             }
+            if (!canUseAssist(status)) {
+              openInspector(aiInspectorId, {
+                [fieldPathParam]: pathKey,
+                [instructionParam]: void 0
+              });
+              return;
+            }
             generateCaption({
               path: pathKey,
               documentId: documentId != null ? documentId : ""
@@ -6210,7 +6271,7 @@ const generateCaptionsActions = {
           disabled: loading,
           hidden: !imageContext.assetRef
         });
-      }, [generateCaption, pathKey, documentId, loading, imageContext]);
+      }, [generateCaption, pathKey, documentId, loading, imageContext, status, openInspector]);
     }
     return void 0;
   }