From f006718e56c736010d3760ca83f4d3b0f7be0afa Mon Sep 17 00:00:00 2001
From: Sidharth Vinod <sidharthv96@gmail.com>
Date: Thu, 17 Apr 2025 21:30:48 +0530
Subject: [PATCH] chore: Change `getDiagramData` to
 `getRegisteredDiagramsMetadata`

Co-authored-by: Alois Klink <alois@aloisklink.com>
---
 packages/mermaid/src/mermaid.ts | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/packages/mermaid/src/mermaid.ts b/packages/mermaid/src/mermaid.ts
index 661617538..c8d57325f 100644
--- a/packages/mermaid/src/mermaid.ts
+++ b/packages/mermaid/src/mermaid.ts
@@ -415,7 +415,12 @@ const render: typeof mermaidAPI.render = (id, text, container) => {
   });
 };
 
-const getDiagramData = (): Pick<ExternalDiagramDefinition, 'id'>[] => {
+/**
+ * Gets the metadata for all registered diagrams.
+ * Currently only the id is returned.
+ * @returns An array of objects with the id of the diagram.
+ */
+const getRegisteredDiagramsMetadata = (): Pick<ExternalDiagramDefinition, 'id'>[] => {
   return Object.keys(detectors).map((id) => ({
     id,
   }));
@@ -443,7 +448,7 @@ export interface Mermaid {
   setParseErrorHandler: typeof setParseErrorHandler;
   detectType: typeof detectType;
   registerIconPacks: typeof registerIconPacks;
-  getDiagramData: typeof getDiagramData;
+  getRegisteredDiagramsMetadata: typeof getRegisteredDiagramsMetadata;
 }
 
 const mermaid: Mermaid = {
@@ -461,7 +466,7 @@ const mermaid: Mermaid = {
   setParseErrorHandler,
   detectType,
   registerIconPacks,
-  getDiagramData,
+  getRegisteredDiagramsMetadata,
 };
 
 export default mermaid;