-
Notifications
You must be signed in to change notification settings - Fork 6
ENG-1477: Convert a tldraw arrow to a DG relation #1082
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sid597
wants to merge
5
commits into
main
Choose a base branch
from
eng-1477-implement-ability-to-convert-a-tldraw-arrow-to-a-dg-relation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
08c8fb2
ENG-1477: Convert a tldraw arrow to a DG relation
sid597 0a799cc
ENG-1477: Keep original arrow until relation persistence succeeds
sid597 42cce45
ENG-1477: Bail when bound nodes are missing in convert flow
sid597 dc41755
ENG-1477: Preserve arrow geometry when converting
sid597 5015301
ENG-1477: Extract relation helpers and enforce DG visual contract on …
sid597 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
apps/roam/src/components/canvas/overlays/relationCreation.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| import { | ||
| DefaultColorThemePalette, | ||
| Editor, | ||
| TLShapeId, | ||
| createShapeId, | ||
| } from "tldraw"; | ||
| import { | ||
| BaseDiscourseRelationUtil, | ||
| DiscourseRelationShape, | ||
| getRelationColor, | ||
| } from "~/components/canvas/DiscourseRelationShape/DiscourseRelationUtil"; | ||
| import { createOrUpdateArrowBinding } from "~/components/canvas/DiscourseRelationShape/helpers"; | ||
| import { | ||
| checkConnectionType, | ||
| getAllRelations, | ||
| isDiscourseNodeShape, | ||
| } from "~/components/canvas/canvasUtils"; | ||
|
|
||
| type RelationTypeOption = { id: string; label: string; color: string }; | ||
|
|
||
| export const getValidRelationTypesBetween = ( | ||
| editor: Editor, | ||
| startId: TLShapeId, | ||
| endId: TLShapeId, | ||
| ): RelationTypeOption[] => { | ||
| const startNode = editor.getShape(startId); | ||
| const endNode = editor.getShape(endId); | ||
| if (!startNode || !endNode) return []; | ||
| if ( | ||
| !isDiscourseNodeShape(editor, startNode) || | ||
| !isDiscourseNodeShape(editor, endNode) | ||
| ) | ||
| return []; | ||
|
|
||
| const colorPalette = DefaultColorThemePalette.lightMode; | ||
| const validTypes: RelationTypeOption[] = []; | ||
| const seenLabels = new Set<string>(); | ||
|
|
||
| for (const relation of getAllRelations()) { | ||
| const { isDirect, isReverse } = checkConnectionType( | ||
| relation, | ||
| startNode.type, | ||
| endNode.type, | ||
| ); | ||
| if (!isDirect && !isReverse) continue; | ||
|
|
||
| const label = | ||
| isReverse && relation.complement ? relation.complement : relation.label; | ||
| if (seenLabels.has(label)) continue; | ||
| seenLabels.add(label); | ||
|
|
||
| const hexColor = | ||
| colorPalette[getRelationColor(relation.label)]?.solid ?? "#333"; | ||
| validTypes.push({ id: relation.id, label, color: hexColor }); | ||
| } | ||
|
|
||
| return validTypes; | ||
| }; | ||
|
|
||
| export const createRelationBetweenNodes = ({ | ||
| editor, | ||
| relationId, | ||
| sourceId, | ||
| targetId, | ||
| }: { | ||
| editor: Editor; | ||
| relationId: string; | ||
| sourceId: TLShapeId; | ||
| targetId: TLShapeId; | ||
| }): TLShapeId | null => { | ||
| const selectedRelation = getAllRelations().find((r) => r.id === relationId); | ||
| if (!selectedRelation) return null; | ||
|
|
||
| const sourceNode = editor.getShape(sourceId); | ||
| const targetNode = editor.getShape(targetId); | ||
| const { isReverse } = checkConnectionType( | ||
| selectedRelation, | ||
| sourceNode?.type ?? "", | ||
| targetNode?.type ?? "", | ||
| ); | ||
| const label = | ||
| isReverse && selectedRelation.complement | ||
| ? selectedRelation.complement | ||
| : selectedRelation.label; | ||
|
|
||
| const sourceBounds = editor.getShapePageBounds(sourceId); | ||
| if (!sourceBounds) return null; | ||
|
|
||
| const arrowId = createShapeId(); | ||
| editor.createShape<DiscourseRelationShape>({ | ||
| id: arrowId, | ||
| type: relationId, | ||
| x: sourceBounds.midX, | ||
| y: sourceBounds.midY, | ||
| props: { | ||
| color: getRelationColor(selectedRelation.label), | ||
| text: label, | ||
| dash: "draw", | ||
| size: "m", | ||
| fill: "none", | ||
| bend: 0, | ||
| start: { x: 0, y: 0 }, | ||
| end: { x: 0, y: 0 }, | ||
| arrowheadStart: "none", | ||
| arrowheadEnd: "arrow", | ||
| labelPosition: 0.5, | ||
| font: "draw", | ||
| scale: 1, | ||
| }, | ||
| }); | ||
|
|
||
| const newArrow = editor.getShape<DiscourseRelationShape>(arrowId); | ||
| if (!newArrow) return null; | ||
|
|
||
| createOrUpdateArrowBinding(editor, newArrow, sourceId, { | ||
| terminal: "start", | ||
| normalizedAnchor: { x: 0.5, y: 0.5 }, | ||
| isPrecise: false, | ||
| isExact: false, | ||
| }); | ||
| createOrUpdateArrowBinding(editor, newArrow, targetId, { | ||
| terminal: "end", | ||
| normalizedAnchor: { x: 0.5, y: 0.5 }, | ||
| isPrecise: false, | ||
| isExact: false, | ||
| }); | ||
|
|
||
| const util = editor.getShapeUtil(newArrow); | ||
| if ( | ||
| util instanceof BaseDiscourseRelationUtil && | ||
| "handleCreateRelationsInRoam" in util | ||
| ) { | ||
| type UtilWithRoamPersistence = BaseDiscourseRelationUtil & { | ||
| handleCreateRelationsInRoam: (args: { | ||
| arrow: DiscourseRelationShape; | ||
| targetId: TLShapeId; | ||
| }) => Promise<void>; | ||
| }; | ||
| void (util as UtilWithRoamPersistence).handleCreateRelationsInRoam({ | ||
| arrow: editor.getShape<DiscourseRelationShape>(arrowId) ?? newArrow, | ||
| targetId, | ||
| }); | ||
| } | ||
|
|
||
| editor.select(arrowId); | ||
| return arrowId; | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This keeps the dropdown's relation filtering behavior the same, but reuses the same valid-relation lookup that the new arrow context menu needs.