@sanity/assist 4.1.0 → 4.3.0

package/dist/index.js

@@ -214,7 +214,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;
@@ -408,10 +417,10 @@ function getFieldRefs(schemaType, parent, depth = 0) {
 }
 function getSyntheticFields(schemaType, parent, depth = 0) {
   return depth >= maxDepth ? [] : schemaType.of.filter((itemType) => !isType(itemType, "block")).flatMap((itemType) => {
-    const segment = { _key: itemType.name }, title = itemType.title ?? itemType.name, path = [...parent.path, segment], fieldRef = {
+    const segment = { _key: itemType.name }, title = itemType.title ?? itemType.name, path = parent ? [...parent.path, segment] : [segment], fieldRef = {
       key: patchableKey(sanity.pathToString(path)),
       path,
-      title: [parent.title, title].join(" / "),
+      title: parent ? [parent.title, title].join(" / ") : title,
       schemaType: itemType,
       icon: getTypeIcon(itemType),
       synthetic: !0
@@ -592,7 +601,6 @@ function serializeInlineOf(blockSchemaType, schema, options2) {
   if (!(!childrenType || !sanity.isArraySchemaType(childrenType)))
     return arrayOf(
       {
-        ...childrenType,
         of: childrenType.of.filter((t) => !isType(t, "span"))
       },
       schema,
@@ -816,6 +824,8 @@ function useRunInstructionApi(apiClient) {
 const NO_INPUT = {}, RunInstructionContext = react.createContext({
   runInstruction: () => {
   },
+  getUserInput: async () => {
+  },
   instructionLoading: !1
 });
 function useRunInstruction() {
@@ -825,7 +835,18 @@ function isUserInputBlock(block) {
   return block._type === userInputTypeName;
 }
 function RunInstructionProvider(props) {
-  const { config } = useAiAssistanceConfig(), apiClient = useApiClient(config?.__customApiClient), { runInstruction: runInstructionRequest, loading } = useRunInstructionApi(apiClient), id = react.useId(), [inputs, setInputs] = react.useState(NO_INPUT), [runRequest, setRunRequest] = react.useState(), runInstruction = react.useCallback(
+  const { config } = useAiAssistanceConfig(), apiClient = useApiClient(config?.__customApiClient), { runInstruction: runInstructionRequest, loading } = useRunInstructionApi(apiClient), id = react.useId(), [inputs, setInputs] = react.useState(NO_INPUT), [runRequest, setRunRequest] = react.useState(), [resolveUserInput, setResolveUserInput] = react.useState(), getUserInput = react.useCallback(async ({ title, inputs: inputs2 }) => {
+    const userInputBlocks = inputs2.map((input, i) => ({
+      _type: userInputTypeName,
+      _key: input.id ?? `${i}`,
+      message: input.title,
+      description: input.description
+    }));
+    if (userInputBlocks.length)
+      return setRunRequest({ dialogTitle: title, userInputBlocks }), new Promise((resolve) => {
+        setResolveUserInput(() => resolve);
+      });
+  }, []), runInstruction = react.useCallback(
     (req) => {
       if (loading)
         return;
@@ -847,21 +868,35 @@ function RunInstructionProvider(props) {
     },
     [runInstructionRequest, loading]
   ), close = react.useCallback(() => {
-    setRunRequest(void 0), setInputs(NO_INPUT);
-  }, []), runWithInput = react.useCallback(() => {
-    if (runRequest) {
-      const { instruction: instruction2, userTexts, ...request } = runRequest;
-      runInstructionRequest({
-        ...request,
-        instructionKey: instruction2._key,
-        userTexts: Object.entries(inputs).map(([key, value]) => ({
-          blockKey: key,
-          userInput: value
-        }))
-      });
-    }
+    setRunRequest(void 0), setInputs(NO_INPUT), resolveUserInput && resolveUserInput(void 0), setResolveUserInput(void 0);
+  }, [resolveUserInput]), runWithInput = react.useCallback(() => {
+    if (runRequest)
+      if ("instruction" in runRequest) {
+        const { instruction: instruction2, userTexts, ...request } = runRequest;
+        runInstructionRequest({
+          ...request,
+          instructionKey: instruction2._key,
+          userTexts: Object.entries(inputs).map(([key, value]) => ({
+            blockKey: key,
+            userInput: value
+          }))
+        });
+      } else {
+        const userInputs = Object.values(inputs).map((input, i) => {
+          const userInputBlock = runRequest.userInputBlocks[i];
+          return {
+            input: {
+              id: userInputBlock._key,
+              title: userInputBlock.message ?? "",
+              description: userInputBlock.description
+            },
+            result: input
+          };
+        });
+        resolveUserInput?.(userInputs), setResolveUserInput(void 0);
+      }
     close();
-  }, [close, runInstructionRequest, runRequest, inputs]), open = !!runRequest, runDisabled = react.useMemo(
+  }, [close, runInstructionRequest, runRequest, inputs, resolveUserInput]), open = !!runRequest, runDisabled = react.useMemo(
     () => (runRequest?.userInputBlocks?.length ?? 0) > Object.entries(inputs).filter(([, value]) => !!value).length,
     [runRequest?.userInputBlocks, inputs]
   ), runButton = /* @__PURE__ */ jsxRuntime.jsx(
@@ -875,7 +910,7 @@ function RunInstructionProvider(props) {
       disabled: runDisabled
     }
   ), contextValue = react.useMemo(
-    () => ({ runInstruction, instructionLoading: loading }),
+    () => ({ runInstruction, getUserInput, instructionLoading: loading }),
     [runInstruction, loading]
   );
   return /* @__PURE__ */ jsxRuntime.jsxs(RunInstructionContext.Provider, { value: contextValue, children: [
@@ -886,7 +921,7 @@ function RunInstructionProvider(props) {
         open,
         onClose: close,
         width: 1,
-        header: getInstructionTitle(runRequest?.instruction),
+        header: "dialogTitle" in runRequest ? runRequest.dialogTitle : getInstructionTitle(runRequest?.instruction),
         footer: /* @__PURE__ */ jsxRuntime.jsx(ui.Flex, { justify: "space-between", padding: 2, flex: 1, children: runDisabled ? /* @__PURE__ */ jsxRuntime.jsx(
           ui.Tooltip,
           {
@@ -984,7 +1019,7 @@ function useAssistDocumentContextValue(documentId, documentType) {
   } = structure.useDocumentPane(), { draft, published, version } = editState || {}, assistableDocumentId = selectedReleaseId ? sanity.getVersionId(documentId, selectedReleaseId) : documentSchemaType.liveEdit ? documentId : sanity.getDraftId(documentId), documentIsNew = selectedReleaseId ? !version?._id : !draft?._id && !published?._id, documentIsAssistable = selectedReleaseId ? !!version : isDocAssistable(documentSchemaType, published, draft), { params } = useAiPaneRouter(), selectedPath = params[fieldPathParam], assistDocument = useStudioAssistDocument({
     documentId: assistableDocumentId,
     schemaType: documentSchemaType
-  });
+  }), { syntheticTasks, addSyntheticTask, removeSyntheticTask } = useSyntheticTasks(assistableDocumentId);
   return react.useMemo(() => {
     const base = {
       assistableDocumentId,
@@ -995,7 +1030,10 @@ function useAssistDocumentContextValue(documentId, documentType) {
       closeInspector,
       inspector,
       documentOnChange,
-      selectedPath
+      selectedPath,
+      syntheticTasks,
+      addSyntheticTask,
+      removeSyntheticTask
     };
     return assistDocument ? {
       ...base,
@@ -1012,9 +1050,26 @@ function useAssistDocumentContextValue(documentId, documentType) {
     closeInspector,
     inspector,
     documentOnChange,
-    selectedPath
+    selectedPath,
+    syntheticTasks,
+    addSyntheticTask,
+    removeSyntheticTask
   ]);
 }
+function useSyntheticTasks(assistableDocumentId) {
+  const [syntheticTasks, setSyntheticTasks] = react.useState(() => []), addSyntheticTask = react.useCallback((task) => {
+    setSyntheticTasks((current) => [...current, task]);
+  }, []), removeSyntheticTask = react.useCallback((task) => {
+    setSyntheticTasks((current) => current.filter((t) => task._key !== t._key));
+  }, []);
+  return react.useEffect(() => {
+    setSyntheticTasks([]);
+  }, [assistableDocumentId]), {
+    syntheticTasks,
+    addSyntheticTask,
+    removeSyntheticTask
+  };
+}
 function AssistDocumentContextProvider(props) {
   const { documentId, documentType } = props, value = useAssistDocumentContextValue(documentId, documentType);
   return /* @__PURE__ */ jsxRuntime.jsx(AssistDocumentContext.Provider, { value, children: props.children });
@@ -1109,49 +1164,14 @@ const fadeIn = styledComponents.keyframes`
 }, ref) {
   return /* @__PURE__ */ jsxRuntime.jsx(FadeInDiv, { ref, style: { animationDuration: `${durationMs}ms` }, children });
 }), purple = {
-  50: {
-    title: "Purple 50",
-    hex: "#f8f5ff"
-  },
-  100: {
-    title: "Purple 100",
-    hex: "#f1ebff"
-  },
-  200: {
-    title: "Purple 200",
-    hex: "#ece1fe"
-  },
-  300: {
-    title: "Purple 300",
-    hex: "#ccb1fc"
-  },
   400: {
-    title: "Purple 400",
     hex: "#b087f7"
   },
   500: {
-    title: "Purple 500",
     hex: "#8f57ef"
   },
   600: {
-    title: "Purple 600",
     hex: "#721fe5"
-  },
-  700: {
-    title: "Purple 700",
-    hex: "#4c1a9e"
-  },
-  800: {
-    title: "Purple 800",
-    hex: "#2f1862"
-  },
-  900: {
-    title: "Purple 900",
-    hex: "#23173f"
-  },
-  950: {
-    title: "Purple 950",
-    hex: "#181128"
   }
 }, Root = styledComponents.styled.span`
   display: block;
@@ -2567,8 +2587,8 @@ function ImageContextProvider(props) {
   ), isShowingOlderRevision = !!structure.usePaneRouter().params?.rev;
   react.useEffect(() => {
     const descriptionField = getDescriptionFieldOption(schemaType);
-    assetRef && assistableDocumentId && descriptionField && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
-      path: sanity.pathToString([...path, descriptionField]),
+    assetRef && assistableDocumentId && descriptionField?.updateOnImageChange && assetRef !== assetRefState && !isSyncing && !isShowingOlderRevision && !readOnly && (setAssetRefState(assetRef), canUseAssist(status) && generateCaption({
+      path: sanity.pathToString([...path, descriptionField.path]),
       documentId: assistableDocumentId
     }));
   }, [
@@ -2586,7 +2606,7 @@ function ImageContextProvider(props) {
   const context = react.useMemo(() => {
     const descriptionField = getDescriptionFieldOption(schemaType), imageInstructionField = getImageInstructionFieldOption(schemaType);
     return {
-      imageDescriptionPath: descriptionField ? sanity.pathToString([...path, descriptionField]) : void 0,
+      imageDescriptionPath: descriptionField?.path ? sanity.pathToString([...path, descriptionField.path]) : void 0,
       imageInstructionPath: imageInstructionField ? sanity.pathToString([...path, imageInstructionField]) : void 0,
       assetRef
     };
@@ -2792,6 +2812,129 @@ function PrivateIcon() {
     }
   );
 }
+function getRandomValues(typedArray) {
+  const crypto = typeof window < "u" && "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(length = 16) {
+  const rnds8 = new Uint8Array(length);
+  return getRandomValues(rnds8), rnds8;
+}
+const getByteHexTable = /* @__PURE__ */ (() => {
+  let table;
+  return () => {
+    if (table)
+      return table;
+    table = [];
+    for (let i = 0; i < 256; ++i)
+      table[i] = (i + 256).toString(16).substring(1);
+    return table;
+  };
+})();
+function randomKey(length) {
+  const table = getByteHexTable();
+  return whatwgRNG(length).reduce((str, n) => str + table[n], "").slice(0, length);
+}
+function defineAssistFieldAction(action) {
+  return {
+    ...action,
+    type: "action"
+  };
+}
+function defineFieldActionDivider() {
+  return {
+    type: "divider"
+  };
+}
+function defineAssistFieldActionGroup(group) {
+  return {
+    ...group,
+    type: "group"
+  };
+}
+function useCustomFieldActions(props) {
+  const {
+    config: { fieldActions }
+  } = useAiAssistanceConfig(), { addSyntheticTask, removeSyntheticTask } = useAssistDocumentContext(), schemaId = sanity.useWorkspaceSchemaId(), { push: pushToast } = ui.useToast(), configActions = fieldActions?.useFieldActions?.({
+    ...props,
+    schemaId,
+    path: props.path
+  });
+  return react.useMemo(() => {
+    const title = fieldActions?.title, customActions = configActions?.map((node) => createSafeNode({
+      node,
+      pushToast,
+      addSyntheticTask,
+      removeSyntheticTask
+    })), onlyGroups = customActions?.length && customActions?.every((node) => node.type === "group");
+    return (customActions?.length ? onlyGroups ? customActions : [
+      {
+        type: "group",
+        title: title || "Custom actions",
+        children: customActions,
+        expanded: !0
+      }
+    ] : []) ?? [];
+  }, [configActions, fieldActions, pushToast]);
+}
+function createSafeNode(args) {
+  const { node } = args;
+  switch (node.type) {
+    case "action":
+      return createSafeAction({ ...args, action: node });
+    case "group":
+      return {
+        ...node,
+        renderAsButton: !1,
+        expanded: !0,
+        children: node.children?.map((child) => createSafeNode({ ...args, node: child }))
+      };
+    case "divider":
+    default:
+      return node;
+  }
+}
+function createSafeAction(args) {
+  const { action, pushToast, addSyntheticTask, removeSyntheticTask } = args;
+  return {
+    ...action,
+    onAction: () => {
+      async function runAction() {
+        const task = {
+          _type: instructionTaskTypeName,
+          _key: randomKey(12),
+          started: (/* @__PURE__ */ new Date()).toISOString(),
+          presence: [
+            {
+              _type: fieldPresenceTypeName,
+              _key: randomKey(12),
+              path: documentRootKey,
+              started: (/* @__PURE__ */ new Date()).toISOString()
+            }
+          ]
+        };
+        try {
+          addSyntheticTask(task);
+          const actionResult = action.onAction?.();
+          actionResult instanceof Promise && await actionResult;
+        } catch (err) {
+          console.error("Failed to execute action", action, err), pushToast({
+            title: "Failed to execute action",
+            description: err?.message,
+            status: "error"
+          });
+        } finally {
+          removeSyntheticTask(task);
+        }
+      }
+      runAction();
+    },
+    renderAsButton: !1,
+    selected: !1
+  };
+}
 const assistFieldActions = {
   name: "sanity-assist-actions",
   useAction(props) {
@@ -2806,7 +2949,7 @@ const assistFieldActions = {
       documentSchemaType,
       selectedPath,
       assistableDocumentId
-    } = useAssistDocumentContext(), { value: docValue, formState } = structure.useDocumentPane(), formStateRef = react.useRef(formState);
+    } = useAssistDocumentContext(), { value: docValue, formState } = structure.useDocumentPane(), docValueRef = react.useRef(docValue), formStateRef = react.useRef(formState);
     formStateRef.current = formState;
     const currentUser = sanity.useCurrentUser(), isHidden = !assistDocument, pathKey = usePathKey(props.path), typePath = useTypePath(docValue, pathKey), assistDocumentId2 = assistDocument?._id, { requestRunInstruction } = useRequestRunInstruction({
       documentOnChange,
@@ -2868,7 +3011,6 @@ const assistFieldActions = {
             isPrivate: !!(instruction2.userId && instruction2.userId === currentUser?.id),
             onInstructionAction,
             hidden: isHidden,
-            documentIsNew: !!documentIsNew,
             assistSupported
           })
         ) || [],
@@ -2886,7 +3028,23 @@ const assistFieldActions = {
       imageCaptionAction,
       translateAction,
       imageGenAction
-    ]), instructionsLength = instructions?.length || 0, manageInstructionsItem = react.useMemo(
+    ]), getDocumentValue = react.useCallback(() => docValueRef.current, []), getConditionalPaths = react.useCallback(() => (formStateRef.current ? getConditionalMembers(formStateRef.current) : []).flatMap(
+      (cm) => {
+        const path = sanity.stringToPath(cm.path);
+        return path.some((s) => typeof s == "number") ? [] : {
+          ...cm,
+          path
+        };
+      }
+    ), []), customActions = useCustomFieldActions({
+      actionType: props.path.length ? "field" : "document",
+      documentIdForAction: assistableDocumentId,
+      schemaType,
+      documentSchemaType,
+      path: props.path,
+      getDocumentValue,
+      getConditionalPaths
+    }), manageInstructionsItem = react.useMemo(
       () => ({
         type: "action",
         icon: icons.ControlsIcon,
@@ -2903,6 +3061,7 @@ const assistFieldActions = {
         children: [
           runInstructionsGroup,
           translateAction,
+          ...customActions,
           assistSupported && manageInstructionsItem
         ].filter((c) => !!c).filter((c) => c.type === "group" ? c.children.length : !0),
         expanded: !1,
@@ -2916,7 +3075,8 @@ const assistFieldActions = {
         assistSupported,
         imageCaptionAction,
         translateAction,
-        imageGenAction
+        imageGenAction,
+        customActions
       ]
     ), emptyAction = react.useMemo(
       () => ({
@@ -2930,7 +3090,7 @@ const assistFieldActions = {
       }),
       [assistSupported, manageInstructions, isSelected]
     );
-    return instructionsLength === 0 && !imageCaptionAction && !translateAction && !imageGenAction ? emptyAction : group;
+    return !instructions?.length && !imageCaptionAction && !translateAction && !imageGenAction && !customActions.length ? emptyAction : group;
   }
 };
 function instructionItem(props) {
@@ -2951,21 +3111,19 @@ function createAssistDocumentPresence(documentId) {
   };
 }
 function AssistDocumentPresence() {
-  const { assistDocument } = useAssistDocumentContext(), anyPresence = react.useMemo(() => {
-    const anyPresence2 = assistDocument?.tasks?.filter((run) => !run.ended && !run.reason)?.flatMap((run) => run.presence ?? []).find((f) => f.started && (/* @__PURE__ */ new Date()).getTime() - new Date(f.started).getTime() < 3e4);
+  const { assistDocument, syntheticTasks } = useAssistDocumentContext(), anyPresence = react.useMemo(() => {
+    const anyPresence2 = [...assistDocument?.tasks ?? [], ...syntheticTasks ?? []].filter((run) => !run.ended && !run.reason)?.flatMap((run) => run.presence ?? []).find((f) => f.started && (/* @__PURE__ */ new Date()).getTime() - new Date(f.started).getTime() < 3e4);
     if (anyPresence2)
       return aiPresence(anyPresence2, []);
     const anyRun = assistDocument?.tasks?.filter((run) => !run.ended && !run.reason)?.find((f) => f.started && (/* @__PURE__ */ new Date()).getTime() - new Date(f.started).getTime() < 3e4);
     return anyRun ? aiPresence(
       {
         started: anyRun.started,
-        path: documentRootKey,
-        _key: anyRun._key,
-        _type: fieldPresenceTypeName
+        _key: anyRun._key
       },
       []
     ) : void 0;
-  }, [assistDocument?.tasks]);
+  }, [assistDocument?.tasks, syntheticTasks]);
   return /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { children: /* @__PURE__ */ jsxRuntime.jsx(ui.Flex, { flex: 1, justify: "flex-end", children: /* @__PURE__ */ jsxRuntime.jsx(ui.Flex, { gap: 2, align: "center", children: anyPresence && /* @__PURE__ */ jsxRuntime.jsx(AiFieldPresence, { presence: anyPresence }) }) }) });
 }
 function BackToInstructionListLink() {
@@ -3359,31 +3517,6 @@ function Selectable({
     /* @__PURE__ */ jsxRuntime.jsx(ui.Card, { marginTop: 1, onClick: handleChange, children: /* @__PURE__ */ jsxRuntime.jsx(ui.Text, { style: { cursor: "default" }, size: 1, children: title }) })
   ] });
 }
-function getRandomValues(typedArray) {
-  const crypto = typeof window < "u" && "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(length = 16) {
-  const rnds8 = new Uint8Array(length);
-  return getRandomValues(rnds8), rnds8;
-}
-const getByteHexTable = /* @__PURE__ */ (() => {
-  let table;
-  return () => {
-    if (table)
-      return table;
-    table = [];
-    for (let i = 0; i < 256; ++i)
-      table[i] = (i + 256).toString(16).substring(1);
-    return table;
-  };
-})();
-function randomKey(length) {
-  const table = getByteHexTable();
-  return whatwgRNG(length).reduce((str, n) => str + table[n], "").slice(0, length);
-}
 const PteMods = styledComponents.styled(ui.Box)`
   & [data-testid='pt-editor__toolbar-card'] > div > div:last-child {
     display: none;
@@ -4084,8 +4217,16 @@ function SchemaEntry({ schemaStub }) {
   const out = react.useMemo(() => JSON.stringify(schemaStub, null, 2), [schemaStub]);
   return /* @__PURE__ */ jsxRuntime.jsx("pre", { children: out });
 }
+function useUserInput() {
+  const { getUserInput } = useRunInstruction();
+  return getUserInput;
+}
 exports.SchemaTypeTool = SchemaTypeTool;
 exports.assist = assist;
 exports.contextDocumentTypeName = contextDocumentTypeName;
 exports.defaultLanguageOutputs = defaultLanguageOutputs;
+exports.defineAssistFieldAction = defineAssistFieldAction;
+exports.defineAssistFieldActionGroup = defineAssistFieldActionGroup;
+exports.defineFieldActionDivider = defineFieldActionDivider;
+exports.useUserInput = useUserInput;
 //# sourceMappingURL=index.js.map