chore: clarify why images are removed from rtf-to-html results (#1295)

README.md

@@ -15,7 +15,7 @@ Docsmith is a RESTful API, built using Node.js and the [Fastify](https://fastify
 -   DOCX to TXT
 -   PDF to HTML
 -   PDF to TXT
--   RTF to HTML
+-   RTF to HTML (images are removed)
 -   RTF to TXT
 -   Scanned documents (as PDFs) to TXT using OCR
 

src/plugins/rtf-to-html/index.js

@@ -66,6 +66,15 @@ async function plugin(server, options) {
 		// Define any default settings the plugin should have to get up and running
 		const config = {
 			rtfToHtmlOptions: {
+				/**
+				 * Images are removed because UnRTF generates image names as `pict001.wmf`,
+				 * `pict002.wmf`, and so on. This poses a confidentiality and clinical risk as,
+				 * should two concurrent requests have the same image name, the second request
+				 * would overwrite the first request's image and that image would be embedded
+				 * into both HTML documents.
+				 *
+				 * We wouldn't want to add one patient's image to another patient's document.
+				 */
 				noPictures: true,
 				outputHtml: true,
 			},
@@ -95,7 +104,7 @@ async function plugin(server, options) {
 			 * UnRTF < v0.20.4 ignores `noPictures` option and
 			 * generates img tags whilst placing images in cwd.
 			 *
-			 * UnRTF generates the image name i.e. `pict001.wmf`, `pict002.wmf` and so on.
+			 * UnRTF generates the image name as `pict001.wmf`, `pict002.wmf`, and so on.
 			 * This means files can be safely removed from the cwd without running the
 			 * risk of removing any important files such as `package.json`, should an image
 			 * ever have the same name.

src/routes/rtf/html/schema.js

@@ -12,7 +12,7 @@ const rtfToHtmlPostSchema = {
 	tags,
 	summary: "Convert RTF to HTML",
 	description:
-		"Returns the result of converting an RTF document to HTML format. Images are discarded.",
+		"Returns the result of converting an RTF document to HTML format. Images are removed.",
 	operationId: "postRtfToHtml",
 	consumes: ["application/rtf"],
 	produces: ["application/json", "application/xml"],