@sanity/assist 3.2.2 → 4.0.1

package/dist/index.mjs

@@ -236,7 +236,7 @@ function isDisabled(type) {
   return !isSchemaAssistEnabled(type) || isUnsupportedType(type);
 }
 function isUnsupportedType(type) {
-  return type.jsonType === "number" || type.name === "sanity.imageCrop" || type.name === "sanity.imageHotspot" || isType(type, "globalDocumentReference") || isType(type, "reference") && !type?.options?.aiAssist?.embeddingsIndex || isType(type, "crossDatasetReference") || isType(type, "slug") || isType(type, "url") || isType(type, "date") || isType(type, "datetime") || isType(type, "file");
+  return type.name === "sanity.imageCrop" || type.name === "sanity.imageHotspot" || isType(type, "globalDocumentReference") || isType(type, "reference") && !type?.options?.aiAssist?.embeddingsIndex || isType(type, "crossDatasetReference") || isType(type, "file");
 }
 const FirstAssistedPathContext = createContext(void 0);
 function FirstAssistedPathProvider(props) {
@@ -466,6 +466,39 @@ function useAiPaneRouter() {
     [paneRouter]
   );
 }
+const AiAssistanceConfigContext = createContext({});
+function useAiAssistanceConfig() {
+  const context = useContext(AiAssistanceConfigContext);
+  if (!context)
+    throw new Error("Missing AiAssistanceConfigContext");
+  return context;
+}
+function AiAssistanceConfigProvider(props) {
+  const [status, setStatus] = useState(), [error, setError] = useState(), apiClient = useApiClient(props.config?.__customApiClient), { getInstructStatus, loading: statusLoading } = useGetInstructStatus(apiClient), { initInstruct, loading: initLoading } = useInitInstruct(apiClient);
+  useEffect(() => {
+    getInstructStatus().then((s) => setStatus(s)).catch((e) => {
+      console.error(e), setError(e);
+    });
+  }, [getInstructStatus]);
+  const init = useCallback(async () => {
+    setError(void 0);
+    try {
+      await initInstruct();
+      const status2 = await getInstructStatus();
+      setStatus(status2);
+    } catch (e) {
+      console.error("Failed to init ai assistance", e), setError(e);
+    }
+  }, [initInstruct, getInstructStatus, setStatus]), { config, children } = props, context = useMemo(() => ({
+    config,
+    status,
+    statusLoading,
+    init,
+    initLoading,
+    error
+  }), [config, status, init, statusLoading, initLoading, error]);
+  return /* @__PURE__ */ jsx(AiAssistanceConfigContext.Provider, { value: context, children });
+}
 const hiddenTypes = [
   "any",
   "array",
@@ -589,12 +622,12 @@ function refToTypeNames(type) {
 function removeUndef(obj) {
   return Object.keys(obj).forEach((key) => obj[key] === void 0 ? delete obj[key] : {}), obj;
 }
-const basePath = "/assist/tasks/instruction";
+const basePath = "/assist/tasks/instruction", API_VERSION_WITH_EXTENDED_TYPES = "2025-04-01";
 function canUseAssist(status) {
   return status?.enabled && status.initialized && status.validToken;
 }
 function useApiClient(customApiClient) {
-  const client = useClient({ apiVersion: "2023-06-05" });
+  const client = useClient({ apiVersion: API_VERSION_WITH_EXTENDED_TYPES });
   return useMemo(
     () => customApiClient ? customApiClient(client) : client,
     [client, customApiClient]
@@ -738,25 +771,40 @@ function useInitInstruct(apiClient) {
   };
 }
 function useRunInstructionApi(apiClient) {
-  const toast = useToast(), [loading, setLoading] = useState(!1), user = useCurrentUser(), schema = useSchema(), types = useMemo(() => serializeSchema(schema, { leanFormat: !0 }), [schema]), runInstruction = useCallback(
-    (request) => (setLoading(!0), apiClient.request({
-      method: "POST",
-      url: `${basePath}/${apiClient.config().dataset}?projectId=${apiClient.config().projectId}`,
-      body: {
-        ...request,
-        types,
-        userId: user?.id
+  const toast = useToast(), [loading, setLoading] = useState(!1), user = useCurrentUser(), schema = useSchema(), types = useMemo(() => serializeSchema(schema, { leanFormat: !0 }), [schema]), {
+    config: { assist: assistConfig }
+  } = useAiAssistanceConfig(), runInstruction = useCallback(
+    (request) => {
+      if (!user) {
+        toast.push({
+          status: "error",
+          title: "Unable to get user for instruction."
+        });
+        return;
       }
-    }).catch((e) => {
-      throw toast.push({
-        status: "error",
-        title: "Instruction failed",
-        description: e.message
-      }), e;
-    }).finally(() => {
-      setLoading(!1);
-    })),
-    [apiClient, types, user, toast]
+      setLoading(!0);
+      const { timeZone, locale } = Intl.DateTimeFormat().resolvedOptions(), defaultLocaleSettings = { timeZone, locale }, localeSettings = assistConfig?.localeSettings?.({ user, defaultSettings: defaultLocaleSettings }) ?? defaultLocaleSettings;
+      return apiClient.request({
+        method: "POST",
+        url: `${basePath}/${apiClient.config().dataset}?projectId=${apiClient.config().projectId}`,
+        body: {
+          ...request,
+          types,
+          userId: user?.id,
+          localeSettings,
+          maxPathDepth: assistConfig?.maxPathDepth
+        }
+      }).catch((e) => {
+        throw toast.push({
+          status: "error",
+          title: "Instruction failed",
+          description: e.message
+        }), e;
+      }).finally(() => {
+        setLoading(!1);
+      });
+    },
+    [apiClient, types, user, toast, assistConfig]
   );
   return useMemo(
     () => ({
@@ -766,39 +814,6 @@ function useRunInstructionApi(apiClient) {
     [runInstruction, loading]
   );
 }
-const AiAssistanceConfigContext = createContext({});
-function useAiAssistanceConfig() {
-  const context = useContext(AiAssistanceConfigContext);
-  if (!context)
-    throw new Error("Missing AiAssistanceConfigContext");
-  return context;
-}
-function AiAssistanceConfigProvider(props) {
-  const [status, setStatus] = useState(), [error, setError] = useState(), apiClient = useApiClient(props.config?.__customApiClient), { getInstructStatus, loading: statusLoading } = useGetInstructStatus(apiClient), { initInstruct, loading: initLoading } = useInitInstruct(apiClient);
-  useEffect(() => {
-    getInstructStatus().then((s) => setStatus(s)).catch((e) => {
-      console.error(e), setError(e);
-    });
-  }, [getInstructStatus]);
-  const init = useCallback(async () => {
-    setError(void 0);
-    try {
-      await initInstruct();
-      const status2 = await getInstructStatus();
-      setStatus(status2);
-    } catch (e) {
-      console.error("Failed to init ai assistance", e), setError(e);
-    }
-  }, [initInstruct, getInstructStatus, setStatus]), { config, children } = props, context = useMemo(() => ({
-    config,
-    status,
-    statusLoading,
-    init,
-    initLoading,
-    error
-  }), [config, status, init, statusLoading, initLoading, error]);
-  return /* @__PURE__ */ jsx(AiAssistanceConfigContext.Provider, { value: context, children });
-}
 const NO_INPUT = {}, RunInstructionContext = createContext({
   runInstruction: () => {
   },
@@ -967,10 +982,7 @@ function useAssistDocumentContextValue(documentId, documentType) {
     // @ts-ignore this is a valid option available in `corel` - Remove after corel is merged to next
     selectedReleaseId,
     editState
-  } = useDocumentPane(), { draft, published, version } = editState || {};
-  let assistableDocumentId = version?._id || draft?._id || published?._id;
-  assistableDocumentId || (assistableDocumentId = selectedReleaseId ? getVersionId(documentId, selectedReleaseId) : documentSchemaType.liveEdit ? documentId : getDraftId(documentId));
-  const documentIsNew = selectedReleaseId ? !version?._id : !draft?._id && !published?._id, documentIsAssistable = selectedReleaseId ? !!version : isDocAssistable(documentSchemaType, published, draft), { params } = useAiPaneRouter(), selectedPath = params[fieldPathParam], assistDocument = useStudioAssistDocument({
+  } = useDocumentPane(), { draft, published, version } = editState || {}, assistableDocumentId = selectedReleaseId ? getVersionId(documentId, selectedReleaseId) : documentSchemaType.liveEdit ? documentId : 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
   });
@@ -1975,7 +1987,7 @@ function AssistInspector(props) {
               mode: "ghost",
               disabled: isEmptyPrompt || instructionLoading,
               fontSize: 1,
-              icon: instructionLoading ? /* @__PURE__ */ jsx(Spinner, {}) : PlayIcon,
+              icon: instructionLoading ? /* @__PURE__ */ jsx(Spinner, { style: { marginTop: 3 } }) : PlayIcon,
               onClick: runCurrentInstruction,
               padding: 3,
               text: "Run instruction"
@@ -3871,11 +3883,19 @@ const instructionForm = [
   instructionTask,
   contextDocumentSchema
 ], assist = definePlugin((config) => {
-  const configWithDefaults = config ?? {}, styleguide = configWithDefaults.translate?.styleguide || "";
+  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))
+    throw new Error(
+      `[${packageName}]: \`assist.maxPathDepth\` must be be in the range [1,12] inclusive, but was ${maxPathDepth}`
+    );
+  if (temperature !== void 0 && (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,
     handlesGDR: !0,