feat(ai): add support for submitting and cancelling documents (#1688)

Author: nikkothari22

frontend/src/components/feature/settings/ai/functions/FunctionConstants.ts

@@ -53,6 +53,24 @@ export const FUNCTION_TYPES = [
         requires_write_permissions: true,
         type: "Bulk Operations"
     },
+    {
+        value: "Submit Document",
+        description: "Submit any document in the system.",
+        requires_write_permissions: true,
+        type: "Standard"
+    },
+    {
+        value: "Cancel Document",
+        description: "Cancel any document in the system.",
+        requires_write_permissions: true,
+        type: "Standard"
+    },
+    {
+        value: "Get Amended Document",
+        description: "Get the amended document for a given document. This function is only available for documents that have been cancelled and then amended.",
+        requires_write_permissions: false,
+        type: "Standard"
+    },
     {
         value: "Custom Function",
         description: "Custom function to be used in the system.",

frontend/src/components/feature/settings/ai/functions/FunctionForm.tsx

@@ -26,7 +26,7 @@ const FunctionForm = ({ isEdit }: { isEdit?: boolean }) => {
         <Tabs.Root defaultValue='function_details'>
             <Tabs.List>
                 <Tabs.Trigger value='function_details'><LuSquareFunction {...ICON_PROPS} /> Details</Tabs.Trigger>
-                <Tabs.Trigger value='variables' disabled={in_list(["Get Document", "Get Multiple Documents", "Delete Document", "Delete Multiple Documents", "Attach File to Document"], type)}><LuVariable {...ICON_PROPS} /> Variables</Tabs.Trigger>
+                <Tabs.Trigger value='variables' disabled={in_list(["Get Document", "Get Multiple Documents", "Delete Document", "Delete Multiple Documents", "Attach File to Document", "Submit Document", "Cancel Document", "Get Amended Document"], type)}><LuVariable {...ICON_PROPS} /> Variables</Tabs.Trigger>
             </Tabs.List>
             <Stack pt='4'>
                 <AINotEnabledCallout />
@@ -278,7 +278,7 @@ const ReferenceDoctypeField = () => {
 
     const type = watch('type')
 
-    const DOCUMENT_REF_FUNCTIONS = ["Get Document", "Get Multiple Documents", "Get List", "Create Document", "Create Multiple Documents", "Update Document", "Update Multiple Documents", "Delete Document", "Delete Multiple Documents"]
+    const DOCUMENT_REF_FUNCTIONS = ["Get Document", "Get Multiple Documents", "Get List", "Create Document", "Create Multiple Documents", "Update Document", "Update Multiple Documents", "Delete Document", "Delete Multiple Documents", "Submit Document", "Cancel Document", "Get Amended Document"]
 
     const onReferenceDoctypeChange = (e: ChangeEvent<HTMLInputElement>) => {
 
@@ -324,6 +324,19 @@ const ReferenceDoctypeField = () => {
                 description = `This function deletes multiple ${e.target.value} from the system.`
                 function_name = `delete_${e.target.value.toLowerCase().replace(/\s/g, '_')}s`
             }
+            if (type === 'Submit Document') {
+                description = `This function submits a ${e.target.value} in the system.`
+                function_name = `submit_${e.target.value.toLowerCase().replace(/\s/g, '_')}`
+            }
+            if (type === 'Cancel Document') {
+                description = `This function cancels a ${e.target.value} in the system.`
+                function_name = `cancel_${e.target.value.toLowerCase().replace(/\s/g, '_')}`
+            }
+
+            if (type === 'Get Amended Document') {
+                description = `This function gets the amended document for a ${e.target.value} in the system.`
+                function_name = `get_amended_${e.target.value.toLowerCase().replace(/\s/g, '_')}`
+            }
 
             if (function_name && !function_name_exists) {
                 setValue('function_name', function_name)

frontend/src/types/RavenAI/RavenAIFunction.ts

@@ -18,7 +18,7 @@ export interface RavenAIFunction{
 	/**	Function Path : Small Text	*/
 	function_path?: string
 	/**	Type : Select	*/
-	type: "Get Document" | "Get Multiple Documents" | "Get List" | "Create Document" | "Create Multiple Documents" | "Update Document" | "Update Multiple Documents" | "Delete Document" | "Delete Multiple Documents" | "Custom Function" | "Send Message" | "Attach File to Document" | "Get Report Result"
+	type: "Get Document" | "Get Multiple Documents" | "Get List" | "Create Document" | "Create Multiple Documents" | "Update Document" | "Update Multiple Documents" | "Delete Document" | "Delete Multiple Documents" | "Submit Document" | "Cancel Document" | "Get Amended Document" | "Custom Function" | "Send Message" | "Attach File to Document" | "Get Report Result"
 	/**	Reference DocType : Link - DocType	*/
 	reference_doctype?: string
 	/**	Pass parameters as JSON : Check - If checked, the params will be passed as a JSON object instead of named parameters	*/

raven/ai/functions.py

@@ -107,6 +107,54 @@ def delete_documents(doctype: str, document_ids: list):
 	return {"document_ids": document_ids, "message": "Documents deleted", "doctype": doctype}
 
 
+def submit_document(doctype: str, document_id: str):
+	"""
+	Submit a document in the database
+	"""
+	doc = frappe.get_doc(doctype, document_id)
+	doc.submit()
+	return {
+		"document_id": document_id,
+		"message": f"{doctype} {document_id} submitted",
+		"doctype": doctype,
+	}
+
+
+def cancel_document(doctype: str, document_id: str):
+	"""
+	Cancel a document in the database
+	"""
+	doc = frappe.get_doc(doctype, document_id)
+	doc.cancel()
+	return {
+		"document_id": document_id,
+		"message": f"{doctype} {document_id} cancelled",
+		"doctype": doctype,
+	}
+
+
+def get_amended_document_id(doctype: str, document_id: str):
+	"""
+	Get the amended document for a given document
+	"""
+	amended_doc = frappe.db.exists(doctype, {"amended_from": document_id})
+	if amended_doc:
+		return amended_doc
+	else:
+		return {"message": f"{doctype} {document_id} is not amended"}
+
+
+def get_amended_document(doctype: str, document_id: str):
+	"""
+	Get the amended document for a given document
+	"""
+	amended_doc = frappe.db.exists(doctype, {"amended_from": document_id})
+	if amended_doc:
+		return client.get(doctype, name=document_id)
+	else:
+		return {"message": f"{doctype} {document_id} is not amended", "doctype": doctype}
+
+
 def attach_file_to_document(doctype: str, document_id: str, file_path: str):
 	"""
 	Attach a file to a document in the database

raven/ai/handler.py

@@ -8,13 +8,16 @@
 
 from raven.ai.functions import (
 	attach_file_to_document,
+	cancel_document,
 	create_document,
 	create_documents,
 	delete_document,
 	delete_documents,
+	get_amended_document,
 	get_document,
 	get_documents,
 	get_list,
+	submit_document,
 	update_document,
 	update_documents,
 )
@@ -140,6 +143,20 @@ def handle_requires_action(self, data, run_id):
 						self.publish_event(f"Fetching multiple {function.reference_doctype}s...")
 						function_output = get_documents(function.reference_doctype, **args)
 
+					if function.type == "Submit Document":
+						self.publish_event(f"Submitting {function.reference_doctype} {args.get('document_id')}...")
+						function_output = submit_document(function.reference_doctype, **args)
+
+					if function.type == "Cancel Document":
+						self.publish_event(f"Cancelling {function.reference_doctype} {args.get('document_id')}...")
+						function_output = cancel_document(function.reference_doctype, **args)
+
+					if function.type == "Get Amended Document":
+						self.publish_event(
+							f"Fetching amended document for {function.reference_doctype} {args.get('document_id')}..."
+						)
+						function_output = get_amended_document(function.reference_doctype, **args)
+
 					if function.type == "Delete Document":
 						self.publish_event(
 							"Deleting {} {}...".format(function.reference_doctype, args.get("document_id"))

raven/raven_ai/doctype/raven_ai_function/raven_ai_function.json

@@ -48,7 +48,7 @@
    "fieldname": "type",
    "fieldtype": "Select",
    "label": "Type",
-   "options": "Get Document\nGet Multiple Documents\nGet List\nCreate Document\nCreate Multiple Documents\nUpdate Document\nUpdate Multiple Documents\nDelete Document\nDelete Multiple Documents\nCustom Function\nSend Message\nAttach File to Document\nGet Report Result",
+   "options": "Get Document\nGet Multiple Documents\nGet List\nCreate Document\nCreate Multiple Documents\nUpdate Document\nUpdate Multiple Documents\nDelete Document\nDelete Multiple Documents\nSubmit Document\nCancel Document\nGet Amended Document\nCustom Function\nSend Message\nAttach File to Document\nGet Report Result",
    "reqd": 1
   },
   {
@@ -103,9 +103,10 @@
    "label": "Strict"
   }
  ],
+ "grid_page_length": 50,
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2024-12-07 23:32:48.633167",
+ "modified": "2025-05-18 17:42:22.628503",
  "modified_by": "Administrator",
  "module": "Raven AI",
  "name": "Raven AI Function",
@@ -137,8 +138,9 @@
    "write": 1
   }
  ],
+ "row_format": "Dynamic",
  "search_fields": "description",
  "sort_field": "creation",
  "sort_order": "DESC",
  "states": []
-}
+}

raven/raven_ai/doctype/raven_ai_function/raven_ai_function.py

@@ -41,6 +41,9 @@ class RavenAIFunction(Document):
 			"Update Multiple Documents",
 			"Delete Document",
 			"Delete Multiple Documents",
+			"Submit Document",
+			"Cancel Document",
+			"Get Amended Document",
 			"Custom Function",
 			"Send Message",
 			"Attach File to Document",
@@ -62,7 +65,13 @@ def before_validate(self):
 		if self.type in WRITE_PERMISSIONS:
 			self.requires_write_permissions = 1
 
-		READ_PERMISSIONS = ["Get Document", "Get Multiple Documents", "Get Report Result", "Get List"]
+		READ_PERMISSIONS = [
+			"Get Document",
+			"Get Multiple Documents",
+			"Get Report Result",
+			"Get List",
+			"Get Amended Document",
+		]
 		if self.type in READ_PERMISSIONS:
 			self.requires_write_permissions = 0
 
@@ -186,6 +195,42 @@ def prepare_function_params(self):
 				"required": ["document_ids"],
 				"additionalProperties": False,
 			}
+		elif self.type == "Submit Document":
+			params = {
+				"type": "object",
+				"properties": {
+					"document_id": {
+						"type": "string",
+						"description": f"The ID of the {self.reference_doctype} to submit",
+					}
+				},
+				"required": ["document_id"],
+				"additionalProperties": False,
+			}
+		elif self.type == "Cancel Document":
+			params = {
+				"type": "object",
+				"properties": {
+					"document_id": {
+						"type": "string",
+						"description": f"The ID of the {self.reference_doctype} to cancel",
+					}
+				},
+				"required": ["document_id"],
+				"additionalProperties": False,
+			}
+		elif self.type == "Get Amended Document":
+			params = {
+				"type": "object",
+				"properties": {
+					"document_id": {
+						"type": "string",
+						"description": f"The ID of the {self.reference_doctype} to get the amended document for",
+					}
+				},
+				"required": ["document_id"],
+				"additionalProperties": False,
+			}
 		elif self.type == "Attach File to Document":
 			params = {
 				"type": "object",
@@ -360,6 +405,9 @@ def validate(self):
 			"Update Multiple Documents",
 			"Delete Document",
 			"Delete Multiple Documents",
+			"Submit Document",
+			"Cancel Document",
+			"Get Amended Document",
 		]
 		if self.type in DOCUMENT_REF_FUNCTIONS:
 			if not self.reference_doctype: