refactor: migrate the DragSource story to TypeScript by tbouffard · Pull Request #860 · maxGraph/maxGraph

tbouffard · 2025-06-27T07:59:55Z

Ease the maintenance and detect errors earlier.

In addition, export the DragHandler type that is part of the API and that wasn't available outside maxGraph.

Summary by CodeRabbit

Refactor
- Centralized the definition of the DropHandler type for improved type consistency across the application.
- Updated relevant components and utilities to use the new shared DropHandler type.
Style
- Improved code clarity and type safety in the DragSource story, including enhanced typings and plugin management.
Tests
- Refined the DragSource story structure for better maintainability and demonstration of features.

Ease the maintenance and detect errors earlier. In addition, export the `DragHandler` type that is part of the API and that wasn't available outside maxGraph.

coderabbitai · 2025-06-27T08:00:47Z

Walkthrough

The changes centralize the definition of the DropHandler type by moving it to a shared types module. All relevant imports in the codebase are updated to reference this new location. Additionally, the DragSource story is refactored for improved type safety, structure, and code clarity, including enhanced custom classes and plugin management.

Changes

File(s)	Change Summary
packages/core/src/types.ts	Added `DropHandler` type alias for a standardized drop handler function signature.
packages/core/src/editor/EditorToolbar.ts packages/core/src/util/gestureUtils.ts packages/core/src/view/other/DragSource.ts	Updated imports to reference the centralized `DropHandler` type from the types module.
packages/html/stories/DragSource.stories.ts	Refactored story: improved typings, restructured custom classes, updated plugin management, and clarified handler logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DragSource
    participant DropHandler
    participant Graph

    User->>DragSource: Initiates drag-and-drop
    DragSource->>DropHandler: Calls drop handler with (graph, event, cell, x?, y?)
    DropHandler->>Graph: Processes drop event
    Graph-->>DropHandler: Updates graph state
    DropHandler-->>DragSource: Returns control

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-28T06_30_26_134Z-debug-0.log

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 746b8b1 and 345fc28.

📒 Files selected for processing (2)

packages/core/src/types.ts (1 hunks)
packages/html/stories/DragSource.stories.ts (7 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

packages/core/src/types.ts
packages/html/stories/DragSource.stories.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build (windows-2022)

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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.

packages/core/src/types.ts

sonarqubecloud · 2025-06-28T06:29:06Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

refactor: migrate the DragSource story to TypeScript

746b8b1

Ease the maintenance and detect errors earlier. In addition, export the `DragHandler` type that is part of the API and that wasn't available outside maxGraph.

tbouffard added the refactor Code refactoring label Jun 27, 2025

tbouffard mentioned this pull request Jun 27, 2025

feat!: improve tree-shaking by isolating SelectionCellsHandler dependencies #823

Draft

19 tasks

tbouffard commented Jun 27, 2025

View reviewed changes

packages/core/src/types.ts Show resolved Hide resolved

tbouffard added 2 commits June 28, 2025 08:26

DropHandler: add JSDoc [skip ci]

0568a4b

story: use type import for DropHandler

345fc28

tbouffard merged commit e2f84b0 into main Jun 28, 2025
7 checks passed

tbouffard deleted the refactor/story_dragsource_migrate_to_ts branch June 28, 2025 06:32

coderabbitai bot mentioned this pull request Dec 23, 2025

refactor(stories): migrate HelloWorld story to TypeScript #984

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate the DragSource story to TypeScript#860

refactor: migrate the DragSource story to TypeScript#860
tbouffard merged 3 commits intomainfrom
refactor/story_dragsource_migrate_to_ts

tbouffard commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

sonarqubecloud bot commented Jun 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

tbouffard commented Jun 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

sonarqubecloud bot commented Jun 28, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)