feat: allow notifications without document previews (#1612)

* feat: allow notifications without document previews

* chore: bump version to 2.2.2

Author: nikkothari22

frontend/package.json

@@ -2,7 +2,7 @@
   "name": "raven-web",
   "private": true,
   "license": "AGPL-3.0-only",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "type": "module",
   "scripts": {
     "dev": "vite",

frontend/src/components/feature/chat/ChatInput/DocumentLinkButton.tsx

@@ -1,9 +1,9 @@
-import { Box, Button, Dialog, Flex, IconButton, Tooltip } from '@radix-ui/themes'
+import { Box, Button, Dialog, Flex, IconButton, Text, TextArea, Tooltip } from '@radix-ui/themes'
 import { DEFAULT_BUTTON_STYLE, ICON_PROPS } from './ToolPanel'
 import { LuFileBox } from 'react-icons/lu'
 import { FormProvider, useForm } from 'react-hook-form'
 import LinkFormField from '@/components/common/LinkField/LinkFormField'
-import { ErrorText } from '@/components/common/Form'
+import { ErrorText, Label } from '@/components/common/Form'
 import { useBoolean } from '@/hooks/useBoolean'
 import clsx from 'clsx'
 import { useFrappeCreateDoc } from 'frappe-react-sdk'
@@ -43,7 +43,8 @@ const DocumentLinkButton = ({ channelID }: { channelID: string }) => {
 
 interface DocumentLinkFormData {
     doctype: string
-    docname: string
+    docname: string,
+    message: string
 }
 
 const DocumentLinkForm = ({ channelID, onClose }: { channelID: string, onClose: () => void }) => {
@@ -71,6 +72,7 @@ const DocumentLinkForm = ({ channelID, onClose }: { channelID: string, onClose:
         createDoc('Raven Message', {
             message_type: 'Text',
             channel_id: channelID,
+            text: data.message,
             link_doctype: data.doctype,
             link_document: data.docname
         } as RavenMessage)
@@ -88,6 +90,7 @@ const DocumentLinkForm = ({ channelID, onClose }: { channelID: string, onClose:
         <FormProvider {...methods}>
             <Stack gap='2'>
                 {error && <ErrorBanner error={error} />}
+
                 <Box width='100%'>
                     <Flex direction='column' gap='2'>
                         <LinkFormField
@@ -127,6 +130,13 @@ const DocumentLinkForm = ({ channelID, onClose }: { channelID: string, onClose:
                     {doctype && docname && <DoctypeLinkRenderer doctype={doctype} docname={docname} />}
                 </div>
 
+                <Box width='100%'>
+                    <Flex direction='column' gap='0'>
+                        <Label>Message <Text as='span' size='1' color='gray'>(Optional)</Text></Label>
+                        <TextArea {...methods.register('message')} placeholder='Enter a message to send with the document' />
+                    </Flex>
+                </Box>
+
                 <Flex gap="3" mt="6" justify="end" align='center'>
                     <Dialog.Close disabled={loading}>
                         <Button variant="soft" color="gray">Cancel</Button>

frontend/src/components/feature/document-notifications/DocumentNotificationForm.tsx

@@ -137,7 +137,7 @@ const GeneralTab = ({ isEdit }: { isEdit: boolean }) => {
             </Stack>
 
         </Grid>
-        <Stack>
+        <Stack width={'fit-content'} gap='4'>
             <Text as="label" size="2">
                 <HStack>
                     <Controller
@@ -153,6 +153,29 @@ const GeneralTab = ({ isEdit }: { isEdit: boolean }) => {
                     Enabled
                 </HStack>
             </Text>
+
+            <Text as="label" size="2">
+                <HStack>
+                    <Controller
+                        control={control}
+                        name='do_not_attach_doc'
+                        render={({ field }) => (
+                            <Checkbox
+                                checked={field.value ? true : false}
+                                onCheckedChange={(v) => field.onChange(v ? 1 : 0)}
+                            />
+                        )} />
+
+                    <Stack gap='1'>
+                        Hide document preview in the notification message
+                        <HelperText>
+                            If checked, the document preview will not be attached to the notification message.
+                        </HelperText>
+                    </Stack>
+
+                </HStack>
+
+            </Text>
         </Stack>
 
         <Separator size='4' />

frontend/src/components/feature/threads/ThreadDrawer/ThreadFirstMessage.tsx

@@ -11,6 +11,7 @@ import { MdOutlineBarChart } from 'react-icons/md'
 import { getFileExtension, getFileName } from '@/utils/operations'
 import { FileExtensionIcon } from '@/utils/layout/FileExtIcon'
 import { DateTooltip } from '../../chat/ChatMessage/Renderers/DateTooltip'
+import { DoctypeLinkRenderer } from '../../chat/ChatMessage/Renderers/DoctypeLinkRenderer'
 
 type MessageContentProps = BoxProps & {
     user?: UserFields
@@ -68,6 +69,11 @@ export const ThreadFirstMessage = ({ message, user, ...props }: MessageContentPr
                             : null
                     }
 
+                    {message.link_doctype && message.link_document && <DoctypeLinkRenderer
+                        doctype={message.link_doctype}
+                        docname={message.link_document}
+                    />}
+
                 </Box>
                 {showButton &&
                     <Button size='1'

frontend/src/types/RavenIntegrations/RavenDocumentNotification.ts

@@ -21,6 +21,8 @@ export interface RavenDocumentNotification{
 	send_alert_on: "New Document" | "Update" | "Submit" | "Cancel" | "Delete"
 	/**	Document Type : Link - DocType	*/
 	document_type: string
+	/**	Do not attach document with message : Check - If enabled, the message won't have a document preview	*/
+	do_not_attach_doc?: 0 | 1
 	/**	Condition : Code - Optional: The alert will be sent if this expression is true	*/
 	condition?: string
 	/**	Recipients : Table - Raven Document Notification Recipients	*/

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "raven",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Messaging Application",
   "workspaces": [
     "frontend",

raven/__init__.py

@@ -1 +1 @@
-__version__ = "2.2.1"
+__version__ = "2.2.2"

raven/package.json

@@ -1,6 +1,6 @@
 {
   "name": "raven-app",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "",
   "main": "index.js",
   "scripts": {

raven/raven_integrations/doctype/raven_document_notification/raven_document_notification.json

@@ -14,6 +14,7 @@
   "send_alert_on",
   "column_break_rxyz",
   "document_type",
+  "do_not_attach_doc",
   "conditions_tab",
   "condition",
   "recipients_tab",
@@ -106,11 +107,19 @@
    "label": "Sender",
    "options": "Raven Bot",
    "reqd": 1
+  },
+  {
+   "default": "0",
+   "description": "If enabled, the message won't have a document preview",
+   "fieldname": "do_not_attach_doc",
+   "fieldtype": "Check",
+   "label": "Do not attach document with message"
   }
  ],
+ "grid_page_length": 50,
  "index_web_pages_for_search": 1,
  "links": [],
- "modified": "2024-12-15 19:21:43.452516",
+ "modified": "2025-04-13 16:44:11.691220",
  "modified_by": "Administrator",
  "module": "Raven Integrations",
  "name": "Raven Document Notification",
@@ -142,7 +151,8 @@
    "write": 1
   }
  ],
+ "row_format": "Dynamic",
  "sort_field": "creation",
  "sort_order": "DESC",
  "states": []
-}
+}

raven/raven_integrations/doctype/raven_document_notification/raven_document_notification.py

@@ -14,6 +14,8 @@
 
 class RavenDocumentNotification(Document):
 	# begin: auto-generated types
+	# ruff: noqa
+
 	# This code is auto-generated. Do not modify anything in this block.
 
 	from typing import TYPE_CHECKING
@@ -26,13 +28,15 @@ class RavenDocumentNotification(Document):
 		)
 
 		condition: DF.Code | None
+		do_not_attach_doc: DF.Check
 		document_type: DF.Link
 		enabled: DF.Check
 		message: DF.Code
 		notification_name: DF.Data
 		recipients: DF.Table[RavenDocumentNotificationRecipients]
 		send_alert_on: DF.Literal["New Document", "Update", "Submit", "Cancel", "Delete"]
 		sender: DF.Link
+	# ruff: noqa
 	# end: auto-generated types
 
 	def validate(self):
@@ -109,8 +113,8 @@ def send_notification(self, context, link_doctype, link_document):
 			bot.send_message(
 				channel_id=channel,
 				text=message,
-				link_doctype=link_doctype,
-				link_document=link_document,
+				link_doctype=link_doctype if not self.do_not_attach_doc else None,
+				link_document=link_document if not self.do_not_attach_doc else None,
 				markdown=True,
 				notification_name=self.name,
 			)
@@ -119,8 +123,8 @@ def send_notification(self, context, link_doctype, link_document):
 			bot.send_direct_message(
 				user_id=user,
 				text=message,
-				link_doctype=link_doctype,
-				link_document=link_document,
+				link_doctype=link_doctype if not self.do_not_attach_doc else None,
+				link_document=link_document if not self.do_not_attach_doc else None,
 				markdown=True,
 				notification_name=self.name,
 			)