[pull] develop from mermaid-js:develop

[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Refactor the class diagram database to create a new instance for each diagram.

New Features:

• The mermaidAPI.getDiagramFromText() function now returns a new, distinct database instance for each class diagram, ensuring that changes to one diagram do not affect others.

Tests:

• Added tests to verify that mermaidAPI.getDiagramFromText() returns different database instances for class diagrams and state diagrams, while returning the same instance for sequence diagrams.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the class diagram database to be a class, which allows for multiple class diagrams to be rendered on the same page. It also fixes an issue where the state diagram database was being cleared when a new diagram was rendered.

Class diagram showing the new ClassDB structure

classDiagram
    class ClassDB {
      -relations: ClassRelation[]
      -classes: Map<string, ClassNode>
      -styleClasses: Map<string, StyleClass>
      -notes: ClassNote[]
      -interfaces: Interface[]
      -namespaces: Map<string, NamespaceNode>
      -namespaceCounter: number
      -functions: any[]
      +constructor()
      +addClass(id: string)
      +addRelation(classRelation: ClassRelation)
      +addMember(className: string, member: string)
      +addNote(text: string, className: string)
      +setDirection(dir: string)
      +getData()
      +clear()
    }
    note for ClassDB "Refactored from global variables to class instance"

Loading

File-Level Changes

Change	Details	Files
Refactor classDb to be a class	The classDb is now a class instead of a module. The classDb now has a constructor that initializes the database. The classDb now has a clear method that clears the database. The classDb now has a getData method that returns the data for the diagram. The classDb now has a setAccTitle method that sets the accessibility title. The classDb now has a getAccTitle method that gets the accessibility title. The classDb now has a setAccDescription method that sets the accessibility description. The classDb now has a getAccDescription method that gets the accessibility description. The classDb now has a setDiagramTitle method that sets the diagram title. The classDb now has a getDiagramTitle method that gets the diagram title. The classDb now has a getConfig method that gets the configuration. The classDb now has a addRelation method that adds a relation to the database. The classDb now has a addAnnotation method that adds an annotation to the database. The classDb now has a addMember method that adds a member to the database. The classDb now has a addMembers method that adds multiple members to the database. The classDb now has a addNote method that adds a note to the database. The classDb now has a cleanupLabel method that cleans up a label. The classDb now has a setCssClass method that sets the CSS class for a class. The classDb now has a defineClass method that defines a class. The classDb now has a setLink method that sets the link for a class. The classDb now has a getTooltip method that gets the tooltip for a class. The classDb now has a setTooltip method that sets the tooltip for a class. The classDb now has a lookUpDomId method that looks up the DOM ID for a class. The classDb now has a setClassLabel method that sets the label for a class. The classDb now has a addNamespace method that adds a namespace to the database. The classDb now has a addClassesToNamespace method that adds classes to a namespace. The classDb now has a getNamespace method that gets a namespace. The classDb now has a getNamespaces method that gets all namespaces. The classDb now has a setCssStyle method that sets the CSS style for a class. The classDb now has a setClickEvent method that sets the click event for a class. The classDb now has a bindFunctions method that binds the functions for a class. The classDb now has a lineType property that defines the line types. The classDb now has a relationType property that defines the relation types. The classDb now has a getDirection method that gets the direction of the diagram. The classDb now has a setDirection method that sets the direction of the diagram. The classDb now has a getClass method that gets a class. The classDb now has a getClasses method that gets all classes. The classDb now has a getNotes method that gets all notes. The classDb now has a getRelations method that gets all relations. The classDb now has a addClass method that adds a class to the database.	packages/mermaid/src/diagrams/class/classDb.ts
Update class diagram to use the new classDb	The class diagram now uses the new classDb class. The class diagram now creates a new classDb instance for each diagram.	packages/mermaid/src/diagrams/class/classDiagram-v2.ts packages/mermaid/src/diagrams/class/classDiagram.ts
Fix state diagram db clear issue	The state diagram now creates a new db instance for each diagram.	packages/mermaid/src/diagrams/state/stateDiagram-v2.ts packages/mermaid/src/diagrams/state/stateDiagram.ts
Fix mermaidAPI.getDiagramFromText() to return a new db for each diagram	The mermaidAPI.getDiagramFromText() now returns a new db for each class and state diagram. The mermaidAPI.getDiagramFromText() now returns the same db for each sequence diagram.	packages/mermaid/src/mermaidAPI.spec.ts
Add tests for class db class	Added tests to ensure that functions used in class JISON are exposed as function from ClassDB.	packages/mermaid/src/diagrams/class/classDiagram.spec.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.