@sanity/assist 1.2.2 → 1.2.4

package/README.md

@@ -10,6 +10,7 @@
 - [Setup](#setup)
   - [Add the plugin](#add-the-plugin)
   - [Enabling the AI Assist API](#enabling-the-ai-assist-api)
+  - [Permissions](#permissions)
 - [Schema configuration](#schema-configuration)
   - [Disable AI Assist for a schema type](#disable-ai-assist-for-a-schema-type)
   - [Disable for a field](#disable-for-a-field)
@@ -89,6 +90,18 @@ The plugin will now work for any dataset in your project.
 
 **Note:** You can revoke this token at any time to disable Sanity AI Assist service. A new token has to be generated via the plugin UI for it to work again.
 
+### Permissions
+
+If your project is using custom roles (Enterprise), there are some additional considerations.
+
+To see AI Assist presence when running instructions, users will need read access to
+documents of `_type=="sanity.assist.task.status"`.
+
+To edit instructions, users will need read and write access to documents of `_type=="sanity.assist.schemaType.annotations"`.
+
+Note that instructions run using the permissions of the user invoking it, so only fields that the user
+themselves can edit can be changed by the instruction instance.
+
 ## Schema configuration
 
 By default, most object, array, and string field types have AI writing assistance enabled. Your assistant can write to all compatible fields that it detects.
@@ -224,7 +237,7 @@ defineField({
     options: {
       captionField: 'caption', 
     },
-}),
+})
 ```
 This will add a "Generate caption" action to the configured field. 
 "Generate caption" action will automatically run whenever the image changes.

package/dist/index.esm.js

@@ -210,7 +210,7 @@ function getBaseFields(schema, type, typeName, options) {
     options: imagePromptField ? {
       imagePromptField
     } : void 0,
-    values: type.jsonType === "string" && ((_b = type == null ? void 0 : type.options) == null ? void 0 : _b.list) ? (_c = type == null ? void 0 : type.options) == null ? void 0 : _c.list.map(v => {
+    values: ((_b = type == null ? void 0 : type.options) == null ? void 0 : _b.list) ? (_c = type == null ? void 0 : type.options) == null ? void 0 : _c.list.map(v => {
       var _a2;
       return typeof v === "string" ? v : (_a2 = v.value) != null ? _a2 : "".concat(v.title);
     }) : void 0,
@@ -662,7 +662,8 @@ const maxHistoryVisibilityMs = minutesToMilliseconds(30);
 function useStudioAssistDocument(_ref2) {
   let {
     documentId,
-    schemaType
+    schemaType,
+    initDoc
   } = _ref2;
   const documentTypeName = schemaType.name;
   const currentUser = useCurrentUser();
@@ -673,13 +674,13 @@ function useStudioAssistDocument(_ref2) {
     apiVersion: "2023-01-01"
   });
   useEffect(() => {
-    if (!assistDocument) {
+    if (!assistDocument && initDoc) {
       client.createIfNotExists({
         _id: assistDocumentId(documentTypeName),
         _type: assistDocumentTypeName
-      });
+      }).catch(e => {});
     }
-  }, [client, assistDocument, documentTypeName]);
+  }, [client, assistDocument, documentTypeName, initDoc]);
   return useMemo(() => {
     var _a, _b;
     if (!assistDocument) {
@@ -959,7 +960,6 @@ function TaskItem(props) {
   });
 }
 const basePath = "/assist/tasks/instruction";
-const editorialAiFieldActionFeature = "editorialAiFieldActions";
 function useApiClient(customApiClient) {
   const client = useClient({
     apiVersion: "2023-06-05"
@@ -1010,30 +1010,19 @@ function useGenerateCaption(apiClient) {
 }
 function useGetInstructStatus(apiClient) {
   const [loading, setLoading] = useState(true);
-  const projectClient = useClient({
-    apiVersion: "2023-06-05"
-  });
   const getInstructStatus = useCallback(async () => {
     setLoading(true);
     const projectId = apiClient.config().projectId;
     try {
-      const features = await projectClient.request({
-        method: "GET",
-        url: "/projects/".concat(projectId, "/features")
-      });
-      const enabled = features.some(f => f === editorialAiFieldActionFeature);
       const status = await apiClient.request({
         method: "GET",
         url: "".concat(basePath, "/").concat(apiClient.config().dataset, "/status?projectId=").concat(projectId)
       });
-      return {
-        ...status,
-        enabled
-      };
+      return status;
     } finally {
       setLoading(false);
     }
-  }, [setLoading, apiClient, projectClient]);
+  }, [setLoading, apiClient]);
   return {
     loading,
     getInstructStatus
@@ -1459,6 +1448,22 @@ function BackToInstructionListLink() {
 const EMPTY_FIELDS = [];
 const TypePathContext = createContext(void 0);
 function AssistDocumentForm(props) {
+  if (props.readOnly) {
+    return /* @__PURE__ */jsx(Card, {
+      border: true,
+      tone: "caution",
+      padding: 2,
+      children: /* @__PURE__ */jsx(Text, {
+        size: 1,
+        children: " You do not have sufficient permissions to manage instructions."
+      })
+    });
+  }
+  return /* @__PURE__ */jsx(AssistDocumentFormEditable, {
+    ...props
+  });
+}
+function AssistDocumentFormEditable(props) {
   const {
     onChange
   } = props;
@@ -1899,7 +1904,8 @@ function AssistInspector(props) {
   const aiDocId = assistDocumentId(documentType);
   const assistDocument = useStudioAssistDocument({
     documentId,
-    schemaType
+    schemaType,
+    initDoc: true
   });
   const assistField = (_a2 = assistDocument == null ? void 0 : assistDocument.fields) == null ? void 0 : _a2.find(f => f.path === typePath);
   const instruction = (_b2 = assistField == null ? void 0 : assistField.instructions) == null ? void 0 : _b2.find(i => i._key === instructionKey);