From ba0bddf4178e1d48de5cc3c73ac52db5a23f05e8 Mon Sep 17 00:00:00 2001
From: Sidharth Vinod <sidharthv96@gmail.com>
Date: Sun, 28 Jan 2024 16:02:28 +0530
Subject: [PATCH] Add MermaidConfigWithDefaults

---
 packages/mermaid/src/config.ts                         | 4 ++--
 packages/mermaid/src/config.type.ts                    | 5 +++++
 packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts | 1 -
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/packages/mermaid/src/config.ts b/packages/mermaid/src/config.ts
index ede3a568d..f1dccd251 100644
--- a/packages/mermaid/src/config.ts
+++ b/packages/mermaid/src/config.ts
@@ -2,7 +2,7 @@ import assignWithDepth from './assignWithDepth.js';
 import { log } from './logger.js';
 import theme from './themes/index.js';
 import config from './defaultConfig.js';
-import type { MermaidConfig } from './config.type.js';
+import type { MermaidConfig, MermaidConfigWithDefaults } from './config.type.js';
 import { sanitizeDirective } from './utils/sanitizeDirective.js';
 
 export const defaultConfig: MermaidConfig = Object.freeze(config);
@@ -128,7 +128,7 @@ export const setConfig = (conf: MermaidConfig): MermaidConfig => {
  *
  * @returns The currentConfig
  */
-export const getConfig = (): MermaidConfig => {
+export const getConfig = (): MermaidConfigWithDefaults => {
   return assignWithDepth({}, currentConfig);
 };
 /**
diff --git a/packages/mermaid/src/config.type.ts b/packages/mermaid/src/config.type.ts
index 575f428dd..7ca4b89d6 100644
--- a/packages/mermaid/src/config.type.ts
+++ b/packages/mermaid/src/config.type.ts
@@ -5,6 +5,8 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+import { RequiredDeep } from 'type-fest';
+
 /**
  * Configuration options to pass to the `dompurify` library.
  */
@@ -165,6 +167,9 @@ export interface MermaidConfig {
   wrap?: boolean;
   fontSize?: number;
 }
+
+// I'd prefer this to be named MermaidConfig, so all the functions can use the shorter name.
+export type MermaidConfigWithDefaults = RequiredDeep<MermaidConfig>;
 /**
  * This interface was referenced by `MermaidConfig`'s JSON-Schema
  * via the `definition` "BaseDiagramConfig".
diff --git a/packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts b/packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts
index 7433f2b9c..51f808ff4 100644
--- a/packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts
+++ b/packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts
@@ -1,6 +1,5 @@
 import type { Diagram } from '../../Diagram.js';
 import { getConfig, defaultConfig } from '../../diagram-api/diagramAPI.js';
-
 import {
   select as d3select,
   scaleOrdinal as d3scaleOrdinal,